From 0f9d9a466c3d18d2f96cf3f93b906e832cf6ccb0 Mon Sep 17 00:00:00 2001 From: iampratik13 Date: Wed, 3 Dec 2025 19:15:29 +0530 Subject: [PATCH 01/12] feat/add-stats-base-ndarray-dnanmskmax --- .../stats/base/ndarray/dnanmskmax/README.md | 119 +++++++++ .../ndarray/dnanmskmax/benchmark/benchmark.js | 128 ++++++++++ .../base/ndarray/dnanmskmax/docs/repl.txt | 32 +++ .../ndarray/dnanmskmax/docs/types/index.d.ts | 46 ++++ .../ndarray/dnanmskmax/docs/types/test.ts | 57 +++++ .../base/ndarray/dnanmskmax/examples/index.js | 40 +++ .../base/ndarray/dnanmskmax/lib/index.js | 45 ++++ .../stats/base/ndarray/dnanmskmax/lib/main.js | 61 +++++ .../base/ndarray/dnanmskmax/package.json | 70 ++++++ .../base/ndarray/dnanmskmax/test/test.js | 232 ++++++++++++++++++ 10 files changed, 830 insertions(+) create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/README.md create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/examples/index.js create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/lib/index.js create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/lib/main.js create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/package.json create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/test/test.js diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/README.md b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/README.md new file mode 100644 index 000000000000..7200ba3f3423 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/README.md @@ -0,0 +1,119 @@ + + +# dnanmskmax + +> Compute the maximum value of a double-precision floating-point ndarray according to a mask, ignoring `NaN` values. + +
+ +
+ + + +
+ +## Usage + +```javascript +var dnanmskmax = require( '@stdlib/stats/base/ndarray/dnanmskmax' ); +``` + +#### dnanmskmax( arrays ) + +Computes the maximum value of a double-precision floating-point ndarray according to a mask, ignoring `NaN` values. + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); + +var xbuf = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); +var x = new ndarray( 'float64', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); + +var v = dnanmskmax( [ x ] ); +// returns 2.0 +``` + +The function has the following parameters: + +- **arrays**: array-like object containing a one-dimensional input ndarray. + +
+ + + +
+ +## Notes + +- If provided an empty one-dimensional ndarray, the function returns `NaN`. + +
+ + + +
+ +## Examples + + + +```javascript +var uniform = require( '@stdlib/random/base/uniform' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); +var bernoulli = require( '@stdlib/random/base/bernoulli' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var ndarray2array = require( '@stdlib/ndarray/to-array' ); +var dnanmskmax = require( '@stdlib/stats/base/ndarray/dnanmskmax' ); + +function rand() { + if ( bernoulli( 0.8 ) < 1 ) { + return NaN; + } + return uniform( -50.0, 50.0 ); +} + +var xbuf = filledarrayBy( 10, 'float64', rand ); +var x = new ndarray( 'float64', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' ); +console.log( ndarray2array( x ) ); + +var v = dnanmskmax( [ x ] ); +console.log( v ); +``` + +
+ + + + + + + + + + + + + + diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/benchmark/benchmark.js new file mode 100644 index 000000000000..cba8cd2c3150 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/benchmark/benchmark.js @@ -0,0 +1,128 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var bench = require( '@stdlib/bench' ); +var uniform = require( '@stdlib/random/base/uniform' ); +var bernoulli = require( '@stdlib/random/base/bernoulli' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var pkg = require( './../package.json' ).name; +var dnanmskmax = require( './../lib' ); + + +// FUNCTIONS // + +/** +* Returns a random number. +* +* @private +* @returns {number} random number or `NaN` +*/ +function rand() { + if ( bernoulli( 0.2 ) < 1 ) { + return NaN; + } + return uniform( -10.0, 10.0 ); +} + +/** +* Returns a random mask value. +* +* @private +* @returns {number} 0 or 1 +*/ +function randMask() { + if ( bernoulli( 0.1 ) < 1 ) { + return 1; + } + return 0; +} + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var mask; + var mbuf; + var xbuf; + var x; + + xbuf = filledarrayBy( len, 'float64', rand ); + x = new ndarray( 'float64', xbuf, [ len ], [ 1 ], 0, 'row-major' ); + + mbuf = filledarrayBy( len, 'uint8', randMask ); + mask = new ndarray( 'uint8', mbuf, [ len ], [ 1 ], 0, 'row-major' ); + + return benchmark; + + function benchmark( b ) { + var v; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v = dnanmskmax( [ x, mask ] ); + if ( isnan( v ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( v ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); + } +} + + +// MAIN // + +/** +* Main execution sequence. +* +* @private +*/ +function main() { + var len; + var min; + var max; + var f; + var i; + + min = 1; // 10^min + max = 6; // 10^max + + for ( i = min; i <= max; i++ ) { + len = pow( 10, i ); + f = createBenchmark( len ); + bench( pkg+':len='+len, f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/docs/repl.txt new file mode 100644 index 000000000000..4eb2a12dd0ed --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/docs/repl.txt @@ -0,0 +1,32 @@ + +{{alias}}( arrays ) + Computes the maximum value of a double-precision floating- + point ndarray according to a mask, ignoring `NaN` values. + + If provided an empty ndarray, the function returns `NaN`. + + Parameters + ---------- + arrays: ArrayLikeObject + Array-like object containing a one-dimensional input ndarray. + + Returns + ------- + out: number + Maximum value. + + Examples + -------- + > var xbuf = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 2.0 ] ); + > var dt = 'float64'; + > var sh = [ xbuf.length ]; + > var sx = [ 1 ]; + > var ox = 0; + > var ord = 'row-major'; + > var x = new {{alias:@stdlib/ndarray/ctor}}( dt, xbuf, sh, sx, ox, ord ); + > {{alias}}( [ x ] ) + 2.0 + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/docs/types/index.d.ts new file mode 100644 index 000000000000..d04d93e313b6 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/docs/types/index.d.ts @@ -0,0 +1,46 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +// TypeScript Version: 4.1 + +/// + +import { float64ndarray } from '@stdlib/types/ndarray'; + +/** +* Computes the maximum value of a double-precision floating-point ndarray according to a mask, ignoring `NaN` values. +* +* @param arrays - array-like object containing an input ndarray +* @returns maximum value +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* +* var xbuf = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); +* var x = new ndarray( 'float64', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); +* +* var v = dnanmskmax( [ x ] ); +* // returns 2.0 +*/ +declare function dnanmskmax( arrays: [ float64ndarray ] ): number; + + +// EXPORTS // + +export = dnanmskmax; diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/docs/types/test.ts b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/docs/types/test.ts new file mode 100644 index 000000000000..79412f7d3cc6 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/docs/types/test.ts @@ -0,0 +1,57 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +/* eslint-disable space-in-parens */ + +import zeros = require( '@stdlib/ndarray/zeros' ); +import dnanmskmax = require( './index' ); + + +// TESTS // + +// The function returns a number... +{ + const x = zeros( [ 10 ], { + 'dtype': 'float64' + }); + + dnanmskmax( [ x ] ); // $ExpectType number +} + +// The compiler throws an error if the function is provided a first argument which is not an array of ndarrays... +{ + dnanmskmax( '10' ); // $ExpectError + dnanmskmax( 10 ); // $ExpectError + dnanmskmax( true ); // $ExpectError + dnanmskmax( false ); // $ExpectError + dnanmskmax( null ); // $ExpectError + dnanmskmax( undefined ); // $ExpectError + dnanmskmax( [] ); // $ExpectError + dnanmskmax( {} ); // $ExpectError + dnanmskmax( ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the function is provided an unsupported number of arguments... +{ + const x = zeros( [ 10 ], { + 'dtype': 'float64' + }); + + dnanmskmax(); // $ExpectError + dnanmskmax( [ x ], {} ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/examples/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/examples/index.js new file mode 100644 index 000000000000..ded9cbc60a9b --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/examples/index.js @@ -0,0 +1,40 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +var uniform = require( '@stdlib/random/base/uniform' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); +var bernoulli = require( '@stdlib/random/base/bernoulli' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var ndarray2array = require( '@stdlib/ndarray/to-array' ); +var dnanmskmax = require( './../lib' ); + +function rand() { + if ( bernoulli( 0.8 ) < 1 ) { + return NaN; + } + return uniform( -50.0, 50.0 ); +} + +var xbuf = filledarrayBy( 10, 'float64', rand ); +var x = new ndarray( 'float64', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' ); +console.log( ndarray2array( x ) ); + +var v = dnanmskmax( [ x ] ); +console.log( v ); diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/lib/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/lib/index.js new file mode 100644 index 000000000000..352f4452b94d --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/lib/index.js @@ -0,0 +1,45 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +/** +* Compute the maximum value of a double-precision floating-point ndarray according to a mask, ignoring `NaN` values. +* +* @module @stdlib/stats/base/ndarray/dnanmskmax +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* var dnanmskmax = require( '@stdlib/stats/base/ndarray/dnanmskmax' ); +* +* var xbuf = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); +* var x = new ndarray( 'float64', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); +* +* var v = dnanmskmax( [ x ] ); +* // returns 2.0 +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/lib/main.js b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/lib/main.js new file mode 100644 index 000000000000..eb92ab710a2a --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/lib/main.js @@ -0,0 +1,61 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var numelDimension = require( '@stdlib/ndarray/base/numel-dimension' ); +var getStride = require( '@stdlib/ndarray/base/stride' ); +var getOffset = require( '@stdlib/ndarray/base/offset' ); +var getData = require( '@stdlib/ndarray/base/data-buffer' ); +var strided = require( '@stdlib/stats/strided/dnanmskmax' ).ndarray; + + +// MAIN // + +/** +* Computes the maximum value of a double-precision floating-point ndarray according to a mask, ignoring `NaN` values. +* +* @param {ArrayLikeObject} arrays - array-like object containing an input ndarray and a mask ndarray +* @returns {number} maximum value +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* var Uint8Array = require( '@stdlib/array/uint8' ); +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* +* var xbuf = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); +* var x = new ndarray( 'float64', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); +* +* var maskbuf = new Uint8Array( [ 0, 0, 0, 0 ] ); +* var mask = new ndarray( 'uint8', maskbuf, [ 4 ], [ 1 ], 0, 'row-major' ); +* +* var v = dnanmskmax( [ x, mask ] ); +* // returns 2.0 +*/ +function dnanmskmax( arrays ) { + var mask = arrays[ 1 ]; + var x = arrays[ 0 ]; + return strided( numelDimension( x, 0 ), getData( x ), getStride( x, 0 ), getOffset( x ), getData( mask ), getStride( mask, 0 ), getOffset( mask ) ); // eslint-disable-line max-len +} + + +// EXPORTS // + +module.exports = dnanmskmax; diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/package.json b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/package.json new file mode 100644 index 000000000000..376e175f0242 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/package.json @@ -0,0 +1,70 @@ +{ + "name": "@stdlib/stats/base/ndarray/dnanmskmax", + "version": "0.0.0", + "description": "Compute the maximum value of a double-precision floating-point ndarray according to a mask, ignoring `NaN` values.", + "license": "Apache-2.0", + "author": { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + }, + "contributors": [ + { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + } + ], + "main": "./lib", + "directories": { + "benchmark": "./benchmark", + "doc": "./docs", + "example": "./examples", + "lib": "./lib", + "test": "./test" + }, + "types": "./docs/types", + "scripts": {}, + "homepage": "https://github.com/stdlib-js/stdlib", + "repository": { + "type": "git", + "url": "git://github.com/stdlib-js/stdlib.git" + }, + "bugs": { + "url": "https://github.com/stdlib-js/stdlib/issues" + }, + "dependencies": {}, + "devDependencies": {}, + "engines": { + "node": ">=0.10.0", + "npm": ">2.7.0" + }, + "os": [ + "aix", + "darwin", + "freebsd", + "linux", + "macos", + "openbsd", + "sunos", + "win32", + "windows" + ], + "keywords": [ + "stdlib", + "stdmath", + "statistics", + "stats", + "mathematics", + "math", + "maximum", + "max", + "masked", + "mask", + "masked array", + "range", + "extremes", + "domain", + "extent", + "ndarray" + ], + "__stdlib__": {} +} diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/test/test.js b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/test/test.js new file mode 100644 index 000000000000..817016c94222 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/test/test.js @@ -0,0 +1,232 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var tape = require( 'tape' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' ); +var Float64Array = require( '@stdlib/array/float64' ); +var Uint8Array = require( '@stdlib/array/uint8' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var dnanmskmax = require( './../lib' ); + + +// FUNCTIONS // + +/** +* Returns a one-dimensional ndarray. +* +* @private +* @param {string} dtype - data type +* @param {Collection} buffer - underlying data buffer +* @param {NonNegativeInteger} length - number of indexed elements +* @param {integer} stride - stride length +* @param {NonNegativeInteger} offset - index offset +* @returns {ndarray} one-dimensional ndarray +*/ +function vector( dtype, buffer, length, stride, offset ) { + return new ndarray( dtype, buffer, [ length ], [ stride ], offset, 'row-major' ); +} + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dnanmskmax, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 1', function test( t ) { + t.strictEqual( dnanmskmax.length, 1, 'has expected arity' ); + t.end(); +}); + +tape( 'the function calculates the maximum value of a one-dimensional ndarray according to a mask, ignoring `NaN` values', function test( t ) { + var mask; + var x; + var v; + + x = new Float64Array( [ 1.0, -2.0, -4.0, NaN, 5.0, 0.0, 3.0 ] ); + mask = new Uint8Array( [ 0, 0, 0, 0, 0, 0, 0 ] ); + v = dnanmskmax( [ vector( 'float64', x, x.length, 1, 0 ), vector( 'uint8', mask, mask.length, 1, 0 ) ] ); + t.strictEqual( v, 5.0, 'returns expected value' ); + + x = new Float64Array( [ -4.0, NaN, -5.0 ] ); + mask = new Uint8Array( [ 0, 0, 0 ] ); + v = dnanmskmax( [ vector( 'float64', x, x.length, 1, 0 ), vector( 'uint8', mask, mask.length, 1, 0 ) ] ); + t.strictEqual( v, -4.0, 'returns expected value' ); + + x = new Float64Array( [-0.0, 0.0, NaN, -0.0 ] ); + mask = new Uint8Array( [ 0, 0, 0, 0 ] ); + v = dnanmskmax( [ vector( 'float64', x, x.length, 1, 0 ), vector( 'uint8', mask, mask.length, 1, 0 ) ] ); + t.strictEqual( isPositiveZero( v ), true, 'returns expected value' ); + + x = new Float64Array( [ NaN ] ); + mask = new Uint8Array( [ 0 ] ); + v = dnanmskmax( [ vector( 'float64', x, x.length, 1, 0 ), vector( 'uint8', mask, mask.length, 1, 0 ) ] ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = new Float64Array( [ NaN, NaN ] ); + mask = new Uint8Array( [ 0, 0 ] ); + v = dnanmskmax( [ vector( 'float64', x, x.length, 1, 0 ), vector( 'uint8', mask, mask.length, 1, 0 ) ] ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an empty ndarray, the function returns `NaN`', function test( t ) { + var mask; + var x; + var v; + + x = new Float64Array( [] ); + mask = new Uint8Array( [] ); + + v = dnanmskmax( [ vector( 'float64', x, 0, 1, 0 ), vector( 'uint8', mask, 0, 1, 0 ) ] ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an ndarray containing a single element, the function returns that element', function test( t ) { + var mask; + var x; + var v; + + x = new Float64Array( [ 1.0 ] ); + mask = new Uint8Array( [ 0 ] ); + + v = dnanmskmax( [ vector( 'float64', x, 1, 1, 0 ), vector( 'uint8', mask, 1, 1, 0 ) ] ); + t.strictEqual( v, 1.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports one-dimensional ndarrays having non-unit strides', function test( t ) { + var mask; + var x; + var v; + + x = new Float64Array([ + 1.0, // 0 + 2.0, + 2.0, // 1 + -7.0, + -2.0, // 2 + 3.0, + 4.0, // 3 + 2.0, + NaN, // 4 + NaN + ]); + mask = new Uint8Array([ + 0, // 0 + 0, + 0, // 1 + 0, + 0, // 2 + 0, + 0, // 3 + 0, + 0, // 4 + 0 + ]); + + v = dnanmskmax( [ vector( 'float64', x, 5, 2, 0 ), vector( 'uint8', mask, 5, 2, 0 ) ] ); + + t.strictEqual( v, 4.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports one-dimensional ndarrays having negative strides', function test( t ) { + var mask; + var x; + var v; + + x = new Float64Array([ + NaN, // 4 + NaN, + 1.0, // 3 + 2.0, + 2.0, // 2 + -7.0, + -2.0, // 1 + 3.0, + 4.0, // 0 + 2.0 + ]); + mask = new Uint8Array([ + 0, // 4 + 0, + 0, // 3 + 0, + 0, // 2 + 0, + 0, // 1 + 0, + 0, // 0 + 0 + ]); + + v = dnanmskmax( [ vector( 'float64', x, 5, -2, 8 ), vector( 'uint8', mask, 5, -2, 8 ) ] ); + + t.strictEqual( v, 4.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports one-dimensional ndarrays having non-zero offsets', function test( t ) { + var mask; + var x; + var v; + + x = new Float64Array([ + 2.0, + 1.0, // 0 + 2.0, + -2.0, // 1 + -2.0, + 2.0, // 2 + 3.0, + 4.0, // 3 + 6.0, + NaN, // 4 + NaN + ]); + mask = new Uint8Array([ + 0, + 0, // 0 + 0, + 0, // 1 + 0, + 0, // 2 + 0, + 0, // 3 + 0, + 0, // 4 + 0 + ]); + + v = dnanmskmax( [ vector( 'float64', x, 5, 2, 1 ), vector( 'uint8', mask, 5, 2, 1 ) ] ); + t.strictEqual( v, 4.0, 'returns expected value' ); + + t.end(); +}); From 2894544a610248363df83cdd3d825c519b29af89 Mon Sep 17 00:00:00 2001 From: iampratik13 Date: Wed, 3 Dec 2025 19:39:26 +0530 Subject: [PATCH 02/12] fix: minor lint error --- .../stats/base/ndarray/dnanmskmax/README.md | 23 +++++++++++++++---- .../base/ndarray/dnanmskmax/docs/repl.txt | 9 +++++--- .../ndarray/dnanmskmax/docs/types/index.d.ts | 12 ++++++---- .../ndarray/dnanmskmax/docs/types/test.ts | 10 ++++++-- .../base/ndarray/dnanmskmax/examples/index.js | 15 ++++++++++-- .../base/ndarray/dnanmskmax/lib/index.js | 6 ++++- 6 files changed, 59 insertions(+), 16 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/README.md b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/README.md index 7200ba3f3423..1ea4ff3e347b 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/README.md +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/README.md @@ -42,18 +42,22 @@ Computes the maximum value of a double-precision floating-point ndarray accordin ```javascript var Float64Array = require( '@stdlib/array/float64' ); +var Uint8Array = require( '@stdlib/array/uint8' ); var ndarray = require( '@stdlib/ndarray/base/ctor' ); var xbuf = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); var x = new ndarray( 'float64', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); -var v = dnanmskmax( [ x ] ); +var maskbuf = new Uint8Array( [ 0, 0, 0, 0 ] ); +var mask = new ndarray( 'uint8', maskbuf, [ 4 ], [ 1 ], 0, 'row-major' ); + +var v = dnanmskmax( [ x, mask ] ); // returns 2.0 ``` The function has the following parameters: -- **arrays**: array-like object containing a one-dimensional input ndarray. +- **arrays**: array-like object containing a one-dimensional input ndarray and a one-dimensional mask ndarray. @@ -84,17 +88,28 @@ var ndarray2array = require( '@stdlib/ndarray/to-array' ); var dnanmskmax = require( '@stdlib/stats/base/ndarray/dnanmskmax' ); function rand() { - if ( bernoulli( 0.8 ) < 1 ) { + if ( bernoulli( 0.2 ) < 1 ) { return NaN; } return uniform( -50.0, 50.0 ); } +function randMask() { + if ( bernoulli( 0.1 ) < 1 ) { + return 1; + } + return 0; +} + var xbuf = filledarrayBy( 10, 'float64', rand ); var x = new ndarray( 'float64', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' ); console.log( ndarray2array( x ) ); -var v = dnanmskmax( [ x ] ); +var maskbuf = filledarrayBy( xbuf.length, 'uint8', randMask ); +var mask = new ndarray( 'uint8', maskbuf, [ maskbuf.length ], [ 1 ], 0, 'row-major' ); +console.log( ndarray2array( mask ) ); + +var v = dnanmskmax( [ x, mask ] ); console.log( v ); ``` diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/docs/repl.txt index 4eb2a12dd0ed..7fc7a4c4f05f 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/docs/repl.txt @@ -8,7 +8,8 @@ Parameters ---------- arrays: ArrayLikeObject - Array-like object containing a one-dimensional input ndarray. + Array-like object containing a one-dimensional input ndarray and a + one-dimensional mask ndarray. Returns ------- @@ -17,14 +18,16 @@ Examples -------- - > var xbuf = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 2.0 ] ); + > var xbuf = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, NaN, 2.0 ] ); > var dt = 'float64'; > var sh = [ xbuf.length ]; > var sx = [ 1 ]; > var ox = 0; > var ord = 'row-major'; > var x = new {{alias:@stdlib/ndarray/ctor}}( dt, xbuf, sh, sx, ox, ord ); - > {{alias}}( [ x ] ) + > var mbuf = new {{alias:@stdlib/array/uint8}}( [ 0, 0, 0, 0 ] ); + > var mask = new {{alias:@stdlib/ndarray/ctor}}( 'uint8', mbuf, sh, sx, ox, ord ); + > {{alias}}( [ x, mask ] ) 2.0 See Also diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/docs/types/index.d.ts index d04d93e313b6..8a11e9df83fe 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/docs/types/index.d.ts @@ -20,25 +20,29 @@ /// -import { float64ndarray } from '@stdlib/types/ndarray'; +import { float64ndarray, uint8ndarray } from '@stdlib/types/ndarray'; /** * Computes the maximum value of a double-precision floating-point ndarray according to a mask, ignoring `NaN` values. * -* @param arrays - array-like object containing an input ndarray +* @param arrays - array-like object containing an input ndarray and a mask ndarray * @returns maximum value * * @example * var Float64Array = require( '@stdlib/array/float64' ); +* var Uint8Array = require( '@stdlib/array/uint8' ); * var ndarray = require( '@stdlib/ndarray/base/ctor' ); * * var xbuf = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); * var x = new ndarray( 'float64', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); * -* var v = dnanmskmax( [ x ] ); +* var mbuf = new Uint8Array( [ 0, 0, 0, 0 ] ); +* var mask = new ndarray( 'uint8', mbuf, [ 4 ], [ 1 ], 0, 'row-major' ); +* +* var v = dnanmskmax( [ x, mask ] ); * // returns 2.0 */ -declare function dnanmskmax( arrays: [ float64ndarray ] ): number; +declare function dnanmskmax( arrays: [ float64ndarray, uint8ndarray ] ): number; // EXPORTS // diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/docs/types/test.ts b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/docs/types/test.ts index 79412f7d3cc6..4784704a3686 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/docs/types/test.ts +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/docs/types/test.ts @@ -29,8 +29,11 @@ import dnanmskmax = require( './index' ); const x = zeros( [ 10 ], { 'dtype': 'float64' }); + const mask = zeros( [ 10 ], { + 'dtype': 'uint8' + }); - dnanmskmax( [ x ] ); // $ExpectType number + dnanmskmax( [ x, mask ] ); // $ExpectType number } // The compiler throws an error if the function is provided a first argument which is not an array of ndarrays... @@ -51,7 +54,10 @@ import dnanmskmax = require( './index' ); const x = zeros( [ 10 ], { 'dtype': 'float64' }); + const mask = zeros( [ 10 ], { + 'dtype': 'uint8' + }); dnanmskmax(); // $ExpectError - dnanmskmax( [ x ], {} ); // $ExpectError + dnanmskmax( [ x, mask ], {} ); // $ExpectError } diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/examples/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/examples/index.js index ded9cbc60a9b..6e470265c2b3 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/examples/index.js @@ -26,15 +26,26 @@ var ndarray2array = require( '@stdlib/ndarray/to-array' ); var dnanmskmax = require( './../lib' ); function rand() { - if ( bernoulli( 0.8 ) < 1 ) { + if ( bernoulli( 0.2 ) < 1 ) { return NaN; } return uniform( -50.0, 50.0 ); } +function randMask() { + if ( bernoulli( 0.1 ) < 1 ) { + return 1; + } + return 0; +} + var xbuf = filledarrayBy( 10, 'float64', rand ); var x = new ndarray( 'float64', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' ); console.log( ndarray2array( x ) ); -var v = dnanmskmax( [ x ] ); +var maskbuf = filledarrayBy( xbuf.length, 'uint8', randMask ); +var mask = new ndarray( 'uint8', maskbuf, [ maskbuf.length ], [ 1 ], 0, 'row-major' ); +console.log( ndarray2array( mask ) ); + +var v = dnanmskmax( [ x, mask ] ); console.log( v ); diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/lib/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/lib/index.js index 352f4452b94d..7b6883c225cc 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/lib/index.js @@ -25,13 +25,17 @@ * * @example * var Float64Array = require( '@stdlib/array/float64' ); +* var Uint8Array = require( '@stdlib/array/uint8' ); * var ndarray = require( '@stdlib/ndarray/base/ctor' ); * var dnanmskmax = require( '@stdlib/stats/base/ndarray/dnanmskmax' ); * * var xbuf = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] ); * var x = new ndarray( 'float64', xbuf, [ 4 ], [ 1 ], 0, 'row-major' ); * -* var v = dnanmskmax( [ x ] ); +* var maskbuf = new Uint8Array( [ 0, 0, 0, 0 ] ); +* var mask = new ndarray( 'uint8', maskbuf, [ 4 ], [ 1 ], 0, 'row-major' ); +* +* var v = dnanmskmax( [ x, mask ] ); * // returns 2.0 */ From 2c3a9c70a88262153869809a002e97b130625f86 Mon Sep 17 00:00:00 2001 From: Athan Date: Wed, 3 Dec 2025 20:40:41 -0800 Subject: [PATCH 03/12] docs: update copy Signed-off-by: Athan --- .../@stdlib/stats/base/ndarray/dnanmskmax/README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/README.md b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/README.md index 1ea4ff3e347b..67042fcaad3d 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/README.md +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/README.md @@ -59,6 +59,9 @@ The function has the following parameters: - **arrays**: array-like object containing a one-dimensional input ndarray and a one-dimensional mask ndarray. +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. + + From 2413aa418bef5b1b0355ec00afce06c4242ed869 Mon Sep 17 00:00:00 2001 From: Athan Date: Wed, 3 Dec 2025 20:41:24 -0800 Subject: [PATCH 04/12] docs: update note Signed-off-by: Athan --- .../@stdlib/stats/base/ndarray/dnanmskmax/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/README.md b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/README.md index 67042fcaad3d..c03ee8416e4b 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/README.md +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/README.md @@ -70,7 +70,7 @@ If a `mask` array element is `0`, the corresponding element in the input ndarray ## Notes -- If provided an empty one-dimensional ndarray, the function returns `NaN`. +- If provided an empty one-dimensional ndarray or a mask with all elements set to `1`, the function returns `NaN`. From 014e1099019697c4fd9812f94dc4efec507ed4da Mon Sep 17 00:00:00 2001 From: Athan Date: Wed, 3 Dec 2025 20:42:25 -0800 Subject: [PATCH 05/12] docs: make note consistent with `dmskmin` Signed-off-by: Athan --- .../@stdlib/stats/base/ndarray/dnanmskmax/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/README.md b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/README.md index c03ee8416e4b..cd5404622749 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/README.md +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/README.md @@ -70,7 +70,7 @@ If a `mask` array element is `0`, the corresponding element in the input ndarray ## Notes -- If provided an empty one-dimensional ndarray or a mask with all elements set to `1`, the function returns `NaN`. +- If provided an empty ndarray or a mask with all elements set to `1`, the function returns `NaN`. From ca6c8525c813145c6ae1be8d54c22a27428f597d Mon Sep 17 00:00:00 2001 From: Athan Date: Wed, 3 Dec 2025 20:43:44 -0800 Subject: [PATCH 06/12] docs: update desc Signed-off-by: Athan --- .../stats/base/ndarray/dnanmskmax/benchmark/benchmark.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/benchmark/benchmark.js index cba8cd2c3150..abf6b708be1d 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/benchmark/benchmark.js @@ -50,7 +50,7 @@ function rand() { * Returns a random mask value. * * @private -* @returns {number} 0 or 1 +* @returns {number} random mask value */ function randMask() { if ( bernoulli( 0.1 ) < 1 ) { From 3207f8657202554d9dcffb4c4f859d2cdc6c12a7 Mon Sep 17 00:00:00 2001 From: Athan Date: Wed, 3 Dec 2025 20:46:12 -0800 Subject: [PATCH 07/12] bench: simplify array creation Signed-off-by: Athan --- .../ndarray/dnanmskmax/benchmark/benchmark.js | 47 ++++++------------- 1 file changed, 15 insertions(+), 32 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/benchmark/benchmark.js index abf6b708be1d..d800ac7c9932 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/benchmark/benchmark.js @@ -21,9 +21,8 @@ // MODULES // var bench = require( '@stdlib/bench' ); -var uniform = require( '@stdlib/random/base/uniform' ); -var bernoulli = require( '@stdlib/random/base/bernoulli' ); -var filledarrayBy = require( '@stdlib/array/filled-by' ); +var uniform = require( '@stdlib/random/array/uniform' ); +var bernoulli = require( '@stdlib/random/array/bernoulli' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); var ndarray = require( '@stdlib/ndarray/base/ctor' ); @@ -31,33 +30,17 @@ var pkg = require( './../package.json' ).name; var dnanmskmax = require( './../lib' ); -// FUNCTIONS // +// VARIABLES // -/** -* Returns a random number. -* -* @private -* @returns {number} random number or `NaN` -*/ -function rand() { - if ( bernoulli( 0.2 ) < 1 ) { - return NaN; - } - return uniform( -10.0, 10.0 ); -} +var options = { + 'dtype': 'float64' +}; +var moptions = { + 'dtype': 'uint8' +}; -/** -* Returns a random mask value. -* -* @private -* @returns {number} random mask value -*/ -function randMask() { - if ( bernoulli( 0.1 ) < 1 ) { - return 1; - } - return 0; -} + +// FUNCTIONS // /** * Creates a benchmark function. @@ -72,11 +55,11 @@ function createBenchmark( len ) { var xbuf; var x; - xbuf = filledarrayBy( len, 'float64', rand ); - x = new ndarray( 'float64', xbuf, [ len ], [ 1 ], 0, 'row-major' ); + xbuf = uniform( len, -100.0, 100.0, options ); + x = new ndarray( options.dtype, xbuf, [ len ], [ 1 ], 0, 'row-major' ); - mbuf = filledarrayBy( len, 'uint8', randMask ); - mask = new ndarray( 'uint8', mbuf, [ len ], [ 1 ], 0, 'row-major' ); + mbuf = bernoulli( len, 0.2, moptions ); + mask = new ndarray( moptions.dtype, mbuf, [ len ], [ 1 ], 0, 'row-major' ); return benchmark; From 3b84330c193f24a2e8eedfc31a2c2cff9bc4ecc5 Mon Sep 17 00:00:00 2001 From: Athan Date: Wed, 3 Dec 2025 20:47:20 -0800 Subject: [PATCH 08/12] docs: fix line wrapping Signed-off-by: Athan --- .../@stdlib/stats/base/ndarray/dnanmskmax/docs/repl.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/docs/repl.txt index 7fc7a4c4f05f..9a48f55b91c1 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/docs/repl.txt @@ -1,7 +1,7 @@ {{alias}}( arrays ) - Computes the maximum value of a double-precision floating- - point ndarray according to a mask, ignoring `NaN` values. + Computes the maximum value of a double-precision floating-point ndarray + according to a mask, ignoring `NaN` values. If provided an empty ndarray, the function returns `NaN`. From d95592b955c0424d1f24d2c7e3e9d2bb2705260c Mon Sep 17 00:00:00 2001 From: Athan Date: Wed, 3 Dec 2025 20:48:09 -0800 Subject: [PATCH 09/12] docs: update copy Signed-off-by: Athan --- .../@stdlib/stats/base/ndarray/dnanmskmax/docs/repl.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/docs/repl.txt index 9a48f55b91c1..5eaf9296a547 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/docs/repl.txt @@ -3,13 +3,13 @@ Computes the maximum value of a double-precision floating-point ndarray according to a mask, ignoring `NaN` values. - If provided an empty ndarray, the function returns `NaN`. + If provided an empty ndarray or a mask with all elements set to `1`, the + function returns `NaN`. Parameters ---------- arrays: ArrayLikeObject - Array-like object containing a one-dimensional input ndarray and a - one-dimensional mask ndarray. + Array-like object containing an input ndarray and a mask ndarray. Returns ------- From f57b36837cdbb372c1dafb1fe5f755e3993e1254 Mon Sep 17 00:00:00 2001 From: Athan Date: Wed, 3 Dec 2025 20:50:42 -0800 Subject: [PATCH 10/12] docs: update example Signed-off-by: Athan --- .../@stdlib/stats/base/ndarray/dnanmskmax/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/README.md b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/README.md index cd5404622749..e11c2c547049 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/README.md +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/README.md @@ -91,7 +91,7 @@ var ndarray2array = require( '@stdlib/ndarray/to-array' ); var dnanmskmax = require( '@stdlib/stats/base/ndarray/dnanmskmax' ); function rand() { - if ( bernoulli( 0.2 ) < 1 ) { + if ( bernoulli( 0.8 ) < 1 ) { return NaN; } return uniform( -50.0, 50.0 ); From 4c2fe2481151e4a52b1399c10fc8f015051ae22d Mon Sep 17 00:00:00 2001 From: Athan Date: Wed, 3 Dec 2025 20:51:25 -0800 Subject: [PATCH 11/12] docs: update example Signed-off-by: Athan --- .../@stdlib/stats/base/ndarray/dnanmskmax/examples/index.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/examples/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/examples/index.js index 6e470265c2b3..a906c8f016ea 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/examples/index.js @@ -26,7 +26,7 @@ var ndarray2array = require( '@stdlib/ndarray/to-array' ); var dnanmskmax = require( './../lib' ); function rand() { - if ( bernoulli( 0.2 ) < 1 ) { + if ( bernoulli( 0.8 ) < 1 ) { return NaN; } return uniform( -50.0, 50.0 ); From e428a6add5674e618b4ac5b56276f4e40d0381f8 Mon Sep 17 00:00:00 2001 From: Athan Date: Wed, 3 Dec 2025 20:53:37 -0800 Subject: [PATCH 12/12] test: actually test that elements are masked Signed-off-by: Athan --- .../@stdlib/stats/base/ndarray/dnanmskmax/test/test.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/test/test.js b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/test/test.js index 817016c94222..57997268f4bc 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/test/test.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/dnanmskmax/test/test.js @@ -66,9 +66,9 @@ tape( 'the function calculates the maximum value of a one-dimensional ndarray ac var v; x = new Float64Array( [ 1.0, -2.0, -4.0, NaN, 5.0, 0.0, 3.0 ] ); - mask = new Uint8Array( [ 0, 0, 0, 0, 0, 0, 0 ] ); + mask = new Uint8Array( [ 0, 0, 0, 0, 1, 0, 0 ] ); v = dnanmskmax( [ vector( 'float64', x, x.length, 1, 0 ), vector( 'uint8', mask, mask.length, 1, 0 ) ] ); - t.strictEqual( v, 5.0, 'returns expected value' ); + t.strictEqual( v, 3.0, 'returns expected value' ); x = new Float64Array( [ -4.0, NaN, -5.0 ] ); mask = new Uint8Array( [ 0, 0, 0 ] );