Struct pdatastructs::BloomFilter

pub struct BloomFilter { /* fields omitted */ }

Simple implementation of a BloomFilter

Methods

impl BloomFilter

fn with_params(m: usize, k: usize) -> BloomFilter

Create new, empty BloomFilter with internal parameters.

• k is the number of hash functions
• m is the number of bits used to store state

fn with_properties(n: usize, p: f64) -> BloomFilter

Create new, empty BloomFilter with given properties.

• n number of unique elements the BloomFilter is expected to hold, must be > 0
• p false positive property when querying the BloomFilter after adding n unique elements, must be > 0 and < 1

Panics if the parameters are not in range.

fn k(&self) -> usize

Get k (number of hash functions).

fn m(&self) -> usize

Get m (number of stored bits).

fn add<T>(&mut self, obj: &T) where
    T: Hash, 

Add new element to the BloomFilter.

If the same element is added multiple times or if an element results in the same hash signature, this method does not have any effect.

fn query<T>(&self, obj: &T) -> bool where
    T: Hash, 

Guess if the given element was added to the BloomFilter.

fn clear(&mut self)

Clear state of the BloomFilter, so that it behaves like a fresh one.

fn is_empty(&self) -> bool

Check whether the BloomFilter is empty.

fn union(&mut self, other: &BloomFilter)

Add the entire content of another bloomfilter to this BloomFilter.

The result is the same as adding all elements added to other to self in the first place.

Panics if k and m of the two BloomFilters are not identical.

fn guess_n(&self) -> usize

Guess the number of unique elements added to the BloomFilter.

Trait Implementations

impl Clone for BloomFilter

fn clone(&self) -> BloomFilter

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BloomFilter

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.