README
incrcount
Compute a count incrementally.
Installation
npm install @stdlib/stats-incr-count
Usage
var incrcount = require( '@stdlib/stats-incr-count' );
incrcount()
Returns an accumulator function
which incrementally computes a count.
var accumulator = incrcount();
accumulator( [x] )
If provided an input value x
, the accumulator function returns an updated count. If not provided an input value x
, the accumulator function returns the current count.
var accumulator = incrcount();
var count = accumulator( 2.0 );
// returns 1
count = accumulator( 1.0 );
// returns 2
count = accumulator( 3.0 );
// returns 3
count = accumulator();
// returns 3
Examples
var randu = require( '@stdlib/random-base-randu' );
var incrcount = require( '@stdlib/stats-incr-count' );
var accumulator;
var v;
var i;
// Initialize an accumulator:
accumulator = incrcount();
// For each simulated datum, update the count...
for ( i = 0; i < 100; i++ ) {
v = randu() * 100.0;
accumulator( v );
}
console.log( accumulator() );
Notice
This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.
Community
License
See LICENSE.
Copyright
Copyright © 2016-2022. The Stdlib Authors.