Skip to content

Commit 7757e13

Browse files
iampratik13kgryte
iampratik13
and
kgryte
authored
feat: add stats/base/ndarray/dnanmskmax
PR-URL: #8748 (review) Co-authored-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 1f6de4e commit 7757e13

File tree

10 files changed

+859
-0
lines changed

10 files changed

+859
-0
lines changed

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

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

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

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

‎lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/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+
Computes the maximum value of a double-precision floating-point ndarray
4+
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+
Maximum value.
18+
19+
Examples
20+
--------
21+
> var xbuf = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, NaN, 2.0 ] );
22+
> var dt = 'float64';
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 mbuf = new {{alias:@stdlib/array/uint8}}( [ 0, 0, 0, 0 ] );
29+
> var mask = new {{alias:@stdlib/ndarray/ctor}}( 'uint8', mbuf, sh, sx, ox, ord );
30+
> {{alias}}( [ x, mask ] )
31+
2.0
32+
33+
See Also
34+
--------
35+

‎lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/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) 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 { float64ndarray, uint8ndarray } from '@stdlib/types/ndarray';
24+
25+
/**
26+
* Computes the maximum value of a double-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 maximum value
30+
*
31+
* @example
32+
* var Float64Array = require( '@stdlib/array/float64' );
33+
* var Uint8Array = require( '@stdlib/array/uint8' );
34+
* var ndarray = require( '@stdlib/ndarray/base/ctor' );
35+
*
36+
* var xbuf = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] );
37+
* var x = new ndarray( 'float64', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
38+
*
39+
* var mbuf = new Uint8Array( [ 0, 0, 0, 0 ] );
40+
* var mask = new ndarray( 'uint8', mbuf, [ 4 ], [ 1 ], 0, 'row-major' );
41+
*
42+
* var v = dnanmskmax( [ x, mask ] );
43+
* // returns 2.0
44+
*/
45+
declare function dnanmskmax( arrays: [ float64ndarray, uint8ndarray ] ): number;
46+
47+
48+
// EXPORTS //
49+
50+
export = dnanmskmax;

0 commit comments

Comments
 (0)