diff --git a/lib/node_modules/@stdlib/stats/base/range/README.md b/lib/node_modules/@stdlib/stats/base/range/README.md index 7997564ea6be..3dd2e1594add 100644 --- a/lib/node_modules/@stdlib/stats/base/range/README.md +++ b/lib/node_modules/@stdlib/stats/base/range/README.md @@ -38,15 +38,14 @@ The [**range**][range] is defined as the difference between the maximum and mini var range = require( '@stdlib/stats/base/range' ); ``` -#### range( N, x, stride ) +#### range( N, x, strideX ) -Computes the [range][range] of a strided array `x`. +Computes the [range][range] of a strided array. ```javascript var x = [ 1.0, -2.0, 2.0 ]; -var N = x.length; -var v = range( N, x, 1 ); +var v = range( x.length, x, 1 ); // returns 4.0 ``` @@ -54,17 +53,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 [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 ]; -var N = floor( x.length / 2 ); -var v = range( N, x, 2 ); +var v = range( 4, x, 2 ); // returns 6.0 ``` @@ -74,42 +70,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, 2.0, 3.0, 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 = range( N, x1, 2 ); +var v = range( 4, x1, 2 ); // returns 6.0 ``` -#### range.ndarray( N, x, stride, offset ) +#### range.ndarray( N, x, strideX, offsetX ) Computes the [range][range] of a strided array using alternative indexing semantics. ```javascript var x = [ 1.0, -2.0, 2.0 ]; -var N = x.length; -var v = range.ndarray( N, x, 1, 0 ); +var v = range.ndarray( x.length, x, 1, 0 ); // returns 4.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 `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, 2.0, 3.0, 4.0 ]; -var N = floor( x.length / 2 ); -var v = range.ndarray( N, x, 2, 1 ); +var v = range.ndarray( 4, x, 2, 1 ); // returns 6.0 ``` @@ -123,6 +112,7 @@ var v = range.ndarray( N, x, 2, 1 ); - If `N <= 0`, both functions return `NaN`. - Depending on the environment, the typed versions ([`drange`][@stdlib/stats/strided/drange], [`srange`][@stdlib/stats/strided/srange], etc.) are likely to be significantly more performant. +- Both functions support array-like objects having getter and setter accessors for array element access (e.g., [`@stdlib/array/base/accessor`][@stdlib/array/base/accessor]). @@ -135,18 +125,12 @@ var v = range.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 discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); var range = require( '@stdlib/stats/base/range' ); -var x; -var i; - -x = new Float64Array( 10 ); -for ( i = 0; i < x.length; i++ ) { - x[ i ] = round( (randu()*100.0) - 50.0 ); -} +var x = discreteUniform(10, -50, 50, { + 'dtype': 'float64' +}); console.log( x ); var v = range( x.length, x, 1 ); @@ -185,6 +169,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/drange]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/drange diff --git a/lib/node_modules/@stdlib/stats/base/range/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/range/benchmark/benchmark.js index 587a3a985234..11b81649396e 100644 --- a/lib/node_modules/@stdlib/stats/base/range/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/range/benchmark/benchmark.js @@ -21,11 +21,18 @@ // MODULES // var bench = require( '@stdlib/bench' ); -var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/array/uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); var pkg = require( './../package.json' ).name; -var range = require( './../lib/range.js' ); +var range = require( './../lib/main.js' ); + + +// VARIABLES // + +var options = { + 'dtype': 'generic' +}; // FUNCTIONS // @@ -38,13 +45,7 @@ var range = require( './../lib/range.js' ); * @returns {Function} benchmark function */ function createBenchmark( len ) { - var x; - var i; - - x = []; - for ( i = 0; i < len; i++ ) { - x.push( ( randu()*20.0 ) - 10.0 ); - } + var x = uniform( len, -10, 10, options ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/stats/base/range/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/base/range/benchmark/benchmark.ndarray.js index 642f0d216ce7..ad83ccba11ef 100644 --- a/lib/node_modules/@stdlib/stats/base/range/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/range/benchmark/benchmark.ndarray.js @@ -21,13 +21,20 @@ // MODULES // var bench = require( '@stdlib/bench' ); -var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/array/uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); var pkg = require( './../package.json' ).name; var range = require( './../lib/ndarray.js' ); +// VARIABLES // + +var options = { + 'dtype': 'generic' +}; + + // FUNCTIONS // /** @@ -38,13 +45,7 @@ var range = require( './../lib/ndarray.js' ); * @returns {Function} benchmark function */ function createBenchmark( len ) { - var x; - var i; - - x = []; - for ( i = 0; i < len; i++ ) { - x.push( ( randu()*20.0 ) - 10.0 ); - } + var x = uniform( len, -10, 10, options ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/stats/base/range/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/range/docs/repl.txt index d93f8c9e76c6..f519f865620c 100644 --- a/lib/node_modules/@stdlib/stats/base/range/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/range/docs/repl.txt @@ -1,12 +1,12 @@ -{{alias}}( N, x, stride ) +{{alias}}( N, x, strideX ) Computes the range of a strided array. - 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. + Indexing is relative to the first index. To introduce an offset, use a + typed array view. If `N <= 0`, the function returns `NaN`. @@ -18,8 +18,8 @@ x: Array|TypedArray Input array. - stride: integer - Index increment. + strideX: integer + Stride length. Returns ------- @@ -33,22 +33,19 @@ > {{alias}}( x.length, x, 1 ) 4.0 - // Using `N` and `stride` parameters: + // Using `N` and stride parameters: > x = [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ]; - > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 ); - > var stride = 2; - > {{alias}}( N, x, stride ) + > {{alias}}( 3, 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 ] ); > 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}}( 3, x1, 2 ) 4.0 -{{alias}}.ndarray( N, x, stride, offset ) + +{{alias}}.ndarray( N, x, strideX, offsetX ) Computes the range of a strided array using alternative indexing semantics. While typed array views mandate a view offset based on the underlying @@ -63,10 +60,10 @@ x: Array|TypedArray Input array. - stride: integer - Index increment. + strideX: integer + Stride length. - offset: integer + offsetX: integer Starting index. Returns @@ -83,10 +80,8 @@ // Using offset parameter: > var x = [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ]; - > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 ); - > {{alias}}.ndarray( N, x, 2, 1 ) + > {{alias}}.ndarray( 3, x, 2, 1 ) 4.0 See Also -------- - diff --git a/lib/node_modules/@stdlib/stats/base/range/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/range/docs/types/index.d.ts index 1d1fa3af1f6e..56a7ddb9a9f7 100644 --- a/lib/node_modules/@stdlib/stats/base/range/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/range/docs/types/index.d.ts @@ -20,18 +20,20 @@ /// -import { NumericArray } from '@stdlib/types/array'; +import { NumericArray, Collection, AccessorArrayLike } from '@stdlib/types/array'; /** * Interface describing `range`. */ +type InputArray = NumericArray | Collection | AccessorArrayLike; + interface Routine { /** * Computes the range of a strided array. * * @param N - number of indexed elements * @param x - input array - * @param stride - stride length + * @param strideX - stride length * @returns range * * @example @@ -40,15 +42,15 @@ interface Routine { * var v = range( 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 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 range * * @example @@ -57,7 +59,7 @@ interface Routine { * var v = range.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, offsetX: number ): number; } /** @@ -65,7 +67,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/range/docs/types/test.ts b/lib/node_modules/@stdlib/stats/base/range/docs/types/test.ts index 5e28c339f10c..c76d915dec2b 100644 --- a/lib/node_modules/@stdlib/stats/base/range/docs/types/test.ts +++ b/lib/node_modules/@stdlib/stats/base/range/docs/types/test.ts @@ -16,6 +16,7 @@ * limitations under the License. */ +import AccessorArray = require( '@stdlib/array/base/accessor' ); import range = require( './index' ); @@ -26,6 +27,7 @@ import range = require( './index' ); const x = new Float64Array( 10 ); range( x.length, x, 1 ); // $ExpectType number + range( 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 range = require( './index' ); const x = new Float64Array( 10 ); range.ndarray( x.length, x, 1, 0 ); // $ExpectType number + range.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/range/examples/index.js b/lib/node_modules/@stdlib/stats/base/range/examples/index.js index 2b2bd004c144..6d6d9df9e149 100644 --- a/lib/node_modules/@stdlib/stats/base/range/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/range/examples/index.js @@ -18,18 +18,12 @@ 'use strict'; -var randu = require( '@stdlib/random/base/randu' ); -var round = require( '@stdlib/math/base/special/round' ); -var Float64Array = require( '@stdlib/array/float64' ); +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); var range = require( './../lib' ); -var x; -var i; - -x = new Float64Array( 10 ); -for ( i = 0; i < x.length; i++ ) { - x[ i ] = round( (randu()*100.0) - 50.0 ); -} +var x = discreteUniform(10, -50, 50, { + 'dtype': 'float64' +}); console.log( x ); var v = range( x.length, x, 1 ); diff --git a/lib/node_modules/@stdlib/stats/base/range/lib/range.js b/lib/node_modules/@stdlib/stats/base/range/lib/accessors.js similarity index 54% rename from lib/node_modules/@stdlib/stats/base/range/lib/range.js rename to lib/node_modules/@stdlib/stats/base/range/lib/accessors.js index 921dd5c8040a..6affccac6712 100644 --- a/lib/node_modules/@stdlib/stats/base/range/lib/range.js +++ b/lib/node_modules/@stdlib/stats/base/range/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,44 +28,51 @@ var isnan = require( '@stdlib/math/base/assert/is-nan' ); /** * Computes the range of a strided array. * +* @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 - strideX length +* @param {NonNegativeInteger} offsetX - starting index * @returns {number} range * * @example -* var x = [ 1.0, -2.0, 2.0 ]; -* var N = x.length; +* var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' ); +* var arraylike2object = require( '@stdlib/array/base/arraylike2object' ); * -* var v = range( N, x, 1 ); -* // returns 4.0 +* var x = toAccessorArray( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] ); +* +* var v = range( 4, arraylike2object( x ), 2, 1 ); +* // returns 6.0 */ -function range( N, x, stride ) { +function range( 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; - } - min = x[ ix ]; + ix = offsetX; + min = get( xbuf, ix ); max = min; for ( i = 1; i < N; i++ ) { - ix += stride; - v = x[ ix ]; + ix += strideX; + v = get( xbuf, ix ); if ( isnan( v ) ) { return v; } diff --git a/lib/node_modules/@stdlib/stats/base/range/lib/index.js b/lib/node_modules/@stdlib/stats/base/range/lib/index.js index 513ee2efe83a..d643c559cee5 100644 --- a/lib/node_modules/@stdlib/stats/base/range/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/range/lib/index.js @@ -27,25 +27,29 @@ * var range = require( '@stdlib/stats/base/range' ); * * var x = [ 1.0, -2.0, 2.0 ]; -* var N = x.length; * -* var v = range( N, x, 1 ); +* var v = range( x.length, x, 1 ); * // returns 4.0 * * @example -* var floor = require( '@stdlib/math/base/special/floor' ); * var range = require( '@stdlib/stats/base/range' ); * * var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ]; -* var N = floor( x.length / 2 ); * -* var v = range.ndarray( N, x, 2, 1 ); +* var v = range.ndarray( 4, 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/range/lib/main.js b/lib/node_modules/@stdlib/stats/base/range/lib/main.js index 9aa713d609f5..b88fa4f5aa2a 100644 --- a/lib/node_modules/@stdlib/stats/base/range/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/range/lib/main.js @@ -20,14 +20,29 @@ // MODULES // -var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); -var range = require( './range.js' ); +var stride2offset = require( '@stdlib/strided/base/stride2offset' ); var ndarray = require( './ndarray.js' ); // MAIN // -setReadOnly( range, 'ndarray', ndarray ); +/** +* Computes the range of a strided array. +* +* @param {PositiveInteger} N - number of indexed elements +* @param {NumericArray} x - input array +* @param {integer} strideX - stride length +* @returns {number} range +* +* @example +* var x = [ 1.0, -2.0, 2.0 ]; +* +* var v = range( x.length, x, 1 ); +* // returns 4.0 +*/ +function range( N, x, strideX ) { + return ndarray( N, x, strideX, stride2offset( N, strideX ) ); +} // EXPORTS // diff --git a/lib/node_modules/@stdlib/stats/base/range/lib/ndarray.js b/lib/node_modules/@stdlib/stats/base/range/lib/ndarray.js index 93676dd8afbb..cdf42424968a 100644 --- a/lib/node_modules/@stdlib/stats/base/range/lib/ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/range/lib/ndarray.js @@ -21,6 +21,8 @@ // MODULES // var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var arraylike2object = require( '@stdlib/array/base/arraylike2object' ); +var accessors = require( './accessors.js' ); // MAIN // @@ -30,40 +32,42 @@ 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 ]; -* var N = floor( x.length / 2 ); * -* var v = range( N, x, 2, 1 ); +* var v = range( 4, x, 2, 1 ); * // returns 6.0 */ -function range( N, x, stride, offset ) { +function range( 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; min = x[ ix ]; max = min; for ( i = 1; i < N; i++ ) { - ix += stride; + ix += strideX; v = x[ ix ]; if ( isnan( v ) ) { return v; diff --git a/lib/node_modules/@stdlib/stats/base/range/test/test.ndarray.js b/lib/node_modules/@stdlib/stats/base/range/test/test.ndarray.js index 867c625caf5f..2827a846183a 100644 --- a/lib/node_modules/@stdlib/stats/base/range/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/range/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 isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' ); +var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' ); var range = 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, 0.0, 3.0 ]; + v = range( x.length, toAccessorArray( x ), 1, 0 ); + t.strictEqual( v, 9.0, 'returns expected value' ); + + x = [ -4.0, -5.0 ]; + v = range( x.length, toAccessorArray( x ), 1, 0 ); + t.strictEqual( v, 1.0, 'returns expected value' ); + + x = [ -0.0, 0.0, -0.0 ]; + v = range( x.length, toAccessorArray( x ), 1, 0 ); + t.strictEqual( isPositiveZero( v ), true, 'returns expected value' ); + + x = [ NaN ]; + v = range( x.length, toAccessorArray( x ), 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN, NaN ]; + v = range( 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; @@ -82,6 +109,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 = range( 0, toAccessorArray( x ), 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + v = range( -1, toAccessorArray( x ), 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + t.end(); +}); + tape( 'if provided an `N` parameter equal to `1`, the function returns `0` or `NaN`', function test( t ) { var x; var v; @@ -99,8 +141,24 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns `0` or `N t.end(); }); +tape( 'if provided an `N` parameter equal to `1`, 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 = range( 1, toAccessorArray( x ), 1, 0 ); + t.strictEqual( v, 0.0, 'returns expected value' ); + + x = [ NaN, -2.0, -4.0, 5.0, 3.0 ]; + + v = range( 1, toAccessorArray( x ), 1, 0 ); + 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; @@ -115,15 +173,34 @@ tape( 'the function supports a `stride` parameter', function test( t ) { 2.0 ]; - N = floor( x.length / 2 ); - v = range( N, x, 2, 0 ); + v = range( 4, 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 + ]; + + v = range( 4, 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; @@ -138,8 +215,28 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) 2.0 ]; - N = floor( x.length / 2 ); - v = range( N, x, -2, 6 ); + v = range( 4, x, -2, 6 ); + + 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 = [ + 1.0, // 3 + 2.0, + 2.0, // 2 + -7.0, + -2.0, // 1 + 3.0, + 4.0, // 0 + 2.0 + ]; + + v = range( 4, toAccessorArray( x ), -2, 6 ); t.strictEqual( v, 6.0, 'returns expected value' ); t.end(); @@ -162,8 +259,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 = range( 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 = range( 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; @@ -177,9 +290,29 @@ tape( 'the function supports an `offset` parameter', function test( t ) { 3.0, 4.0 // 3 ]; - N = floor( x.length / 2 ); - v = range( N, x, 2, 1 ); + v = range( 4, 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 + ]; + + v = range( 4, toAccessorArray( x ), 2, 1 ); t.strictEqual( v, 6.0, 'returns expected value' ); t.end(); diff --git a/lib/node_modules/@stdlib/stats/base/range/test/test.range.js b/lib/node_modules/@stdlib/stats/base/range/test/test.range.js index 6447ea5f2ae3..f6937c24dcf5 100644 --- a/lib/node_modules/@stdlib/stats/base/range/test/test.range.js +++ b/lib/node_modules/@stdlib/stats/base/range/test/test.range.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 isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' ); +var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' ); var Float64Array = require( '@stdlib/array/float64' ); -var range = require( './../lib/range.js' ); +var range = 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 ]; + v = range( x.length, toAccessorArray( x ), 1 ); + t.strictEqual( v, 9.0, 'returns expected value' ); + + x = [ -4.0, -5.0 ]; + v = range( x.length, toAccessorArray( x ), 1 ); + t.strictEqual( v, 1.0, 'returns expected value' ); + + x = [ -0.0, 0.0, -0.0 ]; + v = range( x.length, toAccessorArray( x ), 1 ); + t.strictEqual( isPositiveZero( v ), true, 'returns expected value' ); + + x = [ NaN ]; + v = range( x.length, toAccessorArray( x ), 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN, NaN ]; + v = range( 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; @@ -83,6 +110,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 = range( 0, toAccessorArray( x ), 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + v = range( -1, toAccessorArray( x ), 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + t.end(); +}); + tape( 'if provided an `N` parameter equal to `1`, the function returns `0` or `NaN`', function test( t ) { var x; var v; @@ -100,8 +142,24 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns `0` or `N t.end(); }); +tape( 'if provided an `N` parameter equal to `1`, 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 = range( 1, toAccessorArray( x ), 1 ); + t.strictEqual( v, 0.0, 'returns expected value' ); + + x = [ NaN, -2.0, -4.0, 5.0, 3.0 ]; + + v = range( 1, toAccessorArray( x ), 1 ); + 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; @@ -116,15 +174,34 @@ tape( 'the function supports a `stride` parameter', function test( t ) { 2.0 ]; - N = floor( x.length / 2 ); - v = range( N, x, 2 ); + v = range( 4, 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 + ]; + + v = range( 4, 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; @@ -139,8 +216,28 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) 2.0 ]; - N = floor( x.length / 2 ); - v = range( N, x, -2 ); + v = range( 4, 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 = [ + 1.0, // 3 + 2.0, + 2.0, // 2 + -7.0, + -2.0, // 1 + 3.0, + 4.0, // 0 + 2.0 + ]; + + v = range( 4, toAccessorArray( x ), -2 ); t.strictEqual( v, 6.0, 'returns expected value' ); t.end(); @@ -163,10 +260,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 = range( x.length, toAccessorArray( x ), 0 ); + t.strictEqual( v, 0.0, 'returns expected value' ); + + x = [ NaN, -2.0, -4.0, 5.0, 3.0 ]; + + v = range( 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([ @@ -182,9 +295,33 @@ 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 = range( N, x1, 2 ); + v = range( 4, x1, 2 ); + t.strictEqual( v, 6.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 + ]); + + x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element + + v = range( 4, toAccessorArray( x1 ), 2 ); t.strictEqual( v, 6.0, 'returns expected value' ); t.end();