streaming-percentiles - npm Package Compare versions

Comparing version 2.2.0 to 2.3.0

package.json

 {
   "name": "streaming-percentiles",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "description": "Implementations of various streaming percentile algorithms",
@@ -5,0 +5,0 @@ "keywords": [

README.md

 # streaming-percentiles
 
-This is a library with implementations of various percentile algorithms
-on streams of data, with support for the following languages:
+## Build Status:
+Develop branch: [![Build Status](https://travis-ci.org/sengelha/streaming-percentiles-cpp.svg?branch=develop)](https://travis-ci.org/sengelha/streaming-percentiles-cpp)
+Master branch: [![Build Status](https://travis-ci.org/sengelha/streaming-percentiles-cpp.svg?branch=master)](https://travis-ci.org/sengelha/streaming-percentiles-cpp)
+
+This is a cross-pltaform library with implementations of various
+percentile algorithms on streams of data.  For more on streaming
+percentiles, see [Calculating Percentiles on Streaming
+Data](//stevenengelhardt.com/post-series/calculating-percentiles-on-streaming-data-2018/).
+
+The library supports the following languages:
 - C++
 - JavaScript
 
-For more on streaming percentiles, see [Calculating Percentiles on
-Streaming Data](https://stevenengelhardt.com/post-series/calculating-percentiles-on-streaming-data-2018/).
-
 ## Obtaining the Library
 
-You can download pre-built versions of the library from the
-[streaming-percentiles-cpp releases
-page](https://github.com/sengelha/streaming-percentiles-cpp/releases).
-Otherwise see [CONTRIBUTING.md](CONTRIBUTING.md) for instructions on how
-to compile the library from source.
+### C++
 
+You can download pre-built binaries of the library from the
+[streaming-percentiles latest release
+page](//github.com/sengelha/streaming-percentiles-cpp/releases/latest).
+
+### JavaScript
+
+If you use NPM, `npm install streaming-percentiles`. Otherwise, download
+pre-built binaries of the library from the [streaming-percentiles latest
+release
+page](//github.com/sengelha/streaming-percentiles-cpp/releases/latest)
+page.
+
+For convenience, you can also use the latest release JS directly
+from `sengelha.github.io`:
+
+- [Unminified version](//sengelha.github.io/streaming-percentiles/streamingPercentiles.v1.js)
+- [Minified version](//sengelha.github.io/streaming-percentiles/streamingPercentiles.v1.min.js)
+
+### Source Code
+
+You can download the latest release's source code from the
+[streaming-percentiles latest release
+page](//github.com/sengelha/streaming-percentiles-cpp/releases/latest).
+
+See `CONTRIBUTING.md` for instructions on how to build the release from
+source.
+
 ## Usage Example
@@ -23,3 +51,3 @@
 
-Here's a simple example on how to use the Greenwald-Khanna streaming
+Here's an example on how to use the Greenwald-Khanna streaming
 percentile algorithm from C++:
@@ -61,3 +89,3 @@
 ```html
-<script src="streamingPercentiles.v1.min.js"></script>
+<script src="//sengelha.github.io/streaming-percentiles/streamingPercentiles.v1.min.js"></script>
 <script>
@@ -74,4 +102,173 @@ var epsilon = 0.1;
 
-Coming soon!
+### Usage Notes
 
+- Every algorithm inherits from the interface `stmpct_alg`
+  which defines two methods: `void insert(double value)`
+  and `double quantile(double phi) const`.
+
+#### C++
+
+- All include files are in the directory `stmpct/`
+- All classes are in the `stmpct` namespace.
+
+#### JavaScript
+
+- For backwards-compatibility reasons, all class names are
+  capitalized.
+
+### interface stmpct_alg
+
+Defines the interface that all streaming percentile algorithms
+must implement.
+
+### void *stmpct_alg*.insert(double *value*)
+
+Logs the observation of a value.
+
+#### C++ Example
+
+```cpp
+stmpct_alg* alg = ...;
+alg->insert(rand());
+```
+
+#### JavaScript Example
+
+```javascript
+var alg = ...;
+alg.insert(Math.random());
+```
+
+### double *stmpct_alg*.quantile(double *phi*) const
+
+Compute the approximate quantile at *phi*.  For example, the 95th
+percentile corresponds to *phi* = 0.95.
+
+#### C++ Example
+
+```cpp
+stmpct_alg* alg = ...;
+var p50 = alg->quantile(0.5);
+```
+
+#### JavaScript Example
+
+```javascript
+var alg = ...;
+var p50 = alg.quantile(0.5);
+```
+
+### class gk(double *epsilon*)
+
+Implements the Greenwald-Khanna streaming percentile algorithm
+with allowable error *epsilon*.
+
+#### C++ Example
+
+```cpp
+#include <stmpct/gk.hpp>
+stmpct::gk g(0.1);
+```
+
+#### JavaScript Example
+
+```javascript
+var sp = require('streaming-percentiles');
+var gk = new sp.GK(0.1);
+```
+
+### class ckms_uq(double *epsilon*)
+
+Implements the Cormode-Korn-Muthukrishnan-Srivastava algorithm
+for uniform percentiles with allowable error *epsilon*.
+
+#### C++ Example
+
+```cpp
+#include <stmpct/ckms_uq.hpp>
+stmpct::ckms_uq c(0.1);
+```
+
+#### JavaScript Example
+
+```javascript
+var sp = require('streaming-percentiles');
+var gk = new sp.CKMS_UQ(0.1);
+```
+
+### class ckms_lbq(double *epsilon*)
+
+Implements the Cormode-Korn-Muthukrishnan-Srivastava algorithm
+for low-biased quantiles with allowable error *epsilon*.
+
+#### C++ Example
+
+```cpp
+#include <stmpct/ckms_lbq.hpp>
+stmpct::ckms_lbq c(0.1);
+```
+
+#### JavaScript Example
+
+```javascript
+var sp = require('streaming-percentiles');
+var gk = new sp.CKMS_LBQ(0.1);
+```
+
+### class ckms_hbq(double *epsilon*)
+
+Implements the Cormode-Korn-Muthukrishnan-Srivastava algorithm
+for high-biased quantiles with allowable error *epsilon*.
+
+#### C++ Example
+
+```cpp
+#include <stmpct/ckms_hbq.hpp>
+stmpct::ckms_hbq c(0.1);
+```
+
+#### JavaScript Example
+
+```javascript
+var sp = require('streaming-percentiles');
+var gk = new sp.CKMS_HBQ(0.1);
+```
+
+### class ckms_tq(vector<targeted_quantile> *tqs*)
+
+Implements the Cormode-Korn-Muthukrishnan-Srivastava algorithm
+for the provided set of targeted quantiles *tqs*.  Each
+targeted quantile is the combination of a quantile *phi* and
+allowable error *epsilon*.
+
+#### C++ Example
+
+```cpp
+#include <stmpct/ckms_tq.hpp>
+std::vector<targeted_quantile> tqs;
+tqs.emplace_back(0.125, 0.02);
+tqs.emplace_back(0.375, 0.02);
+tqs.emplace_back(0.75, 0.04);
+tqs.emplace_back(0.875, 0.01);
+ckms_tq c(tqs);
+```
+
+#### JavaScript Example
+
+```javascript
+var sp = require('streaming-percentiles');
+var tqs = [
+    { phi: 0.125, epsilon: 0.02 },
+    { phi: 0.375, epsilon: 0.02 },
+    { phi: 0.75, epsilon: 0.04 },
+    { phi: 0.875, epsilon: 0.01 }
+];
+var c = new sp.CKMS_TQ(tqs);
+```
+
+## License
+
+This project is licensed under the MIT License.  See
+[LICENSE](LICENSE) for more information.
+
 ## Contributing
@@ -78,0 +275,0 @@

New alerts

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

275

increased by252.56%

Number of medium supply chain risk alerts

2

decreased by-33.33%

Worsened metrics

Total package byte prevSize

158257

decreased by-3.4%

Lines of code

595

decreased by-6.15%

No dependency changes