Skip to content

Commit 6b97f56

Browse files
Sachinn-64Planeshifterstdlib-bot
authored
feat: add stats/base/ndarray/snanmskmidrange
PR-URL: #9536 Co-authored-by: Philipp Burckhardt <pburckhardt@outlook.com> Co-authored-by: stdlib-bot <noreply@stdlib.io> Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com> Signed-off-by: Philipp Burckhardt <pburckhardt@outlook.com>
1 parent 876eadb commit 6b97f56

File tree

10 files changed

+865
-0
lines changed

10 files changed

+865
-0
lines changed

‎lib/node_modules/@stdlib/stats/base/ndarray/snanmskmidrange/README.md‎

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
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+
# snanmskmidrange
22+
23+
> Calculate the [mid-range][mid-range] of a one-dimensional single-precision floating-point ndarray according to a mask, ignoring `NaN` values.
24+
25+
<section class="intro">
26+
27+
The [**mid-range**][mid-range], or **mid-extreme**, is the arithmetic mean of the maximum and minimum values in a data set. The measure is the midpoint of the 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 snanmskmidrange = require( '@stdlib/stats/base/ndarray/snanmskmidrange' );
39+
```
40+
41+
#### snanmskmidrange( arrays )
42+
43+
Computes the [mid-range][mid-range] of a one-dimensional single-precision floating-point ndarray according to a mask, ignoring `NaN` values.
44+
45+
```javascript
46+
var Float32Array = require( '@stdlib/array/float32' );
47+
var Uint8Array = require( '@stdlib/array/uint8' );
48+
var ndarray = require( '@stdlib/ndarray/base/ctor' );
49+
50+
var xbuf = new Float32Array( [ 1.0, -2.0, 4.0, 2.0, NaN ] );
51+
var x = new ndarray( 'float32', xbuf, [ 5 ], [ 1 ], 0, 'row-major' );
52+
53+
var maskbuf = new Uint8Array( [ 0, 0, 1, 0, 0 ] );
54+
var mask = new ndarray( 'uint8', maskbuf, [ 5 ], [ 1 ], 0, 'row-major' );
55+
56+
var v = snanmskmidrange( [ x, mask ] );
57+
// returns 0.0
58+
```
59+
60+
The function has the following parameters:
61+
62+
- **arrays**: array-like object containing an input ndarray and a mask ndarray.
63+
64+
If a `mask` array element is `0`, the corresponding element in the input ndarray is considered valid and **included** in computation. If a `mask` array element is `1`, the corresponding element in the input ndarray is considered invalid/missing and **excluded** from computation.
65+
66+
</section>
67+
68+
<!-- /.usage -->
69+
70+
<section class="notes">
71+
72+
## Notes
73+
74+
- If provided an empty ndarray or a mask with all elements set to `1`, the function returns `NaN`.
75+
76+
</section>
77+
78+
<!-- /.notes -->
79+
80+
<section class="examples">
81+
82+
## Examples
83+
84+
<!-- eslint no-undef: "error" -->
85+
86+
```javascript
87+
var uniform = require( '@stdlib/random/array/uniform' );
88+
var bernoulli = require( '@stdlib/random/array/bernoulli' );
89+
var ndarray = require( '@stdlib/ndarray/base/ctor' );
90+
var ndarray2array = require( '@stdlib/ndarray/to-array' );
91+
var snanmskmidrange = require( '@stdlib/stats/base/ndarray/snanmskmidrange' );
92+
93+
var xbuf = uniform( 10, -50.0, 50.0, {
94+
'dtype': 'float32'
95+
});
96+
var x = new ndarray( 'float32', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
97+
console.log( ndarray2array( x ) );
98+
99+
var maskbuf = bernoulli( xbuf.length, 0.2, {
100+
'dtype': 'uint8'
101+
});
102+
var mask = new ndarray( 'uint8', maskbuf, [ maskbuf.length ], [ 1 ], 0, 'row-major' );
103+
console.log( ndarray2array( mask ) );
104+
105+
var v = snanmskmidrange( [ x, mask ] );
106+
console.log( v );
107+
```
108+
109+
</section>
110+
111+
<!-- /.examples -->
112+
113+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
114+
115+
<section class="related">
116+
117+
</section>
118+
119+
<!-- /.related -->
120+
121+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
122+
123+
<section class="links">
124+
125+
[mid-range]: https://en.wikipedia.org/wiki/Mid-range
126+
127+
</section>
128+
129+
<!-- /.links -->

‎lib/node_modules/@stdlib/stats/base/ndarray/snanmskmidrange/benchmark/benchmark.js‎

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
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 uniform = require( '@stdlib/random/array/uniform' );
25+
var bernoulli = require( '@stdlib/random/array/bernoulli' );
26+
var isnan = require( '@stdlib/math/base/assert/is-nan' );
27+
var pow = require( '@stdlib/math/base/special/pow' );
28+
var format = require( '@stdlib/string/format' );
29+
var ndarray = require( '@stdlib/ndarray/base/ctor' );
30+
var pkg = require( './../package.json' ).name;
31+
var snanmskmidrange = require( './../lib' );
32+
33+
34+
// VARIABLES //
35+
36+
var options = {
37+
'dtype': 'float32'
38+
};
39+
var moptions = {
40+
'dtype': 'uint8'
41+
};
42+
43+
44+
// FUNCTIONS //
45+
46+
/**
47+
* Creates a benchmark function.
48+
*
49+
* @private
50+
* @param {PositiveInteger} len - array length
51+
* @returns {Function} benchmark function
52+
*/
53+
function createBenchmark( len ) {
54+
var mask;
55+
var mbuf;
56+
var xbuf;
57+
var x;
58+
59+
xbuf = uniform( len, -100.0, 100.0, options );
60+
x = new ndarray( options.dtype, xbuf, [ len ], [ 1 ], 0, 'row-major' );
61+
62+
mbuf = bernoulli( len, 0.2, moptions );
63+
mask = new ndarray( moptions.dtype, mbuf, [ len ], [ 1 ], 0, 'row-major' );
64+
65+
return benchmark;
66+
67+
68+
/**
69+
* Benchmark function.
70+
*
71+
* @private
72+
* @param {Benchmark} b - benchmark instance
73+
*/
74+
function benchmark( b ) {
75+
var v;
76+
var i;
77+
78+
b.tic();
79+
for ( i = 0; i < b.iterations; i++ ) {
80+
xbuf[ i%len ] = i;
81+
v = snanmskmidrange( [ x, mask ] );
82+
if ( isnan( v ) ) {
83+
b.fail( 'should not return NaN' );
84+
}
85+
}
86+
b.toc();
87+
if ( isnan( v ) ) {
88+
b.fail( 'should not return NaN' );
89+
}
90+
b.pass( 'benchmark finished' );
91+
b.end();
92+
}
93+
}
94+
95+
96+
// MAIN //
97+
98+
/**
99+
* Main execution sequence.
100+
*
101+
* @private
102+
*/
103+
function main() {
104+
var len;
105+
var min;
106+
var max;
107+
var f;
108+
var i;
109+
110+
min = 1; // 10^min
111+
max = 6; // 10^max
112+
113+
for ( i = min; i <= max; i++ ) {
114+
len = pow( 10, i );
115+
f = createBenchmark( len );
116+
bench( format( '%s:len=%d', pkg, len ), f );
117+
}
118+
}
119+
120+
main();

‎lib/node_modules/@stdlib/stats/base/ndarray/snanmskmidrange/docs/repl.txt‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
2+
{{alias}}( arrays )
3+
Calculates the mid-range of a one-dimensional single-precision
4+
floating-point ndarray according to a mask, ignoring `NaN` values.
5+
6+
If provided an empty ndarray or a mask with all elements set to `1`, the
7+
function returns `NaN`.
8+
9+
Parameters
10+
----------
11+
arrays: ArrayLikeObject<ndarray>
12+
Array-like object containing an input ndarray and a mask ndarray.
13+
14+
Returns
15+
-------
16+
out: number
17+
Mid-range.
18+
19+
Examples
20+
--------
21+
> var xbuf = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 4.0, 2.0, NaN ] );
22+
> var dt = 'float32';
23+
> var sh = [ xbuf.length ];
24+
> var sx = [ 1 ];
25+
> var ox = 0;
26+
> var ord = 'row-major';
27+
> var x = new {{alias:@stdlib/ndarray/ctor}}( dt, xbuf, sh, sx, ox, ord );
28+
> var maskbuf = new {{alias:@stdlib/array/uint8}}( [ 0, 0, 1, 0, 0 ] );
29+
> var mask = new {{alias:@stdlib/ndarray/ctor}}( 'uint8', maskbuf, sh, sx, ox, ord );
30+
> {{alias}}( [ x, mask ] )
31+
0.0
32+
33+
See Also
34+
--------
35+

‎lib/node_modules/@stdlib/stats/base/ndarray/snanmskmidrange/docs/types/index.d.ts‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
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+
// TypeScript Version: 4.1
20+
21+
/// <reference types="@stdlib/types"/>
22+
23+
import { float32ndarray, uint8ndarray } from '@stdlib/types/ndarray';
24+
25+
/**
26+
* Calculates the mid-range of a one-dimensional single-precision floating-point ndarray according to a mask, ignoring `NaN` values.
27+
*
28+
* @param arrays - array-like object containing an input ndarray and a mask ndarray
29+
* @returns mid-range
30+
*
31+
* @example
32+
* var Float32Array = require( '@stdlib/array/float32' );
33+
* var Uint8Array = require( '@stdlib/array/uint8' );
34+
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
35+
*
36+
* var xbuf = new Float32Array( [ 1.0, -2.0, 4.0, 2.0, NaN ] );
37+
* var x = new ndarray( 'float32', xbuf, [ 5 ], [ 1 ], 0, 'row-major' );
38+
*
39+
* var maskbuf = new Uint8Array( [ 0, 0, 1, 0, 0 ] );
40+
* var mask = new ndarray( 'uint8', maskbuf, [ 5 ], [ 1 ], 0, 'row-major' );
41+
*
42+
* var v = snanmskmidrange( [ x, mask ] );
43+
* // returns 0.0
44+
*/
45+
declare function snanmskmidrange( arrays: [ float32ndarray, uint8ndarray ] ): number;
46+
47+
48+
// EXPORTS //
49+
50+
export = snanmskmidrange;

0 commit comments

Comments
 (0)