@stdlib/stats-incr-mmean NPM

incrmmean

Compute a moving arithmetic mean incrementally.

For a window of size W, the arithmetic mean is defined as

Installation

npm install @stdlib/stats-incr-mmean

Usage

var incrmmean = require( '@stdlib/stats-incr-mmean' );

incrmmean( window )

Returns an accumulator function which incrementally computes a moving arithmetic mean. The window parameter defines the number of values over which to compute the moving mean.

var accumulator = incrmmean( 3 );

accumulator( [x] )

If provided an input value x, the accumulator function returns an updated mean. If not provided an input value x, the accumulator function returns the current mean.

var accumulator = incrmmean( 3 );

var mu = accumulator();
// returns null

// Fill the window...
mu = accumulator( 2.0 ); // [2.0]
// returns 2.0

mu = accumulator( 1.0 ); // [2.0, 1.0]
// returns 1.5

mu = accumulator( 3.0 ); // [2.0, 1.0, 3.0]
// returns 2.0

// Window begins sliding...
mu = accumulator( -7.0 ); // [1.0, 3.0, -7.0]
// returns -1.0

mu = accumulator( -5.0 ); // [3.0, -7.0, -5.0]
// returns -3.0

mu = accumulator();
// returns -3.0

Notes

Input values are not type checked. If provided NaN or a value which, when used in computations, results in NaN, the accumulated value is NaN for at least W-1 future invocations. If non-numeric inputs are possible, you are advised to type check and handle accordingly before passing the value to the accumulator function.
As W values are needed to fill the window buffer, the first W-1 returned values are calculated from smaller sample sizes. Until the window is full, each returned value is calculated from all provided values.

Examples

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

var accumulator;
var v;
var i;

// Initialize an accumulator:
accumulator = incrmmean( 5 );

// For each simulated datum, update the moving mean...
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.