Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -4,14 +4,37 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2025-03-29)
+## Unreleased (2025-04-02)
+
+<section class="features">
+
+### Features
+
+-   [`41d0632`](https://github.com/stdlib-js/stdlib/commit/41d0632145a36b71711b27c0ee7add3c0434c7f5) - refactor and add protocol support to `stats/base/nanvariancewd` [(#6023)](https://github.com/stdlib-js/stdlib/pull/6023)
+
+</section>
+
+<!-- /.features -->
+
+<section class="issues">
+
+### Closed Issues
+
+This release closes the following issue:
+
+[#5677](https://github.com/stdlib-js/stdlib/issues/5677)
+
+</section>
+
+<!-- /.issues -->
 
 <section class="commits">
 
 ### Commits
 
 <details>
 
+-   [`41d0632`](https://github.com/stdlib-js/stdlib/commit/41d0632145a36b71711b27c0ee7add3c0434c7f5) - **feat:** refactor and add protocol support to `stats/base/nanvariancewd` [(#6023)](https://github.com/stdlib-js/stdlib/pull/6023) _(by Prajjwal Bajpai, Athan Reines, Aayush Khanna)_
 -   [`4de7fc4`](https://github.com/stdlib-js/stdlib/commit/4de7fc4b59fa279a67b642213e90760eaf5f7b88) - **refactor:** update paths _(by Aayush Khanna)_
 
 </details>
@@ -24,9 +47,11 @@
 
 ### Contributors
 
-A total of 1 person contributed to this release. Thank you to this contributor:
+A total of 3 people contributed to this release. Thank you to the following contributors:
 
 -   Aayush Khanna
+-   Athan Reines
+-   Prajjwal Bajpai
 
 </section>
 

CONTRIBUTORS

@@ -132,6 +132,8 @@ Ryan Seal <[email protected]>
 Rylan Yang <[email protected]>
 SAHIL KUMAR <[email protected]>
 SHIVAM YADAV <[email protected]>
+Sahil Goyal <[email protected]>
+Sai Avinash <[email protected]>
 Sai Srikar Dumpeti <[email protected]>
 Sanchay Ketan Sinha <[email protected]>
 Sarthak Paandey <[email protected]>
@@ -169,6 +171,7 @@ Yuvi Mittal <[email protected]>
 ditsu <[email protected]>
 ekambains <[email protected]>
 fadiothman22 <[email protected]>
+lohithganni <[email protected]>
 olenkabilonizhka <[email protected]>
 pranav-1720 <[email protected]>
 rahulrangers <[email protected]>

README.md

@@ -131,9 +131,9 @@ To view installation and usage instructions specific to each branch build, be su
 var nanvariancewd = require( '@stdlib/stats-base-nanvariancewd' );
 ```
 
-#### nanvariancewd( N, correction, x, stride )
+#### nanvariancewd( N, correction, x, strideX )
 
-Computes the [variance][variance] of a strided array `x` ignoring `NaN` values and using Welford's algorithm.
+Computes the [variance][variance] of a strided array ignoring `NaN` values and using Welford's algorithm.
 
 ```javascript
 var x = [ 1.0, -2.0, NaN, 2.0 ];
@@ -147,38 +147,32 @@ 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 = nanvariancewd( N, 1, x, 2 );
+var v = nanvariancewd( 5, 1, x, 2 );
 // returns 6.25
 ```
 
 Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
 
-<!-- eslint-disable stdlib/capitalized-comments -->
+<!-- eslint-disable stdlib/capitalized-comments, max-len -->
 
 ```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 = nanvariancewd( N, 1, x1, 2 );
+var v = nanvariancewd( 5, 1, x1, 2 );
 // returns 6.25
 ```
 
-#### nanvariancewd.ndarray( N, correction, x, stride, offset )
+#### nanvariancewd.ndarray( N, correction, x, strideX, offsetX )
 
 Computes the [variance][variance] of a strided array ignoring `NaN` values and using Welford's algorithm and alternative indexing semantics.
 
@@ -191,17 +185,14 @@ var v = nanvariancewd.ndarray( x.length, 1, x, 1, 0 );
 
 The function has the following additional parameters:
 
--   **offset**: starting index for `x`.
+-   **offsetX**: starting index for `x`.
 
-While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying `buffer`, the `offset` parameter supports indexing semantics based on a starting index. For example, to calculate the [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 element in the strided array starting from the second element
 
 ```javascript
-var floor = require( '@stdlib/math-base-special-floor' );
+var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, 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 = nanvariancewd.ndarray( N, 1, x, 2, 1 );
+var v = nanvariancewd.ndarray( 5, 1, x, 2, 1 );
 // returns 6.25
 ```
 
@@ -214,6 +205,7 @@ var v = nanvariancewd.ndarray( N, 1, x, 2, 1 );
 ## Notes
 
 -   If `N <= 0`, 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]).
 -   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`.
 -   Depending on the environment, the typed versions ([`dnanvariancewd`][@stdlib/stats/strided/dnanvariancewd], [`snanvariancewd`][@stdlib/stats/base/snanvariancewd], etc.) are likely to be significantly more performant.
 
@@ -228,18 +220,19 @@ var v = nanvariancewd.ndarray( N, 1, x, 2, 1 );
 <!-- eslint no-undef: "error" -->
 
 ```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 nanvariancewd = require( '@stdlib/stats-base-nanvariancewd' );
+var bernoulli = require( '@stdlib/random-base-bernoulli' );
 
-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, 'float64', rand );
 console.log( x );
 
 var v = nanvariancewd( x.length, 1, x, 1 );
@@ -359,6 +352,8 @@ Copyright &copy; 2016-2025. The Stdlib [Authors][stdlib-authors].
 
 [mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
 
+[@stdlib/array/base/accessor]: https://github.com/stdlib-js/array-base-accessor
+
 [@welford:1962a]: https://doi.org/10.1080/00401706.1962.10490022
 
 [@vanreeken:1968a]: https://doi.org/10.1145/362929.362961

benchmark/benchmark.js

@@ -21,15 +21,30 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench-harness' );
-var randu = require( '@stdlib/random-base-randu' );
+var uniform = require( '@stdlib/random-base-uniform' );
+var bernoulli = require( '@stdlib/random-base-bernoulli' );
+var filledarrayBy = require( '@stdlib/array-filled-by' );
 var isnan = require( '@stdlib/math-base-assert-is-nan' );
 var pow = require( '@stdlib/math-base-special-pow' );
 var pkg = require( './../package.json' ).name;
-var nanvariancewd = require( './../lib/nanvariancewd.js' );
+var nanvariancewd = require( './../lib/main.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 nanvariancewd = require( './../lib/nanvariancewd.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, 'float64', rand );
 	return benchmark;
 
 	function benchmark( b ) {

benchmark/benchmark.ndarray.js

@@ -21,7 +21,9 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench-harness' );
-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 nanvariancewd = 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 nanvariancewd = 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, 'float64', rand );
 	return benchmark;
 
 	function benchmark( b ) {