diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmin/README.md b/lib/node_modules/@stdlib/stats/base/nanmskmin/README.md index e1d63bb6afc5..556cbd659a01 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmin/README.md +++ b/lib/node_modules/@stdlib/stats/base/nanmskmin/README.md @@ -2,7 +2,7 @@ @license Apache-2.0 -Copyright (c) 2020 The Stdlib Authors. +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. @@ -33,7 +33,7 @@ limitations under the License. ## Usage ```javascript -var nanmskmin = require( '@stdlib/stats/base/nanmskmin' ); +var nanmskmin = require("@stdlib/stats/base/nanmskmin"); ``` #### nanmskmin( N, x, strideX, mask, strideMask ) @@ -41,31 +41,28 @@ var nanmskmin = require( '@stdlib/stats/base/nanmskmin' ); Computes the minimum value of a strided array `x` according to a `mask`, ignoring `NaN` values. ```javascript -var x = [ 1.0, -2.0, -4.0, 2.0, NaN ]; -var mask = [ 0, 0, 1, 0, 0 ]; +var x = [1.0, -2.0, -4.0, 2.0, NaN]; +var mask = [0, 0, 1, 0, 0]; -var v = nanmskmin( x.length, x, 1, mask, 1 ); +var v = nanmskmin(x.length, x, 1, mask, 1); // returns -2.0 ``` The function has the following parameters: -- **N**: number of indexed elements. -- **x**: input [`Array`][mdn-array] or [`typed array`][mdn-typed-array]. -- **strideX**: index increment for `x`. -- **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. -- **strideMask**: index increment for `mask`. +- **N**: number of indexed elements. +- **x**: input [`Array`][mdn-array] or [`typed array`][mdn-typed-array]. +- **strideX**: stride length for `x`. +- **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. +- **strideMask**: stride length for `mask`. -The `N` and `stride` parameters determine which elements are accessed at runtime. For example, to compute the minimum value of every other element in `x`, +The `N` and `stride` parameters determine which elements in the strided arrays are accessed at runtime. For example, to compute the minimum value of every other element in `x`, ```javascript -var floor = require( '@stdlib/math/base/special/floor' ); +var x = [1.0, 2.0, -7.0, -2.0, 4.0, 3.0, -5.0, -6.0]; +var mask = [0, 0, 0, 0, 0, 0, 1, 1]; -var x = [ 1.0, 2.0, -7.0, -2.0, 4.0, 3.0, -5.0, -6.0 ]; -var mask = [ 0, 0, 0, 0, 0, 0, 1, 1 ]; -var N = floor( x.length / 2 ); - -var v = nanmskmin( N, x, 2, mask, 2 ); +var v = nanmskmin(4, x, 2, mask, 2); // returns -7.0 ``` @@ -74,19 +71,16 @@ Note that indexing is relative to the first index. To introduce offsets, use [`t ```javascript -var Float64Array = require( '@stdlib/array/float64' ); -var Uint8Array = require( '@stdlib/array/uint8' ); -var floor = require( '@stdlib/math/base/special/floor' ); - -var x0 = new Float64Array( [ 2.0, 1.0, -2.0, -2.0, 3.0, 4.0, 5.0, 6.0 ] ); -var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element +var Float64Array = require("@stdlib/array/float64"); +var Uint8Array = require("@stdlib/array/uint8"); -var mask0 = new Uint8Array( [ 0, 0, 0, 0, 0, 0, 1, 1 ] ); -var mask1 = new Uint8Array( mask0.buffer, mask0.BYTES_PER_ELEMENT*1 ); // start at 2nd element +var x0 = new Float64Array([2.0, 1.0, -2.0, -2.0, 3.0, 4.0, 5.0, 6.0]); +var x1 = new Float64Array(x0.buffer, x0.BYTES_PER_ELEMENT * 1); // start at 2nd element -var N = floor( x0.length / 2 ); +var mask0 = new Uint8Array([0, 0, 0, 0, 0, 0, 1, 1]); +var mask1 = new Uint8Array(mask0.buffer, mask0.BYTES_PER_ELEMENT * 1); // start at 2nd element -var v = nanmskmin( N, x1, 2, mask1, 2 ); +var v = nanmskmin(4, x1, 2, mask1, 2); // returns -2.0 ``` @@ -95,28 +89,27 @@ var v = nanmskmin( N, x1, 2, mask1, 2 ); Computes the minimum value of a strided array according to a `mask`, ignoring `NaN` values and using alternative indexing semantics. ```javascript -var x = [ 1.0, -2.0, -4.0, 2.0, NaN ]; -var mask = [ 0, 0, 1, 0, 0 ]; +var x = [1.0, -2.0, -4.0, 2.0, NaN]; +var mask = [0, 0, 1, 0, 0]; -var v = nanmskmin.ndarray( x.length, x, 1, 0, mask, 1, 0 ); +var v = nanmskmin.ndarray(x.length, x, 1, 0, mask, 1, 0); // returns -2.0 ``` The function has the following additional parameters: -- **offsetX**: starting index for `x`. -- **offsetMask**: starting index for `mask`. +- **offsetX**: starting index for `x`. +- **offsetMask**: starting index for `mask`. -While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying `buffer`, the `offset` parameter supports indexing semantics based on a starting index. For example, to calculate the minimum value for every other value in `x` starting from the second value +While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset +indexing semantics based on +starting indices. For example, to calculate the minimum value for every other value in `x` starting from the second value ```javascript -var floor = require( '@stdlib/math/base/special/floor' ); +var x = [2.0, 1.0, -2.0, -2.0, 3.0, 4.0, -5.0, -6.0]; +var mask = [0, 0, 0, 0, 0, 0, 1, 1]; -var x = [ 2.0, 1.0, -2.0, -2.0, 3.0, 4.0, -5.0, -6.0 ]; -var mask = [ 0, 0, 0, 0, 0, 0, 1, 1 ]; -var N = floor( x.length / 2 ); - -var v = nanmskmin.ndarray( N, x, 2, 1, mask, 2, 1 ); +var v = nanmskmin.ndarray(4, x, 2, 1, mask, 2, 1); // returns -2.0 ``` @@ -128,8 +121,9 @@ var v = nanmskmin.ndarray( N, x, 2, 1, mask, 2, 1 ); ## Notes -- If `N <= 0`, both functions return `NaN`. -- Depending on the environment, the typed versions ([`dnanmskmin`][@stdlib/stats/base/dnanmskmin], [`snanmskmin`][@stdlib/stats/base/snanmskmin], etc.) are likely to be significantly more performant. +- If `N <= 0`, both functions return `NaN`. +- Depending on the environment, the typed versions ([`dnanmskmin`][@stdlib/stats/base/dnanmskmin], [`snanmskmin`][@stdlib/stats/base/snanmskmin], etc.) are likely to be significantly more performant. +- 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]). @@ -142,35 +136,22 @@ var v = nanmskmin.ndarray( N, x, 2, 1, mask, 2, 1 ); ```javascript -var randu = require( '@stdlib/random/base/randu' ); -var round = require( '@stdlib/math/base/special/round' ); -var Float64Array = require( '@stdlib/array/float64' ); -var Uint8Array = require( '@stdlib/array/uint8' ); -var nanmskmin = require( '@stdlib/stats/base/nanmskmin' ); - -var mask; -var x; -var i; - -x = new Float64Array( 10 ); -mask = new Uint8Array( x.length ); -for ( i = 0; i < x.length; i++ ) { - if ( randu() < 0.2 ) { - mask[ i ] = 1; - } else { - mask[ i ] = 0; - } - if ( randu() < 0.1 ) { - x[ i ] = NaN; - } else { - x[ i ] = round( (randu()*100.0) - 50.0 ); - } -} -console.log( x ); -console.log( mask ); - -var v = nanmskmin( x.length, x, 1, mask, 1 ); -console.log( v ); +var uniform = require("@stdlib/random/array/uniform"); +var bernoulli = require("@stdlib/random/array/bernoulli"); +var nanmskmin = require("@stdlib/stats/base/nanmskmin"); + +var x = uniform(10, -50.0, 50.0, { + dtype: "float64", +}); +console.log(x); + +var mask = bernoulli(x.length, 0.2, { + dtype: "uint8", +}); +console.log(mask); + +var v = nanmskmin(x.length, x, 1, mask, 1); +console.log(v); ``` @@ -181,15 +162,15 @@ console.log( v );
-* * * +--- ## See Also -- [`@stdlib/stats/base/dnanmskmin`][@stdlib/stats/base/dnanmskmin]: calculate the minimum value of a double-precision floating-point strided array according to a mask, ignoring NaN values. -- [`@stdlib/stats/base/mskmin`][@stdlib/stats/base/mskmin]: calculate the minimum value of a strided array according to a mask. -- [`@stdlib/stats/base/nanmin`][@stdlib/stats/base/nanmin]: calculate the minimum value of a strided array, ignoring NaN values. -- [`@stdlib/stats/base/nanmskmax`][@stdlib/stats/base/nanmskmax]: calculate the maximum value of a strided array according to a mask, ignoring NaN values. -- [`@stdlib/stats/base/snanmskmin`][@stdlib/stats/base/snanmskmin]: calculate the minimum value of a single-precision floating-point strided array according to a mask, ignoring NaN values. +- [`@stdlib/stats/base/dnanmskmin`][@stdlib/stats/base/dnanmskmin]: calculate the minimum value of a double-precision floating-point strided array according to a mask, ignoring NaN values. +- [`@stdlib/stats/base/mskmin`][@stdlib/stats/base/mskmin]: calculate the minimum value of a strided array according to a mask. +- [`@stdlib/stats/base/nanmin`][@stdlib/stats/base/nanmin]: calculate the minimum value of a strided array, ignoring NaN values. +- [`@stdlib/stats/base/nanmskmax`][@stdlib/stats/base/nanmskmax]: calculate the maximum value of a strided array according to a mask, ignoring NaN values. +- [`@stdlib/stats/base/snanmskmin`][@stdlib/stats/base/snanmskmin]: calculate the minimum value of a single-precision floating-point strided array according to a mask, ignoring NaN values.
@@ -200,19 +181,15 @@ console.log( v );
[mdn-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array - +[@stdlib/array/base/accessor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/accessor [mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray [@stdlib/stats/base/dnanmskmin]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dnanmskmin - [@stdlib/stats/base/mskmin]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/mskmin - [@stdlib/stats/base/nanmin]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/nanmin - [@stdlib/stats/base/nanmskmax]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/nanmskmax - [@stdlib/stats/base/snanmskmin]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/snanmskmin diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmin/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/nanmskmin/benchmark/benchmark.js index b9ddaf5a7d17..3eadfc0476f8 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmin/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/nanmskmin/benchmark/benchmark.js @@ -1,87 +1,80 @@ /** -* @license Apache-2.0 -* -* Copyright (c) 2020 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. -*/ + * @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'; +"use strict"; // MODULES // -var bench = require( '@stdlib/bench' ); -var randu = require( '@stdlib/random/base/randu' ); -var isnan = require( '@stdlib/math/base/assert/is-nan' ); -var pow = require( '@stdlib/math/base/special/pow' ); -var pkg = require( './../package.json' ).name; -var nanmskmin = require( './../lib/nanmskmin.js' ); +var bench = require("@stdlib/bench"); +var isnan = require("@stdlib/math/base/assert/is-nan"); +var uniform = require("@stdlib/random/array/uniform"); +var bernoulli = require("@stdlib/random/array/bernoulli"); +var pow = require("@stdlib/math/base/special/pow"); +var pkg = require("./../package.json").name; +var nanmskmin = require("./../lib/nanmskmin.js"); +// VARIABLES // + +var options = { + dtype: "generic", +}; // FUNCTIONS // /** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var mask; - var x; - var i; - - x = []; - mask = []; - for ( i = 0; i < len; i++ ) { - if ( randu() < 0.2 ) { - mask.push( 1 ); - } else { - mask.push( 0 ); - } - x.push( ( randu()*20.0 ) - 10.0 ); - } + * Creates a benchmark function. + * + * @private + * @param {PositiveInteger} len - array length + * @returns {Function} benchmark function + */ +function createBenchmark(len) { + var mask = bernoulli(len, 0.2, options); + var x = uniform(len, -10.0, 10.0, options); return benchmark; - function benchmark( b ) { + function benchmark(b) { var v; var i; b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = nanmskmin( x.length, x, 1, mask, 1 ); - if ( isnan( v ) ) { - b.fail( 'should not return NaN' ); + for (i = 0; i < b.iterations; i++) { + v = nanmskmin(x.length, x, 1, mask, 1); + if (isnan(v)) { + b.fail("should not return NaN"); } } b.toc(); - if ( isnan( v ) ) { - b.fail( 'should not return NaN' ); + if (isnan(v)) { + b.fail("should not return NaN"); } - b.pass( 'benchmark finished' ); + b.pass("benchmark finished"); b.end(); } } - // MAIN // /** -* Main execution sequence. -* -* @private -*/ + * Main execution sequence. + * + * @private + */ function main() { var len; var min; @@ -92,10 +85,10 @@ function main() { 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 ); + for (i = min; i <= max; i++) { + len = pow(10, i); + f = createBenchmark(len); + bench(pkg + ":len=" + len, f); } } diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmin/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/base/nanmskmin/benchmark/benchmark.ndarray.js index b4e6c253ce48..3693d4400bdb 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmin/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/nanmskmin/benchmark/benchmark.ndarray.js @@ -1,87 +1,80 @@ /** -* @license Apache-2.0 -* -* Copyright (c) 2020 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. -*/ + * @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'; +"use strict"; // MODULES // -var bench = require( '@stdlib/bench' ); -var randu = require( '@stdlib/random/base/randu' ); -var isnan = require( '@stdlib/math/base/assert/is-nan' ); -var pow = require( '@stdlib/math/base/special/pow' ); -var pkg = require( './../package.json' ).name; -var nanmskmin = require( './../lib/ndarray.js' ); +var bench = require("@stdlib/bench"); +var isnan = require("@stdlib/math/base/assert/is-nan"); +var uniform = require("@stdlib/random/array/uniform"); +var bernoulli = require("@stdlib/random/array/bernoulli"); +var pow = require("@stdlib/math/base/special/pow"); +var pkg = require("./../package.json").name; +var nanmskmin = require("./../lib/ndarray.js"); +// VARIABLES // + +var options = { + dtype: "generic", +}; // FUNCTIONS // /** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var mask; - var x; - var i; - - x = []; - mask = []; - for ( i = 0; i < len; i++ ) { - if ( randu() < 0.2 ) { - mask.push( 1 ); - } else { - mask.push( 0 ); - } - x.push( ( randu()*20.0 ) - 10.0 ); - } + * Creates a benchmark function. + * + * @private + * @param {PositiveInteger} len - array length + * @returns {Function} benchmark function + */ +function createBenchmark(len) { + var mask = bernoulli(len, 0.2, options); + var x = uniform(len, -10.0, 10.0, options); return benchmark; - function benchmark( b ) { + function benchmark(b) { var v; var i; b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = nanmskmin( x.length, x, 1, 0, mask, 1, 0 ); - if ( isnan( v ) ) { - b.fail( 'should not return NaN' ); + for (i = 0; i < b.iterations; i++) { + v = nanmskmin(x.length, x, 1, 0, mask, 1, 0); + if (isnan(v)) { + b.fail("should not return NaN"); } } b.toc(); - if ( isnan( v ) ) { - b.fail( 'should not return NaN' ); + if (isnan(v)) { + b.fail("should not return NaN"); } - b.pass( 'benchmark finished' ); + b.pass("benchmark finished"); b.end(); } } - // MAIN // /** -* Main execution sequence. -* -* @private -*/ + * Main execution sequence. + * + * @private + */ function main() { var len; var min; @@ -92,10 +85,10 @@ function main() { min = 1; // 10^min max = 6; // 10^max - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':ndarray:len='+len, f ); + for (i = min; i <= max; i++) { + len = pow(10, i); + f = createBenchmark(len); + bench(pkg + ":ndarray:len=" + len, f); } } diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmin/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/nanmskmin/docs/repl.txt index 6ca57a6c18b0..dbd5f616798f 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmin/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/nanmskmin/docs/repl.txt @@ -3,8 +3,8 @@ Computes the minimum value of a strided array according to a mask and ignoring `NaN` values. - The `N` and `stride` parameters determine which elements are accessed at - runtime. + The `N` and stride parameters determine which elements in the strided arrays + are accessed at runtime. Indexing is relative to the first index. To introduce offsets, use a typed array views. @@ -26,13 +26,13 @@ Input array. strideX: integer - Index increment for `x`. + Stride length for `x`. mask: Array|TypedArray Mask array. strideMask: integer - Index increment for `mask`. + Stride length for `mask`. Returns ------- @@ -47,11 +47,9 @@ > {{alias}}( x.length, x, 1, mask, 1 ) -2.0 - // Using `N` and `stride` parameters: + // Using `N` and stride parameters: > x = [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, -4.0 ]; - > mask = [ 0, 0, 0, 0, 0, 0, 1 ]; - > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 ); - > {{alias}}( N, x, 2, mask, 2 ) + > {{alias}}( 3, x, 2, mask, 2 ) -2.0 // Using view offsets: @@ -59,8 +57,7 @@ > var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); > var mask0 = new {{alias:@stdlib/array/uint8}}( [ 0, 0, 0, 0, 0, 0, 1 ] ); > var mask1 = new {{alias:@stdlib/array/uint8}}( mask0.buffer, mask0.BYTES_PER_ELEMENT*1 ); - > N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 ); - > {{alias}}( N, x1, 2, mask1, 2 ) + >{{alias}}( 3, x1, 2, mask1, 2 ) -2.0 {{alias}}.ndarray( N, x, strideX, offsetX, mask, strideMask, offsetMask ) @@ -80,7 +77,7 @@ Input array. strideX: integer - Index increment for `x`. + Stride length for `x`. offsetX: integer Starting index for `x`. @@ -89,7 +86,7 @@ Mask array. strideMask: integer - Index increment for `mask`. + Stride length for `mask`. offsetMask: integer Starting index for `mask`. @@ -110,8 +107,7 @@ // Using offset parameter: > x = [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, -4.0 ]; > mask = [ 0, 0, 0, 0, 0, 0, 1 ]; - > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 ); - > {{alias}}.ndarray( N, x, 2, 1, mask, 2, 1 ) + > {{alias}}.ndarray( 3, x, 2, 1, mask, 2, 1 ) -2.0 See Also diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmin/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/nanmskmin/docs/types/index.d.ts index 1440b3275d73..cc3b4e752040 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmin/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/nanmskmin/docs/types/index.d.ts @@ -1,99 +1,121 @@ /* -* @license Apache-2.0 -* -* Copyright (c) 2020 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. -*/ + * @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 { NumericArray } from '@stdlib/types/array'; +import { + NumericArray, + Collection, + AccessorArrayLike, +} from "@stdlib/types/array"; /** -* Interface describing `nanmskmin`. -*/ + * Input array. + */ +type InputArray = NumericArray | Collection | AccessorArrayLike; + +/** + * Interface describing `nanmskmin`. + */ interface Routine { /** - * Computes the minimum value of a strided array according to a mask, ignoring `NaN` values. - * - * @param N - number of indexed elements - * @param x - input array - * @param strideX - `x` stride length - * @param mask - mask array - * @param strideMask - `mask` stride length - * @returns minimum value - * - * @example - * var x = [ 1.0, -2.0, -4.0, 2.0, NaN ]; - * var mask = [ 0, 0, 1, 0, 0 ]; - * - * var v = nanmskmin( x.length, x, 1, mask, 1 ); - * // returns -2.0 - */ - ( N: number, x: NumericArray, strideX: number, mask: NumericArray, strideMask: number ): number; + * Computes the minimum value of a strided array according to a mask, ignoring `NaN` values. + * + * @param N - number of indexed elements + * @param x - input array + * @param strideX - stride length for `x` + * @param mask - mask array + * @param strideMask - stride length for `mask` + * @returns minimum value + * + * @example + * var x = [ 1.0, -2.0, -4.0, 2.0, NaN ]; + * var mask = [ 0, 0, 1, 0, 0 ]; + * + * var v = nanmskmin( x.length, x, 1, mask, 1 ); + * // returns -2.0 + */ + ( + N: number, + x: InputArray, + strideX: number, + mask: InputArray, + strideMask: number, + ): number; /** - * Computes the minimum value of a strided array according to a mask, ignoring `NaN` values and using alternative indexing semantics. - * - * @param N - number of indexed elements - * @param x - input array - * @param strideX - `x` stride length - * @param offsetX - `x` starting index - * @param mask - mask array - * @param strideMask - `mask` stride length - * @param offsetMask - `mask` starting index - * @returns minimum value - * - * @example - * var x = [ 1.0, -2.0, -4.0, 2.0, NaN ]; - * var mask = [ 0, 0, 1, 0, 0 ]; - * - * var v = nanmskmin.ndarray( x.length, x, 1, 0, mask, 1, 0 ); - * // returns -2.0 - */ - ndarray( N: number, x: NumericArray, strideX: number, offsetX: number, mask: NumericArray, strideMask: number, offsetMask: number ): number; + * Computes the minimum value of a strided array according to a mask, ignoring `NaN` values and using alternative indexing semantics. + * + * @param N - number of indexed elements + * @param x - input array + * @param strideX - stride length for `x` + * @param offsetX - `x` starting index + * @param mask - mask array + * @param strideMask - stride length for `mask` + * @param offsetMask - `mask` starting index + * @returns minimum value + * + * @example + * var x = [ 1.0, -2.0, -4.0, 2.0, NaN ]; + * var mask = [ 0, 0, 1, 0, 0 ]; + * + * var v = nanmskmin.ndarray( x.length, x, 1, 0, mask, 1, 0 ); + * // returns -2.0 + */ + ndarray( + N: number, + x: InputArray, + strideX: number, + offsetX: number, + mask: InputArray, + strideMask: number, + offsetMask: number, + ): number; } /** -* Computes the minimum value of a strided array according to a mask, ignoring `NaN` values. -* -* @param N - number of indexed elements -* @param x - input array -* @param strideX - `x` stride length -* @param mask - mask array -* @param strideMask - `mask` stride length -* @returns minimum value -* -* @example -* var x = [ 1.0, -2.0, -4.0, 2.0, NaN ]; -* var mask = [ 0, 0, 1, 0, 0 ]; -* -* var v = nanmskmin( x.length, x, 1, mask, 1 ); -* // returns -2.0 -* -* @example -* var x = [ 1.0, -2.0, -4.0, 2.0, NaN ]; -* var mask = [ 0, 0, 1, 0, 0 ]; -* -* var v = nanmskmin.ndarray( x.length, x, 1, 0, mask, 1, 0 ); -* // returns -2.0 -*/ + * Computes the minimum value of a strided array according to a mask, ignoring `NaN` values. + * + * @param N - number of indexed elements + * @param x - input array + * @param strideX - stride length for `x` + * @param mask - mask array + * @param strideMask - stride length for `mask` + * @returns minimum value + * + * @example + * var x = [ 1.0, -2.0, -4.0, 2.0, NaN ]; + * var mask = [ 0, 0, 1, 0, 0 ]; + * + * var v = nanmskmin( x.length, x, 1, mask, 1 ); + * // returns -2.0 + * + * @example + * var x = [ 1.0, -2.0, -4.0, 2.0, NaN ]; + * var mask = [ 0, 0, 1, 0, 0 ]; + * + * var v = nanmskmin.ndarray( x.length, x, 1, 0, mask, 1, 0 ); + * // returns -2.0 + */ declare var nanmskmin: Routine; - // EXPORTS // export = nanmskmin; diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmin/docs/types/test.ts b/lib/node_modules/@stdlib/stats/base/nanmskmin/docs/types/test.ts index 84a9f398704b..f9fa9d864385 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmin/docs/types/test.ts +++ b/lib/node_modules/@stdlib/stats/base/nanmskmin/docs/types/test.ts @@ -1,247 +1,257 @@ /* -* @license Apache-2.0 -* -* Copyright (c) 2020 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. -*/ - -import nanmskmin = require( './index' ); - + * @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. + */ + +import nanmskmin = require("./index"); +import AccessorArray = require("@stdlib/array/base/accessor"); // TESTS // // The function returns a number... { - const x = new Float64Array( 10 ); - const mask = new Uint8Array( 10 ); + const x = new Float64Array(10); + const mask = new Uint8Array(10); - nanmskmin( x.length, x, 1, mask, 1 ); // $ExpectType number + nanmskmin(x.length, x, 1, mask, 1); // $ExpectType number + nanmskmin(x.length, new AccessorArray(x), 1, mask, 1); } // The compiler throws an error if the function is provided a first argument which is not a number... { - const x = new Float64Array( 10 ); - const mask = new Uint8Array( 10 ); - - nanmskmin( '10', x, 1, mask, 1 ); // $ExpectError - nanmskmin( true, x, 1, mask, 1 ); // $ExpectError - nanmskmin( false, x, 1, mask, 1 ); // $ExpectError - nanmskmin( null, x, 1, mask, 1 ); // $ExpectError - nanmskmin( undefined, x, 1, mask, 1 ); // $ExpectError - nanmskmin( [], x, 1, mask, 1 ); // $ExpectError - nanmskmin( {}, x, 1, mask, 1 ); // $ExpectError - nanmskmin( ( x: number ): number => x, x, 1, mask, 1 ); // $ExpectError + const x = new Float64Array(10); + const mask = new Uint8Array(10); + + nanmskmin("10", x, 1, mask, 1); // $ExpectError + nanmskmin(true, x, 1, mask, 1); // $ExpectError + nanmskmin(false, x, 1, mask, 1); // $ExpectError + nanmskmin(null, x, 1, mask, 1); // $ExpectError + nanmskmin(undefined, x, 1, mask, 1); // $ExpectError + nanmskmin([], x, 1, mask, 1); // $ExpectError + nanmskmin({}, x, 1, mask, 1); // $ExpectError + nanmskmin((x: number): number => x, x, 1, mask, 1); // $ExpectError } // The compiler throws an error if the function is provided a second argument which is not a numeric array... { - const x = new Float64Array( 10 ); - const mask = new Uint8Array( 10 ); - - nanmskmin( x.length, 10, 1, mask, 1 ); // $ExpectError - nanmskmin( x.length, '10', 1, mask, 1 ); // $ExpectError - nanmskmin( x.length, true, 1, mask, 1 ); // $ExpectError - nanmskmin( x.length, false, 1, mask, 1 ); // $ExpectError - nanmskmin( x.length, null, 1, mask, 1 ); // $ExpectError - nanmskmin( x.length, undefined, 1, mask, 1 ); // $ExpectError - nanmskmin( x.length, [ '1' ], 1, mask, 1 ); // $ExpectError - nanmskmin( x.length, {}, 1, mask, 1 ); // $ExpectError - nanmskmin( x.length, ( x: number ): number => x, 1, mask, 1 ); // $ExpectError + const x = new Float64Array(10); + const mask = new Uint8Array(10); + + nanmskmin(x.length, 10, 1, mask, 1); // $ExpectError + nanmskmin(x.length, "10", 1, mask, 1); // $ExpectError + nanmskmin(x.length, true, 1, mask, 1); // $ExpectError + nanmskmin(x.length, false, 1, mask, 1); // $ExpectError + nanmskmin(x.length, null, 1, mask, 1); // $ExpectError + nanmskmin(x.length, undefined, 1, mask, 1); // $ExpectError + nanmskmin(x.length, ["1"], 1, mask, 1); // $ExpectError + nanmskmin(x.length, {}, 1, mask, 1); // $ExpectError + nanmskmin(x.length, (x: number): number => x, 1, mask, 1); // $ExpectError } // The compiler throws an error if the function is provided a third argument which is not a number... { - const x = new Float64Array( 10 ); - const mask = new Uint8Array( 10 ); - - nanmskmin( x.length, x, '10', mask, 1 ); // $ExpectError - nanmskmin( x.length, x, true, mask, 1 ); // $ExpectError - nanmskmin( x.length, x, false, mask, 1 ); // $ExpectError - nanmskmin( x.length, x, null, mask, 1 ); // $ExpectError - nanmskmin( x.length, x, undefined, mask, 1 ); // $ExpectError - nanmskmin( x.length, x, [], mask, 1 ); // $ExpectError - nanmskmin( x.length, x, {}, mask, 1 ); // $ExpectError - nanmskmin( x.length, x, ( x: number ): number => x, mask, 1 ); // $ExpectError + const x = new Float64Array(10); + const mask = new Uint8Array(10); + + nanmskmin(x.length, x, "10", mask, 1); // $ExpectError + nanmskmin(x.length, x, true, mask, 1); // $ExpectError + nanmskmin(x.length, x, false, mask, 1); // $ExpectError + nanmskmin(x.length, x, null, mask, 1); // $ExpectError + nanmskmin(x.length, x, undefined, mask, 1); // $ExpectError + nanmskmin(x.length, x, [], mask, 1); // $ExpectError + nanmskmin(x.length, x, {}, mask, 1); // $ExpectError + nanmskmin(x.length, x, (x: number): number => x, mask, 1); // $ExpectError } // The compiler throws an error if the function is provided a fourth argument which is not a numeric array... { - const x = new Float64Array( 10 ); - - nanmskmin( x.length, x, 1, 10, 1 ); // $ExpectError - nanmskmin( x.length, x, 1, '10', 1 ); // $ExpectError - nanmskmin( x.length, x, 1, true, 1 ); // $ExpectError - nanmskmin( x.length, x, 1, false, 1 ); // $ExpectError - nanmskmin( x.length, x, 1, null, 1 ); // $ExpectError - nanmskmin( x.length, x, 1, undefined, 1 ); // $ExpectError - nanmskmin( x.length, x, 1, [ '1' ], 1 ); // $ExpectError - nanmskmin( x.length, x, 1, {}, 1 ); // $ExpectError - nanmskmin( x.length, x, 1, ( x: number ): number => x, 1 ); // $ExpectError + const x = new Float64Array(10); + + nanmskmin(x.length, x, 1, 10, 1); // $ExpectError + nanmskmin(x.length, x, 1, "10", 1); // $ExpectError + nanmskmin(x.length, x, 1, true, 1); // $ExpectError + nanmskmin(x.length, x, 1, false, 1); // $ExpectError + nanmskmin(x.length, x, 1, null, 1); // $ExpectError + nanmskmin(x.length, x, 1, undefined, 1); // $ExpectError + nanmskmin(x.length, x, 1, ["1"], 1); // $ExpectError + nanmskmin(x.length, x, 1, {}, 1); // $ExpectError + nanmskmin(x.length, x, 1, (x: number): number => x, 1); // $ExpectError } // The compiler throws an error if the function is provided a fifth argument which is not a number... { - const x = new Float64Array( 10 ); - const mask = new Uint8Array( 10 ); - - nanmskmin( x.length, x, 1, mask, '10' ); // $ExpectError - nanmskmin( x.length, x, 1, mask, true ); // $ExpectError - nanmskmin( x.length, x, 1, mask, false ); // $ExpectError - nanmskmin( x.length, x, 1, mask, null ); // $ExpectError - nanmskmin( x.length, x, 1, mask, undefined ); // $ExpectError - nanmskmin( x.length, x, 1, mask, [] ); // $ExpectError - nanmskmin( x.length, x, 1, mask, {} ); // $ExpectError - nanmskmin( x.length, x, 1, mask, ( x: number ): number => x ); // $ExpectError + const x = new Float64Array(10); + const mask = new Uint8Array(10); + + nanmskmin(x.length, x, 1, mask, "10"); // $ExpectError + nanmskmin(x.length, x, 1, mask, true); // $ExpectError + nanmskmin(x.length, x, 1, mask, false); // $ExpectError + nanmskmin(x.length, x, 1, mask, null); // $ExpectError + nanmskmin(x.length, x, 1, mask, undefined); // $ExpectError + nanmskmin(x.length, x, 1, mask, []); // $ExpectError + nanmskmin(x.length, x, 1, mask, {}); // $ExpectError + nanmskmin(x.length, x, 1, mask, (x: number): number => x); // $ExpectError } // The compiler throws an error if the function is provided an unsupported number of arguments... { - const x = new Float64Array( 10 ); - const mask = new Uint8Array( 10 ); + const x = new Float64Array(10); + const mask = new Uint8Array(10); nanmskmin(); // $ExpectError - nanmskmin( x.length ); // $ExpectError - nanmskmin( x.length, x, 1 ); // $ExpectError - nanmskmin( x.length, x, 1, mask ); // $ExpectError - nanmskmin( x.length, x, 1, mask, 1, 10 ); // $ExpectError + nanmskmin(x.length); // $ExpectError + nanmskmin(x.length, x, 1); // $ExpectError + nanmskmin(x.length, x, 1, mask); // $ExpectError + nanmskmin(x.length, x, 1, mask, 1, 10); // $ExpectError } // Attached to main export is an `ndarray` method which returns a number... { - const x = new Float64Array( 10 ); - const mask = new Uint8Array( 10 ); - - nanmskmin.ndarray( x.length, x, 1, 0, mask, 1, 0 ); // $ExpectType number + const x = new Float64Array(10); + const mask = new Uint8Array(10); + + nanmskmin.ndarray(x.length, x, 1, 0, mask, 1, 0); // $ExpectType number + nanmskmin.ndarray( + x.length, + new AccessorArray(x), + 1, + 0, + new AccessorArray(mask), + 1, + 0, + ); } // The compiler throws an error if the `ndarray` method is provided a first argument which is not a number... { - const x = new Float64Array( 10 ); - const mask = new Uint8Array( 10 ); - - nanmskmin.ndarray( '10', x, 1, 0, mask, 1, 0 ); // $ExpectError - nanmskmin.ndarray( true, x, 1, 0, mask, 1, 0 ); // $ExpectError - nanmskmin.ndarray( false, x, 1, 0, mask, 1, 0 ); // $ExpectError - nanmskmin.ndarray( null, x, 1, 0, mask, 1, 0 ); // $ExpectError - nanmskmin.ndarray( undefined, x, 1, 0, mask, 1, 0 ); // $ExpectError - nanmskmin.ndarray( [], x, 1, 0, mask, 1, 0 ); // $ExpectError - nanmskmin.ndarray( {}, x, 1, 0, mask, 1, 0 ); // $ExpectError - nanmskmin.ndarray( ( x: number ): number => x, x, 1, 0, mask, 1, 0 ); // $ExpectError + const x = new Float64Array(10); + const mask = new Uint8Array(10); + + nanmskmin.ndarray("10", x, 1, 0, mask, 1, 0); // $ExpectError + nanmskmin.ndarray(true, x, 1, 0, mask, 1, 0); // $ExpectError + nanmskmin.ndarray(false, x, 1, 0, mask, 1, 0); // $ExpectError + nanmskmin.ndarray(null, x, 1, 0, mask, 1, 0); // $ExpectError + nanmskmin.ndarray(undefined, x, 1, 0, mask, 1, 0); // $ExpectError + nanmskmin.ndarray([], x, 1, 0, mask, 1, 0); // $ExpectError + nanmskmin.ndarray({}, x, 1, 0, mask, 1, 0); // $ExpectError + nanmskmin.ndarray((x: number): number => x, x, 1, 0, mask, 1, 0); // $ExpectError } // The compiler throws an error if the `ndarray` method is provided a second argument which is not a numeric array... { - const x = new Float64Array( 10 ); - const mask = new Uint8Array( 10 ); - - nanmskmin.ndarray( x.length, 10, 1, 0, mask, 1, 0 ); // $ExpectError - nanmskmin.ndarray( x.length, '10', 1, 0, mask, 1, 0 ); // $ExpectError - nanmskmin.ndarray( x.length, true, 1, 0, mask, 1, 0 ); // $ExpectError - nanmskmin.ndarray( x.length, false, 1, 0, mask, 1, 0 ); // $ExpectError - nanmskmin.ndarray( x.length, null, 1, 0, mask, 1, 0 ); // $ExpectError - nanmskmin.ndarray( x.length, undefined, 1, 0, mask, 1, 0 ); // $ExpectError - nanmskmin.ndarray( x.length, [ '1' ], 1, 0, mask, 1, 0 ); // $ExpectError - nanmskmin.ndarray( x.length, {}, 1, 0, mask, 1, 0 ); // $ExpectError - nanmskmin.ndarray( x.length, ( x: number ): number => x, 1, 0, mask, 1, 0 ); // $ExpectError + const x = new Float64Array(10); + const mask = new Uint8Array(10); + + nanmskmin.ndarray(x.length, 10, 1, 0, mask, 1, 0); // $ExpectError + nanmskmin.ndarray(x.length, "10", 1, 0, mask, 1, 0); // $ExpectError + nanmskmin.ndarray(x.length, true, 1, 0, mask, 1, 0); // $ExpectError + nanmskmin.ndarray(x.length, false, 1, 0, mask, 1, 0); // $ExpectError + nanmskmin.ndarray(x.length, null, 1, 0, mask, 1, 0); // $ExpectError + nanmskmin.ndarray(x.length, undefined, 1, 0, mask, 1, 0); // $ExpectError + nanmskmin.ndarray(x.length, ["1"], 1, 0, mask, 1, 0); // $ExpectError + nanmskmin.ndarray(x.length, {}, 1, 0, mask, 1, 0); // $ExpectError + nanmskmin.ndarray(x.length, (x: number): number => x, 1, 0, mask, 1, 0); // $ExpectError } // The compiler throws an error if the `ndarray` method is provided a third argument which is not a number... { - const x = new Float64Array( 10 ); - const mask = new Uint8Array( 10 ); - - nanmskmin.ndarray( x.length, x, '10', 0, mask, 1, 0 ); // $ExpectError - nanmskmin.ndarray( x.length, x, true, 0, mask, 1, 0 ); // $ExpectError - nanmskmin.ndarray( x.length, x, false, 0, mask, 1, 0 ); // $ExpectError - nanmskmin.ndarray( x.length, x, null, 0, mask, 1, 0 ); // $ExpectError - nanmskmin.ndarray( x.length, x, undefined, 0, mask, 1, 0 ); // $ExpectError - nanmskmin.ndarray( x.length, x, [], 0, mask, 1, 0 ); // $ExpectError - nanmskmin.ndarray( x.length, x, {}, 0, mask, 1, 0 ); // $ExpectError - nanmskmin.ndarray( x.length, x, ( x: number ): number => x, 0, mask, 1, 0 ); // $ExpectError + const x = new Float64Array(10); + const mask = new Uint8Array(10); + + nanmskmin.ndarray(x.length, x, "10", 0, mask, 1, 0); // $ExpectError + nanmskmin.ndarray(x.length, x, true, 0, mask, 1, 0); // $ExpectError + nanmskmin.ndarray(x.length, x, false, 0, mask, 1, 0); // $ExpectError + nanmskmin.ndarray(x.length, x, null, 0, mask, 1, 0); // $ExpectError + nanmskmin.ndarray(x.length, x, undefined, 0, mask, 1, 0); // $ExpectError + nanmskmin.ndarray(x.length, x, [], 0, mask, 1, 0); // $ExpectError + nanmskmin.ndarray(x.length, x, {}, 0, mask, 1, 0); // $ExpectError + nanmskmin.ndarray(x.length, x, (x: number): number => x, 0, mask, 1, 0); // $ExpectError } // The compiler throws an error if the `ndarray` method is provided a fourth argument which is not a number... { - const x = new Float64Array( 10 ); - const mask = new Uint8Array( 10 ); - - nanmskmin.ndarray( x.length, x, 1, '10', mask, 1, 0 ); // $ExpectError - nanmskmin.ndarray( x.length, x, 1, true, mask, 1, 0 ); // $ExpectError - nanmskmin.ndarray( x.length, x, 1, false, mask, 1, 0 ); // $ExpectError - nanmskmin.ndarray( x.length, x, 1, null, mask, 1, 0 ); // $ExpectError - nanmskmin.ndarray( x.length, x, 1, undefined, mask, 1, 0 ); // $ExpectError - nanmskmin.ndarray( x.length, x, 1, [], mask, 1, 0 ); // $ExpectError - nanmskmin.ndarray( x.length, x, 1, {}, mask, 1, 0 ); // $ExpectError - nanmskmin.ndarray( x.length, x, 1, ( x: number ): number => x, mask, 1, 0 ); // $ExpectError + const x = new Float64Array(10); + const mask = new Uint8Array(10); + + nanmskmin.ndarray(x.length, x, 1, "10", mask, 1, 0); // $ExpectError + nanmskmin.ndarray(x.length, x, 1, true, mask, 1, 0); // $ExpectError + nanmskmin.ndarray(x.length, x, 1, false, mask, 1, 0); // $ExpectError + nanmskmin.ndarray(x.length, x, 1, null, mask, 1, 0); // $ExpectError + nanmskmin.ndarray(x.length, x, 1, undefined, mask, 1, 0); // $ExpectError + nanmskmin.ndarray(x.length, x, 1, [], mask, 1, 0); // $ExpectError + nanmskmin.ndarray(x.length, x, 1, {}, mask, 1, 0); // $ExpectError + nanmskmin.ndarray(x.length, x, 1, (x: number): number => x, mask, 1, 0); // $ExpectError } // The compiler throws an error if the `ndarray` method is provided a fifth argument which is not a numeric array... { - const x = new Float64Array( 10 ); - - nanmskmin.ndarray( x.length, 1, 0, 10, 1, 0 ); // $ExpectError - nanmskmin.ndarray( x.length, 1, 0, '10', 1, 0 ); // $ExpectError - nanmskmin.ndarray( x.length, 1, 0, true, 1, 0 ); // $ExpectError - nanmskmin.ndarray( x.length, 1, 0, false, 1, 0 ); // $ExpectError - nanmskmin.ndarray( x.length, 1, 0, null, 1, 0 ); // $ExpectError - nanmskmin.ndarray( x.length, 1, 0, undefined, 1, 0 ); // $ExpectError - nanmskmin.ndarray( x.length, 1, 0, [ '1' ], 1, 0 ); // $ExpectError - nanmskmin.ndarray( x.length, 1, 0, {}, 1, 0 ); // $ExpectError - nanmskmin.ndarray( x.length, 1, 0, ( x: number ): number => x, 1, 0 ); // $ExpectError + const x = new Float64Array(10); + + nanmskmin.ndarray(x.length, 1, 0, 10, 1, 0); // $ExpectError + nanmskmin.ndarray(x.length, 1, 0, "10", 1, 0); // $ExpectError + nanmskmin.ndarray(x.length, 1, 0, true, 1, 0); // $ExpectError + nanmskmin.ndarray(x.length, 1, 0, false, 1, 0); // $ExpectError + nanmskmin.ndarray(x.length, 1, 0, null, 1, 0); // $ExpectError + nanmskmin.ndarray(x.length, 1, 0, undefined, 1, 0); // $ExpectError + nanmskmin.ndarray(x.length, 1, 0, ["1"], 1, 0); // $ExpectError + nanmskmin.ndarray(x.length, 1, 0, {}, 1, 0); // $ExpectError + nanmskmin.ndarray(x.length, 1, 0, (x: number): number => x, 1, 0); // $ExpectError } // The compiler throws an error if the `ndarray` method is provided a sixth argument which is not a number... { - const x = new Float64Array( 10 ); - const mask = new Uint8Array( 10 ); - - nanmskmin.ndarray( x.length, x, 1, 0, mask, '10', 0 ); // $ExpectError - nanmskmin.ndarray( x.length, x, 1, 0, mask, true, 0 ); // $ExpectError - nanmskmin.ndarray( x.length, x, 1, 0, mask, false, 0 ); // $ExpectError - nanmskmin.ndarray( x.length, x, 1, 0, mask, null, 0 ); // $ExpectError - nanmskmin.ndarray( x.length, x, 1, 0, mask, undefined, 0 ); // $ExpectError - nanmskmin.ndarray( x.length, x, 1, 0, mask, [], 0 ); // $ExpectError - nanmskmin.ndarray( x.length, x, 1, 0, mask, {}, 0 ); // $ExpectError - nanmskmin.ndarray( x.length, x, 1, 0, mask, ( x: number ): number => x, 0 ); // $ExpectError + const x = new Float64Array(10); + const mask = new Uint8Array(10); + + nanmskmin.ndarray(x.length, x, 1, 0, mask, "10", 0); // $ExpectError + nanmskmin.ndarray(x.length, x, 1, 0, mask, true, 0); // $ExpectError + nanmskmin.ndarray(x.length, x, 1, 0, mask, false, 0); // $ExpectError + nanmskmin.ndarray(x.length, x, 1, 0, mask, null, 0); // $ExpectError + nanmskmin.ndarray(x.length, x, 1, 0, mask, undefined, 0); // $ExpectError + nanmskmin.ndarray(x.length, x, 1, 0, mask, [], 0); // $ExpectError + nanmskmin.ndarray(x.length, x, 1, 0, mask, {}, 0); // $ExpectError + nanmskmin.ndarray(x.length, x, 1, 0, mask, (x: number): number => x, 0); // $ExpectError } // The compiler throws an error if the `ndarray` method is provided a seventh argument which is not a number... { - const x = new Float64Array( 10 ); - const mask = new Uint8Array( 10 ); - - nanmskmin.ndarray( x.length, x, 1, 0, mask, 1, '10' ); // $ExpectError - nanmskmin.ndarray( x.length, x, 1, 0, mask, 1, true ); // $ExpectError - nanmskmin.ndarray( x.length, x, 1, 0, mask, 1, false ); // $ExpectError - nanmskmin.ndarray( x.length, x, 1, 0, mask, 1, null ); // $ExpectError - nanmskmin.ndarray( x.length, x, 1, 0, mask, 1, undefined ); // $ExpectError - nanmskmin.ndarray( x.length, x, 1, 0, mask, 1, [] ); // $ExpectError - nanmskmin.ndarray( x.length, x, 1, 0, mask, 1, {} ); // $ExpectError - nanmskmin.ndarray( x.length, x, 1, 0, mask, 1, ( x: number ): number => x ); // $ExpectError + const x = new Float64Array(10); + const mask = new Uint8Array(10); + + nanmskmin.ndarray(x.length, x, 1, 0, mask, 1, "10"); // $ExpectError + nanmskmin.ndarray(x.length, x, 1, 0, mask, 1, true); // $ExpectError + nanmskmin.ndarray(x.length, x, 1, 0, mask, 1, false); // $ExpectError + nanmskmin.ndarray(x.length, x, 1, 0, mask, 1, null); // $ExpectError + nanmskmin.ndarray(x.length, x, 1, 0, mask, 1, undefined); // $ExpectError + nanmskmin.ndarray(x.length, x, 1, 0, mask, 1, []); // $ExpectError + nanmskmin.ndarray(x.length, x, 1, 0, mask, 1, {}); // $ExpectError + nanmskmin.ndarray(x.length, x, 1, 0, mask, 1, (x: number): number => x); // $ExpectError } // The compiler throws an error if the `ndarray` method is provided an unsupported number of arguments... { - const x = new Float64Array( 10 ); - const mask = new Uint8Array( 10 ); + const x = new Float64Array(10); + const mask = new Uint8Array(10); nanmskmin.ndarray(); // $ExpectError - nanmskmin.ndarray( x.length ); // $ExpectError - nanmskmin.ndarray( x.length, x ); // $ExpectError - nanmskmin.ndarray( x.length, x, 1 ); // $ExpectError - nanmskmin.ndarray( x.length, x, 1, 0 ); // $ExpectError - nanmskmin.ndarray( x.length, x, 1, 0, mask ); // $ExpectError - nanmskmin.ndarray( x.length, x, 1, 0, mask, 1 ); // $ExpectError - nanmskmin.ndarray( x.length, x, 1, 0, mask, 1, 0, 10 ); // $ExpectError + nanmskmin.ndarray(x.length); // $ExpectError + nanmskmin.ndarray(x.length, x); // $ExpectError + nanmskmin.ndarray(x.length, x, 1); // $ExpectError + nanmskmin.ndarray(x.length, x, 1, 0); // $ExpectError + nanmskmin.ndarray(x.length, x, 1, 0, mask); // $ExpectError + nanmskmin.ndarray(x.length, x, 1, 0, mask, 1); // $ExpectError + nanmskmin.ndarray(x.length, x, 1, 0, mask, 1, 0, 10); // $ExpectError } diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmin/examples/index.js b/lib/node_modules/@stdlib/stats/base/nanmskmin/examples/index.js index fc061ffb0006..4e37037e94f3 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmin/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/nanmskmin/examples/index.js @@ -1,49 +1,37 @@ /** -* @license Apache-2.0 -* -* Copyright (c) 2020 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. -*/ + * @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'; +"use strict"; -var randu = require( '@stdlib/random/base/randu' ); -var round = require( '@stdlib/math/base/special/round' ); -var Float64Array = require( '@stdlib/array/float64' ); -var Uint8Array = require( '@stdlib/array/uint8' ); -var nanmskmin = require( './../lib' ); +var uniform = require("@stdlib/random/array/uniform"); +var bernoulli = require("@stdlib/random/array/bernoulli"); +var nanmskmin = require("./../lib"); -var mask; -var x; -var i; +var x = uniform(10, -50.0, 50.0, { + dtype: "float64", +}); -x = new Float64Array( 10 ); -mask = new Uint8Array( x.length ); -for ( i = 0; i < x.length; i++ ) { - if ( randu() < 0.2 ) { - mask[ i ] = 1; - } else { - mask[ i ] = 0; - } - if ( randu() < 0.1 ) { - x[ i ] = NaN; - } else { - x[ i ] = round( (randu()*100.0) - 50.0 ); - } -} -console.log( x ); -console.log( mask ); +console.log(x); -var v = nanmskmin( x.length, x, 1, mask, 1 ); -console.log( v ); +var mask = bernoulli(x.length, 0.2, { + dtype: "uint8", +}); +console.log(mask); + +var v = nanmskmin(x.length, x, 1, mask, 1); +console.log(v); diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmin/lib/accessors.js b/lib/node_modules/@stdlib/stats/base/nanmskmin/lib/accessors.js new file mode 100644 index 000000000000..70aebb20db6f --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/nanmskmin/lib/accessors.js @@ -0,0 +1,118 @@ +/** + * @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 isnan = require("@stdlib/math/base/assert/is-nan"); +var isNegativeZero = require("@stdlib/math/base/assert/is-negative-zero"); + +// MAIN // + +/** +* Computes the minimum value of a strided array according to a mask, ignoring `NaN` values. +* +* @private +* @param {PositiveInteger} N - number of indexed elements +* @param {Object} x - input array object +* @param {Collection} x.data - input array data +* @param {Array} x.accessors - array element accessors +* @param {integer} strideX - stride length for `x` +* @param {NonNegativeInteger} offsetX - starting index for `x` +* @param {Object} mask - mask array object +* @param {Collection} mask.data - mask array data +* @param {Array} mask.accessors - mask element accessors +* @param {integer} strideMask - stride length for `mask` +* @param {NonNegativeInteger} offsetMask - starting index for `mask` +* @returns {Object} output minimum value +* +/* +*@example + +* var floor = require( '@stdlib/math/base/special/floor' ); +* +* var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, -5.0, -6.0 ]; +* var mask = [ 0, 0, 0, 0, 0, 0, 0, 0, 1, 1 ]; +* var N = floor( x.length / 2 ); +* +* var v = mskmax( 5, arraylike2object( toAccessorArray( x ) ), 2, 1, arraylike2object( toAccessorArray( mask ) ), 2, 1 ); +* // returns -2.0 +*/ +function nanmskmin(N, x, StrideX, offsetX, mask, StrideM, offsetMask) { + var xbuf; + var mbuf; + var xget; + var mget; + var min; + var ix; + var im; + var v; + var i; + + // Cache references to array data: + + xbuf = x.data; + mbuf = mask.data; + + // Cache references to element accessors: + + xget = x.accessors[0]; + mget = mask.accessors[0]; + + if (N <= 0) { + return NaN; + } + ix = offsetX; + im = offsetMask; + for (i = 0; i < N; i++) { + if (mget(mbuf, im) === 0) { + break; + } + ix += StrideX; + im += StrideM; + + if (i == N) { + return NaN; + } + min = xget(xbuf, ix); + if (isnan(min)) { + return min; + } + i + 1; + for (i; i < N; i++) { + ix += StrideX; + im += StrideM; + if (mget(mbuf, im)) { + continue; + } + v = xget(xbuf, ix); + if (isnan(v)) { + return v; + } + if (v < min || (v === min && isNegativeZero(v))) { + min = v; + } + } + return min; + } +} + +//Exports + +module.exports = nanmskmin; diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmin/lib/nanmskmin.js b/lib/node_modules/@stdlib/stats/base/nanmskmin/lib/nanmskmin.js index 90a96ac4bf43..575c2b7cce51 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmin/lib/nanmskmin.js +++ b/lib/node_modules/@stdlib/stats/base/nanmskmin/lib/nanmskmin.js @@ -1,99 +1,54 @@ /** -* @license Apache-2.0 -* -* Copyright (c) 2020 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'; + * @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 isnan = require( '@stdlib/math/base/assert/is-nan' ); -var isNegativeZero = require( '@stdlib/math/base/assert/is-negative-zero' ); - +var stride2offset = require("@stdlib/strided/base/stride2offset"); +var ndarray = require("./ndarray.js"); // MAIN // /** -* Computes the minimum value of a strided array according to a mask, ignoring `NaN` values. -* -* @param {PositiveInteger} N - number of indexed elements -* @param {NumericArray} x - input array -* @param {integer} strideX - `x` stride length -* @param {NumericArray} mask - mask array -* @param {integer} strideMask - `mask` stride length -* @returns {number} minimum value -* -* @example -* var x = [ 1.0, -2.0, -4.0, 2.0, NaN ]; -* var mask = [ 0, 0, 1, 0, 0 ]; -* -* var v = nanmskmin( x.length, x, 1, mask, 1 ); -* // returns -2.0 -*/ -function nanmskmin( N, x, strideX, mask, strideMask ) { - var min; - var ix; - var im; - var v; - var i; - - if ( N <= 0 ) { - return NaN; - } - if ( strideX < 0 ) { - ix = (1-N) * strideX; - } else { - ix = 0; - } - if ( strideMask < 0 ) { - im = (1-N) * strideMask; - } else { - im = 0; - } - for ( i = 0; i < N; i++ ) { - v = x[ ix ]; - if ( v === v && mask[ im ] === 0 ) { - break; - } - ix += strideX; - im += strideMask; - } - if ( i === N ) { - return NaN; - } - min = v; - i += 1; - for ( i; i < N; i++ ) { - ix += strideX; - im += strideMask; - if ( mask[ im ] ) { - continue; - } - v = x[ ix ]; - if ( isnan( v ) ) { - continue; - } - if ( v < min || ( v === min && isNegativeZero( v ) ) ) { - min = v; - } - } - return min; + * Computes the minimum value of a strided array according to a mask, ignoring `NaN` values. + * + * @param {PositiveInteger} N - number of indexed elements + * @param {NumericArray} x - input array + * @param {integer} strideX - `x` stride length + * @param {NumericArray} mask - mask array + * @param {integer} strideMask - `mask` stride length + * @returns {number} minimum value + * + * @example + * var x = [ 1.0, -2.0, -4.0, 2.0, NaN ]; + * var mask = [ 0, 0, 1, 0, 0 ]; + * + * var v = nanmskmin( x.length, x, 1, mask, 1 ); + * // returns -2.0 + */ +function nanmskmin(N, x, strideX, mask, strideMask) { + var p = stride2offset(N, strideX); + var q = stride2offset(N, strideMask); + + return ndarray(N, x, strideX, p, mask, strideMask, q); } - // EXPORTS // module.exports = nanmskmin; diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmin/lib/ndarray.js b/lib/node_modules/@stdlib/stats/base/nanmskmin/lib/ndarray.js index 921f9c7a0a9b..858a5144bb03 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmin/lib/ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/nanmskmin/lib/ndarray.js @@ -1,96 +1,133 @@ /** -* @license Apache-2.0 -* -* Copyright (c) 2020 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'; + * @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. + */ -// MODULES // +"use strict"; -var isnan = require( '@stdlib/math/base/assert/is-nan' ); -var isNegativeZero = require( '@stdlib/math/base/assert/is-negative-zero' ); +// MODULES // +var isnan = require("@stdlib/math/base/assert/is-nan"); +var isNegativeZero = require("@stdlib/math/base/assert/is-negative-zero"); +var arraylike2object = require("@stdlib/array/base/arraylike2object"); +var accessors = require("./accessors.js"); // MAIN // /** -* Computes the minimum value of a strided array according to a mask, ignoring `NaN` values. -* -* @param {PositiveInteger} N - number of indexed elements -* @param {NumericArray} x - input array -* @param {integer} strideX - `x` stride length -* @param {NonNegativeInteger} offsetX - `x` starting index -* @param {NumericArray} mask - mask array -* @param {integer} strideMask - `mask` stride length -* @param {NonNegativeInteger} offsetMask - `mask` starting index -* @returns {number} minimum value -* -* @example -* var floor = require( '@stdlib/math/base/special/floor' ); -* -* var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, -5.0, -6.0 ]; -* var mask = [ 0, 0, 0, 0, 0, 0, 0, 0, 1, 1 ]; -* var N = floor( x.length / 2 ); -* -* var v = nanmskmin( N, x, 2, 1, mask, 2, 1 ); -* // returns -2.0 -*/ -function nanmskmin( N, x, strideX, offsetX, mask, strideMask, offsetMask ) { + * Computes the minimum value of a strided array according to a mask, ignoring `NaN` values. + * + * @param {PositiveInteger} N - number of indexed elements + * @param {NumericArray} x - input array + * @param {integer} strideX - `x` stride length + * @param {NonNegativeInteger} offsetX - `x` starting index + * @param {NumericArray} mask - mask array + * @param {integer} strideMask - `mask` stride length + * @param {NonNegativeInteger} offsetMask - `mask` starting index + * @returns {number} minimum value + * + * @example + * var floor = require( '@stdlib/math/base/special/floor' ); + * + * var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, -5.0, -6.0 ]; + * var mask = [ 0, 0, 0, 0, 0, 0, 0, 0, 1, 1 ]; + * var N = floor( x.length / 2 ); + * + * var v = nanmskmin( N, x, 2, 1, mask, 2, 1 ); + * // returns -2.0 + */ +function nanmskmin(N, x, strideX, offsetX, mask, strideMask, offsetMask) { var min; var ix; var im; + var ox; + var om; var v; var i; - if ( N <= 0 ) { + if (N <= 0) { return NaN; } + + ox = arraylike2object(x); + om = arraylike2object(mask); + + console.log("ox:", ox); + console.log("om:", om); + + if (ox.accessorProtocol || om.accessorProtocol) { + console.log( + "Using accessorProtocol:", + ox.accessorProtocol, + om.accessorProtocol, + ); + return accessors(N, ox, strideX, offsetX, om, strideMask, offsetMask); + } + ix = offsetX; im = offsetMask; - for ( i = 0; i < N; i++ ) { - v = x[ ix ]; - if ( v === v && mask[ im ] === 0 ) { + + console.log("mask:", mask); + console.log("strideX:", strideX, "strideMask:", strideMask); + + for (i = 0; i < N; i++) { + if (mask[im] === 0) { break; } ix += strideX; im += strideMask; } - if ( i === N ) { + + if (i === N) { + console.log("All elements are masked. Returning NaN."); return NaN; } - min = v; - i += 1; - for ( i; i < N; i++ ) { + + console.log("First unmasked element at index", ix, ":", x[ix]); + + min = x[ix]; + if (isnan(min)) { + console.log("First element is NaN. Returning NaN."); + return min; + } + + for (i += 1; i < N; i++) { ix += strideX; im += strideMask; - if ( mask[ im ] ) { + if (mask[im] !== 0) { continue; } - v = x[ ix ]; - if ( isnan( v ) ) { - continue; + v = x[ix]; + + console.log("Checking element at index", ix, ":", v); + + if (isnan(v)) { + console.log("Encountered NaN. Returning NaN."); + return v; } - if ( v < min || ( v === min && isNegativeZero( v ) ) ) { + if (v < min || (v === min && isNegativeZero(v))) { + console.log("New minimum found:", v); min = v; } } + + console.log("Final minimum:", min); return min; } - -// EXPORTS // +//exports module.exports = nanmskmin; diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmin/test/test.nanmskmin.js b/lib/node_modules/@stdlib/stats/base/nanmskmin/test/test.nanmskmin.js index 0f37f2d1036d..a3b85ea20798 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmin/test/test.nanmskmin.js +++ b/lib/node_modules/@stdlib/stats/base/nanmskmin/test/test.nanmskmin.js @@ -1,155 +1,271 @@ /** -* @license Apache-2.0 -* -* Copyright (c) 2020 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'; + * @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 floor = require( '@stdlib/math/base/special/floor' ); -var isnan = require( '@stdlib/math/base/assert/is-nan' ); -var isNegativeZero = require( '@stdlib/math/base/assert/is-negative-zero' ); -var Float64Array = require( '@stdlib/array/float64' ); -var Uint8Array = require( '@stdlib/array/uint8' ); -var nanmskmin = require( './../lib/nanmskmin.js' ); - +var tape = require("tape"); +var isnan = require("@stdlib/math/base/assert/is-nan"); +var toAccessorArray = require("@stdlib/array/base/to-accessor-array"); +var isNegativeZero = require("@stdlib/math/base/assert/is-negative-zero"); +var Float64Array = require("@stdlib/array/float64"); +var Uint8Array = require("@stdlib/array/uint8"); +var nanmskmin = require("./../lib/nanmskmin.js"); // TESTS // -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof nanmskmin, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function has an arity of 5', function test( t ) { - t.strictEqual( nanmskmin.length, 5, 'has expected arity' ); - t.end(); -}); - -tape( 'the function calculates the minimum value of a strided array according to a mask, ignoring NaN values', function test( t ) { - var mask; - var x; - var v; - - x = [ 1.0, -2.0, -4.0, NaN, 5.0, 0.0, 3.0 ]; - mask = [ 0, 0, 0, 1, 0, 0, 0 ]; - v = nanmskmin( x.length, x, 1, mask, 1 ); - t.strictEqual( v, -4.0, 'returns expected value' ); - - x = [ -4.0, NaN, -5.0 ]; - mask = [ 0, 1, 0 ]; - v = nanmskmin( x.length, x, 1, mask, 1 ); - t.strictEqual( v, -5.0, 'returns expected value' ); - - x = [ 0.0, -0.0, NaN, 0.0 ]; - mask = [ 0, 0, 1, 0 ]; - v = nanmskmin( x.length, x, 1, mask, 1 ); - t.strictEqual( isNegativeZero( v ), true, 'returns expected value' ); - - x = [ -4.0, 0.0, NaN, 5.0 ]; - mask = [ 0, 0, 0, 0 ]; - v = nanmskmin( x.length, x, 1, mask, 1 ); - t.strictEqual( v, -4.0, 'returns expected value' ); - - x = [ NaN ]; - mask = [ 0 ]; - v = nanmskmin( x.length, x, 1, mask, 1 ); - t.strictEqual( isnan( v ), true, 'returns expected value' ); - - x = [ NaN ]; - mask = [ 1 ]; - v = nanmskmin( x.length, x, 1, mask, 1 ); - t.strictEqual( isnan( v ), true, 'returns expected value' ); - - x = [ NaN, NaN ]; - mask = [ 1, 1 ]; - v = nanmskmin( x.length, x, 1, mask, 1 ); - t.strictEqual( isnan( v ), true, 'returns expected value' ); - - x = [ NaN, NaN ]; - mask = [ 1, 0 ]; - v = nanmskmin( x.length, x, 1, mask, 1 ); - t.strictEqual( isnan( v ), true, 'returns expected value' ); - - x = [ NaN, NaN ]; - mask = [ 0, 1 ]; - v = nanmskmin( x.length, x, 1, mask, 1 ); - t.strictEqual( isnan( v ), true, 'returns expected value' ); - - x = [ NaN, NaN ]; - mask = [ 0, 0 ]; - v = nanmskmin( x.length, x, 1, mask, 1 ); - t.strictEqual( isnan( v ), true, 'returns expected value' ); - +tape("main export is a function", function test(t) { + t.ok(true, __filename); + t.strictEqual(typeof nanmskmin, "function", "main export is a function"); t.end(); }); -tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `NaN`', function test( t ) { - var mask; - var x; - var v; - - x = [ 1.0, -2.0, -4.0, 5.0, 3.0 ]; - mask = [ 0.0, 0.0 ]; - - v = nanmskmin( 0, x, 1, mask, 1 ); - t.strictEqual( isnan( v ), true, 'returns expected value' ); - - v = nanmskmin( -1, x, 1, mask, 1 ); - t.strictEqual( isnan( v ), true, 'returns expected value' ); - +tape("the function has an arity of 5", function test(t) { + t.strictEqual(nanmskmin.length, 5, "has expected arity"); t.end(); }); -tape( 'if provided an `N` parameter equal to `1`, the function returns the first element', function test( t ) { +tape( + "the function calculates the minimum value of a strided array according to a mask, ignoring NaN values", + function test(t) { + var mask; + var x; + var v; + + x = [1.0, -2.0, -4.0, NaN, 5.0, 0.0, 3.0]; + mask = [0, 0, 0, 1, 0, 0, 0]; + v = nanmskmin(x.length, x, 1, mask, 1); + t.strictEqual(v, -4.0, "returns expected value"); + + x = [-4.0, NaN, -5.0]; + mask = [0, 1, 0]; + v = nanmskmin(x.length, x, 1, mask, 1); + t.strictEqual(v, -5.0, "returns expected value"); + + x = [0.0, -0.0, NaN, 0.0]; + mask = [0, 0, 1, 0]; + v = nanmskmin(x.length, x, 1, mask, 1); + t.strictEqual(isNegativeZero(v), true, "returns expected value"); + + x = [-4.0, 0.0, NaN, 5.0]; + mask = [0, 0, 2, 0]; + v = nanmskmin(x.length, x, 1, mask, 1); + t.strictEqual(v, -4.0, "returns expected value"); + + x = [NaN]; + mask = [0]; + v = nanmskmin(x.length, x, 1, mask, 1); + t.strictEqual(isnan(v), true, "returns expected value"); + + x = [NaN]; + mask = [1]; + v = nanmskmin(x.length, x, 1, mask, 1); + t.strictEqual(isnan(v), true, "returns expected value"); + + x = [NaN, NaN]; + mask = [1, 1]; + v = nanmskmin(x.length, x, 1, mask, 1); + t.strictEqual(isnan(v), true, "returns expected value"); + + x = [NaN, NaN]; + mask = [1, 0]; + v = nanmskmin(x.length, x, 1, mask, 1); + t.strictEqual(isnan(v), true, "returns expected value"); + + x = [NaN, NaN]; + mask = [0, 1]; + v = nanmskmin(x.length, x, 1, mask, 1); + t.strictEqual(isnan(v), true, "returns expected value"); + + x = [NaN, NaN]; + mask = [0, 0]; + v = nanmskmin(x.length, x, 1, mask, 1); + t.strictEqual(isnan(v), true, "returns expected value"); + + t.end(); + }, +); + +tape( + "the function calculates the minimum value of a strided array according to a mask (accessor)", + function test(t) { + var mask; + var x; + var v; + + // Test case 1: Mixed values with NaN and masking + x = [1.0, -2.0, -4.0, NaN, 5.0, 0.0, 3.0]; + mask = [0, 0, 0, 1, 0, 0, 0]; + v = nanmskmin(x.length, toAccessorArray(x), 1, toAccessorArray(mask), 1); + t.strictEqual(v, -4.0, "returns expected value"); + + // Test case 2: NaN is masked out + x = [-4.0, NaN, -5.0]; + mask = [0, 1, 0]; + v = nanmskmin(x.length, toAccessorArray(x), 1, toAccessorArray(mask), 1); + t.strictEqual(v, -5.0, "returns expected value"); + + // Test case 3: Handling -0.0 and 0.0 + x = [-0.0, 0.0, NaN, -0.0]; + mask = [0, 0, 1, 0]; + v = nanmskmin(x.length, toAccessorArray(x), 1, toAccessorArray(mask), 1); + t.strictEqual(isNegativeZero(v), true, "returns expected value"); + + // Test case 4: NaN is not masked out + x = [-4.0, 0.0, NaN, 5.0]; + mask = [0, 0, 0, 0]; + v = nanmskmin(x.length, toAccessorArray(x), 1, toAccessorArray(mask), 1); + t.strictEqual(isnan(v), true, "returns expected value"); + + // Test case 5: Single NaN element, not masked out + x = [NaN]; + mask = [0]; + v = nanmskmin(x.length, toAccessorArray(x), 1, toAccessorArray(mask), 1); + t.strictEqual(isnan(v), true, "returns expected value"); + + // Test case 6: Single NaN element, masked out + x = [NaN]; + mask = [1]; + v = nanmskmin(x.length, toAccessorArray(x), 1, toAccessorArray(mask), 1); + t.strictEqual(isnan(v), true, "returns expected value"); + + // Test case 7: All elements are NaN and masked out + x = [NaN, NaN]; + mask = [1, 1]; + v = nanmskmin(x.length, toAccessorArray(x), 1, toAccessorArray(mask), 1); + t.strictEqual(isnan(v), true, "returns expected value"); + + // Test case 8: First element is NaN and masked out, second is NaN and not masked out + x = [NaN, NaN]; + mask = [1, 0]; + v = nanmskmin(x.length, toAccessorArray(x), 1, toAccessorArray(mask), 1); + t.strictEqual(isnan(v), true, "returns expected value"); + + // Test case 9: First element is NaN and not masked out, second is NaN and masked out + x = [NaN, NaN]; + mask = [0, 1]; + v = nanmskmin(x.length, toAccessorArray(x), 1, toAccessorArray(mask), 1); + t.strictEqual(isnan(v), true, "returns expected value"); + + // Test case 10: All elements are NaN and not masked out + x = [NaN, NaN]; + mask = [0, 0]; + v = nanmskmin(x.length, toAccessorArray(x), 1, toAccessorArray(mask), 1); + t.strictEqual(isnan(v), true, "returns expected value"); + + t.end(); + }, +); + +tape( + "if provided an `N` parameter less than or equal to `0`, the function returns `NaN`", + function test(t) { + var mask; + var x; + var v; + + x = [1.0, -2.0, -4.0, 5.0, 3.0]; + mask = [0.0, 0.0]; + + v = nanmskmin(0, x, 1, mask, 1); + t.strictEqual(isnan(v), true, "returns expected value"); + + v = nanmskmin(-1, x, 1, mask, 1); + t.strictEqual(isnan(v), true, "returns expected value"); + + t.end(); + }, +); + +tape( + "if provided an `N` parameter equal to `1`, the function returns the first element", + function test(t) { + var mask; + var x; + var v; + + x = [1.0, -2.0, -4.0, 5.0, 3.0]; + mask = [0.0, 0.0]; + + v = nanmskmin(1, x, 1, mask, 1); + t.strictEqual(v, 1.0, "returns expected value"); + + t.end(); + }, +); + +tape("the function supports `stride` parameters", function test(t) { var mask; var x; var v; - x = [ 1.0, -2.0, -4.0, 5.0, 3.0 ]; - mask = [ 0.0, 0.0 ]; + x = [ + 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, + NaN, // 5 + NaN, + ]; + mask = [ + 0, // 0 + 0, + 0, // 1 + 0, + 0, // 2 + 0, + 0, // 3 + 0, + 1, // 4 + 1, + 1, // 5 + 0, + ]; - v = nanmskmin( 1, x, 1, mask, 1 ); - t.strictEqual( v, 1.0, 'returns expected value' ); + v = nanmskmin(x.length, x, 2, mask, 2); + t.strictEqual(v, -2.0, "returns expected value"); t.end(); }); -tape( 'the function supports `stride` parameters', function test( t ) { +tape("the function supports `stride` parameters (accessor)", function test(t) { var mask; - var N; var x; var v; x = [ - 1.0, // 0 + 1.0, // 0 2.0, - 2.0, // 1 + 2.0, // 1 -7.0, -2.0, // 2 3.0, - 4.0, // 3 + 4.0, // 3 2.0, - 5.0, // 4 + 5.0, // 4 6.0, - NaN, // 5 - NaN ]; mask = [ 0, // 0 @@ -162,39 +278,35 @@ tape( 'the function supports `stride` parameters', function test( t ) { 0, 1, // 4 1, - 0, // 5 - 0 ]; - N = floor( x.length / 2 ); - v = nanmskmin( N, x, 2, mask, 2 ); + v = nanmskmin(x.length, toAccessorArray(x), 2, toAccessorArray(mask), 2); - t.strictEqual( v, -2.0, 'returns expected value' ); + t.strictEqual(v, -2.0, "returns expected value"); t.end(); }); -tape( 'the function supports negative `stride` parameters', function test( t ) { +tape("the function supports negative `stride` parameters", function test(t) { var mask; - var N; var x; var v; x = [ - NaN, // 5 + NaN, // 5 NaN, - 5.0, // 4 + 5.0, // 4 6.0, - 1.0, // 3 + 1.0, // 3 2.0, - 2.0, // 2 + 2.0, // 2 -7.0, -2.0, // 1 3.0, - 4.0, // 0 - 2.0 + 4.0, // 0 + 2.0, ]; mask = [ - 0, // 5 + 1, // 5 0, 1, // 4 1, @@ -205,38 +317,120 @@ tape( 'the function supports negative `stride` parameters', function test( t ) { 0, // 1 0, 0, // 0 - 0 + 0, ]; - N = floor( x.length / 2 ); - v = nanmskmin( N, x, -2, mask, -2 ); + v = nanmskmin(x.length, x, -2, mask, -2); + + t.strictEqual(v, -2.0, "returns expected value"); + t.end(); +}); + +tape( + "the function supports negative `stride` parameters (accessor)", + function test(t) { + var mask; + var x; + var v; + + x = [ + 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 = [ + 1, // 4 + 1, + 0, // 3 + 0, + 0, // 2 + 0, + 0, // 1 + 0, + 0, // 0 + 0, + ]; + + v = nanmskmin(x.length, toAccessorArray(x), -2, toAccessorArray(mask), -2); + + t.strictEqual(v, -2.0, "returns expected value"); + t.end(); + }, +); + +tape("the function supports view offsets", function test(t) { + var mask0; + var mask1; + var x0; + var x; + var v; + + x0 = new Float64Array([ + 2.0, + 1.0, // 0 + 2.0, + -2.0, // 1 + -2.0, + 2.0, // 2 + 3.0, + 4.0, // 3 + 6.0, + 5.0, // 4 + 6.0, + NaN, // 5 + NaN, + ]); + mask0 = new Uint8Array([ + 0, + 0, // 0 + 0, + 0, // 1 + 0, + 0, // 2 + 0, + 0, // 3 + 0, + 1, // 4 + 1, + 1, // 5 + 0, + ]); + + x = new Float64Array(x0.buffer, x0.BYTES_PER_ELEMENT * 1); // start at 2nd element + mask1 = new Uint8Array(mask0.buffer, mask0.BYTES_PER_ELEMENT * 1); // start at 2nd element + + v = nanmskmin(x.length, x, 2, mask1, 2); + t.strictEqual(v, -2.0, "returns expected value"); - t.strictEqual( v, -2.0, 'returns expected value' ); t.end(); }); -tape( 'the function supports view offsets', function test( t ) { +tape("the function supports view offsets (accessor)", function test(t) { var mask0; var mask1; var x0; - var x1; - var N; + var x; var v; x0 = new Float64Array([ 2.0, - 1.0, // 0 + 1.0, // 0 2.0, -2.0, // 1 -2.0, - 2.0, // 2 + 2.0, // 2 3.0, - 4.0, // 3 + 4.0, // 3 6.0, - 5.0, // 4 + 5.0, // 4 6.0, - NaN, // 5 - NaN ]); mask0 = new Uint8Array([ 0, @@ -250,16 +444,13 @@ tape( 'the function supports view offsets', function test( t ) { 0, 1, // 4 1, - 0, // 5 - 0 ]); - x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element - mask1 = new Uint8Array( mask0.buffer, mask0.BYTES_PER_ELEMENT*1 ); // start at 2nd element - N = floor( x1.length/2 ); + x = new Float64Array(x0.buffer, x0.BYTES_PER_ELEMENT * 1); // start at 2nd element + mask1 = new Uint8Array(mask0.buffer, mask0.BYTES_PER_ELEMENT * 1); // start at 2nd element - v = nanmskmin( N, x1, 2, mask1, 2 ); - t.strictEqual( v, -2.0, 'returns expected value' ); + v = nanmskmin(5, toAccessorArray(x), 2, toAccessorArray(mask1), 2); + t.strictEqual(v, -2.0, "returns expected value"); t.end(); }); diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmin/test/test.ndarray.js b/lib/node_modules/@stdlib/stats/base/nanmskmin/test/test.ndarray.js index 35bed6764072..f1135fb870b5 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmin/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/nanmskmin/test/test.ndarray.js @@ -1,153 +1,311 @@ /** -* @license Apache-2.0 -* -* Copyright (c) 2020 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'; + * @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 floor = require( '@stdlib/math/base/special/floor' ); -var isnan = require( '@stdlib/math/base/assert/is-nan' ); -var isNegativeZero = require( '@stdlib/math/base/assert/is-negative-zero' ); -var nanmskmin = require( './../lib/ndarray.js' ); - +var tape = require("tape"); +var isnan = require("@stdlib/math/base/assert/is-nan"); +var toAccessorArray = require("@stdlib/array/base/to-accessor-array"); +var isNegativeZero = require("@stdlib/math/base/assert/is-negative-zero"); +var nanmskmin = require("./../lib/ndarray.js"); // TESTS // -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof nanmskmin, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function has an arity of 7', function test( t ) { - t.strictEqual( nanmskmin.length, 7, 'has expected arity' ); - t.end(); -}); - -tape( 'the function calculates the minimum value of a strided array according to a mask, ignoring NaN values', function test( t ) { - var mask; - var x; - var v; - - x = [ 1.0, -2.0, -4.0, NaN, 5.0, 0.0, 3.0 ]; - mask = [ 0, 0, 0, 1, 0, 0, 0 ]; - v = nanmskmin( x.length, x, 1, 0, mask, 1, 0 ); - t.strictEqual( v, -4.0, 'returns expected value' ); - - x = [ -4.0, NaN, -5.0 ]; - mask = [ 0, 1, 0 ]; - v = nanmskmin( x.length, x, 1, 0, mask, 1, 0 ); - t.strictEqual( v, -5.0, 'returns expected value' ); - - x = [ 0.0, -0.0, NaN, 0.0 ]; - mask = [ 0, 0, 1, 0 ]; - v = nanmskmin( x.length, x, 1, 0, mask, 1, 0 ); - t.strictEqual( isNegativeZero( v ), true, 'returns expected value' ); - - x = [ -4.0, 0.0, NaN, 5.0 ]; - mask = [ 0, 0, 0, 0 ]; - v = nanmskmin( x.length, x, 1, 0, mask, 1, 0 ); - t.strictEqual( v, -4.0, 'returns expected value' ); - - x = [ NaN ]; - mask = [ 0 ]; - v = nanmskmin( x.length, x, 1, 0, mask, 1, 0 ); - t.strictEqual( isnan( v ), true, 'returns expected value' ); - - x = [ NaN ]; - mask = [ 1 ]; - v = nanmskmin( x.length, x, 1, 0, mask, 1, 0 ); - t.strictEqual( isnan( v ), true, 'returns expected value' ); - - x = [ NaN, NaN ]; - mask = [ 1, 1 ]; - v = nanmskmin( x.length, x, 1, 0, mask, 1, 0 ); - t.strictEqual( isnan( v ), true, 'returns expected value' ); - - x = [ NaN, NaN ]; - mask = [ 1, 0 ]; - v = nanmskmin( x.length, x, 1, 0, mask, 1, 0 ); - t.strictEqual( isnan( v ), true, 'returns expected value' ); - - x = [ NaN, NaN ]; - mask = [ 0, 1 ]; - v = nanmskmin( x.length, x, 1, 0, mask, 1, 0 ); - t.strictEqual( isnan( v ), true, 'returns expected value' ); - - x = [ NaN, NaN ]; - mask = [ 0, 0 ]; - v = nanmskmin( x.length, x, 1, 0, mask, 1, 0 ); - t.strictEqual( isnan( v ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `NaN`', function test( t ) { - var mask; - var x; - var v; - - x = [ 1.0, -2.0, -4.0, 5.0, 3.0 ]; - mask = [ 0.0, 0.0 ]; - - v = nanmskmin( 0, x, 1, 0, mask, 1, 0 ); - t.strictEqual( isnan( v ), true, 'returns expected value' ); - - v = nanmskmin( -1, x, 1, 0, mask, 1 ); - t.strictEqual( isnan( v ), true, 'returns expected value' ); - +tape("main export is a function", function test(t) { + t.ok(true, __filename); + t.strictEqual(typeof nanmskmin, "function", "main export is a function"); t.end(); }); -tape( 'if provided an `N` parameter equal to `1`, the function returns the first element', function test( t ) { - var mask; - var x; - var v; - - x = [ 1.0, -2.0, -4.0, 5.0, 3.0 ]; - mask = [ 0.0, 0.0 ]; - - v = nanmskmin( 1, x, 1, 0, mask, 1, 0 ); - t.strictEqual( v, 1.0, 'returns expected value' ); - +tape("the function has an arity of 7", function test(t) { + t.strictEqual(nanmskmin.length, 7, "has expected arity"); t.end(); }); -tape( 'the function supports `stride` parameters', function test( t ) { +tape( + "the function calculates the minimum value of a strided array according to a mask, ignoring NaN values", + function test(t) { + var mask; + var x; + var v; + + x = [1.0, -2.0, -4.0, NaN, 5.0, 0.0, 3.0]; + mask = [0, 0, 0, 1, 0, 0, 0]; + v = nanmskmin(x.length, x, 1, 0, mask, 1, 0); + t.strictEqual(v, -4.0, "returns expected value"); + + x = [-4.0, NaN, -5.0]; + mask = [0, 1, 0]; + v = nanmskmin(x.length, x, 1, 0, mask, 1, 0); + t.strictEqual(v, -5.0, "returns expected value"); + + x = [0.0, -0.0, NaN, 0.0]; + mask = [0, 0, 1, 0]; + v = nanmskmin(x.length, x, 1, 0, mask, 1, 0); + t.strictEqual(isNegativeZero(v), true, "returns expected value"); + + x = [-4.0, 0.0, NaN, 5.0]; + mask = [0, 0, 2, 0]; + v = nanmskmin(x.length, x, 1, 0, mask, 1, 0); + t.strictEqual(v, -4.0, "returns expected value"); + + x = [NaN]; + mask = [0]; + v = nanmskmin(x.length, x, 1, 0, mask, 1, 0); + t.strictEqual(isnan(v), true, "returns expected value"); + + x = [NaN]; + mask = [1]; + v = nanmskmin(x.length, x, 1, 0, mask, 1, 0); + t.strictEqual(isnan(v), true, "returns expected value"); + + x = [NaN, NaN]; + mask = [1, 1]; + v = nanmskmin(x.length, x, 1, 0, mask, 1, 0); + t.strictEqual(isnan(v), true, "returns expected value"); + + x = [NaN, NaN]; + mask = [1, 0]; + v = nanmskmin(x.length, x, 1, 0, mask, 1, 0); + t.strictEqual(isnan(v), true, "returns expected value"); + + x = [NaN, NaN]; + mask = [0, 1]; + v = nanmskmin(x.length, x, 1, 0, mask, 1, 0); + t.strictEqual(isnan(v), true, "returns expected value"); + + x = [NaN, NaN]; + mask = [0, 0]; + v = nanmskmin(x.length, x, 1, 0, mask, 1, 0); + t.strictEqual(isnan(v), true, "returns expected value"); + + t.end(); + }, +); + +tape( + "the function calculates the minimum value of a strided array according to a mask (accessor)", + function test(t) { + var mask; + var x; + var v; + + // Test case 1: Mixed values with NaN and masking + x = [1.0, -2.0, -4.0, NaN, 5.0, 0.0, 3.0]; + mask = [0, 0, 0, 1, 0, 0, 0]; + v = nanmskmin( + x.length, + toAccessorArray(x), + 1, + 0, + toAccessorArray(mask), + 1, + 0, + ); + t.strictEqual(v, -4.0, "returns expected value"); + + // Test case 2: NaN is masked out + x = [-4.0, NaN, -5.0]; + mask = [0, 1, 0]; + v = nanmskmin( + x.length, + toAccessorArray(x), + 1, + 0, + toAccessorArray(mask), + 1, + 0, + ); + t.strictEqual(v, -5.0, "returns expected value"); + + // Test case 3: Handling -0.0 and 0.0 + x = [-0.0, 0.0, NaN, -0.0]; + mask = [0, 0, 1, 0]; + v = nanmskmin( + x.length, + toAccessorArray(x), + 1, + 0, + toAccessorArray(mask), + 1, + 0, + ); + t.strictEqual(isNegativeZero(v), true, "returns expected value"); + + // Test case 4: NaN is not masked out + x = [-4.0, 0.0, NaN, 5.0]; + mask = [0, 0, 0, 0]; + v = nanmskmin( + x.length, + toAccessorArray(x), + 1, + 0, + toAccessorArray(mask), + 1, + 0, + ); + t.strictEqual(isnan(v), false, "returns expected value"); + + // Test case 5: Single NaN element, not masked out + x = [NaN]; + mask = [0]; + v = nanmskmin( + x.length, + toAccessorArray(x), + 1, + 0, + toAccessorArray(mask), + 1, + 0, + ); + t.strictEqual(isnan(v), true, "returns expected value"); + + // Test case 6: Single NaN element, masked out + x = [NaN]; + mask = [1]; + v = nanmskmin( + x.length, + toAccessorArray(x), + 1, + 0, + toAccessorArray(mask), + 1, + 0, + ); + t.strictEqual(isnan(v), true, "returns expected value"); + + // Test case 7: All elements are NaN and masked out + x = [NaN, NaN]; + mask = [1, 1]; + v = nanmskmin( + x.length, + toAccessorArray(x), + 1, + 0, + toAccessorArray(mask), + 1, + 0, + ); + t.strictEqual(isnan(v), true, "returns expected value"); + + // Test case 8: First element is NaN and masked out, second is NaN and not masked out + x = [NaN, NaN]; + mask = [1, 0]; + v = nanmskmin( + x.length, + toAccessorArray(x), + 1, + 0, + toAccessorArray(mask), + 1, + 0, + ); + t.strictEqual(isnan(v), true, "returns expected value"); + + // Test case 9: First element is NaN and not masked out, second is NaN and masked out + x = [NaN, NaN]; + mask = [0, 1]; + v = nanmskmin( + x.length, + toAccessorArray(x), + 1, + 0, + toAccessorArray(mask), + 1, + 0, + ); + t.strictEqual(isnan(v), true, "returns expected value"); + + // Test case 10: All elements are NaN and not masked out + x = [NaN, NaN]; + mask = [0, 0]; + v = nanmskmin( + x.length, + toAccessorArray(x), + 1, + 0, + toAccessorArray(mask), + 1, + 0, + ); + t.strictEqual(isnan(v), true, "returns expected value"); + + t.end(); + }, +); + +tape( + "if provided an `N` parameter less than or equal to `0`, the function returns `NaN`", + function test(t) { + var mask; + var x; + var v; + + x = [1.0, -2.0, -4.0, 5.0, 3.0]; + mask = [0.0, 0.0]; + + v = nanmskmin(0, x, 1, 0, mask, 1, 0); + t.strictEqual(isnan(v), true, "returns expected value"); + + v = nanmskmin(-1, x, 1, 0, mask, 1); + t.strictEqual(isnan(v), true, "returns expected value"); + + t.end(); + }, +); + +tape( + "if provided an `N` parameter equal to `1`, the function returns the first element", + function test(t) { + var mask; + var x; + var v; + + x = [1.0, -2.0, -4.0, 5.0, 3.0]; + mask = [0.0, 0.0]; + + v = nanmskmin(1, x, 1, 0, mask, 1, 0); + t.strictEqual(v, 1.0, "returns expected value"); + + t.end(); + }, +); + +tape("the function supports `stride` parameters", function test(t) { var mask; - var N; var x; var v; x = [ - 1.0, // 0 + 1.0, // 0 2.0, - 2.0, // 1 + 2.0, // 1 -7.0, -2.0, // 2 3.0, - 4.0, // 3 + 4.0, // 3 2.0, - 5.0, // 4 + 5.0, // 4 6.0, - NaN, // 5 - NaN + NaN, // 5 + NaN, ]; mask = [ 0, // 0 @@ -160,39 +318,37 @@ tape( 'the function supports `stride` parameters', function test( t ) { 0, 1, // 4 1, - 0, // 5 - 0 + 1, // 5 + 0, ]; - N = floor( x.length / 2 ); - v = nanmskmin( N, x, 2, 0, mask, 2, 0 ); + v = nanmskmin(x.length, x, 2, 0, mask, 2, 0); - t.strictEqual( v, -2.0, 'returns expected value' ); + t.strictEqual(v, -2.0, "returns expected value"); t.end(); }); -tape( 'the function supports negative `stride` parameters', function test( t ) { +tape("the function supports negative `stride` parameters", function test(t) { var mask; - var N; var x; var v; x = [ - NaN, // 5 + NaN, // 5 NaN, - 5.0, // 4 + 5.0, // 4 6.0, - 1.0, // 3 + 1.0, // 3 2.0, - 2.0, // 2 + 2.0, // 2 -7.0, -2.0, // 1 3.0, - 4.0, // 0 - 2.0 + 4.0, // 0 + 2.0, ]; mask = [ - 0, // 5 + 1, // 5 0, 1, // 4 1, @@ -203,35 +359,33 @@ tape( 'the function supports negative `stride` parameters', function test( t ) { 0, // 1 0, 0, // 0 - 0 + 0, ]; - N = floor( x.length / 2 ); - v = nanmskmin( N, x, -2, 10, mask, -2, 10 ); + v = nanmskmin(5, x, -2, 10, mask, -2, 10); - t.strictEqual( v, -2.0, 'returns expected value' ); + t.strictEqual(v, -2.0, "returns expected value"); t.end(); }); -tape( 'the function supports `offset` parameters', function test( t ) { +tape("the function supports `offset` parameters", function test(t) { var mask; - var N; var x; var v; x = [ 2.0, - 1.0, // 0 + 1.0, // 0 2.0, -2.0, // 1 -2.0, - 2.0, // 2 + 2.0, // 2 3.0, - 4.0, // 3 + 4.0, // 3 5.0, - 6.0, // 4 + 6.0, // 4 NaN, - NaN // 5 + NaN, // 5 ]; mask = [ 0, @@ -245,12 +399,11 @@ tape( 'the function supports `offset` parameters', function test( t ) { 1, 1, // 4 0, - 0 // 5 + 1, // 5 ]; - N = floor( x.length / 2 ); - v = nanmskmin( N, x, 2, 1, mask, 2, 1 ); - t.strictEqual( v, -2.0, 'returns expected value' ); + v = nanmskmin(5, x, 2, 1, mask, 2, 1); + t.strictEqual(v, -2.0, "returns expected value"); t.end(); });