feat: add C ndarray interface and refactor implementation

--- 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: passed - task: lint_c_examples status: passed - task: lint_c_benchmarks status: passed - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
stdlib-js · Jan 10, 2025 · 81d9e20 · 81d9e20
1 parent 6def8d6
commit 81d9e20
Show file tree

Hide file tree

Showing 24 changed files with 391 additions and 239 deletions.
diff --git a/lib/node_modules/@stdlib/stats/base/sstdevch/README.md b/lib/node_modules/@stdlib/stats/base/sstdevch/README.md
@@ -98,17 +98,16 @@ The use of the term `n-1` is commonly referred to as Bessel's correction. Note,
 var sstdevch = require( '@stdlib/stats/base/sstdevch' );
 ```
 
-#### sstdevch( N, correction, x, stride )
+#### sstdevch( N, correction, x, strideX )
 
 Computes the [standard deviation][standard-deviation] of a single-precision floating-point strided array `x` using a one-pass trial mean algorithm.
 
 ```javascript
 var Float32Array = require( '@stdlib/array/float32' );
 
 var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );
-var N = x.length;
 
-var v = sstdevch( N, 1, x, 1 );
+var v = sstdevch( x.length, 1, x, 1 );
 // returns ~2.0817
 ```
 
@@ -117,18 +116,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 = sstdevch( N, 1, x, 2 );
+var v = sstdevch( 4, 1, x, 2 );
 // returns 2.5
 ```
 
@@ -138,45 +135,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 = sstdevch( N, 1, x1, 2 );
+var v = sstdevch( 4, 1, x1, 2 );
 // returns 2.5
 ```
 
-#### sstdevch.ndarray( N, correction, x, stride, offset )
+#### sstdevch.ndarray( N, correction, x, strideX, offsetX )
 
 Computes the [standard deviation][standard-deviation] of a single-precision floating-point strided array using a one-pass trial mean algorithm and 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 = sstdevch.ndarray( N, 1, x, 1, 0 );
+var v = sstdevch.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 = sstdevch.ndarray( N, 1, x, 2, 1 );
+var v = sstdevch.ndarray( 4, 1, x, 2, 1 );
 // returns 2.5
 ```
 
@@ -203,18 +194,12 @@ var v = sstdevch.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 sstdevch = require( '@stdlib/stats/base/sstdevch' );
 
-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 = sstdevch( x.length, 1, x, 1 );
@@ -225,6 +210,125 @@ 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/sstdevch.h"
+```
+
+#### stdlib_strided_sstdevch( N, correction, \*X, strideX )
+
+Computes the [standard deviation][standard-deviation] of a single-precision floating-point strided array using a one-pass trial mean algorithm.
+
+```c
+const float x[] = { 1.0f, -2.0f, 2.0f };
+
+float v = stdlib_strided_sstdevch( 3, 1.0f, x, 1 );
+// returns ~2.0817f
+```
+
+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_sstdevch( const CBLAS_INT N, const float correction, const float *X, const CBLAS_INT strideX );
+```
+
+#### stdlib_strided_sstdevch_ndarray( N, correction, \*X, strideX, offsetX )
+
+Computes the [standard deviation][standard-deviation] of a single-precision floating-point strided array using a one-pass trial mean algorithm and alternative indexing semantics.
+
+```c
+const float x[] = { 1.0f, -2.0f, 2.0f };
+
+float v = stdlib_strided_sstdevch_ndarray( 3, 1.0f, x, 1, 0 );
+// returns ~2.0817f
+```
+
+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_sstdevch_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/sstdevch.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 variance:
+    float v = stdlib_strided_sstdevch( N, 1.0f, x, strideX );
+
+    // Print the result:
+    printf( "sample standard deviation: %f\n", v );
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+</section>
+
+<!-- /.c -->
+
 * * *
 
 <section class="references">

diff --git a/lib/node_modules/@stdlib/stats/base/sstdevch/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/sstdevch/benchmark/benchmark.js
@@ -21,14 +21,20 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench' );
-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 Float32Array = require( '@stdlib/array/float32' );
 var pkg = require( './../package.json' ).name;
 var sstdevch = require( './../lib/sstdevch.js' );
 
 
+// VARIABLES //
+
+var options = {
+	'dtype': 'float32'
+};
+
+
 // FUNCTIONS //
 
 /**
@@ -39,13 +45,7 @@ var sstdevch = require( './../lib/sstdevch.js' );
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x;
-	var i;
-
-	x = new Float32Array( len );
-	for ( i = 0; i < x.length; i++ ) {
-		x[ i ] = ( randu()*20.0 ) - 10.0;
-	}
+	var x = uniform( len, -10.0, 10.0, options );
 	return benchmark;
 
 	function benchmark( b ) {

diff --git a/lib/node_modules/@stdlib/stats/base/sstdevch/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/sstdevch/benchmark/benchmark.native.js
@@ -22,10 +22,9 @@
 
 var resolve = require( 'path' ).resolve;
 var bench = require( '@stdlib/bench' );
-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 Float32Array = require( '@stdlib/array/float32' );
 var tryRequire = require( '@stdlib/utils/try-require' );
 var pkg = require( './../package.json' ).name;
 
@@ -36,6 +35,9 @@ var sstdevch = tryRequire( resolve( __dirname, './../lib/sstdevch.native.js' ) )
 var opts = {
 	'skip': ( sstdevch instanceof Error )
 };
+var options = {
+	'dtype': 'float32'
+};
 
 
 // FUNCTIONS //
@@ -48,13 +50,7 @@ var opts = {
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x;
-	var i;
-
-	x = new Float32Array( len );
-	for ( i = 0; i < x.length; i++ ) {
-		x[ i ] = ( randu()*20.0 ) - 10.0;
-	}
+	var x = uniform( len, -10.0, 10.0, options );
 	return benchmark;
 
 	function benchmark( b ) {

diff --git a/lib/node_modules/@stdlib/stats/base/sstdevch/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/base/sstdevch/benchmark/benchmark.ndarray.js
@@ -21,14 +21,20 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench' );
-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 Float32Array = require( '@stdlib/array/float32' );
 var pkg = require( './../package.json' ).name;
 var sstdevch = require( './../lib/ndarray.js' );
 
 
+// VARIABLES //
+
+var options = {
+	'dtype': 'float32'
+};
+
+
 // FUNCTIONS //
 
 /**
@@ -39,13 +45,7 @@ var sstdevch = require( './../lib/ndarray.js' );
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x;
-	var i;
-
-	x = new Float32Array( len );
-	for ( i = 0; i < x.length; i++ ) {
-		x[ i ] = ( randu()*20.0 ) - 10.0;
-	}
+	var x = uniform( len, -10.0, 10.0, options );
 	return benchmark;
 
 	function benchmark( b ) {

diff --git a/lib/node_modules/@stdlib/stats/base/sstdevch/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/stats/base/sstdevch/benchmark/benchmark.ndarray.native.js
@@ -22,10 +22,9 @@
 
 var resolve = require( 'path' ).resolve;
 var bench = require( '@stdlib/bench' );
-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 Float32Array = require( '@stdlib/array/float32' );
 var tryRequire = require( '@stdlib/utils/try-require' );
 var pkg = require( './../package.json' ).name;
 
@@ -36,6 +35,9 @@ var sstdevch = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) );
 var opts = {
 	'skip': ( sstdevch instanceof Error )
 };
+var options = {
+	'dtype': 'float32'
+};
 
 
 // FUNCTIONS //
@@ -48,13 +50,7 @@ var opts = {
 * @returns {Function} benchmark function
 */
 function createBenchmark( len ) {
-	var x;
-	var i;
-
-	x = new Float32Array( len );
-	for ( i = 0; i < x.length; i++ ) {
-		x[ i ] = ( randu()*20.0 ) - 10.0;
-	}
+	var x = uniform( len, -10.0, 10.0, options );
 	return benchmark;
 
 	function benchmark( b ) {