blossom/bloom~ AttenuatedBloomFilter

new AttenuatedBloomFilter(optionsopt)

Constructs an empty attenuated bloom filter given a bitfield size and a filter depth.

Parameters:
NameTypeAttributesDescription
optionsobject<optional>
Properties
NameTypeAttributesDefaultDescription
bitfieldSizenumber<optional>
160

Size of the underlying bitfields

filterDepthnumber<optional>
3

Number of module:blossom/bloom~BloomFilters

Extends

  • Array

Methods

merge(foreignFilters) → {AttenuatedBloomFilter}

Merges a foreign attenuated filter into ours.

Parameters:
NameTypeDescription
foreignFiltersAttenuatedBloomFilter

The attenuated filter to merge into ours (uses bitwise OR operation)

Returns:
Type: 
AttenuatedBloomFilter

toHexArray() → {Array.<string>}

Returns an array of hex string serialized filters.

Returns:
Type: 
Array.<string>

toString() → {string}

Returns a comma delimited string of each filter serialized to hex strings.

Returns:
Type: 
string