Skip to content

Commit d681872

Browse files
Sachinn-64Sachinn-64
authored
feat: add stats/base/ndarray/mskmidrange
PR-URL: #9511 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 4bb46e9 commit d681872

10 files changed

Lines changed: 845 additions & 0 deletions

File tree

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

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

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

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

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

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

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

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
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 { ndarray } from '@stdlib/types/ndarray';
24+
25+
/**
26+
* Calculates the mid-range of a one-dimensional ndarray according to a mask.
27+
*
28+
* @param arrays - array-like object containing an input ndarray and a mask ndarray
29+
* @returns mid-range
30+
*
31+
* @example
32+
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
33+
*
34+
* var xbuf = [ 1.0, -2.0, 4.0, 2.0 ];
35+
* var x = new ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
36+
*
37+
* var mbuf = [ 0, 0, 1, 0 ];
38+
* var mask = new ndarray( 'generic', mbuf, [ 4 ], [ 1 ], 0, 'row-major' );
39+
*
40+
* var v = mskmidrange( [ x, mask ] );
41+
* // returns 0.0
42+
*/
43+
declare function mskmidrange<T extends ndarray = ndarray>( arrays: [ T, T ] ): number;
44+
45+
46+
// EXPORTS //
47+
48+
export = mskmidrange;

‎lib/node_modules/@stdlib/stats/base/ndarray/mskmidrange/docs/types/test.ts‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
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+
/* eslint-disable space-in-parens */
20+
21+
import zeros = require( '@stdlib/ndarray/zeros' );
22+
import mskmidrange = require( './index' );
23+
24+
25+
// TESTS //
26+
27+
// The function returns a number...
28+
{
29+
const x = zeros( [ 10 ], {
30+
'dtype': 'generic'
31+
});
32+
const mask = zeros( [ 10 ], {
33+
'dtype': 'generic'
34+
});
35+
36+
mskmidrange( [ x, mask ] ); // $ExpectType number
37+
}
38+
39+
// The compiler throws an error if the function is provided a first argument which is not an array of ndarrays...
40+
{
41+
mskmidrange( '10' ); // $ExpectError
42+
mskmidrange( 10 ); // $ExpectError
43+
mskmidrange( true ); // $ExpectError
44+
mskmidrange( false ); // $ExpectError
45+
mskmidrange( null ); // $ExpectError
46+
mskmidrange( undefined ); // $ExpectError
47+
mskmidrange( [] ); // $ExpectError
48+
mskmidrange( {} ); // $ExpectError
49+
mskmidrange( ( x: number ): number => x ); // $ExpectError
50+
}
51+
52+
// The compiler throws an error if the function is provided an unsupported number of arguments...
53+
{
54+
const x = zeros( [ 10 ], {
55+
'dtype': 'generic'
56+
});
57+
const mask = zeros( [ 10 ], {
58+
'dtype': 'generic'
59+
});
60+
61+
mskmidrange(); // $ExpectError
62+
mskmidrange( [ x, mask ], {} ); // $ExpectError
63+
}

0 commit comments

Comments
 (0)