From b40bf0ebd5d0683caf39cd70676b03d6ee04c81e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 29 Dec 2024 02:01:10 +0000 Subject: [PATCH] Auto-generated commit --- CHANGELOG.md | 16 ++- README.md | 148 +++++++++++++++++++++---- benchmark/benchmark.js | 30 ++--- benchmark/benchmark.native.js | 30 ++--- benchmark/benchmark.ndarray.js | 30 ++--- benchmark/benchmark.ndarray.native.js | 30 ++--- benchmark/c/benchmark.length.c | 54 ++++++++- dist/index.js | 14 +-- dist/index.js.map | 8 +- docs/repl.txt | 32 +++--- examples/c/example.c | 9 +- include.gypi | 2 +- include/stdlib/stats/base/snanmaxabs.h | 9 +- lib/index.js | 7 +- lib/ndarray.js | 20 ++-- lib/ndarray.native.js | 20 +--- lib/snanmaxabs.js | 51 +-------- lib/snanmaxabs.native.js | 9 +- manifest.json | 75 ++++++++++++- package.json | 12 +- src/addon.c | 60 ++++++++++ src/addon.cpp | 117 ------------------- src/main.c | 83 ++++++++++++++ src/snanmaxabs.c | 72 ------------ test/test.ndarray.js | 13 +-- test/test.ndarray.native.js | 13 +-- test/test.snanmaxabs.js | 13 +-- test/test.snanmaxabs.native.js | 13 +-- 28 files changed, 562 insertions(+), 428 deletions(-) create mode 100644 src/addon.c delete mode 100644 src/addon.cpp create mode 100644 src/main.c delete mode 100644 src/snanmaxabs.c diff --git a/CHANGELOG.md b/CHANGELOG.md index 429c875..c3b26cf 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,7 +4,17 @@
-## Unreleased (2024-12-24) +## Unreleased (2024-12-29) + +
+ +### Features + +- [`ab52d49`](https://github.com/stdlib-js/stdlib/commit/ab52d49f6321b0af6d615d5ee90ee52c43feb42b) - add C ndarray interface and refactor implementation for `stats/base/snanmaxabs` [(#4328)](https://github.com/stdlib-js/stdlib/pull/4328) + +
+ +
@@ -12,6 +22,7 @@
+- [`ab52d49`](https://github.com/stdlib-js/stdlib/commit/ab52d49f6321b0af6d615d5ee90ee52c43feb42b) - **feat:** add C ndarray interface and refactor implementation for `stats/base/snanmaxabs` [(#4328)](https://github.com/stdlib-js/stdlib/pull/4328) _(by Aayush Khanna, stdlib-bot)_ - [`62364f6`](https://github.com/stdlib-js/stdlib/commit/62364f62ea823a3b52c2ad25660ecd80c71f8f36) - **style:** fix C comment alignment _(by Philipp Burckhardt)_ - [`9e689ff`](https://github.com/stdlib-js/stdlib/commit/9e689ffcb7c6223afc521f1e574b42f10921cf5e) - **chore:** fix indentation in manifest.json files _(by Philipp Burckhardt)_ - [`272ae7a`](https://github.com/stdlib-js/stdlib/commit/272ae7ac5c576c68cfab1b6e304c86407faa20cd) - **docs:** remove comment _(by Athan Reines)_ @@ -26,8 +37,9 @@ ### Contributors -A total of 2 people contributed to this release. Thank you to the following contributors: +A total of 3 people contributed to this release. Thank you to the following contributors: +- Aayush Khanna - Athan Reines - Philipp Burckhardt diff --git a/README.md b/README.md index 93a7395..0565644 100644 --- a/README.md +++ b/README.md @@ -69,7 +69,7 @@ To view installation and usage instructions specific to each branch build, be su var snanmaxabs = require( '@stdlib/stats-base-snanmaxabs' ); ``` -#### snanmaxabs( N, x, stride ) +#### snanmaxabs( N, x, strideX ) Computes the maximum absolute value of a single-precision floating-point strided array `x`, ignoring `NaN` values. @@ -77,9 +77,8 @@ Computes the maximum absolute value of a single-precision floating-point strided var Float32Array = require( '@stdlib/array-float32' ); var x = new Float32Array( [ 1.0, -2.0, NaN, 2.0 ] ); -var N = x.length; -var v = snanmaxabs( N, x, 1 ); +var v = snanmaxabs( x.length, x, 1 ); // returns 2.0 ``` @@ -87,18 +86,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 maximum absolute 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 maximum absolute 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 = snanmaxabs( N, x, 2 ); +var v = snanmaxabs( 4, x, 2 ); // returns 7.0 ``` @@ -108,18 +105,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 = snanmaxabs( N, x1, 2 ); +var v = snanmaxabs( 4, x1, 2 ); // returns 4.0 ``` -#### snanmaxabs.ndarray( N, x, stride, offset ) +#### snanmaxabs.ndarray( N, x, strideX, offsetX ) Computes the maximum absolute value of a single-precision floating-point strided array, ignoring `NaN` values and using alternative indexing semantics. @@ -127,26 +121,23 @@ Computes the maximum absolute value of a single-precision floating-point strided var Float32Array = require( '@stdlib/array-float32' ); var x = new Float32Array( [ 1.0, -2.0, NaN, 2.0 ] ); -var N = x.length; -var v = snanmaxabs.ndarray( N, x, 1, 0 ); +var v = snanmaxabs.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 maximum absolute 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 maximum absolute 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 = snanmaxabs.ndarray( N, x, 2, 1 ); +var v = snanmaxabs.ndarray( 4, x, 2, 1 ); // returns 4.0 ``` @@ -197,6 +188,123 @@ console.log( v ); + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/snanmaxabs.h" +``` + +#### stdlib_strided_snanmaxabs( N, \*X, strideX ) + +Computes the maximum absolute 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_snanmaxabs( 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_snanmaxabs( const CBLAS_INT N, const float *X, const CBLAS_INT strideX ); +``` + +#### stdlib_strided_snanmaxabs_ndarray( N, \*X, strideX, offsetX ) + +Computes the maximum absolute 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_snanmaxabs_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_snanmaxabs_ndarray( const CBLAS_INT N, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/snanmaxabs.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 maximum absolute value: + float v = stdlib_strided_snanmaxabs( N, x, strideX ); + + // Print the result: + printf( "maxabs: %f\n", v ); +} +``` + +
+ + + +
+ + +