blossom/bloom~ ScalingBloomFilter

new ScalingBloomFilter(errorRateopt, optionsopt)

A scaling bloom filter (SBF) as described by Almeida et al.

Parameters:
NameTypeAttributesDefaultDescription
errorRatenumber<optional>
0.1

Max false positive probabilty

optionsobject<optional>
Properties
NameTypeAttributesDefaultDescription
rationumber<optional>
0.9

Error rate ratio

scalingnumber<optional>
2

Scaling factor

initialCapacitynumber<optional>
1000

Starting capacity for underlying SafeBloomFilter

Methods

add(key) → {ScalingBloomFilter}

Add item to the SBF

Parameters:
NameTypeDescription
keystring | Buffer

Item to add

Returns:
Type: 
ScalingBloomFilter

has(key) → {boolean}

Checks if an item probably exists in the filter

Parameters:
NameTypeDescription
keystring | Buffer

Item to check

Returns:
Type: 
boolean

(static) destringify(data) → {ScalingBloomFilter}

Create a ScalingBloomFilter from an object

Parameters:
NameTypeDescription
dataobject
Properties
NameTypeDescription
rationumber

SBF ratio to use

scalingnumber

Scaling factor

initialCapacitynumber

Starting capacity for underlying module:blossom/bloom~SafeBloomFilter

filtersArray.<object>

Serialized data for filters passed to module:blossom/bloom~SafeBloomFilter.destringify

Returns:
Type: 
ScalingBloomFilter