From afa597be9db6de5ddd3d295c7dd1fa068c5ede9b Mon Sep 17 00:00:00 2001 From: Rahul Kumar Date: Tue, 18 Mar 2025 07:21:41 +0000 Subject: [PATCH 1/7] feat: add accessor protocol and refactor stats/base/nanvarianceyc --- 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 --- --- .../stats/base/nanvarianceyc/README.md | 51 ++--- .../base/nanvarianceyc/benchmark/benchmark.js | 29 +-- .../benchmark/benchmark.ndarray.js | 29 +-- .../stats/base/nanvarianceyc/docs/repl.txt | 36 ++-- .../base/nanvarianceyc/docs/types/index.d.ts | 19 +- .../base/nanvarianceyc/docs/types/test.ts | 5 +- .../base/nanvarianceyc/examples/index.js | 21 +- .../stats/base/nanvarianceyc/lib/accessors.js | 115 ++++++++++ .../base/nanvarianceyc/lib/nanvarianceyc.js | 68 +----- .../stats/base/nanvarianceyc/lib/ndarray.js | 34 +-- .../nanvarianceyc/test/test.nanvarianceyc.js | 203 +++++++++++++++++- .../base/nanvarianceyc/test/test.ndarray.js | 199 ++++++++++++++++- 12 files changed, 626 insertions(+), 183 deletions(-) create mode 100644 lib/node_modules/@stdlib/stats/base/nanvarianceyc/lib/accessors.js diff --git a/lib/node_modules/@stdlib/stats/base/nanvarianceyc/README.md b/lib/node_modules/@stdlib/stats/base/nanvarianceyc/README.md index f49d0ef84510..ef78d6fe8466 100644 --- a/lib/node_modules/@stdlib/stats/base/nanvarianceyc/README.md +++ b/lib/node_modules/@stdlib/stats/base/nanvarianceyc/README.md @@ -98,7 +98,7 @@ The use of the term `n-1` is commonly referred to as Bessel's correction. Note, var nanvarianceyc = require( '@stdlib/stats/base/nanvarianceyc' ); ``` -#### nanvarianceyc( N, correction, x, stride ) +#### nanvarianceyc( N, correction, x, strideX ) Computes the [variance][variance] of a strided array `x` ignoring `NaN` values and using a one-pass algorithm proposed by Youngs and Cramer. @@ -114,17 +114,14 @@ The function has the following parameters: - **N**: number of indexed elements. - **correction**: degrees of freedom adjustment. Setting this parameter to a value other than `0` has the effect of adjusting the divisor during the calculation of the [variance][variance] according to `n-c` where `c` corresponds to the provided degrees of freedom adjustment and `n` corresponds to the number of non-`NaN` indexed elements. When computing the [variance][variance] of a population, setting this parameter to `0` is the standard choice (i.e., the provided array contains data constituting an entire population). When computing the unbiased sample [variance][variance], setting this parameter to `1` is the standard choice (i.e., the provided array contains data sampled from a larger population; this is commonly referred to as Bessel's correction). - **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 [variance][variance] 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 [variance][variance] 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 = nanvarianceyc( N, 1, x, 2 ); +var v = nanvarianceyc( 4, 1, x, 2 ); // returns 6.25 ``` @@ -134,41 +131,35 @@ Note that indexing is relative to the first index. To introduce an offset, use [ ```javascript var Float64Array = require( '@stdlib/array/float64' ); -var floor = require( '@stdlib/math/base/special/floor' ); var x0 = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN ] ); var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element -var N = floor( x0.length / 2 ); - -var v = nanvarianceyc( N, 1, x1, 2 ); +var v = nanvarianceyc( 4, 1, x1, 2 ); // returns 6.25 ``` -#### nanvarianceyc.ndarray( N, correction, x, stride, offset ) +#### nanvarianceyc.ndarray( N, correction, x, strideX, offsetX ) Computes the [variance][variance] of a strided array ignoring `NaN` values and using a one-pass algorithm proposed by Youngs and Cramer and alternative indexing semantics. ```javascript var x = [ 1.0, -2.0, NaN, 2.0 ]; -var v = nanvarianceyc.ndarray( x.length, 1, x, 1, 0 ); +var v = nanvarianceyc.ndarray( 4, 1, x, 1, 0 ); // returns ~4.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 [variance][variance] 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 ]; -var N = floor( x.length / 2 ); - -var v = nanvarianceyc.ndarray( N, 1, x, 2, 1 ); +var v = nanvarianceyc.ndarray( 5, 1, x, 2, 1 ); // returns 6.25 ``` @@ -182,6 +173,7 @@ var v = nanvarianceyc.ndarray( N, 1, x, 2, 1 ); - If `N <= 0`, both functions return `NaN`. - If `n - c` is less than or equal to `0` (where `c` corresponds to the provided degrees of freedom adjustment and `n` corresponds to the number of non-`NaN` indexed elements), 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 ([`dnanvarianceyc`][@stdlib/stats/base/dnanvarianceyc], [`snanvarianceyc`][@stdlib/stats/base/snanvarianceyc], etc.) are likely to be significantly more performant. @@ -195,18 +187,19 @@ var v = nanvarianceyc.ndarray( N, 1, 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 nanvarianceyc = require( '@stdlib/stats/base/nanvarianceyc' ); -var x; -var i; - -x = new Float64Array( 10 ); -for ( i = 0; i < x.length; i++ ) { - 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 = nanvarianceyc( x.length, 1, x, 1 ); @@ -271,6 +264,8 @@ console.log( v ); [@stdlib/stats/base/varianceyc]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/varianceyc +[@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/nanvarianceyc/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/nanvarianceyc/benchmark/benchmark.js index 48e2969590fb..6f6b7865d1ac 100644 --- a/lib/node_modules/@stdlib/stats/base/nanvarianceyc/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/nanvarianceyc/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 nanvarianceyc = require( './../lib/nanvarianceyc.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 nanvarianceyc = require( './../lib/nanvarianceyc.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/nanvarianceyc/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/base/nanvarianceyc/benchmark/benchmark.ndarray.js index 912f11bddf5e..4af9132be37b 100644 --- a/lib/node_modules/@stdlib/stats/base/nanvarianceyc/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/nanvarianceyc/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 nanvarianceyc = 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 nanvarianceyc = 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/nanvarianceyc/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/nanvarianceyc/docs/repl.txt index adfb75d9d56a..4e62ca4c936e 100644 --- a/lib/node_modules/@stdlib/stats/base/nanvarianceyc/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/nanvarianceyc/docs/repl.txt @@ -1,10 +1,10 @@ -{{alias}}( N, correction, x, stride ) +{{alias}}( N, correction, x, strideX ) Computes the variance of a strided array ignoring `NaN` values and using a one-pass algorithm proposed by Youngs and Cramer. - 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. @@ -34,8 +34,8 @@ x: Array|TypedArray Input array. - stride: integer - Index increment. + strideX: integer + Stride length. Returns ------- @@ -46,25 +46,24 @@ -------- // Standard Usage: > var x = [ 1.0, -2.0, NaN, 2.0 ]; - > {{alias}}( x.length, 1, x, 1 ) + > {{alias}}( 4, 1, x, 1 ) ~4.3333 // Using `N` and `stride` parameters: > x = [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ]; - > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 ); - > var stride = 2; - > {{alias}}( N, 1, x, stride ) + > var strideX = 2; + > {{alias}}( 3, 1, x, strideX ) ~4.3333 // Using view offsets: > var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] ); > var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); - > N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 ); - > stride = 2; - > {{alias}}( N, 1, x1, stride ) + > strideX = 2; + > {{alias}}( 3, 1, x1, strideX ) ~4.3333 -{{alias}}.ndarray( N, correction, x, stride, offset ) + +{{alias}}.ndarray( N, correction, x, strideX, offsetX ) Computes the variance of a strided array ignoring `NaN` values and using a one-pass algorithm proposed by Youngs and Cramer and alternative indexing semantics. @@ -94,10 +93,10 @@ x: Array|TypedArray Input array. - stride: integer - Index increment. + strideX: integer + Stride length. - offset: integer + offsetX: integer Starting index. Returns @@ -109,13 +108,12 @@ -------- // Standard Usage: > var x = [ 1.0, -2.0, NaN, 2.0 ]; - > {{alias}}.ndarray( x.length, 1, x, 1, 0 ) + > {{alias}}.ndarray(4, 1, x, 1, 0 ) ~4.3333 // Using offset parameter: > var x = [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ]; - > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 ); - > {{alias}}.ndarray( N, 1, x, 2, 1 ) + > {{alias}}.ndarray( 3, 1, x, 2, 1 ) ~4.3333 See Also diff --git a/lib/node_modules/@stdlib/stats/base/nanvarianceyc/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/nanvarianceyc/docs/types/index.d.ts index 625d89045e4b..c290af26c167 100644 --- a/lib/node_modules/@stdlib/stats/base/nanvarianceyc/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/nanvarianceyc/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 `nanvarianceyc`. @@ -32,7 +37,7 @@ interface Routine { * @param N - number of indexed elements * @param correction - degrees of freedom adjustment * @param x - input array - * @param stride - stride length + * @param strideX - stride length * @returns variance * * @example @@ -41,7 +46,7 @@ interface Routine { * var v = nanvarianceyc( x.length, 1, x, 1 ); * // returns ~4.3333 */ - ( N: number, correction: number, x: NumericArray, stride: number ): number; + ( N: number, correction: number, x: InputArray, strideX: number ): number; /** * Computes the variance of a strided array ignoring `NaN` values and using a one-pass algorithm proposed by Youngs and Cramer and alternative indexing semantics. @@ -49,8 +54,8 @@ interface Routine { * @param N - number of indexed elements * @param correction - degrees of freedom adjustment * @param x - input array - * @param stride - stride length - * @param offset - starting index + * @param strideX - stride length + * @param offsetX - starting index * @returns variance * * @example @@ -59,7 +64,7 @@ interface Routine { * var v = nanvarianceyc.ndarray( x.length, 1, x, 1, 0 ); * // returns ~4.3333 */ - ndarray( N: number, correction: number, x: NumericArray, stride: number, offset: number ): number; + ndarray( N: number, correction: number, x: InputArray, strideX: number, offsetX: number ): number; } /** @@ -68,7 +73,7 @@ interface Routine { * @param N - number of indexed elements * @param correction - degrees of freedom adjustment * @param x - input array -* @param stride - stride length +* @param strideX - stride length * @returns variance * * @example diff --git a/lib/node_modules/@stdlib/stats/base/nanvarianceyc/docs/types/test.ts b/lib/node_modules/@stdlib/stats/base/nanvarianceyc/docs/types/test.ts index d2d5a25cce55..94962e732459 100644 --- a/lib/node_modules/@stdlib/stats/base/nanvarianceyc/docs/types/test.ts +++ b/lib/node_modules/@stdlib/stats/base/nanvarianceyc/docs/types/test.ts @@ -16,6 +16,7 @@ * limitations under the License. */ +import AccessorArray = require( '@stdlib/array/base/accessor' ); import nanvarianceyc = require( './index' ); @@ -25,7 +26,7 @@ import nanvarianceyc = require( './index' ); { const x = new Float64Array( 10 ); - nanvarianceyc( x.length, 1, x, 1 ); // $ExpectType number + nanvarianceyc( x.length, 1, new AccessorArray( x ), 1 ); // $ExpectType number } // The compiler throws an error if the function is provided a first argument which is not a number... @@ -100,7 +101,7 @@ import nanvarianceyc = require( './index' ); { const x = new Float64Array( 10 ); - nanvarianceyc.ndarray( x.length, 1, x, 1, 0 ); // $ExpectType number + nanvarianceyc.ndarray( x.length, 1, 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/nanvarianceyc/examples/index.js b/lib/node_modules/@stdlib/stats/base/nanvarianceyc/examples/index.js index b5611c02e5b7..91ef5c26f0bd 100644 --- a/lib/node_modules/@stdlib/stats/base/nanvarianceyc/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/nanvarianceyc/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 nanvarianceyc = 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 = nanvarianceyc( x.length, 1, x, 1 ); diff --git a/lib/node_modules/@stdlib/stats/base/nanvarianceyc/lib/accessors.js b/lib/node_modules/@stdlib/stats/base/nanvarianceyc/lib/accessors.js new file mode 100644 index 000000000000..8f866aac82e5 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/nanvarianceyc/lib/accessors.js @@ -0,0 +1,115 @@ +/** +* @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 variance of a strided array ignoring `NaN` values and using a one-pass algorithm proposed by Youngs and Cramer. +* +* ## Method +* +* - This implementation uses a one-pass algorithm, as proposed by Youngs and Cramer (1971). +* +* ## References +* +* - Youngs, Edward A., and Elliot M. Cramer. 1971. "Some Results Relevant to Choice of Sum and Sum-of-Product Algorithms." _Technometrics_ 13 (3): 657–65. doi:[10.1080/00401706.1971.10488826](https://doi.org/10.1080/00401706.1971.10488826). +* +* @param {PositiveInteger} N - number of indexed elements +* @param {number} correction - degrees of freedom adjustment +* @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} variance +* +* @example +* var arraylike2object = require( '@stdlib/array/base/arraylike2object' ); +* var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' ); +* +* var x = toAccessorArray( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] ); +* +* var v = nanvarianceyc( 5, 1, arraylike2object( x ), 2, 1 ); +* // returns 6.25 +*/ +function nanvarianceyc( N, correction, x, strideX, offsetX ) { + var xbuf; + var xget; + var sum; + var ix; + var nc; + var S; + var v; + var d; + 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 ) { + v = xget( xbuf, offsetX ); + if ( v === v && N-correction > 0.0 ) { + return 0.0; + } + return NaN; + } + ix = offsetX; + + // Find the first non-NaN element... + for ( i = 0; i < N; i++ ) { + v = xget( xbuf, ix ); + if ( v === v ) { + break; + } + ix += strideX; + } + if ( i === N ) { + return NaN; + } + ix += strideX; + sum = v; + S = 0.0; + i += 1; + n = 1; + for ( i; i < N; i++ ) { + v = xget( xbuf, ix ); + if ( v === v ) { + n += 1; + sum += v; + d = (n*v) - sum; + S += (1.0/(n*(n-1))) * d * d; + } + ix += strideX; + } + nc = n - correction; + if ( nc <= 0.0 ) { + return NaN; + } + return S / nc; +} + + +// EXPORTS // + +module.exports = nanvarianceyc; diff --git a/lib/node_modules/@stdlib/stats/base/nanvarianceyc/lib/nanvarianceyc.js b/lib/node_modules/@stdlib/stats/base/nanvarianceyc/lib/nanvarianceyc.js index 64ffa36700cd..a498dfc57773 100644 --- a/lib/node_modules/@stdlib/stats/base/nanvarianceyc/lib/nanvarianceyc.js +++ b/lib/node_modules/@stdlib/stats/base/nanvarianceyc/lib/nanvarianceyc.js @@ -18,6 +18,12 @@ 'use strict'; +// Modules + +var stride2offset = require( '@stdlib/strided/base/stride2offset' ); +var ndarray = require( './ndarray.js' ); + + // MAIN // /** @@ -34,71 +40,17 @@ * @param {PositiveInteger} N - number of indexed elements * @param {number} correction - degrees of freedom adjustment * @param {NumericArray} x - input array -* @param {integer} stride - stride length +* @param {integer} strideX - stride length * @returns {number} variance * * @example * var x = [ 1.0, -2.0, NaN, 2.0 ]; * -* var v = nanvarianceyc( x.length, 1, x, 1 ); +* var v = nanvarianceyc( 4, 1, x, 1 ); * // returns ~4.3333 */ -function nanvarianceyc( N, correction, x, stride ) { - var sum; - var ix; - var nc; - var S; - var v; - var d; - var n; - var i; - - if ( N <= 0 ) { - return NaN; - } - if ( N === 1 || stride === 0 ) { - v = x[ 0 ]; - if ( v === v && N-correction > 0.0 ) { - return 0.0; - } - return NaN; - } - if ( stride < 0 ) { - ix = (1-N) * stride; - } else { - ix = 0; - } - // Find the first non-NaN element... - for ( i = 0; i < N; i++ ) { - v = x[ ix ]; - if ( v === v ) { - break; - } - ix += stride; - } - if ( i === N ) { - return NaN; - } - ix += stride; - sum = v; - S = 0.0; - i += 1; - n = 1; - for ( i; i < N; i++ ) { - v = x[ ix ]; - if ( v === v ) { - n += 1; - sum += v; - d = (n*v) - sum; - S += (1.0/(n*(n-1))) * d * d; - } - ix += stride; - } - nc = n - correction; - if ( nc <= 0.0 ) { - return NaN; - } - return S / nc; +function nanvarianceyc( N, correction, x, strideX ) { + return ndarray( N, correction, x, strideX, stride2offset( N, strideX ) ); } diff --git a/lib/node_modules/@stdlib/stats/base/nanvarianceyc/lib/ndarray.js b/lib/node_modules/@stdlib/stats/base/nanvarianceyc/lib/ndarray.js index 7bab123988bf..1d38aad8ff4c 100644 --- a/lib/node_modules/@stdlib/stats/base/nanvarianceyc/lib/ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/nanvarianceyc/lib/ndarray.js @@ -18,6 +18,12 @@ 'use strict'; +// Modules + +var arraylike2object = require( '@stdlib/array/base/arraylike2object' ); +var accessors = require( './accessors.js' ); + + // MAIN // /** @@ -34,24 +40,22 @@ * @param {PositiveInteger} N - number of indexed elements * @param {number} correction - degrees of freedom adjustment * @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} variance * * @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 N = floor( x.length / 2 ); * -* var v = nanvarianceyc( N, 1, x, 2, 1 ); +* var v = nanvarianceyc( 5, 1, x, 2, 1 ); * // returns 6.25 */ -function nanvarianceyc( N, correction, x, stride, offset ) { +function nanvarianceyc( N, correction, x, strideX, offsetX ) { var sum; var ix; var nc; var S; + var o; var v; var d; var n; @@ -60,14 +64,18 @@ function nanvarianceyc( N, correction, x, stride, offset ) { if ( N <= 0 ) { return NaN; } - if ( N === 1 || stride === 0 ) { - v = x[ offset ]; + o = arraylike2object( x ); + if ( o.accessorProtocol ) { + return accessors( N, correction, o, strideX, offsetX ); + } + if ( N === 1 || strideX === 0 ) { + v = x[ offsetX ]; if ( v === v && N-correction > 0.0 ) { return 0.0; } return NaN; } - ix = offset; + ix = offsetX; // Find the first non-NaN element... for ( i = 0; i < N; i++ ) { @@ -75,12 +83,12 @@ function nanvarianceyc( N, correction, x, stride, offset ) { if ( v === v ) { break; } - ix += stride; + ix += strideX; } if ( i === N ) { return NaN; } - ix += stride; + ix += strideX; sum = v; S = 0.0; i += 1; @@ -93,7 +101,7 @@ function nanvarianceyc( N, correction, x, stride, offset ) { d = (n*v) - sum; S += (1.0/(n*(n-1))) * d * d; } - ix += stride; + ix += strideX; } nc = n - correction; if ( nc <= 0.0 ) { diff --git a/lib/node_modules/@stdlib/stats/base/nanvarianceyc/test/test.nanvarianceyc.js b/lib/node_modules/@stdlib/stats/base/nanvarianceyc/test/test.nanvarianceyc.js index 886b1e1866ee..d8d9fbda97d2 100644 --- a/lib/node_modules/@stdlib/stats/base/nanvarianceyc/test/test.nanvarianceyc.js +++ b/lib/node_modules/@stdlib/stats/base/nanvarianceyc/test/test.nanvarianceyc.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 nanvarianceyc = require( './../lib/nanvarianceyc.js' ); @@ -148,6 +148,114 @@ tape( 'the function calculates the sample variance of a strided array (ignoring t.end(); }); +tape( 'the function calculates the population variance of a strided array (ignoring `NaN` values) (accessors)', function test( t ) { + var x; + var v; + var i; + + x = [ 1.0, -2.0, -4.0, 5.0, NaN, 0.0, 3.0 ]; + + v = nanvarianceyc( x.length, 0, toAccessorArray( x ), 1 ); + t.strictEqual( v, 53.5/(x.length-1), 'returns expected value' ); + + x = [ 1.0, NaN, NaN, -2.0, NaN, -4.0, NaN, 5.0, NaN, 0.0, 3.0, NaN ]; + + v = nanvarianceyc( x.length, 0, toAccessorArray( x ), 1 ); + t.strictEqual( v, 53.5/(x.length-6), 'returns expected value' ); + + x = [ -4.0, NaN ]; + + v = nanvarianceyc( x.length, 0, toAccessorArray( x ), 1 ); + t.strictEqual( v, 0.0, 'returns expected value' ); + + x = [ NaN, NaN ]; + + v = nanvarianceyc( x.length, 0, toAccessorArray( x ), 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN ]; + v = nanvarianceyc( x.length, 0, toAccessorArray( x ), 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ 4.0 ]; + v = nanvarianceyc( x.length, 0, toAccessorArray( x ), 1 ); + t.strictEqual( v, 0.0, 'returns expected value' ); + + x = []; + for ( i = 0; i < 1e3; i++ ) { + x.push( 100.0 ); + } + v = nanvarianceyc( x.length, 0, toAccessorArray( x ), 1 ); + t.strictEqual( v, 0.0, 'returns expected value' ); + + x = [ NaN, NaN, NaN, NaN, NaN, NaN, NaN, NaN, NaN, NaN ]; + v = nanvarianceyc( x.length, 0, toAccessorArray( x ), 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = []; + for ( i = 0; i < 1e3; i++ ) { + x.push( NaN ); + } + v = nanvarianceyc( x.length, 0, toAccessorArray( x ), 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function calculates the sample variance of a strided array (ignoring `NaN` values) (accessors)', function test( t ) { + var x; + var v; + var i; + + x = [ 1.0, -2.0, -4.0, 5.0, NaN, 0.0, 3.0 ]; + + v = nanvarianceyc( x.length, 1, toAccessorArray( x ), 1 ); + t.strictEqual( v, 53.5/(x.length-2), 'returns expected value' ); + + x = [ 1.0, NaN, NaN, -2.0, NaN, -4.0, NaN, 5.0, NaN, 0.0, 3.0, NaN ]; + + v = nanvarianceyc( x.length, 1, toAccessorArray( x ), 1 ); + t.strictEqual( v, 53.5/(x.length-7), 'returns expected value' ); + + x = [ -4.0, NaN ]; + + v = nanvarianceyc( x.length, 1, toAccessorArray( x ), 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN, NaN ]; + + v = nanvarianceyc( x.length, 1, toAccessorArray( x ), 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN ]; + v = nanvarianceyc( x.length, 1, toAccessorArray( x ), 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ 4.0 ]; + v = nanvarianceyc( x.length, 1, toAccessorArray( x ), 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = []; + for ( i = 0; i < 1e3; i++ ) { + x.push( 100.0 ); + } + v = nanvarianceyc( x.length, 1, toAccessorArray( x ), 1 ); + t.strictEqual( v, 0.0, 'returns expected value' ); + + x = [ NaN, NaN, NaN, NaN, NaN, NaN, NaN, NaN, NaN, NaN ]; + v = nanvarianceyc( x.length, 1, toAccessorArray( x ), 1 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = []; + for ( i = 0; i < 1e3; i++ ) { + x.push( NaN ); + } + v = nanvarianceyc( x.length, 1, 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; @@ -213,7 +321,6 @@ tape( 'if provided a `correction` parameter yielding a correction term less than }); tape( 'the function supports a `stride` parameter', function test( t ) { - var N; var x; var v; @@ -230,15 +337,36 @@ tape( 'the function supports a `stride` parameter', function test( t ) { NaN ]; - N = floor( x.length / 2 ); - v = nanvarianceyc( N, 1, x, 2 ); + v = nanvarianceyc( 5, 1, x, 2 ); + + t.strictEqual( v, 6.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 = nanvarianceyc( 5, 1, toAccessorArray( x ), 2 ); t.strictEqual( v, 6.25, 'returns expected value' ); t.end(); }); tape( 'the function supports a negative `stride` parameter', function test( t ) { - var N; var x; var v; var i; @@ -255,9 +383,8 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) 4.0, // 0 2.0 ]; - N = floor( x.length / 2 ); - v = nanvarianceyc( N, 1, x, -2 ); + v = nanvarianceyc( 5, 1, x, -2 ); t.strictEqual( v, 6.25, 'returns expected value' ); x = []; @@ -270,6 +397,37 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) t.end(); }); +tape( 'the function supports a negative `stride` parameter (accessors)', function test( t ) { + var x; + var v; + var i; + + x = [ + NaN, // 4 + NaN, + 1.0, // 3 + 2.0, + 2.0, // 2 + -7.0, + -2.0, // 1 + 3.0, + 4.0, // 0 + 2.0 + ]; + + v = nanvarianceyc( 5, 1, toAccessorArray( x ), -2 ); + t.strictEqual( v, 6.25, 'returns expected value' ); + + x = []; + for ( i = 0; i < 1e3; i++ ) { + x.push( 100.0 ); + } + v = nanvarianceyc( x.length, 1, toAccessorArray( x ), -1 ); + t.strictEqual( v, 0.0, 'returns expected value' ); + + t.end(); +}); + tape( 'if provided a `stride` parameter equal to `0`, the function returns `0` provided the correction term is not less than `0` and the first element is not `NaN`', function test( t ) { var x; var v; @@ -295,7 +453,6 @@ tape( 'if provided a `stride` parameter equal to `0`, the function returns `0` p tape( 'the function supports view offsets', function test( t ) { var x0; var x1; - var N; var v; x0 = new Float64Array([ @@ -313,9 +470,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 = nanvarianceyc( N, 1, x1, 2 ); + v = nanvarianceyc( 5, 1, x1, 2 ); + t.strictEqual( v, 6.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 = nanvarianceyc( 5, 1, toAccessorArray( x1 ), 2 ); t.strictEqual( v, 6.25, 'returns expected value' ); t.end(); diff --git a/lib/node_modules/@stdlib/stats/base/nanvarianceyc/test/test.ndarray.js b/lib/node_modules/@stdlib/stats/base/nanvarianceyc/test/test.ndarray.js index b2964c11fe7f..6d53f4d5c427 100644 --- a/lib/node_modules/@stdlib/stats/base/nanvarianceyc/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/nanvarianceyc/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 nanvarianceyc = require( './../lib/ndarray.js' ); @@ -147,6 +147,114 @@ tape( 'the function calculates the sample variance of a strided array (ignoring t.end(); }); +tape( 'the function calculates the population variance of a strided array (ignoring `NaN` values) (accessors)', function test( t ) { + var x; + var v; + var i; + + x = [ 1.0, -2.0, -4.0, 5.0, NaN, 0.0, 3.0 ]; + + v = nanvarianceyc( x.length, 0, toAccessorArray( x ), 1, 0 ); + t.strictEqual( v, 53.5/(x.length-1), 'returns expected value' ); + + x = [ 1.0, NaN, NaN, -2.0, NaN, -4.0, NaN, 5.0, NaN, 0.0, 3.0, NaN ]; + + v = nanvarianceyc( x.length, 0, toAccessorArray( x ), 1, 0 ); + t.strictEqual( v, 53.5/(x.length-6), 'returns expected value' ); + + x = [ -4.0, NaN ]; + + v = nanvarianceyc( x.length, 0, toAccessorArray( x ), 1, 0 ); + t.strictEqual( v, 0.0, 'returns expected value' ); + + x = [ NaN, NaN ]; + + v = nanvarianceyc( x.length, 0, toAccessorArray( x ), 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN ]; + v = nanvarianceyc( x.length, 0, toAccessorArray( x ), 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ 4.0 ]; + v = nanvarianceyc( x.length, 0, toAccessorArray( x ), 1, 0 ); + t.strictEqual( v, 0.0, 'returns expected value' ); + + x = []; + for ( i = 0; i < 1e3; i++ ) { + x.push( 100.0 ); + } + v = nanvarianceyc( x.length, 0, toAccessorArray( x ), 1, 0 ); + t.strictEqual( v, 0.0, 'returns expected value' ); + + x = [ NaN, NaN, NaN, NaN, NaN, NaN, NaN, NaN, NaN, NaN ]; + v = nanvarianceyc( x.length, 0, toAccessorArray( x ), 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = []; + for ( i = 0; i < 1e3; i++ ) { + x.push( NaN ); + } + v = nanvarianceyc( x.length, 0, toAccessorArray( x ), 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function calculates the sample variance of a strided array (ignoring `NaN` values) (accessors)', function test( t ) { + var x; + var v; + var i; + + x = [ 1.0, -2.0, -4.0, 5.0, NaN, 0.0, 3.0 ]; + + v = nanvarianceyc( x.length, 1, toAccessorArray( x ), 1, 0 ); + t.strictEqual( v, 53.5/(x.length-2), 'returns expected value' ); + + x = [ 1.0, NaN, NaN, -2.0, NaN, -4.0, NaN, 5.0, NaN, 0.0, 3.0, NaN ]; + + v = nanvarianceyc( x.length, 1, toAccessorArray( x ), 1, 0 ); + t.strictEqual( v, 53.5/(x.length-7), 'returns expected value' ); + + x = [ -4.0, NaN ]; + + v = nanvarianceyc( x.length, 1, toAccessorArray( x ), 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN, NaN ]; + + v = nanvarianceyc( x.length, 1, toAccessorArray( x ), 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ NaN ]; + v = nanvarianceyc( x.length, 1, toAccessorArray( x ), 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = [ 4.0 ]; + v = nanvarianceyc( x.length, 1, toAccessorArray( x ), 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = []; + for ( i = 0; i < 1e3; i++ ) { + x.push( 100.0 ); + } + v = nanvarianceyc( x.length, 1, toAccessorArray( x ), 1, 0 ); + t.strictEqual( v, 0.0, 'returns expected value' ); + + x = [ NaN, NaN, NaN, NaN, NaN, NaN, NaN, NaN, NaN, NaN ]; + v = nanvarianceyc( x.length, 1, toAccessorArray( x ), 1, 0 ); + t.strictEqual( isnan( v ), true, 'returns expected value' ); + + x = []; + for ( i = 0; i < 1e3; i++ ) { + x.push( NaN ); + } + v = nanvarianceyc( x.length, 1, 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; @@ -212,7 +320,6 @@ tape( 'if provided a `correction` parameter yielding a correction term less than }); tape( 'the function supports a `stride` parameter', function test( t ) { - var N; var x; var v; @@ -229,15 +336,36 @@ tape( 'the function supports a `stride` parameter', function test( t ) { NaN ]; - N = floor( x.length / 2 ); - v = nanvarianceyc( N, 1, x, 2, 0 ); + v = nanvarianceyc( 5, 1, x, 2, 0 ); + + t.strictEqual( v, 6.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 = nanvarianceyc( 5, 1, toAccessorArray( x ), 2, 0 ); t.strictEqual( v, 6.25, 'returns expected value' ); t.end(); }); tape( 'the function supports a negative `stride` parameter', function test( t ) { - var N; var x; var v; var i; @@ -254,9 +382,8 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) 4.0, // 0 2.0 ]; - N = floor( x.length / 2 ); - v = nanvarianceyc( N, 1, x, -2, 8 ); + v = nanvarianceyc( 5, 1, x, -2, 8 ); t.strictEqual( v, 6.25, 'returns expected value' ); x = []; @@ -269,6 +396,37 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) t.end(); }); +tape( 'the function supports a negative `stride` parameter (accessors)', function test( t ) { + var x; + var v; + var i; + + x = [ + NaN, // 4 + NaN, + 1.0, // 3 + 2.0, + 2.0, // 2 + -7.0, + -2.0, // 1 + 3.0, + 4.0, // 0 + 2.0 + ]; + + v = nanvarianceyc( 5, 1, toAccessorArray( x ), -2, 8 ); + t.strictEqual( v, 6.25, 'returns expected value' ); + + x = []; + for ( i = 0; i < 1e3; i++ ) { + x.push( 100.0 ); + } + v = nanvarianceyc( x.length, 1, toAccessorArray( x ), -1, x.length-1 ); + t.strictEqual( v, 0.0, 'returns expected value' ); + + t.end(); +}); + tape( 'if provided a `stride` parameter equal to `0`, the function returns `0` provided the correction term is not less than `0` and the first element is not `NaN`', function test( t ) { var x; var v; @@ -292,7 +450,6 @@ tape( 'if provided a `stride` parameter equal to `0`, the function returns `0` p }); tape( 'the function supports an `offset` parameter', function test( t ) { - var N; var x; var v; @@ -308,9 +465,31 @@ tape( 'the function supports an `offset` parameter', function test( t ) { NaN, NaN // 4 ]; - N = floor( x.length / 2 ); - v = nanvarianceyc( N, 1, x, 2, 1 ); + v = nanvarianceyc( 5, 1, x, 2, 1 ); + t.strictEqual( v, 6.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 = nanvarianceyc( 5, 1, toAccessorArray( x ), 2, 1 ); t.strictEqual( v, 6.25, 'returns expected value' ); t.end(); From 7ab9228148761b53572c22d1b692765926b59f80 Mon Sep 17 00:00:00 2001 From: Athan Date: Tue, 18 Mar 2025 01:37:56 -0700 Subject: [PATCH 2/7] Apply suggestions from code review Signed-off-by: Athan --- .../@stdlib/stats/base/nanvarianceyc/README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/nanvarianceyc/README.md b/lib/node_modules/@stdlib/stats/base/nanvarianceyc/README.md index ef78d6fe8466..e452e60f8b4e 100644 --- a/lib/node_modules/@stdlib/stats/base/nanvarianceyc/README.md +++ b/lib/node_modules/@stdlib/stats/base/nanvarianceyc/README.md @@ -119,9 +119,9 @@ The function has the following parameters: The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to compute the [variance][variance] 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 ]; +var x = [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0, NaN, NaN ]; -var v = nanvarianceyc( 4, 1, x, 2 ); +var v = nanvarianceyc( 5, 1, x, 2 ); // returns 6.25 ``` @@ -132,10 +132,10 @@ Note that indexing is relative to the first index. To introduce an offset, use [ ```javascript var Float64Array = require( '@stdlib/array/float64' ); -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 v = nanvarianceyc( 4, 1, x1, 2 ); +var v = nanvarianceyc( 5, 1, x1, 2 ); // returns 6.25 ``` @@ -154,7 +154,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` parameter supports indexing semantics based on a starting index. For example, to calculate the [variance][variance] 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 [variance][variance] 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 ]; From f47905a7c51c047da68ccbb1fe4cb7452ea62041 Mon Sep 17 00:00:00 2001 From: Athan Date: Tue, 18 Mar 2025 01:40:10 -0700 Subject: [PATCH 3/7] Apply suggestions from code review Signed-off-by: Athan --- .../@stdlib/stats/base/nanvarianceyc/docs/repl.txt | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/nanvarianceyc/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/nanvarianceyc/docs/repl.txt index 4e62ca4c936e..3ac295c669ab 100644 --- a/lib/node_modules/@stdlib/stats/base/nanvarianceyc/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/nanvarianceyc/docs/repl.txt @@ -3,8 +3,8 @@ Computes the variance of a strided array ignoring `NaN` values and using a one-pass algorithm proposed by Youngs and Cramer. - The `N` and stride parameters determine which elements in the strided - array 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. @@ -51,15 +51,13 @@ // Using `N` and `stride` parameters: > x = [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ]; - > var strideX = 2; - > {{alias}}( 3, 1, x, strideX ) + > {{alias}}( 3, 1, x, 2 ) ~4.3333 // Using view offsets: > var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] ); > var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); - > strideX = 2; - > {{alias}}( 3, 1, x1, strideX ) + > {{alias}}( 3, 1, x1, 2 ) ~4.3333 From 200d714db68af5a93ca9750880cb7fbaa3bac4d2 Mon Sep 17 00:00:00 2001 From: Athan Date: Tue, 18 Mar 2025 01:40:53 -0700 Subject: [PATCH 4/7] style: fix missing space Signed-off-by: Athan --- lib/node_modules/@stdlib/stats/base/nanvarianceyc/docs/repl.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/nanvarianceyc/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/nanvarianceyc/docs/repl.txt index 3ac295c669ab..ebcdd0016b78 100644 --- a/lib/node_modules/@stdlib/stats/base/nanvarianceyc/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/nanvarianceyc/docs/repl.txt @@ -106,7 +106,7 @@ -------- // Standard Usage: > var x = [ 1.0, -2.0, NaN, 2.0 ]; - > {{alias}}.ndarray(4, 1, x, 1, 0 ) + > {{alias}}.ndarray( 4, 1, x, 1, 0 ) ~4.3333 // Using offset parameter: From e0d71fe4897aff7a323749967151ff98cb9a43d8 Mon Sep 17 00:00:00 2001 From: Athan Date: Tue, 18 Mar 2025 01:43:19 -0700 Subject: [PATCH 5/7] docs: fix comment Signed-off-by: Athan --- .../@stdlib/stats/base/nanvarianceyc/lib/nanvarianceyc.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/nanvarianceyc/lib/nanvarianceyc.js b/lib/node_modules/@stdlib/stats/base/nanvarianceyc/lib/nanvarianceyc.js index a498dfc57773..08bca4693180 100644 --- a/lib/node_modules/@stdlib/stats/base/nanvarianceyc/lib/nanvarianceyc.js +++ b/lib/node_modules/@stdlib/stats/base/nanvarianceyc/lib/nanvarianceyc.js @@ -18,7 +18,7 @@ 'use strict'; -// Modules +// MODULES // var stride2offset = require( '@stdlib/strided/base/stride2offset' ); var ndarray = require( './ndarray.js' ); From 853cd11a4c8517ceb26331f90efd2cfc6a4173f4 Mon Sep 17 00:00:00 2001 From: Athan Date: Tue, 18 Mar 2025 01:43:57 -0700 Subject: [PATCH 6/7] docs: fix comment Signed-off-by: Athan --- .../@stdlib/stats/base/nanvarianceyc/lib/ndarray.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/nanvarianceyc/lib/ndarray.js b/lib/node_modules/@stdlib/stats/base/nanvarianceyc/lib/ndarray.js index 1d38aad8ff4c..e0d3acad74a7 100644 --- a/lib/node_modules/@stdlib/stats/base/nanvarianceyc/lib/ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/nanvarianceyc/lib/ndarray.js @@ -18,7 +18,7 @@ 'use strict'; -// Modules +// MODULES // var arraylike2object = require( '@stdlib/array/base/arraylike2object' ); var accessors = require( './accessors.js' ); From 42b0df4c7b61a09d8ec3c694b2923260b4b3bc5b Mon Sep 17 00:00:00 2001 From: Athan Date: Tue, 18 Mar 2025 01:49:25 -0700 Subject: [PATCH 7/7] style: disable lint rule Signed-off-by: Athan --- lib/node_modules/@stdlib/stats/base/nanvarianceyc/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/stats/base/nanvarianceyc/README.md b/lib/node_modules/@stdlib/stats/base/nanvarianceyc/README.md index e452e60f8b4e..640c386548b0 100644 --- a/lib/node_modules/@stdlib/stats/base/nanvarianceyc/README.md +++ b/lib/node_modules/@stdlib/stats/base/nanvarianceyc/README.md @@ -127,7 +127,7 @@ var v = nanvarianceyc( 5, 1, x, 2 ); 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' );