Struct hyperloglogplus::HyperLogLogPF

pub struct HyperLogLogPF<H, B> where
    H: Hash + ?Sized,
    B: BuildHasher,  { /* private fields */ }

Implements the original HyperLogLog algorithm for cardinality estimation.

This implementation is based on the original paper of P. Flajolet et al:

HyperLogLog: the analysis of a near-optimal cardinality estimation algorithm.

• Uses 5-bit registers, packed in a 32-bit unsigned integer. Thus, every six registers 2 bits are not used.
• Supports serialization/deserialization through serde.
• Compiles in a no_std environment using a global allocator.

Examples

use std::collections::hash_map::RandomState;
use hyperloglogplus::{HyperLogLog, HyperLogLogPF};

let mut hll: HyperLogLogPF<u32, _> =
    HyperLogLogPF::new(16, RandomState::new()).unwrap();

hll.insert(&12345);
hll.insert(&23456);

assert_eq!(hll.count().trunc() as u32, 2);

References

• “HyperLogLog: the analysis of a near-optimal cardinality estimation algorithm”, Philippe Flajolet, Éric Fusy, Olivier Gandouet and Frédéric Meunier.

Implementations

impl<H, B> HyperLogLogPF<H, B> where
    H: Hash + ?Sized,
    B: BuildHasher, 

pub fn new(precision: u8, builder: B) -> Result<Self, HyperLogLogError>

Creates a new HyperLogLogPF instance.

pub fn merge<S, T>(
    &mut self,
    other: &HyperLogLogPF<S, T>
) -> Result<(), HyperLogLogError> where
    S: Hash + ?Sized,
    T: BuildHasher, 

Merges the other HyperLogLogPF instance into self.

Both sketches must have the same precision.

pub fn insert_any<R>(&mut self, value: &R) where
    R: Hash + ?Sized, 

Inserts a new value, of any type, to the multiset.

Trait Implementations

impl<H: Clone, B: Clone> Clone for HyperLogLogPF<H, B> where
    H: Hash + ?Sized,
    B: BuildHasher, 

fn clone(&self) -> HyperLogLogPF<H, B>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<H: Debug, B: Debug> Debug for HyperLogLogPF<H, B> where
    H: Hash + ?Sized,
    B: BuildHasher, 

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

Formats the value using the given formatter.

impl<'de, H, B> Deserialize<'de> for HyperLogLogPF<H, B> where
    H: Hash + ?Sized,
    B: BuildHasher,
    B: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<H, B> HyperLogLog<H> for HyperLogLogPF<H, B> where
    H: Hash + ?Sized,
    B: BuildHasher, 

fn add(&mut self, value: &H)

👎 Deprecated since 0.3.0:

use insert() function instead.

Adds a new value to the multiset.

fn insert<Q>(&mut self, value: &Q) where
    H: Borrow<Q>,
    Q: Hash + ?Sized, 

Inserts a new value to the multiset.

fn count(&mut self) -> f64

Estimates the cardinality of the multiset.

impl<H, B> Serialize for HyperLogLogPF<H, B> where
    H: Hash + ?Sized,
    B: BuildHasher,
    B: Serialize, 

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.