From 873d5f7f20d9883b4b49b2bdfb36939a4d4aa7c5 Mon Sep 17 00:00:00 2001 From: headlessNode Date: Fri, 11 Oct 2024 14:24:57 +0500 Subject: [PATCH] feat: add C ndarray API and refactor --- .../blas/ext/base/dnansumors/README.md | 128 +++++++++++++++++- .../dnansumors/benchmark/c/benchmark.length.c | 52 ++++++- .../blas/ext/base/dnansumors/docs/repl.txt | 15 +- .../ext/base/dnansumors/docs/types/index.d.ts | 12 +- .../ext/base/dnansumors/examples/c/example.c | 7 +- .../include/stdlib/blas/ext/base/dnansumors.h | 9 +- .../ext/base/dnansumors/lib/dnansumors.js | 34 +---- .../base/dnansumors/lib/dnansumors.native.js | 6 +- .../blas/ext/base/dnansumors/lib/ndarray.js | 17 +-- .../ext/base/dnansumors/lib/ndarray.native.js | 15 +- .../blas/ext/base/dnansumors/manifest.json | 31 +++-- .../blas/ext/base/dnansumors/src/addon.c | 27 +++- .../blas/ext/base/dnansumors/src/dnansumors.c | 58 -------- .../blas/ext/base/dnansumors/src/main.c | 70 ++++++++++ .../base/dnansumors/test/test.dnansumors.js | 4 +- .../dnansumors/test/test.dnansumors.native.js | 4 +- .../ext/base/dnansumors/test/test.ndarray.js | 4 +- .../dnansumors/test/test.ndarray.native.js | 4 +- 18 files changed, 333 insertions(+), 164 deletions(-) delete mode 100644 lib/node_modules/@stdlib/blas/ext/base/dnansumors/src/dnansumors.c create mode 100644 lib/node_modules/@stdlib/blas/ext/base/dnansumors/src/main.c diff --git a/lib/node_modules/@stdlib/blas/ext/base/dnansumors/README.md b/lib/node_modules/@stdlib/blas/ext/base/dnansumors/README.md index 4f17dfb8836..bedda224ad5 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dnansumors/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/dnansumors/README.md @@ -36,7 +36,7 @@ limitations under the License. var dnansumors = require( '@stdlib/blas/ext/base/dnansumors' ); ``` -#### dnansumors( N, x, stride ) +#### dnansumors( N, x, strideX ) Computes the sum of double-precision floating-point strided array elements, ignoring `NaN` values and using ordinary recursive summation. @@ -54,7 +54,7 @@ The function has the following parameters: - **N**: number of indexed elements. - **x**: input [`Float64Array`][@stdlib/array/float64]. -- **stride**: index increment for `x`. +- **strideX**: index increment for `x`. The `N` and stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to compute the sum of every other element in `x`, @@ -82,7 +82,7 @@ var v = dnansumors( 4, x1, 2 ); // returns 5.0 ``` -#### dnansumors.ndarray( N, x, stride, offset ) +#### dnansumors.ndarray( N, x, strideX, offsetX ) Computes the sum of double-precision floating-point strided array elements, ignoring `NaN` values and using ordinary recursive summation and alternative indexing semantics. @@ -97,9 +97,9 @@ var v = dnansumors.ndarray( 4, x, 1, 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 sum of 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 sum of every other value in `x` starting from the second value ```javascript var Float64Array = require( '@stdlib/array/float64' ); @@ -155,6 +155,124 @@ console.log( v ); + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/blas/ext/base/dnansumors.h" +``` + +#### stdlib_strided_dnansumors( N, \*X, strideX ) + +Computes the sum of double-precision floating-point strided array elements, ignoring `NaN` values and using ordinary recursive summation. + +```c +const double x[] = { 1.0, 2.0, 0.0/0.0, 4.0 }; + +double v = stdlib_strided_dnansumors( 4, x, 1 ); +// returns 7.0 +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **X**: `[in] double*` input array. +- **strideX**: `[in] CBLAS_INT` index increment for `X`. + +```c +double stdlib_strided_dnansumors( const CBLAS_INT N, const double *X, const CBLAS_INT strideX ); +``` + +#### stdlib_strided_dnansumors_ndarray( N, \*X, strideX, offsetX ) + +Computes the sum of double-precision floating-point strided array elements, ignoring `NaN` values and using ordinary recursive summation and alternative indexing semantics. + +```c +const double x[] = { 1.0, 2.0, 0.0/0.0, 4.0 }; + +double v = stdlib_strided_dnansumors_ndarray( 4, x, 1, 0 ); +// returns 7.0 +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **X**: `[in] double*` input array. +- **strideX**: `[in] CBLAS_INT` index increment for `X`. +- **offsetX**: `[in] CBLAS_INT` starting index for `X`. + +```c +double stdlib_strided_dnansumors_ndarray( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/blas/ext/base/dnansumors.h" +#include "stdlib/blase/base/shared.h" +#include + +int main( void ) { + // Create a strided array: + const double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 0.0/0.0, 0.0/0.0 }; + + // Specify the number of elements: + const int N = 5; + + // Specify the stride length: + const int strideX = 2; + + // Compute the sum: + double v = stdlib_strided_dnansumors( N, x, strideX ); + + // Print the result: + printf( "sum: %lf\n", v ); +} +``` + +
+ + + +
+ + +