diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmin/README.md b/lib/node_modules/@stdlib/stats/base/nanmskmin/README.md index d17482005d93..fc17865b0f13 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmin/README.md +++ b/lib/node_modules/@stdlib/stats/base/nanmskmin/README.md @@ -38,7 +38,7 @@ var nanmskmin = require( '@stdlib/stats/base/nanmskmin' ); #### nanmskmin( N, x, strideX, mask, strideMask ) -Computes the minimum value of a strided array `x` according to a `mask`, ignoring `NaN` values. +Computes the minimum value of a strided array according to a `mask`, ignoring `NaN` values. ```javascript var x = [ 1.0, -2.0, -4.0, 2.0, NaN ]; @@ -52,41 +52,35 @@ 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`. +- **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**: index increment for `mask`. +- **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, NaN, NaN ]; +var mask = [ 0, 0, 0, 0, 0, 0, 1, 1, 0, 0 ]; -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( 5, x, 2, mask, 2 ); // returns -7.0 ``` Note that indexing is relative to the first index. To introduce offsets, use [`typed array`][mdn-typed-array] views. - + ```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 x0 = new Float64Array( [ 2.0, 1.0, -2.0, -2.0, 3.0, 4.0, 5.0, 6.0, NaN, NaN ] ); var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element -var mask0 = new Uint8Array( [ 0, 0, 0, 0, 0, 0, 1, 1 ] ); +var mask0 = new Uint8Array( [ 0, 0, 0, 0, 0, 0, 1, 1, 0, 0 ] ); var mask1 = new Uint8Array( mask0.buffer, mask0.BYTES_PER_ELEMENT*1 ); // start at 2nd element -var N = floor( x0.length / 2 ); - -var v = nanmskmin( N, x1, 2, mask1, 2 ); +var v = nanmskmin( 5, x1, 2, mask1, 2 ); // returns -2.0 ``` @@ -107,16 +101,13 @@ The function has the following additional parameters: - **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 parameters support indexing semantics based on starting indices. For example, to calculate the minimum value for every other element in `x` starting from the second element ```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 N = floor( x.length / 2 ); +var x = [ 2.0, 1.0, -2.0, -2.0, 3.0, 4.0, -5.0, -6.0, NaN, NaN ]; +var mask = [ 0, 0, 0, 0, 0, 0, 1, 1, 0, 0 ]; -var v = nanmskmin.ndarray( N, x, 2, 1, mask, 2, 1 ); +var v = nanmskmin.ndarray( 5, x, 2, 1, mask, 2, 1 ); // returns -2.0 ``` @@ -130,6 +121,7 @@ var v = nanmskmin.ndarray( N, x, 2, 1, mask, 2, 1 ); - If `N <= 0`, both functions return `NaN`. - Depending on the environment, the typed versions ([`dnanmskmin`][@stdlib/stats/strided/dnanmskmin], [`snanmskmin`][@stdlib/stats/strided/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,31 +134,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 uniform = require( '@stdlib/random/base/uniform' ); +var bernoulli = require( '@stdlib/random/base/bernoulli' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); 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 ); +function rand() { + if ( bernoulli( 0.8 ) < 1 ) { + return NaN; } + return uniform( -50.0, 50.0 ); } + +var x = filledarrayBy( 10, 'float64', rand ); console.log( x ); + +var mask = filledarrayBy( x.length, 'uint8', bernoulli.factory( 0.2 ) ); console.log( mask ); var v = nanmskmin( x.length, x, 1, mask, 1 ); @@ -203,6 +186,8 @@ console.log( v ); [mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray +[@stdlib/array/base/accessor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/accessor + [@stdlib/stats/strided/dnanmskmin]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dnanmskmin 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..79c7c93f39c3 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmin/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/nanmskmin/benchmark/benchmark.js @@ -21,15 +21,30 @@ // MODULES // var bench = require( '@stdlib/bench' ); -var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/base/uniform' ); +var bernoulli = require( '@stdlib/random/base/bernoulli' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); var pkg = require( './../package.json' ).name; -var nanmskmin = require( './../lib/nanmskmin.js' ); +var nanmskmin = require( './../lib/main.js' ); // FUNCTIONS // +/** +* Returns a random value or `NaN`. +* +* @private +* @returns {number} random number or `NaN` +*/ +function rand() { + if ( bernoulli( 0.8 ) < 1 ) { + return NaN; + } + return uniform( -10.0, 10.0 ); +} + /** * Creates a benchmark function. * @@ -40,18 +55,9 @@ var nanmskmin = require( './../lib/nanmskmin.js' ); 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 ); - } + x = filledarrayBy( len, 'generic', rand ); + mask = filledarrayBy( len, 'uint8', bernoulli.factory( 0.2 ) ); return benchmark; function benchmark( b ) { 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..802837bce9bf 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 @@ -21,7 +21,9 @@ // MODULES // var bench = require( '@stdlib/bench' ); -var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/base/uniform' ); +var bernoulli = require( '@stdlib/random/base/bernoulli' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); var pkg = require( './../package.json' ).name; @@ -30,6 +32,19 @@ var nanmskmin = require( './../lib/ndarray.js' ); // FUNCTIONS // +/** +* Returns a random value or `NaN`. +* +* @private +* @returns {number} random number or `NaN` +*/ +function rand() { + if ( bernoulli( 0.8 ) < 1 ) { + return NaN; + } + return uniform( -10.0, 10.0 ); +} + /** * Creates a benchmark function. * @@ -40,18 +55,9 @@ var nanmskmin = require( './../lib/ndarray.js' ); 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 ); - } + x = filledarrayBy( len, 'generic', rand ); + mask = filledarrayBy( len, 'uint8', bernoulli.factory( 0.2 ) ); return benchmark; function benchmark( b ) { 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..4416c2e59199 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 array + 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,22 +47,21 @@ > {{alias}}( x.length, x, 1, mask, 1 ) -2.0 - // Using `N` and `stride` parameters: - > x = [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, -4.0 ]; + // Using `N` and stride parameters: + > x = [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, NaN ]; > 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}}( 4, x, 2, mask, 2 ) -2.0 // Using view offsets: - > var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, -4.0 ] ); + > var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ] ); > 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 mask0 = new {{alias:@stdlib/array/uint8}}( [ 0, 0, 0, 0, 0, 0, 1, 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}}( 4, x1, 2, mask1, 2 ) -2.0 + {{alias}}.ndarray( N, x, strideX, offsetX, mask, strideMask, offsetMask ) Computes the minimum value of a strided array according to a mask, ignoring `NaN` values and using alternative indexing semantics. @@ -80,7 +79,7 @@ Input array. strideX: integer - Index increment for `x`. + Stride length for `x`. offsetX: integer Starting index for `x`. @@ -89,7 +88,7 @@ Mask array. strideMask: integer - Index increment for `mask`. + Stride length for `mask`. offsetMask: integer Starting index for `mask`. @@ -108,10 +107,9 @@ -2.0 // 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 ) + > x = [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, -4.0, NaN, NaN ]; + > mask = [ 0, 0, 0, 0, 0, 0, 1, 0, 0 ]; + > {{alias}}.ndarray( 4, 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..e8988ea538ca 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 @@ -20,7 +20,12 @@ /// -import { NumericArray } from '@stdlib/types/array'; +import { NumericArray, Collection, AccessorArrayLike } from '@stdlib/types/array'; + +/** +* Input array. +*/ +type InputArray = NumericArray | Collection | AccessorArrayLike; /** * Interface describing `nanmskmin`. @@ -31,9 +36,9 @@ interface Routine { * * @param N - number of indexed elements * @param x - input array - * @param strideX - `x` stride length + * @param strideX - stride length for `x` * @param mask - mask array - * @param strideMask - `mask` stride length + * @param strideMask - stride length for `mask` * @returns minimum value * * @example @@ -43,17 +48,17 @@ interface Routine { * var v = nanmskmin( x.length, x, 1, mask, 1 ); * // returns -2.0 */ - ( N: number, x: NumericArray, strideX: number, mask: NumericArray, strideMask: number ): number; + ( 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 strideX - stride length for `x` * @param offsetX - `x` starting index * @param mask - mask array - * @param strideMask - `mask` stride length + * @param strideMask - stride length for `mask` * @param offsetMask - `mask` starting index * @returns minimum value * @@ -64,7 +69,7 @@ interface Routine { * 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; + ndarray( N: number, x: InputArray, strideX: number, offsetX: number, mask: InputArray, strideMask: number, offsetMask: number ): number; } /** @@ -72,9 +77,9 @@ interface Routine { * * @param N - number of indexed elements * @param x - input array -* @param strideX - `x` stride length +* @param strideX - stride length for `x` * @param mask - mask array -* @param strideMask - `mask` stride length +* @param strideMask - stride length for `mask` * @returns minimum value * * @example 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..00eff863e2aa 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 @@ -16,6 +16,7 @@ * limitations under the License. */ +import AccessorArray = require( '@stdlib/array/base/accessor' ); import nanmskmin = require( './index' ); @@ -27,6 +28,7 @@ import nanmskmin = require( './index' ); const mask = new Uint8Array( 10 ); nanmskmin( x.length, x, 1, mask, 1 ); // $ExpectType number + nanmskmin( x.length, new AccessorArray( x ), 1, mask, 1 ); // $ExpectType number } // The compiler throws an error if the function is provided a first argument which is not a number... @@ -123,6 +125,7 @@ import nanmskmin = require( './index' ); 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, mask, 1, 0 ); // $ExpectType number } // The compiler throws an error if the `ndarray` method is provided a first argument which is not a number... 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..826ec3622739 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmin/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/nanmskmin/examples/index.js @@ -18,31 +18,22 @@ '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 uniform = require( '@stdlib/random/base/uniform' ); +var bernoulli = require( '@stdlib/random/base/bernoulli' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); var nanmskmin = require( './../lib' ); -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 ); +function rand() { + if ( bernoulli( 0.8 ) < 1 ) { + return NaN; } + return uniform( -50.0, 50.0 ); } + +var x = filledarrayBy( 10, 'float64', rand ); console.log( x ); + +var mask = filledarrayBy( x.length, 'uint8', bernoulli.factory( 0.2 ) ); console.log( mask ); var v = nanmskmin( x.length, x, 1, mask, 1 ); 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..0380b02a904e --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/nanmskmin/lib/accessors.js @@ -0,0 +1,110 @@ +/** +* @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 {number} minimum value +* +* @example +* var arraylike2object = require( '@stdlib/array/base/arraylike2object' ); +* var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' ); +* +* var x = toAccessorArray( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* var mask = toAccessorArray( [ 0, 0, 0, 0, 0, 0, 0, 0, 1, 1 ] ); +* +* var v = nanmskmin( 5, arraylike2object( toAccessorArray( x ) ), 2, 1, arraylike2object( toAccessorArray( mask ) ), 2, 1 ); +* // returns -2.0 +*/ +function nanmskmin( N, x, strideX, offsetX, mask, strideMask, offsetMask ) { + var xbuf; + var xget; + var mbuf; + 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 ]; + + ix = offsetX; + im = offsetMask; + for ( i = 0; i < N; i++ ) { + v = xget( xbuf, ix ); + if ( v === v && mget( mbuf, 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 ( mget( mbuf, im ) ) { + continue; + } + v = xget( xbuf, ix ); + if ( isnan( v ) ) { + continue; + } + 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/index.js b/lib/node_modules/@stdlib/stats/base/nanmskmin/lib/index.js index ce2f603f2746..70bc06b875a5 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmin/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/nanmskmin/lib/index.js @@ -33,20 +33,25 @@ * // returns -2.0 * * @example -* var floor = require( '@stdlib/math/base/special/floor' ); * var nanmskmin = require( '@stdlib/stats/base/nanmskmin' ); * * 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.ndarray( N, x, 2, 1, mask, 2, 1 ); +* var v = nanmskmin.ndarray( 5, x, 2, 1, mask, 2, 1 ); * // returns -2.0 */ // MODULES // +var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); var main = require( './main.js' ); +var ndarray = require( './ndarray.js' ); + + +// MAIN // + +setReadOnly( main, 'ndarray', ndarray ); // EXPORTS // diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmin/lib/main.js b/lib/node_modules/@stdlib/stats/base/nanmskmin/lib/main.js index 074c2295d907..5f252b1f9cdc 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmin/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/nanmskmin/lib/main.js @@ -20,14 +20,34 @@ // MODULES // -var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); -var nanmskmin = require( './nanmskmin.js' ); +var stride2offset = require( '@stdlib/strided/base/stride2offset' ); var ndarray = require( './ndarray.js' ); // MAIN // -setReadOnly( nanmskmin, 'ndarray', ndarray ); +/** +* 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 offsetMask = stride2offset( N, strideMask ); + var offsetX = stride2offset( N, strideX ); + return ndarray( N, x, strideX, offsetX, mask, strideMask, offsetMask ); +} // EXPORTS // diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmin/lib/nanmskmin.js b/lib/node_modules/@stdlib/stats/base/nanmskmin/lib/nanmskmin.js deleted file mode 100644 index 90a96ac4bf43..000000000000 --- a/lib/node_modules/@stdlib/stats/base/nanmskmin/lib/nanmskmin.js +++ /dev/null @@ -1,99 +0,0 @@ -/** -* @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'; - -// 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. -* -* @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; -} - - -// 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..6eb9fb1151c0 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmskmin/lib/ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/nanmskmin/lib/ndarray.js @@ -22,6 +22,8 @@ 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 // @@ -31,33 +33,37 @@ var isNegativeZero = require( '@stdlib/math/base/assert/is-negative-zero' ); * * @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 {integer} strideX - stride length for `x` +* @param {NonNegativeInteger} offsetX - starting index for `x` * @param {NumericArray} mask - mask array -* @param {integer} strideMask - `mask` stride length -* @param {NonNegativeInteger} offsetMask - `mask` starting index +* @param {integer} strideMask - stride length for `mask` +* @param {NonNegativeInteger} offsetMask - starting index for `mask` * @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 ); +* var v = nanmskmin( 5, 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 ) { return NaN; } + ox = arraylike2object( x ); + om = arraylike2object( mask ); + if ( ox.accessorProtocol || om.accessorProtocol ) { + return accessors( N, ox, strideX, offsetX, om, strideMask, offsetMask ); + } ix = offsetX; im = offsetMask; for ( i = 0; i < N; i++ ) { diff --git a/lib/node_modules/@stdlib/stats/base/nanmskmin/test/test.main.js b/lib/node_modules/@stdlib/stats/base/nanmskmin/test/test.main.js new file mode 100644 index 000000000000..3a7d35094f57 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/nanmskmin/test/test.main.js @@ -0,0 +1,475 @@ +/** +* @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 toAccessorArray = require( '@stdlib/array/base/to-accessor-array' ); +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/main.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' ); + + t.end(); +}); + +tape( 'the function calculates the minimum value of a strided array according to a mask, ignoring NaN values (accessors)', 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, toAccessorArray( x ), 1, toAccessorArray( mask ), 1 ); // eslint-disable-line max-len + t.strictEqual( v, -4.0, 'returns expected value' ); + + x = [ -4.0, NaN, -5.0 ]; + mask = [ 0, 1, 0 ]; + v = nanmskmin( x.length, toAccessorArray( x ), 1, toAccessorArray( mask ), 1 ); // eslint-disable-line max-len + 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, toAccessorArray( x ), 1, toAccessorArray( mask ), 1 ); // eslint-disable-line max-len + 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, toAccessorArray( x ), 1, toAccessorArray( mask ), 1 ); // eslint-disable-line max-len + t.strictEqual( v, -4.0, 'returns expected value' ); + + x = [ NaN ]; + mask = [ 0 ]; + v = nanmskmin( x.length, toAccessorArray( x ), 1, toAccessorArray( mask ), 1 ); // eslint-disable-line max-len + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN ]; + mask = [ 1 ]; + v = nanmskmin( x.length, toAccessorArray( x ), 1, toAccessorArray( mask ), 1 ); // eslint-disable-line max-len + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN, NaN ]; + mask = [ 1, 1 ]; + v = nanmskmin( x.length, toAccessorArray( x ), 1, toAccessorArray( mask ), 1 ); // eslint-disable-line max-len + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN, NaN ]; + mask = [ 1, 0 ]; + v = nanmskmin( x.length, toAccessorArray( x ), 1, toAccessorArray( mask ), 1 ); // eslint-disable-line max-len + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN, NaN ]; + mask = [ 0, 1 ]; + v = nanmskmin( x.length, toAccessorArray( x ), 1, toAccessorArray( mask ), 1 ); // eslint-disable-line max-len + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN, NaN ]; + mask = [ 0, 0 ]; + v = nanmskmin( x.length, toAccessorArray( x ), 1, toAccessorArray( mask ), 1 ); // eslint-disable-line max-len + 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 ]; + + 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 less than or equal to `0`, the function returns `NaN` (accessors)', function test( t ) { + var mask; + var x; + var v; + + x = [ 1.0, -2.0, -4.0, 5.0, 3.0 ]; + mask = [ 0, 0 ]; + + v = nanmskmin( 0, toAccessorArray( x ), 1, toAccessorArray( mask ), 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + v = nanmskmin( -1, toAccessorArray( x ), 1, toAccessorArray( 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 ]; + + v = nanmskmin( 1, x, 1, mask, 1 ); + t.strictEqual( v, 1.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an `N` parameter equal to `1`, the function returns the first element (accessors)', function test( t ) { + var mask; + var x; + var v; + + x = [ 1.0, -2.0, -4.0, 5.0, 3.0 ]; + mask = [ 0, 0 ]; + + v = nanmskmin( 1, toAccessorArray( x ), 1, toAccessorArray( 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, // 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, + 0, // 5 + 0 + ]; + + v = nanmskmin( 6, x, 2, mask, 2 ); + + t.strictEqual( v, -2.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports `stride` parameters (accessors)', function test( t ) { + var mask; + var x; + var v; + + 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, + 0, // 5 + 0 + ]; + + v = nanmskmin( 6, toAccessorArray( x ), 2, toAccessorArray( mask ), 2 ); + + t.strictEqual( v, -2.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports negative `stride` parameters', function test( t ) { + var mask; + var x; + var v; + + x = [ + NaN, // 5 + NaN, + 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 = [ + 0, // 5 + 0, + 1, // 4 + 1, + 0, // 3 + 0, + 0, // 2 + 0, + 0, // 1 + 0, + 0, // 0 + 0 + ]; + + v = nanmskmin( 6, x, -2, mask, -2 ); + + t.strictEqual( v, -2.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports negative `stride` parameters (accessors)', function test( t ) { + var mask; + var x; + var v; + + x = [ + NaN, // 5 + NaN, + 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 = [ + 0, // 5 + 0, + 1, // 4 + 1, + 0, // 3 + 0, + 0, // 2 + 0, + 0, // 1 + 0, + 0, // 0 + 0 + ]; + + v = nanmskmin( 6, 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 x1; + 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, + 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 + + v = nanmskmin( 6, x1, 2, mask1, 2 ); + t.strictEqual( v, -2.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports view offsets (accessors)', function test( t ) { + var mask0; + var mask1; + var x0; + var x1; + 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, + 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 + + v = nanmskmin( 6, toAccessorArray( x1 ), 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.nanmskmin.js b/lib/node_modules/@stdlib/stats/base/nanmskmin/test/test.nanmskmin.js deleted file mode 100644 index 0f37f2d1036d..000000000000 --- a/lib/node_modules/@stdlib/stats/base/nanmskmin/test/test.nanmskmin.js +++ /dev/null @@ -1,265 +0,0 @@ -/** -* @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'; - -// 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' ); - - -// 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' ); - - 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 N; - var x; - var v; - - 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, - 0, // 5 - 0 - ]; - - N = floor( x.length / 2 ); - v = nanmskmin( N, x, 2, mask, 2 ); - - t.strictEqual( v, -2.0, 'returns expected value' ); - t.end(); -}); - -tape( 'the function supports negative `stride` parameters', function test( t ) { - var mask; - var N; - var x; - var v; - - x = [ - NaN, // 5 - NaN, - 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 = [ - 0, // 5 - 0, - 1, // 4 - 1, - 0, // 3 - 0, - 0, // 2 - 0, - 0, // 1 - 0, - 0, // 0 - 0 - ]; - - N = floor( x.length / 2 ); - v = nanmskmin( N, x, -2, 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 x1; - var N; - 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, - 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 ); - - v = nanmskmin( N, x1, 2, 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 2e4240501128..f0957964d7e4 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 @@ -21,7 +21,7 @@ // MODULES // var tape = require( 'tape' ); -var floor = require( '@stdlib/math/base/special/floor' ); +var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' ); 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' ); @@ -98,13 +98,71 @@ tape( 'the function calculates the minimum value of a strided array according to t.end(); }); +tape( 'the function calculates the minimum value of a strided array according to a mask, ignoring NaN values (accessors)', 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, toAccessorArray( x ), 1, 0, toAccessorArray( mask ), 1, 0 ); // eslint-disable-line max-len + t.strictEqual( v, -4.0, 'returns expected value' ); + + x = [ -4.0, NaN, -5.0 ]; + mask = [ 0, 1, 0 ]; + v = nanmskmin( x.length, toAccessorArray( x ), 1, 0, toAccessorArray( mask ), 1, 0 ); // eslint-disable-line max-len + 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, toAccessorArray( x ), 1, 0, toAccessorArray( mask ), 1, 0 ); // eslint-disable-line max-len + 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, toAccessorArray( x ), 1, 0, toAccessorArray( mask ), 1, 0 ); // eslint-disable-line max-len + t.strictEqual( v, -4.0, 'returns expected value' ); + + x = [ NaN ]; + mask = [ 0 ]; + v = nanmskmin( x.length, toAccessorArray( x ), 1, 0, toAccessorArray( mask ), 1, 0 ); // eslint-disable-line max-len + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN ]; + mask = [ 1 ]; + v = nanmskmin( x.length, toAccessorArray( x ), 1, 0, toAccessorArray( mask ), 1, 0 ); // eslint-disable-line max-len + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN, NaN ]; + mask = [ 1, 1 ]; + v = nanmskmin( x.length, toAccessorArray( x ), 1, 0, toAccessorArray( mask ), 1, 0 ); // eslint-disable-line max-len + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN, NaN ]; + mask = [ 1, 0 ]; + v = nanmskmin( x.length, toAccessorArray( x ), 1, 0, toAccessorArray( mask ), 1, 0 ); // eslint-disable-line max-len + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN, NaN ]; + mask = [ 0, 1 ]; + v = nanmskmin( x.length, toAccessorArray( x ), 1, 0, toAccessorArray( mask ), 1, 0 ); // eslint-disable-line max-len + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN, NaN ]; + mask = [ 0, 0 ]; + v = nanmskmin( x.length, toAccessorArray( x ), 1, 0, toAccessorArray( mask ), 1, 0 ); // eslint-disable-line max-len + 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 ]; + mask = [ 0, 0 ]; v = nanmskmin( 0, x, 1, 0, mask, 1, 0 ); t.strictEqual( isnan( v ), true, 'returns expected value' ); @@ -115,13 +173,30 @@ tape( 'if provided an `N` parameter less than or equal to `0`, the function retu t.end(); }); +tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `NaN` (accessors)', function test( t ) { + var mask; + var x; + var v; + + x = [ 1.0, -2.0, -4.0, 5.0, 3.0 ]; + mask = [ 0, 0 ]; + + v = nanmskmin( 0, toAccessorArray( x ), 1, 0, toAccessorArray( mask ), 1, 0 ); // eslint-disable-line max-len + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + v = nanmskmin( -1, toAccessorArray( x ), 1, 0, toAccessorArray( mask ), 1, 0 ); // eslint-disable-line max-len + 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 ]; + mask = [ 0, 0 ]; v = nanmskmin( 1, x, 1, 0, mask, 1, 0 ); t.strictEqual( v, 1.0, 'returns expected value' ); @@ -129,9 +204,22 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns the first t.end(); }); +tape( 'if provided an `N` parameter equal to `1`, the function returns the first element (accessors)', function test( t ) { + var mask; + var x; + var v; + + x = [ 1.0, -2.0, -4.0, 5.0, 3.0 ]; + mask = [ 0, 0 ]; + + v = nanmskmin( 1, toAccessorArray( x ), 1, 0, toAccessorArray( mask ), 1, 0 ); // eslint-disable-line max-len + 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; @@ -164,8 +252,47 @@ tape( 'the function supports `stride` parameters', function test( t ) { 0 ]; - N = floor( x.length / 2 ); - v = nanmskmin( N, x, 2, 0, mask, 2, 0 ); + v = nanmskmin( 6, x, 2, 0, mask, 2, 0 ); + + t.strictEqual( v, -2.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports `stride` parameters (accessors)', function test( t ) { + var mask; + var x; + var v; + + 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, + 0, // 5 + 0 + ]; + + v = nanmskmin( 6, toAccessorArray( x ), 2, 0, toAccessorArray( mask ), 2, 0 ); // eslint-disable-line max-len t.strictEqual( v, -2.0, 'returns expected value' ); t.end(); @@ -173,7 +300,6 @@ tape( 'the function supports `stride` parameters', function test( t ) { tape( 'the function supports negative `stride` parameters', function test( t ) { var mask; - var N; var x; var v; @@ -206,8 +332,47 @@ tape( 'the function supports negative `stride` parameters', function test( t ) { 0 ]; - N = floor( x.length / 2 ); - v = nanmskmin( N, x, -2, 10, mask, -2, 10 ); + v = nanmskmin( 6, x, -2, 10, mask, -2, 10 ); + + t.strictEqual( v, -2.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports negative `stride` parameters (accessors)', function test( t ) { + var mask; + var x; + var v; + + x = [ + NaN, // 5 + NaN, + 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 = [ + 0, // 5 + 0, + 1, // 4 + 1, + 0, // 3 + 0, + 0, // 2 + 0, + 0, // 1 + 0, + 0, // 0 + 0 + ]; + + v = nanmskmin( 6, toAccessorArray( x ), -2, 10, toAccessorArray( mask ), -2, 10 ); // eslint-disable-line max-len t.strictEqual( v, -2.0, 'returns expected value' ); t.end(); @@ -215,7 +380,6 @@ tape( 'the function supports negative `stride` parameters', function test( t ) { tape( 'the function supports `offset` parameters', function test( t ) { var mask; - var N; var x; var v; @@ -247,9 +411,48 @@ tape( 'the function supports `offset` parameters', function test( t ) { 0, 0 // 5 ]; - N = floor( x.length / 2 ); - v = nanmskmin( N, x, 2, 1, mask, 2, 1 ); + v = nanmskmin( 6, x, 2, 1, mask, 2, 1 ); + t.strictEqual( v, -2.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports `offset` parameters (accessors)', function test( t ) { + var mask; + var x; + var v; + + x = [ + 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 + NaN, + NaN // 5 + ]; + mask = [ + 0, + 0, // 0 + 0, + 0, // 1 + 0, + 0, // 2 + 0, + 0, // 3 + 1, + 1, // 4 + 0, + 0 // 5 + ]; + + v = nanmskmin( 6, toAccessorArray( x ), 2, 1, toAccessorArray( mask ), 2, 1 ); // eslint-disable-line max-len t.strictEqual( v, -2.0, 'returns expected value' ); t.end();