# bloomfilter 
[](https://crates.io/crates/bloomfilter)
[](https://docs.rs/bloomfilter)
[](https://github.com/jedisct1/rust-bloom-filter/blob/master/LICENSE)
A simple but fast implementation of the Bloom filter in Rust. The Bloom filter is a a space-efficient probabilistic data structure supporting dynamic set membership queries with false positives. It was introduced by Burton H. Bloom in 1970 [(Bloom, 1970)](https://dl.acm.org/doi/10.1145/362686.362692) and have since been increasingly used in computing applications and bioinformatics.
### Documentation
Library documentation with examples is available on [docs.rs](https://docs.rs/bloomfilter).
### Usage
Add this to your `Cargo.toml`:
```toml
[dependencies]
bloomfilter = "1"
```
Here is a simple example for creating a bloom filter with a false positive rate of 0.001 and query for presence of some numbers.
```rust
use bloomfilter::Bloom;
let num_items = 100000;
let fp_rate = 0.001;
let mut bloom = Bloom::new_for_fp_rate(num_items, fp_rate);
bloom.set(&10); // insert 10 in the bloom filter
bloom.check(&10); // return true
bloom.check(&20); // return false
```
### License
This project is licensed under the ISC license ([LICENSE](https://github.com/jedisct1/rust-bloom-filter/blob/master/LICENSE) or https://opensource.org/licenses/ISC).