Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -4,14 +4,25 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2025-06-07)
+## Unreleased (2025-06-22)
+
+<section class="features">
+
+### Features
+
+-   [`0cdbf3c`](https://github.com/stdlib-js/stdlib/commit/0cdbf3cf7d5f3c16907ea70a586a732304b6b41b) - add C ndarray interface and refactor implementation for `stats/base/dmeanstdev` [(#7409)](https://github.com/stdlib-js/stdlib/pull/7409)
+
+</section>
+
+<!-- /.features -->
 
 <section class="commits">
 
 ### Commits
 
 <details>
 
+-   [`0cdbf3c`](https://github.com/stdlib-js/stdlib/commit/0cdbf3cf7d5f3c16907ea70a586a732304b6b41b) - **feat:** add C ndarray interface and refactor implementation for `stats/base/dmeanstdev` [(#7409)](https://github.com/stdlib-js/stdlib/pull/7409) _(by Gururaj Gurram, Athan Reines, stdlib-bot)_
 -   [`76100b0`](https://github.com/stdlib-js/stdlib/commit/76100b038910770cca2f13dd6e715802e3da756c) - **refactor:** update paths _(by Gururaj Gurram)_
 -   [`744337a`](https://github.com/stdlib-js/stdlib/commit/744337aaebfd4a9631f17765bce57a38c5374173) - **refactor:** update paths _(by Gururaj Gurram)_
 -   [`95bdc42`](https://github.com/stdlib-js/stdlib/commit/95bdc42196643ed99f417ec1be130ca7acc6b121) - **refactor:** update `stats/base/dmeanstdev` native addon from C++ to C [(#4612)](https://github.com/stdlib-js/stdlib/pull/4612) _(by Dhruv Arvind Singh)_

CONTRIBUTORS

@@ -21,10 +21,13 @@ Ali Salesi <ali_sal1381@yahoo.com>
 AlyAbdelmoneim <148393799+AlyAbdelmoneim@users.noreply.github.com>
 Aman Bhansali <bhansali.1@iitj.ac.in>
 AmanBhadkariya <140033975+AmanBhadkariya@users.noreply.github.com>
+Amisha Chhajed <136238836+amishhaa@users.noreply.github.com>
 Amit Jimiwal <amitjimiwal45@gmail.com>
+Annamalai Prabu <apfossdev@gmail.com>
 Anshu Kumar <132515490+anxhukumar@users.noreply.github.com>
 Anshu Kumar <contact.anshukumar@protonmail.com>
 Anudeep Sanapala <anudeep0306@gmail.com>
+Aryan Bhirud <112156883+AryanBhirud@users.noreply.github.com>
 Athan Reines <kgryte@gmail.com>
 Ayaka <73595362+USERSATOSHI@users.noreply.github.com>
 Bhavishy Agrawal <90029607+bhavishy2801@users.noreply.github.com>
@@ -92,6 +95,7 @@ Krishnam Agarwal <83017176+888krishnam@users.noreply.github.com>
 Krishnendu Das <86651039+itskdhere@users.noreply.github.com>
 Kshitij-Dale <152467202+Kshitij-Dale@users.noreply.github.com>
 Lalit Narayan Yadav <162928571+LalitNarayanYadav@users.noreply.github.com>
+Lokesh Ranjan <lokesh.ranjan.phe23@itbhu.ac.in>
 Lovelin Dhoni J B <100030865+lovelindhoni@users.noreply.github.com>
 MANI <77221000+Eternity0207@users.noreply.github.com>
 Mahfuza Humayra Mohona <mhmohona@gmail.com>
@@ -120,6 +124,7 @@ Ognjen Jevremović <ognjenjevremovic@users.noreply.github.com>
 Oneday12323 <107678750+Oneday12323@users.noreply.github.com>
 Ori Miles <97595296+orimiles5@users.noreply.github.com>
 Philipp Burckhardt <pburckhardt@outlook.com>
+Pierre Forstmann <15964998+pierreforstmann@users.noreply.github.com>
 Prajjwal Bajpai <142303989+prajjwalbajpai@users.noreply.github.com>
 Prajwal Kulkarni <prajwalkulkarni76@gmail.com>
 Pranav Goswami <pranavchiku11@gmail.com>

README.md

@@ -135,7 +135,7 @@ var dmeanstdev = require( '@stdlib/stats-base-dmeanstdev' );
 
 #### dmeanstdev( N, correction, x, strideX, out, strideOut )
 
-Computes the [mean][arithmetic-mean] and [standard deviation][standard-deviation] of a double-precision floating-point strided array `x`.
+Computes the [mean][arithmetic-mean] and [standard deviation][standard-deviation] of a double-precision floating-point strided array.
 
 ```javascript
 var Float64Array = require( '@stdlib/array-float64' );
@@ -155,21 +155,19 @@ 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 [`Float64Array`][@stdlib/array/float64].
--   **strideX**: index increment for `x`.
+-   **strideX**: stride length for `x`.
 -   **out**: output [`Float64Array`][@stdlib/array/float64] for storing results.
--   **strideOut**: index increment for `out`.
+-   **strideOut**: stride length for `out`.
 
-The `N` and `stride` parameters determine which elements 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 Float64Array = require( '@stdlib/array-float64' );
-var floor = require( '@stdlib/math-base-special-floor' );
 
 var x = new Float64Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ] );
 var out = new Float64Array( 2 );
-var N = floor( x.length / 2 );
 
-var v = dmeanstdev( N, 1, x, 2, out, 1 );
+var v = dmeanstdev( 4, 1, x, 2, out, 1 );
 // returns <Float64Array>[ 1.25, 2.5 ]
 ```
 
@@ -179,17 +177,14 @@ 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 out0 = new Float64Array( 4 );
 var out1 = new Float64Array( out0.buffer, out0.BYTES_PER_ELEMENT*2 ); // start at 3rd element
 
-var N = floor( x0.length / 2 );
-
-var v = dmeanstdev( N, 1, x1, 2, out1, 1 );
+var v = dmeanstdev( 4, 1, x1, 2, out1, 1 );
 // returns <Float64Array>[ 1.25, 2.5 ]
 ```
 
@@ -212,17 +207,15 @@ The function has the following additional parameters:
 -   **offsetX**: starting index for `x`.
 -   **offsetOut**: starting index for `out`.
 
-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 [mean][arithmetic-mean] and [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 parameters support indexing semantics based on starting indices. For example, to calculate the [mean][arithmetic-mean] and [standard deviation][standard-deviation] for every other element in `x` starting from the second element
 
 ```javascript
 var Float64Array = require( '@stdlib/array-float64' );
-var floor = require( '@stdlib/math-base-special-floor' );
 
 var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
 var out = new Float64Array( 4 );
-var N = floor( x.length / 2 );
 
-var v = dmeanstdev.ndarray( N, 1, x, 2, 1, out, 2, 1 );
+var v = dmeanstdev.ndarray( 4, 1, x, 2, 1, out, 2, 1 );
 // returns <Float64Array>[ 0.0, 1.25, 0.0, 2.5 ]
 ```
 
@@ -248,22 +241,16 @@ var v = dmeanstdev.ndarray( N, 1, x, 2, 1, out, 2, 1 );
 <!-- eslint no-undef: "error" -->
 
 ```javascript
-var randu = require( '@stdlib/random-base-randu' );
-var round = require( '@stdlib/math-base-special-round' );
+var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
 var Float64Array = require( '@stdlib/array-float64' );
 var dmeanstdev = require( '@stdlib/stats-base-dmeanstdev' );
 
-var out;
-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 );
 
-out = new Float64Array( 2 );
+var out = new Float64Array( 2 );
 dmeanstdev( x.length, 1, x, 1, out, 1 );
 console.log( out );
 ```
@@ -272,6 +259,135 @@ console.log( out );
 
 <!-- /.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/dmeanstdev.h"
+```
+
+#### stdlib_strided_dmeanstdev( N, correction, \*X, strideX, \*Out, strideOut )
+
+Computes the [mean][arithmetic-mean] and [standard deviation][standard-deviation] of a double-precision floating-point strided array.
+
+```c
+const double x[] = { 1.0, -2.0, 2.0 };
+double out[] = { 0.0, 0.0 };
+
+stdlib_strided_dmeanstdev( 4, 1.0, x, 1, out, 1 );
+```
+
+The function accepts the following arguments:
+
+-   **N**: `[in] CBLAS_INT` number of indexed elements.
+-   **correction**: `[in] double` 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] double*` input array.
+-   **strideX**: `[in] CBLAS_INT` stride length for `X`.
+-   **Out**: `[out] double*` output array.
+-   **strideOut**: `[in] CBLAS_INT` stride length for `Out`.
+
+```c
+void stdlib_strided_dmeanstdev( const CBLAS_INT N, const double correction, const double *X, const CBLAS_INT strideX, double *Out, const CBLAS_INT strideOut );
+```
+
+#### stdlib_strided_dmeanstdev_ndarray( N, correction, \*X, strideX, offsetX, \*Out, strideOut, offsetOut )
+
+Computes the [mean][arithmetic-mean] and [standard deviation][standard-deviation] of a double-precision floating-point strided array using alternative indexing semantics.
+
+```c
+const double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 };
+double out[] = { 0.0, 0.0 };
+
+stdlib_strided_dmeanstdev_ndarray( 4, 1.0, x, 2, 0, x, 1, 0 );
+```
+
+The function accepts the following arguments:
+
+-   **N**: `[in] CBLAS_INT` number of indexed elements.
+-   **correction**: `[in] double` 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] double*` input array.
+-   **strideX**: `[in] CBLAS_INT` stride length for `X`.
+-   **offsetX**: `[in] CBLAS_INT` starting index for `X`.
+-   **Out**: `[out] double*` output array.
+-   **strideOut**: `[in] CBLAS_INT` stride length for `Out`.
+-   **offsetOut**: `[in] CBLAS_INT` starting index for `Out`.
+
+```c
+void stdlib_strided_dmeanstdev_ndarray( const CBLAS_INT N, const double correction, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, double *Out, const CBLAS_INT strideOut, const CBLAS_INT offsetOut );
+```
+
+</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/dmeanstdev.h"
+#include <stdio.h>
+
+int main( void ) {
+    // Create a strided array:
+    const double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 };
+
+    // Create an output array:
+    double out[] = { 0.0, 0.0 };
+
+    // Specify the number of elements:
+    const int N = 4;
+
+    // Specify the stride length:
+    const int strideX = 2;
+    const int strideOut = 1;
+
+    // Compute the mean and standard deviation:
+    stdlib_strided_dmeanstdev( N, 1.0, x, strideX, out, strideOut );
+
+    // Print the result:
+    printf( "sample mean: %lf\n", out[ 0 ] );
+    printf( "sample standard deviation: %lf\n", out[ 1 ] );
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+</section>
+
+<!-- /.c -->
+
 <section class="references">
 
 </section>

benchmark/benchmark.js

@@ -21,14 +21,21 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench-harness' );
-var randu = require( '@stdlib/random-base-randu' );
 var isnan = require( '@stdlib/math-base-assert-is-nan' );
 var pow = require( '@stdlib/math-base-special-pow' );
 var Float64Array = require( '@stdlib/array-float64' );
+var uniform = require( '@stdlib/random-array-uniform' );
 var pkg = require( './../package.json' ).name;
 var dmeanstdev = require( './../lib/dmeanstdev.js' );
 
 
+// VARIABLES //
+
+var options = {
+	'dtype': 'float64'
+};
+
+
 // FUNCTIONS //
 
 /**
@@ -41,12 +48,8 @@ var dmeanstdev = require( './../lib/dmeanstdev.js' );
 function createBenchmark( len ) {
 	var out;
 	var x;
-	var i;
 
-	x = new Float64Array( len );
-	for ( i = 0; i < x.length; i++ ) {
-		x[ i ] = ( randu()*20.0 ) - 10.0;
-	}
+	x = uniform( len, -10.0, 10.0, options );
 	out = new Float64Array( 2 );
 	return benchmark;
 

benchmark/benchmark.native.js

@@ -22,10 +22,10 @@
 
 var resolve = require( 'path' ).resolve;
 var bench = require( '@stdlib/bench-harness' );
-var randu = require( '@stdlib/random-base-randu' );
 var isnan = require( '@stdlib/math-base-assert-is-nan' );
 var pow = require( '@stdlib/math-base-special-pow' );
 var Float64Array = require( '@stdlib/array-float64' );
+var uniform = require( '@stdlib/random-array-uniform' );
 var tryRequire = require( '@stdlib/utils-try-require' );
 var pkg = require( './../package.json' ).name;
 
@@ -36,6 +36,9 @@ var dmeanstdev = tryRequire( resolve( __dirname, './../lib/dmeanstdev.native.js'
 var opts = {
 	'skip': ( dmeanstdev instanceof Error )
 };
+var options = {
+	'dtype': 'float64'
+};
 
 
 // FUNCTIONS //
@@ -50,12 +53,8 @@ var opts = {
 function createBenchmark( len ) {
 	var out;
 	var x;
-	var i;
 
-	x = new Float64Array( len );
-	for ( i = 0; i < x.length; i++ ) {
-		x[ i ] = ( randu()*20.0 ) - 10.0;
-	}
+	x = uniform( len, -10.0, 10.0, options );
 	out = new Float64Array( 2 );
 	return benchmark;