From 9f86bc619db065369ef877eced46cfd709784aba Mon Sep 17 00:00:00 2001 From: Aayush Khanna <96649223+aayush0325@users.noreply.github.com> Date: Sat, 28 Dec 2024 02:49:48 +0530 Subject: [PATCH] feat: add C ndarray interface and refactor implementation for `stats/base/snanmin` PR-URL: https://github.com/stdlib-js/stdlib/pull/4292 Reviewed-by: Philipp Burckhardt --- .../@stdlib/stats/base/snanmin/README.md | 166 ++++++++++++++---- .../stats/base/snanmin/benchmark/benchmark.js | 29 +-- .../snanmin/benchmark/benchmark.native.js | 29 +-- .../snanmin/benchmark/benchmark.ndarray.js | 29 +-- .../benchmark/benchmark.ndarray.native.js | 29 +-- .../snanmin/benchmark/c/benchmark.length.c | 54 +++++- .../@stdlib/stats/base/snanmin/docs/repl.txt | 32 ++-- .../stats/base/snanmin/docs/types/index.d.ts | 12 +- .../stats/base/snanmin/examples/c/example.c | 9 +- .../stats/base/snanmin/examples/index.js | 18 +- .../@stdlib/stats/base/snanmin/include.gypi | 2 +- .../include/stdlib/stats/base/snanmin.h | 9 +- .../@stdlib/stats/base/snanmin/lib/index.js | 7 +- .../@stdlib/stats/base/snanmin/lib/ndarray.js | 20 +-- .../stats/base/snanmin/lib/ndarray.native.js | 20 +-- .../@stdlib/stats/base/snanmin/lib/snanmin.js | 51 +----- .../stats/base/snanmin/lib/snanmin.native.js | 9 +- .../@stdlib/stats/base/snanmin/manifest.json | 72 +++++++- .../@stdlib/stats/base/snanmin/src/addon.c | 60 +++++++ .../@stdlib/stats/base/snanmin/src/addon.cpp | 117 ------------ .../base/snanmin/src/{snanmin.c => main.c} | 45 +++-- .../stats/base/snanmin/test/test.ndarray.js | 13 +- .../base/snanmin/test/test.ndarray.native.js | 13 +- .../stats/base/snanmin/test/test.snanmin.js | 13 +- .../base/snanmin/test/test.snanmin.native.js | 13 +- 25 files changed, 479 insertions(+), 392 deletions(-) create mode 100644 lib/node_modules/@stdlib/stats/base/snanmin/src/addon.c delete mode 100644 lib/node_modules/@stdlib/stats/base/snanmin/src/addon.cpp rename lib/node_modules/@stdlib/stats/base/snanmin/src/{snanmin.c => main.c} (54%) diff --git a/lib/node_modules/@stdlib/stats/base/snanmin/README.md b/lib/node_modules/@stdlib/stats/base/snanmin/README.md index f131ddc5f25b..145725c11bb4 100644 --- a/lib/node_modules/@stdlib/stats/base/snanmin/README.md +++ b/lib/node_modules/@stdlib/stats/base/snanmin/README.md @@ -36,7 +36,7 @@ limitations under the License. var snanmin = require( '@stdlib/stats/base/snanmin' ); ``` -#### snanmin( N, x, stride ) +#### snanmin( N, x, strideX ) Computes the minimum value of a single-precision floating-point strided array `x`, ignoring `NaN` values. @@ -44,9 +44,8 @@ Computes the minimum value of a single-precision floating-point strided array `x var Float32Array = require( '@stdlib/array/float32' ); var x = new Float32Array( [ 1.0, -2.0, NaN, 2.0 ] ); -var N = x.length; -var v = snanmin( N, x, 1 ); +var v = snanmin( x.length, x, 1 ); // returns -2.0 ``` @@ -54,18 +53,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 minimum value 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 minimum value 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, -7.0, -2.0, 4.0, 3.0, NaN, NaN ] ); -var N = floor( x.length / 2 ); -var v = snanmin( N, x, 2 ); +var v = snanmin( 4, x, 2 ); // returns -7.0 ``` @@ -75,18 +72,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, 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 = snanmin( N, x1, 2 ); +var v = snanmin( 4, x1, 2 ); // returns -2.0 ``` -#### snanmin.ndarray( N, x, stride, offset ) +#### snanmin.ndarray( N, x, strideX, offsetX ) Computes the minimum value of a single-precision floating-point strided array, ignoring `NaN` values and using alternative indexing semantics. @@ -94,26 +88,23 @@ Computes the minimum value of a single-precision floating-point strided array, i var Float32Array = require( '@stdlib/array/float32' ); var x = new Float32Array( [ 1.0, -2.0, NaN, 2.0 ] ); -var N = x.length; -var v = snanmin.ndarray( N, x, 1, 0 ); +var v = snanmin.ndarray( x.length, x, 1, 0 ); // returns -2.0 ``` 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 minimum value 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 minimum value 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, 3.0, 4.0, NaN, NaN ] ); -var N = floor( x.length / 2 ); -var v = snanmin.ndarray( N, x, 2, 1 ); +var v = snanmin.ndarray( 4, x, 2, 1 ); // returns -2.0 ``` @@ -138,22 +129,12 @@ var v = snanmin.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 discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); var snanmin = require( '@stdlib/stats/base/snanmin' ); -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 ); - } -} +var x = discreteUniform( 10, -50, 50, { + 'dtype': 'float32' +}); console.log( x ); var v = snanmin( x.length, x, 1 ); @@ -164,6 +145,123 @@ console.log( v ); + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/snanmin.h" +``` + +#### stdlib_strided_snanmin( N, \*X, strideX ) + +Computes the minimum value of a single-precision floating-point strided array `x`, ignoring `NaN` values. + +```c +const float x[] = { 1.0f, -2.0f, 0.0f/0.0f, -4.0f }; + +float v = stdlib_strided_snanmin( 4, x, 1 ); +// returns -4.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_snanmin( const CBLAS_INT N, const float *X, const CBLAS_INT strideX ); +``` + +#### stdlib_strided_snanmin_ndarray( N, \*X, strideX, offsetX ) + +Computes the minimum value of a single-precision floating-point strided array, ignoring `NaN` values and using alternative indexing semantics. + +```c +const float x[] = { 1.0f, -2.0f, 0.0f/0.0f, -4.0f }; + +float v = stdlib_strided_snanmin_ndarray( 4, x, 1, 0 ); +// returns -4.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_snanmin_ndarray( const CBLAS_INT N, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/snanmin.h" +#include + +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, 0.0f/0.0f, 0.0f/0.0f }; + + // Specify the number of elements: + const int N = 5; + + // Specify the stride length: + const int strideX = 2; + + // Compute the minimum value: + float v = stdlib_strided_snanmin( N, x, strideX ); + + // Print the result: + printf( "min: %f\n", v ); +} +``` + +
+ + + +
+ + +