From 4311c9c06c0692323e038a021495afdecdb5bd9b Mon Sep 17 00:00:00 2001 From: gururaj1512 Date: Sun, 20 Jul 2025 17:58:52 +0000 Subject: [PATCH 1/2] feat: add C ndarray interface and refactor implementation for `stats/base/snanmean` --- 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: missing_dependencies - task: lint_c_examples status: missing_dependencies - task: lint_c_benchmarks status: missing_dependencies - 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/stats/base/snanmean/README.md | 179 ++++++++++++++---- .../base/snanmean/benchmark/benchmark.js | 30 +-- .../snanmean/benchmark/benchmark.native.js | 30 +-- .../snanmean/benchmark/benchmark.ndarray.js | 30 +-- .../benchmark/benchmark.ndarray.native.js | 30 +-- .../snanmean/benchmark/c/benchmark.length.c | 58 +++++- .../@stdlib/stats/base/snanmean/docs/repl.txt | 36 ++-- .../stats/base/snanmean/docs/types/index.d.ts | 12 +- .../stats/base/snanmean/examples/c/example.c | 9 +- .../stats/base/snanmean/examples/index.js | 21 +- .../include/stdlib/stats/base/snanmean.h | 9 +- .../@stdlib/stats/base/snanmean/lib/index.js | 9 +- .../stats/base/snanmean/lib/ndarray.js | 14 +- .../stats/base/snanmean/lib/ndarray.native.js | 22 +-- .../stats/base/snanmean/lib/snanmean.js | 12 +- .../base/snanmean/lib/snanmean.native.js | 9 +- .../@stdlib/stats/base/snanmean/manifest.json | 45 +++-- .../@stdlib/stats/base/snanmean/src/addon.c | 26 ++- .../@stdlib/stats/base/snanmean/src/main.c | 48 +++++ .../stats/base/snanmean/src/snanmean.c | 33 ---- .../stats/base/snanmean/test/test.ndarray.js | 13 +- .../base/snanmean/test/test.ndarray.native.js | 13 +- .../stats/base/snanmean/test/test.snanmean.js | 13 +- .../snanmean/test/test.snanmean.native.js | 13 +- 24 files changed, 449 insertions(+), 265 deletions(-) create mode 100644 lib/node_modules/@stdlib/stats/base/snanmean/src/main.c delete mode 100644 lib/node_modules/@stdlib/stats/base/snanmean/src/snanmean.c diff --git a/lib/node_modules/@stdlib/stats/base/snanmean/README.md b/lib/node_modules/@stdlib/stats/base/snanmean/README.md index f4ff7acde953..6960636ccbc1 100644 --- a/lib/node_modules/@stdlib/stats/base/snanmean/README.md +++ b/lib/node_modules/@stdlib/stats/base/snanmean/README.md @@ -51,17 +51,16 @@ The [arithmetic mean][arithmetic-mean] is defined as var snanmean = require( '@stdlib/stats/base/snanmean' ); ``` -#### snanmean( N, x, stride ) +#### snanmean( N, x, strideX ) -Computes the [arithmetic mean][arithmetic-mean] of a single-precision floating-point strided array `x`, ignoring `NaN` values. +Computes the [arithmetic mean][arithmetic-mean] of a single-precision floating-point strided array, ignoring `NaN` values. ```javascript var Float32Array = require( '@stdlib/array/float32' ); var x = new Float32Array( [ 1.0, -2.0, NaN, 2.0 ] ); -var N = x.length; -var v = snanmean( N, x, 1 ); +var v = snanmean( x.length, x, 1 ); // returns ~0.3333 ``` @@ -69,39 +68,34 @@ The function has the following parameters: - **N**: number of indexed elements. - **x**: input [`Float32Array`][@stdlib/array/float32]. -- **stride**: index increment for `x`. +- **strideX**: stride length. -The `N` and `stride` parameters determine which elements in `x` are accessed at runtime. For example, to compute the [arithmetic mean][arithmetic-mean] 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 [arithmetic mean][arithmetic-mean] 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, NaN ] ); -var N = floor( x.length / 2 ); -var v = snanmean( N, x, 2 ); +var v = snanmean( 4, x, 2 ); // returns 1.25 ``` Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views. - + ```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, NaN ] ); +var x0 = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] ); var x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element -var N = floor( x0.length / 2 ); - -var v = snanmean( N, x1, 2 ); +var v = snanmean( 5, x1, 2 ); // returns 1.25 ``` -#### snanmean.ndarray( N, x, stride, offset ) +#### snanmean.ndarray( N, x, strideX, offsetX ) Computes the [arithmetic mean][arithmetic-mean] of a single-precision floating-point strided array, ignoring `NaN` values and using alternative indexing semantics. @@ -109,26 +103,25 @@ Computes the [arithmetic mean][arithmetic-mean] of a single-precision floating-p var Float32Array = require( '@stdlib/array/float32' ); var x = new Float32Array( [ 1.0, -2.0, NaN, 2.0 ] ); -var N = x.length; -var v = snanmean.ndarray( N, x, 1, 0 ); +var v = snanmean.ndarray( x.length, x, 1, 0 ); // returns ~0.33333 ``` The function has the following additional parameters: -- **offset**: starting index for `x`. +- **offsetX**: starting index. + +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 [arithmetic mean][arithmetic-mean] for every other element in `x` starting from the second element -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 [arithmetic mean][arithmetic-mean] for every other value in `x` starting from the second value + ```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, NaN ] ); -var N = floor( x.length / 2 ); +var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] ); -var v = snanmean.ndarray( N, x, 2, 1 ); +var v = snanmean.ndarray( 5, x, 2, 1 ); // returns 1.25 ``` @@ -154,22 +147,19 @@ var v = snanmean.ndarray( N, x, 2, 1 ); ```javascript -var randu = require( '@stdlib/random/base/randu' ); -var round = require( '@stdlib/math/base/special/round' ); -var Float32Array = require( '@stdlib/array/float32' ); +var uniform = require( '@stdlib/random/base/uniform' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); +var bernoulli = require( '@stdlib/random/base/bernoulli' ); var snanmean = require( '@stdlib/stats/base/snanmean' ); -var x; -var i; - -x = new Float32Array( 10 ); -for ( i = 0; i < x.length; i++ ) { - if ( randu() < 0.2 ) { - x[ i ] = NaN; - } else { - 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, 'float32', rand ); console.log( x ); var v = snanmean( x.length, x, 1 ); @@ -180,6 +170,123 @@ console.log( v ); + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/snanmean.h" +``` + +#### stdlib_strided_snanmean( N, \*X, strideX ) + +Computes the [arithmetic mean][arithmetic-mean] of a single-precision floating-point strided array, ignoring `NaN` values. + +```c +const float x[] = { 1.0f, 2.0f, 3.0f, 0.0f/0.0f }; + +float v = stdlib_strided_snanmean( 4, x, 1 ); +// returns 2.0f +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **X**: `[in] float*` input array. +- **strideX**: `[in] CBLAS_INT` stride length. + +```c +float stdlib_strided_snanmean( const CBLAS_INT N, const float *X, const CBLAS_INT strideX ); +``` + +#### stdlib_strided_snanmean_ndarray( N, \*X, strideX, offsetX ) + +Computes the [arithmetic mean][arithmetic-mean] of a single-precision floating-point strided array, ignoring `NaN` values and using alternative indexing semantics. + +```c +const float x[] = { 1.0f, 2.0f, 3.0f, 0.0f/0.0f }; + +float v = stdlib_strided_snanmean_ndarray( 4, x, 1, 0 ); +// returns 2.0f +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **X**: `[in] float*` input array. +- **strideX**: `[in] CBLAS_INT` stride length. +- **offsetX**: `[in] CBLAS_INT` starting index. + +```c +float stdlib_strided_snanmean_ndarray( const CBLAS_INT N, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/snanmean.h" +#include + +int main( void ) { + // Create a strided array: + const float x[] = { 1.0f, 2.0f, 0.0f/0.0f, 3.0f, 0.0f/0.0f, 4.0f, 5.0f, 6.0f, 0.0f/0.0f, 7.0f, 8.0f, 0.0f/0.0f }; + + // Specify the number of elements: + const int N = 6; + + // Specify the stride length: + const int strideX = 2; + + // Compute the arithmetic mean: + float v = stdlib_strided_snanmean( N, x, strideX ); + + // Print the result: + printf( "mean: %f\n", v ); +} +``` + +
+ + + +
+ + +