### 10 releases (6 breaking)

new 0.7.1 | Apr 17, 2024 |
---|---|

0.7.0 | Apr 16, 2024 |

0.6.1 | Apr 2, 2024 |

0.5.1 | Mar 22, 2024 |

0.1.0 | Feb 23, 2024 |

#**140** in Data structures

**2,188** downloads per month

**MIT/Apache**

87KB

1.5K
SLoC

# fastbloom

The fastest Bloom filter in Rust. No accuracy compromises. Compatible with any hasher.

## Overview

is a SIMD accelerated Bloom filter implemented in Rust. `fastbloom`

's default hasher is SipHash-1-3 using randomized keys but can be seeded or configured to use any hasher. `fastbloom`

is 50-10000% faster than existing Bloom filter implementations.`fastbloom`

## Usage

Due to a different (improved!) algorithm in 0.7.x,

s have incompatible serialization/deserialization with 0.6.x!`BloomFilter`

`# Cargo.toml`
`[``dependencies``]`
`fastbloom ``=` `"`0.7.1`"`

Basic usage:

`use` `fastbloom``::`BloomFilter`;`
`let` `mut` filter `=` `BloomFilter``::`with_num_bits`(``1024``)``.``expected_items``(``2``)``;`
filter`.``insert``(``"`42`"``)``;`
filter`.``insert``(``"`π¦`"``)``;`

Instantiate with a target false positive rate:

`use` `fastbloom``::`BloomFilter`;`
`let` filter `=` `BloomFilter``::`with_false_pos`(``0.``001``)``.``items``(``[``"`42`"``,` `"`π¦`"``]``)``;`
`assert!``(`filter`.``contains``(``"`42`"``)``)``;`
`assert!``(`filter`.``contains``(``"`π¦`"``)``)``;`

Use any hasher:

`use` `fastbloom``::`BloomFilter`;`
`use` `ahash``::`RandomState`;`
`let` filter `=` `BloomFilter``::`with_num_bits`(``1024``)`
`.``hasher``(``RandomState``::`default`(``)``)`
`.``items``(``[``"`42`"``,` `"`π¦`"``]``)``;`

## Background

Bloom filters are space-efficient approximate membership set data structures supported by an underlying bit array to track item membership. To insert/check membership, a number of bits are set/checked at positions based on the item's hash. False positives from a membership check are possible, but false negatives are not. Once constructed, neither the Bloom filter's underlying memory usage nor number of bits per item change. See more.

`hash(4) βββββββ¬ββββββ¬ββββββββββββββββ
β β β
0 0 0 0 0 0 0 1 0 0 1 0 0 0 0 0 0 0 1 0
β β β
βββββββββββββ΄ββββββββββββ΄ββββ hash(3) (not in the set)
`

## Implementation

is `fastbloom`**several times faster** than existing Bloom filters and scales very well with the number of hashes per item. In all cases,

maintains competitive false positive rates. `fastbloom`

is blazingly fast because it uses L1 cache friendly blocks, efficiently derives many index bits from `fastbloom`**only one real hash per item**, employs SIMD acceleration, and leverages other research findings on Bloom filters.

is implemented as a partial blocked Bloom filter. Blocked Bloom filters partition their underlying bit array into sub-array βblocksβ. Bits set and checked from the itemβs hash are constrained to a single block instead of the entire bit array. This allows for better cache-efficiency and the opportunity to leverage SIMD and SWAR operations when generating bits from an itemβs hash. See more on blocked bloom filters. Half of `fastbloom`

's hash indexes span the entire bit array while others are confined to a single block.`fastbloom`

## Runtime Performance

is 50-10000% faster than existing Bloom filters implemented in Rust.`fastbloom`

#### SipHash

Runtime comparison to other Bloom filter crates (all using SipHash). Note:

- The number hashes for all Bloom filters is derived to optimize accuracy, meaning fewer items in the Bloom filters result in more hashes per item and generally slower performance.
- As number of items (input) increases, the accuracy of the Bloom filter decreases.

Results are amortized over 1000 random strings

#### XXHash

These crates use xxhash.

is also configured to use xxhash.`fastbloom`

Results are amortized over 1000 random strings.

sbbf-rs-safe is hardcoded for 8 index bits per item, explaining the constant and fast performance, but this results in less accuracy as shown in the next section "False Positive Performance".

## False Positive Performance

does not compromise accuracy. Below is a comparison of false positive rates with other Bloom filter crates:`fastbloom`

The Bloom filters and a control hash set were populated with a varying number of random 64 bit integers ("Number of Items"). Then 100,000 random 64 bit integers were checked: false positives are numbers that do NOT exist in the control hash set but do report as existing in the Bloom filter.

## Comparing Block Sizes

offers 4 different block sizes: 64, 128, 256, and 512 bits.`fastbloom`

`use` `fastbloom``::`BloomFilter`;`
`let` filter `=` `BloomFilter``::`with_num_bits`(``1024``)``.``block_size_128``(``)``.``expected_items``(``2``)``;`

512 bits is the default. Larger block sizes generally have slower performance but are more accurate, e.g. a Bloom filter with 64 bit blocks is very fast but slightly less accurate.

#### Runtime Performance

Results are amortized over 1000 random strings. The Bloom filters used ahash.

#### Accuracy

## How it Works

attributes its performance to two insights:`fastbloom`

- Only one real hash per item is needed, subsequent hashes can be cheaply derived from the real hash using "hash composition"
- Many bit positions can be derived from a few subsequent hashes through SIMD and SWAR-like operations

#### One Real Hash Per Item

employs "hash composition" on two 32-bit halves of an original 64-bit hash. Each subsequent hash is derived by combining the original hash value with a different constant using modular arithmetic and bitwise operations. This results in a set of hash functions that are effectively independent and uniformly distributed, even though they are derived from the same original hash function. Computing the composition of two original hashes is faster than re-computing the hash with a different seed. This technique is explained in depth in this paper.`fastbloom`

#### Many Bit Positions Derived from Subsequent Hashes

Instead of deriving a single bit position per hash, a hash with ~N 1 bits set can be formed by chaining bitwise AND and OR operations of the subsequent hashes.

##### Example

For a Bloom filter with a bit vector of size 64 and desired hashes 24, 24 (potentially overlapping) positions in the bit vector are set or checked for each item on insertion or membership check respectively.

Other traditional Bloom filters derive 24 positions based on 24 hashes of the item:

`hash0``(`item`)``%``64``hash1``(`item`)``%``64`- ...
`hash23``(`item`)``%``64`

Instead,

uses a "sparse hash", a composed hash with less than 32 expected number of bits set. In this case, a ~20 bit set sparse hash is derived from the item and added to the bit vector with a bitwise OR:`fastbloom`

`hash0``(`item`)``&``hash1``(`item`)``|``hash2``(`item`)``&``hash3``(`item`)`

That's 4 hashes versus 24!

Note:

- Given 64 bits, and 24 hashes, a bit has probability (63/64)^24 to NOT be set, i.e. 0, after 24 hashes. The expected number of bits to be set for an item is 64 - (64 * (63/64)^24) ~= 20.
- A 64 bit

provides us with roughly 32 set bits with a binomial distribution.`hash0``(`item`)`

gives us ~16 set bits,`hash0``(`item`)``&``hash1``(`item`)`

gives us ~48 set bits, etc.`hash0``(`item`)``|``hash1``(`item`)`

In reality, the Bloom filter may have more than 64 bits of storage. In that case, many underlying

s in the block are operated on using SIMD intrinsics. The number of hashes is adjusted to be the number of hashes per `u64`

in the block. Additionally, some bits may be set in the traditional way, across the entire bit vector, to account for any truncating errors from the sparse hash. This also reduces the false positive rate and boosts non-member check speed.`u64`

## Available Features

- Enabled by default, this has the`rand`

source its random state using`DefaultHasher`

instead of hardware sources. Getting entropy from a user-space source is considerably faster, but requires additional dependencies to achieve this. Disabling this feature by using`thread_rng``(``)`

makes`default``-`features`=``false`

source its entropy using`DefaultHasher`

, which will have a much simpler code footprint at the expense of speed.`getrandom`

## References

- Bloom filter - Wikipedia
- Bloom Filter - Brilliant
- Bloom Filter Interactive Demonstration
- Cache-, Hash- and Space-Efficient Bloom Filters
- Less hashing, same performance: Building a better Bloom filter
- A fast alternative to the modulo reduction

## License

Licensed under either of

- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

## Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

#### Dependencies

~1.4β1.9MB

~36K SLoC