Skip to content

README.md

Latest commit

 

History

History
174 lines (109 loc) · 5.34 KB

README.md

File metadata and controls

174 lines (109 loc) · 5.34 KB

incrnanmme

Compute a moving mean error (ME) incrementally.

For a window of size W, the mean error is defined ignoring any (x, y) pairs containing NaN.

$$\mathop{\mathrm{ME}} = \frac{1}{W} \sum_{i=0}^{W-1} (y_i - x_i)$$

Usage

var incrnanmme = require( '@stdlib/stats/incr/nanmme' );

incrnanmme( window )

Returns an accumulator function which incrementally computes a moving mean error, ignoring any (x, y) pairs containing NaN. The window parameter defines the number of values over which to compute the moving mean error.

var accumulator = incrnanmme( 3 );

accumulator( [x, y] )

If provided input values x and y, the accumulator function returns an updated mean error. If not provided input values x and y, the accumulator function returns the current mean error.

var accumulator = incrnanmme( 3 );

var m = accumulator();
// returns null

// Fill the window...
m = accumulator( 2.0, 3.0 ); // [(2.0,3.0)]
// returns 1.0

m = accumulator( -1.0, 4.0 ); // [(2.0,3.0), (-1.0,4.0)]
// returns 3.0

m = accumulator( 3.0, NaN ); // ignored
// returns 3.0

// Window begins sliding...
m = accumulator( -7.0, 3.0 );
// returns 5.333333333333334

m = accumulator( -5.0, -3.0 );
// returns 5.666666666666667

m = accumulator();
// returns 5.666666666666667

Notes

  • Input values are not type checked. Any (x, y) pair containing NaN is ignored and does not update the window.
  • As W (x,y) pairs 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.
  • Be careful when interpreting the mean error as errors can cancel. This stated, that errors can cancel makes the mean error suitable for measuring the bias in forecasts.
  • Warning: the mean error is scale-dependent and, thus, the measure should not be used to make comparisons between datasets having different scales.

Examples

var randu = require( '@stdlib/random/base/randu' );
var incrnanmme = require( '@stdlib/stats/incr/nanmme' );

var accumulator;
var v1;
var v2;
var i;

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

// For each simulated datum, update the moving mean error...
for ( i = 0; i < 100; i++ ) {
    v1 = ( randu()*100.0 ) - 50.0;
    v2 = ( randu()*100.0 ) - 50.0;
    accumulator( v1, v2 );
}
console.log( accumulator() );

See Also