From 1fd7d4e597e25713ad47182b734a864b8018617a Mon Sep 17 00:00:00 2001 From: Muhammad Haris <101793258+headlessNode@users.noreply.github.com> Date: Fri, 24 Jan 2025 10:57:41 +0000 Subject: [PATCH] feat: add C ndarray API and refactor --- 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 --- --- 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/blas/ext/base/sdsnansum/README.md | 138 ++++++++++++++++-- .../ext/base/sdsnansum/benchmark/benchmark.js | 10 +- .../sdsnansum/benchmark/benchmark.native.js | 10 +- .../sdsnansum/benchmark/benchmark.ndarray.js | 10 +- .../benchmark/benchmark.ndarray.native.js | 10 +- .../sdsnansum/benchmark/c/benchmark.length.c | 54 ++++++- .../blas/ext/base/sdsnansum/docs/repl.txt | 33 ++--- .../ext/base/sdsnansum/docs/types/index.d.ts | 12 +- .../ext/base/sdsnansum/examples/c/example.c | 11 +- .../blas/ext/base/sdsnansum/examples/index.js | 2 +- .../include/stdlib/blas/ext/base/sdsnansum.h | 9 +- .../blas/ext/base/sdsnansum/lib/index.js | 3 +- .../blas/ext/base/sdsnansum/lib/ndarray.js | 8 +- .../ext/base/sdsnansum/lib/ndarray.native.js | 16 +- .../blas/ext/base/sdsnansum/lib/sdsnansum.js | 9 +- .../base/sdsnansum/lib/sdsnansum.native.js | 9 +- .../blas/ext/base/sdsnansum/manifest.json | 31 ++-- .../blas/ext/base/sdsnansum/src/addon.c | 30 +++- .../blas/ext/base/sdsnansum/src/main.c | 48 ++++++ .../blas/ext/base/sdsnansum/src/sdsnansum.c | 33 ----- .../ext/base/sdsnansum/test/test.ndarray.js | 4 +- .../sdsnansum/test/test.ndarray.native.js | 4 +- .../ext/base/sdsnansum/test/test.sdsnansum.js | 4 +- .../sdsnansum/test/test.sdsnansum.native.js | 4 +- 24 files changed, 357 insertions(+), 145 deletions(-) create mode 100644 lib/node_modules/@stdlib/blas/ext/base/sdsnansum/src/main.c delete mode 100644 lib/node_modules/@stdlib/blas/ext/base/sdsnansum/src/sdsnansum.c diff --git a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/README.md b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/README.md index e7143da00c09..68dddd14b5ef 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/README.md @@ -36,7 +36,7 @@ limitations under the License. var sdsnansum = require( '@stdlib/blas/ext/base/sdsnansum' ); ``` -#### sdsnansum( N, x, stride ) +#### sdsnansum( N, x, strideX ) Computes the sum of single-precision floating-point strided array elements, ignoring `NaN` values and using extended accumulation. @@ -53,9 +53,9 @@ The function has the following parameters: - **N**: number of indexed elements. - **x**: input [`Float32Array`][@stdlib/array/float32]. -- **stride**: index increment for the strided array. +- **strideX**: stride length. -The `N` and `stride` parameters determine which elements in the strided array are accessed at runtime. For example, to compute the sum of every other element in the strided array, +The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to compute the sum of every other element: ```javascript var Float32Array = require( '@stdlib/array/float32' ); @@ -80,7 +80,7 @@ var v = sdsnansum( 4, x1, 2 ); // returns 5.0 ``` -#### sdsnansum.ndarray( N, x, stride, offset ) +#### sdsnansum.ndarray( N, x, strideX, offsetX ) Computes the sum of single-precision floating-point strided array elements, ignoring `NaN` values and using extended accumulation and alternative indexing semantics. @@ -88,17 +88,16 @@ Computes the sum of single-precision floating-point strided array elements, igno var Float32Array = require( '@stdlib/array/float32' ); var x = new Float32Array( [ 1.0, -2.0, NaN, 2.0 ] ); -var N = x.length; -var v = sdsnansum.ndarray( N, x, 1, 0 ); +var v = sdsnansum.ndarray( x.length, x, 1, 0 ); // returns 1.0 ``` The function has the following additional parameters: -- **offset**: starting index for the strided array. +- **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 sum of every other value in the strided array 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 element starting from the second element: ```javascript var Float32Array = require( '@stdlib/array/float32' ); @@ -136,14 +135,14 @@ var bernoulli = require( '@stdlib/random/base/bernoulli' ); var filledarrayBy = require( '@stdlib/array/filled-by' ); var sdsnansum = require( '@stdlib/blas/ext/base/sdsnansum' ); -function randOrNan() { - if ( bernoulli() < 0.2 ) { +function rand() { + if ( bernoulli( 0.5 ) < 1 ) { return NaN; } return discreteUniform( 0, 100 ); } -var x = filledarrayBy( 10, 'float32', randOrNan ); +var x = filledarrayBy( 10, 'float32', rand ); console.log( x ); var v = sdsnansum( x.length, x, 1 ); @@ -154,6 +153,123 @@ console.log( v ); + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/blas/ext/base/sdsnansum.h" +``` + +#### stdlib_strided_sdsnansum( N, \*X, strideX ) + +Computes the sum of single-precision floating-point strided array elements, ignoring `NaN` values and using extended accumulation. + +```c +const float x[] = { 1.0f, -2.0f, 0.0f/0.0f, 2.0f }; + +float v = stdlib_strided_sdsnansum( 4, x, 1 ); +// returns 1.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_sdsnansum( const CBLAS_INT N, const float *X, const CBLAS_INT strideX ); +``` + +#### stdlib_strided_sdsnansum_ndarray( N, \*X, strideX, offsetX ) + +Computes the sum of single-precision floating-point strided array elements, ignoring `NaN` values and using extended accumulation and alternative indexing semantics. + +```c +const float x[] = { 1.0f, -2.0f, 0.0f/0.0f, 2.0f }; + +float v = stdlib_strided_sdsnansum_ndarray( 4, x, 1, 0 ); +// returns 1.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_sdsnansum_ndarray( const CBLAS_INT N, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/blas/ext/base/sdsnansum.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 sum: + float v = stdlib_strided_sdsnansum( N, x, strideX ); + + // Print the result: + printf( "Sum: %f\n", v ); +} +``` + +
+ + + +
+ + +
diff --git a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/benchmark/benchmark.js index 79881ee1a5db..ad6690d194bd 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/benchmark/benchmark.js @@ -32,11 +32,17 @@ var sdsnansum = require( './../lib/sdsnansum.js' ); // FUNCTIONS // +/** +* Returns a random number. +* +* @private +* @returns {number} random number +*/ function rand() { - if ( bernoulli( 0.2 ) ) { + if ( bernoulli( 0.5 ) < 1 ) { return NaN; } - return uniform( -20.0, -10.0 ); + return uniform( -10, 10 ); } /** diff --git a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/benchmark/benchmark.native.js index 2d45cdbb2f38..d7b21fbb69e6 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/benchmark/benchmark.native.js @@ -41,11 +41,17 @@ var opts = { // FUNCTIONS // +/** +* Returns a random number. +* +* @private +* @returns {number} random number +*/ function rand() { - if ( bernoulli( 0.2 ) ) { + if ( bernoulli( 0.5 ) < 1 ) { return NaN; } - return uniform( -20.0, -10.0 ); + return uniform( -10, 10 ); } /** diff --git a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/benchmark/benchmark.ndarray.js index 2e1b0a9ce2d5..c1957def6f04 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/benchmark/benchmark.ndarray.js @@ -32,11 +32,17 @@ var sdsnansum = require( './../lib/ndarray.js' ); // FUNCTIONS // +/** +* Returns a random number. +* +* @private +* @returns {number} random number +*/ function rand() { - if ( bernoulli( 0.2 ) ) { + if ( bernoulli( 0.5 ) < 1 ) { return NaN; } - return uniform( -20.0, -10.0 ); + return uniform( -10, 10 ); } /** diff --git a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/benchmark/benchmark.ndarray.native.js index 3f07e732a32e..de8169444b09 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/benchmark/benchmark.ndarray.native.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/benchmark/benchmark.ndarray.native.js @@ -41,11 +41,17 @@ var opts = { // FUNCTIONS // +/** +* Returns a random number. +* +* @private +* @returns {number} random number +*/ function rand() { - if ( bernoulli( 0.2 ) ) { + if ( bernoulli( 0.5 ) < 1 ) { return NaN; } - return uniform( -20.0, -10.0 ); + return uniform( -10, 10 ); } /** diff --git a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/benchmark/c/benchmark.length.c b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/benchmark/c/benchmark.length.c index 1e447af019bd..991b8a75382f 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/benchmark/c/benchmark.length.c +++ b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/benchmark/c/benchmark.length.c @@ -94,7 +94,7 @@ static float rand_float( void ) { * @param len array length * @return elapsed time in seconds */ -static double benchmark( int iterations, int len ) { +static double benchmark1( int iterations, int len ) { double elapsed; float x[ len ]; float v; @@ -111,6 +111,7 @@ static double benchmark( int iterations, int len ) { v = 0.0f; t = tic(); for ( i = 0; i < iterations; i++ ) { + // cppcheck-suppress uninitvar v = stdlib_strided_sdsnansum( len, x, 1 ); if ( v != v ) { printf( "should not return NaN\n" ); @@ -124,6 +125,44 @@ static double benchmark( int iterations, int len ) { return elapsed; } +/** +* Runs a benchmark. +* +* @param iterations number of iterations +* @param len array length +* @return elapsed time in seconds +*/ +static double benchmark2( int iterations, int len ) { + double elapsed; + float x[ len ]; + float v; + double t; + int i; + + for ( i = 0; i < len; i++ ) { + if ( rand_float() < 0.2f ) { + x[ i ] = 0.0f / 0.0f; // NaN + } else { + x[ i ] = ( rand_float()*20000.0f ) - 10000.0f; + } + } + v = 0.0f; + t = tic(); + for ( i = 0; i < iterations; i++ ) { + // cppcheck-suppress uninitvar + v = stdlib_strided_sdsnansum_ndarray( len, x, 1, 0 ); + if ( v != v ) { + printf( "should not return NaN\n" ); + break; + } + } + elapsed = tic() - t; + if ( v != v ) { + printf( "should not return NaN\n" ); + } + return elapsed; +} + /** * Main execution sequence. */ @@ -146,7 +185,18 @@ int main( void ) { for ( j = 0; j < REPEATS; j++ ) { count += 1; printf( "# c::%s:len=%d\n", NAME, len ); - elapsed = benchmark( iter, len ); + elapsed = benchmark1( iter, len ); + print_results( iter, elapsed ); + printf( "ok %d benchmark finished\n", count ); + } + } + for ( i = MIN; i <= MAX; i++ ) { + len = pow( 10, i ); + iter = ITERATIONS / pow( 10, i-1 ); + for ( j = 0; j < REPEATS; j++ ) { + count += 1; + printf( "# c::%s:ndarray:len=%d\n", NAME, len ); + elapsed = benchmark2( iter, len ); print_results( iter, elapsed ); printf( "ok %d benchmark finished\n", count ); } diff --git a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/docs/repl.txt index 2a035ced8f64..d584fecf6076 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/docs/repl.txt @@ -1,11 +1,10 @@ -{{alias}}( N, x, stride ) - Computes the sum of single-precision floating-point strided array - elements, ignore `NaN` values and using extended accumulation. +{{alias}}( N, x, strideX ) + Computes the sum of single-precision floating-point strided array elements, + ignore `NaN` values and using extended accumulation. - The `N` and `stride` parameters determine which elements in the - strided array are accessed - at runtime. + The `N` and stride parameters determine which elements in the strided array + are accessed at runtime. Indexing is relative to the first index. To introduce an offset, use a typed array view. @@ -20,8 +19,8 @@ x: Float32Array Input array. - stride: integer - Index increment. + strideX: integer + Stride length. Returns ------- @@ -35,27 +34,25 @@ > {{alias}}( x.length, x, 1 ) 1.0 - // Using `N` and `stride` parameters: + // Using `N` and stride parameters: > x = new {{alias:@stdlib/array/float32}}( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0, NaN, NaN ] ); - > var stride = 2; - > {{alias}}( 4, x, stride ) + > {{alias}}( 4, x, 2 ) 1.0 // Using view offsets: > var x0 = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0, NaN, NaN ] ); > var x1 = new {{alias:@stdlib/array/float32}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); - > stride = 2; - > {{alias}}( 4, x1, stride ) + > {{alias}}( 4, x1, 2 ) -1.0 -{{alias}}.ndarray( N, x, stride, offset ) +{{alias}}.ndarray( N, x, strideX, offsetX ) Computes the sum of single-precision floating-point strided array elements, ignoring `NaN` values and using extended accumulation and alternative indexing semantics. While typed array views mandate a view offset based on the underlying - buffer, the `offset` parameter supports indexing semantics based on a + buffer, the offset parameter supports indexing semantics based on a starting index. Parameters @@ -66,10 +63,10 @@ x: Float32Array Input array. - stride: integer - Index increment. + strideX: integer + Stride length. - offset: integer + offsetX: integer Starting index. Returns diff --git a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/docs/types/index.d.ts index 645a4bcb306d..11b77b69f91d 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/docs/types/index.d.ts @@ -27,7 +27,7 @@ interface Routine { * * @param N - number of indexed elements * @param x - input array - * @param stride - stride length + * @param strideX - stride length * @returns sum * * @example @@ -38,15 +38,15 @@ interface Routine { * var v = sdsnansum( x.length, x, 1 ); * // returns 1.0 */ - ( N: number, x: Float32Array, stride: number ): number; + ( N: number, x: Float32Array, strideX: number ): number; /** * Computes the sum of single-precision floating-point strided array elements, ignoring `NaN` values and using extended accumulation and alternative indexing semantics. * * @param N - number of indexed elements * @param x - input array - * @param stride - stride length - * @param offset - starting index + * @param strideX - stride length + * @param offsetX - starting index * @returns sum * * @example @@ -57,7 +57,7 @@ interface Routine { * var v = sdsnansum.ndarray( x.length, x, 1, 0 ); * // returns 1.0 */ - ndarray( N: number, x: Float32Array, stride: number, offset: number ): number; + ndarray( N: number, x: Float32Array, strideX: number, offsetX: number ): number; } /** @@ -65,7 +65,7 @@ interface Routine { * * @param N - number of indexed elements * @param x - input array -* @param stride - stride length +* @param strideX - stride length * @returns sum * * @example diff --git a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/examples/c/example.c b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/examples/c/example.c index 86babb63ece3..b6f56a6e869a 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/examples/c/example.c +++ b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/examples/c/example.c @@ -17,22 +17,21 @@ */ #include "stdlib/blas/ext/base/sdsnansum.h" -#include #include int main( void ) { // Create a strided array: - const float 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 }; + 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 int64_t N = 5; + const int N = 5; // Specify the stride length: - const int64_t stride = 2; + const int strideX = 2; // Compute the sum: - float v = stdlib_strided_sdsnansum( N, x, stride ); + float v = stdlib_strided_sdsnansum( N, x, strideX ); // Print the result: - printf( "sum: %f\n", v ); + printf( "Sum: %f\n", v ); } diff --git a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/examples/index.js b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/examples/index.js index 01ee638487aa..1d7cc221f66a 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/examples/index.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/examples/index.js @@ -24,7 +24,7 @@ var filledarrayBy = require( '@stdlib/array/filled-by' ); var sdsnansum = require( './../lib' ); function rand() { - if ( bernoulli( 0.2 ) ) { + if ( bernoulli( 0.5 ) < 1 ) { return NaN; } return discreteUniform( 0, 100 ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/include/stdlib/blas/ext/base/sdsnansum.h b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/include/stdlib/blas/ext/base/sdsnansum.h index 447850784ebd..491eeadb1312 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/include/stdlib/blas/ext/base/sdsnansum.h +++ b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/include/stdlib/blas/ext/base/sdsnansum.h @@ -19,7 +19,7 @@ #ifndef STDLIB_BLAS_EXT_BASE_SDSNANSUM_H #define STDLIB_BLAS_EXT_BASE_SDSNANSUM_H -#include +#include "stdlib/blas/base/shared.h" /* * If C++, prevent name mangling so that the compiler emits a binary file having undecorated names, thus mirroring the behavior of a C compiler. @@ -31,7 +31,12 @@ extern "C" { /** * Computes the sum of single-precision floating-point strided array elements, ignoring `NaN` values and using extended summation. */ -float stdlib_strided_sdsnansum( const int64_t N, const float *X, const int64_t stride ); +float API_SUFFIX(stdlib_strided_sdsnansum)( const CBLAS_INT N, const float *X, const CBLAS_INT strideX ); + +/** +* Computes the sum of single-precision floating-point strided array elements, ignoring `NaN` values and using extended summation and alternative indexing semantics. +*/ +float API_SUFFIX(stdlib_strided_sdsnansum_ndarray)( const CBLAS_INT N, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); #ifdef __cplusplus } diff --git a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/lib/index.js b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/lib/index.js index fa822a9988de..9ed1fec4f839 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/lib/index.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/lib/index.js @@ -28,9 +28,8 @@ * var sdsnansum = require( '@stdlib/blas/ext/base/sdsnansum' ); * * var x = new Float32Array( [ 1.0, -2.0, NaN, 2.0 ] ); -* var N = x.length; * -* var v = sdsnansum( N, x, 1 ); +* var v = sdsnansum( x.length, x, 1 ); * // returns 1.0 * * @example diff --git a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/lib/ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/lib/ndarray.js index 10d6a1ffa741..8afbc5cc1713 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/lib/ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/lib/ndarray.js @@ -30,8 +30,8 @@ var sdsnansumpw = require( '@stdlib/blas/ext/base/sdsnansumpw' ).ndarray; * * @param {PositiveInteger} N - number of indexed elements * @param {Float32Array} x - input array -* @param {integer} stride - stride length -* @param {NonNegativeInteger} offset - starting index +* @param {integer} strideX - stride length +* @param {NonNegativeInteger} offsetX - starting index * @returns {number} sum * * @example @@ -42,8 +42,8 @@ var sdsnansumpw = require( '@stdlib/blas/ext/base/sdsnansumpw' ).ndarray; * var v = sdsnansum( 5, x, 2, 1 ); * // returns 5.0 */ -function sdsnansum( N, x, stride, offset ) { - return sdsnansumpw( N, x, stride, offset ); +function sdsnansum( N, x, strideX, offsetX ) { + return sdsnansumpw( N, x, strideX, offsetX ); } diff --git a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/lib/ndarray.native.js b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/lib/ndarray.native.js index 9fa8b7e91204..8b344ca6943b 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/lib/ndarray.native.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/lib/ndarray.native.js @@ -20,9 +20,7 @@ // MODULES // -var minViewBufferIndex = require( '@stdlib/strided/base/min-view-buffer-index' ); -var offsetView = require( '@stdlib/strided/base/offset-view' ); -var addon = require( './sdsnansum.native.js' ); +var addon = require( './../src/addon.node' ); // MAIN // @@ -32,8 +30,8 @@ var addon = require( './sdsnansum.native.js' ); * * @param {PositiveInteger} N - number of indexed elements * @param {Float32Array} x - input array -* @param {integer} stride - stride length -* @param {NonNegativeInteger} offset - starting index +* @param {integer} strideX - stride length +* @param {NonNegativeInteger} offsetX - starting index * @returns {number} sum * * @example @@ -44,12 +42,8 @@ var addon = require( './sdsnansum.native.js' ); * var v = sdsnansum( 5, x, 2, 1 ); * // returns 5.0 */ -function sdsnansum( N, x, stride, offset ) { - var view; - offset = minViewBufferIndex( N, stride, offset ); - view = offsetView( x, offset ); - - return addon( N, view, stride ); +function sdsnansum( N, x, strideX, offsetX ) { + return addon.ndarray( N, x, strideX, offsetX ); } diff --git a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/lib/sdsnansum.js b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/lib/sdsnansum.js index 9b7b4da9a73a..4716a8bcf977 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/lib/sdsnansum.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/lib/sdsnansum.js @@ -30,20 +30,19 @@ var sdsnansumpw = require( '@stdlib/blas/ext/base/sdsnansumpw' ); * * @param {PositiveInteger} N - number of indexed elements * @param {Float32Array} x - input array -* @param {integer} stride - stride length +* @param {integer} strideX - stride length * @returns {number} sum * * @example * var Float32Array = require( '@stdlib/array/float32' ); * * var x = new Float32Array( [ 1.0, -2.0, NaN, 2.0 ] ); -* var N = x.length; * -* var v = sdsnansum( N, x, 1 ); +* var v = sdsnansum( x.length, x, 1 ); * // returns 1.0 */ -function sdsnansum( N, x, stride ) { - return sdsnansumpw( N, x, stride ); +function sdsnansum( N, x, strideX ) { + return sdsnansumpw( N, x, strideX ); } diff --git a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/lib/sdsnansum.native.js b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/lib/sdsnansum.native.js index f8cdc49c91fd..ec9513144fcc 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/lib/sdsnansum.native.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/lib/sdsnansum.native.js @@ -30,20 +30,19 @@ var addon = require( './../src/addon.node' ); * * @param {PositiveInteger} N - number of indexed elements * @param {Float32Array} x - input array -* @param {integer} stride - stride length +* @param {integer} strideX - stride length * @returns {number} sum * * @example * var Float32Array = require( '@stdlib/array/float32' ); * * var x = new Float32Array( [ 1.0, -2.0, NaN, 2.0 ] ); -* var N = x.length; * -* var v = sdsnansum( N, x, 1 ); +* var v = sdsnansum( x.length, x, 1 ); * // returns 1.0 */ -function sdsnansum( N, x, stride ) { - return addon( N, x, stride ); +function sdsnansum( N, x, strideX ) { + return addon( N, x, strideX ); } diff --git a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/manifest.json b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/manifest.json index b973b809e1e3..d7dfa6c8774c 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/manifest.json +++ b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/manifest.json @@ -28,53 +28,54 @@ { "task": "build", "src": [ - "./src/sdsnansum.c" + "./src/main.c" ], "include": [ "./include" ], - "libraries": [ - "-lm" - ], + "libraries": [], "libpath": [], "dependencies": [ "@stdlib/blas/ext/base/sdsnansumpw", "@stdlib/napi/export", "@stdlib/napi/argv", "@stdlib/napi/argv-int64", - "@stdlib/napi/argv-strided-float32array" + "@stdlib/napi/argv-strided-float32array", + "@stdlib/napi/create-double", + "@stdlib/strided/base/stride2offset", + "@stdlib/blas/base/shared" ] }, { "task": "benchmark", "src": [ - "./src/sdsnansum.c" + "./src/main.c" ], "include": [ "./include" ], - "libraries": [ - "-lm" - ], + "libraries": [], "libpath": [], "dependencies": [ - "@stdlib/blas/ext/base/sdsnansumpw" + "@stdlib/blas/ext/base/sdsnansumpw", + "@stdlib/strided/base/stride2offset", + "@stdlib/blas/base/shared" ] }, { "task": "examples", "src": [ - "./src/sdsnansum.c" + "./src/main.c" ], "include": [ "./include" ], - "libraries": [ - "-lm" - ], + "libraries": [], "libpath": [], "dependencies": [ - "@stdlib/blas/ext/base/sdsnansumpw" + "@stdlib/blas/ext/base/sdsnansumpw", + "@stdlib/strided/base/stride2offset", + "@stdlib/blas/base/shared" ] } ] diff --git a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/src/addon.c b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/src/addon.c index 78d2b23e52ce..ac4ed4e1ca90 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/src/addon.c +++ b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/src/addon.c @@ -17,12 +17,13 @@ */ #include "stdlib/blas/ext/base/sdsnansum.h" +#include "stdlib/blas/base/shared.h" #include "stdlib/napi/export.h" #include "stdlib/napi/argv.h" #include "stdlib/napi/argv_int64.h" #include "stdlib/napi/argv_strided_float32array.h" +#include "stdlib/napi/create_double.h" #include -#include /** * Receives JavaScript callback invocation data. @@ -34,14 +35,27 @@ static napi_value addon( napi_env env, napi_callback_info info ) { STDLIB_NAPI_ARGV( env, info, argv, argc, 3 ); STDLIB_NAPI_ARGV_INT64( env, N, argv, 0 ); - STDLIB_NAPI_ARGV_INT64( env, stride, argv, 2 ); - STDLIB_NAPI_ARGV_STRIDED_FLOAT32ARRAY( env, X, N, stride, argv, 1 ); - - napi_value v; - napi_status status = napi_create_double( env, (double)stdlib_strided_sdsnansum( N, X, stride ), &v ); - assert( status == napi_ok ); + STDLIB_NAPI_ARGV_INT64( env, strideX, argv, 2 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT32ARRAY( env, X, N, strideX, argv, 1 ); + STDLIB_NAPI_CREATE_DOUBLE( env, (double)API_SUFFIX(stdlib_strided_sdsnansum)( N, X, strideX ), v ); + return v; +} +/** +* Receives JavaScript callback invocation data. +* +* @param env environment under which the function is invoked +* @param info callback data +* @return Node-API value +*/ +static napi_value addon_method( napi_env env, napi_callback_info info ) { + STDLIB_NAPI_ARGV( env, info, argv, argc, 4 ); + STDLIB_NAPI_ARGV_INT64( env, N, argv, 0 ); + STDLIB_NAPI_ARGV_INT64( env, strideX, argv, 2 ); + STDLIB_NAPI_ARGV_INT64( env, offsetX, argv, 3 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT32ARRAY( env, X, N, strideX, argv, 1 ); + STDLIB_NAPI_CREATE_DOUBLE( env, (double)API_SUFFIX(stdlib_strided_sdsnansum_ndarray)( N, X, strideX, offsetX ), v ); return v; } -STDLIB_NAPI_MODULE_EXPORT_FCN( addon ) +STDLIB_NAPI_MODULE_EXPORT_FCN_WITH_METHOD( addon, "ndarray", addon_method ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/src/main.c b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/src/main.c new file mode 100644 index 000000000000..28340ea79a29 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/src/main.c @@ -0,0 +1,48 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +#include "stdlib/blas/ext/base/sdsnansum.h" +#include "stdlib/blas/ext/base/sdsnansumpw.h" +#include "stdlib/blas/base/shared.h" +#include "stdlib/strided/base/stride2offset.h" + +/** +* Computes the sum of single-precision floating-point strided array elements, ignoring `NaN` values and using extended accumulation. +* +* @param N number of indexed elements +* @param X input array +* @param strideX stride length +* @return output value +*/ +float API_SUFFIX(stdlib_strided_sdsnansum)( const CBLAS_INT N, const float *X, const CBLAS_INT strideX ) { + CBLAS_INT ox = stdlib_strided_stride2offset( N, strideX ); + return API_SUFFIX(stdlib_strided_sdsnansum_ndarray)( N, X, strideX, ox ); +} + +/** +* Computes the sum of single-precision floating-point strided array elements, ignoring `NaN` values and using extended accumulation and alternative indexing semantics. +* +* @param N number of indexed elements +* @param X input array +* @param strideX stride length +* @param offsetX starting index +* @return output value +*/ +float API_SUFFIX(stdlib_strided_sdsnansum_ndarray)( const CBLAS_INT N, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ) { + return API_SUFFIX(stdlib_strided_sdsnansumpw_ndarray)( N, X, strideX, offsetX ); +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/src/sdsnansum.c b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/src/sdsnansum.c deleted file mode 100644 index 091f2fd34add..000000000000 --- a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/src/sdsnansum.c +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2020 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -#include "stdlib/blas/ext/base/sdsnansum.h" -#include "stdlib/blas/ext/base/sdsnansumpw.h" -#include - -/** -* Computes the sum of single-precision floating-point strided array elements, ignoring `NaN` values and using extended accumulation. -* -* @param N number of indexed elements -* @param X input array -* @param stride stride length -* @return output value -*/ -float stdlib_strided_sdsnansum( const int64_t N, const float *X, const int64_t stride ) { - return stdlib_strided_sdsnansumpw( N, X, stride ); -} diff --git a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/test/test.ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/test/test.ndarray.js index 57e2c434459b..7d62c37ffef5 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/test/test.ndarray.js @@ -178,14 +178,14 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) t.end(); }); -tape( 'if provided a `stride` parameter equal to `0`, the function returns the first indexed element', function test( t ) { +tape( 'if provided a `stride` parameter equal to `0`, the function returns the sum of the first element repeated N times', function test( t ) { var x; var v; x = new Float32Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); v = sdsnansum( x.length, x, 0, 0 ); - t.strictEqual( v, 1.0, 'returns expected value' ); + t.strictEqual( v, 5.0, 'returns expected value' ); t.end(); }); diff --git a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/test/test.ndarray.native.js b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/test/test.ndarray.native.js index 525be0756be5..a8b799133fcf 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/test/test.ndarray.native.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/test/test.ndarray.native.js @@ -187,14 +187,14 @@ tape( 'the function supports a negative `stride` parameter', opts, function test t.end(); }); -tape( 'if provided a `stride` parameter equal to `0`, the function returns the first indexed element', opts, function test( t ) { +tape( 'if provided a `stride` parameter equal to `0`, the function returns the sum of the first element repeated N times', opts, function test( t ) { var x; var v; x = new Float32Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); v = sdsnansum( x.length, x, 0, 0 ); - t.strictEqual( v, 1.0, 'returns expected value' ); + t.strictEqual( v, 5.0, 'returns expected value' ); t.end(); }); diff --git a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/test/test.sdsnansum.js b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/test/test.sdsnansum.js index 21230435bc4d..75a0e65d0129 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/test/test.sdsnansum.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/test/test.sdsnansum.js @@ -178,14 +178,14 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) t.end(); }); -tape( 'if provided a `stride` parameter equal to `0`, the function returns the first element', function test( t ) { +tape( 'if provided a `stride` parameter equal to `0`, the function returns the sum of the first element repeated N times', function test( t ) { var x; var v; x = new Float32Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); v = sdsnansum( x.length, x, 0 ); - t.strictEqual( v, 1.0, 'returns expected value' ); + t.strictEqual( v, 5.0, 'returns expected value' ); t.end(); }); diff --git a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/test/test.sdsnansum.native.js b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/test/test.sdsnansum.native.js index ab9d65d948ee..c2c6d71069a4 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/test/test.sdsnansum.native.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sdsnansum/test/test.sdsnansum.native.js @@ -269,14 +269,14 @@ tape( 'the function supports a negative `stride` parameter', opts, function test t.end(); }); -tape( 'if provided a `stride` parameter equal to `0`, the function returns the first element', opts, function test( t ) { +tape( 'if provided a `stride` parameter equal to `0`, the function returns the sum of the first element repeated N times', opts, function test( t ) { var x; var v; x = new Float32Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); v = sdsnansum( x.length, x, 0 ); - t.strictEqual( v, 1.0, 'returns expected value' ); + t.strictEqual( v, 5.0, 'returns expected value' ); t.end(); });