From 32e9189b91c573f13cc455c26f7e1afe256e3002 Mon Sep 17 00:00:00 2001 From: Rahul Kumar Date: Tue, 1 Apr 2025 16:31:52 +0000 Subject: [PATCH 1/3] feat: add accessor protocol support and refactor stats/base/nanmeanors --- 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/nanmeanors/README.md | 65 ++++------ .../base/nanmeanors/benchmark/benchmark.js | 29 +++-- .../nanmeanors/benchmark/benchmark.ndarray.js | 29 +++-- .../stats/base/nanmeanors/docs/repl.txt | 36 +++--- .../base/nanmeanors/docs/types/index.d.ts | 19 ++- .../stats/base/nanmeanors/docs/types/test.ts | 3 + .../stats/base/nanmeanors/examples/index.js | 21 ++- .../stats/base/nanmeanors/lib/accessors.js | 81 ++++++++++++ .../stats/base/nanmeanors/lib/nanmeanors.js | 42 ++---- .../stats/base/nanmeanors/lib/ndarray.js | 25 +++- .../base/nanmeanors/test/test.nanmeanors.js | 121 ++++++++++++++++-- .../base/nanmeanors/test/test.ndarray.js | 117 +++++++++++++++-- 12 files changed, 427 insertions(+), 161 deletions(-) create mode 100644 lib/node_modules/@stdlib/stats/base/nanmeanors/lib/accessors.js diff --git a/lib/node_modules/@stdlib/stats/base/nanmeanors/README.md b/lib/node_modules/@stdlib/stats/base/nanmeanors/README.md index afd3f304ec19..3f192161733d 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmeanors/README.md +++ b/lib/node_modules/@stdlib/stats/base/nanmeanors/README.md @@ -51,15 +51,14 @@ The [arithmetic mean][arithmetic-mean] is defined as var nanmeanors = require( '@stdlib/stats/base/nanmeanors' ); ``` -#### nanmeanors( N, x, stride ) +#### nanmeanors( N, x, strideX ) Computes the [arithmetic mean][arithmetic-mean] of a strided array `x`, ignoring `NaN` values and using ordinary recursive summation. ```javascript var x = [ 1.0, -2.0, NaN, 2.0 ]; -var N = x.length; -var v = nanmeanors( N, x, 1 ); +var v = nanmeanors( 4, 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 arrays 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, NaN ]; -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 = nanmeanors( N, x, 2 ); +var v = nanmeanors( 5, 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 = nanmeanors( N, x1, 2 ); +var v = nanmeanors( 5, x1, 2 ); // returns 1.25 ``` -#### nanmeanors.ndarray( N, x, stride, offset ) +#### nanmeanors.ndarray( N, x, strideX, offsetX ) Computes the [arithmetic mean][arithmetic-mean] of a strided array, ignoring `NaN` values and using ordinary recursive summation and alternative indexing semantics. ```javascript var x = [ 1.0, -2.0, NaN, 2.0 ]; -var N = x.length; -var v = nanmeanors.ndarray( N, x, 1, 0 ); +var v = nanmeanors.ndarray( 4, 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 parameters support 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 ```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, 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 = nanmeanors.ndarray( N, x, 2, 1 ); +var v = nanmeanors.ndarray( 5, x, 2, 1 ); // returns 1.25 ``` @@ -137,6 +126,7 @@ var v = nanmeanors.ndarray( N, x, 2, 1 ); - If `N <= 0`, both functions return `NaN`. - If every indexed element is `NaN`, both functions return `NaN`. - Ordinary recursive summation (i.e., a "simple" sum) is performant, but can incur significant numerical error. If performance is paramount and error tolerated, using ordinary recursive summation to compute an arithmetic mean is acceptable; in all other cases, exercise due caution. +- 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 ([`dnanmeanors`][@stdlib/stats/strided/dnanmeanors], [`snanmeanors`][@stdlib/stats/strided/snanmeanors], etc.) are likely to be significantly more performant. @@ -150,22 +140,19 @@ var v = nanmeanors.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 nanmeanors = require( '@stdlib/stats/base/nanmeanors' ); -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, 'generic', rand ); console.log( x ); var v = nanmeanors( x.length, x, 1 ); @@ -219,6 +206,8 @@ console.log( v ); [@stdlib/stats/strided/snanmeanors]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/snanmeanors +[@stdlib/array/base/accessor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/accessor + diff --git a/lib/node_modules/@stdlib/stats/base/nanmeanors/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/nanmeanors/benchmark/benchmark.js index 0c4132b328db..8797087bebf2 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmeanors/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/nanmeanors/benchmark/benchmark.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 nanmeanors = require( './../lib/nanmeanors.js' ); // FUNCTIONS // +/** +* Returns a random value or `NaN`. +* +* @private +* @returns {number} random number or `NaN` +*/ +function rand() { + if ( bernoulli( 0.8 ) < 1 ) { + return NaN; + } + return uniform( -10.0, 10.0 ); +} + /** * Creates a benchmark function. * @@ -38,17 +53,7 @@ var nanmeanors = require( './../lib/nanmeanors.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/nanmeanors/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/base/nanmeanors/benchmark/benchmark.ndarray.js index 772c2fbf0b3b..658cafb9a76d 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmeanors/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/nanmeanors/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 nanmeanors = require( './../lib/ndarray.js' ); // FUNCTIONS // +/** +* Returns a random value or `NaN`. +* +* @private +* @returns {number} random number or `NaN` +*/ +function rand() { + if ( bernoulli( 0.8 ) < 1 ) { + return NaN; + } + return uniform( -10.0, 10.0 ); +} + /** * Creates a benchmark function. * @@ -38,17 +53,7 @@ var nanmeanors = 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/nanmeanors/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/nanmeanors/docs/repl.txt index f0ba9a8a8d82..4e9ba7896877 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmeanors/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/nanmeanors/docs/repl.txt @@ -1,10 +1,10 @@ -{{alias}}( N, x, stride ) +{{alias}}( N, x, strideX ) Computes the arithmetic mean of a strided array, ignoring `NaN` values and using ordinary recursive summation. - 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 Input array. - stride: integer - Index increment. + strideX: integer + Stride length. Returns ------- @@ -33,25 +33,22 @@ -------- // Standard Usage: > var x = [ 1.0, -2.0, NaN, 2.0 ]; - > {{alias}}( x.length, x, 1 ) + > {{alias}}( 4, 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}}( 3, 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 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 ) ~-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 ordinary recursive summation and alternative indexing semantics. @@ -67,10 +64,10 @@ x: Array|TypedArray Input array. - stride: integer - Index increment. + strideX: integer + Stride length. - offset: integer + offsetX: integer Starting index. Returns @@ -82,13 +79,12 @@ -------- // Standard Usage: > var x =[ 1.0, -2.0, NaN, 2.0 ]; - > {{alias}}.ndarray( x.length, x, 1, 0 ) + > {{alias}}.ndarray( 4, x, 1, 0 ) ~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 ) + > {{alias}}.ndarray( 3, x, 2, 1 ) ~-0.3333 See Also diff --git a/lib/node_modules/@stdlib/stats/base/nanmeanors/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/nanmeanors/docs/types/index.d.ts index b6d0cdcbaafb..588f79f2d8f8 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmeanors/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/nanmeanors/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 `nanmeanors`. @@ -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 = nanmeanors( 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 ordinary recursive summation and 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 = nanmeanors.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/nanmeanors/docs/types/test.ts b/lib/node_modules/@stdlib/stats/base/nanmeanors/docs/types/test.ts index f0c698f7af8c..d7ede7d82520 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmeanors/docs/types/test.ts +++ b/lib/node_modules/@stdlib/stats/base/nanmeanors/docs/types/test.ts @@ -16,6 +16,7 @@ * limitations under the License. */ +import AccessorArray = require( '@stdlib/array/base/accessor' ); import nanmeanors = require( './index' ); @@ -26,6 +27,7 @@ import nanmeanors = require( './index' ); const x = new Float64Array( 10 ); nanmeanors( x.length, x, 1 ); // $ExpectType number + nanmeanors( 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 nanmeanors = require( './index' ); const x = new Float64Array( 10 ); nanmeanors.ndarray( x.length, x, 1, 0 ); // $ExpectType number + nanmeanors.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/nanmeanors/examples/index.js b/lib/node_modules/@stdlib/stats/base/nanmeanors/examples/index.js index 72604cd58c1d..ec9e90feda73 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmeanors/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/nanmeanors/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 nanmeanors = 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, 'generic', rand ); console.log( x ); var v = nanmeanors( x.length, x, 1 ); diff --git a/lib/node_modules/@stdlib/stats/base/nanmeanors/lib/accessors.js b/lib/node_modules/@stdlib/stats/base/nanmeanors/lib/accessors.js new file mode 100644 index 000000000000..b954c75afe15 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/nanmeanors/lib/accessors.js @@ -0,0 +1,81 @@ +/** +* @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'; + +// MAIN // + +/** +* Computes the arithmetic mean of a strided array, ignoring `NaN` values and using ordinary recursive summation. +* +* @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 - stride length +* @param {NonNegativeInteger} offsetX - starting index +* @returns {number} arithmetic mean +* +* @example +* var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' ); +* var arraylike2object = require( '@stdlib/array/base/arraylike2object' ); +* +* var x = toAccessorArray( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] ); +* +* var v = nanmeanors( 5, arraylike2object( x ), 2, 1 ); +* // returns 1.25 +*/ +function nanmeanors( N, x, strideX, offsetX ) { + var xget; + var xbuf; + var sum; + var ix; + var v; + var n; + var i; + + // Cache references to array data: + xbuf = x.data; + + // Cache references to element accessors: + xget = x.accessors[ 0 ]; + + if ( N === 1 || strideX === 0 ) { + return xget( xbuf, offsetX ); + } + ix = offsetX; + sum = 0.0; + n = 0; + for ( i = 0; i < N; i++ ) { + v = xget( xbuf, ix ); + if ( v === v ) { + sum += v; + n += 1; + } + ix += strideX; + } + if ( n === 0 ) { + return NaN; + } + return sum / n; +} + + +// EXPORTS // + +module.exports = nanmeanors; diff --git a/lib/node_modules/@stdlib/stats/base/nanmeanors/lib/nanmeanors.js b/lib/node_modules/@stdlib/stats/base/nanmeanors/lib/nanmeanors.js index 2961ee183757..abe2accc787b 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmeanors/lib/nanmeanors.js +++ b/lib/node_modules/@stdlib/stats/base/nanmeanors/lib/nanmeanors.js @@ -18,6 +18,12 @@ 'use strict'; +// MODULES // + +var stride2offset = require( '@stdlib/strided/base/stride2offset' ); +var ndarray = require( './ndarray.js' ); + + // MAIN // /** @@ -25,7 +31,7 @@ * * @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 @@ -35,38 +41,8 @@ * var v = nanmeanors( N, x, 1 ); * // returns ~0.3333 */ -function nanmeanors( N, x, stride ) { - var sum; - var ix; - var v; - var n; - var i; - - if ( N <= 0 ) { - return NaN; - } - if ( N === 1 || stride === 0 ) { - return x[ 0 ]; - } - if ( stride < 0 ) { - ix = (1-N) * stride; - } else { - ix = 0; - } - sum = 0.0; - n = 0; - for ( i = 0; i < N; i++ ) { - v = x[ ix ]; - if ( v === v ) { - sum += v; - n += 1; - } - ix += stride; - } - if ( n === 0 ) { - return NaN; - } - return sum / n; +function nanmeanors( N, x, strideX ) { + return ndarray( N, x, strideX, stride2offset( N, strideX ) ); } diff --git a/lib/node_modules/@stdlib/stats/base/nanmeanors/lib/ndarray.js b/lib/node_modules/@stdlib/stats/base/nanmeanors/lib/ndarray.js index 3e60cfccd7f8..331aaa71fa3e 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmeanors/lib/ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/nanmeanors/lib/ndarray.js @@ -18,6 +18,12 @@ 'use strict'; +// MODULES // + +var arraylike2object = require( '@stdlib/array/base/arraylike2object' ); +var accessors = require( './accessors.js' ); + + // MAIN // /** @@ -25,8 +31,8 @@ * * @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 @@ -38,20 +44,25 @@ * var v = nanmeanors( N, x, 2, 1 ); * // returns 1.25 */ -function nanmeanors( N, x, stride, offset ) { +function nanmeanors( N, x, strideX, offsetX ) { var sum; var ix; var v; var n; var i; + var o; if ( N <= 0 ) { return NaN; } - if ( N === 1 || stride === 0 ) { - return x[ offset ]; + o = arraylike2object( x ); + if ( o.accessorProtocol ) { + return accessors( N, o, strideX, offsetX ); + } + if ( N === 1 || strideX === 0 ) { + return x[ offsetX ]; } - ix = offset; + ix = offsetX; sum = 0.0; n = 0; for ( i = 0; i < N; i++ ) { @@ -60,7 +71,7 @@ function nanmeanors( N, x, stride, offset ) { sum += v; n += 1; } - ix += stride; + ix += strideX; } if ( n === 0 ) { return NaN; diff --git a/lib/node_modules/@stdlib/stats/base/nanmeanors/test/test.nanmeanors.js b/lib/node_modules/@stdlib/stats/base/nanmeanors/test/test.nanmeanors.js index 088e46a8c667..779cb84039c0 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmeanors/test/test.nanmeanors.js +++ b/lib/node_modules/@stdlib/stats/base/nanmeanors/test/test.nanmeanors.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 Float64Array = require( '@stdlib/array/float64' ); var nanmeanors = require( './../lib/nanmeanors.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 = nanmeanors( x.length, toAccessorArray( x ), 1 ); + t.strictEqual( v, 0.5, 'returns expected value' ); + + x = [ -4.0, NaN ]; + + v = nanmeanors( x.length, toAccessorArray( x ), 1 ); + t.strictEqual( v, -4.0, 'returns expected value' ); + + x = [ NaN, NaN ]; + + v = nanmeanors( 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; @@ -90,7 +112,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; @@ -107,15 +128,36 @@ tape( 'the function supports a `stride` parameter', function test( t ) { NaN ]; - N = floor( x.length / 2 ); - v = nanmeanors( N, x, 2 ); + v = nanmeanors( 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 = nanmeanors( 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 +174,30 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) NaN ]; - N = floor( x.length / 2 ); - v = nanmeanors( N, x, -2 ); + v = nanmeanors( 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 = nanmeanors( 5, toAccessorArray( x ), -2 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); @@ -151,10 +215,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 = nanmeanors( 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 +247,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 = nanmeanors( N, x1, 2 ); + v = nanmeanors( 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 = nanmeanors( 5, toAccessorArray( x1 ), 2 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); diff --git a/lib/node_modules/@stdlib/stats/base/nanmeanors/test/test.ndarray.js b/lib/node_modules/@stdlib/stats/base/nanmeanors/test/test.ndarray.js index 04ac9e143a81..ea787a0c1373 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmeanors/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/nanmeanors/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 nanmeanors = 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 = nanmeanors( x.length, toAccessorArray( x ), 1, 0 ); + t.strictEqual( v, 0.5, 'returns expected value' ); + + x = [ -4.0, NaN ]; + + v = nanmeanors( x.length, toAccessorArray( x ), 1, 0 ); + t.strictEqual( v, -4.0, 'returns expected value' ); + + x = [ NaN, NaN ]; + + v = nanmeanors( 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; @@ -89,7 +111,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; @@ -106,15 +127,36 @@ tape( 'the function supports a `stride` parameter', function test( t ) { NaN ]; - N = floor( x.length / 2 ); - v = nanmeanors( N, x, 2, 0 ); + v = nanmeanors( 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 = nanmeanors( 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 +173,30 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) NaN ]; - N = floor( x.length / 2 ); - v = nanmeanors( N, x, -2, 8 ); + v = nanmeanors( 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 = nanmeanors( 5, toAccessorArray( x ), -2, 8 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); @@ -150,8 +214,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 = nanmeanors( 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 +242,31 @@ tape( 'the function supports an `offset` parameter', function test( t ) { NaN, NaN // 4 ]; - N = floor( x.length / 2 ); - v = nanmeanors( N, x, 2, 1 ); + v = nanmeanors( 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 = nanmeanors( 5, toAccessorArray( x ), 2, 1 ); t.strictEqual( v, 1.25, 'returns expected value' ); t.end(); From 0dbec030264642f7d737bf3b37bf1a49dcd5d1a8 Mon Sep 17 00:00:00 2001 From: Rahul Kumar Date: Mon, 7 Apr 2025 08:54:42 +0000 Subject: [PATCH 2/3] docs: ensure consistent conventions --- 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: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - 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: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../@stdlib/stats/base/nanmeanors/README.md | 4 ++-- .../@stdlib/stats/base/nanmeanors/docs/repl.txt | 12 ++++++------ .../@stdlib/stats/base/nanmeanors/lib/nanmeanors.js | 3 +-- .../@stdlib/stats/base/nanmeanors/lib/ndarray.js | 5 +---- 4 files changed, 10 insertions(+), 14 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/nanmeanors/README.md b/lib/node_modules/@stdlib/stats/base/nanmeanors/README.md index 3f192161733d..63226a004c5c 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmeanors/README.md +++ b/lib/node_modules/@stdlib/stats/base/nanmeanors/README.md @@ -68,7 +68,7 @@ The function has the following parameters: - **x**: input [`Array`][mdn-array] or [`typed array`][mdn-typed-array]. - **strideX**: stride length for `x`. -The `N` and stride parameters determine which elements in the strided arrays 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 x = [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0, NaN, NaN ]; @@ -106,7 +106,7 @@ The function has the following additional parameters: - **offsetX**: starting index for `x`. -While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support 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 value in `x` starting from the second value ```javascript var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ]; diff --git a/lib/node_modules/@stdlib/stats/base/nanmeanors/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/nanmeanors/docs/repl.txt index 4e9ba7896877..c1517c963deb 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmeanors/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/nanmeanors/docs/repl.txt @@ -37,14 +37,14 @@ ~0.3333 // Using `N` and stride parameters: - > x = [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, NaN ]; - > {{alias}}( 3, x, 2 ) + > x = [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, NaN, NaN ]; + > {{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 ); - > {{alias}}( 3, x1, 2 ) + > {{alias}}( 4, x1, 2 ) ~-0.3333 @@ -83,8 +83,8 @@ ~0.3333 // Using offset parameter: - > var x = [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN ]; - > {{alias}}.ndarray( 3, 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/nanmeanors/lib/nanmeanors.js b/lib/node_modules/@stdlib/stats/base/nanmeanors/lib/nanmeanors.js index abe2accc787b..b739b419517a 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmeanors/lib/nanmeanors.js +++ b/lib/node_modules/@stdlib/stats/base/nanmeanors/lib/nanmeanors.js @@ -36,9 +36,8 @@ var ndarray = require( './ndarray.js' ); * * @example * var x = [ 1.0, -2.0, NaN, 2.0 ]; -* var N = x.length; * -* var v = nanmeanors( N, x, 1 ); +* var v = nanmeanors( 4, x, 1 ); * // returns ~0.3333 */ function nanmeanors( N, x, strideX ) { diff --git a/lib/node_modules/@stdlib/stats/base/nanmeanors/lib/ndarray.js b/lib/node_modules/@stdlib/stats/base/nanmeanors/lib/ndarray.js index 331aaa71fa3e..e6eaeb15969e 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmeanors/lib/ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/nanmeanors/lib/ndarray.js @@ -36,12 +36,9 @@ var accessors = require( './accessors.js' ); * @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 ]; -* var N = floor( x.length / 2 ); * -* var v = nanmeanors( N, x, 2, 1 ); +* var v = nanmeanors( 4, x, 2, 1 ); * // returns 1.25 */ function nanmeanors( N, x, strideX, offsetX ) { From 7669478f2ea7c0f96935405208822d302800903f Mon Sep 17 00:00:00 2001 From: Rahul Kumar Date: Tue, 8 Apr 2025 13:30:31 +0000 Subject: [PATCH 3/3] refactor: ensure existing conventions for lib's files --- 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: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - 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: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../base/nanmeanors/benchmark/benchmark.js | 2 +- .../stats/base/nanmeanors/lib/index.js | 14 ++++-- .../@stdlib/stats/base/nanmeanors/lib/main.js | 21 ++++++-- .../stats/base/nanmeanors/lib/nanmeanors.js | 50 ------------------- .../test/{test.nanmeanors.js => test.main.js} | 2 +- 5 files changed, 29 insertions(+), 60 deletions(-) delete mode 100644 lib/node_modules/@stdlib/stats/base/nanmeanors/lib/nanmeanors.js rename lib/node_modules/@stdlib/stats/base/nanmeanors/test/{test.nanmeanors.js => test.main.js} (99%) diff --git a/lib/node_modules/@stdlib/stats/base/nanmeanors/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/nanmeanors/benchmark/benchmark.js index 8797087bebf2..ccfe949e9df1 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmeanors/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/nanmeanors/benchmark/benchmark.js @@ -27,7 +27,7 @@ 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 nanmeanors = require( './../lib/nanmeanors.js' ); +var nanmeanors = require( './../lib/main.js' ); // FUNCTIONS // diff --git a/lib/node_modules/@stdlib/stats/base/nanmeanors/lib/index.js b/lib/node_modules/@stdlib/stats/base/nanmeanors/lib/index.js index 62983a4539b6..b0d9a714fed2 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmeanors/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/nanmeanors/lib/index.js @@ -27,25 +27,29 @@ * var nanmeanors = require( '@stdlib/stats/base/nanmeanors' ); * * var x = [ 1.0, -2.0, NaN, 2.0 ]; -* var N = x.length; * -* var v = nanmeanors( N, x, 1 ); +* var v = nanmeanors( 4, x, 1 ); * // returns ~0.3333 * * @example -* var floor = require( '@stdlib/math/base/special/floor' ); * var nanmeanors = require( '@stdlib/stats/base/nanmeanors' ); * * 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 = nanmeanors.ndarray( N, x, 2, 1 ); +* var v = nanmeanors.ndarray( 4, x, 2, 1 ); * // returns 1.25 */ // 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/nanmeanors/lib/main.js b/lib/node_modules/@stdlib/stats/base/nanmeanors/lib/main.js index 0707e6695f22..b739b419517a 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmeanors/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/nanmeanors/lib/main.js @@ -20,14 +20,29 @@ // MODULES // -var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); -var nanmeanors = require( './nanmeanors.js' ); +var stride2offset = require( '@stdlib/strided/base/stride2offset' ); var ndarray = require( './ndarray.js' ); // MAIN // -setReadOnly( nanmeanors, 'ndarray', ndarray ); +/** +* Computes the arithmetic mean of a strided array, ignoring `NaN` values and using ordinary recursive summation. +* +* @param {PositiveInteger} N - number of indexed elements +* @param {NumericArray} x - input array +* @param {integer} strideX - stride length +* @returns {number} arithmetic mean +* +* @example +* var x = [ 1.0, -2.0, NaN, 2.0 ]; +* +* var v = nanmeanors( 4, x, 1 ); +* // returns ~0.3333 +*/ +function nanmeanors( N, x, strideX ) { + return ndarray( N, x, strideX, stride2offset( N, strideX ) ); +} // EXPORTS // diff --git a/lib/node_modules/@stdlib/stats/base/nanmeanors/lib/nanmeanors.js b/lib/node_modules/@stdlib/stats/base/nanmeanors/lib/nanmeanors.js deleted file mode 100644 index b739b419517a..000000000000 --- a/lib/node_modules/@stdlib/stats/base/nanmeanors/lib/nanmeanors.js +++ /dev/null @@ -1,50 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2020 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 stride2offset = require( '@stdlib/strided/base/stride2offset' ); -var ndarray = require( './ndarray.js' ); - - -// MAIN // - -/** -* Computes the arithmetic mean of a strided array, ignoring `NaN` values and using ordinary recursive summation. -* -* @param {PositiveInteger} N - number of indexed elements -* @param {NumericArray} x - input array -* @param {integer} strideX - stride length -* @returns {number} arithmetic mean -* -* @example -* var x = [ 1.0, -2.0, NaN, 2.0 ]; -* -* var v = nanmeanors( 4, x, 1 ); -* // returns ~0.3333 -*/ -function nanmeanors( N, x, strideX ) { - return ndarray( N, x, strideX, stride2offset( N, strideX ) ); -} - - -// EXPORTS // - -module.exports = nanmeanors; diff --git a/lib/node_modules/@stdlib/stats/base/nanmeanors/test/test.nanmeanors.js b/lib/node_modules/@stdlib/stats/base/nanmeanors/test/test.main.js similarity index 99% rename from lib/node_modules/@stdlib/stats/base/nanmeanors/test/test.nanmeanors.js rename to lib/node_modules/@stdlib/stats/base/nanmeanors/test/test.main.js index 779cb84039c0..d0f5821eedae 100644 --- a/lib/node_modules/@stdlib/stats/base/nanmeanors/test/test.nanmeanors.js +++ b/lib/node_modules/@stdlib/stats/base/nanmeanors/test/test.main.js @@ -24,7 +24,7 @@ var tape = require( 'tape' ); var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var Float64Array = require( '@stdlib/array/float64' ); -var nanmeanors = require( './../lib/nanmeanors.js' ); +var nanmeanors = require( './../lib/main.js' ); // TESTS //