Package Exports

@stdlib/stats-incr-nancount
@stdlib/stats-incr-nancount/lib/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/stats-incr-nancount) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

incrnancount

Compute a count incrementally, ignoring NaN values.

Installation

npm install @stdlib/stats-incr-nancount

Usage

var incrnancount = require( '@stdlib/stats-incr-nancount' );

incrnancount()

Returns an accumulator function which incrementally computes a count, ignoring NaN values.

var accumulator = incrnancount();

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 = incrnancount();

var count = accumulator( 2.0 );
// returns 1

count = accumulator( 1.0 );
// returns 2

count = accumulator( NaN );
// returns 2

count = accumulator( 3.0 );
// returns 3

count = accumulator();
// returns 3

Examples

var randu = require( '@stdlib/random-base-randu' );
var incrnancount = require( '@stdlib/stats-incr-nancount' );

var accumulator;
var v;
var i;

// Initialize an accumulator:
accumulator = incrnancount();

// For each simulated datum, update the count...
for ( i = 0; i < 100; i++ ) {
    if ( randu() < 0.2 ) {
        v = NaN;
    } else {
        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.

@stdlib/stats-incr-nancount