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!

incrmape

[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]

> Compute the [mean absolute percentage error][mean-absolute-percentage-error] (MAPE) incrementally.

The [mean absolute percentage error][mean-absolute-percentage-error] is defined as

Equation for the mean absolute percentage error.

where f_i is the forecast value and a_i is the actual value.

Installation

``bash npm install @stdlib/stats-incr-mape`

`Usage`

`javascript var incrmape = require( '@stdlib/stats-incr-mape' );`

#### incrmape()

Returns an accumulator function which incrementally computes the [mean absolute percentage error][mean-absolute-percentage-error].

`javascript var accumulator = incrmape();`

#### accumulator( \[f, a] )

If provided input values f and a, the accumulator function returns an updated [mean absolute percentage error][mean-absolute-percentage-error]. If not provided input values f and a, the accumulator function returns the current [mean absolute percentage error][mean-absolute-percentage-error].

`javascript var accumulator = incrmape();

var m = accumulator( 2.0, 3.0 ); // returns ~33.33

m = accumulator( 1.0, 4.0 ); // returns ~54.17

m = accumulator( 3.0, 5.0 ); // returns ~49.44

m = accumulator(); // returns ~49.44`

`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 all 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.

- Warning: the [mean absolute percentage error][mean-absolute-percentage-error] has several shortcomings:

- The measure is not suitable for intermittent demand patterns (i.e., when a_i is 0). - The [mean absolute percentage error][mean-absolute-percentage-error] is not symmetrical, as the measure cannot exceed 100% for forecasts which are too "low" and has no limit for forecasts which are too "high". - When used to compare the accuracy of forecast models (e.g., predicting demand), the measure is biased toward forecasts which are too low.

`Examples`

`javascript var randu = require( '@stdlib/random-base-randu' ); var incrmape = require( '@stdlib/stats-incr-mape' );

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

// Initialize an accumulator: accumulator = incrmape();

// For each simulated datum, update the mean absolute percentage 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() );`

*

`Notice`

This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].

#### Community

[![Chat][chat-image]][chat-url]

---

`License`

See [LICENSE][stdlib-license].

`Copyright`

[npm-image]: http://img.shields.io/npm/v/@stdlib/stats-incr-mape.svg [npm-url]: https://npmjs.org/package/@stdlib/stats-incr-mape

[test-image]: https://github.com/stdlib-js/stats-incr-mape/actions/workflows/test.yml/badge.svg?branch=v0.2.3 [test-url]: https://github.com/stdlib-js/stats-incr-mape/actions/workflows/test.yml?query=branch:v0.2.3

[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-incr-mape/main.svg [coverage-url]: https://codecov.io/github/stdlib-js/stats-incr-mape?branch=main

[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg [chat-url]: https://stdlib.zulipchat.com

[stdlib]: https://github.com/stdlib-js/stdlib

[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors

[umd]: https://github.com/umdjs/umd [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules

[deno-url]: https://github.com/stdlib-js/stats-incr-mape/tree/deno [deno-readme]: https://github.com/stdlib-js/stats-incr-mape/blob/deno/README.md [umd-url]: https://github.com/stdlib-js/stats-incr-mape/tree/umd [umd-readme]: https://github.com/stdlib-js/stats-incr-mape/blob/umd/README.md [esm-url]: https://github.com/stdlib-js/stats-incr-mape/tree/esm [esm-readme]: https://github.com/stdlib-js/stats-incr-mape/blob/esm/README.md [branches-url]: https://github.com/stdlib-js/stats-incr-mape/blob/main/branches.md

[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-incr-mape/main/LICENSE

[mean-absolute-percentage-error]: https://en.wikipedia.org/wiki/Mean_absolute_percentage_error

[@stdlib/stats/incr/maape]: https://www.npmjs.com/package/@stdlib/stats-incr-maape

[@stdlib/stats/incr/mae]: https://www.npmjs.com/package/@stdlib/stats-incr-mae

[@stdlib/stats/incr/mean]: https://www.npmjs.com/package/@stdlib/stats-incr-mean

[@stdlib/stats/incr/mmape]: https://www.npmjs.com/package/@stdlib/stats-incr-mmape


  
    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!

`incrmape`

[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]

> Compute the [mean absolute percentage error][mean-absolute-percentage-error] (MAPE) incrementally.

The [mean absolute percentage error][mean-absolute-percentage-error] is defined as

where f_i is the forecast value and a_i is the actual value.

`Installation`

``bash npm install @stdlib/stats-incr-mape `

`Usage`

`javascript var incrmape = require( '@stdlib/stats-incr-mape' ); `

#### incrmape()

Returns an accumulator function which incrementally computes the [mean absolute percentage error][mean-absolute-percentage-error].

`javascript var accumulator = incrmape(); `

#### accumulator( \[f, a] )

If provided input values f and a, the accumulator function returns an updated [mean absolute percentage error][mean-absolute-percentage-error]. If not provided input values f and a, the accumulator function returns the current [mean absolute percentage error][mean-absolute-percentage-error].

`javascript var accumulator = incrmape();

var m = accumulator( 2.0, 3.0 ); // returns ~33.33

m = accumulator( 1.0, 4.0 ); // returns ~54.17

m = accumulator( 3.0, 5.0 ); // returns ~49.44

m = accumulator(); // returns ~49.44 `

`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 all 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.

- Warning: the [mean absolute percentage error][mean-absolute-percentage-error] has several shortcomings:

- The measure is not suitable for intermittent demand patterns (i.e., when a_i is 0). - The [mean absolute percentage error][mean-absolute-percentage-error] is not symmetrical, as the measure cannot exceed 100% for forecasts which are too "low" and has no limit for forecasts which are too "high". - When used to compare the accuracy of forecast models (e.g., predicting demand), the measure is biased toward forecasts which are too low.

`Examples`

`javascript var randu = require( '@stdlib/random-base-randu' ); var incrmape = require( '@stdlib/stats-incr-mape' );

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

// Initialize an accumulator: accumulator = incrmape();

// For each simulated datum, update the mean absolute percentage 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() ); `