bloom-filter [![travis][travis-image]][travis-url] [![npm][npm-image]][npm-url] [![downloads][downloads-image]][downloads-url] 

[travis-image]: https://travis-ci.org/PolkaJS/bloom-filter.svg?branch=master
[travis-url]: https://travis-ci.org/PolkaJS/bloom-filter
[npm-image]: https://img.shields.io/npm/v/@polkajs/bloom-filter.svg
[npm-url]: https://npmjs.org/package/@polkajs/bloom-filter
[downloads-image]: https://img.shields.io/npm/dm/@polkajs/bloom-filter.svg
[downloads-url]: https://npmjs.org/package/@polkajs/bloom-filter

About

Bloom filters can very quickly answer variations on the Yes/No question “is this item in the set?”, like “have I seen this item before?”

* WIKI
* Bloom filters by example
* fun read about bloom filters and their value
* white paper
* c++ example

While bloom filters can give false positives, they cannot give false negatives. When

Install

``js
// NPM
npm install --save @polkajs/bloom-filter
// YARN
yarn add @polkajs/bloom-filter
`

Use

`js
const Bloom = require('@polkajs/bloom-filter').default;

let bloom = new Bloom(16, 8); // 16 byte length, assuming max 8 inputs
B.add("cat");
B.add("parrot");
B.add("monkey");

console.log(B);
// Bloom {
// bitmapBits: 128,
// k: 2,
// bitmap: ,
// numHashes: 8,
// hashFunc: [Function]
// }

let dog = B.inSet("dog");
let cat = B.inSet("cat");

console.log("is 'dog' in the set?", dog);
// false
console.log("is 'cat' in the set?", cat);
// true
console.log(B.toString());
// 00008000000008000020010088000000
`

API

$3


create a new bloom
`
new Bloom(size: number, numHashes: number, hashFunc?: Function)
`
* size: number of bytes in bloom map
* numHashes: max number of inputs
* hashFun: [OPTIONAL] replace the murmurhash3 algorithm

$3

add a new input
`
bloom.add(data: string)
`
* data: input string to be mapped

$3

check if a value exists in the bloom filter set
`
bloom.inset(data: string): bool
`
* data: input string to be checked

$3

hexadecimal string of the current mapping of inputs
`
bloom.toString(): string
`

$3

takes
`
bloom.extendBloom(b: Bloom): Bloom
``
* b bloom filter to extend from

---

ISC License (ISC)

Copyright 2017
Copyright (c) 2004-2010 by Internet Systems Consortium, Inc. ("ISC")
Copyright (c) 1995-2003 by Internet Software Consortium

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.