hyperloglog-rs 0.1.56

A Rust implementation of HyperLogLog trying to be parsimonious with memory.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92

//! This module defines a trait and an implementation for estimating the cardinality of an iterator
//! using a HyperLogLog data structure.
//!
//! # Example
//! You can estimate the cardinality of an iterator using the `estimate_cardinality` method.
//! ```
//! use hyperloglog_rs::prelude::*;
//!
//! let v = vec![1, 2, 3, 4, 5, 6, 7, 8, 9, 10];
//! let cardinality_estimate = v.iter().estimate_cardinality::<Precision12, 5>();
//! assert!((cardinality_estimate - 10.0).abs() < 1.0);
//! ```
//!
//! You can merge multiple HyperLogLog counters from iterators using the `union` method.
//!
//! ```
//! use hyperloglog_rs::prelude::*;
//!
//! let v = vec![1, 2, 3, 4, 5, 6, 7, 8, 9, 10];
//! let hll: HyperLogLog<Precision12, 6> = v.into_iter().map(|index|{
//!     HyperLogLog::from(index)
//! }).union();
//! let cardinality_estimate = hll.estimate_cardinality();
//! assert!((cardinality_estimate - 10.0).abs() < 1.0);
//! ```
use core::hash::Hash;

use crate::prelude::*;

/// A trait for estimating the cardinality of an iterator.
pub trait EstimateIterCardinality {
    /// Estimate the cardinality of the iterator.
    ///
    /// # Arguments
    ///
    /// * `self` - An iterator over elements to estimate the cardinality of.
    ///
    /// # Type parameters
    ///
    /// * `PRECISION` - The precision to use for the HyperLogLog counter.
    /// * `BITS` - The number of bits per register in the HyperLogLog counter.
    ///
    fn estimate_cardinality<P: Precision + WordType<BITS>, const BITS: usize>(self) -> f32;
}

impl<I, T: Hash> EstimateIterCardinality for I
where
    I: Iterator<Item = T>,
{
    fn estimate_cardinality<P: Precision + WordType<BITS>, const BITS: usize>(self) -> f32 {
        let hll: HyperLogLog<P, BITS> = self.collect();
        hll.estimate_cardinality()
    }
}

pub trait HyperLogLogIterator<P: Precision + WordType<BITS>, const BITS: usize> {
    /// Returns a HyperLogLog that is the union of all HyperLogLogs in the iterator.
    ///
    /// # Example
    ///
    /// ```rust
    /// use hyperloglog_rs::prelude::*;
    ///
    /// let mut hll1 = HyperLogLog::<Precision12, 6>::default();
    /// hll1.insert(&1);
    /// hll1.insert(&2);
    ///
    /// let mut hll2 = HyperLogLog::<Precision12, 6>::default();
    /// hll2.insert(&3);
    /// hll2.insert(&4);
    ///
    /// let mut hll3 = HyperLogLog::<Precision12, 6>::default();
    /// hll3.insert(&5);
    /// hll3.insert(&6);
    ///
    /// let hll_union = vec![hll1, hll2, hll3].iter().union();
    ///
    /// assert!(hll_union.estimate_cardinality() - 6.0 < 1.0, "Expected 6.0, got {}", hll_union.estimate_cardinality());
    /// ```
    fn union(self) -> HyperLogLog<P, BITS>;
}

impl<P: Precision + WordType<BITS>, const BITS: usize, I, C> HyperLogLogIterator<P, BITS> for I
where
    I: Iterator<Item = C>,
    HyperLogLog<P, BITS>: BitOr<C, Output = HyperLogLog<P, BITS>>,
{
    #[inline(always)]
    fn union(self) -> HyperLogLog<P, BITS> {
        self.fold(HyperLogLog::default(), |acc, hll| acc | hll)
    }
}