Struct HyperLogLog

pub struct HyperLogLog<V: ?Sized> { /* private fields */ }

An implementation of the HyperLogLog data structure with bias correction.

See HyperLogLog: the analysis of a near-optimal cardinality estimation algorithm and HyperLogLog in Practice: Algorithmic Engineering of a State of The Art Cardinality Estimation Algorithm for background on HyperLogLog with bias correction.

Implementations

impl<V> HyperLogLog<V>

where V: Hash + ?Sized,

pub fn new(error_rate: f64) -> Self

Create an empty HyperLogLog data structure with the specified error tolerance.

pub fn new_from(hll: &Self) -> Self

Create an empty HyperLogLog data structure, copying the error tolerance from hll.

pub fn push(&mut self, value: &V)

“Visit” an element.

pub fn len(&self) -> f64

Retrieve an estimate of the carginality of the stream.

pub fn is_empty(&self) -> bool

Returns true if empty.

pub fn union(&mut self, src: &Self)

Merge another HyperLogLog data structure into self.

This is the same as an HLL approximating cardinality of the union of two multisets.

pub fn intersect(&mut self, src: &Self)

Intersect another HyperLogLog data structure into self.

Note: This is different to an HLL approximating cardinality of the intersection of two multisets.

pub fn clear(&mut self)

Clears the HyperLogLog data structure, as if it was new.

Trait Implementations

impl<'a, V> AddAssign<&'a HyperLogLog<V>> for HyperLogLog<V>

where V: Hash + ?Sized,

fn add_assign(&mut self, rhs: &'a Self)

Performs the += operation.

impl<'a, V> AddAssign<&'a V> for HyperLogLog<V>

where V: Hash + ?Sized,

fn add_assign(&mut self, rhs: &'a V)

Performs the += operation.

impl<V: ?Sized> Clone for HyperLogLog<V>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<V> Debug for HyperLogLog<V>

where V: Hash + ?Sized,

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

Formats the value using the given formatter.

impl<'de, V: ?Sized> Deserialize<'de> for HyperLogLog<V>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<V> Intersect for HyperLogLog<V>

where V: Hash + ?Sized,

fn intersect<'a>(iter: impl Iterator<Item = &'a Self>) -> Option<Self>

where Self: Sized + 'a,

Intersect.

impl<V: ?Sized> IntersectPlusUnionIsPlus for HyperLogLog<V>

const VAL: bool = true

Apply optimisation or not

impl<V> New for HyperLogLog<V>

where V: Hash + ?Sized,

type Config = f64

The type of data required to instantiate a new Self.

fn new(config: &Self::Config) -> Self

Instantiate a new Self with the given <Self as New>::Config.

impl<V: ?Sized> Serialize for HyperLogLog<V>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a, V> UnionAssign<&'a HyperLogLog<V>> for HyperLogLog<V>

where V: Hash + ?Sized,

fn union_assign(&mut self, rhs: &'a Self)

Union.