@stdlib/stats-incr-mme
TypeScript icon, indicating that this package has built-in type declarations

0.2.1 • Public • Published
About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

incrmme

NPM version Build Status Coverage Status

Compute a moving mean error (ME) incrementally.

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

Equation for the mean error.

Installation

npm install @stdlib/stats-incr-mme

Usage

var incrmme = require( '@stdlib/stats-incr-mme' );

incrmme( window )

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

var accumulator = incrmme( 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 = incrmme( 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, 9.0 ); // [(2.0,3.0), (-1.0,4.0), (3.0,9.0)]
// returns 4.0

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

m = accumulator( -5.0, -3.0 ); // [(3.0,9.0), (-7.0,3.0), (-5.0,-3.0)]
// returns 6.0

m = accumulator();
// returns 6.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 (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 incrmme = require( '@stdlib/stats-incr-mme' );

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

// Initialize an accumulator:
accumulator = incrmme( 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


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

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.

Package Sidebar

Install

npm i @stdlib/stats-incr-mme

Homepage

stdlib.io

Weekly Downloads

18

Version

0.2.1

License

Apache-2.0

Unpacked Size

40.6 kB

Total Files

12

Last publish

Collaborators

  • stdlib-bot
  • kgryte
  • planeshifter
  • rreusser