From 0e281b3043f9f8fb23e157f82b2a61e23f323e8a Mon Sep 17 00:00:00 2001 From: Aman Bhansali <92033532+aman-095@users.noreply.github.com> Date: Fri, 22 Nov 2024 04:35:43 +0530 Subject: [PATCH] feat: add C `ndarray` implementation for `blas/base/sscal` PR-URL: https://github.com/stdlib-js/stdlib/pull/3030 Ref: https://github.com/stdlib-js/stdlib/issues/2039 Co-authored-by: Athan Reines Reviewed-by: Athan Reines Signed-off-by: Athan Reines Co-authored-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> --- .../@stdlib/blas/base/sscal/README.md | 127 ++++++++++++++++++ .../base/sscal/benchmark/c/benchmark.length.c | 35 ++++- .../@stdlib/blas/base/sscal/docs/repl.txt | 2 +- .../blas/base/sscal/docs/types/index.d.ts | 6 +- .../blas/base/sscal/examples/c/example.c | 8 ++ .../sscal/include/stdlib/blas/base/sscal.h | 11 +- .../include/stdlib/blas/base/sscal_cblas.h | 8 +- .../include/stdlib/blas/base/sscal_fortran.h | 6 +- .../@stdlib/blas/base/sscal/lib/ndarray.js | 17 ++- .../blas/base/sscal/lib/ndarray.native.js | 15 +-- .../@stdlib/blas/base/sscal/lib/sscal.js | 44 +----- .../blas/base/sscal/lib/sscal.native.js | 2 +- .../@stdlib/blas/base/sscal/manifest.json | 113 ++++++++++++---- .../@stdlib/blas/base/sscal/package.json | 2 - .../@stdlib/blas/base/sscal/src/addon.c | 29 +++- .../@stdlib/blas/base/sscal/src/sscal.c | 40 +----- .../@stdlib/blas/base/sscal/src/sscal_cblas.c | 28 +++- .../@stdlib/blas/base/sscal/src/sscal_f.c | 28 +++- .../blas/base/sscal/src/sscal_ndarray.c | 72 ++++++++++ .../base/sscal/test/test.ndarray.native.js | 2 +- .../blas/base/sscal/test/test.sscal.js | 29 ++-- .../blas/base/sscal/test/test.sscal.native.js | 26 ++-- 22 files changed, 486 insertions(+), 164 deletions(-) create mode 100644 lib/node_modules/@stdlib/blas/base/sscal/src/sscal_ndarray.c diff --git a/lib/node_modules/@stdlib/blas/base/sscal/README.md b/lib/node_modules/@stdlib/blas/base/sscal/README.md index 162125ea8420..11290c779b53 100644 --- a/lib/node_modules/@stdlib/blas/base/sscal/README.md +++ b/lib/node_modules/@stdlib/blas/base/sscal/README.md @@ -146,6 +146,133 @@ console.log( x ); + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/blas/base/sscal.h" +``` + +#### c_sscal( N, alpha, \*X, stride ) + +Multiplies each element of a single-precision floating-point vector by a constant. + +```c +float x[] = { 1.0f, 2.0f, 3.0f, 4.0f }; + +c_sscal( 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. +- **stride**: `[in] CBLAS_INT` index increment for `X`. + +```c +void c_sscal( const CBLAS_INT N, const float alpha, float *X, const CBLAS_INT stride ); +``` + +#### c_sscal_ndarray( N, alpha, \*X, stride, offset ) + +Multiplies each element of a single-precision floating-point vector by a constant using alternative indexing semantics. + +```c +float x[] = { 1.0f, 2.0f, 3.0f, 4.0f }; + +c_sscal_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. +- **stride**: `[in] CBLAS_INT` index increment for `X`. +- **offset**: `[in] CBLAS_INT` starting index for `X`. + +```c +void c_sscal_ndarray( const CBLAS_INT N, const float alpha, float *X, const CBLAS_INT stride, const CBLAS_INT offset ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/blas/base/sscal.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 elements: + const int N = 8; + + // Specify a stride: + const int stride = 1; + + // Scale the vector: + c_sscal( N, 5.0f, x, stride ); + + // Print the result: + for ( int i = 0; i < 8; i++ ) { + printf( "x[ %i ] = %f\n", i, x[ i ] ); + } + + // Scale the vector using alternative indexing semantics: + c_sscal_ndarray( N, 5.0f, x, -stride, N-1 ); + + // 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/base/sscal/benchmark/c/benchmark.length.c b/lib/node_modules/@stdlib/blas/base/sscal/benchmark/c/benchmark.length.c index 2ec54296c887..803a9ed47192 100644 --- a/lib/node_modules/@stdlib/blas/base/sscal/benchmark/c/benchmark.length.c +++ b/lib/node_modules/@stdlib/blas/base/sscal/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; @@ -118,6 +118,30 @@ static double benchmark( int iterations, int len ) { return elapsed; } +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++ ) { + c_sscal_ndarray( len, 5.0f, x, 1, 0 ); + 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; +} + /** * Main execution sequence. */ @@ -140,7 +164,14 @@ 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 ( 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/base/sscal/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/sscal/docs/repl.txt index 5e77737339ac..67726d2c0b93 100644 --- a/lib/node_modules/@stdlib/blas/base/sscal/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/base/sscal/docs/repl.txt @@ -9,7 +9,7 @@ Indexing is relative to the first index. To introduce an offset, use typed array views. - If `N <= 0` or `stride <= 0`, the function returns `x` unchanged. + If `N <= 0`, the function returns `x` unchanged. Parameters ---------- diff --git a/lib/node_modules/@stdlib/blas/base/sscal/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/sscal/docs/types/index.d.ts index d312beef2bff..d5de3d0e4856 100644 --- a/lib/node_modules/@stdlib/blas/base/sscal/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/base/sscal/docs/types/index.d.ts @@ -28,7 +28,7 @@ interface Routine { * @param N - number of indexed elements * @param alpha - constant * @param x - input array - * @param stride - stride length + * @param stride - index increment * @returns input array * * @example @@ -47,7 +47,7 @@ interface Routine { * @param N - number of indexed elements * @param alpha - constant * @param x - input array - * @param stride - stride length + * @param stride - index increment * @param offset - starting index * @returns input array * @@ -68,7 +68,7 @@ interface Routine { * @param N - number of indexed elements * @param alpha - constant * @param x - input array -* @param stride - stride length +* @param stride - index increment * @returns input array * * @example diff --git a/lib/node_modules/@stdlib/blas/base/sscal/examples/c/example.c b/lib/node_modules/@stdlib/blas/base/sscal/examples/c/example.c index 4d5551c68e74..45b2d167f4ee 100644 --- a/lib/node_modules/@stdlib/blas/base/sscal/examples/c/example.c +++ b/lib/node_modules/@stdlib/blas/base/sscal/examples/c/example.c @@ -36,4 +36,12 @@ int main( void ) { for ( int i = 0; i < 8; i++ ) { printf( "x[ %i ] = %f\n", i, x[ i ] ); } + + // Scale the vector using alternative indexing semantics: + c_sscal_ndarray( N, 5.0f, x, -strideX, N-1 ); + + // 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/base/sscal/include/stdlib/blas/base/sscal.h b/lib/node_modules/@stdlib/blas/base/sscal/include/stdlib/blas/base/sscal.h index 689e2465d27d..82219b06ec4f 100644 --- a/lib/node_modules/@stdlib/blas/base/sscal/include/stdlib/blas/base/sscal.h +++ b/lib/node_modules/@stdlib/blas/base/sscal/include/stdlib/blas/base/sscal.h @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2019 The Stdlib Authors. +* Copyright (c) 2024 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. @@ -22,6 +22,8 @@ #ifndef SSCAL_H #define SSCAL_H +#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. */ @@ -32,7 +34,12 @@ extern "C" { /** * Multiplies each element of a single-precision floating-point vector by a constant. */ -void c_sscal( const int N, const float alpha, float *X, const int stride ); +void API_SUFFIX(c_sscal)( const CBLAS_INT N, const float alpha, float *X, const CBLAS_INT stride ); + +/** +* Multiplies each element of a single-precision floating-point vector by a constant using alternative indexing semantics. +*/ +void API_SUFFIX(c_sscal_ndarray)( const CBLAS_INT N, const float alpha, float *X, const CBLAS_INT stride, const CBLAS_INT offset ); #ifdef __cplusplus } diff --git a/lib/node_modules/@stdlib/blas/base/sscal/include/stdlib/blas/base/sscal_cblas.h b/lib/node_modules/@stdlib/blas/base/sscal/include/stdlib/blas/base/sscal_cblas.h index 7a92b01d83fc..98d3be61f48f 100644 --- a/lib/node_modules/@stdlib/blas/base/sscal/include/stdlib/blas/base/sscal_cblas.h +++ b/lib/node_modules/@stdlib/blas/base/sscal/include/stdlib/blas/base/sscal_cblas.h @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2019 The Stdlib Authors. +* Copyright (c) 2024 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. @@ -19,9 +19,11 @@ /** * Header file containing function declarations for the C interface to the CBLAS Level 1 routine `cblas_sscal`. */ -#ifndef SSCAL_CLBAS_H +#ifndef SSCAL_CBLAS_H #define SSCAL_CBLAS_H +#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. */ @@ -32,7 +34,7 @@ extern "C" { /** * Multiplies each element of a single-precision floating-point vector by a constant. */ -void cblas_sscal( const int N, const float alpha, float *X, const int stride ); +void API_SUFFIX(cblas_sscal)( const CBLAS_INT N, const float alpha, float *X, const CBLAS_INT stride ); #ifdef __cplusplus } diff --git a/lib/node_modules/@stdlib/blas/base/sscal/include/stdlib/blas/base/sscal_fortran.h b/lib/node_modules/@stdlib/blas/base/sscal/include/stdlib/blas/base/sscal_fortran.h index e4ebc2044183..c2e4a0f3601a 100644 --- a/lib/node_modules/@stdlib/blas/base/sscal/include/stdlib/blas/base/sscal_fortran.h +++ b/lib/node_modules/@stdlib/blas/base/sscal/include/stdlib/blas/base/sscal_fortran.h @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2019 The Stdlib Authors. +* Copyright (c) 2024 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. @@ -22,6 +22,8 @@ #ifndef SSCAL_FORTRAN_H #define SSCAL_FORTRAN_H +#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/Fortran compiler (a Fortran compiler must be configured to not attach underscores). */ @@ -32,7 +34,7 @@ extern "C" { /** * Multiplies each element of a single-precision floating-point vector by a constant. */ -void sscal( const int *, const float *, float *, const int * ); +void sscal( const CBLAS_INT *, const float *, float *, const CBLAS_INT * ); #ifdef __cplusplus } diff --git a/lib/node_modules/@stdlib/blas/base/sscal/lib/ndarray.js b/lib/node_modules/@stdlib/blas/base/sscal/lib/ndarray.js index e71793163b98..6f6b24a4dd3e 100644 --- a/lib/node_modules/@stdlib/blas/base/sscal/lib/ndarray.js +++ b/lib/node_modules/@stdlib/blas/base/sscal/lib/ndarray.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2019 The Stdlib Authors. +* Copyright (c) 2024 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. @@ -39,15 +39,14 @@ var M = 5; * 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; * -* sscal( 3, alpha, x, 1, x.length-3 ); +* sscal( 3, 5.0, x, 1, x.length-3 ); * // x => [ 1.0, -2.0, 3.0, -20.0, 25.0, -30.0 ] */ function sscal( N, alpha, x, stride, offset ) { var ix; - var i; var m; + var i; if ( N <= 0 || alpha === 1.0 ) { return x; @@ -69,11 +68,11 @@ function sscal( N, alpha, x, stride, offset ) { 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; + x[ ix ] *= alpha; + x[ ix+1 ] *= alpha; + x[ ix+2 ] *= alpha; + x[ ix+3 ] *= alpha; + x[ ix+4 ] *= alpha; ix += M; } return x; diff --git a/lib/node_modules/@stdlib/blas/base/sscal/lib/ndarray.native.js b/lib/node_modules/@stdlib/blas/base/sscal/lib/ndarray.native.js index f83e42b0d16b..a5cb29efd8ed 100644 --- a/lib/node_modules/@stdlib/blas/base/sscal/lib/ndarray.native.js +++ b/lib/node_modules/@stdlib/blas/base/sscal/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( './sscal.native.js' ); +var addon = require( './../src/addon.node' ); // MAIN // @@ -41,19 +39,12 @@ var addon = require( './sscal.native.js' ); * 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; * -* sscal( 3, alpha, x, 1, x.length-3 ); +* sscal( 3, 5.0, x, 1, x.length-3 ); * // x => [ 1.0, -2.0, 3.0, -20.0, 25.0, -30.0 ] */ function sscal( N, alpha, x, stride, offset ) { - var view; - offset = minViewBufferIndex( N, stride, offset ); - if ( stride < 0 ) { - stride *= -1; - } - view = offsetView( x, offset ); - addon( N, alpha, view, stride ); + addon.ndarray( N, alpha, x, stride, offset ); return x; } diff --git a/lib/node_modules/@stdlib/blas/base/sscal/lib/sscal.js b/lib/node_modules/@stdlib/blas/base/sscal/lib/sscal.js index f35e39334404..2abd0147ea22 100644 --- a/lib/node_modules/@stdlib/blas/base/sscal/lib/sscal.js +++ b/lib/node_modules/@stdlib/blas/base/sscal/lib/sscal.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2019 The Stdlib Authors. +* Copyright (c) 2024 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. @@ -18,9 +18,10 @@ 'use strict'; -// VARIABLES // +// MODULES // -var M = 5; +var stride2offset = require( '@stdlib/strided/base/stride2offset' ); +var ndarray = require( './ndarray.js' ); // MAIN // @@ -31,7 +32,7 @@ var M = 5; * @param {PositiveInteger} N - number of indexed elements * @param {number} alpha - scalar * @param {Float32Array} x - input array -* @param {PositiveInteger} stride - index increment +* @param {integer} stride - index increment * @returns {Float32Array} input array * * @example @@ -43,39 +44,8 @@ var M = 5; * // x => [ -10.0, 5.0, 15.0, -25.0, 20.0, 0.0, -5.0, -15.0 ] */ function sscal( N, alpha, x, stride ) { - var i; - var m; - - if ( N <= 0 || stride <= 0|| alpha === 1.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; - } - N *= stride; - for ( i = 0; i < N; i += stride ) { - x[ i ] *= alpha; - } - return x; + var ox = stride2offset( N, stride ); + return ndarray( N, alpha, x, stride, ox ); } diff --git a/lib/node_modules/@stdlib/blas/base/sscal/lib/sscal.native.js b/lib/node_modules/@stdlib/blas/base/sscal/lib/sscal.native.js index 1903ff7f1c13..1cd6820d3d49 100644 --- a/lib/node_modules/@stdlib/blas/base/sscal/lib/sscal.native.js +++ b/lib/node_modules/@stdlib/blas/base/sscal/lib/sscal.native.js @@ -31,7 +31,7 @@ var addon = require( './../src/addon.node' ); * @param {PositiveInteger} N - number of indexed elements * @param {number} alpha - scalar * @param {Float32Array} x - input array -* @param {PositiveInteger} stride - index increment +* @param {integer} stride - index increment * @returns {Float32Array} input array * * @example diff --git a/lib/node_modules/@stdlib/blas/base/sscal/manifest.json b/lib/node_modules/@stdlib/blas/base/sscal/manifest.json index 0f20adee9708..d8f2b93d79eb 100644 --- a/lib/node_modules/@stdlib/blas/base/sscal/manifest.json +++ b/lib/node_modules/@stdlib/blas/base/sscal/manifest.json @@ -43,10 +43,12 @@ "libraries": [], "libpath": [], "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/min-view-buffer-index", "@stdlib/napi/export", "@stdlib/napi/argv", - "@stdlib/napi/argv-float", "@stdlib/napi/argv-int64", + "@stdlib/napi/argv-float", "@stdlib/napi/argv-strided-float32array" ] }, @@ -56,14 +58,18 @@ "blas": "", "wasm": false, "src": [ - "./src/sscal.c" + "./src/sscal.c", + "./src/sscal_ndarray.c" ], "include": [ "./include" ], "libraries": [], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset" + ] }, { "task": "examples", @@ -71,14 +77,18 @@ "blas": "", "wasm": false, "src": [ - "./src/sscal.c" + "./src/sscal.c", + "./src/sscal_ndarray.c" ], "include": [ "./include" ], "libraries": [], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset" + ] }, { @@ -98,10 +108,12 @@ ], "libpath": [], "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/min-view-buffer-index", "@stdlib/napi/export", "@stdlib/napi/argv", - "@stdlib/napi/argv-float", "@stdlib/napi/argv-int64", + "@stdlib/napi/argv-float", "@stdlib/napi/argv-strided-float32array" ] }, @@ -121,7 +133,10 @@ "-lpthread" ], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/min-view-buffer-index" + ] }, { "task": "examples", @@ -139,7 +154,10 @@ "-lpthread" ], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/min-view-buffer-index" + ] }, { @@ -157,10 +175,12 @@ "libraries": [], "libpath": [], "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/min-view-buffer-index", "@stdlib/napi/export", "@stdlib/napi/argv", - "@stdlib/napi/argv-float", "@stdlib/napi/argv-int64", + "@stdlib/napi/argv-float", "@stdlib/napi/argv-strided-float32array" ] }, @@ -170,14 +190,18 @@ "blas": "", "wasm": false, "src": [ - "./src/sscal.c" + "./src/sscal.c", + "./src/sscal_ndarray.c" ], "include": [ "./include" ], "libraries": [], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset" + ] }, { "task": "examples", @@ -185,14 +209,18 @@ "blas": "", "wasm": false, "src": [ - "./src/sscal.c" + "./src/sscal.c", + "./src/sscal_ndarray.c" ], "include": [ "./include" ], "libraries": [], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset" + ] }, { @@ -211,10 +239,12 @@ ], "libpath": [], "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/min-view-buffer-index", "@stdlib/napi/export", "@stdlib/napi/argv", - "@stdlib/napi/argv-float", "@stdlib/napi/argv-int64", + "@stdlib/napi/argv-float", "@stdlib/napi/argv-strided-float32array" ] }, @@ -233,7 +263,10 @@ "-lblas" ], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/min-view-buffer-index" + ] }, { "task": "examples", @@ -250,7 +283,10 @@ "-lblas" ], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/min-view-buffer-index" + ] }, { @@ -270,10 +306,12 @@ ], "libpath": [], "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/min-view-buffer-index", "@stdlib/napi/export", "@stdlib/napi/argv", - "@stdlib/napi/argv-float", "@stdlib/napi/argv-int64", + "@stdlib/napi/argv-float", "@stdlib/napi/argv-strided-float32array" ] }, @@ -293,7 +331,10 @@ "-lpthread" ], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/min-view-buffer-index" + ] }, { "task": "examples", @@ -311,7 +352,10 @@ "-lpthread" ], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/min-view-buffer-index" + ] }, { @@ -320,7 +364,8 @@ "blas": "", "wasm": false, "src": [ - "./src/sscal.c" + "./src/sscal.c", + "./src/sscal_ndarray.c" ], "include": [ "./include" @@ -328,10 +373,12 @@ "libraries": [], "libpath": [], "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset", "@stdlib/napi/export", "@stdlib/napi/argv", - "@stdlib/napi/argv-float", "@stdlib/napi/argv-int64", + "@stdlib/napi/argv-float", "@stdlib/napi/argv-strided-float32array" ] }, @@ -341,14 +388,18 @@ "blas": "", "wasm": false, "src": [ - "./src/sscal.c" + "./src/sscal.c", + "./src/sscal_ndarray.c" ], "include": [ "./include" ], "libraries": [], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset" + ] }, { "task": "examples", @@ -356,14 +407,18 @@ "blas": "", "wasm": false, "src": [ - "./src/sscal.c" + "./src/sscal.c", + "./src/sscal_ndarray.c" ], "include": [ "./include" ], "libraries": [], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset" + ] }, { @@ -372,14 +427,18 @@ "blas": "", "wasm": true, "src": [ - "./src/sscal.c" + "./src/sscal.c", + "./src/sscal_ndarray.c" ], "include": [ "./include" ], "libraries": [], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset" + ] } ] } diff --git a/lib/node_modules/@stdlib/blas/base/sscal/package.json b/lib/node_modules/@stdlib/blas/base/sscal/package.json index 5befba75665b..e553bf051ca4 100644 --- a/lib/node_modules/@stdlib/blas/base/sscal/package.json +++ b/lib/node_modules/@stdlib/blas/base/sscal/package.json @@ -60,7 +60,6 @@ "blas", "level 1", "sscal", - "dscal", "linear", "algebra", "scal", @@ -72,7 +71,6 @@ "ndarray", "float32", "float", - "single", "float32array" ], "__stdlib__": { diff --git a/lib/node_modules/@stdlib/blas/base/sscal/src/addon.c b/lib/node_modules/@stdlib/blas/base/sscal/src/addon.c index 920b5b9c271b..00c364a7b6e8 100644 --- a/lib/node_modules/@stdlib/blas/base/sscal/src/addon.c +++ b/lib/node_modules/@stdlib/blas/base/sscal/src/addon.c @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2020 The Stdlib Authors. +* Copyright (c) 2024 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. @@ -17,6 +17,7 @@ */ #include "stdlib/blas/base/sscal.h" +#include "stdlib/blas/base/shared.h" #include "stdlib/napi/export.h" #include "stdlib/napi/argv.h" #include "stdlib/napi/argv_float.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_sscal( N, alpha, X, strideX ); + STDLIB_NAPI_ARGV_INT64( env, stride, argv, 3 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT32ARRAY( env, X, N, stride, argv, 2 ); + API_SUFFIX(c_sscal)( N, alpha, X, stride ); 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, stride, argv, 3 ); + STDLIB_NAPI_ARGV_INT64( env, offset, argv, 4 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT32ARRAY( env, X, N, stride, argv, 2 ); + API_SUFFIX(c_sscal_ndarray)( N, alpha, X, stride, offset ); + return NULL; +} + +STDLIB_NAPI_MODULE_EXPORT_FCN_WITH_METHOD( addon, "ndarray", addon_method ) diff --git a/lib/node_modules/@stdlib/blas/base/sscal/src/sscal.c b/lib/node_modules/@stdlib/blas/base/sscal/src/sscal.c index 22f8a705a611..7f2d8da1bb8f 100644 --- a/lib/node_modules/@stdlib/blas/base/sscal/src/sscal.c +++ b/lib/node_modules/@stdlib/blas/base/sscal/src/sscal.c @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2019 The Stdlib Authors. +* Copyright (c) 2024 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. @@ -17,6 +17,8 @@ */ #include "stdlib/blas/base/sscal.h" +#include "stdlib/blas/base/shared.h" +#include "stdlib/strided/base/stride2offset.h" /** * Multiplies a single-precision floating-point vector `X` by a constant. @@ -26,37 +28,7 @@ * @param X input array * @param stride index increment */ -void c_sscal( const int N, const float alpha, float *X, const int stride ) { - int i; - int m; - - if ( N <= 0 || stride <= 0 || alpha == 1.0f ) { - 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; - } - for ( i = 0; i < N*stride; i += stride ) { - X[ i ] *= alpha; - } - return; +void API_SUFFIX(c_sscal)( const CBLAS_INT N, const float alpha, float *X, const CBLAS_INT stride ) { + CBLAS_INT ox = stdlib_strided_stride2offset( N, stride ); + API_SUFFIX(c_sscal_ndarray)( N, alpha, X, stride, ox ); } diff --git a/lib/node_modules/@stdlib/blas/base/sscal/src/sscal_cblas.c b/lib/node_modules/@stdlib/blas/base/sscal/src/sscal_cblas.c index 8816d9ae6b98..f3d2de9bca37 100644 --- a/lib/node_modules/@stdlib/blas/base/sscal/src/sscal_cblas.c +++ b/lib/node_modules/@stdlib/blas/base/sscal/src/sscal_cblas.c @@ -18,6 +18,8 @@ #include "stdlib/blas/base/sscal.h" #include "stdlib/blas/base/sscal_cblas.h" +#include "stdlib/blas/base/shared.h" +#include "stdlib/strided/base/min_view_buffer_index.h" /** * Multiplies a single-precision floating-point vector `X` by a constant. @@ -27,6 +29,28 @@ * @param X input array * @param stride index increment */ -void c_sscal( const int N, const float alpha, float *X, const int stride ) { - cblas_sscal( N, alpha, X, stride ); +void API_SUFFIX(c_sscal)( const CBLAS_INT N, const float alpha, float *X, const CBLAS_INT stride ) { + CBLAS_INT sx = stride; + if ( sx < 0 ) { + sx = -sx; + } + API_SUFFIX(cblas_sscal)( N, alpha, X, sx ); +} + +/** +* Multiplies a single-precision floating-point vector `X` by a constant using alternative indexing semantics. +* +* @param N number of indexed elements +* @param alpha scalar +* @param X input array +* @param stride index increment +* @param offset starting index +*/ +void API_SUFFIX(c_sscal_ndarray)( const CBLAS_INT N, const float alpha, float *X, const CBLAS_INT stride, const CBLAS_INT offset ) { + CBLAS_INT sx = stride; + X += stdlib_strided_min_view_buffer_index( N, stride, offset ); // adjust array pointer + if ( sx < 0 ) { + sx = -sx; + } + API_SUFFIX(cblas_sscal)( N, alpha, X, sx ); } diff --git a/lib/node_modules/@stdlib/blas/base/sscal/src/sscal_f.c b/lib/node_modules/@stdlib/blas/base/sscal/src/sscal_f.c index 0b723b23d1e1..a1ab636fbd04 100644 --- a/lib/node_modules/@stdlib/blas/base/sscal/src/sscal_f.c +++ b/lib/node_modules/@stdlib/blas/base/sscal/src/sscal_f.c @@ -18,6 +18,8 @@ #include "stdlib/blas/base/sscal.h" #include "stdlib/blas/base/sscal_fortran.h" +#include "stdlib/blas/base/shared.h" +#include "stdlib/strided/base/min_view_buffer_index.h" /** * Multiplies a single-precision floating-point vector `X` by a constant. @@ -27,6 +29,28 @@ * @param X input array * @param stride index increment */ -void c_sscal( const int N, const float alpha, float *X, const int stride ) { - sscal( &N, &alpha, X, &stride ); +void API_SUFFIX(c_sscal)( const CBLAS_INT N, const float alpha, float *X, const CBLAS_INT stride ) { + CBLAS_INT sx = stride; + if ( sx < 0 ) { + sx = -sx; + } + sscal( &N, &alpha, X, &sx ); +} + +/** +* Multiplies a single-precision floating-point vector `X` by a constant using alternative indexing semantics. +* +* @param N number of indexed elements +* @param alpha scalar +* @param X input array +* @param stride index increment +* @param offset starting index +*/ +void API_SUFFIX(c_sscal_ndarray)( const CBLAS_INT N, const float alpha, float *X, const CBLAS_INT stride, const CBLAS_INT offset ) { + CBLAS_INT sx = stride; + if ( sx < 0 ) { + sx = -sx; + } + X += stdlib_strided_min_view_buffer_index( N, stride, offset ); // adjust array pointer + sscal( &N, &alpha, X, &sx ); } diff --git a/lib/node_modules/@stdlib/blas/base/sscal/src/sscal_ndarray.c b/lib/node_modules/@stdlib/blas/base/sscal/src/sscal_ndarray.c new file mode 100644 index 000000000000..ff9b424193f6 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/sscal/src/sscal_ndarray.c @@ -0,0 +1,72 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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/base/sscal.h" +#include "stdlib/blas/base/shared.h" + +static const CBLAS_INT M = 5; + +/** +* Multiplies a single-precision floating-point vector `X` by a constant using alternative indexing semantics. +* +* @param N number of indexed elements +* @param alpha scalar +* @param X input array +* @param stride index increment +* @param offset starting index +*/ +void API_SUFFIX(c_sscal_ndarray)( const CBLAS_INT N, const float alpha, float *X, const CBLAS_INT stride, const CBLAS_INT offset ) { + CBLAS_INT ix; + CBLAS_INT i; + CBLAS_INT m; + + if ( N <= 0 || alpha == 1.0f ) { + return; + } + ix = offset; + + // 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[ ix ] *= alpha; + ix += stride; + } + } + if ( N < M ) { + return; + } + for ( i = m; i < N; i += M ) { + X[ ix ] *= alpha; + X[ ix+1 ] *= alpha; + X[ ix+2 ] *= alpha; + X[ ix+3 ] *= alpha; + X[ ix+4 ] *= alpha; + ix += M; + } + return; + } + for ( i = 0; i < N; i++ ) { + X[ ix ] *= alpha; + ix += stride; + } + return; +} diff --git a/lib/node_modules/@stdlib/blas/base/sscal/test/test.ndarray.native.js b/lib/node_modules/@stdlib/blas/base/sscal/test/test.ndarray.native.js index 09bbb0c09459..40cf502920ed 100644 --- a/lib/node_modules/@stdlib/blas/base/sscal/test/test.ndarray.native.js +++ b/lib/node_modules/@stdlib/blas/base/sscal/test/test.ndarray.native.js @@ -167,7 +167,7 @@ tape( 'the function supports specifying a negative stride', opts, function test( 30.0 // 0 ]); - sscal( 3, 5.0, x, -2, x.length-1 ); + sscal( 3, 5.0, x, -2, 4 ); t.deepEqual( x, expected, 'returns expected value' ); t.end(); }); diff --git a/lib/node_modules/@stdlib/blas/base/sscal/test/test.sscal.js b/lib/node_modules/@stdlib/blas/base/sscal/test/test.sscal.js index b6933e5f564a..4a10eebaf3c2 100644 --- a/lib/node_modules/@stdlib/blas/base/sscal/test/test.sscal.js +++ b/lib/node_modules/@stdlib/blas/base/sscal/test/test.sscal.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2019 The Stdlib Authors. +* Copyright (c) 2024 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. @@ -139,19 +139,27 @@ tape( 'the function supports specifying a stride', function test( t ) { t.end(); }); -tape( 'if provided a `stride` less than or equal to `0`, the function returns `x` unchanged', function test( t ) { +tape( 'the function supports specifying a negative stride', function test( t ) { var expected; var x; - x = new Float32Array( [ 3.0, -4.0, 1.0 ] ); - expected = new Float32Array( [ 3.0, -4.0, 1.0 ] ); - - sscal( x.length, 5.0, x, 0 ); - t.deepEqual( x, expected, 'returns expected value' ); + x = new Float32Array([ + 2.0, // 2 + -3.0, + -5.0, // 1 + 7.0, + 6.0 // 0 + ]); + expected = new Float32Array([ + 10.0, // 2 + -3.0, + -25.0, // 1 + 7.0, + 30.0 // 0 + ]); - sscal( x.length, 5.0, x, -1 ); + sscal( 3, 5.0, x, -2 ); t.deepEqual( x, expected, 'returns expected value' ); - t.end(); }); @@ -169,6 +177,7 @@ tape( 'the function supports view offsets', function test( t ) { 6.0 // 2 ]); expected = new Float32Array([ + 1.0, 10.0, 3.0, 20.0, @@ -179,7 +188,7 @@ tape( 'the function supports view offsets', function test( t ) { x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); sscal( 3, 5.0, x1, 2 ); - t.deepEqual( x1, expected, 'returns expected value' ); + t.deepEqual( x0, expected, 'returns expected value' ); t.end(); }); diff --git a/lib/node_modules/@stdlib/blas/base/sscal/test/test.sscal.native.js b/lib/node_modules/@stdlib/blas/base/sscal/test/test.sscal.native.js index daa1c164f8fa..a72ea061cffe 100644 --- a/lib/node_modules/@stdlib/blas/base/sscal/test/test.sscal.native.js +++ b/lib/node_modules/@stdlib/blas/base/sscal/test/test.sscal.native.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2020 The Stdlib Authors. +* Copyright (c) 2024 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. @@ -148,19 +148,27 @@ tape( 'the function supports specifying a stride', opts, function test( t ) { t.end(); }); -tape( 'if provided a `stride` less than or equal to `0`, the function returns `x` unchanged', opts, function test( t ) { +tape( 'the function supports specifying a negative stride', opts, function test( t ) { var expected; var x; - x = new Float32Array( [ 3.0, -4.0, 1.0 ] ); - expected = new Float32Array( [ 3.0, -4.0, 1.0 ] ); - - sscal( x.length, 5.0, x, 0 ); - t.deepEqual( x, expected, 'returns expected value' ); + x = new Float32Array([ + 2.0, // 2 + -3.0, + -5.0, // 1 + 7.0, + 6.0 // 0 + ]); + expected = new Float32Array([ + 10.0, // 2 + -3.0, + -25.0, // 1 + 7.0, + 30.0 // 0 + ]); - sscal( x.length, 5.0, x, -1 ); + sscal( 3, 5.0, x, -2 ); t.deepEqual( x, expected, 'returns expected value' ); - t.end(); });