diff --git a/lib/node_modules/@stdlib/stats/base/range/README.md b/lib/node_modules/@stdlib/stats/base/range/README.md index 7997564ea6be..d49dd517a3e2 100644 --- a/lib/node_modules/@stdlib/stats/base/range/README.md +++ b/lib/node_modules/@stdlib/stats/base/range/README.md @@ -38,7 +38,7 @@ 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`. @@ -54,17 +54,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,18 +71,15 @@ 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. @@ -99,17 +93,14 @@ var v = range.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 value in `x` starting from the second value ```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 +114,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 +127,18 @@ var v = range.ndarray( N, x, 2, 1 ); ```javascript +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); var randu = require( '@stdlib/random/base/randu' ); var round = require( '@stdlib/math/base/special/round' ); -var Float64Array = require( '@stdlib/array/float64' ); 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 ); -} +x = discreteUniform(10, -50, 50, { + 'dtype': 'float64' +}); +x = x.map(round); console.log( x ); var v = range( x.length, x, 1 ); @@ -185,6 +177,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..4e64b2aac601 100644 --- a/lib/node_modules/@stdlib/stats/base/range/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/range/benchmark/benchmark.js @@ -21,7 +21,7 @@ // MODULES // var bench = require( '@stdlib/bench' ); -var randu = require( '@stdlib/random/base/randu' ); +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); var pkg = require( './../package.json' ).name; @@ -38,13 +38,9 @@ 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 = discreteUniform(len, 0, len, { + 'dtype': 'float64' + }); 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..e97c037dd409 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,7 +21,7 @@ // MODULES // var bench = require( '@stdlib/bench' ); -var randu = require( '@stdlib/random/base/randu' ); +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); var pkg = require( './../package.json' ).name; @@ -38,13 +38,9 @@ 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 = discreteUniform(len, 0, len, { + 'dtype': 'float64' + }); 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..97914010d7b1 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 ------- @@ -30,15 +30,15 @@ -------- // Standard Usage: > var x = [ 1.0, -2.0, 2.0 ]; - > {{alias}}( x.length, x, 1 ) + > {{alias}}( 3, 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 N = {{alias:@stdlib/math/base/special/floor}}( 3 / 2 ); > var stride = 2; > {{alias}}( N, x, stride ) - 4.0 + 0 // Using view offsets: > var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] ); @@ -48,7 +48,8 @@ > {{alias}}( N, x1, stride ) 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 +64,10 @@ x: Array|TypedArray Input array. - stride: integer - Index increment. + strideX: integer + Stride length. - offset: integer + offsetX: integer Starting index. Returns @@ -78,15 +79,14 @@ -------- // Standard Usage: > var x = [ 1.0, -2.0, 2.0 ]; - > {{alias}}.ndarray( x.length, x, 1, 0 ) + > {{alias}}.ndarray( 3, x, 1, 0 ) 4.0 // 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 ); + > var N = {{alias:@stdlib/math/base/special/floor}}( 3 / 2 ); > {{alias}}.ndarray( N, x, 2, 1 ) - 4.0 + 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..28f34170d10f 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,13 @@ '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 len = 50; +var x = discreteUniform(len, 0, len, { + 'dtype': 'float64' +}); console.log( x ); var v = range( x.length, x, 1 ); diff --git a/lib/node_modules/@stdlib/stats/base/range/lib/accessors.js b/lib/node_modules/@stdlib/stats/base/range/lib/accessors.js new file mode 100644 index 000000000000..d5b66403f8cf --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/range/lib/accessors.js @@ -0,0 +1,82 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var isnan = require( '@stdlib/math/base/assert/is-nan' ); + + +// MAIN // + +/** +* Computes the range of a strided array using accessors. +* +* @private +* @param {PositiveInteger} N - number of indexed elements +* @param {Object} obj - input array object +* @param {integer} strideX - strideX length +* @param {NonNegativeInteger} offsetX - starting index +* @returns {number} range +*/ +function range( N, obj, strideX, offsetX ) { + var xbuf; + var xget; + var min; + var max; + var ix; + var v; + var i; + + // Cache references to array data: + xbuf = obj.data; + + // Cache references to element accessors: + xget = obj.accessors[ 0 ]; + + if ( N === 1 || strideX === 0 ) { + v = xget( xbuf, offsetX ); + return ( isnan( v ) ) ? NaN : 0.0; + } + ix = offsetX; + v = xget( xbuf, ix ); + if ( isnan( v ) ) { + return NaN; + } + min = v; + max = v; + for ( i = 1; i < N; i++ ) { + ix += strideX; + v = xget( xbuf, ix ); + if ( isnan( v ) ) { + return NaN; + } + if ( v < min ) { + min = v; + } else if ( v > max ) { + max = v; + } + } + return max - min; +} + + +// EXPORTS // + +module.exports = range; 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..a3ec007bc9f4 100644 --- a/lib/node_modules/@stdlib/stats/base/range/lib/ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/range/lib/ndarray.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. @@ -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,8 +32,8 @@ 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 for `x` +* @param {NonNegativeInteger} offsetX - starting index for `x` * @returns {number} range * * @example @@ -40,30 +42,35 @@ var isnan = require( '@stdlib/math/base/assert/is-nan' ); * 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/lib/range.js b/lib/node_modules/@stdlib/stats/base/range/lib/range.js index 921dd5c8040a..dc12a706b917 100644 --- a/lib/node_modules/@stdlib/stats/base/range/lib/range.js +++ b/lib/node_modules/@stdlib/stats/base/range/lib/range.js @@ -20,7 +20,8 @@ // MODULES // -var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var stride2offset = require( '@stdlib/strided/base/stride2offset' ); +var ndarray = require( './ndarray.js' ); // MAIN // @@ -30,7 +31,7 @@ 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 {integer} strideX - strideX length * @returns {number} range * * @example @@ -40,42 +41,8 @@ var isnan = require( '@stdlib/math/base/assert/is-nan' ); * var v = range( N, x, 1 ); * // returns 4.0 */ -function range( N, x, stride ) { - var max; - var min; - var ix; - var v; - var i; - - if ( N <= 0 ) { - return NaN; - } - if ( N === 1 || stride === 0 ) { - if ( isnan( x[ 0 ] ) ) { - return NaN; - } - return 0.0; - } - if ( stride < 0 ) { - ix = (1-N) * stride; - } else { - ix = 0; - } - min = x[ ix ]; - max = min; - for ( i = 1; i < N; i++ ) { - ix += stride; - v = x[ ix ]; - if ( isnan( v ) ) { - return v; - } - if ( v < min ) { - min = v; - } else if ( v > max ) { - max = v; - } - } - return max - min; +function range( N, x, strideX ) { + return ndarray( N, x, strideX, stride2offset( N, strideX ) ); } 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..cd990e2e16c0 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,86 +21,94 @@ // 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 range = require( './../lib/ndarray.js' ); // TESTS // -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof range, 'function', 'main export is a function' ); +tape('main export is a function', function test(t) { + t.ok(true, __filename); + t.strictEqual(typeof range, 'function', 'main export is a function'); t.end(); }); -tape( 'the function has an arity of 4', function test( t ) { - t.strictEqual( range.length, 4, 'has expected arity' ); +tape('the function has an arity of 4', function test(t) { + t.strictEqual(range.length, 4, 'has expected arity'); t.end(); }); -tape( 'the function calculates the range of a strided array', function test( t ) { +tape('the function calculates the range of a strided array', function test(t) { var x; var v; - x = [ 1.0, -2.0, -4.0, 5.0, 0.0, 3.0 ]; - v = range( x.length, x, 1, 0 ); - t.strictEqual( v, 9.0, 'returns expected value' ); + x = [1.0, -2.0, -4.0, 5.0, 0.0, 3.0]; + v = range(x.length, x, 1, 0); + t.strictEqual(v, 9.0, 'returns expected value'); - x = [ -4.0, -5.0 ]; - v = range( x.length, x, 1, 0 ); - t.strictEqual( v, 1.0, 'returns expected value' ); + x = [-4.0, -5.0]; + v = range(x.length, x, 1, 0); + t.strictEqual(v, 1.0, 'returns expected value'); - x = [ -0.0, 0.0, -0.0 ]; - v = range( x.length, x, 1, 0 ); - t.strictEqual( isPositiveZero( v ), true, 'returns expected value' ); - - x = [ NaN ]; - v = range( x.length, x, 1, 0 ); - t.strictEqual( isnan( v ), true, 'returns expected value' ); - - x = [ NaN, NaN ]; - v = range( x.length, x, 1, 0 ); - t.strictEqual( isnan( v ), true, 'returns expected value' ); + x = [-0.0, 0.0, -0.0]; + v = range(x.length, x, 1, 0); + t.strictEqual(isPositiveZero(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 ) { +tape('the function calculates the range of a sorted strided array (accessor)', function test(t) { var x; var v; - x = [ 1.0, -2.0, -4.0, 5.0, 3.0 ]; + x = [-3.0, -2.0, -1.0, 1.0, 2.0, 3.0]; + v = range(x.length, toAccessorArray(x), 1, 0); + t.strictEqual(v, 6.0, 'returns expected value'); + + x = [3.0, 2.0, 1.0, 0.0, -1.0, -2.0, -3.0]; + v = range(x.length, toAccessorArray(x), 1, 0); + t.strictEqual(v, 6.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 = [-4.0, -4.0]; + v = range(x.length, toAccessorArray(x), 1, 0); + t.strictEqual(v, 0.0, 'returns expected value'); - v = range( 0, x, 1, 0 ); - t.strictEqual( isnan( v ), true, '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'); - v = range( -1, x, 1, 0 ); - t.strictEqual( isnan( v ), true, 'returns expected value' ); + x = [-0.0, -0.0, -0.0, 0.0]; + v = range(x.length, toAccessorArray(x), 1, 0); + t.strictEqual(isPositiveZero(v), true, '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 = [5.0, 5.0, 5.0]; + v = range(x.length, toAccessorArray(x), 1, 0); + t.strictEqual(v, 0.0, 'returns expected value'); t.end(); }); -tape( 'if provided an `N` parameter equal to `1`, the function returns `0` or `NaN`', function test( t ) { +tape('if provided an `N` parameter equal to `1`, the function returns `0` or `NaN`', function test(t) { var x; var v; - x = [ 1.0, -2.0, -4.0, 5.0, 3.0 ]; - - v = range( 1, x, 1, 0 ); - t.strictEqual( v, 0.0, 'returns expected value' ); - - x = [ NaN, -2.0, -4.0, 5.0, 3.0 ]; - - v = range( 1, x, 1, 0 ); - t.strictEqual( isnan( v ), true, 'returns expected value' ); + x = [1.0, -2.0, -4.0, 5.0, 3.0]; + v = range(1, x, 1, 0); + t.strictEqual(v, 0.0, 'returns expected value'); t.end(); }); -tape( 'the function supports a `stride` parameter', function test( t ) { - var N; +tape('the function supports a `stride` parameter', function test(t) { var x; var v; @@ -115,15 +123,13 @@ 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.strictEqual(v, 6.0, 'returns expected value'); t.end(); }); -tape( 'the function supports a negative `stride` parameter', function test( t ) { - var N; +tape('the function supports a negative `stride` parameter', function test(t) { var x; var v; @@ -132,38 +138,42 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) 2.0, 2.0, // 2 -7.0, - -2.0, // 1 + 3.0, // 1 3.0, 4.0, // 0 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.strictEqual(v, 3, 'returns expected value'); t.end(); }); -tape( 'if provided a `stride` parameter equal to `0`, the function returns `0` or `NaN`', function test( t ) { +tape('if provided a `stride` parameter equal to `0`, the function returns `0` or `NaN`', function test(t) { var x; var v; - x = [ 1.0, -2.0, -4.0, 5.0, 3.0 ]; + x = [1.0, -2.0, -4.0, 5.0, 3.0]; + + v = range(x.length, x, 0, 0); + t.strictEqual(v, 0.0, 'returns expected value'); + t.end(); +}); - v = range( x.length, x, 0, 0 ); - t.strictEqual( v, 0.0, 'returns expected value' ); +tape('if provided a `stride` parameter equal to `0`, the function returns the first indexed element (accessor)', function test(t) { + var x; + var v; - x = [ NaN, -2.0, -4.0, 5.0, 3.0 ]; + x = [1.0, -2.0, -4.0, -5.0, -6.0]; - v = range( x.length, x, 0, 0 ); - t.strictEqual( isnan( v ), true, 'returns expected value' ); + v = range(x.length, toAccessorArray(x), 0, 0); + t.strictEqual(v, 0, 'returns expected value'); t.end(); }); -tape( 'the function supports an `offset` parameter', function test( t ) { - var N; +tape('the function supports an `offset` parameter', function test(t) { var x; var v; @@ -177,10 +187,30 @@ 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 ); - t.strictEqual( v, 6.0, 'returns expected value' ); + v = range(4, x, 2, 1); + t.strictEqual(v, 6.0, 'returns expected value'); + + t.end(); +}); + +tape('the function supports an `offset` parameter (accessor)', function test(t) { + var x; + var v; + + x = [ + 2.0, + 1.0, // 0 + 2.0, + 2.0, // 1 + -2.0, + 3.0, // 2 + 3.0, + 4.0 // 3 + ]; + + v = range(4, toAccessorArray(x), 2, 1); + t.ok(v, 3.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..f8ec56267d36 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 @@ -23,6 +23,7 @@ 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 range = require( './../lib/range.js' ); @@ -124,7 +125,6 @@ tape( 'the function supports a `stride` parameter', function test( t ) { }); tape( 'the function supports a negative `stride` parameter', function test( t ) { - var N; var x; var v; @@ -139,10 +139,9 @@ 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.strictEqual(v, 6, 'returns expected value'); t.end(); }); @@ -163,10 +162,21 @@ 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 the first element (accessor)', function test( t ) { + var x; + var v; + + x = [ 1.0, -2.0, -4.0, -5.0, -6.0 ]; + + v = range( x.length, toAccessorArray( x ), 0 ); + t.strictEqual(isnan(v), false, '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([ @@ -181,10 +191,9 @@ tape( 'the function supports view offsets', function test( t ) { 6.0 ]); - x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element - N = floor(x1.length / 2); + x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); - v = range( N, x1, 2 ); + v = range( 4, x1, 2 ); t.strictEqual( v, 6.0, 'returns expected value' ); t.end();