Skip to content

Commit 9bd9c8f

Browse files
satansin123Planeshifter
satansin123
and
Planeshifter
authored
feat: add stats/incr/nanmmean
PR-URL: #6185 Closes: #5588 Co-authored-by: Philipp Burckhardt <pburckhardt@outlook.com> Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
1 parent c5ec2d1 commit 9bd9c8f

11 files changed

Lines changed: 853 additions & 0 deletions

File tree

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

Lines changed: 161 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,161 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2026 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+
# incrnanmmean
22+
23+
> Compute a moving [arithmetic mean][arithmetic-mean] incrementally, ignoring `NaN` values.
24+
25+
<section class="intro">
26+
27+
For a window of size `W`, the [arithmetic mean][arithmetic-mean] is defined as
28+
29+
<!-- <equation class="equation" label="eq:arithmetic_mean" align="center" raw="\bar{x} = \frac{1}{W} \sum_{i=0}^{W-1} x_i" alt="Equation for the arithmetic mean."> -->
30+
31+
```math
32+
\bar{x} = \frac{1}{W} \sum_{i=0}^{W-1} x_i
33+
```
34+
35+
<!-- <div class="equation" align="center" data-raw-text="\bar{x} = \frac{1}{W} \sum_{i=0}^{W-1} x_i" data-equation="eq:arithmetic_mean">
36+
<img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@320a89534d4f59b82d162f31e968222555dae2f7/lib/node_modules/@stdlib/stats/incr/nanmmean/docs/img/equation_arithmetic_mean.svg" alt="Equation for the arithmetic mean.">
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 incrnanmmean = require( '@stdlib/stats/incr/nanmmean' );
52+
```
53+
54+
#### incrnanmmean( window )
55+
56+
Returns an accumulator `function` which incrementally computes a moving [arithmetic mean][arithmetic-mean], ignoring `NaN` values. The `window` parameter defines the number of values over which to compute the moving mean.
57+
58+
```javascript
59+
var accumulator = incrnanmmean( 3 );
60+
```
61+
62+
#### accumulator( \[x] )
63+
64+
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.
65+
66+
```javascript
67+
var accumulator = incrnanmmean( 3 );
68+
69+
var mu = accumulator();
70+
// returns null
71+
72+
// Fill the window...
73+
mu = accumulator( 2.0 ); // [2.0]
74+
// returns 2.0
75+
76+
mu = accumulator( 1.0 ); // [2.0, 1.0]
77+
// returns 1.5
78+
79+
mu = accumulator( 3.0 ); // [2.0, 1.0, 3.0]
80+
// returns 2.0
81+
82+
// Window begins sliding...
83+
mu = accumulator( -7.0 ); // [1.0, 3.0, -7.0]
84+
// returns -1.0
85+
86+
mu = accumulator( NaN ); // [1.0, 3.0, -7.0]
87+
// returns -1.0
88+
89+
mu = accumulator( -5.0 ); // [3.0, -7.0, -5.0]
90+
// returns -3.0
91+
92+
mu = accumulator();
93+
// returns -3.0
94+
```
95+
96+
</section>
97+
98+
<!-- /.usage -->
99+
100+
<section class="notes">
101+
102+
## Notes
103+
104+
- 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.
105+
- 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.
106+
107+
</section>
108+
109+
<!-- /.notes -->
110+
111+
<section class="examples">
112+
113+
## Examples
114+
115+
<!-- eslint no-undef: "error" -->
116+
117+
```javascript
118+
var uniform = require( '@stdlib/random/base/uniform' );
119+
var bernoulli = require( '@stdlib/random/base/bernoulli' );
120+
var incrnanmmean = require( '@stdlib/stats/incr/nanmmean' );
121+
122+
var accumulator;
123+
var v;
124+
var i;
125+
126+
// Initialize an accumulator:
127+
accumulator = incrnanmmean( 5 );
128+
129+
// For each simulated datum, update the moving mean...
130+
for ( i = 0; i < 100; i++ ) {
131+
v = ( bernoulli( 0.8 ) < 1 ) ? NaN : uniform( 0.0, 100.0 );
132+
accumulator( v );
133+
}
134+
console.log( accumulator() );
135+
```
136+
137+
</section>
138+
139+
<!-- /.examples -->
140+
141+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
142+
143+
<section class="related">
144+
145+
</section>
146+
147+
<!-- /.related -->
148+
149+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
150+
151+
<section class="links">
152+
153+
[arithmetic-mean]: https://en.wikipedia.org/wiki/Arithmetic_mean
154+
155+
<!-- <related-links> -->
156+
157+
<!-- </related-links> -->
158+
159+
</section>
160+
161+
<!-- /.links -->

‎lib/node_modules/@stdlib/stats/incr/nanmmean/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) 2026 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 format = require( '@stdlib/string/format' );
25+
var pkg = require( './../package.json' ).name;
26+
var incrnanmmean = 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 = incrnanmmean( (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( format( '%s::accumulator', pkg ), function benchmark( b ) {
50+
var acc;
51+
var v;
52+
var i;
53+
54+
acc = incrnanmmean( 5 );
55+
56+
b.tic();
57+
for ( i = 0; i < b.iterations; i++ ) {
58+
v = acc( i );
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/nanmmean/docs/img/equation_arithmetic_mean.svg‎

Lines changed: 43 additions & 0 deletions
Loading

‎lib/node_modules/@stdlib/stats/incr/nanmmean/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+
arithmetic mean, ignoring `NaN` values.
5+
6+
The `W` parameter defines the number of values over which to compute the
7+
moving mean.
8+
9+
If provided a value, the accumulator function returns an updated moving
10+
mean. If not provided a value, the accumulator function returns the current
11+
moving mean.
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 mu = accumulator()
31+
null
32+
> mu = accumulator( 2.0 )
33+
2.0
34+
> mu = accumulator( -5.0 )
35+
-1.5
36+
> mu = accumulator( NaN )
37+
-1.5
38+
> mu = accumulator( 3.0 )
39+
0.0
40+
> mu = accumulator( 5.0 )
41+
1.0
42+
> mu = accumulator( NaN )
43+
1.0
44+
> mu = accumulator()
45+
1.0
46+
47+
See Also
48+
--------
49+

0 commit comments

Comments
 (0)