time-to-botec/js/node_modules/@stdlib/stats/iter/mean/README.md

itermean

Compute the arithmetic mean over all iterated values.

The arithmetic mean is defined as

Usage

var itermean = require( '@stdlib/stats/iter/mean' );

itermean( iterator )

Computes the arithmetic mean over all iterated values.

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

var arr = array2iterator( [ 1.0, 2.0, 3.0, 4.0 ] );

var m = itermean( arr );
// returns 2.5

Notes

• If an iterated value is non-numeric (including NaN), the returned iterator returns NaN. 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 itermean = require( '@stdlib/stats/iter/mean' );

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

// Compute the arithmetic mean:
var m = itermean( rand );
// returns <number>

console.log( 'Mean: %d.', m );