diff --git a/lib/node_modules/@stdlib/stats/base/mediansorted/README.md b/lib/node_modules/@stdlib/stats/base/mediansorted/README.md index a280307318bd..279a1a02e9b5 100644 --- a/lib/node_modules/@stdlib/stats/base/mediansorted/README.md +++ b/lib/node_modules/@stdlib/stats/base/mediansorted/README.md @@ -36,7 +36,7 @@ limitations under the License. var mediansorted = require( '@stdlib/stats/base/mediansorted' ); ``` -#### mediansorted( N, x, stride ) +#### mediansorted( N, x, strideX ) Computes the median value of a sorted 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 median value 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 median 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, 3.0, 3.0, 4.0, 2.0 ]; -var N = floor( x.length / 2 ); -var v = mediansorted( N, x, 2 ); +var v = mediansorted( 4, x, 2 ); // returns 2.5 ``` @@ -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 = mediansorted( N, x1, 2 ); +var v = mediansorted( 4, x1, 2 ); // returns 2.0 ``` -#### mediansorted.ndarray( N, x, stride, offset ) +#### mediansorted.ndarray( N, x, strideX, offsetX ) Computes the median value of a sorted strided array using alternative indexing semantics. @@ -98,17 +92,14 @@ var v = mediansorted.ndarray( x.length, 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 median 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 median value 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 = mediansorted.ndarray( N, x, 2, 1 ); +var v = mediansorted.ndarray( 4, x, 2, 1 ); // returns 2.0 ``` @@ -122,6 +113,7 @@ var v = mediansorted.ndarray( N, x, 2, 1 ); - If `N <= 0`, both functions return `NaN`. - The input strided array must be sorted in either **strictly** ascending or descending order. +- 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]). @@ -134,16 +126,10 @@ var v = mediansorted.ndarray( N, x, 2, 1 ); ```javascript -var Float64Array = require( '@stdlib/array/float64' ); +var linspace = require( '@stdlib/array/base/linspace' ); var mediansorted = require( '@stdlib/stats/base/mediansorted' ); -var x; -var i; - -x = new Float64Array( 10 ); -for ( i = 0; i < x.length; i++ ) { - x[ i ] = i - 5.0; -} +var x = linspace( -5.0, 5.0, 10 ); console.log( x ); var v = mediansorted( x.length, x, 1 ); @@ -178,6 +164,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/dmediansorted]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dmediansorted diff --git a/lib/node_modules/@stdlib/stats/base/mediansorted/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/mediansorted/benchmark/benchmark.js index 4c7c57728dcc..bdfbce0fa523 100644 --- a/lib/node_modules/@stdlib/stats/base/mediansorted/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/mediansorted/benchmark/benchmark.js @@ -22,6 +22,7 @@ var bench = require( '@stdlib/bench' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var linspace = require( '@stdlib/array/base/linspace' ); var pow = require( '@stdlib/math/base/special/pow' ); var pkg = require( './../package.json' ).name; var mediansorted = require( './../lib/mediansorted.js' ); @@ -37,13 +38,7 @@ var mediansorted = require( './../lib/mediansorted.js' ); * @returns {Function} benchmark function */ function createBenchmark( len ) { - var x; - var i; - - x = []; - for ( i = 0; i < len; i++ ) { - x.push( i ); - } + var x = linspace( 0.0, len, len ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/stats/base/mediansorted/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/base/mediansorted/benchmark/benchmark.ndarray.js index 5ecad817bf16..cf6077b2dac9 100644 --- a/lib/node_modules/@stdlib/stats/base/mediansorted/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/mediansorted/benchmark/benchmark.ndarray.js @@ -22,6 +22,7 @@ var bench = require( '@stdlib/bench' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var linspace = require( '@stdlib/array/base/linspace' ); var pow = require( '@stdlib/math/base/special/pow' ); var pkg = require( './../package.json' ).name; var mediansorted = require( './../lib/ndarray.js' ); @@ -37,13 +38,7 @@ var mediansorted = require( './../lib/ndarray.js' ); * @returns {Function} benchmark function */ function createBenchmark( len ) { - var x; - var i; - - x = []; - for ( i = 0; i < len; i++ ) { - x.push( i ); - } + var x = linspace( 0.0, len, len ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/stats/base/mediansorted/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/mediansorted/docs/repl.txt index 307019343630..236b2f21a124 100644 --- a/lib/node_modules/@stdlib/stats/base/mediansorted/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/mediansorted/docs/repl.txt @@ -1,12 +1,12 @@ -{{alias}}( N, x, stride ) +{{alias}}( N, x, strideX ) Computes the median value of a sorted strided array. The input strided array must be sorted in either strictly ascending or descending order. - 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. @@ -21,8 +21,8 @@ x: Array|TypedArray Sorted input array. - stride: integer - Index increment. + strideX: integer + Stride length. Returns ------- @@ -36,20 +36,19 @@ > {{alias}}( x.length, 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 ]; - > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 ); - > {{alias}}( N, x, 2 ) + > {{alias}}( 3, x, 2 ) 1.0 // Using view offsets: > var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, 3.0 ] ); > var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); - > N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 ); - > {{alias}}( N, x1, 2 ) + > {{alias}}( 3, x1, 2 ) 2.0 -{{alias}}.ndarray( N, x, stride, offset ) + +{{alias}}.ndarray( N, x, strideX, offsetX ) Computes the median value of a sorted strided array using alternative indexing semantics. @@ -65,10 +64,10 @@ x: Array|TypedArray Sorted input array. - stride: integer - Index increment. + strideX: integer + Stride length. - offset: integer + offsetX: integer Starting index. Returns @@ -85,8 +84,7 @@ // Using offset parameter: > var x = [ 1.0, -2.0, 3.0, 2.0, 5.0, 3.0 ]; - > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 ); - > {{alias}}.ndarray( N, x, 2, 1 ) + > {{alias}}.ndarray( 3, x, 2, 1 ) 2.0 See Also diff --git a/lib/node_modules/@stdlib/stats/base/mediansorted/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/mediansorted/docs/types/index.d.ts index 0eae488ed199..e081ca8e07d2 100644 --- a/lib/node_modules/@stdlib/stats/base/mediansorted/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/mediansorted/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 `mediansorted`. @@ -31,7 +36,7 @@ interface Routine { * * @param N - number of indexed elements * @param x - sorted input array - * @param stride - stride length + * @param strideX - stride length * @returns median value * * @example @@ -40,15 +45,15 @@ interface Routine { * var v = mediansorted( x.length, x, 1 ); * // returns 2.0 */ - ( N: number, x: NumericArray, stride: number ): number; + ( N: number, x: InputArray, strideX: number ): number; /** * Computes the median value of a sorted strided array using alternative indexing semantics. * * @param N - number of indexed elements * @param x - sorted input array - * @param stride - stride length - * @param offset - starting index + * @param strideX - stride length + * @param offsetX - starting index * @returns median value * * @example @@ -57,7 +62,7 @@ interface Routine { * var v = mediansorted.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 - sorted input array -* @param stride - stride length +* @param strideX - stride length * @returns median value * * @example diff --git a/lib/node_modules/@stdlib/stats/base/mediansorted/docs/types/test.ts b/lib/node_modules/@stdlib/stats/base/mediansorted/docs/types/test.ts index 32a8c0b7e21f..41a3e2f79b2b 100644 --- a/lib/node_modules/@stdlib/stats/base/mediansorted/docs/types/test.ts +++ b/lib/node_modules/@stdlib/stats/base/mediansorted/docs/types/test.ts @@ -16,6 +16,7 @@ * limitations under the License. */ +import AccessorArray = require( '@stdlib/array/base/accessor' ); import mediansorted = require( './index' ); @@ -26,6 +27,7 @@ import mediansorted = require( './index' ); const x = new Float64Array( 10 ); mediansorted( x.length, x, 1 ); // $ExpectType number + mediansorted( 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... @@ -86,6 +88,7 @@ import mediansorted = require( './index' ); const x = new Float64Array( 10 ); mediansorted.ndarray( x.length, x, 1, 0 ); // $ExpectType number + mediansorted.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/mediansorted/examples/index.js b/lib/node_modules/@stdlib/stats/base/mediansorted/examples/index.js index 57ba83e4098f..fe172ee9a39d 100644 --- a/lib/node_modules/@stdlib/stats/base/mediansorted/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/mediansorted/examples/index.js @@ -18,16 +18,10 @@ 'use strict'; -var Float64Array = require( '@stdlib/array/float64' ); +var linspace = require( '@stdlib/array/base/linspace' ); var mediansorted = require( './../lib' ); -var x; -var i; - -x = new Float64Array( 10 ); -for ( i = 0; i < x.length; i++ ) { - x[ i ] = i - 5.0; -} +var x = linspace( -5.0, 5.0, 10 ); console.log( x ); var v = mediansorted( x.length, x, 1 ); diff --git a/lib/node_modules/@stdlib/stats/base/mediansorted/lib/accessors.js b/lib/node_modules/@stdlib/stats/base/mediansorted/lib/accessors.js new file mode 100644 index 000000000000..c05acad137e9 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/mediansorted/lib/accessors.js @@ -0,0 +1,77 @@ +/** +* @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 floor = require( '@stdlib/math/base/special/floor' ); + + +// MAIN // + +/** +* Computes the median value of a sorted strided array. +* +* @private +* @param {PositiveInteger} N - number of indexed elements +* @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} median value +* +* @example +* var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' ); +* var arraylike2object = require( '@stdlib/array/base/arraylike2object' ); +* +* var x = toAccessorArray( [ 2.0, -3.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] ); +* +* var v = mediansorted( 4, arraylike2object( x ), 2, 1 ); +* // returns 0.0 +*/ +function mediansorted( N, x, strideX, offsetX ) { + var xbuf; + var xget; + var n; + var m; + + // Cache references to array data: + xbuf = x.data; + + // Cache references to element accessors: + xget = x.accessors[ 0 ]; + + if ( N <= 0 ) { + return NaN; + } + n = N / 2; + m = floor( n ); + if ( n === m ) { + // Even number of elements... + return ( xget( xbuf, offsetX+(m * strideX) ) + xget( xbuf, offsetX+((m-1) * strideX) ) ) / 2.0; + } + // Odd number of elements... + return xget( xbuf, offsetX+(m * strideX) ); +} + + +// EXPORTS // + +module.exports = mediansorted; diff --git a/lib/node_modules/@stdlib/stats/base/mediansorted/lib/mediansorted.js b/lib/node_modules/@stdlib/stats/base/mediansorted/lib/mediansorted.js index 40615767309d..8a2d49f32385 100644 --- a/lib/node_modules/@stdlib/stats/base/mediansorted/lib/mediansorted.js +++ b/lib/node_modules/@stdlib/stats/base/mediansorted/lib/mediansorted.js @@ -20,7 +20,8 @@ // MODULES // -var floor = require( '@stdlib/math/base/special/floor' ); +var stride2offset = require( '@stdlib/strided/base/stride2offset' ); +var ndarray = require( './ndarray.js' ); // MAIN // @@ -30,7 +31,7 @@ var floor = require( '@stdlib/math/base/special/floor' ); * * @param {PositiveInteger} N - number of indexed elements * @param {NumericArray} x - sorted input array -* @param {integer} stride - stride length +* @param {integer} strideX - strideX length * @returns {number} median value * * @example @@ -39,27 +40,8 @@ var floor = require( '@stdlib/math/base/special/floor' ); * var v = mediansorted( x.length, x, 1 ); * // returns 2.0 */ -function mediansorted( N, x, stride ) { - var offset; - var n; - var m; - - if ( N <= 0 ) { - return NaN; - } - if ( stride < 0 ) { - offset = (1-N) * stride; - } else { - offset = 0; - } - n = N / 2; - m = floor( n ); - if ( n === m ) { - // Even number of elements... - return ( x[ offset+(m*stride) ] + x[ offset+((m-1)*stride) ] ) / 2.0; - } - // Odd number of elements... - return x[ offset+(m*stride) ]; +function mediansorted( N, x, strideX ) { + return ndarray( N, x, strideX, stride2offset( N, strideX ) ); } diff --git a/lib/node_modules/@stdlib/stats/base/mediansorted/lib/ndarray.js b/lib/node_modules/@stdlib/stats/base/mediansorted/lib/ndarray.js index 5a56b5cd12c9..038397760e56 100644 --- a/lib/node_modules/@stdlib/stats/base/mediansorted/lib/ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/mediansorted/lib/ndarray.js @@ -21,6 +21,8 @@ // MODULES // var floor = require( '@stdlib/math/base/special/floor' ); +var arraylike2object = require( '@stdlib/array/base/arraylike2object' ); +var accessors = require( './accessors.js' ); // MAIN // @@ -30,34 +32,36 @@ var floor = require( '@stdlib/math/base/special/floor' ); * * @param {PositiveInteger} N - number of indexed elements * @param {NumericArray} x - sorted input array -* @param {integer} stride - stride length -* @param {NonNegativeInteger} offset - starting index +* @param {integer} strideX - stride length +* @param {NonNegativeInteger} offsetX - starting index * @returns {number} median value * * @example -* var floor = require( '@stdlib/math/base/special/floor' ); -* * var x = [ 2.0, -3.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ]; -* var N = floor( x.length / 2 ); * -* var v = mediansorted( N, x, 2, 1 ); +* var v = mediansorted( 4, x, 2, 1 ); * // returns 0.0 */ -function mediansorted( N, x, stride, offset ) { +function mediansorted( N, x, strideX, offsetX ) { var n; var m; + var o; if ( N <= 0 ) { return NaN; } + o = arraylike2object( x ); + if ( o.accessorProtocol ) { + return accessors( N, o, strideX, offsetX ); + } n = N / 2; m = floor( n ); if ( n === m ) { // Even number of elements... - return ( x[ offset+(m*stride) ] + x[ offset+((m-1)*stride) ] ) / 2.0; + return ( x[ offsetX+(m*strideX) ] + x[ offsetX+((m-1)*strideX) ] ) / 2.0; } // Odd number of elements... - return x[ offset+(m*stride) ]; + return x[ offsetX+(m*strideX) ]; } diff --git a/lib/node_modules/@stdlib/stats/base/mediansorted/test/test.mediansorted.js b/lib/node_modules/@stdlib/stats/base/mediansorted/test/test.mediansorted.js index 061d9feeb057..884e8ac26bb5 100644 --- a/lib/node_modules/@stdlib/stats/base/mediansorted/test/test.mediansorted.js +++ b/lib/node_modules/@stdlib/stats/base/mediansorted/test/test.mediansorted.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 isNegativeZero = require( '@stdlib/math/base/assert/is-negative-zero' ); var Float64Array = require( '@stdlib/array/float64' ); var mediansorted = require( './../lib/mediansorted.js' ); @@ -92,6 +92,57 @@ tape( 'the function calculates the median value of a sorted strided array', func t.end(); }); +tape( 'the function calculates the median value of a sorted strided array (accessor)', function test( t ) { + var x; + var v; + + x = [ -3.0, -2.0, -1.0, 1.0, 2.0, 3.0 ]; + v = mediansorted( x.length, toAccessorArray( x ), 1 ); + t.strictEqual( v, 0.0, 'returns expected value' ); + + x = [ 3.0, 2.0, 1.0, -1.0, -2.0, -3.0 ]; + v = mediansorted( x.length, toAccessorArray( x ), 1 ); + t.strictEqual( v, 0.0, 'returns expected value' ); + + x = [ -4.0, -5.0 ]; + v = mediansorted( x.length, toAccessorArray( x ), 1 ); + t.strictEqual( v, -4.5, 'returns expected value' ); + + x = [ -4.0, -4.0 ]; + v = mediansorted( x.length, toAccessorArray( x ), 1 ); + t.strictEqual( v, -4.0, 'returns expected value' ); + + x = [ -0.0, -0.0, 0.0 ]; + v = mediansorted( x.length, toAccessorArray( x ), 1 ); + t.strictEqual( isNegativeZero( v ), true, 'returns expected value' ); + + x = [ -0.0, -0.0, -0.0, 0.0 ]; + v = mediansorted( x.length, toAccessorArray( x ), 1 ); + t.strictEqual( isNegativeZero( v ), true, 'returns expected value' ); + + x = [ 0.0, -0.0, -0.0 ]; + v = mediansorted( x.length, toAccessorArray( x ), 1 ); + t.strictEqual( isNegativeZero( v ), true, 'returns expected value' ); + + x = [ NaN ]; + v = mediansorted( x.length, toAccessorArray( x ), 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN, NaN ]; + v = mediansorted( x.length, toAccessorArray( x ), 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ 5.0, NaN ]; + v = mediansorted( x.length, toAccessorArray( x ), 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN, 5.0 ]; + v = mediansorted( 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; @@ -120,7 +171,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; @@ -135,15 +185,34 @@ tape( 'the function supports a `stride` parameter', function test( t ) { 2.0 ]; - N = floor( x.length / 2 ); - v = mediansorted( N, x, 2 ); + v = mediansorted( 4, toAccessorArray( x ), 2 ); + + t.strictEqual( v, 2.5, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a `stride` parameter (accessor)', function test( t ) { + var x; + var v; + + x = [ + 1.0, // 0 + 2.0, + 2.0, // 1 + -7.0, + 3.0, // 2 + 3.0, + 4.0, // 3 + 2.0 + ]; + + v = mediansorted( 4, toAccessorArray( x ), 2 ); t.strictEqual( v, 2.5, 'returns expected value' ); t.end(); }); tape( 'the function supports a negative `stride` parameter', function test( t ) { - var N; var x; var v; @@ -158,8 +227,28 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) 2.0 ]; - N = floor( x.length / 2 ); - v = mediansorted( N, x, -2 ); + v = mediansorted( 4, x, -2 ); + + t.strictEqual( v, 2.5, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a negative `stride` parameter (accessor)', function test( t ) { + var x; + var v; + + x = [ + 1.0, // 3 + 2.0, + 2.0, // 2 + -7.0, + 3.0, // 1 + 3.0, + 4.0, // 0 + 2.0 + ]; + + v = mediansorted( 4, toAccessorArray( x ), -2 ); t.strictEqual( v, 2.5, 'returns expected value' ); t.end(); @@ -177,10 +266,21 @@ tape( 'if provided a `stride` parameter equal to `0`, the function returns the f 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 = mediansorted( x.length, toAccessorArray( x ), 0 ); + t.strictEqual( v, 1.0, '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([ @@ -196,9 +296,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 = mediansorted( N, x1, 2 ); + v = mediansorted( 4, x1, 2 ); + t.strictEqual( v, 2.5, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports view offsets (accessor)', function test( t ) { + var x0; + var x1; + var v; + + x0 = new Float64Array([ + 2.0, + 1.0, // 0 + 2.0, + 2.0, // 1 + -2.0, + 3.0, // 2 + 3.0, + 4.0, // 3 + 6.0 + ]); + + x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element + + v = mediansorted( 4, toAccessorArray( x1 ), 2 ); t.strictEqual( v, 2.5, 'returns expected value' ); t.end(); diff --git a/lib/node_modules/@stdlib/stats/base/mediansorted/test/test.ndarray.js b/lib/node_modules/@stdlib/stats/base/mediansorted/test/test.ndarray.js index 3def7fc27f4c..ad8932dd3def 100644 --- a/lib/node_modules/@stdlib/stats/base/mediansorted/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/mediansorted/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 mediansorted = require( './../lib/ndarray.js' ); @@ -91,6 +91,57 @@ tape( 'the function calculates the median value of a sorted strided array', func t.end(); }); +tape( 'the function calculates the median value of a sorted strided array (accessor)', function test( t ) { + var x; + var v; + + x = [ -3.0, -2.0, -1.0, 1.0, 2.0, 3.0 ]; + v = mediansorted( x.length, toAccessorArray( x ), 1, 0 ); + t.strictEqual( v, 0.0, 'returns expected value' ); + + x = [ 3.0, 2.0, 1.0, 0.0, -1.0, -2.0, -3.0 ]; + v = mediansorted( x.length, toAccessorArray( x ), 1, 0 ); + t.strictEqual( v, 0.0, 'returns expected value' ); + + x = [ -4.0, -5.0 ]; + v = mediansorted( x.length, toAccessorArray( x ), 1, 0 ); + t.strictEqual( v, -4.5, 'returns expected value' ); + + x = [ -4.0, -4.0 ]; + v = mediansorted( x.length, toAccessorArray( x ), 1, 0 ); + t.strictEqual( v, -4.0, 'returns expected value' ); + + x = [ -0.0, -0.0, 0.0 ]; + v = mediansorted( x.length, toAccessorArray( x ), 1, 0 ); + t.strictEqual( isNegativeZero( v ), true, 'returns expected value' ); + + x = [ -0.0, -0.0, -0.0, 0.0 ]; + v = mediansorted( x.length, toAccessorArray( x ), 1, 0 ); + t.strictEqual( isNegativeZero( v ), true, 'returns expected value' ); + + x = [ 0.0, -0.0, -0.0 ]; + v = mediansorted( x.length, toAccessorArray( x ), 1, 0 ); + t.strictEqual( isNegativeZero( v ), true, 'returns expected value' ); + + x = [ NaN ]; + v = mediansorted( x.length, toAccessorArray( x ), 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN, NaN ]; + v = mediansorted( x.length, toAccessorArray( x ), 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ 5.0, NaN ]; + v = mediansorted( x.length, toAccessorArray( x ), 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN, 5.0 ]; + v = mediansorted( 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; @@ -119,7 +170,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; @@ -134,15 +184,34 @@ tape( 'the function supports a `stride` parameter', function test( t ) { 2.0 ]; - N = floor( x.length / 2 ); - v = mediansorted( N, x, 2, 0 ); + v = mediansorted( 4, x, 2, 0 ); + + t.strictEqual( v, 2.5, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a `stride` parameter (accessor)', function test( t ) { + var x; + var v; + + x = [ + 1.0, // 0 + 2.0, + 2.0, // 1 + -7.0, + 3.0, // 2 + 3.0, + 4.0, // 3 + 2.0 + ]; + + v = mediansorted( 4, toAccessorArray( x ), 2, 0 ); t.strictEqual( v, 2.5, 'returns expected value' ); t.end(); }); tape( 'the function supports a negative `stride` parameter', function test( t ) { - var N; var x; var v; @@ -157,8 +226,28 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) 2.0 ]; - N = floor( x.length / 2 ); - v = mediansorted( N, x, -2, 6 ); + v = mediansorted( 4, x, -2, 6 ); + + t.strictEqual( v, 2.5, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a negative `stride` parameter (accessor)', function test( t ) { + var x; + var v; + + x = [ + 1.0, // 3 + 2.0, + 2.0, // 2 + -7.0, + 3.0, // 1 + 3.0, + 4.0, // 0 + 2.0 + ]; + + v = mediansorted( 4, toAccessorArray( x ), -2, 6 ); t.strictEqual( v, 2.5, 'returns expected value' ); t.end(); @@ -176,8 +265,19 @@ tape( 'if provided a `stride` parameter equal to `0`, the function returns the f t.end(); }); +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 = [ 1.0, -2.0, -4.0, -5.0, -6.0 ]; + + v = mediansorted( x.length, toAccessorArray( x ), 0, 0 ); + t.strictEqual( v, 1.0, 'returns expected value' ); + + t.end(); +}); + tape( 'the function supports an `offset` parameter', function test( t ) { - var N; var x; var v; @@ -191,9 +291,29 @@ tape( 'the function supports an `offset` parameter', function test( t ) { 3.0, 4.0 // 3 ]; - N = floor( x.length / 2 ); - v = mediansorted( N, x, 2, 1 ); + v = mediansorted( 4, x, 2, 1 ); + t.strictEqual( v, 2.5, '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 = mediansorted( 4, toAccessorArray( x ), 2, 1 ); t.strictEqual( v, 2.5, 'returns expected value' ); t.end();