Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -4,14 +4,37 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2025-03-30)
+## Unreleased (2025-06-13)
+
+<section class="features">
+
+### Features
+
+-   [`33266af`](https://github.com/stdlib-js/stdlib/commit/33266af98fc620c8fdcc2fa9a9624b776b5f8f9b) - refactor and add protocol support to `stats/base/stdevpn` [(#6225)](https://github.com/stdlib-js/stdlib/pull/6225)
+
+</section>
+
+<!-- /.features -->
+
+<section class="issues">
+
+### Closed Issues
+
+This release closes the following issue:
+
+[#5683](https://github.com/stdlib-js/stdlib/issues/5683)
+
+</section>
+
+<!-- /.issues -->
 
 <section class="commits">
 
 ### Commits
 
 <details>
 
+-   [`33266af`](https://github.com/stdlib-js/stdlib/commit/33266af98fc620c8fdcc2fa9a9624b776b5f8f9b) - **feat:** refactor and add protocol support to `stats/base/stdevpn` [(#6225)](https://github.com/stdlib-js/stdlib/pull/6225) _(by Amisha Chhajed, Athan Reines, Gururaj Gurram, stdlib-bot)_
 -   [`8e9e556`](https://github.com/stdlib-js/stdlib/commit/8e9e556cbd76873f3418d4b999f1c2f125282a0d) - **refactor:** update paths _(by Aayush Khanna)_
 -   [`4df836a`](https://github.com/stdlib-js/stdlib/commit/4df836acfee5e6f359fc5d15a31ee9f6ef4237f0) - **refactor:** update paths _(by Aayush Khanna)_
 
@@ -25,9 +48,12 @@
 
 ### Contributors
 
-A total of 1 person contributed to this release. Thank you to this contributor:
+A total of 4 people contributed to this release. Thank you to the following contributors:
 
 -   Aayush Khanna
+-   Amisha Chhajed
+-   Athan Reines
+-   Gururaj Gurram
 
 </section>
 

CONTRIBUTORS

@@ -22,6 +22,7 @@ AlyAbdelmoneim <[email protected]>
 Aman Bhansali <[email protected]>
 AmanBhadkariya <[email protected]>
 Amit Jimiwal <[email protected]>
+Annamalai Prabu <[email protected]>
 Anshu Kumar <[email protected]>
 Anshu Kumar <[email protected]>
 Anudeep Sanapala <[email protected]>
@@ -38,27 +39,33 @@ Daniel Killenberger <[email protected]>
 Daniel Yu <[email protected]>
 Debashis Maharana <[email protected]>
 Deep Trivedi <[email protected]>
+Deepak Singh <[email protected]>
 Desh Deepak Kant <[email protected]>
 Dev Goel <[email protected]>
 Dhanyabad behera <[email protected]>
 Dhruv Arvind Singh <[email protected]>
 Dhruvil Mehta <[email protected]>
+Dipjyoti Das <[email protected]>
 Divyansh Seth <[email protected]>
 Dominic Lim <[email protected]>
 Dominik Moritz <[email protected]>
 Dorrin Sotoudeh <[email protected]>
 EuniceSim142 <[email protected]>
 Frank Kovacs <[email protected]>
 GK Bishnoi <[email protected]>
+GURU PRASAD SHARMA <[email protected]>
 Gaurav <[email protected]>
+Gautam Kaushik <[email protected]>
 Gautam sharma <[email protected]>
+Girish Garg <[email protected]>
 Golden Kumar <[email protected]>
 Gunj Joshi <[email protected]>
 Gururaj Gurram <[email protected]>
 Haroon Rasheed <[email protected]>
-Harsh <[email protected].com>
+Harsh <harshyadav6078@gmail.com>
 HarshaNP <[email protected]>
 Harshita Kalani <[email protected]>
+Hemang Choudhary <[email protected]>
 Hemant M Mehta <[email protected]>
 Hridyanshu <[email protected]>
 Jaimin Godhani <[email protected]>
@@ -75,16 +82,20 @@ Jordan Gallivan <[email protected]>
 Joris Labie <[email protected]>
 Justin Dennison <[email protected]>
 Justyn Shelby <[email protected]>
-Karan Anand <[email protected]>
+Karan Anand <[email protected]>
+Karan Vasudevamurthy <[email protected]>
+Karan Yadav <[email protected]>
 Karthik Prakash <[email protected]>
 Kaushikgtm <[email protected]>
 Kavyansh-Bagdi <[email protected]>
 Kohantika Nath <[email protected]>
 Krishnam Agarwal <[email protected]>
 Krishnendu Das <[email protected]>
 Kshitij-Dale <[email protected]>
+Lalit Narayan Yadav <[email protected]>
 Lovelin Dhoni J B <[email protected]>
 MANI <[email protected]>
+Mahfuza Humayra Mohona <[email protected]>
 Manik Sharma <[email protected]>
 Manvith M <[email protected]>
 Marcus Fantham <[email protected]>
@@ -95,24 +106,31 @@ Mohammad Bin Aftab <[email protected]>
 Mohammad Kaif <[email protected]>
 Momtchil Momtchev <[email protected]>
 Muhammad Haris <[email protected]>
+Muhammad Taaha Tariq <[email protected]>
+Muhmmad Saad <[email protected]>
 Naresh Jagadeesan <[email protected]>
 Naveen Kumar <[email protected]>
 Neeraj Pathak <[email protected]>
+NirvedMishra <[email protected]>
 Nishant Shinde <[email protected]>
+Nishant singh <[email protected]>
 Nishchay Rajput <[email protected]>
 Nithin Katta <[email protected]>
 Nourhan Hasan <[email protected]>
 Ognjen Jevremović <[email protected]>
 Oneday12323 <[email protected]>
 Ori Miles <[email protected]>
 Philipp Burckhardt <[email protected]>
+Pierre Forstmann <[email protected]>
 Prajjwal Bajpai <[email protected]>
 Prajwal Kulkarni <[email protected]>
 Pranav Goswami <[email protected]>
 Pranjal Jha <[email protected]>
 Prashant Kumar Yadav <[email protected]>
+PrathamBhamare <[email protected]>
 Pratik Singh <[email protected]>
 Pratyush Kumar Chouhan <[email protected]>
+Pravesh Kunwar <[email protected]>
 Priyansh Prajapati <[email protected]>
 Priyanshu Agarwal <[email protected]>
 Pulkit Gupta <[email protected]>
@@ -126,12 +144,16 @@ Rishav <[email protected]>
 Rishav Tarway <[email protected]>
 Robert Gislason <[email protected]>
 Roman Stetsyk <[email protected]>
+Rupa <[email protected]>
 Rutam Kathale <[email protected]>
 Ruthwik Chikoti <[email protected]>
 Ryan Seal <[email protected]>
 Rylan Yang <[email protected]>
 SAHIL KUMAR <[email protected]>
 SHIVAM YADAV <[email protected]>
+Sachin Raj <[email protected]>
+Sahil Goyal <[email protected]>
+Sai Avinash <[email protected]>
 Sai Srikar Dumpeti <[email protected]>
 Sanchay Ketan Sinha <[email protected]>
 Sarthak Paandey <[email protected]>
@@ -150,14 +172,19 @@ Spandan Barve <[email protected]>
 Stephannie Jiménez Gacha <[email protected]>
 Suhaib Ilahi <[email protected]>
 Suraj Kumar <[email protected]>
+Swapnil Hajare <[email protected]>
 Tanishq Ahuja <[email protected]>
 Tirtadwipa Manunggal <[email protected]>
 Tudor Pagu <[email protected]>
 Tufailahmed Bargir <[email protected]>
+Tushar Bhardwaj <[email protected]>
+Uday Kakade <[email protected]>
+Ujjwal Kirti <[email protected]>
 Utkarsh <http://[email protected]>
 Utkarsh Raj <[email protected]>
 UtkershBasnet <[email protected]>
 Vaibhav Patel <[email protected]>
+Vara Rahul Rajana <[email protected]>
 Varad Gupta <[email protected]>
 Vinit Pandit <[email protected]>
 Vivek Maurya <[email protected]>
@@ -166,11 +193,15 @@ Yaswanth Kosuru <[email protected]>
 Yernar Yergaziyev <[email protected]>
 Yugal Kaushik <[email protected]>
 Yuvi Mittal <[email protected]>
+devshree-bhati <[email protected]>
 ditsu <[email protected]>
 ekambains <[email protected]>
 fadiothman22 <[email protected]>
+iraandrushko <[email protected]>
+lohithganni <[email protected]>
 olenkabilonizhka <[email protected]>
 pranav-1720 <[email protected]>
 rahulrangers <[email protected]>
 rainn <[email protected]>
 rei2hu <[email protected]>
+zhanggy <[email protected]>

README.md

@@ -131,9 +131,9 @@ To view installation and usage instructions specific to each branch build, be su
 var stdevpn = require( '@stdlib/stats-base-stdevpn' );
 ```
 
-#### stdevpn( N, correction, x, stride )
+#### stdevpn( N, correction, x, strideX )
 
-Computes the [standard deviation][standard-deviation] of a strided array `x` using a two-pass algorithm.
+Computes the [standard deviation][standard-deviation] of a strided array using a two-pass algorithm.
 
 ```javascript
 var x = [ 1.0, -2.0, 2.0 ];
@@ -147,17 +147,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 [standard deviation][standard-deviation] according to `N-c` where `c` corresponds to the provided degrees of freedom adjustment. When computing the [standard deviation][standard-deviation] 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 corrected sample [standard deviation][standard-deviation], 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 [standard deviation][standard-deviation] 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 [standard deviation][standard-deviation] 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 ];
-var N = floor( x.length / 2 );
 
-var v = stdevpn( N, 1, x, 2 );
+var v = stdevpn( 4, 1, x, 2 );
 // returns 2.5
 ```
 
@@ -167,18 +164,15 @@ Note that indexing is relative to the first index. To introduce an offset, use [
 
 ```javascript
 var Float64Array = require( '@stdlib/array-float64' );
-var floor = require( '@stdlib/math-base-special-floor' );
 
 var x0 = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
 var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
 
-var N = floor( x0.length / 2 );
-
-var v = stdevpn( N, 1, x1, 2 );
+var v = stdevpn( 4, 1, x1, 2 );
 // returns 2.5
 ```
 
-#### stdevpn.ndarray( N, correction, x, stride, offset )
+#### stdevpn.ndarray( N, correction, x, strideX, offsetX )
 
 Computes the [standard deviation][standard-deviation] of a strided array using a two-pass algorithm and alternative indexing semantics.
 
@@ -191,17 +185,14 @@ var v = stdevpn.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 [standard deviation][standard-deviation] 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 [standard deviation][standard-deviation] 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 ];
-var N = floor( x.length / 2 );
 
-var v = stdevpn.ndarray( N, 1, x, 2, 1 );
+var v = stdevpn.ndarray( 4, 1, x, 2, 1 );
 // returns 2.5
 ```
 
@@ -215,6 +206,7 @@ var v = stdevpn.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), 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 ([`dstdevpn`][@stdlib/stats/strided/dstdevpn], [`sstdevpn`][@stdlib/stats/strided/sstdevpn], etc.) are likely to be significantly more performant.
 
 </section>
@@ -228,18 +220,12 @@ var v = stdevpn.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 discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
 var stdevpn = require( '@stdlib/stats-base-stdevpn' );
 
-var x;
-var i;
-
-x = new Float64Array( 10 );
-for ( i = 0; i < x.length; i++ ) {
-    x[ i ] = round( (randu()*100.0) - 50.0 );
-}
+var x = discreteUniform( 10, -50, 50, {
+    'dtype': 'float64'
+});
 console.log( x );
 
 var v = stdevpn( x.length, 1, x, 1 );
@@ -359,6 +345,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
+
 [@stdlib/stats/strided/dstdevpn]: https://github.com/stdlib-js/stats-strided-dstdevpn
 
 [@stdlib/stats/strided/sstdevpn]: https://github.com/stdlib-js/stats-strided-sstdevpn

benchmark/benchmark.js

@@ -21,13 +21,20 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench-harness' );
-var randu = require( '@stdlib/random-base-randu' );
+var uniform = require( '@stdlib/random-array-uniform' );
 var isnan = require( '@stdlib/math-base-assert-is-nan' );
 var pow = require( '@stdlib/math-base-special-pow' );
 var pkg = require( './../package.json' ).name;
 var stdevpn = require( './../lib/stdevpn.js' );
 
 
+// VARIABLES //
+
+var options = {
+	'dtype': 'generic'
+};
+
+
 // FUNCTIONS //
 
 /**
@@ -38,13 +45,7 @@ var stdevpn = require( './../lib/stdevpn.js' );
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x;
-	var i;
-
-	x = [];
-	for ( i = 0; i < len; i++ ) {
-		x.push( ( randu()*20.0 ) - 10.0 );
-	}
+	var x = uniform( len, -10, 10, options );
 	return benchmark;
 
 	function benchmark( b ) {

benchmark/benchmark.ndarray.js

@@ -21,13 +21,20 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench-harness' );
-var randu = require( '@stdlib/random-base-randu' );
+var uniform = require( '@stdlib/random-array-uniform' );
 var isnan = require( '@stdlib/math-base-assert-is-nan' );
 var pow = require( '@stdlib/math-base-special-pow' );
 var pkg = require( './../package.json' ).name;
 var stdevpn = require( './../lib/ndarray.js' );
 
 
+// VARIABLES //
+
+var options = {
+	'dtype': 'generic'
+};
+
+
 // FUNCTIONS //
 
 /**
@@ -38,13 +45,7 @@ var stdevpn = require( './../lib/ndarray.js' );
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x;
-	var i;
-
-	x = [];
-	for ( i = 0; i < len; i++ ) {
-		x.push( ( randu()*20.0 ) - 10.0 );
-	}
+	var x = uniform( len, -10, 10, options );
 	return benchmark;
 
 	function benchmark( b ) {