apache-datasketches 0.2.0

Safe, idiomatic Rust bindings for Apache DataSketches
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

//! CPC (Compressed Probabilistic Counting) sketch family: cardinality
//! estimation with a more compact serialized form than HLL or Theta.
//!
//! Unlike the `theta` module, CPC has no set operations beyond union — no
//! intersection, a-not-b, or Jaccard similarity.
//!
//! ```
//! # fn main() -> Result<(), apache_datasketches::SketchError> {
//! use apache_datasketches::cpc::CpcSketchBuilder;
//!
//! let mut sketch = CpcSketchBuilder::new().lg_k(11).build()?;
//! sketch.update_u64(42);
//! println!("estimate: {}", sketch.get_estimate());
//! # Ok(())
//! # }
//! ```
//!
//! - [`CpcSketch`] / [`CpcSketchBuilder`] — the sketch; build with
//!   `CpcSketchBuilder::new().lg_k(..).build()`.
//! - [`CpcUnion`] / [`CpcUnionBuilder`] — merges multiple sketches.
//! - [`get_max_serialized_size_bytes`] — the estimated maximum compressed
//!   serialized size, in bytes, for a given `lg_k`.
//! - [`init`] — eagerly initializes CPC's global decompression tables, as
//!   a one-time latency optimization; see its own doc comment for details.

mod builder;
mod init;
mod sketch;
mod union;

pub use builder::{CpcSketchBuilder, CpcUnionBuilder};
pub use init::init;
pub use sketch::{get_max_serialized_size_bytes, CpcSketch};
pub use union::CpcUnion;