asap_sketchlib 0.2.0

A high-performance sketching library for approximate stream processing
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

# API: UnivMon Optimized

Status: `Ready`

## Purpose

Optimized two-tier UnivMon stack with sketch pooling.

## Type/Struct

- `UnivSketchPool`
- `UnivMonPyramid`

## Constructors

```rust
// UnivSketchPool
fn new(heap_size: usize, sketch_row: usize, sketch_col: usize, layer_size: usize, cap: usize) -> Self

// UnivMonPyramid
fn new(
    top_heap_size: usize,
    top_rows: usize,
    top_cols: usize,
    bottom_heap_size: usize,
    bottom_rows: usize,
    bottom_cols: usize,
    layer_size: usize,
    pool_cap: usize,
) -> Self
fn with_defaults() -> Self
```

## Insert/Update

```rust
fn insert(&mut self, key: &DataInput, value: i64)
fn fast_insert(&mut self, key: &DataInput, value: i64)
fn free(&mut self)
```

## Query

```rust
fn calc_l1(&self) -> f64
fn calc_l2(&self) -> f64
fn calc_entropy(&self) -> f64
fn calc_card(&self) -> f64
fn calc_g_sum<F>(&self, g: F, is_card: bool) -> f64

// Pool introspection
fn available(&self) -> usize
fn total_allocated(&self) -> usize
```

## Merge

```rust
fn merge(&mut self, other: &UnivMonPyramid)
```

## Serialization

No dedicated serialization API.

## Examples

```rust
use asap_sketchlib::{DataInput, UnivMonPyramid};

let mut um = UnivMonPyramid::with_defaults();
um.insert(&DataInput::U64(1), 1);
assert!(um.calc_l1() >= 1.0);
```

## Caveats

- Merge expects compatible layout/configuration.

## Status

Ready optimized path for pooled UnivMon deployments.