From 837387075ebdf2e29559699f17020e07a2314d13 Mon Sep 17 00:00:00 2001 From: kaustubh Date: Thu, 4 Dec 2025 22:19:01 +0530 Subject: [PATCH 1/5] feat: add stats/base/ndarray/snanmskrange --- .../stats/base/ndarray/snanmskrange/README.md | 129 +++++++++ .../snanmskrange/benchmark/benchmark.js | 109 ++++++++ .../base/ndarray/snanmskrange/docs/repl.txt | 35 +++ .../snanmskrange/docs/types/index.d.ts | 50 ++++ .../ndarray/snanmskrange/docs/types/test.ts | 63 +++++ .../ndarray/snanmskrange/examples/index.js | 40 +++ .../base/ndarray/snanmskrange/lib/index.js | 47 ++++ .../base/ndarray/snanmskrange/lib/main.js | 59 ++++ .../base/ndarray/snanmskrange/package.json | 66 +++++ .../base/ndarray/snanmskrange/test/test.js | 255 ++++++++++++++++++ 10 files changed, 853 insertions(+) create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/README.md create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/examples/index.js create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/lib/index.js create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/lib/main.js create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/package.json create mode 100644 lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/test/test.js diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/README.md b/lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/README.md new file mode 100644 index 000000000000..1f561ff5a9b6 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/README.md @@ -0,0 +1,129 @@ + + +# snanmskrange + +> Calculate the [range][range] of a one-dimensional single-precision floating-point ndarray according to a mask, ignoring `NaN` values. + +
+ +The [**range**][range] is defined as the difference between the maximum and minimum values. + +
+ + + +
+ +## Usage + +```javascript +var snanmskrange = require( '@stdlib/stats/base/ndarray/snanmskrange' ); +``` + +#### snanmskrange( arrays ) + +Computes the [range][range] of a one-dimensional single-precision floating-point ndarray according to a mask, ignoring `NaN` values. + +```javascript +var Float32Array = require( '@stdlib/array/float32' ); +var Uint8Array = require( '@stdlib/array/uint8' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); + +var xbuf = new Float32Array( [ 1.0, -2.0, 4.0, 2.0, NaN ] ); +var x = new ndarray( 'float32', xbuf, [ 5 ], [ 1 ], 0, 'row-major' ); + +var maskbuf = new Uint8Array( [ 0, 0, 1, 0, 0 ] ); +var mask = new ndarray( 'uint8', maskbuf, [ 5 ], [ 1 ], 0, 'row-major' ); + +var v = snanmskrange( [ x, mask ] ); +// returns 4.0 +``` + +The function has the following parameters: + +- **arrays**: array-like object containing an input ndarray and a 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. + +
+ + + +
+ +## Notes + +- If provided an empty ndarray or a mask with all elements set to `1`, the function returns `NaN`. + +
+ + + +
+ +## Examples + + + +```javascript +var uniform = require( '@stdlib/random/array/uniform' ); +var bernoulli = require( '@stdlib/random/array/bernoulli' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var ndarray2array = require( '@stdlib/ndarray/to-array' ); +var snanmskrange = require( '@stdlib/stats/base/ndarray/snanmskrange' ); + +var xbuf = uniform( 10, -50.0, 50.0, { + 'dtype': 'float32' +}); +var x = new ndarray( 'float32', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' ); +console.log( ndarray2array( x ) ); + +var maskbuf = bernoulli( xbuf.length, 0.2, { + 'dtype': 'uint8' +}); +var mask = new ndarray( 'uint8', maskbuf, [ maskbuf.length ], [ 1 ], 0, 'row-major' ); +console.log( ndarray2array( mask ) ); + +var v = snanmskrange( [ x, mask ] ); +console.log( v ); +``` + +
+ + + + + + + + + + + + + + diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/benchmark/benchmark.js new file mode 100644 index 000000000000..b5bedc1ed7ee --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/benchmark/benchmark.js @@ -0,0 +1,109 @@ +/** +* @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/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' ); +var pkg = require( '@stdlib/stats/base/ndarray/snanmskrange/package.json' ).name; +var snanmskrange = require( '@stdlib/stats/base/ndarray/snanmskrange/lib' ); + + +// VARIABLES // + +var options = { + 'dtype': 'float32' +}; + + +// FUNCTIONS // + +/** +* 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 = uniform( len, -100.0, 100.0, options ); + x = new ndarray( options.dtype, xbuf, [ len ], [ 1 ], 0, 'row-major' ); + + mbuf = bernoulli( len, 0.2, options ); + mask = new ndarray( options.dtype, mbuf, [ len ], [ 1 ], 0, 'row-major' ); + + return benchmark; + + function benchmark( b ) { + var v; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + xbuf[ i%len ] = i; + v = snanmskrange( [ 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/snanmskrange/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/docs/repl.txt new file mode 100644 index 000000000000..4b3b24060f3b --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/docs/repl.txt @@ -0,0 +1,35 @@ + +{{alias}}( arrays ) + Calculates the range of a one-dimensional single-precision floating-point + ndarray according to a mask, ignoring `NaN` values. + + 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 an input ndarray and a mask ndarray. + + Returns + ------- + out: number + Range. + + Examples + -------- + > var xbuf = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 4.0, 2.0, NaN ] ); + > var dt = 'float32'; + > 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 ); + > var maskbuf = new {{alias:@stdlib/array/uint8}}( [ 0, 0, 1, 0, 0 ] ); + > var mask = new {{alias:@stdlib/ndarray/ctor}}( 'uint8', maskbuf, sh, sx, ox, ord ); + > {{alias}}( [ x, mask ] ) + 4.0 + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/docs/types/index.d.ts new file mode 100644 index 000000000000..6e1bbecf38ac --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/docs/types/index.d.ts @@ -0,0 +1,50 @@ +/* +* @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 { float32ndarray, uint8ndarray } from '@stdlib/types/ndarray'; + +/** +* Calculates the range of a one-dimensional single-precision floating-point ndarray according to a mask, ignoring `NaN` values. +* +* @param arrays - array-like object containing an input ndarray and a mask ndarray +* @returns range +* +* @example +* var Float32Array = require( '@stdlib/array/float32' ); +* var Uint8Array = require( '@stdlib/array/uint8' ); +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* +* var xbuf = new Float32Array( [ 1.0, -2.0, 4.0, 2.0, NaN ] ); +* var x = new ndarray( 'float32', xbuf, [ 5 ], [ 1 ], 0, 'row-major' ); +* +* var maskbuf = new Uint8Array( [ 0, 0, 1, 0, 0 ] ); +* var mask = new ndarray( 'uint8', maskbuf, [ 5 ], [ 1 ], 0, 'row-major' ); +* +* var v = snanmskrange( [ x, mask ] ); +* // returns 4.0 +*/ +declare function snanmskrange( arrays: [ float32ndarray, uint8ndarray ] ): number; + + +// EXPORTS // + +export = snanmskrange; diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/docs/types/test.ts b/lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/docs/types/test.ts new file mode 100644 index 000000000000..1f35026b02a1 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/docs/types/test.ts @@ -0,0 +1,63 @@ +/* +* @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 snanmskrange = require( '@stdlib/stats/base/ndarray/snanmskrange' ); + + +// TESTS // + +// The function returns a number... +{ + const x = zeros( [ 10 ], { + 'dtype': 'float32' + }); + const mask = zeros( [ 10 ], { + 'dtype': 'uint8' + }); + + snanmskrange( [ x, mask ] ); // $ExpectType number +} + +// The compiler throws an error if the function is provided a first argument which is not an array of ndarrays... +{ + snanmskrange( '10' ); // $ExpectError + snanmskrange( 10 ); // $ExpectError + snanmskrange( true ); // $ExpectError + snanmskrange( false ); // $ExpectError + snanmskrange( null ); // $ExpectError + snanmskrange( undefined ); // $ExpectError + snanmskrange( [] ); // $ExpectError + snanmskrange( {} ); // $ExpectError + snanmskrange( ( 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': 'float32' + }); + const mask = zeros( [ 10 ], { + 'dtype': 'uint8' + }); + + snanmskrange(); // $ExpectError + snanmskrange( [ x, mask ], {} ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/examples/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/examples/index.js new file mode 100644 index 000000000000..d02446945837 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/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/array/uniform' ); +var bernoulli = require( '@stdlib/random/array/bernoulli' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var ndarray2array = require( '@stdlib/ndarray/to-array' ); +var snanmskrange = require( '@stdlib/stats/base/ndarray/snanmskrange/lib' ); + +var xbuf = uniform( 10, -50.0, 50.0, { + 'dtype': 'float32' +}); +var x = new ndarray( 'float32', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' ); +console.log( ndarray2array( x ) ); + +var maskbuf = bernoulli( xbuf.length, 0.2, { + 'dtype': 'uint8' +}); +var mask = new ndarray( 'uint8', maskbuf, [ maskbuf.length ], [ 1 ], 0, 'row-major' ); +console.log( ndarray2array( mask ) ); + +var v = snanmskrange( [ x, mask ] ); +console.log( v ); diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/lib/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/lib/index.js new file mode 100644 index 000000000000..22b5b1d8c165 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/lib/index.js @@ -0,0 +1,47 @@ +/** +* @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 range of a one-dimensional single-precision floating-point ndarray according to a mask, ignoring `NaN` values. +* +* @module @stdlib/stats/base/ndarray/snanmskrange +* +* @example +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* var snanmskrange = require( '@stdlib/stats/base/ndarray/snanmskrange' ); +* +* var xbuf = [ 1.0, -2.0, 4.0, 2.0, NaN ]; +* var x = new ndarray( 'float32', xbuf, [ 5 ], [ 1 ], 0, 'row-major' ); +* +* var maskbuf = [ 0, 0, 1, 0, 0 ]; +* var mask = new ndarray( 'uint8', maskbuf, [ 5 ], [ 1 ], 0, 'row-major' ); +* +* var v = snanmskrange( [ x, mask ] ); +* // returns 4.0 +*/ + +// MODULES // + +var main = require( '@stdlib/stats/base/ndarray/snanmskrange/lib/main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/lib/main.js b/lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/lib/main.js new file mode 100644 index 000000000000..74158c04a3be --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/lib/main.js @@ -0,0 +1,59 @@ +/** +* @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/snanmskrange' ).ndarray; + + +// MAIN // + +/** +* Computes the range of a one-dimensional single-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} range +* +* @example +* var ndarray = require( '@stdlib/ndarray/base/ctor' ); +* +* var xbuf = [ 1.0, -2.0, 4.0, 2.0, NaN ]; +* var x = new ndarray( 'float32', xbuf, [ 5 ], [ 1 ], 0, 'row-major' ); +* +* var maskbuf = [ 0, 0, 1, 0, 0 ]; +* var mask = new ndarray( 'uint8', maskbuf, [ 5 ], [ 1 ], 0, 'row-major' ); +* +* var v = snanmskrange( [ x, mask ] ); +* // returns 4.0 +*/ +function snanmskrange( 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 = snanmskrange; diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/package.json b/lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/package.json new file mode 100644 index 000000000000..e9b15b87cfec --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/package.json @@ -0,0 +1,66 @@ +{ + "name": "@stdlib/stats/base/ndarray/snanmskrange", + "version": "0.0.0", + "description": "Calculate the range of a one-dimensional single-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", + "range", + "single-precision", + "masked", + "mask", + "nan", + "ndarray" + ], + "__stdlib__": {} +} diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/test/test.js b/lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/test/test.js new file mode 100644 index 000000000000..1476efe15bd7 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/test/test.js @@ -0,0 +1,255 @@ +/** +* @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 isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var isPositiveZerof = require( '@stdlib/math/base/assert/is-positive-zerof' ); +var Float32Array = require( '@stdlib/array/float32' ); +var Uint8Array = require( '@stdlib/array/uint8' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var snanmskrange = require( '@stdlib/stats/base/ndarray/snanmskrange/lib' ); + + +// FUNCTIONS // + +/** +* Returns a one-dimensional ndarray. +* +* @private +* @param {Collection} buffer - underlying data buffer +* @param {string} dtype - data type +* @param {NonNegativeInteger} length - number of indexed elements +* @param {integer} stride - stride length +* @param {NonNegativeInteger} offset - index offset +* @returns {ndarray} one-dimensional ndarray +*/ +function vector( buffer, dtype, 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 snanmskrange, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 1', function test( t ) { + t.strictEqual( snanmskrange.length, 1, 'has expected arity' ); + t.end(); +}); + +tape( 'the function calculates the range value of a one-dimensional single-precision floating-point ndarray according to a mask, ignoring NaN values', function test( t ) { + var mask; + var x; + var v; + + x = new Float32Array( [ 1.0, -2.0, -4.0, NaN, 5.0, 0.0, 3.0 ] ); + mask = new Uint8Array( [ 0, 0, 0, 1, 0, 0, 0 ] ); + v = snanmskrange( [ vector( x, 'float32', x.length, 1, 0 ), vector( mask, 'uint8', mask.length, 1, 0 ) ] ); + t.strictEqual( v, 9.0, 'returns expected value' ); + + x = new Float32Array( [ -4.0, NaN, -5.0 ] ); + mask = new Uint8Array( [ 0, 1, 0 ] ); + v = snanmskrange( [ vector( x, 'float32', x.length, 1, 0 ), vector( mask, 'uint8', mask.length, 1, 0 ) ] ); + t.strictEqual( v, 1.0, 'returns expected value' ); + + x = new Float32Array( [ -0.0, 0.0, NaN, -0.0 ] ); + mask = new Uint8Array( [ 0, 0, 1, 0 ] ); + v = snanmskrange( [ vector( x, 'float32', x.length, 1, 0 ), vector( mask, 'uint8', mask.length, 1, 0 ) ] ); + t.strictEqual( isPositiveZerof( v ), true, 'returns expected value' ); + + x = new Float32Array( [ -4.0, 0.0, NaN, 5.0 ] ); + mask = new Uint8Array( [ 0, 0, 0, 0 ] ); + v = snanmskrange( [ vector( x, 'float32', x.length, 1, 0 ), vector( mask, 'uint8', mask.length, 1, 0 ) ] ); + t.strictEqual( v, 9.0, 'returns expected value' ); + + x = new Float32Array( [ NaN ] ); + mask = new Uint8Array( [ 0 ] ); + v = snanmskrange( [ vector( x, 'float32', x.length, 1, 0 ), vector( mask, 'uint8', mask.length, 1, 0 ) ] ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + + x = new Float32Array( [ NaN ] ); + mask = new Uint8Array( [ 1 ] ); + v = snanmskrange( [ vector( x, 'float32', x.length, 1, 0 ), vector( mask, 'uint8', mask.length, 1, 0 ) ] ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + + x = new Float32Array( [ NaN, NaN ] ); + mask = new Uint8Array( [ 1, 1 ] ); + v = snanmskrange( [ vector( x, 'float32', x.length, 1, 0 ), vector( mask, 'uint8', mask.length, 1, 0 ) ] ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + + x = new Float32Array( [ NaN, NaN ] ); + mask = new Uint8Array( [ 1, 0 ] ); + v = snanmskrange( [ vector( x, 'float32', x.length, 1, 0 ), vector( mask, 'uint8', mask.length, 1, 0 ) ] ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + + x = new Float32Array( [ NaN, NaN ] ); + mask = new Uint8Array( [ 0, 1 ] ); + v = snanmskrange( [ vector( x, 'float32', x.length, 1, 0 ), vector( mask, 'uint8', mask.length, 1, 0 ) ] ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + + x = new Float32Array( [ NaN, NaN ] ); + mask = new Uint8Array( [ 0, 0 ] ); + v = snanmskrange( [ vector( x, 'float32', x.length, 1, 0 ), vector( mask, 'uint8', mask.length, 1, 0 ) ] ); + t.strictEqual( isnanf( 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 Float32Array( [] ); + mask = new Uint8Array( [] ); + + v = snanmskrange( [ vector( x, 'float32', 0, 1, 0 ), vector( mask, 'uint8', 0, 1, 0 ) ] ); + t.strictEqual( isnanf( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an ndarray containing a single element, the function returns zero', function test( t ) { + var mask; + var x; + var v; + + x = new Float32Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); + mask = new Uint8Array( [ 0, 0, 0, 0, 0 ] ); + + v = snanmskrange( [ vector( x, 'float32', 1, 1, 0 ), vector( mask, 'uint8', 1, 1, 0 ) ] ); + t.strictEqual( v, 0.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 Float32Array([ + 1.0, // 0 + 2.0, + 2.0, // 1 + -7.0, + -2.0, // 2 + 3.0, + 4.0, // 3 + 2.0, + 5.0, // 4 + 6.0 + ]); + mask = new Uint8Array([ + 0, // 0 + 0, + 0, // 1 + 0, + 0, // 2 + 0, + 0, // 3 + 0, + 1, // 4 + 1 + ]); + + v = snanmskrange( [ vector( x, 'float32', 5, 2, 0 ), vector( mask, 'uint8', 5, 2, 0 ) ] ); + + t.strictEqual( v, 6.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 Float32Array([ + 5.0, // 4 + 6.0, + 1.0, // 3 + 2.0, + 2.0, // 2 + -7.0, + -2.0, // 1 + 3.0, + 4.0, // 0 + 2.0 + ]); + mask = new Uint8Array([ + 1, // 4 + 1, + 0, // 3 + 0, + 0, // 2 + 0, + 0, // 1 + 0, + 0, // 0 + 0 + ]); + + v = snanmskrange( [ vector( x, 'float32', 5, -2, 8 ), vector( mask, 'uint8', 5, -2, 8 ) ] ); + + t.strictEqual( v, 6.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 Float32Array([ + 2.0, + 1.0, // 0 + 2.0, + -2.0, // 1 + -2.0, + 2.0, // 2 + 3.0, + 4.0, // 3 + 5.0, + 6.0 // 4 + ]); + mask = new Uint8Array([ + 0, + 0, // 0 + 0, + 0, // 1 + 0, + 0, // 2 + 0, + 0, // 3 + 1, + 1 // 4 + ]); + + v = snanmskrange( [ vector( x, 'float32', 5, 2, 1 ), vector( mask, 'uint8', 5, 2, 1 ) ] ); + t.strictEqual( v, 6.0, 'returns expected value' ); + + t.end(); +}); From abfb3d5518dd1c36f7ee5fea320a0274a1ff17a3 Mon Sep 17 00:00:00 2001 From: kaustubh Date: Thu, 4 Dec 2025 22:24:08 +0530 Subject: [PATCH 2/5] added root directory --- .../@stdlib/stats/base/ndarray/snanmskrange/lib/index.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/lib/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/lib/index.js index 22b5b1d8c165..3b7718849c4e 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/lib/index.js @@ -39,7 +39,7 @@ // MODULES // -var main = require( '@stdlib/stats/base/ndarray/snanmskrange/lib/main.js' ); +var main = require( './main.js' ); // EXPORTS // From 730e61a9e27a942a42c22cfb6c94cadd6c129810 Mon Sep 17 00:00:00 2001 From: kaustubh Date: Thu, 4 Dec 2025 22:27:27 +0530 Subject: [PATCH 3/5] Lint --- .../@stdlib/stats/base/ndarray/snanmskrange/examples/index.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/examples/index.js b/lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/examples/index.js index d02446945837..691e6cd42489 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/examples/index.js @@ -22,7 +22,7 @@ var uniform = require( '@stdlib/random/array/uniform' ); var bernoulli = require( '@stdlib/random/array/bernoulli' ); var ndarray = require( '@stdlib/ndarray/base/ctor' ); var ndarray2array = require( '@stdlib/ndarray/to-array' ); -var snanmskrange = require( '@stdlib/stats/base/ndarray/snanmskrange/lib' ); +var snanmskrange = require( './../lib' ); var xbuf = uniform( 10, -50.0, 50.0, { 'dtype': 'float32' From 4033d29dfe4b1b38e898cf571309a441cfc9c698 Mon Sep 17 00:00:00 2001 From: kaustubh Date: Thu, 4 Dec 2025 22:31:08 +0530 Subject: [PATCH 4/5] Lint2 --- .../@stdlib/stats/base/ndarray/snanmskrange/test/test.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/test/test.js b/lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/test/test.js index 1476efe15bd7..5dafa896d3e1 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/test/test.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/test/test.js @@ -26,7 +26,7 @@ var isPositiveZerof = require( '@stdlib/math/base/assert/is-positive-zerof' ); var Float32Array = require( '@stdlib/array/float32' ); var Uint8Array = require( '@stdlib/array/uint8' ); var ndarray = require( '@stdlib/ndarray/base/ctor' ); -var snanmskrange = require( '@stdlib/stats/base/ndarray/snanmskrange/lib' ); +var snanmskrange = require( './../lib' ); // FUNCTIONS // From fca08f10cbe4c6732c001c3d9170c25b449edffe Mon Sep 17 00:00:00 2001 From: kaustubh Date: Thu, 4 Dec 2025 22:35:26 +0530 Subject: [PATCH 5/5] Lint --- .../stats/base/ndarray/snanmskrange/benchmark/benchmark.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/benchmark/benchmark.js index b5bedc1ed7ee..1090c1b451c8 100644 --- a/lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/ndarray/snanmskrange/benchmark/benchmark.js @@ -26,8 +26,8 @@ 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' ); -var pkg = require( '@stdlib/stats/base/ndarray/snanmskrange/package.json' ).name; -var snanmskrange = require( '@stdlib/stats/base/ndarray/snanmskrange/lib' ); +var pkg = require( './../package.json' ).name; +var snanmskrange = require( './../lib' ); // VARIABLES //