Struct BloomFilter

pub struct BloomFilter<K> { /* private fields */ }

A Bloom filter that keeps track of items of type K.

Implementations

impl<K> BloomFilter<K>

where K: Hash,

pub fn new(capacity: usize) -> BloomFilter<K>

Return a new Bloom filter with a given approximate item capacity. The default false positive probability is set and defined by [DEFAULT_FALSE_POS].

pub fn with_size(nbytes: usize) -> BloomFilter<K>

Return a new Bloom filter given a size in bytes for the filter.

pub fn with_rate(capacity: usize, fp_rate: f64) -> BloomFilter<K>

Return a new Bloom filter with a given approximate item capacity and a desired false positive rate.

pub fn insert(&mut self, item: &K)

Set an item in the Bloom filter. This operation is idempotent with regards to each unique item. Each item must implement the Hash trait.

pub fn contains(&self, item: &K) -> bool

Return whether or not a given item is likely in the Bloom filter or not. There is a possibility for a false positive with the probability being under the Bloom filter’s p value, but a false negative will never occur.

pub fn clear(&mut self)

Set all bits to zero.

pub fn bits(&self) -> usize

Return the number of bits in this filter.

pub fn hashes(&self) -> usize

Number of hashes used (k parameter).

pub fn count(&self) -> usize

Count the approximate number of items in the filter.

pub fn similarity(&self, other: &BloomFilter<K>) -> f64

Compute the approximate similarity between two filters using the Jaccard Index.

pub fn overlap(&self, other: &BloomFilter<K>) -> f64

Compute the approximate overlap between two filters using the overlap coefficient.

pub fn union(&self, other: &BloomFilter<K>) -> BloomFilter<K>

Compute the union of two Bloom filters.

pub fn intersection(&self, other: &BloomFilter<K>) -> BloomFilter<K>

Compute the intersection of two Bloom filters.

pub fn is_comparable(&self, other: &BloomFilter<K>) -> bool

Check whether two filters can be compared, intersected and unioned.

pub fn as_bytes(&self) -> &[u8]

Return the underlying bytes storage.

Trait Implementations

impl<K> AsRef<[u8]> for BloomFilter<K>

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl<K> Clone for BloomFilter<K>

where K: Clone,

fn clone(&self) -> BloomFilter<K>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<K> Debug for BloomFilter<K>

where K: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<K> From<BloomFilter<K>> for Vec<u8>

fn from(other: BloomFilter<K>) -> Vec<u8>

Converts to this type from the input type.

impl From<BloomFilter<RepoId>> for Filter

fn from(bloom: BloomFilter<RepoId>) -> Self

Converts to this type from the input type.

impl<K> From<Vec<u8>> for BloomFilter<K>

fn from(other: Vec<u8>) -> BloomFilter<K>

Converts to this type from the input type.

impl<K> PartialEq for BloomFilter<K>

fn eq(&self, other: &BloomFilter<K>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<K> Eq for BloomFilter<K>