Skip to content

Commit 2f7a35f

Browse files
authored
Update README.md
1 parent b2e90e7 commit 2f7a35f

File tree

1 file changed

+13
-15
lines changed

1 file changed

+13
-15
lines changed

README.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
11
# sketches-rust
2-
This is a direct port of the java [DDSketch](https://github.com/DataDog/sketches-java) quantile implementation writen by Rust. DDSketch is mergeable, meaning that multiple sketches from distributed systems can be combined in a central node.
2+
The port of the [DDSketch](https://github.com/DataDog/sketches-java) rust implementation.
33

44
# Features
5-
It aims at as compatible as possible with Java implementations, here is some features has support:
6-
- [x] CubicallyInterpolatedMapping
7-
- [x] LogarithmicMapping
8-
- [x] CollapsingHighestDenseStore: collapse the highest bucket when reach specified size
9-
- [x] CollapsingLowestDenseStore: collapse the lowest bucket when reach specified size
10-
- [x] UnboundedSizeDenseStore: unlimited bucket
11-
- [x] Merge with other instance
12-
- [x] Deserialize from bytes
13-
- [x] Serialize to bytes
5+
- CubicallyInterpolatedMapping
6+
- LogarithmicMapping
7+
- CollapsingHighestDenseStore: collapse the highest bucket when reach specified size
8+
- CollapsingLowestDenseStore: collapse the lowest bucket when reach specified size
9+
- UnboundedSizeDenseStore: unlimited bucket
10+
- Merge with other instance
11+
- Serialize & Deserialize
1412

1513
# Usage
1614

@@ -25,8 +23,8 @@ Or add the following line to your Cargo.toml:
2523
sketches-rust = "0.2.2"
2624
```
2725

28-
# Demos
29-
Query quantile:
26+
27+
Query:
3028
```rust
3129
use sketches_rust::DDSketch;
3230
let mut d = DDSketch::collapsing_lowest_dense(0.02,100).unwrap();
@@ -39,7 +37,7 @@ Query quantile:
3937
assert!(q < 2.01 && q > 1.99);
4038
```
4139

42-
Merge with other instance:
40+
Merge:
4341
```rust
4442
use sketches_rust::DDSketch;
4543
let mut d1 = DDSketch::collapsing_lowest_dense(0.02,100).unwrap();
@@ -56,7 +54,7 @@ Merge with other instance:
5654
assert_eq!(6.0, d2.get_count());
5755
```
5856

59-
Serialize to bytes:
57+
Serialize:
6058
```rust
6159
use sketches_rust::DDSketch;
6260
let mut d = DDSketch::unbounded_dense(2e-2).unwrap();
@@ -69,7 +67,7 @@ Serialize to bytes:
6967

7068
```
7169

72-
Deserialize from bytes:
70+
Deserialize:
7371
```rust
7472
use sketches_rust::DDSketch;
7573
let mut input = vec![

0 commit comments

Comments
 (0)