diff --git a/lib/node_modules/@stdlib/stats/base/nanrange/README.md b/lib/node_modules/@stdlib/stats/base/nanrange/README.md index c469cec47e9c..5d68d2638ff6 100644 --- a/lib/node_modules/@stdlib/stats/base/nanrange/README.md +++ b/lib/node_modules/@stdlib/stats/base/nanrange/README.md @@ -38,9 +38,9 @@ The [**range**][range] is defined as the difference between the maximum and mini var nanrange = require( '@stdlib/stats/base/nanrange' ); ``` -#### nanrange( N, x, stride ) +#### nanrange( N, x, strideX ) -Computes the [range][range] of a strided array `x`, ignoring `NaN` values. +Computes the [range][range] of a strided array, ignoring `NaN` values. ```javascript var x = [ 1.0, -2.0, NaN, 2.0 ]; @@ -54,38 +54,32 @@ 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 [range][range] of every other element in `x`, +The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to compute the [range][range] 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 = nanrange( N, x, 2 ); +var v = nanrange( 5, x, 2 ); // returns 6.0 ``` Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views. - + ```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 = nanrange( N, x1, 2 ); +var v = nanrange( 4, x1, 2 ); // returns 6.0 ``` -#### nanrange.ndarray( N, x, stride, offset ) +#### nanrange.ndarray( N, x, strideX, offsetX ) Computes the [range][range] of a strided array, ignoring `NaN` values and using alternative indexing semantics. @@ -99,17 +93,14 @@ var v = nanrange.ndarray( N, x, 1, 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 [range][range] 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 [range][range] for every other element in the strided array 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 = nanrange.ndarray( N, x, 2, 1 ); +var v = nanrange.ndarray( 5, x, 2, 1 ); // returns 6.0 ``` @@ -122,6 +113,7 @@ var v = nanrange.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 ([`dnanrange`][@stdlib/stats/base/dnanrange], [`snanrange`][@stdlib/stats/base/snanrange], etc.) are likely to be significantly more performant. @@ -135,22 +127,19 @@ var v = nanrange.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 nanrange = require( '@stdlib/stats/base/nanrange' ); -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 = nanrange( x.length, x, 1 ); @@ -189,6 +178,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/base/dnanrange]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dnanrange diff --git a/lib/node_modules/@stdlib/stats/base/nanrange/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/nanrange/benchmark/benchmark.js index 006d94738e5e..053405e0fb96 100644 --- a/lib/node_modules/@stdlib/stats/base/nanrange/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/nanrange/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 nanrange = require( './../lib/nanrange.js' ); +var nanrange = 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. * @@ -38,17 +53,7 @@ var nanrange = require( './../lib/nanrange.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, 'float64', rand ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/stats/base/nanrange/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/base/nanrange/benchmark/benchmark.ndarray.js index b992801a0ac7..149af2ab9a1f 100644 --- a/lib/node_modules/@stdlib/stats/base/nanrange/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/nanrange/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 nanrange = 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. * @@ -38,17 +53,7 @@ var nanrange = 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, 'float64', rand ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/stats/base/nanrange/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/nanrange/docs/repl.txt index f7c4a341efc1..1fd87d1268bc 100644 --- a/lib/node_modules/@stdlib/stats/base/nanrange/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/nanrange/docs/repl.txt @@ -1,9 +1,9 @@ -{{alias}}( N, x, stride ) +{{alias}}( N, x, strideX ) Computes the range 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 ------- @@ -35,20 +35,17 @@ // 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 ) 4.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 ) 4.0 -{{alias}}.ndarray( N, x, stride, offset ) + +{{alias}}.ndarray( N, x, strideX, offsetX ) Computes the range 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 @@ -84,8 +81,7 @@ // 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 ) 4.0 See Also diff --git a/lib/node_modules/@stdlib/stats/base/nanrange/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/nanrange/docs/types/index.d.ts index 543bf933b324..6f54a7fc3b62 100644 --- a/lib/node_modules/@stdlib/stats/base/nanrange/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/nanrange/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 `nanrange`. @@ -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 range * * @example @@ -40,14 +45,14 @@ interface Routine { * var v = nanrange( x.length, x, 1 ); * // returns 4.0 */ - ( N: number, x: NumericArray, stride: number ): number; + ( N: number, x: InputArray, strideX: number ): number; /** * Computes the range 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 strideX - stride length * @param offset - starting index * @returns range * @@ -57,7 +62,7 @@ interface Routine { * var v = nanrange.ndarray( x.length, x, 1, 0 ); * // returns 4.0 */ - ndarray( N: number, x: NumericArray, stride: number, offset: number ): number; + ndarray( N: number, x: InputArray, strideX: number, offset: 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 range * * @example diff --git a/lib/node_modules/@stdlib/stats/base/nanrange/docs/types/test.ts b/lib/node_modules/@stdlib/stats/base/nanrange/docs/types/test.ts index 42e12839efcb..2edb746a63fc 100644 --- a/lib/node_modules/@stdlib/stats/base/nanrange/docs/types/test.ts +++ b/lib/node_modules/@stdlib/stats/base/nanrange/docs/types/test.ts @@ -16,6 +16,7 @@ * limitations under the License. */ +import AccessorArray = require( '@stdlib/array/base/accessor' ); import nanrange = require( './index' ); @@ -26,6 +27,7 @@ import nanrange = require( './index' ); const x = new Float64Array( 10 ); nanrange( x.length, x, 1 ); // $ExpectType number + nanrange( 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 nanrange = require( './index' ); const x = new Float64Array( 10 ); nanrange.ndarray( x.length, x, 1, 0 ); // $ExpectType number + nanrange.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/nanrange/examples/index.js b/lib/node_modules/@stdlib/stats/base/nanrange/examples/index.js index 202429f2cca7..dd3e77a02559 100644 --- a/lib/node_modules/@stdlib/stats/base/nanrange/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/nanrange/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 nanrange = 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 = nanrange( x.length, x, 1 ); diff --git a/lib/node_modules/@stdlib/stats/base/nanrange/lib/nanrange.js b/lib/node_modules/@stdlib/stats/base/nanrange/lib/accessors.js similarity index 58% rename from lib/node_modules/@stdlib/stats/base/nanrange/lib/nanrange.js rename to lib/node_modules/@stdlib/stats/base/nanrange/lib/accessors.js index e8af112b6154..647ca9144ee2 100644 --- a/lib/node_modules/@stdlib/stats/base/nanrange/lib/nanrange.js +++ b/lib/node_modules/@stdlib/stats/base/nanrange/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. @@ -28,45 +28,52 @@ var isnan = require( '@stdlib/math/base/assert/is-nan' ); /** * Computes the range 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 accessors +* @param {integer} strideX - stride length +* @param {NonNegativeInteger} offsetX - starting index * @returns {number} range * * @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 = nanrange( N, x, 1 ); +* var x = toAccessorArray( [ 1.0, -2.0, NaN, 2.0 ] ); +* +* var v = nanrange( 4, arraylike2object( x ), 1, 0 ); * // returns 4.0 */ -function nanrange( N, x, stride ) { +function nanrange( N, x, strideX, offsetX ) { + var xbuf; + var get; var max; var min; var ix; var v; var i; - if ( N <= 0 ) { - return NaN; - } - if ( N === 1 || stride === 0 ) { - if ( isnan( x[ 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 ) { + if ( isnan( get( xbuf, offsetX ) ) ) { return NaN; } return 0.0; } - if ( stride < 0 ) { - ix = (1-N) * stride; - } else { - ix = 0; - } + + ix = offsetX; for ( i = 0; i < N; i++ ) { - v = x[ ix ]; + v = get( xbuf, ix ); if ( v === v ) { break; } - ix += stride; + ix += strideX; } if ( i === N ) { return NaN; @@ -75,8 +82,8 @@ function nanrange( N, x, stride ) { max = min; i += 1; for ( i; i < N; i++ ) { - ix += stride; - v = x[ ix ]; + ix += strideX; + v = get( xbuf, ix ); if ( isnan( v ) ) { continue; } diff --git a/lib/node_modules/@stdlib/stats/base/nanrange/lib/index.js b/lib/node_modules/@stdlib/stats/base/nanrange/lib/index.js index 8be8b200592b..90ab2a1c0abb 100644 --- a/lib/node_modules/@stdlib/stats/base/nanrange/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/nanrange/lib/index.js @@ -33,19 +33,24 @@ * // returns 4.0 * * @example -* var floor = require( '@stdlib/math/base/special/floor' ); * var nanrange = require( '@stdlib/stats/base/nanrange' ); * * 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 = nanrange.ndarray( N, x, 2, 1 ); +* var v = nanrange.ndarray( 5, x, 2, 1 ); * // returns 6.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/nanrange/lib/main.js b/lib/node_modules/@stdlib/stats/base/nanrange/lib/main.js index 8337d4a674a5..0a114b9cd47d 100644 --- a/lib/node_modules/@stdlib/stats/base/nanrange/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/nanrange/lib/main.js @@ -20,14 +20,29 @@ // MODULES // -var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); -var nanrange = require( './nanrange.js' ); +var stride2offset = require( '@stdlib/strided/base/stride2offset' ); var ndarray = require( './ndarray.js' ); // MAIN // -setReadOnly( nanrange, 'ndarray', ndarray ); +/** +* Computes the range 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} variance +* +* @example +* var x = [ 1.0, -2.0, NaN, 2.0 ]; +* +* var v = nanrange( 4, x, 1 ); +* // returns 4.0 +*/ +function nanrange( N, x, strideX ) { + return ndarray( N, x, strideX, stride2offset( N, strideX ) ); +} // EXPORTS // diff --git a/lib/node_modules/@stdlib/stats/base/nanrange/lib/ndarray.js b/lib/node_modules/@stdlib/stats/base/nanrange/lib/ndarray.js index 20034db69971..5dff1479c716 100644 --- a/lib/node_modules/@stdlib/stats/base/nanrange/lib/ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/nanrange/lib/ndarray.js @@ -20,7 +20,9 @@ // MODULES // +var arraylike2object = require( '@stdlib/array/base/arraylike2object' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var accessors = require( './accessors.js' ); // MAIN // @@ -30,42 +32,44 @@ var isnan = require( '@stdlib/math/base/assert/is-nan' ); * * @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} range * * @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 = nanrange( N, x, 2, 1 ); +* var v = nanrange( 5, x, 2, 1 ); * // returns 6.0 */ -function nanrange( N, x, stride, offset ) { +function nanrange( N, x, strideX, offsetX ) { var max; var min; var ix; + var o; var v; var i; if ( N <= 0 ) { return NaN; } - if ( N === 1 || stride === 0 ) { - if ( isnan( x[ offset ] ) ) { + o = arraylike2object( x ); + if ( o.accessorProtocol ) { + return accessors( N, o, strideX, offsetX ); + } + if ( N === 1 || strideX === 0 ) { + if ( isnan( x[ offsetX ] ) ) { return NaN; } return 0.0; } - 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; @@ -74,7 +78,7 @@ function nanrange( N, x, stride, offset ) { max = min; 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/nanrange/test/test.nanrange.js b/lib/node_modules/@stdlib/stats/base/nanrange/test/test.main.js similarity index 65% rename from lib/node_modules/@stdlib/stats/base/nanrange/test/test.nanrange.js rename to lib/node_modules/@stdlib/stats/base/nanrange/test/test.main.js index 87a09a03608f..c88a7e570901 100644 --- a/lib/node_modules/@stdlib/stats/base/nanrange/test/test.nanrange.js +++ b/lib/node_modules/@stdlib/stats/base/nanrange/test/test.main.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 toAccessorArray = require( '@stdlib/array/base/to-accessor-array' ); var isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' ); var Float64Array = require( '@stdlib/array/float64' ); -var nanrange = require( './../lib/nanrange.js' ); +var nanrange = require( './../lib/main.js' ); // TESTS // @@ -68,6 +68,33 @@ tape( 'the function calculates the range of a strided array', function test( t ) t.end(); }); +tape( 'the function calculates the range 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 = nanrange( x.length, toAccessorArray( x ), 1 ); + t.strictEqual( v, 9.0, 'returns expected value' ); + + x = [ -4.0, NaN, -5.0 ]; + v = nanrange( x.length, toAccessorArray( x ), 1 ); + t.strictEqual( v, 1.0, 'returns expected value' ); + + x = [ -0.0, NaN, 0.0, -0.0 ]; + v = nanrange( x.length, toAccessorArray( x ), 1 ); + t.strictEqual( isPositiveZero( v ), true, 'returns expected value' ); + + x = [ NaN ]; + v = nanrange( x.length, toAccessorArray( x ), 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN, NaN ]; + v = nanrange( 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; @@ -101,7 +128,6 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns `0` or `N }); tape( 'the function supports a `stride` parameter', function test( t ) { - var N; var x; var v; @@ -118,15 +144,36 @@ tape( 'the function supports a `stride` parameter', function test( t ) { NaN ]; - N = floor( x.length / 2 ); - v = nanrange( N, x, 2 ); + v = nanrange( 5, x, 2 ); + + t.strictEqual( v, 6.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 = nanrange( 5, toAccessorArray( x ), 2 ); t.strictEqual( v, 6.0, 'returns expected value' ); t.end(); }); tape( 'the function supports a negative `stride` parameter', function test( t ) { - var N; var x; var v; @@ -143,8 +190,30 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) 2.0 ]; - N = floor( x.length / 2 ); - v = nanrange( N, x, -2 ); + v = nanrange( 5, x, -2 ); + + t.strictEqual( v, 6.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 = nanrange( 5, toAccessorArray( x ), -2 ); t.strictEqual( v, 6.0, 'returns expected value' ); t.end(); @@ -167,10 +236,26 @@ tape( 'if provided a `stride` parameter equal to `0`, the function returns `0` o t.end(); }); +tape( 'if provided a `stride` parameter equal to `0`, the function returns `0` or `NaN` (accessors)', function test( t ) { + var x; + var v; + + x = [ 1.0, -2.0, -4.0, 5.0, 3.0 ]; + + v = nanrange( x.length, toAccessorArray( x ), 0 ); + t.strictEqual( v, 0.0, 'returns expected value' ); + + x = [ NaN, -2.0, -4.0, 5.0, 3.0 ]; + + v = nanrange( x.length, toAccessorArray( x ), 0 ); + 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([ @@ -188,9 +273,8 @@ 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 = nanrange( N, x1, 2 ); + v = nanrange( 5, x1, 2 ); t.strictEqual( v, 6.0, 'returns expected value' ); t.end(); diff --git a/lib/node_modules/@stdlib/stats/base/nanrange/test/test.ndarray.js b/lib/node_modules/@stdlib/stats/base/nanrange/test/test.ndarray.js index d176aabee37f..81c0169d7479 100644 --- a/lib/node_modules/@stdlib/stats/base/nanrange/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/nanrange/test/test.ndarray.js @@ -21,8 +21,8 @@ // MODULES // var tape = require( 'tape' ); -var floor = require( '@stdlib/math/base/special/floor' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' ); var isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' ); var nanrange = require( './../lib/ndarray.js' ); @@ -67,6 +67,33 @@ tape( 'the function calculates the range of a strided array', function test( t ) t.end(); }); +tape( 'the function calculates the range 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 = nanrange( x.length, toAccessorArray( x ), 1, 0 ); + t.strictEqual( v, 9.0, 'returns expected value' ); + + x = [ -4.0, NaN, -5.0 ]; + v = nanrange( x.length, toAccessorArray( x ), 1, 0 ); + t.strictEqual( v, 1.0, 'returns expected value' ); + + x = [ -0.0, 0.0, NaN, -0.0 ]; + v = nanrange( x.length, toAccessorArray( x ), 1, 0 ); + t.strictEqual( isPositiveZero( v ), true, 'returns expected value' ); + + x = [ NaN ]; + v = nanrange( x.length, toAccessorArray( x ), 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN, NaN ]; + v = nanrange( 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; @@ -100,7 +127,6 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns `0` or `N }); tape( 'the function supports a `stride` parameter', function test( t ) { - var N; var x; var v; @@ -117,15 +143,36 @@ tape( 'the function supports a `stride` parameter', function test( t ) { NaN ]; - N = floor( x.length / 2 ); - v = nanrange( N, x, 2, 0 ); + v = nanrange( 5, x, 2, 0 ); + + t.strictEqual( v, 6.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 = nanrange( 5, toAccessorArray( x ), 2, 0 ); t.strictEqual( v, 6.0, 'returns expected value' ); t.end(); }); tape( 'the function supports a negative `stride` parameter', function test( t ) { - var N; var x; var v; @@ -142,8 +189,30 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) 2.0 ]; - N = floor( x.length / 2 ); - v = nanrange( N, x, -2, 8 ); + v = nanrange( 5, x, -2, 8 ); + + t.strictEqual( v, 6.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 = nanrange( 5, toAccessorArray( x ), -2, 8 ); t.strictEqual( v, 6.0, 'returns expected value' ); t.end(); @@ -166,8 +235,24 @@ tape( 'if provided a `stride` parameter equal to `0`, the function returns `0` o t.end(); }); +tape( 'if provided a `stride` parameter equal to `0`, the function returns `0` or `NaN` (accessors)', function test( t ) { + var x; + var v; + + x = [ 1.0, -2.0, -4.0, 5.0, 3.0 ]; + + v = nanrange( x.length, toAccessorArray( x ), 0, 0 ); + t.strictEqual( v, 0.0, 'returns expected value' ); + + x = [ NaN, -2.0, -4.0, 5.0, 3.0 ]; + + v = nanrange( x.length, toAccessorArray( x ), 0, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + t.end(); +}); + tape( 'the function supports an `offset` parameter', function test( t ) { - var N; var x; var v; @@ -183,9 +268,31 @@ tape( 'the function supports an `offset` parameter', function test( t ) { NaN, NaN // 4 ]; - N = floor( x.length / 2 ); - v = nanrange( N, x, 2, 1 ); + v = nanrange( 5, x, 2, 1 ); + t.strictEqual( v, 6.0, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports an `offset` parameter (accessors)', 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 = nanrange( 5, toAccessorArray( x ), 2, 1 ); t.strictEqual( v, 6.0, 'returns expected value' ); t.end();