diff --git a/README.md b/README.md index 4e80a89..7bb9524 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ![Continuous Integration](https://github.com/GraphMetrics/sketches-js/workflows/Continuous%20Integration/badge.svg) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) -This repo contains the TypeScript implementation of the distributed quantile sketch algorithm [DDSketch](http://www.vldb.org/pvldb/vol12/p2195-masson.pdf). DDSketch is mergeable, meaning that multiple sketches from distributed systems can be combined in a central node. +This repo contains the TypeScript implementation of the distributed quantile sketch algorithm [DDSketch](http://www.vldb.org/pvldb/vol12/p2195-masson.pdf) originally developed by [DataDog](https://github.com/DataDog/sketches-js)™. DDSketch is mergeable, meaning that multiple sketches from distributed systems can be combined in a central node. ## Installation @@ -45,7 +45,7 @@ const sketch = new DDSketch({ ### Add values to a sketch -To add a number to a sketch, call `sketch.accept(value)`. Only positive numbers above or equal to 1 are supported. +To add a number to a sketch, call `sketch.accept(value)`. Only positive numbers above 0 are supported. ```js const measurementOne = 1607374726; diff --git a/test/test.test.ts b/test/test.test.ts deleted file mode 100644 index 5bd093c..0000000 --- a/test/test.test.ts +++ /dev/null @@ -1,19 +0,0 @@ -import { - CubicallyInterpolatedMapping, - LinearlyInterpolatedMapping, - LogarithmicMapping -} from '../src/ddsketch/mapping'; -import { MAX_INT_16, MIN_INT_16 } from '../src/ddsketch/mapping/KeyMapping'; - -it('is within bounds', () => { - const mapping = new CubicallyInterpolatedMapping(0.01); - - const minIndex = mapping.key(mapping.minPossible); - const maxIndex = mapping.key(mapping.maxPossible); - - console.log(minIndex); - console.log(maxIndex); - - expect(minIndex).toBeGreaterThan(MIN_INT_16); - expect(maxIndex).toBeLessThan(MAX_INT_16); -});