api_common_heap.md

API: Common Heap Utilities

Status: Shared

Purpose

Common heavy-hitter heap helper used by multiple sketches/frameworks.

Type/Struct

• HHHeap

Constructors

fn new(k: usize) -> Self
fn from_heap(other: &HHHeap) -> Self

Insert/Update

fn update(&mut self, key: &DataInput, count: i64) -> bool
fn update_heap_item(&mut self, key: &HeapItem, count: i64) -> bool
fn clear(&mut self)

Query

fn find(&self, key: &DataInput) -> Option<usize>
fn find_heap_item(&self, key: &HeapItem) -> Option<usize>
fn heap(&self) -> &[HHItem]
fn len(&self) -> usize
fn is_empty(&self) -> bool
fn capacity(&self) -> usize

Merge

No dedicated merge method on HHHeap; reconciliation is sketch-specific.

Serialization

No dedicated byte API helpers.

Examples

use asap_sketchlib::{HHHeap, DataInput};

let mut hh = HHHeap::new(8);
hh.update(&DataInput::Str("u1"), 10);
assert!(hh.find(&DataInput::Str("u1")).is_some());

Caveats

• Key ownership conversion follows DataInput/HeapItem behavior from Common Input Types.

See Also

• Common Module (Canonical)
• Common Input Types

Status

Canonical shared heap utility.