Skip to content

Commit 7884049

Browse files
anxhukumaranxhukumar
committed
feat(stats): add nanmmae package
1 parent 9e91f81 commit 7884049

File tree

11 files changed

+976
-0
lines changed

11 files changed

+976
-0
lines changed

‎lib/node_modules/@stdlib/stats/incr/nanmmae/README.md‎

Lines changed: 160 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2025 The Stdlib Authors.
6+
7+
Licensed under the Apache License, Version 2.0 (the "License");
8+
you may not use this file except in compliance with the License.
9+
You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing, software
14+
distributed under the License is distributed on an "AS IS" BASIS,
15+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
See the License for the specific language governing permissions and
17+
limitations under the License.
18+
19+
-->
20+
21+
# incrnanmmae
22+
23+
> Compute a moving [mean absolute error][mean-absolute-error] (MAE) incrementally, ignoring `NaN` values.
24+
25+
<section class="intro">
26+
27+
For a window of size `W`, the [mean absolute error][mean-absolute-error] is defined as
28+
29+
<!-- <equation class="equation" label="eq:mean_absolute_error" align="center" raw="\operatorname{MAE} = \frac{1}{W} \sum_{i=0}^{W-1} |y_i - x_i|" alt="Equation for the mean absolute error."> -->
30+
31+
```math
32+
\mathop{\mathrm{MAE}} = \frac{1}{W} \sum_{i=0}^{W-1} |y_i - x_i|
33+
```
34+
35+
<!-- <div class="equation" align="center" data-raw-text="\operatorname{MAE} = \frac{1}{W} \sum_{i=0}^{W-1} |y_i - x_i|" data-equation="eq:mean_absolute_error">
36+
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@2fd94e331f96b2984303ca92fad16757cfc5fdcb/lib/node_modules/@stdlib/stats/incr/nanmmae/docs/img/equation_mean_absolute_error.svg" alt="Equation for the mean absolute error.">
37+
<br>
38+
</div> -->
39+
40+
<!-- </equation> -->
41+
42+
</section>
43+
44+
<!-- /.intro -->
45+
46+
<section class="usage">
47+
48+
## Usage
49+
50+
```javascript
51+
var incrnanmmae = require( '@stdlib/stats/incr/nanmmae' );
52+
```
53+
54+
#### incrnanmmae( window )
55+
56+
Returns an accumulator function which incrementally computes a moving [mean absolute error][mean-absolute-error]. The `window` parameter defines the number of values over which to compute the moving [mean absolute error][mean-absolute-error], ignoring `NaN` values.
57+
58+
```javascript
59+
var accumulator = incrnanmmae( 3 );
60+
```
61+
62+
#### accumulator( \[x, y] )
63+
64+
If provided input values `x` and `y`, the accumulator function returns an updated [mean absolute error][mean-absolute-error]. If not provided input values `x` and `y`, the accumulator function returns the current [mean absolute error][mean-absolute-error].
65+
66+
```javascript
67+
var accumulator = incrnanmmae( 3 );
68+
69+
var m = accumulator();
70+
// returns null
71+
72+
// Fill the window...
73+
m = accumulator( 2.0, 3.0 ); // [(2.0,3.0)]
74+
// returns 1.0
75+
76+
m = accumulator( NaN, 2.0 );
77+
// returns 1.0
78+
79+
m = accumulator( -5.0, NaN );
80+
// returns 1.0
81+
82+
m = accumulator( -1.0, 4.0 ); // [(2.0,3.0), (-1.0,4.0)]
83+
// returns 3.0
84+
85+
m = accumulator( 3.0, 9.0 ); // [(2.0,3.0), (-1.0,4.0), (3.0,9.0)]
86+
// returns 4.0
87+
88+
// Window begins sliding...
89+
m = accumulator( -7.0, 3.0 ); // [(-1.0,4.0), (3.0,9.0), (-7.0,3.0)]
90+
// returns 7.0
91+
92+
m = accumulator( -5.0, -3.0 ); // [(3.0,9.0), (-7.0,3.0), (-5.0,-3.0)]
93+
// returns 6.0
94+
95+
m = accumulator();
96+
// returns 6.0
97+
```
98+
99+
</section>
100+
101+
<!-- /.usage -->
102+
103+
<section class="notes">
104+
105+
## Notes
106+
107+
- Input values are **not** type checked. If non-numeric inputs are possible, you are advised to type check and handle accordingly **before** passing the value to the accumulator function.
108+
- 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.
109+
- **Warning**: the [mean absolute error][mean-absolute-error] is scale-dependent and, thus, the measure should **not** be used to make comparisons between datasets having different scales.
110+
111+
</section>
112+
113+
<!-- /.notes -->
114+
115+
<section class="examples">
116+
117+
## Examples
118+
119+
<!-- eslint no-undef: "error" -->
120+
121+
```javascript
122+
var randu = require( '@stdlib/random/base/randu' );
123+
var incrnanmmae = require( '@stdlib/stats/incr/nanmmae' );
124+
125+
// Initialize an accumulator:
126+
var accumulator = incrnanmmae( 5 );
127+
128+
// For each simulated datum, update the moving mean absolute error...
129+
var v1;
130+
var v2;
131+
var i;
132+
for ( i = 0; i < 100; i++ ) {
133+
v1 = ( randu()*100.0 ) - 50.0;
134+
v2 = ( randu()*100.0 ) - 50.0;
135+
accumulator( v1, v2 );
136+
}
137+
console.log( accumulator() );
138+
```
139+
140+
</section>
141+
142+
<!-- /.examples -->
143+
144+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
145+
146+
<section class="related">
147+
148+
</section>
149+
150+
<!-- /.related -->
151+
152+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
153+
154+
<section class="links">
155+
156+
[mean-absolute-error]: https://en.wikipedia.org/wiki/Mean_absolute_error
157+
158+
</section>
159+
160+
<!-- /.links -->

‎lib/node_modules/@stdlib/stats/incr/nanmmae/benchmark/benchmark.js‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
// MODULES //
22+
23+
var bench = require( '@stdlib/bench' );
24+
var randu = require( '@stdlib/random/base/randu' );
25+
var pkg = require( './../package.json' ).name;
26+
var incrnanmmae = require( './../lib' );
27+
28+
29+
// MAIN //
30+
31+
bench( pkg, function benchmark( b ) {
32+
var f;
33+
var i;
34+
b.tic();
35+
for ( i = 0; i < b.iterations; i++ ) {
36+
f = incrnanmmae( (i%5)+1 );
37+
if ( typeof f !== 'function' ) {
38+
b.fail( 'should return a function' );
39+
}
40+
}
41+
b.toc();
42+
if ( typeof f !== 'function' ) {
43+
b.fail( 'should return a function' );
44+
}
45+
b.pass( 'benchmark finished' );
46+
b.end();
47+
});
48+
49+
bench( pkg+'::accumulator', function benchmark( b ) {
50+
var acc;
51+
var v;
52+
var i;
53+
54+
acc = incrnanmmae( 5 );
55+
56+
b.tic();
57+
for ( i = 0; i < b.iterations; i++ ) {
58+
v = acc( randu()-0.5, randu()-0.5 );
59+
if ( v !== v ) {
60+
b.fail( 'should not return NaN' );
61+
}
62+
}
63+
b.toc();
64+
if ( v !== v ) {
65+
b.fail( 'should not return NaN' );
66+
}
67+
b.pass( 'benchmark finished' );
68+
b.end();
69+
});

‎lib/node_modules/@stdlib/stats/incr/nanmmae/docs/img/equation_mean_absolute_error.svg‎

Lines changed: 55 additions & 0 deletions
Loading

‎lib/node_modules/@stdlib/stats/incr/nanmmae/docs/repl.txt‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
2+
{{alias}}( W )
3+
Returns an accumulator function which incrementally computes a moving
4+
mean absolute error (MAE), ignoring `NaN` values.
5+
6+
The `W` parameter defines the number of values over which to compute the
7+
moving mean absolute error.
8+
9+
If provided a value, the accumulator function returns an updated moving
10+
mean absolute error. If not provided a value, the accumulator function
11+
returns the current moving mean absolute error.
12+
13+
As `W` values are needed to fill the window buffer, the first `W-1` returned
14+
values are calculated from smaller sample sizes. Until the window is full,
15+
each returned value is calculated from all provided values.
16+
17+
Parameters
18+
----------
19+
W: integer
20+
Window size.
21+
22+
Returns
23+
-------
24+
acc: Function
25+
Accumulator function.
26+
27+
Examples
28+
--------
29+
> var accumulator = {{alias}}( 3 );
30+
> var m = accumulator()
31+
null
32+
> m = accumulator( 2.0, 3.0 )
33+
1.0
34+
> m = accumulator( NaN, 2.0 )
35+
1.0
36+
> m = accumulator( -5.0, NaN )
37+
1.0
38+
> m = accumulator( -5.0, 2.0 )
39+
4.0
40+
> m = accumulator( 3.0, 2.0 )
41+
3.0
42+
> m = accumulator( 5.0, -2.0 )
43+
5.0
44+
> m = accumulator()
45+
5.0
46+
47+
See Also
48+
--------
49+

0 commit comments

Comments
 (0)