Skip to content

Commit 6992dba

Browse files
stdlib-botstdlib-bot
committed
Auto-generated commit
1 parent 7a63fda commit 6992dba

File tree

11 files changed

+845
-0
lines changed

11 files changed

+845
-0
lines changed

‎CHANGELOG.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010

1111
### Features
1212

13+
- [`4e1eaac`](https://github.com/stdlib-js/stdlib/commit/4e1eaac6e4faf9b1b299ea6ebe6585ad136674e8) - add `stats/base/ndarray/mskrange` [(#8634)](https://github.com/stdlib-js/stdlib/pull/8634)
1314
- [`84b30fb`](https://github.com/stdlib-js/stdlib/commit/84b30fb2c4455b9cdc27d8010487631a4568c0cf) - add `snanmeanors`, `snanmeanpn`, `snanmeanwd` to namespace
1415
- [`320a026`](https://github.com/stdlib-js/stdlib/commit/320a026ee97a919f752a4d205a80d705b0e8c07b) - add `sminsorted`, `snanmaxabs`, `snanminabs` to namespace
1516
- [`11c3a12`](https://github.com/stdlib-js/stdlib/commit/11c3a1236bbf511c76ba421960f468e8bac696ad) - add `smeankbn`, `smeankbn2`, `smeanli`, `smeanlipw`, `smeanpn`, `smeanpw`, `smeanwd` to namespace
@@ -3470,6 +3471,7 @@ A total of 557 issues were closed in this release:
34703471

34713472
<details>
34723473

3474+
- [`4e1eaac`](https://github.com/stdlib-js/stdlib/commit/4e1eaac6e4faf9b1b299ea6ebe6585ad136674e8) - **feat:** add `stats/base/ndarray/mskrange` [(#8634)](https://github.com/stdlib-js/stdlib/pull/8634) _(by Pratik, Athan Reines)_
34733475
- [`84b30fb`](https://github.com/stdlib-js/stdlib/commit/84b30fb2c4455b9cdc27d8010487631a4568c0cf) - **feat:** add `snanmeanors`, `snanmeanpn`, `snanmeanwd` to namespace _(by Athan Reines)_
34743476
- [`320a026`](https://github.com/stdlib-js/stdlib/commit/320a026ee97a919f752a4d205a80d705b0e8c07b) - **feat:** add `sminsorted`, `snanmaxabs`, `snanminabs` to namespace _(by Athan Reines)_
34753477
- [`11c3a12`](https://github.com/stdlib-js/stdlib/commit/11c3a1236bbf511c76ba421960f468e8bac696ad) - **feat:** add `smeankbn`, `smeankbn2`, `smeanli`, `smeanlipw`, `smeanpn`, `smeanpw`, `smeanwd` to namespace _(by Athan Reines)_

‎base/ndarray/mskrange/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) 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+
# mskrange
22+
23+
> Calculate the [range][range] of a one-dimensional ndarray according to a mask.
24+
25+
<section class="intro">
26+
27+
The [**range**][range] is defined as the difference between the maximum and minimum values.
28+
29+
</section>
30+
31+
<!-- /.intro -->
32+
33+
<section class="usage">
34+
35+
## Usage
36+
37+
```javascript
38+
var mskrange = require( '@stdlib/stats/base/ndarray/mskrange' );
39+
```
40+
41+
#### mskrange( arrays )
42+
43+
Computes the [range][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 = mskrange( [ x, mask ] );
55+
// returns 4.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 mskrange = require( '@stdlib/stats/base/ndarray/mskrange' );
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 = mskrange( [ 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+
[range]: https://en.wikipedia.org/wiki/Range_%28statistics%29
124+
125+
</section>
126+
127+
<!-- /.links -->

‎base/ndarray/mskrange/benchmark/benchmark.js‎

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

‎base/ndarray/mskrange/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 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+
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+
4.0
31+
32+
See Also
33+
--------
34+

‎base/ndarray/mskrange/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) 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+
import { ndarray } from '@stdlib/types/ndarray';
24+
25+
/**
26+
* Calculates the 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 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 = mskrange( [ x, mask ] );
41+
* // returns 4.0
42+
*/
43+
declare function mskrange<T extends ndarray = ndarray>( arrays: [ T, T ] ): number;
44+
45+
46+
// EXPORTS //
47+
48+
export = mskrange;

0 commit comments

Comments
 (0)