diff --git a/lib/node_modules/@stdlib/stats/base/nanmin/README.md b/lib/node_modules/@stdlib/stats/base/nanmin/README.md index fe5d3f8d44f8..28bd3dac58d5 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmin/README.md +++ b/lib/node_modules/@stdlib/stats/base/nanmin/README.md @@ -36,15 +36,14 @@ limitations under the License. var nanmin = require( '@stdlib/stats/base/nanmin' ); ``` -#### nanmin( N, x, stride ) +#### nanmin( N, x, strideX ) -Computes the minimum value of a strided array `x`, ignoring `NaN` values. +Computes the minimum value of a strided array, ignoring `NaN` values. ```javascript var x = [ 1.0, -2.0, NaN, 2.0 ]; -var N = x.length; -var v = nanmin( N, x, 1 ); +var v = nanmin( 4, x, 1 ); // returns -2.0 ``` @@ -52,17 +51,14 @@ The function has the following parameters: - **N**: number of indexed elements. - **x**: input [`Array`][mdn-array] or [`typed array`][mdn-typed-array]. -- **stride**: index increment for `x`. +- **strideX**: stride length for `x`. -The `N` and `stride` parameters determine which elements in `x` 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, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0, NaN, NaN ]; -var N = floor( x.length / 2 ); -var v = nanmin( N, x, 2 ); +var v = nanmin( 5, x, 2 ); // returns -2.0 ``` @@ -72,42 +68,35 @@ 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' ); var x0 = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, NaN, NaN, 4.0 ] ); var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element -var N = floor( x0.length / 2 ); - -var v = nanmin( N, x1, 2 ); +var v = nanmin( 4, x1, 2 ); // returns -2.0 ``` -#### nanmin.ndarray( N, x, stride, offset ) +#### nanmin.ndarray( N, x, strideX, offsetX ) Computes the minimum value of a strided array, ignoring `NaN` values and using alternative indexing semantics. ```javascript var x = [ 1.0, -2.0, NaN, 2.0 ]; -var N = x.length; -var v = nanmin.ndarray( N, x, 1, 0 ); +var v = nanmin.ndarray( 4, x, 1, 0 ); // returns -2.0 ``` The function has the following additional parameters: -- **offset**: starting index for `x`. +- **offsetX**: starting index for `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 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 parameter supports indexing semantics based on a starting index. 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, -2.0, NaN, NaN, 2.0, 3.0, 4.0 ]; -var N = floor( x.length / 2 ); -var v = nanmin.ndarray( N, x, 2, 1 ); +var v = nanmin.ndarray( 5, x, 2, 1 ); // returns -2.0 ``` @@ -120,6 +109,7 @@ var v = nanmin.ndarray( N, x, 2, 1 ); ## Notes - If `N <= 0`, both functions return `NaN`. +- 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]). - Depending on the environment, the typed versions ([`dnanmin`][@stdlib/stats/strided/dnanmin], [`snanmin`][@stdlib/stats/strided/snanmin], etc.) are likely to be significantly more performant. @@ -133,22 +123,19 @@ var v = nanmin.ndarray( N, x, 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 uniform = require( '@stdlib/random/base/uniform' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); +var bernoulli = require( '@stdlib/random/base/bernoulli' ); var nanmin = require( '@stdlib/stats/base/nanmin' ); -var x; -var i; - -x = new Float64Array( 10 ); -for ( i = 0; i < x.length; i++ ) { - if ( randu() < 0.2 ) { - 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 v = nanmin( x.length, x, 1 ); @@ -184,6 +171,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/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/nanmin/benchmark/benchmark.js index fd02e3119ec0..e40d15fd59f7 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmin/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/nanmin/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 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 nanmin = require( './../lib/nanmin.js' ); +var nanmin = require( './../lib/main.js' ); // FUNCTIONS // +/** +* Returns a random number. +* +* @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. * @@ -38,17 +53,7 @@ var nanmin = require( './../lib/nanmin.js' ); * @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/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/base/nanmin/benchmark/benchmark.ndarray.js index 139ea6d3f809..4b725aed43b8 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmin/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/nanmin/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; @@ -30,6 +32,19 @@ var nanmin = require( './../lib/ndarray.js' ); // FUNCTIONS // +/** +* Returns a random number. +* +* @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. * @@ -38,17 +53,7 @@ var nanmin = require( './../lib/ndarray.js' ); * @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/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/nanmin/docs/repl.txt index 695bfb089530..64c938ffaa1d 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmin/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/nanmin/docs/repl.txt @@ -1,9 +1,9 @@ -{{alias}}( N, x, stride ) +{{alias}}( N, x, strideX ) Computes the minimum value of a strided array, 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 a typed array view. @@ -18,8 +18,8 @@ x: Array|TypedArray Input array. - stride: integer - Index increment. + strideX: integer + Stride length. Returns ------- @@ -30,25 +30,22 @@ -------- // Standard Usage: > var x = [ 1.0, -2.0, NaN, 2.0 ]; - > {{alias}}( x.length, x, 1 ) + > {{alias}}( 4, x, 1 ) -2.0 - // Using `N` and `stride` parameters: + // Using `N` and stride parameters: > x = [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, NaN, NaN ]; - > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 ); - > var stride = 2; - > {{alias}}( N, x, stride ) + > {{alias}}( 4, x, 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, NaN, NaN ] ); > var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); - > N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 ); - > stride = 2; - > {{alias}}( N, x1, stride ) + > {{alias}}( 4, x1, 2 ) -2.0 -{{alias}}.ndarray( N, x, stride, offset ) + +{{alias}}.ndarray( N, x, strideX, offsetX ) Computes the minimum value of a strided array, ignoring `NaN` values and using alternative indexing semantics. @@ -64,10 +61,10 @@ x: Array|TypedArray Input array. - stride: integer - Index increment. + strideX: integer + Stride length. - offset: integer + offsetX: integer Starting index. Returns @@ -79,13 +76,12 @@ -------- // Standard Usage: > var x = [ 1.0, -2.0, NaN, 2.0 ]; - > {{alias}}.ndarray( x.length, x, 1, 0 ) + > {{alias}}.ndarray( 4, x, 1, 0 ) -2.0 // Using offset parameter: > var x = [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ]; - > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 ); - > {{alias}}.ndarray( N, x, 2, 1 ) + > {{alias}}.ndarray( 4, x, 2, 1 ) -2.0 See Also diff --git a/lib/node_modules/@stdlib/stats/base/nanmin/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/nanmin/docs/types/index.d.ts index 9b69c530f4ff..02dbfe545ff7 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmin/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/nanmin/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 `nanmin`. @@ -31,7 +36,7 @@ interface Routine { * * @param N - number of indexed elements * @param x - input array - * @param stride - stride length + * @param strideX - stride length * @returns minimum value * * @example @@ -40,15 +45,15 @@ interface Routine { * var v = nanmin( x.length, x, 1 ); * // returns -2.0 */ - ( N: number, x: NumericArray, stride: number ): number; + ( N: number, x: InputArray, strideX: number ): number; /** * Computes the minimum value of a strided array, ignoring `NaN` values and using alternative indexing semantics. * * @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 * @returns minimum value * * @example @@ -57,7 +62,7 @@ interface Routine { * var v = nanmin.ndarray( x.length, x, 1, 0 ); * // returns -2.0 */ - ndarray( N: number, x: NumericArray, stride: number, offset: number ): number; + ndarray( N: number, x: InputArray, strideX: number, offsetX: number ): number; } /** @@ -65,7 +70,7 @@ interface Routine { * * @param N - number of indexed elements * @param x - input array -* @param stride - stride length +* @param strideX - stride length * @returns minimum value * * @example diff --git a/lib/node_modules/@stdlib/stats/base/nanmin/docs/types/test.ts b/lib/node_modules/@stdlib/stats/base/nanmin/docs/types/test.ts index 27062ad66245..390083bcad05 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmin/docs/types/test.ts +++ b/lib/node_modules/@stdlib/stats/base/nanmin/docs/types/test.ts @@ -16,6 +16,7 @@ * limitations under the License. */ +import AccessorArray = require( '@stdlib/array/base/accessor' ); import nanmin = require( './index' ); @@ -26,6 +27,7 @@ import nanmin = require( './index' ); const x = new Float64Array( 10 ); nanmin( x.length, x, 1 ); // $ExpectType number + nanmin( x.length, new AccessorArray( x ), 1 ); // $ExpectType number } // The compiler throws an error if the function is provided a first argument which is not a number... @@ -85,6 +87,7 @@ import nanmin = require( './index' ); const x = new Float64Array( 10 ); nanmin.ndarray( x.length, x, 1, 0 ); // $ExpectType number + nanmin.ndarray( x.length, new AccessorArray( x ), 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/nanmin/examples/index.js b/lib/node_modules/@stdlib/stats/base/nanmin/examples/index.js index 8fe15cc10dab..82c8a18489fd 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmin/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/nanmin/examples/index.js @@ -18,22 +18,19 @@ 'use strict'; -var randu = require( '@stdlib/random/base/randu' ); -var round = require( '@stdlib/math/base/special/round' ); -var Float64Array = require( '@stdlib/array/float64' ); +var uniform = require( '@stdlib/random/base/uniform' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); +var bernoulli = require( '@stdlib/random/base/bernoulli' ); var nanmin = require( './../lib' ); -var x; -var i; - -x = new Float64Array( 10 ); -for ( i = 0; i < x.length; i++ ) { - if ( randu() < 0.2 ) { - 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 v = nanmin( x.length, x, 1 ); diff --git a/lib/node_modules/@stdlib/stats/base/nanmin/lib/nanmin.js b/lib/node_modules/@stdlib/stats/base/nanmin/lib/accessors.js similarity index 58% rename from lib/node_modules/@stdlib/stats/base/nanmin/lib/nanmin.js rename to lib/node_modules/@stdlib/stats/base/nanmin/lib/accessors.js index a740132d1715..15f5e5c889c6 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmin/lib/nanmin.js +++ b/lib/node_modules/@stdlib/stats/base/nanmin/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. @@ -29,41 +29,48 @@ var isNegativeZero = require( '@stdlib/math/base/assert/is-negative-zero' ); /** * Computes the minimum value of a strided array, ignoring `NaN` values. * +* @private * @param {PositiveInteger} N - number of indexed elements -* @param {NumericArray} x - input array -* @param {integer} stride - stride length +* @param {Object} x - input array object +* @param {Collection} x.data - input array data +* @param {Array} x.accessors - array element accessor +* @param {integer} strideX - stride length +* @param {NonNegativeInteger} offsetX - starting index * @returns {number} minimum value * * @example -* var x = [ 1.0, -2.0, NaN, 2.0 ]; -* var N = x.length; +* var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' ); +* var arraylike2object = require( '@stdlib/array/base/arraylike2object' ); * -* var v = nanmin( N, x, 1 ); +* var x = toAccessorArray( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] ); +* +* var v = nanmin( 5, arraylike2object( x ), 2, 1 ); * // returns -2.0 */ -function nanmin( N, x, stride ) { +function nanmin( N, x, strideX, offsetX ) { + var xget; + var xbuf; var min; var ix; var v; var i; - if ( N <= 0 ) { - return NaN; - } - if ( N === 1 || stride === 0 ) { - return x[ 0 ]; - } - if ( stride < 0 ) { - ix = (1-N) * stride; - } else { - ix = 0; + // Cache reference to array data: + xbuf = x.data; + + // Cache a reference to the element accessor: + xget = x.accessors[ 0 ]; + + if ( N === 1 || strideX === 0 ) { + return xget( xbuf, offsetX ); } + ix = offsetX; for ( i = 0; i < N; i++ ) { - v = x[ ix ]; + v = xget( xbuf, ix ); if ( v === v ) { break; } - ix += stride; + ix += strideX; } if ( i === N ) { return NaN; @@ -71,8 +78,8 @@ function nanmin( N, x, stride ) { min = v; i += 1; for ( i; i < N; i++ ) { - ix += stride; - v = x[ ix ]; + ix += strideX; + v = xget( xbuf, ix ); if ( isnan( v ) ) { continue; } diff --git a/lib/node_modules/@stdlib/stats/base/nanmin/lib/index.js b/lib/node_modules/@stdlib/stats/base/nanmin/lib/index.js index 8b4d75f53034..0b814cae78d9 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmin/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/nanmin/lib/index.js @@ -27,25 +27,29 @@ * var nanmin = require( '@stdlib/stats/base/nanmin' ); * * var x = [ 1.0, -2.0, NaN, 2.0 ]; -* var N = x.length; * -* var v = nanmin( N, x, 1 ); +* var v = nanmin( 4, x, 1 ); * // returns -2.0 * * @example -* var floor = require( '@stdlib/math/base/special/floor' ); * var nanmin = require( '@stdlib/stats/base/nanmin' ); * * var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ]; -* var N = floor( x.length / 2 ); * -* var v = nanmin.ndarray( N, x, 2, 1 ); +* var v = nanmin.ndarray( 5, x, 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/nanmin/lib/main.js b/lib/node_modules/@stdlib/stats/base/nanmin/lib/main.js index 10f75d07bfa9..4a83fa8d7dbb 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmin/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/nanmin/lib/main.js @@ -20,14 +20,29 @@ // MODULES // -var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); -var nanmin = require( './nanmin.js' ); +var stride2offset = require( '@stdlib/strided/base/stride2offset' ); var ndarray = require( './ndarray.js' ); // MAIN // -setReadOnly( nanmin, 'ndarray', ndarray ); +/** +* Computes the minimum value of a strided array, ignoring `NaN` values. +* +* @param {PositiveInteger} N - number of indexed elements +* @param {NumericArray} x - input array +* @param {integer} strideX - stride length +* @returns {number} minimum value +* +* @example +* var x = [ 1.0, -2.0, NaN, 2.0 ]; +* +* var v = nanmin( 4, x, 1 ); +* // returns -2.0 +*/ +function nanmin( N, x, strideX ) { + return ndarray( N, x, strideX, stride2offset( N, strideX ) ); +} // EXPORTS // diff --git a/lib/node_modules/@stdlib/stats/base/nanmin/lib/ndarray.js b/lib/node_modules/@stdlib/stats/base/nanmin/lib/ndarray.js index 1b88405221e8..da8312fede87 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmin/lib/ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/nanmin/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,38 +33,40 @@ var isNegativeZero = require( '@stdlib/math/base/assert/is-negative-zero' ); * * @param {PositiveInteger} N - number of indexed elements * @param {NumericArray} x - input array -* @param {integer} stride - stride length -* @param {NonNegativeInteger} offset - starting index +* @param {integer} strideX - stride length +* @param {NonNegativeInteger} offsetX - starting index * @returns {number} minimum value * * @example -* var floor = require( '@stdlib/math/base/special/floor' ); -* * var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ]; -* var N = floor( x.length / 2 ); * -* var v = nanmin( N, x, 2, 1 ); +* var v = nanmin( 5, x, 2, 1 ); * // returns -2.0 */ -function nanmin( N, x, stride, offset ) { +function nanmin( N, x, strideX, offsetX ) { var min; var ix; var v; var i; + var o; if ( N <= 0 ) { return NaN; } - if ( N === 1 || stride === 0 ) { - return x[ offset ]; + o = arraylike2object( x ); + if ( o.accessorProtocol ) { + return accessors( N, o, strideX, offsetX ); + } + if ( N === 1 || strideX === 0 ) { + return x[ offsetX ]; } - ix = offset; + ix = offsetX; for ( i = 0; i < N; i++ ) { v = x[ ix ]; if ( v === v ) { break; } - ix += stride; + ix += strideX; } if ( i === N ) { return NaN; @@ -70,7 +74,7 @@ function nanmin( N, x, stride, offset ) { min = v; i += 1; for ( i; i < N; i++ ) { - ix += stride; + ix += strideX; v = x[ ix ]; if ( isnan( v ) ) { continue; diff --git a/lib/node_modules/@stdlib/stats/base/nanmin/test/test.nanmin.js b/lib/node_modules/@stdlib/stats/base/nanmin/test/test.main.js similarity index 63% rename from lib/node_modules/@stdlib/stats/base/nanmin/test/test.nanmin.js rename to lib/node_modules/@stdlib/stats/base/nanmin/test/test.main.js index c7cedc838309..bf0495edc475 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmin/test/test.nanmin.js +++ b/lib/node_modules/@stdlib/stats/base/nanmin/test/test.main.js @@ -21,11 +21,11 @@ // 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 Float64Array = require( '@stdlib/array/float64' ); -var nanmin = require( './../lib/nanmin.js' ); +var nanmin = require( './../lib/main.js' ); // TESTS // @@ -68,6 +68,33 @@ tape( 'the function calculates the minimum value of a strided array', function t t.end(); }); +tape( 'the function calculates the minimum value of a strided array (accessors)', function test( t ) { + var x; + var v; + + x = [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0, NaN, NaN ]; + v = nanmin( x.length, toAccessorArray( x ), 1 ); + t.strictEqual( v, -4.0, 'returns expected value' ); + + x = [ -4.0, NaN, -5.0 ]; + v = nanmin( x.length, toAccessorArray( x ), 1 ); + t.strictEqual( v, -5.0, 'returns expected value' ); + + x = [ 0.0, NaN, -0.0, 0.0 ]; + v = nanmin( x.length, toAccessorArray( x ), 1 ); + t.strictEqual( isNegativeZero( v ), true, 'returns expected value' ); + + x = [ NaN ]; + v = nanmin( x.length, toAccessorArray( x ), 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN, NaN ]; + v = nanmin( x.length, toAccessorArray( x ), 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 x; var v; @@ -96,7 +123,6 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns the first }); tape( 'the function supports a `stride` parameter', function test( t ) { - var N; var x; var v; @@ -113,15 +139,36 @@ tape( 'the function supports a `stride` parameter', function test( t ) { NaN ]; - N = floor( x.length / 2 ); - v = nanmin( N, x, 2 ); + v = nanmin( 5, x, 2 ); + + t.strictEqual( v, -2.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 = nanmin( 5, toAccessorArray( x ), 2 ); t.strictEqual( v, -2.0, 'returns expected value' ); t.end(); }); tape( 'the function supports a negative `stride` parameter', function test( t ) { - var N; var x; var v; @@ -138,8 +185,30 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) 2.0 ]; - N = floor( x.length / 2 ); - v = nanmin( N, x, -2 ); + v = nanmin( 5, x, -2 ); + + t.strictEqual( v, -2.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 = nanmin( 5, toAccessorArray( x ), -2 ); t.strictEqual( v, -2.0, 'returns expected value' ); t.end(); @@ -160,7 +229,6 @@ tape( 'if provided a `stride` parameter equal to `0`, the function returns the f tape( 'the function supports view offsets', function test( t ) { var x0; var x1; - var N; var v; x0 = new Float64Array([ @@ -178,9 +246,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 = nanmin( N, x1, 2 ); + v = nanmin( 5, x1, 2 ); + t.strictEqual( v, -2.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 = nanmin( 5, toAccessorArray( x1 ), 2 ); t.strictEqual( v, -2.0, 'returns expected value' ); t.end(); diff --git a/lib/node_modules/@stdlib/stats/base/nanmin/test/test.ndarray.js b/lib/node_modules/@stdlib/stats/base/nanmin/test/test.ndarray.js index de5eff440364..59458316a0d5 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmin/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/nanmin/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 nanmin = require( './../lib/ndarray.js' ); @@ -67,6 +67,33 @@ tape( 'the function calculates the minimum value of a strided array', function t t.end(); }); +tape( 'the function calculates the minimum value of a strided array (accessors)', function test( t ) { + var x; + var v; + + x = [ 1.0, -2.0, -4.0, 5.0, NaN, 0.0, 3.0 ]; + v = nanmin( x.length, toAccessorArray( x ), 1, 0 ); + t.strictEqual( v, -4.0, 'returns expected value' ); + + x = [ -4.0, NaN, -5.0 ]; + v = nanmin( x.length, toAccessorArray( x ), 1, 0 ); + t.strictEqual( v, -5.0, 'returns expected value' ); + + x = [ 0.0, -0.0, NaN, 0.0 ]; + v = nanmin( x.length, toAccessorArray( x ), 1, 0 ); + t.strictEqual( isNegativeZero( v ), true, 'returns expected value' ); + + x = [ NaN ]; + v = nanmin( x.length, toAccessorArray( x ), 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN, NaN ]; + v = nanmin( x.length, toAccessorArray( x ), 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + t.end(); +}); + tape( 'if provided an `N` parameter less than or equal to `0`, the function returns `NaN`', function test( t ) { var x; var v; @@ -95,7 +122,6 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns the first }); tape( 'the function supports a `stride` parameter', function test( t ) { - var N; var x; var v; @@ -112,15 +138,59 @@ tape( 'the function supports a `stride` parameter', function test( t ) { NaN ]; - N = floor( x.length / 2 ); - v = nanmin( N, x, 2, 0 ); + v = nanmin( 5, x, 2, 0 ); + + t.strictEqual( v, -2.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 = nanmin( 5, toAccessorArray( x ), 2, 0 ); + + t.strictEqual( v, -2.0, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a negative `stride` parameter', 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 = nanmin( 5, x, -2, 8 ); t.strictEqual( v, -2.0, 'returns expected value' ); t.end(); }); tape( 'the function supports a negative `stride` parameter', function test( t ) { - var N; var x; var v; @@ -137,8 +207,7 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) 2.0 ]; - N = floor( x.length / 2 ); - v = nanmin( N, x, -2, 8 ); + v = nanmin( 5, toAccessorArray( x ), -2, 8 ); t.strictEqual( v, -2.0, 'returns expected value' ); t.end(); @@ -157,7 +226,6 @@ tape( 'if provided a `stride` parameter equal to `0`, the function returns the f }); tape( 'the function supports an `offset` parameter', function test( t ) { - var N; var x; var v; @@ -173,9 +241,31 @@ tape( 'the function supports an `offset` parameter', function test( t ) { NaN, NaN // 4 ]; - N = floor( x.length / 2 ); - v = nanmin( N, x, 2, 1 ); + v = nanmin( 4, x, 2, 1 ); + t.strictEqual( v, -2.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports an `offset` parameter', function test( t ) { + 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 + NaN, + NaN // 4 + ]; + + v = nanmin( 4, toAccessorArray( x ), 2, 1 ); t.strictEqual( v, -2.0, 'returns expected value' ); t.end();