Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -4,14 +4,25 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2025-03-30)
+## Unreleased (2025-05-08)
+
+<section class="features">
+
+### Features
+
+-   [`3c04537`](https://github.com/stdlib-js/stdlib/commit/3c045376b0079bd51c2a60ff690ab25f5c178d1a) - add add C ndarray interface and refactor implementation for `stats/base/sstdev` [(#6930)](https://github.com/stdlib-js/stdlib/pull/6930)
+
+</section>
+
+<!-- /.features -->
 
 <section class="commits">
 
 ### Commits
 
 <details>
 
+-   [`3c04537`](https://github.com/stdlib-js/stdlib/commit/3c045376b0079bd51c2a60ff690ab25f5c178d1a) - **feat:** add add C ndarray interface and refactor implementation for `stats/base/sstdev` [(#6930)](https://github.com/stdlib-js/stdlib/pull/6930) _(by Gururaj Gurram, Athan Reines, stdlib-bot)_
 -   [`8e9e556`](https://github.com/stdlib-js/stdlib/commit/8e9e556cbd76873f3418d4b999f1c2f125282a0d) - **refactor:** update paths _(by Aayush Khanna)_
 -   [`099a20d`](https://github.com/stdlib-js/stdlib/commit/099a20d177062b4d44568ce283f14d391227cfa6) - **refactor:** update `stats/base/sstdev` native addon from C++ to C [(#4507)](https://github.com/stdlib-js/stdlib/pull/4507) _(by Dhruv Arvind Singh)_
 -   [`62364f6`](https://github.com/stdlib-js/stdlib/commit/62364f62ea823a3b52c2ad25660ecd80c71f8f36) - **style:** fix C comment alignment _(by Philipp Burckhardt)_
@@ -29,11 +40,12 @@
 
 ### Contributors
 
-A total of 4 people contributed to this release. Thank you to the following contributors:
+A total of 5 people contributed to this release. Thank you to the following contributors:
 
 -   Aayush Khanna
 -   Athan Reines
 -   Dhruv Arvind Singh
+-   Gururaj Gurram
 -   Philipp Burckhardt
 
 </section>

CONTRIBUTORS

@@ -43,22 +43,26 @@ 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 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 +79,19 @@ 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 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,10 +102,14 @@ 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]>
@@ -111,8 +122,10 @@ 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 +139,15 @@ 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]>
+Sahil Goyal <[email protected]>
+Sai Avinash <[email protected]>
 Sai Srikar Dumpeti <[email protected]>
 Sanchay Ketan Sinha <[email protected]>
 Sarthak Paandey <[email protected]>
@@ -166,11 +182,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,17 +131,16 @@ To view installation and usage instructions specific to each branch build, be su
 var sstdev = require( '@stdlib/stats-base-sstdev' );
 ```
 
-#### sstdev( N, correction, x, stride )
+#### sstdev( N, correction, x, strideX )
 
-Computes the [standard deviation][standard-deviation] of a single-precision floating-point strided array `x`.
+Computes the [standard deviation][standard-deviation] of a single-precision floating-point strided array.
 
 ```javascript
 var Float32Array = require( '@stdlib/array-float32' );
 
 var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );
-var N = x.length;
 
-var v = sstdev( N, 1, x, 1 );
+var v = sstdev( x.length, 1, x, 1 );
 // returns ~2.0817
 ```
 
@@ -150,18 +149,16 @@ 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 [`Float32Array`][@stdlib/array/float32].
--   **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 Float32Array = require( '@stdlib/array-float32' );
-var floor = require( '@stdlib/math-base-special-floor' );
 
 var x = new Float32Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ] );
-var N = floor( x.length / 2 );
 
-var v = sstdev( N, 1, x, 2 );
+var v = sstdev( 4, 1, x, 2 );
 // returns 2.5
 ```
 
@@ -171,45 +168,39 @@ Note that indexing is relative to the first index. To introduce an offset, use [
 
 ```javascript
 var Float32Array = require( '@stdlib/array-float32' );
-var floor = require( '@stdlib/math-base-special-floor' );
 
 var x0 = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
 var x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
 
-var N = floor( x0.length / 2 );
-
-var v = sstdev( N, 1, x1, 2 );
+var v = sstdev( 4, 1, x1, 2 );
 // returns 2.5
 ```
 
-#### sstdev.ndarray( N, correction, x, stride, offset )
+#### sstdev.ndarray( N, correction, x, strideX, offsetX )
 
 Computes the [standard deviation][standard-deviation] of a single-precision floating-point strided array using alternative indexing semantics.
 
 ```javascript
 var Float32Array = require( '@stdlib/array-float32' );
 
 var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );
-var N = x.length;
 
-var v = sstdev.ndarray( N, 1, x, 1, 0 );
+var v = sstdev.ndarray( x.length, 1, x, 1, 0 );
 // returns ~2.0817
 ```
 
 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 `x` starting from the second element
 
 ```javascript
 var Float32Array = require( '@stdlib/array-float32' );
-var floor = require( '@stdlib/math-base-special-floor' );
 
 var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
-var N = floor( x.length / 2 );
 
-var v = sstdev.ndarray( N, 1, x, 2, 1 );
+var v = sstdev.ndarray( 4, 1, x, 2, 1 );
 // returns 2.5
 ```
 
@@ -235,18 +226,12 @@ var v = sstdev.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 Float32Array = require( '@stdlib/array-float32' );
+var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
 var sstdev = require( '@stdlib/stats-base-sstdev' );
 
-var x;
-var i;
-
-x = new Float32Array( 10 );
-for ( i = 0; i < x.length; i++ ) {
-    x[ i ] = round( (randu()*100.0) - 50.0 );
-}
+var x = discreteUniform( 10, -50, 50, {
+    'dtype': 'float32'
+});
 console.log( x );
 
 var v = sstdev( x.length, 1, x, 1 );
@@ -257,10 +242,129 @@ console.log( v );
 
 <!-- /.examples -->
 
+<!-- C interface documentation. -->
+
 * * *
 
+<section class="c">
+
+## C APIs
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<!-- C usage documentation. -->
+
+<section class="usage">
+
+### Usage
+
+```c
+#include "stdlib/stats/base/sstdev.h"
+```
+
+#### stdlib_strided_sstdev( N, correction, \*X, strideX )
+
+Computes the [standard deviation][standard-deviation] of a single-precision floating-point strided array.
+
+```c
+const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f, 5.0f, 6.0f, 7.0f, 8.0f };
+
+float v = stdlib_strided_sstdev( 4, 1.0f, x, 2 );
+// returns 2.581989f
+```
+
+The function accepts the following arguments:
+
+-   **N**: `[in] CBLAS_INT` number of indexed elements.
+-   **correction**: `[in] float` 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**: `[in] float*` input array.
+-   **strideX**: `[in] CBLAS_INT` stride length for `X`.
+
+```c
+float stdlib_strided_sstdev( const CBLAS_INT N, const float correction, const float *X, const CBLAS_INT strideX );
+```
+
+#### stdlib_strided_sstdev_ndarray( N, correction, \*X, strideX, offsetX )
+
+Computes the [standard deviation][standard-deviation] of a single-precision floating-point strided array using alternative indexing semantics.
+
+```c
+const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f, 5.0f, 6.0f, 7.0f, 8.0f };
+
+float v = stdlib_strided_sstdev_ndarray( 4, 1.0f, x, 2, 0 );
+// returns 2.581989f
+```
+
+The function accepts the following arguments:
+
+-   **N**: `[in] CBLAS_INT` number of indexed elements.
+-   **correction**: `[in] float` 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**: `[in] float*` input array.
+-   **strideX**: `[in] CBLAS_INT` stride length for `X`.
+-   **offsetX**: `[in] CBLAS_INT` starting index for `X`.
+
+```c
+float stdlib_strided_sstdev_ndarray( const CBLAS_INT N, const float correction, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX );
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<!-- C API usage examples. -->
+
+<section class="examples">
+
+### Examples
+
+```c
+#include "stdlib/stats/base/sstdev.h"
+#include <stdio.h>
+
+int main( void ) {
+    // Create a strided array:
+    const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f, 5.0f, 6.0f, 7.0f, 8.0f };
+
+    // Specify the number of elements:
+    const int N = 4;
+
+    // Specify the stride length:
+    const int strideX = 2;
+
+    // Compute the standard deviation:
+    float v = stdlib_strided_sstdev( N, 1.0f, x, strideX );
+
+    // Print the result:
+    printf( "sample standard deviation: %f\n", v );
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+</section>
+
+<!-- /.c -->
+
 <section class="references">
 
+* * *
+
 ## References
 
 -   Neely, Peter M. 1966. "Comparison of Several Algorithms for Computation of Means, Standard Deviations and Correlation Coefficients." _Communications of the ACM_ 9 (7). Association for Computing Machinery: 496–99. doi:[10.1145/365719.365958][@neely:1966a].