Skip to content

Commit 6e77062

Browse files
AaryaBalwadkar-PHCAaryaBalwadkar-PHC
committed
feat(stats): add nanmmidrange package
1 parent fe0ad15 commit 6e77062

File tree

10 files changed

+1049
-0
lines changed

10 files changed

+1049
-0
lines changed

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

Lines changed: 166 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
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+
# incrnanmmidrange
22+
23+
> Compute a moving [mid-range][mid-range] incrementally, ignoring `NaN` values.
24+
25+
<section class="intro">
26+
27+
The [**mid-range**][mid-range], or **mid-extreme**, is the arithmetic mean of maximum and minimum values. Accordingly, the [mid-range][mid-range] is the midpoint of the [range][range] and a measure of central tendency.
28+
29+
</section>
30+
31+
<!-- /.intro -->
32+
33+
<section class="usage">
34+
35+
## Usage
36+
37+
```javascript
38+
var incrnanmmidrange = require( '@stdlib/stats/incr/nanmmidrange' );
39+
```
40+
41+
#### incrnanmmidrange( window )
42+
43+
Returns an accumulator `function` which incrementally computes a moving [mid-range][mid-range], ignoring `NaN` values. The `window` parameter defines the number of values over which to compute the moving [mid-range][mid-range].
44+
45+
```javascript
46+
var accumulator = incrnanmmidrange( 3 );
47+
```
48+
49+
#### accumulator( \[x] )
50+
51+
If provided an input value `x`, the accumulator function returns an updated [mid-range][mid-range]. If not provided an input value `x`, the accumulator function returns the current [mid-range][mid-range].
52+
53+
```javascript
54+
var accumulator = incrnanmmidrange( 3 );
55+
56+
var mr = accumulator();
57+
// returns null
58+
59+
// Fill the window...
60+
mr = accumulator( 2.0 ); // [2.0]
61+
// returns 2.0
62+
63+
mr = accumulator( 1.0 ); // [2.0, 1.0]
64+
// returns 1.5
65+
66+
mr = accumulator( 3.0 ); // [2.0, 1.0, 3.0]
67+
// returns 2.0
68+
69+
// Window begins sliding...
70+
mr = accumulator( -7.0 ); // [1.0, 3.0, -7.0]
71+
// returns -2.0
72+
73+
mr = accumulator( NaN ); // [1.0, 3.0, -7.0]
74+
// returns -2.0
75+
76+
mr = accumulator( -5.0 ); // [3.0, -7.0, -5.0]
77+
// returns -2.0
78+
79+
mr = accumulator();
80+
// returns -2.0
81+
```
82+
83+
</section>
84+
85+
<!-- /.usage -->
86+
87+
<section class="notes">
88+
89+
## Notes
90+
91+
- 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.
92+
- 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.
93+
94+
</section>
95+
96+
<!-- /.notes -->
97+
98+
<section class="examples">
99+
100+
## Examples
101+
102+
<!-- eslint no-undef: "error" -->
103+
104+
```javascript
105+
var randu = require( '@stdlib/random/base/randu' );
106+
var incrmmidrange = require( '@stdlib/stats/incr/mmidrange' );
107+
108+
var accumulator;
109+
var v;
110+
var i;
111+
112+
// Initialize an accumulator:
113+
accumulator = incrmmidrange( 5 );
114+
115+
// For each simulated datum, update the moving mid-range...
116+
for ( i = 0; i < 100; i++ ) {
117+
v = randu() * 100.0;
118+
accumulator( v );
119+
}
120+
console.log( accumulator() );
121+
```
122+
123+
</section>
124+
125+
<!-- /.examples -->
126+
127+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
128+
129+
<section class="related">
130+
131+
* * *
132+
133+
## See Also
134+
135+
- <span class="package-name">[`@stdlib/stats/incr/mmean`][@stdlib/stats/incr/mmean]</span><span class="delimiter">: </span><span class="description">compute a moving arithmetic mean incrementally.</span>
136+
- <span class="package-name">[`@stdlib/stats/incr/mmax`][@stdlib/stats/incr/mmax]</span><span class="delimiter">: </span><span class="description">compute a moving maximum incrementally.</span>
137+
- <span class="package-name">[`@stdlib/stats/incr/mmin`][@stdlib/stats/incr/mmin]</span><span class="delimiter">: </span><span class="description">compute a moving minimum incrementally.</span>
138+
- <span class="package-name">[`@stdlib/stats/incr/mrange`][@stdlib/stats/incr/mrange]</span><span class="delimiter">: </span><span class="description">compute a moving range incrementally.</span>
139+
140+
</section>
141+
142+
<!-- /.related -->
143+
144+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
145+
146+
<section class="links">
147+
148+
[range]: https://en.wikipedia.org/wiki/Range_%28statistics%29
149+
150+
[mid-range]: https://en.wikipedia.org/wiki/Mid-range
151+
152+
<!-- <related-links> -->
153+
154+
[@stdlib/stats/incr/mmean]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/mmean
155+
156+
[@stdlib/stats/incr/mmax]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/mmax
157+
158+
[@stdlib/stats/incr/mmin]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/mmin
159+
160+
[@stdlib/stats/incr/mrange]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/incr/mrange
161+
162+
<!-- </related-links> -->
163+
164+
</section>
165+
166+
<!-- /.links -->

‎lib/node_modules/@stdlib/stats/incr/nanmmidrange/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 incrnanmmidrange = 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 = incrnanmmidrange( (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 = incrnanmmidrange( 5 );
55+
56+
b.tic();
57+
for ( i = 0; i < b.iterations; i++ ) {
58+
v = acc( randu() );
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/nanmmidrange/docs/repl.txt‎

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

‎lib/node_modules/@stdlib/stats/incr/nanmmidrange/docs/types/index.d.ts‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
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+
// TypeScript Version: 4.1
20+
21+
/// <reference types="@stdlib/types"/>
22+
23+
/**
24+
* If provided a value, returns an updated mid-range; otherwise, returns the current mid-range.
25+
*
26+
* ## Notes
27+
*
28+
* - The mid-range is the arithmetic mean of maximum and minimum values. Accordingly, the mid-range is the midpoint of the range and a measure of central tendency.
29+
*
30+
* @param x - value
31+
* @returns mid-range
32+
*/
33+
type accumulator = ( x?: number ) => number | null;
34+
35+
/**
36+
* Returns an accumulator function which incrementally computes a moving mid-range.
37+
*
38+
* ## Notes
39+
*
40+
* - The `W` parameter defines the number of values over which to compute the moving mid-range.
41+
* - 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.
42+
*
43+
* @param W - window size
44+
* @throws must provide a positive integer
45+
* @returns accumulator function
46+
*
47+
* @example
48+
* var accumulator = incrmmidrange( 3 );
49+
*
50+
* var mr = accumulator();
51+
* // returns null
52+
*
53+
* mr = accumulator( 2.0 );
54+
* // returns 2.0
55+
*
56+
* mr = accumulator( -5.0 );
57+
* // returns -1.5
58+
*
59+
* mr = accumulator( 3.0 );
60+
* // returns -1.0
61+
*
62+
* mr = accumulator( 5.0 );
63+
* // returns 0.0
64+
*
65+
* mr = accumulator( NaN );
66+
* // returns 0.0
67+
*
68+
* mr = accumulator();
69+
* // returns 0.0
70+
*/
71+
declare function incrnanmmidrange( W: number ): accumulator;
72+
73+
74+
// EXPORTS //
75+
76+
export = incrnanmmidrange;

0 commit comments

Comments
 (0)