Skip to content

api_countmin.md

Latest commit

 

History

History
74 lines (52 loc) · 1.61 KB

api_countmin.md

File metadata and controls

74 lines (52 loc) · 1.61 KB

API: CountMin

Status: Ready

Purpose

Approximate frequency estimation with sub-linear memory.

Type/Struct

  • CountMin<S = Vector2D<i32>, Mode = RegularPath, H = DefaultXxHasher>

Constructors

fn default() -> Self
fn with_dimensions(rows: usize, cols: usize) -> Self
fn from_storage(counts: S) -> Self

Insert/Update

fn insert(&mut self, value: &DataInput)
fn insert_many(&mut self, value: &DataInput, many: S::Counter)
fn bulk_insert(&mut self, values: &[DataInput])
fn bulk_insert_many(&mut self, values: &[(DataInput, S::Counter)])
fn fast_insert_with_hash_value(&mut self, hashed_val: &S::HashValueType)
fn fast_insert_many_with_hash_value(&mut self, hashed_val: &S::HashValueType, many: S::Counter)

Query

fn estimate(&self, value: &DataInput) -> S::Counter
fn fast_estimate_with_hash(&self, hashed_val: &S::HashValueType) -> S::Counter
fn rows(&self) -> usize
fn cols(&self) -> usize
fn as_storage(&self) -> &S
fn as_storage_mut(&mut self) -> &mut S

Merge

fn merge(&mut self, other: &Self)

Serialization

fn serialize_to_bytes(&self) -> Result<Vec<u8>, RmpEncodeError>
fn deserialize_from_bytes(bytes: &[u8]) -> Result<Self, RmpDecodeError>

Examples

use asap_sketchlib::{CountMin, DataInput};

let mut cm = CountMin::with_dimensions(3, 1024);
cm.insert(&DataInput::U64(42));
let est = cm.estimate(&DataInput::U64(42));
assert!(est >= 1);

Caveats

  • merge requires matching dimensions.
  • FastPath and regular modes must be paired consistently.

Status

Used as a primary building block in frameworks and orchestrated paths.