sketches_ddsketch/lib.rs
1/*!
2This crate provides a direct port of the [Golang](https://github.com/DataDog/sketches-go)
3[DDSketch](https://arxiv.org/pdf/1908.10693.pdf) implementation to Rust. All efforts
4have been made to keep this as close to the original implementation as possible, with a few tweaks to
5get closer to idiomatic Rust.
6
7# Usage
8
9Add multiple samples to a DDSketch and invoke the `quantile` method to pull any quantile from
10*0.0* to *1.0*.
11
12```rust
13use sketches_ddsketch::{Config, DDSketch};
14
15let c = Config::defaults();
16let mut d = DDSketch::new(c);
17
18d.add(1.0);
19d.add(1.0);
20d.add(1.0);
21
22let q = d.quantile(0.50).unwrap();
23
24assert!(q < Some(1.01));
25assert!(q > Some(0.99));
26```
27
28Sketches can also be merged.
29
30```rust
31use sketches_ddsketch::{Config, DDSketch};
32
33let c = Config::defaults();
34let mut d1 = DDSketch::new(c);
35let mut d2 = DDSketch::new(c);
36
37d1.add(1.0);
38d2.add(2.0);
39d2.add(2.0);
40
41d1.merge(&d2);
42
43assert_eq!(d1.count(), 3);
44```
45
46 */
47
48pub use self::config::Config;
49pub use self::ddsketch::{DDSketch, DDSketchError};
50
51mod config;
52mod ddsketch;
53mod store;