cn.hutool.bloomfilter

Class BitSetBloomFilter

java.lang.Object

cn.hutool.bloomfilter.BitSetBloomFilter

All Implemented Interfaces:

BloomFilter, Serializable

public class BitSetBloomFilter
extends Object
implements BloomFilter

BloomFilter实现方式2，此方式使用BitSet存储。
Hash算法的使用使用固定顺序，只需指定个数即可

Author:

loolly

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BitSetBloomFilter(int c, int n, int k) 构造一个布隆过滤器，过滤器的容量为c * k 个bit.

Method Summary

Modifier and Type	Method and Description
boolean	add(String str) 在boolean的bitMap中增加一个字符串 如果存在就返回false .如果不存在.先增加这个字符串.再返回true
boolean	contains(String str) 判定是否包含指定字符串
static int[]	createHashes(String str, int hashNumber) 将字符串的字节表示进行多哈希编码.
double	getFalsePositiveProbability()
static int	hash(String str, int k) 计算Hash值
void	init(String path, Charset charset) 通过文件初始化过滤器.
void	init(String path, String charsetName) Deprecated. 请使用 init(String, Charset)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BitSetBloomFilter

public BitSetBloomFilter(int c,
                         int n,
                         int k)

构造一个布隆过滤器，过滤器的容量为c * k 个bit.

Parameters:

c - 当前过滤器预先开辟的最大包含记录,通常要比预计存入的记录多一倍.

n - 当前过滤器预计所要包含的记录.

k - 哈希函数的个数，等同每条记录要占用的bit数，此处值取值为1~8

Method Detail

init

@Deprecated
public void init(String path,
                             String charsetName)
                      throws IOException

Deprecated. 请使用 init(String, Charset)

通过文件初始化过滤器.

Parameters:

path - 文件路径

charsetName - 字符集

Throws:

IOException - IO异常

init

public void init(String path,
                 Charset charset)
          throws IOException

通过文件初始化过滤器.

Parameters:

path - 文件路径

charset - 字符集

Throws:

IOException - IO异常

Since:

5.8.0

add

public boolean add(String str)

Description copied from interface: BloomFilter

在boolean的bitMap中增加一个字符串
如果存在就返回false .如果不存在.先增加这个字符串.再返回true

Specified by:

add in interface BloomFilter

Parameters:

str - 字符串

Returns:

是否加入成功，如果存在就返回false .如果不存在返回true

contains

public boolean contains(String str)

判定是否包含指定字符串

Specified by:

contains in interface BloomFilter

Parameters:

str - 字符串

Returns:

是否包含，存在误差

getFalsePositiveProbability

public double getFalsePositiveProbability()

Returns:

得到当前过滤器的错误率.

createHashes

public static int[] createHashes(String str,
                                 int hashNumber)

将字符串的字节表示进行多哈希编码.

Parameters:

str - 待添加进过滤器的字符串字节表示.

hashNumber - 要经过的哈希个数.

Returns:

各个哈希的结果数组.

hash

public static int hash(String str,
                       int k)

计算Hash值

Parameters:

str - 被计算Hash的字符串

k - Hash算法序号

Returns:

Hash值