From 2ea4452fa0f63499be526f392fa7fdd647d1a9b5 Mon Sep 17 00:00:00 2001 From: Muhammad Haris <101793258+headlessNode@users.noreply.github.com> Date: Sun, 19 Jan 2025 13:59:39 +0500 Subject: [PATCH] feat!: add C `ndarray` API and refactor `blas/ext/base/sapx` This PR renames `c_sapx` to `stdlib_strided_sapx`. The original naming convention stemmed from early construction of the `blas/ext/base` namespace in which it was not known whether to follow BLAS conventions (e.g., `c_*`) or stdlib's strided naming conventions (e.g., `stdlib_strided_`). Ultimately, we've opted to only use BLAS and LAPACK conventions for the known symbols in those respective libraries in order to avoid future naming collisions and explicitly distinguish stdlib's extensions from that of symbols whose origins are found elsewhere. BREAKING CHANGE: rename `c_sapx` to `stdlib_strided_sapx` To migrate, users should replace all instances of `c_sapx` with `stdlib_strided_sapx`. PR-URL: https://github.com/stdlib-js/stdlib/pull/4696 Co-authored-by: Athan Reines Reviewed-by: Athan Reines --- .../@stdlib/blas/ext/base/sapx/README.md | 144 ++++++++++++++++-- .../blas/ext/base/sapx/benchmark/benchmark.js | 9 +- .../base/sapx/benchmark/benchmark.native.js | 9 +- .../base/sapx/benchmark/benchmark.ndarray.js | 9 +- .../benchmark/benchmark.ndarray.native.js | 9 +- .../base/sapx/benchmark/c/benchmark.length.c | 50 +++++- .../@stdlib/blas/ext/base/sapx/docs/repl.txt | 32 ++-- .../blas/ext/base/sapx/docs/types/index.d.ts | 24 +-- .../blas/ext/base/sapx/examples/c/example.c | 10 +- .../blas/ext/base/sapx/examples/index.js | 8 +- .../sapx/include/stdlib/blas/ext/base/sapx.h | 11 +- .../@stdlib/blas/ext/base/sapx/lib/index.js | 2 +- .../@stdlib/blas/ext/base/sapx/lib/ndarray.js | 21 ++- .../blas/ext/base/sapx/lib/ndarray.native.js | 22 +-- .../@stdlib/blas/ext/base/sapx/lib/sapx.js | 53 +------ .../blas/ext/base/sapx/lib/sapx.native.js | 10 +- .../@stdlib/blas/ext/base/sapx/manifest.json | 32 ++-- .../@stdlib/blas/ext/base/sapx/package.json | 2 +- .../@stdlib/blas/ext/base/sapx/src/addon.c | 27 +++- .../@stdlib/blas/ext/base/sapx/src/main.c | 84 ++++++++++ .../@stdlib/blas/ext/base/sapx/src/sapx.c | 70 --------- 21 files changed, 401 insertions(+), 237 deletions(-) create mode 100644 lib/node_modules/@stdlib/blas/ext/base/sapx/src/main.c delete mode 100644 lib/node_modules/@stdlib/blas/ext/base/sapx/src/sapx.c diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapx/README.md b/lib/node_modules/@stdlib/blas/ext/base/sapx/README.md index d5021571d5ea..438f5be61036 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sapx/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/sapx/README.md @@ -20,7 +20,7 @@ limitations under the License. # sapx -> Add a constant to each element in a single-precision floating-point strided array. +> Add a scalar constant to each element in a single-precision floating-point strided array.
@@ -30,9 +30,9 @@ limitations under the License. var sapx = require( '@stdlib/blas/ext/base/sapx' ); ``` -#### sapx( N, alpha, x, stride ) +#### sapx( N, alpha, x, strideX ) -Adds a constant `alpha` to each element in a single-precision floating-point strided array `x`. +Adds a scalar constant to each element in a single-precision floating-point strided array. ```javascript var Float32Array = require( '@stdlib/array/float32' ); @@ -48,9 +48,9 @@ The function has the following parameters: - **N**: number of indexed elements. - **alpha**: scalar constant. - **x**: input [`Float32Array`][@stdlib/array/float32]. -- **stride**: index increment. +- **strideX**: stride length. -The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to add a constant to every other element +The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to add a constant to every other element: ```javascript var Float32Array = require( '@stdlib/array/float32' ); @@ -77,9 +77,9 @@ sapx( 3, 5.0, x1, 2 ); // x0 => [ 1.0, 3.0, 3.0, 1.0, 5.0, -1.0 ] ``` -#### sapx.ndarray( N, alpha, x, stride, offset ) +#### sapx.ndarray( N, alpha, x, strideX, offsetX ) -Adds a constant `alpha` to each element in a single-precision floating-point strided array `x` using alternative indexing semantics. +Adds a scalar constant to each element in a single-precision floating-point strided array using alternative indexing semantics. ```javascript var Float32Array = require( '@stdlib/array/float32' ); @@ -92,9 +92,9 @@ sapx.ndarray( x.length, 5.0, x, 1, 0 ); The function has the following additional parameters: -- **offset**: starting index. +- **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 only the last three elements of the strided array +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 only the last three elements of the strided array: ```javascript var Float32Array = require( '@stdlib/array/float32' ); @@ -126,11 +126,12 @@ sapx.ndarray( 3, 5.0, x, 1, x.length-3 ); ```javascript -var uniform = require( '@stdlib/random/base/uniform' ).factory; -var filledarrayBy = require( '@stdlib/array/filled-by' ); +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); var sapx = require( '@stdlib/blas/ext/base/sapx' ); -var x = filledarrayBy( 10, 'float32', uniform( -100.0, 100.0 ) ); +var x = discreteUniform( 10, -100, 100, { + 'dtype': 'float32' +}); console.log( x ); sapx( x.length, 5.0, x, 1 ); @@ -141,6 +142,125 @@ console.log( x ); + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/blas/ext/base/sapx.h" +``` + +#### stdlib_strided_sapx( N, alpha, \*X, strideX ) + +Adds a scalar constant to each element in a single-precision floating-point strided array. + +```c +float x[] = { 1.0f, 2.0f, 3.0f, 4.0f }; + +stdlib_strided_sapx( 4, 5.0f, x, 1 ); +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **alpha**: `[in] float` scalar constant. +- **X**: `[inout] float*` input array. +- **strideX**: `[in] CBLAS_INT` stride length. + +```c +void stdlib_strided_sapx( const CBLAS_INT N, const float alpha, float *X, const CBLAS_INT strideX ); +``` + +#### stdlib_strided_sapx_ndarray( N, alpha, \*X, strideX, offsetX ) + +Adds a scalar constant to each element in a single-precision floating-point strided array using alternative indexing semantics. + +```c +float x[] = { 1.0f, 2.0f, 3.0f, 4.0f }; + +stdlib_strided_sapx_ndarray( 4, 5.0f, x, 1, 0 ); +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **alpha**: `[in] float` scalar constant. +- **X**: `[inout] float*` input array. +- **strideX**: `[in] CBLAS_INT` stride length. +- **offsetX**: `[in] CBLAS_INT` starting index. + +```c +void stdlib_strided_sapx_ndarray( const CBLAS_INT N, const float alpha, float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/blas/ext/base/sapx.h" +#include + +int main( void ) { + // Create a strided array: + 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; + + // Add a constant to each element: + stdlib_strided_sapx( N, 5.0f, x, strideX ); + + // Print the result: + for ( int i = 0; i < 8; i++ ) { + printf( "x[ %i ] = %f\n", i, x[ i ] ); + } +} +``` + +
+ + + +
+ + +
diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapx/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/ext/base/sapx/benchmark/benchmark.js index ffd0ff4adca6..8f3b1f96a94a 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sapx/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sapx/benchmark/benchmark.js @@ -21,8 +21,7 @@ // MODULES // var bench = require( '@stdlib/bench' ); -var uniform = require( '@stdlib/random/base/uniform' ).factory; -var filledarrayBy = require( '@stdlib/array/filled-by' ); +var uniform = require( '@stdlib/random/array/uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); var pkg = require( './../package.json' ).name; @@ -31,7 +30,9 @@ var sapx = require( './../lib/sapx.js' ); // VARIABLES // -var rand = uniform( -100.0, 100.0 ); +var options = { + 'dtype': 'float32' +}; // FUNCTIONS // @@ -44,7 +45,7 @@ var rand = uniform( -100.0, 100.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/sapx/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/blas/ext/base/sapx/benchmark/benchmark.native.js index c0d5da977159..86badb8b1007 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sapx/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sapx/benchmark/benchmark.native.js @@ -22,8 +22,7 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); -var uniform = require( '@stdlib/random/base/uniform' ).factory; -var filledarrayBy = require( '@stdlib/array/filled-by' ); +var uniform = require( '@stdlib/random/array/uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); var tryRequire = require( '@stdlib/utils/try-require' ); @@ -36,7 +35,9 @@ var sapx = tryRequire( resolve( __dirname, './../lib/sapx.native.js' ) ); var opts = { 'skip': ( sapx instanceof Error ) }; -var rand = uniform( -100.0, 100.0 ); +var options = { + 'dtype': 'float32' +}; // FUNCTIONS // @@ -49,7 +50,7 @@ var rand = uniform( -100.0, 100.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/sapx/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/sapx/benchmark/benchmark.ndarray.js index b98d981d2b07..50c4b3da2e68 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sapx/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sapx/benchmark/benchmark.ndarray.js @@ -21,8 +21,7 @@ // MODULES // var bench = require( '@stdlib/bench' ); -var uniform = require( '@stdlib/random/base/uniform' ).factory; -var filledarrayBy = require( '@stdlib/array/filled-by' ); +var uniform = require( '@stdlib/random/array/uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); var pkg = require( './../package.json' ).name; @@ -31,7 +30,9 @@ var sapx = require( './../lib/ndarray.js' ); // VARIABLES // -var rand = uniform( -100.0, 100.0 ); +var options = { + 'dtype': 'float32' +}; // FUNCTIONS // @@ -44,7 +45,7 @@ var rand = uniform( -100.0, 100.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/sapx/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/blas/ext/base/sapx/benchmark/benchmark.ndarray.native.js index 650ac428642a..d0963eedb4e8 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sapx/benchmark/benchmark.ndarray.native.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sapx/benchmark/benchmark.ndarray.native.js @@ -22,8 +22,7 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); -var uniform = require( '@stdlib/random/base/uniform' ).factory; -var filledarrayBy = require( '@stdlib/array/filled-by' ); +var uniform = require( '@stdlib/random/array/uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); var tryRequire = require( '@stdlib/utils/try-require' ); @@ -36,7 +35,9 @@ var sapx = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) ); var opts = { 'skip': ( sapx instanceof Error ) }; -var rand = uniform( -100.0, 100.0 ); +var options = { + 'dtype': 'float32' +}; // FUNCTIONS // @@ -49,7 +50,7 @@ var rand = uniform( -100.0, 100.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/sapx/benchmark/c/benchmark.length.c b/lib/node_modules/@stdlib/blas/ext/base/sapx/benchmark/c/benchmark.length.c index 0b4366bbe756..ae841c296048 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sapx/benchmark/c/benchmark.length.c +++ b/lib/node_modules/@stdlib/blas/ext/base/sapx/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 ]; double t; @@ -105,7 +105,40 @@ static double benchmark( int iterations, int len ) { } t = tic(); for ( i = 0; i < iterations; i++ ) { - c_sapx( len, 5.0f, x, 1 ); + // cppcheck-suppress uninitvar + stdlib_strided_sapx( len, 5.0f, x, 1 ); + if ( x[ 0 ] != x[ 0 ] ) { + printf( "should not return NaN\n" ); + break; + } + } + elapsed = tic() - t; + if ( x[ 0 ] != x[ 0 ] ) { + printf( "should not return NaN\n" ); + } + 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 ]; + double t; + int i; + + for ( i = 0; i < len; i++ ) { + x[ i ] = ( rand_float()*200.0f ) - 100.0f; + } + t = tic(); + for ( i = 0; i < iterations; i++ ) { + // cppcheck-suppress uninitvar + stdlib_strided_sapx_ndarray( len, 5.0f, x, 1, 0 ); if ( x[ 0 ] != x[ 0 ] ) { printf( "should not return NaN\n" ); break; @@ -140,7 +173,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/sapx/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/sapx/docs/repl.txt index 42e084cc080c..f62676a59287 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sapx/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/ext/base/sapx/docs/repl.txt @@ -1,7 +1,7 @@ -{{alias}}( N, alpha, x, stride ) - Adds a constant to each element in a single-precision floating-point strided - array. +{{alias}}( N, alpha, x, strideX ) + Adds a scalar constant to each element in a single-precision floating-point + strided array. The `N` and stride parameters determine which elements in the strided array are accessed at runtime. @@ -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 ------- @@ -37,7 +37,7 @@ > {{alias}}( x.length, 5.0, x, 1 ) [ 3.0, 6.0, 8.0, 0.0, 9.0, 4.0, 2.0 ] - // Using `N` and `stride` parameters: + // Using `N` and stride parameters: > x = new {{alias:@stdlib/array/float32}}( [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0, -3.0 ] ); > {{alias}}( 3, 5.0, x, 2 ) [ 3.0, 1.0, 8.0, -5.0, 9.0, -1.0, -3.0 ] @@ -51,13 +51,13 @@ [ 1.0, 3.0, 3.0, 1.0, 5.0, -1.0 ] -{{alias}}.ndarray( N, alpha, x, stride, offset ) - Adds a constant to each element in a single-precision floating-point strided - array using alternative indexing semantics. +{{alias}}.ndarray( N, alpha, x, strideX, offsetX ) + Adds a scalar constant to each element in a single-precision floating-point + strided array 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 ---------- @@ -65,15 +65,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/sapx/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/sapx/docs/types/index.d.ts index 7d857c2b98d9..a3ff0738d11c 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sapx/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/sapx/docs/types/index.d.ts @@ -23,12 +23,12 @@ */ interface Routine { /** - * Adds a constant to each element in a single-precision floating-point strided array. + * Adds a scalar constant to each element in a single-precision floating-point strided array. * * @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 `x` * * @example @@ -39,16 +39,16 @@ interface Routine { * sapx( x.length, 5.0, x, 1 ); * // x => [ 3.0, 6.0, 8.0, 0.0, 9.0, 5.0, 4.0, 2.0 ] */ - ( N: number, alpha: number, x: Float32Array, stride: number ): Float32Array; + ( N: number, alpha: number, x: Float32Array, strideX: number ): Float32Array; /** - * Adds a constant to each element in a single-precision floating-point strided array using alternative indexing semantics. + * Adds a scalar constant to each element in a single-precision floating-point strided array 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 `x` * * @example @@ -59,16 +59,16 @@ interface Routine { * sapx.ndarray( x.length, 5.0, x, 1, 0 ); * // x => [ 3.0, 6.0, 8.0, 0.0, 9.0, 5.0, 4.0, 2.0 ] */ - ndarray( N: number, alpha: number, x: Float32Array, stride: number, offset: number ): Float32Array; + ndarray( N: number, alpha: number, x: Float32Array, strideX: number, offsetX: number ): Float32Array; } /** -* Adds a constant to each element in a single-precision floating-point strided array. +* Adds a scalar constant to each element in a single-precision floating-point strided array. * * @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 `x` * * @example diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapx/examples/c/example.c b/lib/node_modules/@stdlib/blas/ext/base/sapx/examples/c/example.c index d92581131043..b1e0e48c8206 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sapx/examples/c/example.c +++ b/lib/node_modules/@stdlib/blas/ext/base/sapx/examples/c/example.c @@ -21,16 +21,16 @@ int main( void ) { // Create a strided array: - float x[] = { 1.0, -2.0, 3.0, -4.0, 5.0, -6.0, 7.0, -8.0 }; + float x[] = { 1.0f, -2.0f, 3.0f, -4.0f, 5.0f, -6.0f, 7.0f, -8.0f }; - // Specify the number of elements: - int N = 8; + // Specify the number of indexed elements: + const int N = 8; // Specify a stride: - int strideX = 1; + const int strideX = 1; // Add a constant to each element: - c_sapx( N, 5.0f, x, strideX ); + stdlib_strided_sapx( N, 5.0f, x, strideX ); // Print the result: for ( int i = 0; i < 8; i++ ) { diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapx/examples/index.js b/lib/node_modules/@stdlib/blas/ext/base/sapx/examples/index.js index 3e9bf3a73c87..2460d9142b8e 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sapx/examples/index.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sapx/examples/index.js @@ -18,12 +18,12 @@ 'use strict'; -var uniform = require( '@stdlib/random/base/uniform' ).factory; -var filledarrayBy = require( '@stdlib/array/filled-by' ); +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); var sapx = require( './../lib' ); -var x = filledarrayBy( 10, 'float32', uniform( -100.0, 100.0 ) ); - +var x = discreteUniform( 10, -100, 100, { + 'dtype': 'float32' +}); console.log( x ); sapx( x.length, 5.0, x, 1 ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapx/include/stdlib/blas/ext/base/sapx.h b/lib/node_modules/@stdlib/blas/ext/base/sapx/include/stdlib/blas/ext/base/sapx.h index 91ed15d0035a..1ef08133e787 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sapx/include/stdlib/blas/ext/base/sapx.h +++ b/lib/node_modules/@stdlib/blas/ext/base/sapx/include/stdlib/blas/ext/base/sapx.h @@ -19,7 +19,7 @@ #ifndef STDLIB_BLAS_EXT_BASE_SAPX_H #define STDLIB_BLAS_EXT_BASE_SAPX_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. @@ -29,9 +29,14 @@ extern "C" { #endif /** -* Adds a constant to each element in a single-precision floating-point strided array. +* Adds a scalar constant to each element in a single-precision floating-point strided array. */ -void c_sapx( const int64_t N, const float alpha, float *X, const int64_t stride ); +void API_SUFFIX(stdlib_strided_sapx)( const CBLAS_INT N, const float alpha, float *X, const CBLAS_INT strideX ); + +/** +* Adds a scalar constant to each element in a single-precision floating-point strided array using alternative indexing semantics. +*/ +void API_SUFFIX(stdlib_strided_sapx_ndarray)( const CBLAS_INT N, const float alpha, float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); #ifdef __cplusplus } diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapx/lib/index.js b/lib/node_modules/@stdlib/blas/ext/base/sapx/lib/index.js index 1428e568d469..35147f913034 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sapx/lib/index.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sapx/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Add a constant to each element in a single-precision floating-point strided array. +* Add a scalar constant to each element in a single-precision floating-point strided array. * * @module @stdlib/blas/ext/base/sapx * diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapx/lib/ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/sapx/lib/ndarray.js index 85ec6e02d6e4..90a8da4d6790 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sapx/lib/ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sapx/lib/ndarray.js @@ -26,25 +26,24 @@ var M = 5; // MAIN // /** -* Adds a constant to each element in a single-precision floating-point strided array. +* Adds a scalar constant to each element in a single-precision floating-point strided array. * * @param {PositiveInteger} N - number of indexed elements -* @param {number} alpha - scalar +* @param {number} alpha - scalar constant * @param {Float32Array} x - input array -* @param {integer} stride - index increment -* @param {NonNegativeInteger} offset - starting index +* @param {integer} strideX - stride length +* @param {NonNegativeInteger} offsetX - starting index * @returns {Float32Array} input array * * @example * var Float32Array = require( '@stdlib/array/float32' ); * * var x = new Float32Array( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] ); -* var alpha = 5.0; * -* sapx( 3, alpha, x, 1, x.length-3 ); +* sapx( 3, 5.0, x, 1, x.length-3 ); * // x => [ 1.0, -2.0, 3.0, 1.0, 10.0, -1.0 ] */ -function sapx( N, alpha, x, stride, offset ) { +function sapx( N, alpha, x, strideX, offsetX ) { var ix; var m; var i; @@ -52,17 +51,17 @@ function sapx( N, alpha, x, stride, offset ) { if ( N <= 0 || alpha === 0.0 ) { return x; } - ix = offset; + ix = offsetX; // Use loop unrolling if the stride is equal to `1`... - if ( stride === 1 ) { + if ( strideX === 1 ) { m = N % M; // If we have a remainder, run a clean-up loop... if ( m > 0 ) { for ( i = 0; i < m; i++ ) { x[ ix ] += alpha; - ix += stride; + ix += strideX; } } if ( N < M ) { @@ -80,7 +79,7 @@ function sapx( N, alpha, x, stride, offset ) { } for ( i = 0; i < N; i++ ) { x[ ix ] += alpha; - ix += stride; + ix += strideX; } return x; } diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapx/lib/ndarray.native.js b/lib/node_modules/@stdlib/blas/ext/base/sapx/lib/ndarray.native.js index 21a3eee655e9..efaff76ccd2d 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sapx/lib/ndarray.native.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sapx/lib/ndarray.native.js @@ -20,37 +20,31 @@ // MODULES // -var minViewBufferIndex = require( '@stdlib/strided/base/min-view-buffer-index' ); -var offsetView = require( '@stdlib/strided/base/offset-view' ); -var addon = require( './sapx.native.js' ); +var addon = require( './../src/addon.node' ); // MAIN // /** -* Adds a constant to each element in a single-precision floating-point strided array. +* Adds a scalar constant to each element in a single-precision floating-point strided array. * * @param {PositiveInteger} N - number of indexed elements -* @param {number} alpha - scalar +* @param {number} alpha - scalar constant * @param {Float32Array} x - input array -* @param {integer} stride - index increment -* @param {NonNegativeInteger} offset - starting index +* @param {integer} strideX - stride length +* @param {NonNegativeInteger} offsetX - starting index * @returns {Float32Array} input array * * @example * var Float32Array = require( '@stdlib/array/float32' ); * * var x = new Float32Array( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] ); -* var alpha = 5.0; * -* sapx( 3, alpha, x, 1, x.length-3 ); +* sapx( 3, 5.0, x, 1, x.length-3 ); * // x => [ 1.0, -2.0, 3.0, 1.0, 10.0, -1.0 ] */ -function sapx( N, alpha, x, stride, offset ) { - var view; - offset = minViewBufferIndex( N, stride, offset ); - view = offsetView( x, offset ); - addon( N, alpha, view, stride ); +function sapx( N, alpha, x, strideX, offsetX ) { + addon.ndarray( N, alpha, x, strideX, offsetX ); return x; } diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapx/lib/sapx.js b/lib/node_modules/@stdlib/blas/ext/base/sapx/lib/sapx.js index 16d0874abb34..80f34e493382 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sapx/lib/sapx.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sapx/lib/sapx.js @@ -18,20 +18,21 @@ 'use strict'; -// VARIABLES // +// MODULES // -var M = 5; +var stride2offset = require( '@stdlib/strided/base/stride2offset' ); +var ndarray = require( './ndarray.js' ); // MAIN // /** -* Adds a constant to each element in a single-precision floating-point strided array. +* Adds a scalar constant to each element in a single-precision floating-point strided array. * * @param {PositiveInteger} N - number of indexed elements -* @param {number} alpha - scalar +* @param {number} alpha - scalar constant * @param {Float32Array} x - input array -* @param {integer} stride - index increment +* @param {integer} strideX - stride length * @returns {Float32Array} input array * * @example @@ -42,46 +43,8 @@ var M = 5; * sapx( x.length, 5.0, x, 1 ); * // x => [ 3.0, 6.0, 8.0, 0.0, 9.0, 5.0, 4.0, 2.0 ] */ -function sapx( N, alpha, x, stride ) { - var ix; - var i; - var m; - - if ( N <= 0 || alpha === 0.0 ) { - return x; - } - // Use loop unrolling if the stride is equal to `1`... - if ( stride === 1 ) { - m = N % M; - - // If we have a remainder, run a clean-up loop... - if ( m > 0 ) { - for ( i = 0; i < m; i++ ) { - x[ i ] += alpha; - } - } - if ( N < M ) { - return x; - } - for ( i = m; i < N; i += M ) { - x[ i ] += alpha; - x[ i+1 ] += alpha; - x[ i+2 ] += alpha; - x[ i+3 ] += alpha; - x[ i+4 ] += alpha; - } - return x; - } - if ( stride < 0 ) { - ix = (1-N) * stride; - } else { - ix = 0; - } - for ( i = 0; i < N; i++ ) { - x[ ix ] += alpha; - ix += stride; - } - return x; +function sapx( N, alpha, x, strideX ) { + return ndarray( N, alpha, x, strideX, stride2offset( N, strideX ) ); } diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapx/lib/sapx.native.js b/lib/node_modules/@stdlib/blas/ext/base/sapx/lib/sapx.native.js index 5d44d3d8a12a..d48177ff9009 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sapx/lib/sapx.native.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sapx/lib/sapx.native.js @@ -26,12 +26,12 @@ var addon = require( './../src/addon.node' ); // MAIN // /** -* Adds a constant to each element in a single-precision floating-point strided array. +* Adds a scalar constant to each element in a single-precision floating-point strided array. * * @param {PositiveInteger} N - number of indexed elements -* @param {number} alpha - scalar +* @param {number} alpha - scalar constant * @param {Float32Array} x - input array -* @param {integer} stride - index increment +* @param {integer} strideX - stride length * @returns {Float32Array} input array * * @example @@ -42,8 +42,8 @@ var addon = require( './../src/addon.node' ); * sapx( x.length, 5.0, x, 1 ); * // x => [ 3.0, 6.0, 8.0, 0.0, 9.0, 5.0, 4.0, 2.0 ] */ -function sapx( N, alpha, x, stride ) { - addon( N, alpha, x, stride ); +function sapx( N, alpha, x, strideX ) { + addon( N, alpha, x, strideX ); return x; } diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapx/manifest.json b/lib/node_modules/@stdlib/blas/ext/base/sapx/manifest.json index 7cef12cf17e3..10733716c85b 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sapx/manifest.json +++ b/lib/node_modules/@stdlib/blas/ext/base/sapx/manifest.json @@ -28,50 +28,52 @@ { "task": "build", "src": [ - "./src/sapx.c" + "./src/main.c" ], "include": [ "./include" ], - "libraries": [ - "-lm" - ], + "libraries": [], "libpath": [], "dependencies": [ "@stdlib/napi/export", "@stdlib/napi/argv", "@stdlib/napi/argv-int64", "@stdlib/napi/argv-float", - "@stdlib/napi/argv-strided-float32array" + "@stdlib/napi/argv-strided-float32array", + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset" ] }, { "task": "benchmark", "src": [ - "./src/sapx.c" + "./src/main.c" ], "include": [ "./include" ], - "libraries": [ - "-lm" - ], + "libraries": [], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset" + ] }, { "task": "examples", "src": [ - "./src/sapx.c" + "./src/main.c" ], "include": [ "./include" ], - "libraries": [ - "-lm" - ], + "libraries": [], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset" + ] } ] } diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapx/package.json b/lib/node_modules/@stdlib/blas/ext/base/sapx/package.json index f67f02f104bf..be34a4c10c5e 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sapx/package.json +++ b/lib/node_modules/@stdlib/blas/ext/base/sapx/package.json @@ -1,7 +1,7 @@ { "name": "@stdlib/blas/ext/base/sapx", "version": "0.0.0", - "description": "Add a constant to each element in a single-precision floating-point strided array.", + "description": "Add a scalar constant to each element in a single-precision floating-point strided array.", "license": "Apache-2.0", "author": { "name": "The Stdlib Authors", diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapx/src/addon.c b/lib/node_modules/@stdlib/blas/ext/base/sapx/src/addon.c index 9acbeab3ad06..38b9d492a592 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sapx/src/addon.c +++ b/lib/node_modules/@stdlib/blas/ext/base/sapx/src/addon.c @@ -17,6 +17,7 @@ */ #include "stdlib/blas/ext/base/sapx.h" +#include "stdlib/blas/base/shared.h" #include "stdlib/napi/export.h" #include "stdlib/napi/argv.h" #include "stdlib/napi/argv_int64.h" @@ -35,10 +36,28 @@ static napi_value addon( 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_FLOAT( env, alpha, argv, 1 ); - STDLIB_NAPI_ARGV_INT64( env, strideX, argv, 3 ); - STDLIB_NAPI_ARGV_STRIDED_FLOAT32ARRAY( env, X, N, strideX, argv, 2 ) - c_sapx( N, alpha, X, strideX ); + STDLIB_NAPI_ARGV_INT64( env, strideX, argv, 3 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT32ARRAY( env, X, N, strideX, argv, 2 ); + API_SUFFIX(stdlib_strided_sapx)( N, alpha, X, strideX ); return NULL; } -STDLIB_NAPI_MODULE_EXPORT_FCN( addon ) +/** +* 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 ); + API_SUFFIX(stdlib_strided_sapx_ndarray)( N, alpha, X, strideX, offsetX ); + return NULL; +} + +STDLIB_NAPI_MODULE_EXPORT_FCN_WITH_METHOD( addon, "ndarray", addon_method ) diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapx/src/main.c b/lib/node_modules/@stdlib/blas/ext/base/sapx/src/main.c new file mode 100644 index 000000000000..9a1d3480fac7 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/sapx/src/main.c @@ -0,0 +1,84 @@ +/** +* @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/sapx.h" +#include "stdlib/strided/base/stride2offset.h" +#include "stdlib/blas/base/shared.h" + +/** +* Adds a scalar constant to each element in a single-precision floating-point strided array. +* +* @param N number of indexed elements +* @param alpha scalar constant +* @param X input array +* @param strideX stride length +*/ +void API_SUFFIX(stdlib_strided_sapx)( const CBLAS_INT N, const float alpha, float *X, const CBLAS_INT strideX ) { + CBLAS_INT ox = stdlib_strided_stride2offset( N, strideX ); + API_SUFFIX(stdlib_strided_sapx_ndarray)( N, alpha, X, strideX, ox ); +} + +/** +* Adds a scalar constant to each element in a single-precision floating-point strided array 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 +*/ +void API_SUFFIX(stdlib_strided_sapx_ndarray)( const CBLAS_INT N, const float alpha, float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ) { + CBLAS_INT ix; + CBLAS_INT m; + CBLAS_INT i; + + if ( N <= 0 || alpha == 0.0 ) { + return; + } + ix = offsetX; + + // Use loop unrolling if the stride is equal to `1`... + if ( strideX == 1 ) { + m = N % 5; + + // If we have a remainder, run a clean-up loop... + if ( m > 0 ) { + for ( i = 0; i < m; i++ ) { + X[ ix ] += alpha; + ix += strideX; + } + } + if ( N < 5 ) { + return; + } + for ( i = m; i < N; i += 5 ) { + X[ ix ] += alpha; + X[ ix+1 ] += alpha; + X[ ix+2 ] += alpha; + X[ ix+3 ] += alpha; + X[ ix+4 ] += alpha; + ix += 5; + } + return; + } + for ( i = 0; i < N; i++ ) { + X[ ix ] += alpha; + ix += strideX; + } + return; +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/sapx/src/sapx.c b/lib/node_modules/@stdlib/blas/ext/base/sapx/src/sapx.c deleted file mode 100644 index 2771b85c8023..000000000000 --- a/lib/node_modules/@stdlib/blas/ext/base/sapx/src/sapx.c +++ /dev/null @@ -1,70 +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/sapx.h" -#include - -/** -* Adds a constant to each element in a single-precision floating-point strided array. -* -* @param N number of indexed elements -* @param alpha scalar -* @param X input array -* @param stride index increment -*/ -void c_sapx( const int64_t N, const float alpha, float *X, const int64_t stride ) { - int64_t ix; - int64_t m; - int64_t i; - - if ( N <= 0 || alpha == 0.0 ) { - return; - } - // Use loop unrolling if the stride is equal to `1`... - if ( stride == 1 ) { - m = N % 5; - - // If we have a remainder, run a clean-up loop... - if ( m > 0 ) { - for ( i = 0; i < m; i++ ) { - X[ i ] += alpha; - } - } - if ( N < 5 ) { - return; - } - for ( i = m; i < N; i += 5 ) { - X[ i ] += alpha; - X[ i+1 ] += alpha; - X[ i+2 ] += alpha; - X[ i+3 ] += alpha; - X[ i+4 ] += alpha; - } - return; - } - if ( stride < 0 ) { - ix = (1-N) * stride; - } else { - ix = 0; - } - for ( i = 0; i < N; i++ ) { - X[ ix ] += alpha; - ix += stride; - } - return; -}