@stdlib/stats-iter-cumean NPM

itercumean

Create an iterator which iteratively computes a cumulative arithmetic mean.

The cumulative arithmetic mean is defined as

Installation

npm install @stdlib/stats-iter-cumean

Usage

var itercumean = require( '@stdlib/stats-iter-cumean' );

itercumean( iterator )

Returns an iterator which iteratively computes a cumulative arithmetic mean.

var array2iterator = require( '@stdlib/array-to-iterator' );

var arr = array2iterator( [ 2.0, 1.0, 3.0, -7.0, -5.0 ] );
var it = itercumean( arr );

var m = it.next().value;
// returns 2.0

m = it.next().value;
// returns 1.5

m = it.next().value;
// returns 2.0

m = it.next().value;
// returns -0.25

m = it.next().value;
// returns -1.2

Notes

If an iterated value is non-numeric (including NaN), the function returns NaN for all future iterations. If non-numeric iterated values are possible, you are advised to provide an iterator which type checks and handles non-numeric values accordingly.

Examples

var runif = require( '@stdlib/random-iter-uniform' );
var itercumean = require( '@stdlib/stats-iter-cumean' );

// Create an iterator for generating uniformly distributed pseudorandom numbers:
var rand = runif( -10.0, 10.0, {
    'seed': 1234,
    'iter': 100
});

// Create an iterator for iteratively computing a cumulative mean:
var it = itercumean( rand );

// Perform manual iteration...
var v;
while ( true ) {
    v = it.next();
    if ( typeof v.value === 'number' ) {
        console.log( 'mean: %d', v.value );
    }
    if ( v.done ) {
        break;
    }
}

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.