From 1635a0e4911c31f65b4247d876ac399b99d46963 Mon Sep 17 00:00:00 2001 From: JoyBoy <144602492+0PrashantYadav0@users.noreply.github.com> Date: Sun, 26 Jan 2025 14:36:25 +0530 Subject: [PATCH 1/9] 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: na - 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: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- .../@stdlib/stats/base/sdsnanmean/README.md | 168 ++++++++++++++---- .../base/sdsnanmean/benchmark/benchmark.js | 30 ++-- .../sdsnanmean/benchmark/benchmark.native.js | 30 ++-- .../sdsnanmean/benchmark/benchmark.ndarray.js | 30 ++-- .../benchmark/benchmark.ndarray.native.js | 30 ++-- .../sdsnanmean/benchmark/c/benchmark.length.c | 60 ++++++- .../base/sdsnanmean/examples/c/example.c | 9 +- .../stats/base/sdsnanmean/examples/index.js | 21 +-- .../include/stdlib/stats/base/sdsnanmean.h | 9 +- .../stats/base/sdsnanmean/lib/index.js | 6 +- .../stats/base/sdsnanmean/lib/ndarray.js | 12 +- .../base/sdsnanmean/lib/ndarray.native.js | 20 +-- .../stats/base/sdsnanmean/lib/sdsnanmean.js | 12 +- .../base/sdsnanmean/lib/sdsnanmean.native.js | 9 +- .../stats/base/sdsnanmean/manifest.json | 42 +++-- .../@stdlib/stats/base/sdsnanmean/src/addon.c | 28 ++- .../@stdlib/stats/base/sdsnanmean/src/main.c | 47 +++++ .../stats/base/sdsnanmean/src/sdsnanmean.c | 33 ---- .../base/sdsnanmean/test/test.ndarray.js | 13 +- .../sdsnanmean/test/test.ndarray.native.js | 13 +- .../base/sdsnanmean/test/test.sdsnanmean.js | 13 +- .../sdsnanmean/test/test.sdsnanmean.native.js | 13 +- 22 files changed, 414 insertions(+), 234 deletions(-) create mode 100644 lib/node_modules/@stdlib/stats/base/sdsnanmean/src/main.c delete mode 100644 lib/node_modules/@stdlib/stats/base/sdsnanmean/src/sdsnanmean.c diff --git a/lib/node_modules/@stdlib/stats/base/sdsnanmean/README.md b/lib/node_modules/@stdlib/stats/base/sdsnanmean/README.md index cc496e85f3da..c116d1cbb8bd 100644 --- a/lib/node_modules/@stdlib/stats/base/sdsnanmean/README.md +++ b/lib/node_modules/@stdlib/stats/base/sdsnanmean/README.md @@ -51,7 +51,7 @@ The [arithmetic mean][arithmetic-mean] is defined as var sdsnanmean = require( '@stdlib/stats/base/sdsnanmean' ); ``` -#### sdsnanmean( N, x, stride ) +#### sdsnanmean( N, x, strideX ) Computes the [arithmetic mean][arithmetic-mean] of a single-precision floating-point strided array `x`, ignoring `NaN` values and using extended accumulation. @@ -61,7 +61,7 @@ var Float32Array = require( '@stdlib/array/float32' ); var x = new Float32Array( [ 1.0, -2.0, NaN, 2.0 ] ); var N = x.length; -var v = sdsnanmean( N, x, 1 ); +var v = sdsnanmean( x.length, x, 1 ); // returns ~0.3333 ``` @@ -69,18 +69,16 @@ 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 for `x`. -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 = sdsnanmean( N, x, 2 ); +var v = sdsnanmean( 4, x, 2 ); // returns 1.25 ``` @@ -90,18 +88,15 @@ 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, NaN ] ); var x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element -var N = floor( x0.length / 2 ); - -var v = sdsnanmean( N, x1, 2 ); +var v = sdsnanmean( 4, x1, 2 ); // returns 1.25 ``` -#### sdsnanmean.ndarray( N, x, stride, offset ) +#### sdsnanmean.ndarray( N, x, strideX, offsetX ) Computes the [arithmetic mean][arithmetic-mean] of a single-precision floating-point strided array, ignoring `NaN` values and using extended accumulation and alternative indexing semantics. @@ -109,26 +104,23 @@ 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 = sdsnanmean.ndarray( N, x, 1, 0 ); +var v = sdsnanmean.ndarray( x.length, x, 1, 0 ); // returns ~0.33333 ``` 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 [arithmetic mean][arithmetic-mean] 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 [arithmetic mean][arithmetic-mean] 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, NaN ] ); -var N = floor( x.length / 2 ); -var v = sdsnanmean.ndarray( N, x, 2, 1 ); +var v = sdsnanmean.ndarray( 4, x, 2, 1 ); // returns 1.25 ``` @@ -155,23 +147,18 @@ var v = sdsnanmean.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 sdsnanmean = require( '@stdlib/stats/base/sdsnanmean' ); -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 ); } -console.log( x ); +var x = filledarrayBy( 10, 'float32', rand ); var v = sdsnanmean( x.length, x, 1 ); console.log( v ); @@ -181,6 +168,123 @@ console.log( v ); + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/sdsnanmean.h" +``` + +#### stdlib_strided_sdsnanmean( N, \*X, strideX ) + +Computes the [arithmetic mean][arithmetic-mean] of a single-precision floating-point strided array, ignoring `NaN` values and using extended accumulation. + +```c +const float x[] = { 1.0f, 2.0f, 3.0f, 0.0f/0.0f }; + +float v = stdlib_strided_sdsnanmean( 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 for `X`. + +```c +float stdlib_strided_sdsnanmean( const CBLAS_INT N, const float *X, const CBLAS_INT strideX ); +``` + +#### stdlib_strided_sdsnanmean_ndarray( N, \*X, strideX, offsetX ) + +Computes the [arithmetic mean][arithmetic-mean] of a single-precision floating-point strided array, ignoring `NaN` values and using extended accumulation and alternative indexing semantics. + +```c +const float x[] = { 1.0f, 2.0f, 3.0f, 0.0f/0.0f }; + +float v = stdlib_strided_sdsnanmean_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 for `X`. +- **offsetX**: `[in] CBLAS_INT` starting index for `X`. + +```c +float stdlib_strided_sdsnanmean_ndarray( const CBLAS_INT N, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/sdsnanmean.h" +#include + +int main( void ) { + // Create a strided array: + const float x[] = { 1.0, 2.0, 0.0/0.0, 3.0, 0.0/0.0, 4.0, 5.0, 6.0, 0.0/0.0, 7.0, 8.0, 0.0/0.0 }; + + // 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_sdsnanmean( N, x, strideX ); + + // Print the result: + printf( "mean: %f\n", v ); +} +``` + +
+ + + +
+ + +