diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapxsum/README.md b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/README.md index 3b335687ccc9..532dfbc81f39 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sapxsum/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/README.md @@ -20,7 +20,7 @@ limitations under the License. # sapxsum -> Add a constant to each single-precision floating-point strided array element and compute the sum. +> Add a scalar constant to each single-precision floating-point strided array element and compute the sum.
@@ -36,27 +36,27 @@ limitations under the License. var sapxsum = require( '@stdlib/blas/ext/base/sapxsum' ); ``` -#### sapxsum( N, alpha, x, stride ) +#### sapxsum( N, alpha, x, strideX ) -Adds a constant to each single-precision floating-point strided array element and computes the sum. +Adds a scalar constant to each single-precision floating-point strided array element and computes the sum. ```javascript var Float32Array = require( '@stdlib/array/float32' ); var x = new Float32Array( [ 1.0, -2.0, 2.0 ] ); -var N = x.length; -var v = sapxsum( N, 5.0, x, 1 ); +var v = sapxsum( x.length, 5.0, x, 1 ); // returns 16.0 ``` The function has the following parameters: - **N**: number of indexed elements. +- **alpha**: scalar constant. - **x**: input [`Float32Array`][@stdlib/array/float32]. -- **stride**: index increment for `x`. +- **strideX**: stride length. -The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to access every other element in `x`, +The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to access every other element: ```javascript var Float32Array = require( '@stdlib/array/float32' ); @@ -81,25 +81,24 @@ var v = sapxsum( 4, 5.0, x1, 2 ); // returns 25.0 ``` -#### sapxsum.ndarray( N, alpha, x, stride, offset ) +#### sapxsum.ndarray( N, alpha, x, strideX, offsetX ) -Adds a constant to each single-precision floating-point strided array element and computes the sum using alternative indexing semantics. +Adds a scalar constant to each single-precision floating-point strided array element and computes the sum using alternative indexing semantics. ```javascript var Float32Array = require( '@stdlib/array/float32' ); var x = new Float32Array( [ 1.0, -2.0, 2.0 ] ); -var N = x.length; -var v = sapxsum.ndarray( N, 5.0, x, 1, 0 ); +var v = sapxsum.ndarray( x.length, 5.0, x, 1, 0 ); // returns 16.0 ``` The function has the following additional parameters: -- **offset**: starting index for `x`. +- **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 access 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 access every other element starting from the second element: ```javascript var Float32Array = require( '@stdlib/array/float32' ); @@ -131,18 +130,141 @@ var v = sapxsum.ndarray( 4, 5.0, x, 2, 1 ); ```javascript -var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory; -var filledarrayBy = require( '@stdlib/array/filled-by' ); +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); var sapxsum = require( '@stdlib/blas/ext/base/sapxsum' ); -var x = filledarrayBy( 10, 'float32', discreteUniform( 0, 100 ) ); +var x = discreteUniform( 10, -100, 100, { + 'dtype': 'float32' +}); console.log( x ); + +var v = sapxsum( x.length, 5.0, x, 1 ); +console.log( v ); +``` + +
+ + + + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/blas/ext/base/sapxsum.h" +``` + +#### stdlib_strided_sapxsum( N, alpha, \*X, strideX ) + +Adds a scalar constant to each single-precision floating-point strided array element and computes the sum. + +```c +const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f }; + +float v = stdlib_strided_sapxsum( 4, 5.0f, x, 1 ); +// returns 30.0f +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **alpha**: `[in] float` scalar constant. +- **X**: `[in] float*` input array. +- **strideX**: `[in] CBLAS_INT` stride length. + +```c +float stdlib_strided_sapxsum( const CBLAS_INT N, const float alpha, const float *X, const CBLAS_INT strideX ); +``` + +#### stdlib_strided_sapxsum_ndarray( N, alpha, \*X, strideX, offsetX ) + +Adds a scalar constant to each single-precision floating-point strided array element and computes the sum using alternative indexing semantics. + +```c +const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f }; + +float v = stdlib_strided_sapxsum_ndarray( 4, 5.0f, x, 1, 0 ); +// returns 30.0f +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **alpha**: `[in] float` scalar constant. +- **X**: `[in] float*` input array. +- **strideX**: `[in] CBLAS_INT` stride length. +- **offsetX**: `[in] CBLAS_INT` starting index. + +```c +float stdlib_strided_sapxsum_ndarray( const CBLAS_INT N, const float alpha, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/blas/ext/base/sapxsum.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 }; + + // Specify the number of indexed elements: + const int N = 8; + + // Specify a stride: + const int strideX = 1; + + // Compute the sum: + float v = stdlib_strided_sapxsum( N, 5.0f, x, strideX ); + + // Print the result: + printf( "Sum: %f\n", v ); +} ```
+
+ + +
diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapxsum/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/benchmark/benchmark.js index a3794363584e..b57b2cc0bb94 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sapxsum/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/benchmark/benchmark.js @@ -23,15 +23,16 @@ var bench = require( '@stdlib/bench' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); -var uniform = require( '@stdlib/random/base/uniform' ).factory; -var filledarrayBy = require( '@stdlib/array/filled-by' ); +var uniform = require( '@stdlib/random/array/uniform' ); var pkg = require( './../package.json' ).name; var sapxsum = require( './../lib/sapxsum.js' ); // VARIABLES // -var rand = uniform( -10.0, 10.0 ); +var options = { + 'dtype': 'float32' +}; // FUNCTIONS // @@ -44,7 +45,7 @@ var rand = uniform( -10.0, 10.0 ); * @returns {Function} benchmark function */ function createBenchmark( len ) { - var x = filledarrayBy( len, 'float32', rand ); + var x = uniform( len, -100, 100, options ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapxsum/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/benchmark/benchmark.native.js index f850b14b21dc..e6410b84f568 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sapxsum/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/benchmark/benchmark.native.js @@ -24,8 +24,7 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); -var uniform = require( '@stdlib/random/base/uniform' ).factory; -var filledarrayBy = require( '@stdlib/array/filled-by' ); +var uniform = require( '@stdlib/random/array/uniform' ); var tryRequire = require( '@stdlib/utils/try-require' ); var pkg = require( './../package.json' ).name; @@ -36,7 +35,9 @@ var sapxsum = tryRequire( resolve( __dirname, './../lib/sapxsum.native.js' ) ); var opts = { 'skip': ( sapxsum instanceof Error ) }; -var rand = uniform( -10.0, 10.0 ); +var options = { + 'dtype': 'float32' +}; // FUNCTIONS // @@ -49,7 +50,7 @@ var rand = uniform( -10.0, 10.0 ); * @returns {Function} benchmark function */ function createBenchmark( len ) { - var x = filledarrayBy( len, 'float32', rand ); + var x = uniform( len, -100, 100, options ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapxsum/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/benchmark/benchmark.ndarray.js index 8197e74a9950..e349ef03d0f6 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sapxsum/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/benchmark/benchmark.ndarray.js @@ -23,15 +23,16 @@ var bench = require( '@stdlib/bench' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); -var uniform = require( '@stdlib/random/base/uniform' ).factory; -var filledarrayBy = require( '@stdlib/array/filled-by' ); +var uniform = require( '@stdlib/random/array/uniform' ); var pkg = require( './../package.json' ).name; var sapxsum = require( './../lib/ndarray.js' ); // VARIABLES // -var rand = uniform( -10.0, 10.0 ); +var options = { + 'dtype': 'float32' +}; // FUNCTIONS // @@ -44,7 +45,7 @@ var rand = uniform( -10.0, 10.0 ); * @returns {Function} benchmark function */ function createBenchmark( len ) { - var x = filledarrayBy( len, 'float32', rand ); + var x = uniform( len, -100, 100, options ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapxsum/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/benchmark/benchmark.ndarray.native.js index ad9b898716e7..7421e9af74e7 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sapxsum/benchmark/benchmark.ndarray.native.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/benchmark/benchmark.ndarray.native.js @@ -24,8 +24,7 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); -var uniform = require( '@stdlib/random/base/uniform' ).factory; -var filledarrayBy = require( '@stdlib/array/filled-by' ); +var uniform = require( '@stdlib/random/array/uniform' ); var tryRequire = require( '@stdlib/utils/try-require' ); var pkg = require( './../package.json' ).name; @@ -36,7 +35,9 @@ var sapxsum = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) ); var opts = { 'skip': ( sapxsum instanceof Error ) }; -var rand = uniform( -10.0, 10.0 ); +var options = { + 'dtype': 'float32' +}; // FUNCTIONS // @@ -49,7 +50,7 @@ var rand = uniform( -10.0, 10.0 ); * @returns {Function} benchmark function */ function createBenchmark( len ) { - var x = filledarrayBy( len, 'float32', rand ); + var x = uniform( len, -100, 100, options ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapxsum/benchmark/c/benchmark.length.c b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/benchmark/c/benchmark.length.c index be5d510f7f2d..1d2520397265 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sapxsum/benchmark/c/benchmark.length.c +++ b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/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; @@ -107,6 +107,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_sapxsum( len, 5.0f, x, 1 ); if ( v != v ) { printf( "should not return NaN\n" ); @@ -120,6 +121,40 @@ 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++ ) { + 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_sapxsum_ndarray( len, 5.0f, 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. */ @@ -142,7 +177,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/sapxsum/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/docs/repl.txt index b277320a58d3..fe8db2f64e4f 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sapxsum/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/docs/repl.txt @@ -1,10 +1,10 @@ -{{alias}}( N, alpha, x, stride ) - Adds a constant to each single-precision floating-point strided array +{{alias}}( N, alpha, x, strideX ) + Adds a scalar constant to each single-precision floating-point strided array element and computes the sum. - 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. @@ -17,13 +17,13 @@ Number of indexed elements. alpha: number - Constant. + Scalar constant. x: Float32Array Input array. - stride: integer - Index increment. + strideX: integer + Stride length. Returns ------- @@ -49,13 +49,13 @@ 14.0 -{{alias}}.ndarray( N, alpha, x, stride, offset ) - Adds a constant to each single-precision floating-point strided array +{{alias}}.ndarray( N, alpha, x, strideX, offsetX ) + Adds a scalar constant to each single-precision floating-point strided array element and computes the sum using 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 - starting index. + buffer, the offset parameter supports indexing semantics based on a starting + index. Parameters ---------- @@ -63,15 +63,15 @@ Number of indexed elements. alpha: number - Constant. + Scalar constant. 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/sapxsum/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/docs/types/index.d.ts index ba777172f308..4cd0ee7d6f30 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sapxsum/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/docs/types/index.d.ts @@ -23,12 +23,12 @@ */ interface Routine { /** - * Adds a constant to each single-precision floating-point strided array element and computes the sum. + * Adds a scalar constant to each single-precision floating-point strided array element and computes the sum. * * @param N - number of indexed elements - * @param alpha - constant + * @param alpha - scalar constant * @param x - input array - * @param stride - stride length + * @param strideX - stride length * @returns sum * * @example @@ -39,16 +39,16 @@ interface Routine { * var v = sapxsum( x.length, 5.0, x, 1 ); * // returns 16.0 */ - ( N: number, alpha: number, x: Float32Array, stride: number ): number; + ( N: number, alpha: number, x: Float32Array, strideX: number ): number; /** - * Adds a constant to each single-precision floating-point strided array element and computes the sum using alternative indexing semantics. + * Adds a scalar constant to each single-precision floating-point strided array element and computes the sum using alternative indexing semantics. * * @param N - number of indexed elements - * @param alpha - constant + * @param alpha - scalar constant * @param x - input array - * @param stride - stride length - * @param offset - starting index + * @param strideX - stride length + * @param offsetX - starting index * @returns sum * * @example @@ -59,16 +59,16 @@ interface Routine { * var v = sapxsum.ndarray( x.length, 5.0, x, 1, 0 ); * // returns 16.0 */ - ndarray( N: number, alpha: number, x: Float32Array, stride: number, offset: number ): number; + ndarray( N: number, alpha: number, x: Float32Array, strideX: number, offsetX: number ): number; } /** -* Adds a constant to each single-precision floating-point strided array element and computes the sum. +* Adds a scalar constant to each single-precision floating-point strided array element and computes the sum. * * @param N - number of indexed elements -* @param alpha - constant +* @param alpha - scalar constant * @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/sapxsum/examples/c/example.c b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/examples/c/example.c index d77ef9e37850..25cf72b30d14 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sapxsum/examples/c/example.c +++ b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/examples/c/example.c @@ -17,22 +17,21 @@ */ #include "stdlib/blas/ext/base/sapxsum.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 }; + const float x[] = { 1.0f, -2.0f, 3.0f, -4.0f, 5.0f, -6.0f, 7.0f, -8.0f }; - // Specify the number of elements: - const int64_t N = 4; + // Specify the number of indexed elements: + const int N = 8; - // Specify the stride length: - const int64_t stride = 2; + // Specify a stride: + const int strideX = 1; // Compute the sum: - float v = stdlib_strided_sapxsum( N, 5.0f, x, stride ); + float v = stdlib_strided_sapxsum( N, 5.0f, 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/sapxsum/examples/index.js b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/examples/index.js index 9dffd93b0fc8..a188ecdfb3d4 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sapxsum/examples/index.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/examples/index.js @@ -18,11 +18,12 @@ 'use strict'; -var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory; -var filledarrayBy = require( '@stdlib/array/filled-by' ); +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); var sapxsum = require( './../lib' ); -var x = filledarrayBy( 10, 'float32', discreteUniform( 0, 100 ) ); +var x = discreteUniform( 10, -100, 100, { + 'dtype': 'float32' +}); console.log( x ); var v = sapxsum( x.length, 5.0, x, 1 ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapxsum/include/stdlib/blas/ext/base/sapxsum.h b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/include/stdlib/blas/ext/base/sapxsum.h index 2ffe1d15b422..90ef9a49a33e 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sapxsum/include/stdlib/blas/ext/base/sapxsum.h +++ b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/include/stdlib/blas/ext/base/sapxsum.h @@ -19,7 +19,7 @@ #ifndef STDLIB_BLAS_EXT_BASE_SAPXSUM_H #define STDLIB_BLAS_EXT_BASE_SAPXSUM_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" { /** * Adds a scalar constant to each single-precision floating-point strided array element and computes the sum. */ -float stdlib_strided_sapxsum( const int64_t N, const float alpha, const float *X, const int64_t stride ); +float API_SUFFIX(stdlib_strided_sapxsum)( const CBLAS_INT N, const float alpha, const float *X, const CBLAS_INT strideX ); + +/** +* Adds a scalar constant to each single-precision floating-point strided array element and computes the sum using alternative indexing semantics. +*/ +float API_SUFFIX(stdlib_strided_sapxsum_ndarray)( const CBLAS_INT N, const float alpha, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); #ifdef __cplusplus } diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapxsum/lib/index.js b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/lib/index.js index 4b3299cf1b73..8ffd46a53178 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sapxsum/lib/index.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Add a constant to each single-precision floating-point strided array element and compute the sum. +* Add a scalar constant to each single-precision floating-point strided array element and compute the sum. * * @module @stdlib/blas/ext/base/sapxsum * @@ -28,9 +28,8 @@ * var sapxsum = require( '@stdlib/blas/ext/base/sapxsum' ); * * var x = new Float32Array( [ 1.0, -2.0, 2.0 ] ); -* var N = x.length; * -* var v = sapxsum( N, 5.0, x, 1 ); +* var v = sapxsum( x.length, 5.0, x, 1 ); * // returns 16.0 * * @example diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapxsum/lib/ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/lib/ndarray.js index a1aa827fe731..f91439d0ee00 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sapxsum/lib/ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/lib/ndarray.js @@ -26,13 +26,13 @@ var sapxsumkbn = require( '@stdlib/blas/ext/base/sapxsumkbn' ).ndarray; // MAIN // /** -* Adds a constant to each single-precision floating-point strided array element and computes the sum. +* Adds a scalar constant to each single-precision floating-point strided array element and computes the sum. * * @param {PositiveInteger} N - number of indexed elements -* @param {number} alpha - constant +* @param {number} alpha - scalar constant * @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 @@ -43,8 +43,8 @@ var sapxsumkbn = require( '@stdlib/blas/ext/base/sapxsumkbn' ).ndarray; * var v = sapxsum( 4, 5.0, x, 2, 1 ); * // returns 25.0 */ -function sapxsum( N, alpha, x, stride, offset ) { - return sapxsumkbn( N, alpha, x, stride, offset ); +function sapxsum( N, alpha, x, strideX, offsetX ) { + return sapxsumkbn( N, alpha, x, strideX, offsetX ); } diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapxsum/lib/ndarray.native.js b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/lib/ndarray.native.js index 3eea08a9333a..e8c4ec754704 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sapxsum/lib/ndarray.native.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/lib/ndarray.native.js @@ -20,21 +20,19 @@ // MODULES // -var minViewBufferIndex = require( '@stdlib/strided/base/min-view-buffer-index' ); -var offsetView = require( '@stdlib/strided/base/offset-view' ); -var addon = require( './sapxsum.native.js' ); +var addon = require( './../src/addon.node' ); // MAIN // /** -* Adds a constant to each single-precision floating-point strided array element and computes the sum. +* Adds a scalar constant to each single-precision floating-point strided array element and computes the sum. * * @param {PositiveInteger} N - number of indexed elements -* @param {number} alpha - constant +* @param {number} alpha - scalar constant * @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 @@ -45,11 +43,8 @@ var addon = require( './sapxsum.native.js' ); * var v = sapxsum( 4, 5.0, x, 2, 1 ); * // returns 25.0 */ -function sapxsum( N, alpha, x, stride, offset ) { - var view; - offset = minViewBufferIndex( N, stride, offset ); - view = offsetView( x, offset ); - return addon( N, alpha, view, stride ); +function sapxsum( N, alpha, x, strideX, offsetX ) { + return addon.ndarray( N, alpha, x, strideX, offsetX ); } diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapxsum/lib/sapxsum.js b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/lib/sapxsum.js index 383db5413bf4..68082e4277ce 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sapxsum/lib/sapxsum.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/lib/sapxsum.js @@ -20,31 +20,31 @@ // MODULES // -var sapxsumkbn = require( '@stdlib/blas/ext/base/sapxsumkbn' ); +var stride2offset = require( '@stdlib/strided/base/stride2offset' ); +var ndarray = require( './ndarray.js' ); // MAIN // /** -* Adds a constant to each single-precision floating-point strided array element and computes the sum. +* Adds a scalar constant to each single-precision floating-point strided array element and computes the sum. * * @param {PositiveInteger} N - number of indexed elements -* @param {number} alpha - constant +* @param {number} alpha - scalar constant * @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, 2.0 ] ); -* var N = x.length; * -* var v = sapxsum( N, 5.0, x, 1 ); +* var v = sapxsum( x.length, 5.0, x, 1 ); * // returns 16.0 */ -function sapxsum( N, alpha, x, stride ) { - return sapxsumkbn( N, alpha, x, stride ); +function sapxsum( N, alpha, x, strideX ) { + return ndarray( N, alpha, x, strideX, stride2offset( N, strideX ) ); } diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapxsum/lib/sapxsum.native.js b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/lib/sapxsum.native.js index d8883d0be826..747599450c73 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sapxsum/lib/sapxsum.native.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/lib/sapxsum.native.js @@ -26,25 +26,24 @@ var addon = require( './../src/addon.node' ); // MAIN // /** -* Adds a constant to each single-precision floating-point strided array element and computes the sum. +* Adds a scalar constant to each single-precision floating-point strided array element and computes the sum. * * @param {PositiveInteger} N - number of indexed elements -* @param {number} alpha - constant +* @param {number} alpha - scalar constant * @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, 2.0 ] ); -* var N = x.length; * -* var v = sapxsum( N, 5.0, x, 1 ); +* var v = sapxsum( x.length, 5.0, x, 1 ); * // returns 16.0 */ -function sapxsum( N, alpha, x, stride ) { - return addon( N, alpha, x, stride ); +function sapxsum( N, alpha, x, strideX ) { + return addon( N, alpha, x, strideX ); } diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapxsum/manifest.json b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/manifest.json index c4a950608abe..73be58e72bc1 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sapxsum/manifest.json +++ b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/manifest.json @@ -28,14 +28,12 @@ { "task": "build", "src": [ - "./src/sapxsum.c" + "./src/main.c" ], "include": [ "./include" ], - "libraries": [ - "-lm" - ], + "libraries": [], "libpath": [], "dependencies": [ "@stdlib/blas/ext/base/sapxsumkbn", @@ -43,39 +41,42 @@ "@stdlib/napi/argv", "@stdlib/napi/argv-int64", "@stdlib/napi/argv-strided-float32array", - "@stdlib/napi/argv-float" + "@stdlib/napi/argv-float", + "@stdlib/napi/create-double", + "@stdlib/strided/base/stride2offset", + "@stdlib/blas/base/shared" ] }, { "task": "benchmark", "src": [ - "./src/sapxsum.c" + "./src/main.c" ], "include": [ "./include" ], - "libraries": [ - "-lm" - ], + "libraries": [], "libpath": [], "dependencies": [ - "@stdlib/blas/ext/base/sapxsumkbn" + "@stdlib/blas/ext/base/sapxsumkbn", + "@stdlib/strided/base/stride2offset", + "@stdlib/blas/base/shared" ] }, { "task": "examples", "src": [ - "./src/sapxsum.c" + "./src/main.c" ], "include": [ "./include" ], - "libraries": [ - "-lm" - ], + "libraries": [], "libpath": [], "dependencies": [ - "@stdlib/blas/ext/base/sapxsumkbn" + "@stdlib/blas/ext/base/sapxsumkbn", + "@stdlib/strided/base/stride2offset", + "@stdlib/blas/base/shared" ] } ] diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapxsum/src/addon.c b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/src/addon.c index 551bdd7ef326..fd0e466b19b7 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sapxsum/src/addon.c +++ b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/src/addon.c @@ -17,13 +17,14 @@ */ #include "stdlib/blas/ext/base/sapxsum.h" +#include "stdlib/blas/base/shared.h" #include "stdlib/napi/export.h" #include "stdlib/napi/argv.h" #include "stdlib/napi/argv_float.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. @@ -38,12 +39,26 @@ static napi_value addon( napi_env env, napi_callback_info info ) { STDLIB_NAPI_ARGV_FLOAT( env, alpha, argv, 1 ); STDLIB_NAPI_ARGV_INT64( env, strideX, argv, 3 ); STDLIB_NAPI_ARGV_STRIDED_FLOAT32ARRAY( env, X, N, strideX, argv, 2 ); + STDLIB_NAPI_CREATE_DOUBLE( env, (double)API_SUFFIX(stdlib_strided_sapxsum)( N, alpha, X, strideX ), v ); + return v; +} - napi_value v; - napi_status status = napi_create_double( env, (double)stdlib_strided_sapxsum( N, alpha, X, strideX ), &v ); - assert( status == napi_ok ); - +/** +* 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, 5 ); + STDLIB_NAPI_ARGV_INT64( env, N, argv, 0 ); + STDLIB_NAPI_ARGV_FLOAT( env, alpha, argv, 1 ); + STDLIB_NAPI_ARGV_INT64( env, strideX, argv, 3 ); + STDLIB_NAPI_ARGV_INT64( env, offsetX, argv, 4 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT32ARRAY( env, X, N, strideX, argv, 2 ); + STDLIB_NAPI_CREATE_DOUBLE( env, (double)API_SUFFIX(stdlib_strided_sapxsum_ndarray)( N, alpha, 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/sapxsum/src/main.c b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/src/main.c new file mode 100644 index 000000000000..918b2fb6a69f --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/src/main.c @@ -0,0 +1,50 @@ +/** +* @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/sapxsum.h" +#include "stdlib/blas/ext/base/sapxsumkbn.h" +#include "stdlib/strided/base/stride2offset.h" +#include "stdlib/blas/base/shared.h" + +/** +* Adds a scalar constant to each single-precision floating-point strided array element and computes the sum. +* +* @param N number of indexed elements +* @param alpha scalar constant +* @param X input array +* @param strideX stride length +* @return output value +*/ +float API_SUFFIX(stdlib_strided_sapxsum)( const CBLAS_INT N, const float alpha, const float *X, const CBLAS_INT strideX ) { + CBLAS_INT ox = stdlib_strided_stride2offset( N, strideX ); + return API_SUFFIX(stdlib_strided_sapxsum_ndarray)( N, alpha, X, strideX, ox ); +} + +/** +* Adds a scalar constant to each single-precision floating-point strided array element and computes the sum using alternative indexing semantics. +* +* @param N number of indexed elements +* @param alpha scalar constant +* @param X input array +* @param strideX stride length +* @param offsetX starting index +* @return output value +*/ +float API_SUFFIX(stdlib_strided_sapxsum_ndarray)( const CBLAS_INT N, const float alpha, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ) { + return API_SUFFIX(stdlib_strided_sapxsumkbn_ndarray)( N, alpha, X, strideX, offsetX ); +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapxsum/src/sapxsum.c b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/src/sapxsum.c deleted file mode 100644 index 8f92a5add7d2..000000000000 --- a/lib/node_modules/@stdlib/blas/ext/base/sapxsum/src/sapxsum.c +++ /dev/null @@ -1,34 +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/sapxsum.h" -#include "stdlib/blas/ext/base/sapxsumkbn.h" -#include - -/** -* Adds a constant to each single-precision floating-point strided array element and computes the sum. -* -* @param N number of indexed elements -* @param alpha constant -* @param X input array -* @param stride stride length -* @return output value -*/ -float stdlib_strided_sapxsum( const int64_t N, const float alpha, const float *X, const int64_t stride ) { - return stdlib_strided_sapxsumkbn( N, alpha, X, stride ); -} diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapxsum/test/test.ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/test/test.ndarray.js index 6b1841d188ca..e934787b6ee6 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sapxsum/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/test/test.ndarray.js @@ -135,14 +135,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 plus a constant', function test( t ) { +tape( 'if provided a `stride` parameter equal to `0`, the function returns the first indexed element plus a constant repeated N times', function test( t ) { var x; var v; x = new Float32Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); v = sapxsum( x.length, 5.0, x, 0, 0 ); - t.strictEqual( v, 6.0, 'returns expected value' ); + t.strictEqual( v, x.length * (x[0]+5.0), 'returns expected value' ); t.end(); }); diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapxsum/test/test.ndarray.native.js b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/test/test.ndarray.native.js index 6d6e3d7349d3..41408fb8dde6 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sapxsum/test/test.ndarray.native.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/test/test.ndarray.native.js @@ -144,14 +144,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 plus a constant', opts, function test( t ) { +tape( 'if provided a `stride` parameter equal to `0`, the function returns the first indexed element plus a constant 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 = sapxsum( x.length, 5.0, x, 0, 0 ); - t.strictEqual( v, 6.0, 'returns expected value' ); + t.strictEqual( v, x.length * (x[0]+5.0), 'returns expected value' ); t.end(); }); diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapxsum/test/test.sapxsum.js b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/test/test.sapxsum.js index e69c204bcc8f..9ffab4c34652 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sapxsum/test/test.sapxsum.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/test/test.sapxsum.js @@ -135,14 +135,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 plus a constant', function test( t ) { +tape( 'if provided a `stride` parameter equal to `0`, the function returns the first indexed element plus a constant repeated N times', function test( t ) { var x; var v; x = new Float32Array( [ 1.0, -2.0, -4.0, 5.0, 3.0 ] ); v = sapxsum( x.length, 5.0, x, 0 ); - t.strictEqual( v, 6.0, 'returns expected value' ); + t.strictEqual( v, x.length * (x[0]+5.0), 'returns expected value' ); t.end(); }); diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapxsum/test/test.sapxsum.native.js b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/test/test.sapxsum.native.js index 5776424c10a5..ea4af83e62e1 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sapxsum/test/test.sapxsum.native.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sapxsum/test/test.sapxsum.native.js @@ -253,14 +253,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 plus a constant', opts, function test( t ) { +tape( 'if provided a `stride` parameter equal to `0`, the function returns the first indexed element plus a constant 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 = sapxsum( x.length, 5.0, x, 0 ); - t.strictEqual( v, 6.0, 'returns expected value' ); + t.strictEqual( v, x.length * (x[0]+5.0), 'returns expected value' ); t.end(); });