1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
|
# Boost Bloom Library
[](https://github.com/boostorg/bloom/tree/master) [](https://github.com/boostorg/bloom/actions/workflows/ci.yml) [](https://drone.cpp.al/boostorg/bloom) [](https://app.codecov.io/gh/joaquintides/bloom/tree/master) [](https://boost.org/doc/libs/master/libs/bloom) </br>
[](https://github.com/boostorg/bloom/tree/develop) [](https://github.com/boostorg/bloom/actions/workflows/ci.yml) [](https://drone.cpp.al/boostorg/bloom) [](https://app.codecov.io/gh/joaquintides/bloom/tree/develop) [](https://boost.org/doc/libs/develop/libs/bloom) </br>
[](https://www.boost.org/users/license.html) <img alt="C++11 required" src="https://img.shields.io/badge/standard-C%2b%2b11-blue.svg"> <img alt="Header-only library" src="https://img.shields.io/badge/build-header--only-blue.svg">
Boost.Bloom provides the class template `boost::bloom::filter` that
can be configured to implement a classical [Bloom filter](https://en.wikipedia.org/wiki/Bloom_filter)
as well as variations discussed in the literature such as block filters, multiblock filters, and more.
```cpp
#include <boost/bloom/filter.hpp>
#include <cassert>
#include <string>
int main()
{
// Bloom filter of strings with 5 bits set per insertion
using filter = boost::bloom::filter<std::string, 5>;
// create filter with a capacity of 1'000'000 **bits**
filter f(1'000'000);
// insert elements (they can't be erased, Bloom filters are insert-only)
f.insert("hello");
f.insert("Boost");
//...
// elements inserted are always correctly checked as such
assert(f.may_contain("hello") == true);
// elements not inserted may incorrectly be identified as such with a
// false positive rate (FPR) which is a function of the array capacity,
// the number of bits set per element and generally how the boost::bloom::filter
// was specified
if(f.may_contain("bye")) { // likely false
//...
}
}
```
## Learn about Boost.Bloom
* [Online documentation](https://boost.org/libs/bloom)
* [Some benchmarks](https://github.com/boostorg/boost_bloom_benchmarks)
## Install Boost.Bloom
* [Download Boost](https://www.boost.org/users/download/) and you're ready to go (this is a header-only library requiring no building).
* Using Conan 2: In case you don't have it yet, add an entry for Boost in your `conanfile.txt` (the example requires at least Boost 1.89):
```
[requires]
boost/[>=1.89.0]
```
<ul>If you're not using any compiled Boost library, the following will skip building altogether:</ul>
```
[options]
boost:header_only=True
```
* Using vcpkg: Execute the command
```
vcpkg install boost-bloom
```
* Using CMake: [Boost CMake support infrastructure](https://github.com/boostorg/cmake)
allows you to use CMake directly to download, build and consume all of Boost or
some specific libraries.
## Support
* Join the **#boost** discussion group at [cpplang.slack.com](https://cpplang.slack.com/)
([ask for an invite](https://cppalliance.org/slack/) if you’re not a member of this workspace yet)
* [File an issue](https://github.com/boostorg/bloom/issues)
## Contribute
* [Pull requests](https://github.com/boostorg/bloom/pulls) against **develop** branch are most welcome.
Note that by submitting patches you agree to license your modifications under the [Boost Software License, Version 1.0](http://www.boost.org/LICENSE_1_0.txt).
|
