asap_sketchlib 0.2.1

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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112

# API: Common Input Types

Status: `Shared`

## Purpose

Canonical input and ownership model shared across sketches/frameworks.

**File:** [src/common/input.rs](../../src/common/input.rs)

## Type/Struct

- `DataInput<'a>`
- `HeapItem`
- `HHItem`
- `HydraQuery<'a>`
- `HydraCounter`
- `L2HH`

`HydraQuery` and `HydraCounter` are defined in `asap_sketchlib::common::input`.

## Constructors / Conversions

```rust
fn heap_item_to_sketch_input(item: &HeapItem) -> DataInput<'_>
fn input_to_owned(input: &DataInput<'_>) -> HeapItem

// HHItem
fn new(k: DataInput, count: i64) -> Self
fn create_item(k: HeapItem, count: i64) -> Self
fn init_item(k: DataInput, count: i64) -> Self
```

## Insert/Update

```rust
// L2HH
fn update_and_est(&mut self, key: &DataInput, value: i64) -> f64
fn update_and_est_without_l2(&mut self, key: &DataInput, value: i64) -> f64
fn clear(&mut self)

// HydraCounter
fn insert(&mut self, value: &DataInput, count: Option<i32>)
fn insert_with_hash(
    &mut self,
    value: &DataInput,
    hashed_val: &MatrixHashType,
    count: Option<i32>,
)
```

## Query

```rust
// L2HH
fn get_l2(&self) -> f64

// HydraCounter
fn query(&self, query: &HydraQuery) -> Result<f64, String>
```

## Merge

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

// HydraCounter
fn merge(&mut self, other: &HydraCounter) -> Result<(), String>
```

## Serialization

- `DataInput`, `HeapItem`, `HHItem`, `HydraCounter`, and `L2HH` derive serde traits.
- `HydraQuery` is query-only and does not derive serde in current code.

## Variants (Core)

```rust
enum DataInput<'a> {
    I8(i8), I16(i16), I32(i32), I64(i64), I128(i128), ISIZE(isize),
    U8(u8), U16(u16), U32(u32), U64(u64), U128(u128), USIZE(usize),
    F32(f32), F64(f64),
    Str(&'a str), String(String), Bytes(&'a [u8]),
}

enum HeapItem {
    I8(i8), I16(i16), I32(i32), I64(i64), I128(i128), ISIZE(isize),
    U8(u8), U16(u16), U32(u32), U64(u64), U128(u128), USIZE(usize),
    F32(f32), F64(f64),
    String(String),
}
```

## Examples

```rust
use asap_sketchlib::{DataInput, input_to_owned};
use asap_sketchlib::common::input::HydraQuery;

let q = HydraQuery::Frequency(DataInput::Str("key"));
let _ = q;

let key = DataInput::String("flow".to_string());
let _owned = input_to_owned(&key);
```

## See Also

- [Common Module (Canonical)](./api_common.md)
- [Common Heap Utilities](./api_common_heap.md)
- [API: Hydra](./api_hydra.md)