asap_sketchlib 0.3.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

//! Higher-level frameworks built on top of the core sketches.
//!
//! These APIs compose, extend, or orchestrate sketches for more advanced
//! workflows:
//!
//! - windowed analytics: [`ExponentialHistogram`], [`TumblingWindow`]
//! - subpopulation queries: [`Hydra`]
//! - universal multi-metric monitoring: [`UnivMon`] and experimental [`UnivMonQ`]
//! - batch update acceleration: [`NitroBatch`]
//! - shared-hash or multi-sketch coordination: [`HashSketchEnsemble`]
//! - runtime and parallel execution helpers: the `octo` family
//!
//! Most users can begin with the core algorithms in [`crate::sketches`]. Reach
//! for this module when you need to add windows, grouped queries, coordinated
//! execution, or higher-level sketch composition.
//!
//! Some parts of this module are feature-gated:
//!
//! - `eh_univ_optimized` requires `experimental`
//! - the `OctoRuntime` execution runtime requires `octo-runtime`

pub mod eh;
pub use eh::EHBucket;
pub use eh::ExponentialHistogram;

/// Sketch-type adapters used by exponential histograms.
pub mod eh_sketch_list;
pub use eh_sketch_list::EHSketchList;
pub use eh_sketch_list::SketchNorm;

pub mod hashlayer;
pub use hashlayer::{EnsembleSketch, HashSketchEnsemble};

pub mod sketch_catalog;

pub mod hydra;
pub use hydra::Hydra;

pub mod univmon;
pub use univmon::{UnivMon, UnivMonDeltaFidelity, bottom_layer_for_hash};

pub mod univmon_q;
pub use univmon_q::{
    OrderedQueryDiagnostics, UnivMonQ, UnivMonQConfig, UnivMonQError, UnivMonQPoint, UnivMonQQuery,
};

pub mod univmon_optimized;
pub use univmon_optimized::{UnivMonPyramid, UnivSketchPool};

pub mod nitro;
pub use nitro::{
    NitroBatch, NitroEstimate, NitroTarget, nitro_delta_saturated_i32, nitro_delta_saturated_u32,
};

#[cfg(feature = "experimental")]
pub mod eh_univ_optimized;
#[cfg(feature = "experimental")]
pub use eh_univ_optimized::{EHMapBucket, EHUnivMonBucket, EHUnivOptimized, EHUnivQueryResult};

pub mod octo;
pub use octo::{
    CmOctoAggregator, CmOctoPlan, CmOctoWorker, CmTopKOctoAggregator, CmTopKOctoPlan,
    CmTopKOctoWorker, CmWorkerSketch, CocoOctoAggregator, CocoOctoPlan, CocoOctoWorker,
    CocoWorkerSketch, CountOctoAggregator, CountOctoPlan, CountOctoWorker, CountTopKOctoAggregator,
    CountTopKOctoPlan, CountTopKOctoWorker, CountWorkerSketch, DEFAULT_OCTO_TOP_K,
    DdOctoAggregator, DdOctoPlan, DdOctoWorker, DdWorkerSketch, ElasticOctoAggregator,
    ElasticOctoPlan, ElasticOctoWorker, ElasticWorkerSketch, HllOctoAggregator, HllOctoPlan,
    HllOctoWorker, KeyedHashes, L2hhWorkerSketch, OctoAggregator, OctoPlan, OctoWorker, RowHashes,
    UnivMonInput, UnivMonOctoAggregator, UnivMonOctoPlan, UnivMonOctoWorker, flow_key_string,
    max_hll_threshold, threshold_for_error, univmon_layer_threshold,
};
#[cfg(feature = "octo-runtime")]
pub use octo::{
    OctoAdaptiveThreshold, OctoConfig, OctoPartition, OctoReadHandle, OctoResult, OctoRuntime,
    run_octo,
};

pub mod tumbling;
pub use tumbling::{
    FoldCMSConfig, FoldCSConfig, KLLConfig, SketchPool, TumblingWindow, TumblingWindowSketch,
};