diff --git a/lib/node_modules/@stdlib/stats/base/nanmin-by/README.md b/lib/node_modules/@stdlib/stats/base/nanmin-by/README.md index 40a2f27cf662..c165a3251d48 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmin-by/README.md +++ b/lib/node_modules/@stdlib/stats/base/nanmin-by/README.md @@ -30,9 +30,9 @@ limitations under the License. var nanminBy = require( '@stdlib/stats/base/nanmin-by' ); ``` -#### nanminBy( N, x, stride, clbk\[, thisArg] ) +#### nanminBy( N, x, strideX, clbk\[, thisArg] ) -Calculates the minimum value of strided array `x` via a callback function, ignoring `NaN` values. +Computes the minimum value of a strided array via a callback function, ignoring `NaN` values. ```javascript function accessor( v ) { @@ -49,7 +49,7 @@ The function has the following parameters: - **N**: number of indexed elements. - **x**: input [`Array`][mdn-array], [`typed array`][mdn-typed-array], or an array-like object (excluding strings and functions). -- **stride**: index increment. +- **strideX**: stride length. - **clbk**: callback function. - **thisArg**: execution context (_optional_). @@ -81,19 +81,16 @@ var cnt = context.count; // returns 10 ``` -The `N` and `stride` parameters determine which elements in `x` are accessed at runtime. For example, to access every other element +The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to access every other element ```javascript -var floor = require( '@stdlib/math/base/special/floor' ); - function accessor( v ) { return v * 2.0; } var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0, NaN, NaN ]; -var N = floor( x.length / 2 ); -var v = nanminBy( N, x, 2, accessor ); +var v = nanminBy( 5, x, 2, accessor ); // returns -4.0 ``` @@ -101,7 +98,6 @@ Note that indexing is relative to the first index. To introduce an offset, use [ ```javascript var Float64Array = require( '@stdlib/array/float64' ); -var floor = require( '@stdlib/math/base/special/floor' ); function accessor( v ) { return v * 2.0; @@ -112,16 +108,15 @@ var x0 = new Float64Array( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] ); // Create an offset view... var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element -var N = floor( x0.length/2 ); // Access every other element... -var v = nanminBy( N, x1, 2, accessor ); +var v = nanminBy( 3, x1, 2, accessor ); // returns -12.0 ``` -#### nanminBy.ndarray( N, x, stride, offset, clbk\[, thisArg] ) +#### nanminBy.ndarray( N, x, strideX, offsetX, clbk\[, thisArg] ) -Calculates the minimum value of strided array `x` via a callback function, ignoring `NaN` values and using alternative indexing semantics. +Computes the minimum value of a strided array via a callback function, ignoring `NaN` values and using alternative indexing semantics. ```javascript function accessor( v ) { @@ -136,9 +131,9 @@ var v = nanminBy.ndarray( x.length, x, 1, 0, accessor ); The function has the following additional parameters: -- **offset**: starting index. +- **offsetX**: starting index. -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 access only the last three elements of `x` +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 access only the last three elements of `x` ```javascript function accessor( v ) { @@ -163,6 +158,7 @@ var v = nanminBy.ndarray( 3, x, 1, x.length-3, accessor ); - A provided callback function should return a numeric value. - If a provided callback function returns `NaN`, the value is ignored. - If a provided callback function does not return any value (or equivalently, explicitly returns `undefined`), the value is ignored. +- 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]). - When possible, prefer using [`dnanmin`][@stdlib/stats/strided/dnanmin], [`snanmin`][@stdlib/stats/strided/snanmin], and/or [`nanmin`][@stdlib/stats/base/nanmin], as, depending on the environment, these interfaces are likely to be significantly more performant. @@ -176,23 +172,23 @@ var v = nanminBy.ndarray( 3, x, 1, x.length-3, accessor ); ```javascript -var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ); -var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/base/uniform' ); var filledarrayBy = require( '@stdlib/array/filled-by' ); +var bernoulli = require( '@stdlib/random/base/bernoulli' ); var nanminBy = require( '@stdlib/stats/base/nanmin-by' ); -function fill() { - if ( randu() < 0.2 ) { +function rand() { + if ( bernoulli( 0.8 )< 0.2 ) { return NaN; } - return discreteUniform( -50, 50 ); + return uniform( -50, 50 ); } function accessor( v ) { return v * 2.0; } -var x = filledarrayBy( 10, 'float64', fill ); +var x = filledarrayBy( 10, 'float64', rand ); console.log( x ); var v = nanminBy( x.length, x, 1, accessor ); @@ -229,6 +225,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/dnanmin]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dnanmin diff --git a/lib/node_modules/@stdlib/stats/base/nanmin-by/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/nanmin-by/benchmark/benchmark.js index facdddf5131a..dd58af109323 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmin-by/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/nanmin-by/benchmark/benchmark.js @@ -21,11 +21,13 @@ // MODULES // var bench = require( '@stdlib/bench' ); -var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/base/uniform' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); +var bernoulli = require( '@stdlib/random/base/bernoulli' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); var pkg = require( './../package.json' ).name; -var nanminBy = require( './../lib/nanmin_by.js' ); +var nanminBy = require( './../lib/main.js' ); // FUNCTIONS // @@ -41,6 +43,19 @@ function accessor( value ) { return value * 2.0; } +/** +* Returns a random number. +* +* @private +* @returns {number} random number +*/ +function rand() { + if ( bernoulli( 0.8 ) < 1 ) { + return NaN; + } + return uniform( -50.0, 50.0 ); +} + /** * Create a benchmark function. * @@ -49,17 +64,7 @@ function accessor( value ) { * @returns {Function} benchmark function */ function createBenchmark( len ) { - var x; - var i; - - x = []; - for ( i = 0; i < len; i++ ) { - if ( randu() < 0.2 ) { - x.push( NaN ); - } else { - x.push( ( randu()*20.0 ) - 10.0 ); - } - } + var x = filledarrayBy( len, 'generic', rand ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/stats/base/nanmin-by/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/base/nanmin-by/benchmark/benchmark.ndarray.js index 1571c3c927ed..6567d1764513 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmin-by/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/nanmin-by/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 filledarrayBy = require( '@stdlib/array/filled-by' ); +var bernoulli = require( '@stdlib/random/base/bernoulli' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); var pkg = require( './../package.json' ).name; @@ -41,6 +43,19 @@ function accessor( value ) { return value * 2.0; } +/** +* Returns a random number. +* +* @private +* @returns {number} random number +*/ +function rand() { + if ( bernoulli( 0.8 ) < 1 ) { + return NaN; + } + return uniform( -50.0, 50.0 ); +} + /** * Create a benchmark function. * @@ -49,17 +64,7 @@ function accessor( value ) { * @returns {Function} benchmark function */ function createBenchmark( len ) { - var x; - var i; - - x = []; - for ( i = 0; i < len; i++ ) { - if ( randu() < 0.2 ) { - x.push( NaN ); - } else { - x.push( ( randu()*20.0 ) - 10.0 ); - } - } + var x = filledarrayBy( len, 'generic', rand ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/stats/base/nanmin-by/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/nanmin-by/docs/repl.txt index 31e3189ca9d0..022002e0f289 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmin-by/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/nanmin-by/docs/repl.txt @@ -1,15 +1,15 @@ -{{alias}}( N, x, stride, clbk[, thisArg] ) - Calculates the minimum value of a strided array via a callback function, +{{alias}}( N, x, strideX, clbk[, thisArg] ) + Computes the minimum value of a strided array via a callback function, ignoring `NaN` values. - The `N` and `stride` parameters determine which elements in `x` 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 an offset, use typed array views. - If `N <= 0`, the function returns `x` unchanged. + If `N <= 0`, the function returns `NaN`. The callback function is provided four arguments: @@ -34,8 +34,8 @@ Input array/collection. If provided an object, the object must be array- like (excluding strings and functions). - stride: integer - Index increment for `x`. + strideX: integer + Stride length. clbk: Function Callback function. @@ -56,25 +56,24 @@ > {{alias}}( x.length, x, 1, accessor ) -10.0 - // Using `N` and `stride` parameters: + // Using `N` and stride parameters: > x = [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0, NaN, -3.0 ]; - > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 ); - > {{alias}}( N, x, 2, accessor ) + > {{alias}}( 4, x, 2, accessor ) -4.0 // Using view offsets: > var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] ); > var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); - > N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 ); - > {{alias}}( N, x1, 2, accessor ) + > {{alias}}( 3, x1, 2, accessor ) -12.0 -{{alias}}.ndarray( N, x, stride, offset, clbk[, thisArg] ) - Calculates the minimum value of a strided array via a callback function, + +{{alias}}.ndarray( N, x, strideX, offsetX, clbk[, thisArg] ) + Computes the minimum value of a strided array via a callback function, ignoring `NaN` values and using alternative indexing semantics. While typed array views mandate a view offset based on the underlying - buffer, the `offset` parameter supports indexing semantics based on a + buffer, the offset parameter supports indexing semantics based on a starting index. Parameters @@ -86,10 +85,10 @@ Input array/collection. If provided an object, the object must be array- like (excluding strings and functions). - stride: integer - Index increment for `x`. + strideX: integer + Stride length. - offset: integer + offsetX: integer Starting index of `x`. clbk: Function @@ -113,8 +112,7 @@ // Using an index offset: > x = [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ]; - > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 ); - > {{alias}}.ndarray( N, x, 2, 1, accessor ) + > {{alias}}.ndarray( 3, x, 2, 1, accessor ) -12.0 See Also diff --git a/lib/node_modules/@stdlib/stats/base/nanmin-by/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/nanmin-by/docs/types/index.d.ts index 05666501132c..1bf3d9765d3e 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmin-by/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/nanmin-by/docs/types/index.d.ts @@ -20,7 +20,12 @@ /// -import { Collection } from '@stdlib/types/array'; +import { NumericArray, Collection, AccessorArrayLike } from '@stdlib/types/array'; + +/** +* Input array. +*/ +type InputArray = NumericArray | Collection | AccessorArrayLike; /** * Returns an accessed value. @@ -83,7 +88,7 @@ type Callback = Nullary | Unary | Binary | Ternary | */ interface Routine { /** - * Calculates the minimum value of a strided array via a callback function, ignoring `NaN` values. + * Computes the minimum value of a strided array via a callback function, ignoring `NaN` values. * * ## Notes * @@ -102,7 +107,7 @@ interface Routine { * * @param N - number of indexed elements * @param x - input array - * @param stride - stride length + * @param strideX - stride length * @param clbk - callback * @param thisArg - execution context * @returns minimum value @@ -117,10 +122,10 @@ interface Routine { * var v = nanminBy( x.length, x, 1, accessor ); * // returns -10.0 */ - ( N: number, x: Collection, stride: number, clbk: Callback, thisArg?: ThisParameterType> ): number; + ( N: number, x: InputArray, strideX: number, clbk: Callback, thisArg?: ThisParameterType> ): number; /** - * Calculates the minimum value of a strided array via a callback function, ignoring `NaN` values and using alternative indexing semantics. + * Computes the minimum value of a strided array via a callback function, ignoring `NaN` values and using alternative indexing semantics. * * ## Notes * @@ -139,8 +144,8 @@ interface Routine { * * @param N - number of indexed elements * @param x - input array - * @param stride - stride length - * @param offset - starting index + * @param strideX - stride length + * @param offsetX - starting index * @param clbk - callback * @param thisArg - execution context * @returns minimum value @@ -155,11 +160,11 @@ interface Routine { * var v = nanminBy.ndarray( x.length, x, 1, 0, accessor ); * // returns -10.0 */ - ndarray( N: number, x: Collection, stride: number, offset: number, clbk: Callback, thisArg?: ThisParameterType> ): number; + ndarray( N: number, x: InputArray, strideX: number, offsetX: number, clbk: Callback, thisArg?: ThisParameterType> ): number; } /** -* Calculates the minimum value of a strided array via a callback function, ignoring `NaN` values. +* Computes the minimum value of a strided array via a callback function, ignoring `NaN` values. * * ## Notes * @@ -178,7 +183,7 @@ interface Routine { * * @param N - number of indexed elements * @param x - input array -* @param stride - stride length +* @param strideX - stride length * @param clbk - callback * @param thisArg - execution context * @returns minimum value diff --git a/lib/node_modules/@stdlib/stats/base/nanmin-by/docs/types/test.ts b/lib/node_modules/@stdlib/stats/base/nanmin-by/docs/types/test.ts index eeebd51df143..8c4008fd3652 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmin-by/docs/types/test.ts +++ b/lib/node_modules/@stdlib/stats/base/nanmin-by/docs/types/test.ts @@ -16,6 +16,7 @@ * limitations under the License. */ +import AccessorArray = require( '@stdlib/array/base/accessor' ); import nanminBy = require( './index' ); const accessor = (): number => { @@ -30,7 +31,10 @@ const accessor = (): number => { const x = new Float64Array( 10 ); nanminBy( x.length, x, 1, accessor ); // $ExpectType number + nanminBy( x.length, new AccessorArray( x ), 1, accessor ); // $ExpectType number + nanminBy( x.length, x, 1, accessor, {} ); // $ExpectType number + nanminBy( x.length, new AccessorArray( x ), 1, accessor, {} ); // $ExpectType number } // The compiler throws an error if the function is provided a first argument which is not a number... @@ -70,7 +74,7 @@ const accessor = (): number => { nanminBy( x.length, x, undefined, accessor ); // $ExpectError nanminBy( x.length, x, [], accessor ); // $ExpectError nanminBy( x.length, x, {}, accessor ); // $ExpectError - nanminBy( x.length, x, ( x: number, accessor ): number => x, accessor ); // $ExpectError + nanminBy( x.length, x, ( x: number ): number => x, accessor ); // $ExpectError } // The compiler throws an error if the function is provided a fourth argument which is not a function... @@ -102,7 +106,10 @@ const accessor = (): number => { const x = new Float64Array( 10 ); nanminBy.ndarray( x.length, x, 1, 0, accessor ); // $ExpectType number + nanminBy.ndarray( x.length, new AccessorArray( x ), 1, 0, accessor ); // $ExpectType number + nanminBy.ndarray( x.length, x, 1, 0, accessor, {} ); // $ExpectType number + nanminBy.ndarray( x.length, new AccessorArray( x ), 1, 0, accessor, {} ); // $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/nanmin-by/examples/index.js b/lib/node_modules/@stdlib/stats/base/nanmin-by/examples/index.js index 47da3a4f59c7..a1bc1d6a611f 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmin-by/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/nanmin-by/examples/index.js @@ -18,23 +18,23 @@ 'use strict'; -var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ); -var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/base/uniform' ); var filledarrayBy = require( '@stdlib/array/filled-by' ); +var bernoulli = require( '@stdlib/random/base/bernoulli' ); var nanminBy = require( './../lib' ); -function fill() { - if ( randu() < 0.2 ) { +function rand() { + if ( bernoulli( 0.8 )< 0.2 ) { return NaN; } - return discreteUniform( -50, 50 ); + return uniform( -50, 50 ); } function accessor( v ) { return v * 2.0; } -var x = filledarrayBy( 10, 'float64', fill ); +var x = filledarrayBy( 10, 'float64', rand ); console.log( x ); var v = nanminBy( x.length, x, 1, accessor ); diff --git a/lib/node_modules/@stdlib/stats/base/nanmin-by/lib/nanmin_by.js b/lib/node_modules/@stdlib/stats/base/nanmin-by/lib/accessors.js similarity index 54% rename from lib/node_modules/@stdlib/stats/base/nanmin-by/lib/nanmin_by.js rename to lib/node_modules/@stdlib/stats/base/nanmin-by/lib/accessors.js index d27553636d96..cd99cdc76f77 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmin-by/lib/nanmin_by.js +++ b/lib/node_modules/@stdlib/stats/base/nanmin-by/lib/accessors.js @@ -1,7 +1,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. @@ -27,60 +27,67 @@ var isNegativeZero = require( '@stdlib/math/base/assert/is-negative-zero' ); // MAIN // /** -* Calculates the minimum value of a strided array via a callback function, ignoring `NaN` values. +* Computes the minimum value of a strided array via a callback function, ignoring `NaN` values. * * @param {PositiveInteger} N - number of indexed elements -* @param {Collection} x - input array/collection -* @param {integer} stride - index increment +* @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 +* @param {NonNegativeInteger} offsetX - starting index * @param {Callback} clbk - callback * @param {*} [thisArg] - execution context * @returns {number} minimum value * * @example -* var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, NaN, 0.0, -1.0, -3.0 ]; +* var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' ); +* var arraylike2object = require( '@stdlib/array/base/arraylike2object' ); +* +* var x = toAccessorArray( [ -2.0, 1.0, 3.0, -5.0, 4.0, NaN, 0.0, -1.0, -3.0 ] ); * * function accessor( v ) { * return v * 2.0; * } * -* var v = nanminBy( x.length, x, 1, accessor ); +* var v = nanminBy( x.length, arraylike2object( x ), 1, 0, accessor ); * // returns -10.0 */ -function nanminBy( N, x, stride, clbk, thisArg ) { +function nanminBy( N, x, strideX, offsetX, clbk, thisArg ) { + var xbuf; + var get; var min; var ix; var v; var i; - if ( N <= 0 ) { - return NaN; - } - if ( N === 1 || stride === 0 ) { - v = clbk.call( thisArg, x[ 0 ], 0, 0, x ); - if ( v === void 0 ) { + // Cache reference to array data: + xbuf = x.data; + + // Cache a reference to the element accessor: + get = x.accessors[0]; + + if ( N === 1 || strideX === 0 ) { + v = clbk.call( thisArg, get( xbuf, offsetX ), 0, offsetX, x ); + if ( v === void 0 || isnan( v ) ) { return NaN; } return v; } - if ( stride < 0 ) { - ix = (1-N) * stride; - } else { - ix = 0; - } + ix = offsetX; for ( i = 0; i < N; i++ ) { - min = clbk.call( thisArg, x[ ix ], i, ix, x ); + min = clbk.call( thisArg, get( xbuf, ix ), i, ix, xbuf ); if ( min === min && min !== void 0 ) { break; } - ix += stride; + ix += strideX; } if ( i === N ) { return NaN; } i += 1; for ( i; i < N; i++ ) { - ix += stride; - v = clbk.call( thisArg, x[ ix ], i, ix, x ); + ix += strideX; + v = clbk.call( thisArg, get( xbuf, ix ), i, ix, xbuf ); if ( v === void 0 || isnan( v ) ) { continue; } diff --git a/lib/node_modules/@stdlib/stats/base/nanmin-by/lib/index.js b/lib/node_modules/@stdlib/stats/base/nanmin-by/lib/index.js index 467a89cf670e..d47bc104369b 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmin-by/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/nanmin-by/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Calculate the minimum value of a strided array via a callback function and ignoring `NaN` values. +* Compute the minimum value of a strided array via a callback function and ignoring `NaN` values. * * @module @stdlib/stats/base/nanmin-by * @@ -50,7 +50,14 @@ // 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/nanmin-by/lib/main.js b/lib/node_modules/@stdlib/stats/base/nanmin-by/lib/main.js index 360b050b4a6b..a9bf0ef9e62d 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmin-by/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/nanmin-by/lib/main.js @@ -20,14 +20,35 @@ // MODULES // -var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); -var nanminBy = require( './nanmin_by.js' ); +var stride2offset = require( '@stdlib/strided/base/stride2offset' ); var ndarray = require( './ndarray.js' ); // MAIN // -setReadOnly( nanminBy, 'ndarray', ndarray ); +/** +* Computes the minimum value of a strided array via a callback function, ignoring `NaN` values. +* +* @param {PositiveInteger} N - number of indexed elements +* @param {Collection} x - input array/collection +* @param {integer} strideX - index increment +* @param {Callback} clbk - callback +* @param {*} [thisArg] - execution context +* @returns {number} minimum value +* +* @example +* var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ]; +* +* function accessor( v ) { +* return v * 2.0; +* } +* +* var v = nanminBy( x.length, x, 1, accessor ); +* // returns -10.0 +*/ +function nanminBy( N, x, strideX, clbk, thisArg ) { + return ndarray( N, x, strideX, stride2offset( N, strideX ), clbk, thisArg ); +} // EXPORTS // diff --git a/lib/node_modules/@stdlib/stats/base/nanmin-by/lib/ndarray.js b/lib/node_modules/@stdlib/stats/base/nanmin-by/lib/ndarray.js index 4e51a5e2bace..64c2f5f21a96 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmin-by/lib/ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/nanmin-by/lib/ndarray.js @@ -22,17 +22,19 @@ 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 // /** -* Calculates the minimum value of a strided array via a callback function, ignoring `NaN` values. +* Computes the minimum value of a strided array via a callback function, ignoring `NaN` values. * * @param {PositiveInteger} N - number of indexed elements * @param {Collection} x - input array/collection -* @param {integer} stride - index increment -* @param {NonNegativeInteger} offset - starting index +* @param {integer} strideX - index increment +* @param {NonNegativeInteger} offsetX - starting index * @param {Callback} clbk - callback * @param {*} [thisArg] - execution context * @returns {number} minimum value @@ -47,36 +49,41 @@ var isNegativeZero = require( '@stdlib/math/base/assert/is-negative-zero' ); * var v = nanminBy( x.length, x, 1, 0, accessor ); * // returns -10.0 */ -function nanminBy( N, x, stride, offset, clbk, thisArg ) { +function nanminBy( N, x, strideX, offsetX, clbk, thisArg ) { var min; var ix; + var o; var v; var i; if ( N <= 0 ) { return NaN; } - if ( N === 1 || stride === 0 ) { - v = clbk.call( thisArg, x[ 0 ], 0, 0, x ); + o = arraylike2object( x ); + if ( o.accessorProtocol ) { + return accessors( N, o, strideX, offsetX, clbk, thisArg ); + } + if ( N === 1 || strideX === 0 ) { + v = clbk.call( thisArg, x[ offsetX ], 0, offsetX, x ); if ( v === void 0 ) { return NaN; } return v; } - ix = offset; + ix = offsetX; for ( i = 0; i < N; i++ ) { min = clbk.call( thisArg, x[ ix ], i, ix, x ); if ( min === min && min !== void 0 ) { break; } - ix += stride; + ix += strideX; } if ( i === N ) { return NaN; } i += 1; for ( i; i < N; i++ ) { - ix += stride; + ix += strideX; v = clbk.call( thisArg, x[ ix ], i, ix, x ); if ( v === void 0 || isnan( v ) ) { continue; diff --git a/lib/node_modules/@stdlib/stats/base/nanmin-by/test/test.nanmin_by.js b/lib/node_modules/@stdlib/stats/base/nanmin-by/test/test.nanmin_by.js index d6489f16ccf6..3c910b9c1a6d 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmin-by/test/test.nanmin_by.js +++ b/lib/node_modules/@stdlib/stats/base/nanmin-by/test/test.nanmin_by.js @@ -21,11 +21,11 @@ // 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 toAccessorArray = require( '@stdlib/array/base/to-accessor-array' ); var Float64Array = require( '@stdlib/array/float64' ); -var nanminBy = require( './../lib/nanmin_by.js' ); +var nanminBy = require( './../lib/main.js' ); // FUNCTIONS // @@ -75,11 +75,11 @@ tape( 'the function calculates the minimum value of a strided array via a callba v = nanminBy( x.length, x, 1, accessor ); t.strictEqual( isnan( v ), true, 'returns expected value' ); - x = new Array( 5 ); // sparse array + x = new Array( 5 ); // eslint-disable-line stdlib/no-new-array v = nanminBy( x.length, x, 1, accessor ); t.strictEqual( isnan( v ), true, 'returns expected value' ); - x = new Array( 5 ); // sparse array + x = new Array( 5 ); // eslint-disable-line stdlib/no-new-array x[ 2 ] = 1.0; v = nanminBy( x.length, x, 1, accessor ); t.strictEqual( v, 2.0, 'returns expected value' ); @@ -87,6 +87,42 @@ tape( 'the function calculates the minimum value of a strided array via a callba t.end(); }); +tape( 'the function calculates the minimum value of a strided array via a callback function, ignoring NaN values (accessors)', function test( t ) { + var x; + var v; + + x = [ 1.0, -2.0, -4.0, NaN, 5.0, 0.0, NaN, 3.0 ]; + v = nanminBy( x.length, toAccessorArray( x ), 1, accessor ); + t.strictEqual( v, -8.0, 'returns expected value' ); + + x = [ -4.0, NaN, -5.0 ]; + v = nanminBy( x.length, toAccessorArray( x ), 1, accessor ); + t.strictEqual( v, -10.0, 'returns expected value' ); + + x = [ 0.0, -0.0, NaN, 0.0 ]; + v = nanminBy( x.length, toAccessorArray( x ), 1, accessor ); + t.strictEqual( isNegativeZero( v ), true, 'returns expected value' ); + + x = [ NaN ]; + v = nanminBy( x.length, toAccessorArray( x ), 1, accessor ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN, NaN ]; + v = nanminBy( x.length, toAccessorArray( x ), 1, accessor ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = new Array( 5 ); // eslint-disable-line stdlib/no-new-array + v = nanminBy( x.length, toAccessorArray( x ), 1, accessor ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = new Array( 5 ); // eslint-disable-line stdlib/no-new-array + x[ 2 ] = 1.0; + v = nanminBy( x.length, toAccessorArray( x ), 1, accessor ); + t.strictEqual( v, 2.0, '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 x; var v; @@ -102,6 +138,21 @@ 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 x; + var v; + + x = [ 1.0, -2.0, -4.0, 5.0, 3.0 ]; + + v = nanminBy( 0, toAccessorArray( x ), 1, accessor ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + v = nanminBy( -1, toAccessorArray( x ), 1, accessor ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + t.end(); +}); + tape( 'if provided an `N` parameter equal to `1`, the function returns the first accessed element', function test( t ) { var x; var v; @@ -111,15 +162,30 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns the first v = nanminBy( 1, x, 1, accessor ); t.strictEqual( v, 2.0, 'returns expected value' ); - x = new Array( 1 ); // sparse array + x = new Array( 1 ); // eslint-disable-line stdlib/no-new-array v = nanminBy( 1, x, 1, accessor ); t.strictEqual( isnan( v ), true, 'returns expected value' ); t.end(); }); +tape( 'if provided an `N` parameter equal to `1`, the function returns the first accessed element (accessors)', function test( t ) { + var x; + var v; + + x = [ 1.0, -2.0, -4.0, 5.0, 3.0 ]; + + v = nanminBy( 1, toAccessorArray( x ), 1, accessor ); + t.strictEqual( v, 2.0, 'returns expected value' ); + + x = new Array( 1 ); // eslint-disable-line stdlib/no-new-array + v = nanminBy( 1, toAccessorArray( x ), 1, accessor ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + t.end(); +}); + tape( 'the function supports a `stride` parameter', function test( t ) { - var N; var x; var v; @@ -136,15 +202,36 @@ tape( 'the function supports a `stride` parameter', function test( t ) { NaN ]; - N = floor( x.length / 2 ); - v = nanminBy( N, x, 2, accessor ); + v = nanminBy( 5, x, 2, accessor ); + + t.strictEqual( v, -4.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a `stride` parameter (accessors)', function test( t ) { + 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, + NaN, // 4 + NaN + ]; + + v = nanminBy( 5, toAccessorArray( x ), 2, accessor ); t.strictEqual( v, -4.0, 'returns expected value' ); t.end(); }); tape( 'the function supports a negative `stride` parameter', function test( t ) { - var N; var x; var v; @@ -161,8 +248,30 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) 2.0 ]; - N = floor( x.length / 2 ); - v = nanminBy( N, x, -2, accessor ); + v = nanminBy( 5, x, -2, accessor ); + + t.strictEqual( v, -4.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a negative `stride` parameter (accessors)', function test( t ) { + var x; + var v; + + x = [ + NaN, // 4 + NaN, + 1.0, // 3 + 2.0, + 2.0, // 2 + -7.0, + -2.0, // 1 + 3.0, + 4.0, // 0 + 2.0 + ]; + + v = nanminBy( 5, toAccessorArray( x ), -2, accessor ); t.strictEqual( v, -4.0, 'returns expected value' ); t.end(); @@ -177,17 +286,32 @@ tape( 'if provided a `stride` parameter equal to `0`, the function returns the f v = nanminBy( x.length, x, 0, accessor ); t.strictEqual( v, 2.0, 'returns expected value' ); - x = new Array( 1 ); // sparse array + x = new Array( 1 ); // eslint-disable-line stdlib/no-new-array v = nanminBy( 1, x, 0, accessor ); t.strictEqual( isnan( v ), true, 'returns expected value' ); t.end(); }); +tape( 'if provided a `stride` parameter equal to `0`, the function returns the first accessed element (accessors)', function test( t ) { + var x; + var v; + + x = [ 1.0, -2.0, -4.0, 5.0, 3.0 ]; + + v = nanminBy( x.length, toAccessorArray( x ), 0, accessor ); + t.strictEqual( v, 2.0, 'returns expected value' ); + + x = new Array( 1 ); // eslint-disable-line stdlib/no-new-array + v = nanminBy( 1, toAccessorArray( x ), 0, accessor ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + t.end(); +}); + tape( 'the function supports view offsets', function test( t ) { var x0; var x1; - var N; var v; x0 = new Float64Array([ @@ -205,9 +329,35 @@ tape( 'the function supports view offsets', function test( t ) { ]); x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element - N = floor(x1.length / 2); - v = nanminBy( N, x1, 2, accessor ); + v = nanminBy( 5, x1, 2, accessor ); + t.strictEqual( v, -4.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports view offsets (accessors)', function test( t ) { + 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, + NaN, // 4 + NaN + ]); + + x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element + + v = nanminBy( 5, toAccessorArray( x1 ), 2, accessor ); t.strictEqual( v, -4.0, 'returns expected value' ); t.end(); @@ -231,3 +381,22 @@ tape( 'the function supports providing a callback execution context', function t return v * 2.0; } }); + +tape( 'the function supports providing a callback execution context (accessors)', function test( t ) { + var ctx; + var x; + + x = [ 1.0, 2.0, 3.0, NaN, 4.0, 5.0 ]; + ctx = { + 'count': 0 + }; + nanminBy( x.length, toAccessorArray( x ), 1, accessor, ctx ); + + t.strictEqual( ctx.count, x.length, 'returns expected value' ); + t.end(); + + function accessor( v ) { + this.count += 1; // eslint-disable-line no-invalid-this + return v * 2.0; + } +}); diff --git a/lib/node_modules/@stdlib/stats/base/nanmin-by/test/test.ndarray.js b/lib/node_modules/@stdlib/stats/base/nanmin-by/test/test.ndarray.js index 32bafbcc27bd..efe679230bd2 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmin-by/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/nanmin-by/test/test.ndarray.js @@ -21,9 +21,9 @@ // 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 toAccessorArray = require( '@stdlib/array/base/to-accessor-array' ); var nanminBy = require( './../lib/ndarray.js' ); @@ -74,11 +74,11 @@ tape( 'the function calculates the minimum value of a strided array via a callba v = nanminBy( x.length, x, 1, 0, accessor ); t.strictEqual( isnan( v ), true, 'returns expected value' ); - x = new Array( 5 ); // sparse array + x = new Array( 5 ); // eslint-disable-line stdlib/no-new-array v = nanminBy( x.length, x, 1, 0, accessor ); t.strictEqual( isnan( v ), true, 'returns expected value' ); - x = new Array( 5 ); // sparse array + x = new Array( 5 ); // eslint-disable-line stdlib/no-new-array x[ 2 ] = 1.0; v = nanminBy( x.length, x, 1, 0, accessor ); t.strictEqual( v, 2.0, 'returns expected value' ); @@ -86,6 +86,42 @@ tape( 'the function calculates the minimum value of a strided array via a callba t.end(); }); +tape( 'the function calculates the minimum value of a strided array via a callback function, ignoring NaN values (accessors)', function test( t ) { + var x; + var v; + + x = [ 1.0, -2.0, -4.0, NaN, 5.0, 0.0, NaN, 3.0 ]; + v = nanminBy( x.length, toAccessorArray( x ), 1, 0, accessor ); + t.strictEqual( v, -8.0, 'returns expected value' ); + + x = [ -4.0, NaN, -5.0 ]; + v = nanminBy( x.length, toAccessorArray( x ), 1, 0, accessor ); + t.strictEqual( v, -10.0, 'returns expected value' ); + + x = [ 0.0, -0.0, NaN, 0.0 ]; + v = nanminBy( x.length, toAccessorArray( x ), 1, 0, accessor ); + t.strictEqual( isNegativeZero( v ), true, 'returns expected value' ); + + x = [ NaN ]; + v = nanminBy( x.length, toAccessorArray( x ), 1, 0, accessor ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN, NaN ]; + v = nanminBy( x.length, toAccessorArray( x ), 1, 0, accessor ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = new Array( 5 ); // eslint-disable-line stdlib/no-new-array + v = nanminBy( x.length, toAccessorArray( x ), 1, 0, accessor ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = new Array( 5 ); // eslint-disable-line stdlib/no-new-array + x[ 2 ] = 1.0; + v = nanminBy( x.length, toAccessorArray( x ), 1, 0, accessor ); + t.strictEqual( v, 2.0, '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 x; var v; @@ -101,6 +137,21 @@ 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 x; + var v; + + x = [ 1.0, -2.0, -4.0, 5.0, 3.0 ]; + + v = nanminBy( 0, toAccessorArray( x ), 1, 0, accessor ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + v = nanminBy( -1, toAccessorArray( x ), 1, 0, accessor ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + t.end(); +}); + tape( 'if provided an `N` parameter equal to `1`, the function returns the first accessed element', function test( t ) { var x; var v; @@ -110,15 +161,30 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns the first v = nanminBy( 1, x, 1, 0, accessor ); t.strictEqual( v, 2.0, 'returns expected value' ); - x = new Array( 1 ); // sparse array + x = new Array( 1 ); // eslint-disable-line stdlib/no-new-array v = nanminBy( 1, x, 1, 0, accessor ); t.strictEqual( isnan( v ), true, 'returns expected value' ); t.end(); }); +tape( 'if provided an `N` parameter equal to `1`, the function returns the first accessed element (accessors)', function test( t ) { + var x; + var v; + + x = [ 1.0, -2.0, -4.0, 5.0, 3.0 ]; + + v = nanminBy( 1, toAccessorArray( x ), 1, 0, accessor ); + t.strictEqual( v, 2.0, 'returns expected value' ); + + x = new Array( 1 ); // eslint-disable-line stdlib/no-new-array + v = nanminBy( 1, toAccessorArray( x ), 1, 0, accessor ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + t.end(); +}); + tape( 'the function supports a `stride` parameter', function test( t ) { - var N; var x; var v; @@ -135,15 +201,36 @@ tape( 'the function supports a `stride` parameter', function test( t ) { NaN ]; - N = floor( x.length / 2 ); - v = nanminBy( N, x, 2, 0, accessor ); + v = nanminBy( 5, x, 2, 0, accessor ); + + t.strictEqual( v, -4.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a `stride` parameter (accessors)', function test( t ) { + 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, + NaN, // 4 + NaN + ]; + + v = nanminBy( 5, toAccessorArray( x ), 2, 0, accessor ); t.strictEqual( v, -4.0, 'returns expected value' ); t.end(); }); tape( 'the function supports a negative `stride` parameter', function test( t ) { - var N; var x; var v; @@ -160,8 +247,30 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) 2.0 ]; - N = floor( x.length / 2 ); - v = nanminBy( N, x, -2, 8, accessor ); + v = nanminBy( 5, x, -2, 8, accessor ); + + t.strictEqual( v, -4.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a negative `stride` parameter (accessors)', function test( t ) { + var x; + var v; + + x = [ + NaN, // 4 + NaN, + 1.0, // 3 + 2.0, + 2.0, // 2 + -7.0, + -2.0, // 1 + 3.0, + 4.0, // 0 + 2.0 + ]; + + v = nanminBy( 5, toAccessorArray( x ), -2, 8, accessor ); t.strictEqual( v, -4.0, 'returns expected value' ); t.end(); @@ -176,12 +285,27 @@ tape( 'if provided a `stride` parameter equal to `0`, the function returns the f v = nanminBy( x.length, x, 0, 0, accessor ); t.strictEqual( v, 2.0, 'returns expected value' ); - x = new Array( 1 ); // sparse array + x = new Array( 1 ); // eslint-disable-line stdlib/no-new-array v = nanminBy( 1, x, 0, 0, accessor ); t.strictEqual( isnan( v ), true, 'returns expected value' ); t.end(); }); +tape( 'if provided a `stride` parameter equal to `0`, the function returns the first accessed element (accessors)', function test( t ) { + var x; + var v; + + x = [ 1.0, -2.0, -4.0, 5.0, 3.0 ]; + + v = nanminBy( x.length, toAccessorArray( x ), 0, 0, accessor ); + t.strictEqual( v, 2.0, 'returns expected value' ); + + x = new Array( 1 ); // eslint-disable-line stdlib/no-new-array + v = nanminBy( 1, toAccessorArray( x ), 0, 0, accessor ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + t.end(); +}); tape( 'the function supports an offset parameter', function test( t ) { var x; @@ -204,6 +328,27 @@ tape( 'the function supports an offset parameter', function test( t ) { t.end(); }); +tape( 'the function supports an offset parameter (accessors)', function test( t ) { + var x; + var v; + + x = [ + 1.0, + -2.0, // 0 + 3.0, + 4.0, // 1 + 5.0, + -6.0, // 2 + NaN, + NaN // 3 + ]; + + v = nanminBy( 4, toAccessorArray( x ), 2, 1, accessor ); + t.strictEqual( v, -12.0, 'returns expected value' ); + + t.end(); +}); + tape( 'the function supports providing a callback execution context', function test( t ) { var ctx; var x; @@ -222,3 +367,22 @@ tape( 'the function supports providing a callback execution context', function t return v * 2.0; } }); + +tape( 'the function supports providing a callback execution context (accessors)', function test( t ) { + var ctx; + var x; + + x = [ 1.0, 2.0, 3.0, NaN, 4.0, 5.0 ]; + ctx = { + 'count': 0 + }; + nanminBy( x.length, toAccessorArray( x ), 1, 0, accessor, ctx ); + + t.strictEqual( ctx.count, x.length, 'returns expected value' ); + t.end(); + + function accessor( v ) { + this.count += 1; // eslint-disable-line no-invalid-this + return v * 2.0; + } +});