1  # Bloomy
 2  
 3  A minimal implementation of a Bloom filter in Rust.
 4  
 5  Bloom filters are a space-efficient probabilistic data structure invented by
 6  Burton Howard Bloom in the 1970s.
 7  
 8  This crate combines ideas and code from various other Bloom filter
 9  crates.
10  
11  The underlying bit vector implementation is adapted from existing code by
12  Helge Wrede, Alexander Schultheiß and Lukas Simon.
13  
14  In comparison with other crates, `bloomy` combines the following advantages:
15  * Computationally efficient by using a double hashing technique pioneered
16  by Adam Kirsch and Michael Mitzenmacher. You can find a copy of the paper in
17  the `docs/` folder.
18  * Has only a single dependency: `siphasher`, from which multiple hashers are
19  derived, and hence doesn't depend on the `bitvec` or `bit-vec` crates.
20  * Supports *union* and *intersection* operations.
21  * Supports *counting* items and *similarity* metrics.
22  
23  Usage
24  -----
25  Add the following to your `Cargo.toml`:
26  
27      [dependencies]
28      bloomy = "1"
29  
30  Check the `examples/` folder for usage examples.
31  
32  License
33  -------
34  Licensed under the MIT license.