Skip to content

Commit da40a1a

Browse files
bhargava-d16bhargava-d16
committed
feat: add stats/strided/nanmskminabs
Signed-off-by: Bhargav Dabhade <bhargava2005dabhade@gmail.com>
1 parent 80b62e9 commit da40a1a

File tree

15 files changed

+2304
-0
lines changed

15 files changed

+2304
-0
lines changed

‎lib/node_modules/@stdlib/stats/strided/nanmskminabs/README.md‎

Lines changed: 191 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
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+
# nanmskminabs
22+
23+
> Calculate the minimum absolute value of a strided array according to a mask, ignoring `NaN` values.
24+
25+
<section class="intro">
26+
27+
</section>
28+
29+
<!-- /.intro -->
30+
31+
<section class="usage">
32+
33+
## Usage
34+
35+
```javascript
36+
var nanmskminabs = require( '@stdlib/stats/strided/nanmskminabs' );
37+
```
38+
39+
#### nanmskminabs( N, x, strideX, mask, strideMask )
40+
41+
Computes the minimum absolute value of a strided array according to a mask, ignoring `NaN` values.
42+
43+
```javascript
44+
var x = [ 1.0, -2.0, 4.0, 2.0, NaN ];
45+
var mask = [ 0, 0, 1, 0, 0 ];
46+
47+
var v = nanmskminabs( x.length, x, 1, mask, 1 );
48+
// returns 1.0
49+
```
50+
51+
The function has the following parameters:
52+
53+
- **N**: number of indexed elements.
54+
- **x**: input [`Array`][mdn-array] or [`typed array`][mdn-typed-array].
55+
- **strideX**: stride length for `x`.
56+
- **mask**: mask [`Array`][mdn-array] or [`typed array`][mdn-typed-array]. If a `mask` array element is `0`, the corresponding element in `x` is considered valid and **included** in computation. If a `mask` array element is `1`, the corresponding element in `x` is considered invalid/missing and **excluded** from computation.
57+
- **strideMask**: stride length for `mask`.
58+
59+
The `N` and stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to compute the minimum absolute value of every other element in `x`,
60+
61+
```javascript
62+
var x = [ 1.0, 2.0, -7.0, -2.0, 4.0, 3.0, 5.0, 6.0, NaN, NaN ];
63+
var mask = [ 0, 0, 0, 0, 0, 0, 1, 1, 0, 0 ];
64+
65+
var v = nanmskminabs( 5, x, 2, mask, 2 );
66+
// returns 1.0
67+
```
68+
69+
Note that indexing is relative to the first index. To introduce offsets, use [`typed array`][mdn-typed-array] views.
70+
71+
<!-- eslint-disable stdlib/capitalized-comments, max-len -->
72+
73+
```javascript
74+
var Float64Array = require( '@stdlib/array/float64' );
75+
var Uint8Array = require( '@stdlib/array/uint8' );
76+
77+
var x0 = new Float64Array( [ 2.0, 1.0, -2.0, -2.0, 3.0, 4.0, 5.0, 6.0, NaN, NaN ] );
78+
var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
79+
80+
var mask0 = new Uint8Array( [ 0, 0, 0, 0, 0, 0, 1, 1, 0, 0 ] );
81+
var mask1 = new Uint8Array( mask0.buffer, mask0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
82+
83+
var v = nanmskminabs( 5, x1, 2, mask1, 2 );
84+
// returns 1.0
85+
```
86+
87+
#### nanmskminabs.ndarray( N, x, strideX, offsetX, mask, strideMask, offsetMask )
88+
89+
Computes the minimum absolute value of a strided array according to a mask, ignoring `NaN` values and using alternative indexing semantics.
90+
91+
```javascript
92+
var x = [ 1.0, -2.0, 4.0, 2.0, NaN ];
93+
var mask = [ 0, 0, 1, 0, 0 ];
94+
95+
var v = nanmskminabs.ndarray( x.length, x, 1, 0, mask, 1, 0 );
96+
// returns 1.0
97+
```
98+
99+
The function has the following additional parameters:
100+
101+
- **offsetX**: starting index for `x`.
102+
- **offsetMask**: starting index for `mask`.
103+
104+
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example, to calculate the minimum absolute value for every other element in `x` starting from the second element
105+
106+
```javascript
107+
var x = [ 2.0, 1.0, -2.0, -2.0, 3.0, 4.0, 5.0, 6.0, NaN, NaN ];
108+
var mask = [ 0, 0, 0, 0, 0, 0, 1, 1, 0, 0 ];
109+
110+
var v = nanmskminabs.ndarray( 5, x, 2, 1, mask, 2, 1 );
111+
// returns 1.0
112+
```
113+
114+
</section>
115+
116+
<!-- /.usage -->
117+
118+
<section class="notes">
119+
120+
## Notes
121+
122+
- If `N <= 0`, both functions return `NaN`.
123+
- Depending on the environment, the typed versions ([`dnanmskminabs`][@stdlib/stats/strided/dnanmskminabs], [`snanmskminabs`][@stdlib/stats/strided/snanmskminabs] etc.) are likely to be significantly more performant.
124+
- Both functions support array-like objects having getter and setter accessors for array element access (e.g., [`@stdlib/array/base/accessor`][@stdlib/array/base/accessor]).
125+
126+
</section>
127+
128+
<!-- /.notes -->
129+
130+
<section class="examples">
131+
132+
## Examples
133+
134+
<!-- eslint no-undef: "error" -->
135+
136+
```javascript
137+
var uniform = require( '@stdlib/random/base/uniform' );
138+
var bernoulli = require( '@stdlib/random/base/bernoulli' );
139+
var filledarrayBy = require( '@stdlib/array/filled-by' );
140+
var nanmskminabs = require( '@stdlib/stats/strided/nanmskminabs' );
141+
142+
function rand() {
143+
if ( bernoulli( 0.8 ) < 1 ) {
144+
return NaN;
145+
}
146+
return uniform( -50.0, 50.0 );
147+
}
148+
149+
var x = filledarrayBy( 10, 'float64', rand );
150+
console.log( x );
151+
152+
var mask = filledarrayBy( x.length, 'uint8', bernoulli.factory( 0.2 ) );
153+
console.log( mask );
154+
155+
var v = nanmskminabs( x.length, x, 1, mask, 1 );
156+
console.log( v );
157+
```
158+
159+
</section>
160+
161+
<!-- /.examples -->
162+
163+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
164+
165+
<section class="related">
166+
167+
</section>
168+
169+
<!-- /.related -->
170+
171+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
172+
173+
<section class="links">
174+
175+
[mdn-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array
176+
177+
[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
178+
179+
[@stdlib/array/base/accessor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/accessor
180+
181+
[@stdlib/stats/strided/dnanmskminabs]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dnanmskminabs
182+
183+
[@stdlib/stats/strided/snanmskminabs]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/snanmskminabs
184+
185+
<!-- <related-links> -->
186+
187+
<!-- </related-links> -->
188+
189+
</section>
190+
191+
<!-- /.links -->

‎lib/node_modules/@stdlib/stats/strided/nanmskminabs/benchmark/benchmark.js‎

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

0 commit comments

Comments
 (0)