From 665a8fc04f1e8e4d89b52e7599bf0c51112d5563 Mon Sep 17 00:00:00 2001 From: gururaj1512 Date: Wed, 11 Jun 2025 13:24:44 +0000 Subject: [PATCH 1/2] feat: add support for accessor arrays and refactor `stats/base/nanmean` --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed --- --- .../@stdlib/stats/base/nanmean/README.md | 65 ++++---- .../stats/base/nanmean/benchmark/benchmark.js | 31 ++-- .../nanmean/benchmark/benchmark.ndarray.js | 29 ++-- .../@stdlib/stats/base/nanmean/docs/repl.txt | 36 ++--- .../stats/base/nanmean/docs/types/index.d.ts | 19 ++- .../stats/base/nanmean/docs/types/test.ts | 3 + .../stats/base/nanmean/examples/index.js | 21 ++- .../@stdlib/stats/base/nanmean/lib/index.js | 9 +- .../@stdlib/stats/base/nanmean/lib/nanmean.js | 12 +- .../@stdlib/stats/base/nanmean/lib/ndarray.js | 15 +- .../stats/base/nanmean/test/test.nanmean.js | 148 ++++++++++++++++-- .../stats/base/nanmean/test/test.ndarray.js | 144 +++++++++++++++-- 12 files changed, 389 insertions(+), 143 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/nanmean/README.md b/lib/node_modules/@stdlib/stats/base/nanmean/README.md index b92e6429f100..e1429ee72eda 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmean/README.md +++ b/lib/node_modules/@stdlib/stats/base/nanmean/README.md @@ -51,15 +51,14 @@ The [arithmetic mean][arithmetic-mean] is defined as var nanmean = require( '@stdlib/stats/base/nanmean' ); ``` -#### nanmean( N, x, stride ) +#### nanmean( N, x, strideX ) -Computes the [arithmetic mean][arithmetic-mean] of a strided array `x`, ignoring `NaN` values. +Computes the [arithmetic mean][arithmetic-mean] of a strided array, ignoring `NaN` values. ```javascript var x = [ 1.0, -2.0, NaN, 2.0 ]; -var N = x.length; -var v = nanmean( N, x, 1 ); +var v = nanmean( x.length, x, 1 ); // returns ~0.3333 ``` @@ -67,62 +66,52 @@ 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 [arithmetic mean][arithmetic-mean] 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 [arithmetic mean][arithmetic-mean] 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 ]; -var N = floor( x.length / 2 ); -var v = nanmean( N, x, 2 ); +var v = nanmean( 4, x, 2 ); // returns 1.25 ``` 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, 2.0, 3.0, 4.0, NaN ] ); +var x0 = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] ); var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element -var N = floor( x0.length / 2 ); - -var v = nanmean( N, x1, 2 ); +var v = nanmean( 5, x1, 2 ); // returns 1.25 ``` -#### nanmean.ndarray( N, x, stride, offset ) +#### nanmean.ndarray( N, x, strideX, offsetX ) Computes the [arithmetic mean][arithmetic-mean] of a strided array, ignoring `NaN` values and using alternative indexing semantics. ```javascript var x = [ 1.0, -2.0, NaN, 2.0 ]; -var N = x.length; -var v = nanmean.ndarray( N, x, 1, 0 ); +var v = nanmean.ndarray( x.length, x, 1, 0 ); // returns ~0.33333 ``` 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 [arithmetic mean][arithmetic-mean] 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 [arithmetic mean][arithmetic-mean] 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, NaN ]; -var N = floor( x.length / 2 ); +var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ]; -var v = nanmean.ndarray( N, x, 2, 1 ); +var v = nanmean.ndarray( 5, x, 2, 1 ); // returns 1.25 ``` @@ -136,6 +125,7 @@ var v = nanmean.ndarray( N, x, 2, 1 ); - If `N <= 0`, both functions return `NaN`. - If every indexed element is `NaN`, 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 ([`dnanmean`][@stdlib/stats/strided/dnanmean], [`snanmean`][@stdlib/stats/base/snanmean], etc.) are likely to be significantly more performant. @@ -149,22 +139,19 @@ var v = nanmean.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 nanmean = require( '@stdlib/stats/base/nanmean' ); -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 = nanmean( x.length, x, 1 ); @@ -201,6 +188,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/dnanmean]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dnanmean diff --git a/lib/node_modules/@stdlib/stats/base/nanmean/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/nanmean/benchmark/benchmark.js index ef3fa875a09b..4864a0f84910 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmean/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/nanmean/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 nanmean = require( './../lib/nanmean.js' ); +var nanmean = require( './../lib/main.js' ); // FUNCTIONS // +/** +* Returns a random number. +* +* @private +* @returns {number} random number +*/ +function rand() { + if ( bernoulli( 0.8 ) < 1 ) { + return NaN; + } + return uniform( -10.0, 10.0 ); +} + /** * Creates a benchmark function. * @@ -38,17 +53,7 @@ var nanmean = require( './../lib/nanmean.js' ); * @returns {Function} benchmark function */ function createBenchmark( len ) { - var x; - var i; - - x = []; - for ( i = 0; i < len; i++ ) { - if ( randu() < 0.2 ) { - x.push( NaN ); - } else { - x.push( ( randu()*20.0 ) - 10.0 ); - } - } + var x = filledarrayBy( len, 'generic', rand ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/stats/base/nanmean/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/base/nanmean/benchmark/benchmark.ndarray.js index 7c4a3f720a21..74422824dadc 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmean/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/nanmean/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 nanmean = require( './../lib/ndarray.js' ); // FUNCTIONS // +/** +* Returns a random number. +* +* @private +* @returns {number} random number +*/ +function rand() { + if ( bernoulli( 0.8 ) < 1 ) { + return NaN; + } + return uniform( -10.0, 10.0 ); +} + /** * Creates a benchmark function. * @@ -38,17 +53,7 @@ var nanmean = require( './../lib/ndarray.js' ); * @returns {Function} benchmark function */ function createBenchmark( len ) { - var x; - var i; - - x = []; - for ( i = 0; i < len; i++ ) { - if ( randu() < 0.2 ) { - x.push( NaN ); - } else { - x.push( ( randu()*20.0 ) - 10.0 ); - } - } + var x = filledarrayBy( len, 'generic', rand ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/stats/base/nanmean/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/nanmean/docs/repl.txt index c77e53abda7c..f355f72010e7 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmean/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/nanmean/docs/repl.txt @@ -1,9 +1,9 @@ -{{alias}}( N, x, stride ) +{{alias}}( N, x, strideX ) Computes the arithmetic mean 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. @@ -20,8 +20,8 @@ x: Array|TypedArray Input array. - stride: integer - Index increment. + strideX: integer + Stride length. Returns ------- @@ -35,22 +35,19 @@ > {{alias}}( x.length, x, 1 ) ~0.3333 - // Using `N` and `stride` parameters: + // Using `N` and stride parameters: > x = [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, NaN ]; - > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 ); - > var stride = 2; - > {{alias}}( N, x, stride ) + > {{alias}}( 4, x, 2 ) ~0.3333 // Using view offsets: - > var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN ] ); + > 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 ) ~-0.3333 -{{alias}}.ndarray( N, x, stride, offset ) + +{{alias}}.ndarray( N, x, strideX, offsetX ) Computes the arithmetic mean of a strided array, ignoring `NaN` values and using alternative indexing semantics. @@ -66,10 +63,10 @@ x: Array|TypedArray Input array. - stride: integer - Index increment. + strideX: integer + Stride length. - offset: integer + offsetX: integer Starting index. Returns @@ -85,9 +82,8 @@ ~0.3333 // Using offset parameter: - > var x = [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN ]; - > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 ); - > {{alias}}.ndarray( N, x, 2, 1 ) + > var x = [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ]; + > {{alias}}.ndarray( 4, x, 2, 1 ) ~-0.3333 See Also diff --git a/lib/node_modules/@stdlib/stats/base/nanmean/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/nanmean/docs/types/index.d.ts index 7649d05724c7..bc224d2be877 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmean/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/nanmean/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 `nanmean`. @@ -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 arithmetic mean * * @example @@ -40,15 +45,15 @@ interface Routine { * var v = nanmean( x.length, x, 1 ); * // returns ~0.3333 */ - ( N: number, x: NumericArray, stride: number ): number; + ( N: number, x: InputArray, strideX: number ): number; /** * Computes the arithmetic mean of a strided array, ignoring `NaN` values and using alternative indexing semantics. * * @param N - number of indexed elements * @param x - input array - * @param stride - stride length - * @param offset - starting index + * @param strideX - stride length + * @param offsetX - starting index * @returns arithmetic mean * * @example @@ -57,7 +62,7 @@ interface Routine { * var v = nanmean.ndarray( x.length, x, 1, 0 ); * // returns ~0.3333 */ - ndarray( N: number, x: NumericArray, stride: number, offset: number ): number; + ndarray( N: number, x: InputArray, strideX: number, offsetX: number ): number; } /** @@ -65,7 +70,7 @@ interface Routine { * * @param N - number of indexed elements * @param x - input array -* @param stride - stride length +* @param strideX - stride length * @returns arithmetic mean * * @example diff --git a/lib/node_modules/@stdlib/stats/base/nanmean/docs/types/test.ts b/lib/node_modules/@stdlib/stats/base/nanmean/docs/types/test.ts index 493b45b36a2b..7f8f1288bc14 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmean/docs/types/test.ts +++ b/lib/node_modules/@stdlib/stats/base/nanmean/docs/types/test.ts @@ -16,6 +16,7 @@ * limitations under the License. */ +import AccessorArray = require( '@stdlib/array/base/accessor' ); import nanmean = require( './index' ); @@ -26,6 +27,7 @@ import nanmean = require( './index' ); const x = new Float64Array( 10 ); nanmean( x.length, x, 1 ); // $ExpectType number + nanmean( 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 nanmean = require( './index' ); const x = new Float64Array( 10 ); nanmean.ndarray( x.length, x, 1, 0 ); // $ExpectType number + nanmean.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/nanmean/examples/index.js b/lib/node_modules/@stdlib/stats/base/nanmean/examples/index.js index ce9f11af382d..921313259795 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmean/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/nanmean/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 nanmean = 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 = nanmean( x.length, x, 1 ); diff --git a/lib/node_modules/@stdlib/stats/base/nanmean/lib/index.js b/lib/node_modules/@stdlib/stats/base/nanmean/lib/index.js index 41324649159c..dca0f1ff159a 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmean/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/nanmean/lib/index.js @@ -27,19 +27,16 @@ * var nanmean = require( '@stdlib/stats/base/nanmean' ); * * var x = [ 1.0, -2.0, NaN, 2.0 ]; -* var N = x.length; * -* var v = nanmean( N, x, 1 ); +* var v = nanmean( x.length, x, 1 ); * // returns ~0.3333 * * @example -* var floor = require( '@stdlib/math/base/special/floor' ); * var nanmean = require( '@stdlib/stats/base/nanmean' ); * -* var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN ]; -* var N = floor( x.length / 2 ); +* var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ]; * -* var v = nanmean.ndarray( N, x, 2, 1 ); +* var v = nanmean.ndarray( 5, x, 2, 1 ); * // returns 1.25 */ diff --git a/lib/node_modules/@stdlib/stats/base/nanmean/lib/nanmean.js b/lib/node_modules/@stdlib/stats/base/nanmean/lib/nanmean.js index 698b2a3a9cbe..56c5b0fee922 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmean/lib/nanmean.js +++ b/lib/node_modules/@stdlib/stats/base/nanmean/lib/nanmean.js @@ -20,7 +20,8 @@ // MODULES // -var nanmeanpn = require( '@stdlib/stats/base/nanmeanpn' ); +var stride2offset = require( '@stdlib/strided/base/stride2offset' ); +var ndarray = require( './ndarray.js' ); // MAIN // @@ -30,18 +31,17 @@ var nanmeanpn = require( '@stdlib/stats/base/nanmeanpn' ); * * @param {PositiveInteger} N - number of indexed elements * @param {NumericArray} x - input array -* @param {integer} stride - stride length +* @param {integer} strideX - stride length * @returns {number} arithmetic mean * * @example * var x = [ 1.0, -2.0, NaN, 2.0 ]; -* var N = x.length; * -* var v = nanmean( N, x, 1 ); +* var v = nanmean( x.length, x, 1 ); * // returns ~0.3333 */ -function nanmean( N, x, stride ) { - return nanmeanpn( N, x, stride ); +function nanmean( N, x, strideX ) { + return ndarray( N, x, strideX, stride2offset( N, strideX ) ); } diff --git a/lib/node_modules/@stdlib/stats/base/nanmean/lib/ndarray.js b/lib/node_modules/@stdlib/stats/base/nanmean/lib/ndarray.js index ad313aeda0f9..5857307f1555 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmean/lib/ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/nanmean/lib/ndarray.js @@ -30,21 +30,18 @@ var nanmeanpn = require( '@stdlib/stats/base/nanmeanpn' ).ndarray; * * @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} arithmetic mean * * @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 x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN ]; -* var N = floor( x.length / 2 ); -* -* var v = nanmean( N, x, 2, 1 ); +* var v = nanmean( 5, x, 2, 1 ); * // returns 1.25 */ -function nanmean( N, x, stride, offset ) { - return nanmeanpn( N, x, stride, offset ); +function nanmean( N, x, strideX, offsetX ) { + return nanmeanpn( N, x, strideX, offsetX ); } diff --git a/lib/node_modules/@stdlib/stats/base/nanmean/test/test.nanmean.js b/lib/node_modules/@stdlib/stats/base/nanmean/test/test.nanmean.js index 2a65158bf545..78f5b80e8b25 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmean/test/test.nanmean.js +++ b/lib/node_modules/@stdlib/stats/base/nanmean/test/test.nanmean.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 Float64Array = require( '@stdlib/array/float64' ); +var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' ); var nanmean = require( './../lib/nanmean.js' ); @@ -62,6 +62,28 @@ tape( 'the function calculates the arithmetic mean of a strided array', function t.end(); }); +tape( 'the function calculates the arithmetic mean 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 = nanmean( x.length, toAccessorArray( x ), 1 ); + t.strictEqual( v, 0.5, 'returns expected value' ); + + x = [ -4.0, NaN ]; + + v = nanmean( x.length, toAccessorArray( x ), 1 ); + t.strictEqual( v, -4.0, 'returns expected value' ); + + x = [ NaN, NaN ]; + + v = nanmean( 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; @@ -77,6 +99,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 = nanmean( 0, toAccessorArray( x ), 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + v = nanmean( -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 the first element', function test( t ) { var x; var v; @@ -89,8 +126,19 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns the first t.end(); }); +tape( 'if provided an `N` parameter equal to `1`, the function returns the first element (accessors)', function test( t ) { + var x; + var v; + + x = [ 1.0, -2.0, -4.0, 5.0, 3.0 ]; + + v = nanmean( 1, toAccessorArray( x ), 1 ); + t.strictEqual( v, 1.0, 'returns expected value' ); + + t.end(); +}); + tape( 'the function supports a `stride` parameter', function test( t ) { - var N; var x; var v; @@ -107,15 +155,36 @@ tape( 'the function supports a `stride` parameter', function test( t ) { NaN ]; - N = floor( x.length / 2 ); - v = nanmean( N, x, 2 ); + v = nanmean( 5, x, 2 ); + + t.strictEqual( v, 1.25, '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 = nanmean( 5, toAccessorArray( x ), 2 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); }); tape( 'the function supports a negative `stride` parameter', function test( t ) { - var N; var x; var v; @@ -132,8 +201,30 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) NaN ]; - N = floor( x.length / 2 ); - v = nanmean( N, x, -2 ); + v = nanmean( 5, x, -2 ); + + t.strictEqual( v, 1.25, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a negative `stride` parameter (accessors)', function test( t ) { + var x; + var v; + + x = [ + 1.0, // 4 + 2.0, + 2.0, // 3 + -7.0, + -2.0, // 2 + 3.0, + 4.0, // 1 + 2.0, + NaN, // 0 + NaN + ]; + + v = nanmean( 5, toAccessorArray( x ), -2 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); @@ -151,10 +242,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 (accessors)', function test( t ) { + var x; + var v; + + x = [ 1.0, -2.0, -4.0, 5.0, 3.0 ]; + + v = nanmean( 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([ @@ -172,9 +274,35 @@ tape( 'the function supports view offsets', function test( t ) { ]); x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element - N = floor(x1.length / 2); - v = nanmean( N, x1, 2 ); + v = nanmean( 5, x1, 2 ); + t.strictEqual( v, 1.25, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports view offsets (accessors)', function test( t ) { + var x0; + var x1; + var v; + + x0 = new Float64Array([ + 2.0, + 1.0, // 0 + 2.0, + -2.0, // 1 + -2.0, + 2.0, // 2 + 3.0, + 4.0, // 3 + 6.0, + NaN, // 4 + NaN + ]); + + x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element + + v = nanmean( 5, toAccessorArray( x1 ), 2 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); diff --git a/lib/node_modules/@stdlib/stats/base/nanmean/test/test.ndarray.js b/lib/node_modules/@stdlib/stats/base/nanmean/test/test.ndarray.js index b358cb5bcbd0..9956e1900c3a 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmean/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/nanmean/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 nanmean = require( './../lib/ndarray.js' ); @@ -61,6 +61,28 @@ tape( 'the function calculates the arithmetic mean of a strided array', function t.end(); }); +tape( 'the function calculates the arithmetic mean 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 = nanmean( x.length, toAccessorArray( x ), 1, 0 ); + t.strictEqual( v, 0.5, 'returns expected value' ); + + x = [ -4.0, NaN ]; + + v = nanmean( x.length, toAccessorArray( x ), 1, 0 ); + t.strictEqual( v, -4.0, 'returns expected value' ); + + x = [ NaN, NaN ]; + + v = nanmean( 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; @@ -76,6 +98,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 = nanmean( 0, toAccessorArray( x ), 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + v = nanmean( -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 the first indexed element', function test( t ) { var x; var v; @@ -88,8 +125,19 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns the first t.end(); }); +tape( 'if provided an `N` parameter equal to `1`, the function returns the first indexed element (accessors)', function test( t ) { + var x; + var v; + + x = [ 1.0, -2.0, -4.0, 5.0, 3.0 ]; + + v = nanmean( 1, toAccessorArray( x ), 1, 0 ); + t.strictEqual( v, 1.0, 'returns expected value' ); + + t.end(); +}); + tape( 'the function supports a `stride` parameter', function test( t ) { - var N; var x; var v; @@ -106,15 +154,36 @@ tape( 'the function supports a `stride` parameter', function test( t ) { NaN ]; - N = floor( x.length / 2 ); - v = nanmean( N, x, 2, 0 ); + v = nanmean( 5, x, 2, 0 ); + + t.strictEqual( v, 1.25, '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 = nanmean( 5, toAccessorArray( x ), 2, 0 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); }); tape( 'the function supports a negative `stride` parameter', function test( t ) { - var N; var x; var v; @@ -131,8 +200,30 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) NaN ]; - N = floor( x.length / 2 ); - v = nanmean( N, x, -2, 8 ); + v = nanmean( 5, x, -2, 8 ); + + t.strictEqual( v, 1.25, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a negative `stride` parameter (accessors)', function test( t ) { + var x; + var v; + + x = [ + 1.0, // 4 + 2.0, + 2.0, // 3 + -7.0, + -2.0, // 2 + 3.0, + 4.0, // 1 + 2.0, + NaN, // 0 + NaN + ]; + + v = nanmean( 5, toAccessorArray( x ), -2, 8 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); @@ -150,8 +241,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 (accessors)', function test( t ) { + var x; + var v; + + x = [ 1.0, -2.0, -4.0, 5.0, 3.0 ]; + + v = nanmean( 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; @@ -167,9 +269,31 @@ tape( 'the function supports an `offset` parameter', function test( t ) { NaN, NaN // 4 ]; - N = floor( x.length / 2 ); - v = nanmean( N, x, 2, 1 ); + v = nanmean( 5, x, 2, 1 ); + t.strictEqual( v, 1.25, '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 = nanmean( 5, toAccessorArray( x ), 2, 1 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); From 1f82b410d8e8b1beded0b6a02ae3507c9fc5bc30 Mon Sep 17 00:00:00 2001 From: Athan Date: Thu, 12 Jun 2025 01:06:32 -0700 Subject: [PATCH 2/2] docs: avoid duplicate declaration Signed-off-by: Athan --- lib/node_modules/@stdlib/stats/base/nanmean/docs/repl.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/nanmean/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/nanmean/docs/repl.txt index f355f72010e7..0d5383b1c3d2 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmean/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/nanmean/docs/repl.txt @@ -82,7 +82,7 @@ ~0.3333 // Using offset parameter: - > var x = [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ]; + > x = [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ]; > {{alias}}.ndarray( 4, x, 2, 1 ) ~-0.3333