From 0a4b659ffe648ba49ab7cc47920f96e160a685ff Mon Sep 17 00:00:00 2001 From: aman-095 Date: Wed, 2 Oct 2024 17:57:46 +0530 Subject: [PATCH 1/2] feat: update Js implementation and add C implementation for idamax --- .../@stdlib/blas/base/idamax/README.md | 124 ++++++++++++++++++ .../idamax/benchmark/c/benchmark.length.c | 44 ++++++- .../blas/base/idamax/examples/c/example.c | 6 + .../idamax/include/stdlib/blas/base/idamax.h | 9 +- .../include/stdlib/blas/base/idamax_cblas.h | 4 +- .../@stdlib/blas/base/idamax/lib/idamax.js | 42 +----- .../blas/base/idamax/lib/ndarray.native.js | 12 +- .../@stdlib/blas/base/idamax/manifest.json | 102 ++++++++++++-- .../@stdlib/blas/base/idamax/src/addon.c | 25 +++- .../@stdlib/blas/base/idamax/src/idamax.c | 46 +------ .../blas/base/idamax/src/idamax_cblas.c | 65 ++++++++- .../@stdlib/blas/base/idamax/src/idamax_f.c | 69 +++++++++- .../blas/base/idamax/src/idamax_ndarray.c | 57 ++++++++ .../blas/base/idamax/test/test.idamax.js | 33 +++-- .../base/idamax/test/test.idamax.native.js | 33 +++-- 15 files changed, 523 insertions(+), 148 deletions(-) create mode 100644 lib/node_modules/@stdlib/blas/base/idamax/src/idamax_ndarray.c diff --git a/lib/node_modules/@stdlib/blas/base/idamax/README.md b/lib/node_modules/@stdlib/blas/base/idamax/README.md index 56cf4f873cc..71a4dacd637 100644 --- a/lib/node_modules/@stdlib/blas/base/idamax/README.md +++ b/lib/node_modules/@stdlib/blas/base/idamax/README.md @@ -143,6 +143,130 @@ console.log( idx ); + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/blas/base/idamax.h" +``` + +#### c_idamax( N, \*X, strideX ) + +Finds the index of the first element having the maximum absolute value. + +```c +const double x[] = { 4.0, 2.0, -3.0, 5.0, -1.0 }; + +int idx = c_idamax( 5, x, 1 ); +// returns 3 +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **X**: `[in] double*` first input array. +- **strideX**: `[in] CBLAS_INT` index increment for `X`. + +```c +CBLAS_INT c_idamax( const CBLAS_INT N, const double *X, const CBLAS_INT strideX ); +``` + +#### c_idamax_ndarray( N, \*X, strideX, offsetX ) + +Finds the index of the first element having the maximum absolute value using alternative indexing semantics. + +```c +const double x[] = { 4.0, 2.0, -3.0, 5.0, -1.0 }; + +int idx = c_idamax_ndarray( 5, x, 1, 0 ); +// returns 3 +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **X**: `[in] double*` first input array. +- **strideX**: `[in] CBLAS_INT` index increment for `X`. +- **offsetX**: `[in] CBLAS_INT` starting index for `X`. + +```c +CBLAS_INT c_idamax_ndarray( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/blas/base/idamax.h" +#include + +int main( void ) { + // Create strided array: + const double x[] = { 1.0, -2.0, 3.0, -4.0, 5.0, -6.0, 7.0, -8.0 }; + + // Specify the number of element: + const int N = 8; + + // Specify stride: + const int strideX = 1; + + // Compute the index of the maximum absolute value: + int idx = c_idamax( N, x, strideX ); + + // Print the result: + printf( "index value: %d\n", idx ); + + // Compute the index of the maximum absolute value: + idx = c_idamax_ndarray( N, x, -strideX, N-1 ); + + // Print the result: + printf( "index value: %d\n", idx ); +} +``` + +
+ + + +
+ + + +
diff --git a/lib/node_modules/@stdlib/blas/base/idamax/benchmark/c/benchmark.length.c b/lib/node_modules/@stdlib/blas/base/idamax/benchmark/c/benchmark.length.c index 24105e7247a..ce5609f5f95 100644 --- a/lib/node_modules/@stdlib/blas/base/idamax/benchmark/c/benchmark.length.c +++ b/lib/node_modules/@stdlib/blas/base/idamax/benchmark/c/benchmark.length.c @@ -94,7 +94,7 @@ static double rand_double( 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; double x[ len ]; double t; @@ -120,6 +120,39 @@ 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; + double x[ len ]; + double t; + int idx; + int i; + + for ( i = 0; i < len; i++ ) { + x[ i ] = ( rand_double()*20000.0 ) - 10000.0; + } + idx = -1; + t = tic(); + for ( i = 0; i < iterations; i++ ) { + idx = c_idamax_ndarray( len, x, 1, 0 ); + if ( idx < -2 ) { + printf( "unexpected result\n" ); + break; + } + } + elapsed = tic() - t; + if ( idx < -2 ) { + printf( "unexpected result\n" ); + } + return elapsed; +} + /** * Main execution sequence. */ @@ -142,7 +175,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/idamax/examples/c/example.c b/lib/node_modules/@stdlib/blas/base/idamax/examples/c/example.c index 9656cf8d3a8..3bafd16dc17 100644 --- a/lib/node_modules/@stdlib/blas/base/idamax/examples/c/example.c +++ b/lib/node_modules/@stdlib/blas/base/idamax/examples/c/example.c @@ -34,4 +34,10 @@ int main( void ) { // Print the result: printf( "index value: %d\n", idx ); + + // Compute the index of the maximum absolute value: + idx = c_idamax_ndarray( N, x, -strideX, N-1 ); + + // Print the result: + printf( "index value: %d\n", idx ); } diff --git a/lib/node_modules/@stdlib/blas/base/idamax/include/stdlib/blas/base/idamax.h b/lib/node_modules/@stdlib/blas/base/idamax/include/stdlib/blas/base/idamax.h index 2288ac6057f..bd916dfa4e2 100644 --- a/lib/node_modules/@stdlib/blas/base/idamax/include/stdlib/blas/base/idamax.h +++ b/lib/node_modules/@stdlib/blas/base/idamax/include/stdlib/blas/base/idamax.h @@ -22,6 +22,8 @@ #ifndef IDAMAX_H #define IDAMAX_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" { /** * Finds the index of the first element having the maximum absolute value. */ -int c_idamax( const int N, const double *X, const int strideX ); +CBLAS_INT API_SUFFIX(c_idamax)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX ); + +/** +* Finds the index of the first element having the maximum absolute value using alternative indexing semantics. +*/ +CBLAS_INT API_SUFFIX(c_idamax_ndarray)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); #ifdef __cplusplus } diff --git a/lib/node_modules/@stdlib/blas/base/idamax/include/stdlib/blas/base/idamax_cblas.h b/lib/node_modules/@stdlib/blas/base/idamax/include/stdlib/blas/base/idamax_cblas.h index e44daf4ab01..96c39064891 100644 --- a/lib/node_modules/@stdlib/blas/base/idamax/include/stdlib/blas/base/idamax_cblas.h +++ b/lib/node_modules/@stdlib/blas/base/idamax/include/stdlib/blas/base/idamax_cblas.h @@ -22,6 +22,8 @@ #ifndef IDAMAX_CLBAS_H #define IDAMAX_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" { /** * Finds the index of the first element having the maximum absolute value. */ -int cblas_idamax( const int N, const double *X, const int strideX ); +CBLAS_INT API_SUFFIX(cblas_idamax)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX ); #ifdef __cplusplus } diff --git a/lib/node_modules/@stdlib/blas/base/idamax/lib/idamax.js b/lib/node_modules/@stdlib/blas/base/idamax/lib/idamax.js index 524eba592ec..3bad805b9c4 100644 --- a/lib/node_modules/@stdlib/blas/base/idamax/lib/idamax.js +++ b/lib/node_modules/@stdlib/blas/base/idamax/lib/idamax.js @@ -20,7 +20,8 @@ // MODULES // -var abs = require( '@stdlib/math/base/special/abs' ); +var stride2offset = require( '@stdlib/strided/base/stride2offset' ); +var ndarray = require( './ndarray.js' ); // MAIN // @@ -42,43 +43,8 @@ var abs = require( '@stdlib/math/base/special/abs' ); * // returns 4 */ function idamax( N, x, strideX ) { - var dmax; - var idx; - var ix; - var v; - var i; - - if ( N < 1 || strideX <= 0 ) { - return -1; - } - idx = 0; - if ( N === 1 ) { - return idx; - } - if (strideX === 1 ) { - // Code for stride equal to `1`... - dmax = abs( x[ 0 ] ); - for ( i = 1; i < N; i++ ) { - v = abs( x[ i ] ); - if ( v > dmax ) { - idx = i; - dmax = v; - } - } - return idx; - } - // Code for stride not equal to `1`... - dmax = abs( x[ 0 ] ); - ix = strideX; - for ( i = 1; i < N; i++ ) { - v = abs( x[ ix ] ); - if ( v > dmax ) { - idx = i; - dmax = v; - } - ix += strideX; - } - return idx; + var ox = stride2offset( N, strideX ); + return ndarray( N, x, strideX, ox ); } diff --git a/lib/node_modules/@stdlib/blas/base/idamax/lib/ndarray.native.js b/lib/node_modules/@stdlib/blas/base/idamax/lib/ndarray.native.js index f4123a9e92b..a6964cb588e 100644 --- a/lib/node_modules/@stdlib/blas/base/idamax/lib/ndarray.native.js +++ b/lib/node_modules/@stdlib/blas/base/idamax/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( './idamax.native.js' ); +var addon = require( './../src/addon.node' ); // MAIN // @@ -45,13 +43,7 @@ var addon = require( './idamax.native.js' ); * // returns 3 */ function idamax( N, x, strideX, offsetX ) { - var viewX; - offsetX = minViewBufferIndex( N, strideX, offsetX ); - viewX = offsetView( x, offsetX ); - if ( strideX < 0 ) { - return N - 1 - addon( N, viewX, -strideX ); - } - return addon( N, viewX, strideX ); + return addon.ndarray( N, x, strideX, offsetX ); } diff --git a/lib/node_modules/@stdlib/blas/base/idamax/manifest.json b/lib/node_modules/@stdlib/blas/base/idamax/manifest.json index 276a00f38b5..0223b75053c 100644 --- a/lib/node_modules/@stdlib/blas/base/idamax/manifest.json +++ b/lib/node_modules/@stdlib/blas/base/idamax/manifest.json @@ -45,6 +45,10 @@ "libpath": [], "dependencies": [ "@stdlib/napi/export", + "@stdlib/blas/base/shared", + "@stdlib/strided/base/min-view-buffer-index", + "@stdlib/blas/base/xerbla", + "@stdlib/blas/base/dcopy", "@stdlib/napi/argv", "@stdlib/napi/argv-int64", "@stdlib/napi/argv-strided-float64array", @@ -58,7 +62,8 @@ "blas": "", "wasm": false, "src": [ - "./src/idamax.c" + "./src/idamax.c", + "./src/idamax_ndarray.c" ], "include": [ "./include" @@ -66,6 +71,8 @@ "libraries": [], "libpath": [], "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset", "@stdlib/math/base/special/abs" ] }, @@ -75,7 +82,8 @@ "blas": "", "wasm": false, "src": [ - "./src/idamax.c" + "./src/idamax.c", + "./src/idamax_ndarray.c" ], "include": [ "./include" @@ -83,6 +91,8 @@ "libraries": [], "libpath": [], "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset", "@stdlib/math/base/special/abs" ] }, @@ -105,6 +115,10 @@ "libpath": [], "dependencies": [ "@stdlib/napi/export", + "@stdlib/blas/base/shared", + "@stdlib/strided/base/min-view-buffer-index", + "@stdlib/blas/base/xerbla", + "@stdlib/blas/base/dcopy", "@stdlib/napi/argv", "@stdlib/napi/argv-int64", "@stdlib/napi/argv-strided-float64array", @@ -127,7 +141,12 @@ "-lpthread" ], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/min-view-buffer-index", + "@stdlib/blas/base/xerbla", + "@stdlib/blas/base/dcopy" + ] }, { "task": "examples", @@ -145,7 +164,12 @@ "-lpthread" ], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/min-view-buffer-index", + "@stdlib/blas/base/xerbla", + "@stdlib/blas/base/dcopy" + ] }, { @@ -165,6 +189,10 @@ "libpath": [], "dependencies": [ "@stdlib/napi/export", + "@stdlib/blas/base/shared", + "@stdlib/strided/base/min-view-buffer-index", + "@stdlib/blas/base/xerbla", + "@stdlib/blas/base/dcopy", "@stdlib/napi/argv", "@stdlib/napi/argv-int64", "@stdlib/napi/argv-strided-float64array", @@ -178,7 +206,8 @@ "blas": "", "wasm": false, "src": [ - "./src/idamax.c" + "./src/idamax.c", + "./src/idamax_ndarray.c" ], "include": [ "./include" @@ -186,6 +215,8 @@ "libraries": [], "libpath": [], "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset", "@stdlib/math/base/special/abs" ] }, @@ -195,7 +226,8 @@ "blas": "", "wasm": false, "src": [ - "./src/idamax.c" + "./src/idamax.c", + "./src/idamax_ndarray.c" ], "include": [ "./include" @@ -203,6 +235,8 @@ "libraries": [], "libpath": [], "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset", "@stdlib/math/base/special/abs" ] }, @@ -224,6 +258,10 @@ "libpath": [], "dependencies": [ "@stdlib/napi/export", + "@stdlib/blas/base/shared", + "@stdlib/strided/base/min-view-buffer-index", + "@stdlib/blas/base/xerbla", + "@stdlib/blas/base/dcopy", "@stdlib/napi/argv", "@stdlib/napi/argv-int64", "@stdlib/napi/argv-strided-float64array", @@ -245,7 +283,12 @@ "-lblas" ], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/min-view-buffer-index", + "@stdlib/blas/base/xerbla", + "@stdlib/blas/base/dcopy" + ] }, { "task": "examples", @@ -262,7 +305,12 @@ "-lblas" ], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/min-view-buffer-index", + "@stdlib/blas/base/xerbla", + "@stdlib/blas/base/dcopy" + ] }, { @@ -283,6 +331,10 @@ "libpath": [], "dependencies": [ "@stdlib/napi/export", + "@stdlib/blas/base/shared", + "@stdlib/strided/base/min-view-buffer-index", + "@stdlib/blas/base/xerbla", + "@stdlib/blas/base/dcopy", "@stdlib/napi/argv", "@stdlib/napi/argv-int64", "@stdlib/napi/argv-strided-float64array", @@ -305,7 +357,12 @@ "-lpthread" ], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/min-view-buffer-index", + "@stdlib/blas/base/xerbla", + "@stdlib/blas/base/dcopy" + ] }, { "task": "examples", @@ -323,7 +380,12 @@ "-lpthread" ], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/min-view-buffer-index", + "@stdlib/blas/base/xerbla", + "@stdlib/blas/base/dcopy" + ] }, { @@ -332,7 +394,8 @@ "blas": "", "wasm": false, "src": [ - "./src/idamax.c" + "./src/idamax.c", + "./src/idamax_ndarray.c" ], "include": [ "./include" @@ -341,6 +404,8 @@ "libpath": [], "dependencies": [ "@stdlib/napi/export", + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset", "@stdlib/napi/argv", "@stdlib/napi/argv-int64", "@stdlib/napi/argv-strided-float64array", @@ -354,7 +419,8 @@ "blas": "", "wasm": false, "src": [ - "./src/idamax.c" + "./src/idamax.c", + "./src/idamax_ndarray.c" ], "include": [ "./include" @@ -362,6 +428,8 @@ "libraries": [], "libpath": [], "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset", "@stdlib/math/base/special/abs" ] }, @@ -371,7 +439,8 @@ "blas": "", "wasm": false, "src": [ - "./src/idamax.c" + "./src/idamax.c", + "./src/idamax_ndarray.c" ], "include": [ "./include" @@ -379,6 +448,8 @@ "libraries": [], "libpath": [], "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset", "@stdlib/math/base/special/abs" ] }, @@ -389,7 +460,8 @@ "blas": "", "wasm": true, "src": [ - "./src/idamax.c" + "./src/idamax.c", + "./src/idamax_ndarray.c" ], "include": [ "./include" @@ -397,6 +469,8 @@ "libraries": [], "libpath": [], "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset", "@stdlib/math/base/special/abs" ] } diff --git a/lib/node_modules/@stdlib/blas/base/idamax/src/addon.c b/lib/node_modules/@stdlib/blas/base/idamax/src/addon.c index 0b71fcd7f3e..1b87cfc4dd4 100644 --- a/lib/node_modules/@stdlib/blas/base/idamax/src/addon.c +++ b/lib/node_modules/@stdlib/blas/base/idamax/src/addon.c @@ -18,6 +18,7 @@ #include "stdlib/blas/base/idamax.h" #include "stdlib/napi/export.h" +#include "stdlib/blas/base/shared.h" #include "stdlib/napi/argv.h" #include "stdlib/napi/argv_int64.h" #include "stdlib/napi/argv_strided_float64array.h" @@ -38,9 +39,29 @@ static napi_value addon( napi_env env, napi_callback_info info ) { STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY( env, X, N, strideX, argv, 1 ); // TODO: revisit once we support 64-bit integers as return values and 64 integers more generally in JavaScript - STDLIB_NAPI_CREATE_INT32( env, c_idamax( N, X, strideX ), idx ); + STDLIB_NAPI_CREATE_INT32( env, API_SUFFIX(c_idamax)( N, X, strideX ), idx ); return idx; } -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, 4 ); + STDLIB_NAPI_ARGV_INT64( env, N, argv, 0 ); + STDLIB_NAPI_ARGV_INT64( env, strideX, argv, 2 ); + STDLIB_NAPI_ARGV_INT64( env, offsetX, argv, 3 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY( env, X, N, strideX, argv, 1 ); + + // TODO: revisit once we support 64-bit integers as return values and 64 integers more generally in JavaScript + STDLIB_NAPI_CREATE_INT32( env, API_SUFFIX(c_idamax_ndarray)( N, X, strideX, offsetX ), idx ); + + return idx; +} + +STDLIB_NAPI_MODULE_EXPORT_FCN_WITH_METHOD( addon, "ndarray", addon_method ) diff --git a/lib/node_modules/@stdlib/blas/base/idamax/src/idamax.c b/lib/node_modules/@stdlib/blas/base/idamax/src/idamax.c index f63236119ad..a4b982dc870 100644 --- a/lib/node_modules/@stdlib/blas/base/idamax/src/idamax.c +++ b/lib/node_modules/@stdlib/blas/base/idamax/src/idamax.c @@ -17,52 +17,18 @@ */ #include "stdlib/blas/base/idamax.h" -#include "stdlib/math/base/special/abs.h" +#include "stdlib/blas/base/shared.h" +#include "stdlib/strided/base/stride2offset.h" /** * Finds the index of the first element having the maximum absolute value. * * @param N number of indexed elements * @param X input array -* @param strideX stride length +* @param strideX X stride length * @return index value */ -int c_idamax( const int N, const double *X, const int strideX ) { - double dmax; - double v; - int idx; - int ix; - int i; - - if ( N < 1 || strideX <= 0 ) { - return -1; - } - idx = 0; - if ( N == 1 ) { - return idx; - } - if ( strideX == 1 ) { - // Code for stride equal to `1`... - dmax = stdlib_base_abs( X[ 0 ] ); - for ( i = 1; i < N; i++ ) { - v = stdlib_base_abs( X[ i ] ); - if ( v > dmax ) { - idx = i; - dmax = v; - } - } - return idx; - } - // Code for stride not equal to `1`... - dmax = stdlib_base_abs( X[ 0 ] ); - ix = strideX; - for ( i = 1; i < N; i++ ) { - v = stdlib_base_abs( X[ ix ] ); - if ( v > dmax ) { - idx = i; - dmax = v; - } - ix += strideX; - } - return idx; +CBLAS_INT API_SUFFIX(c_idamax)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX ) { + CBLAS_INT ox = stdlib_strided_stride2offset( N, strideX ); + return API_SUFFIX(c_idamax_ndarray)( N, X, strideX, ox ); } diff --git a/lib/node_modules/@stdlib/blas/base/idamax/src/idamax_cblas.c b/lib/node_modules/@stdlib/blas/base/idamax/src/idamax_cblas.c index 4accfdbbb18..b47e81b4ad3 100644 --- a/lib/node_modules/@stdlib/blas/base/idamax/src/idamax_cblas.c +++ b/lib/node_modules/@stdlib/blas/base/idamax/src/idamax_cblas.c @@ -18,15 +18,74 @@ #include "stdlib/blas/base/idamax.h" #include "stdlib/blas/base/idamax_cblas.h" +#include "stdlib/blas/base/shared.h" +#include "stdlib/blas/base/dcopy.h" +#include "stdlib/blas/base/xerbla.h" +#include "stdlib/strided/base/min_view_buffer_index.h" +#include /** * Finds the index of the first element having the maximum absolute value. * * @param N number of indexed elements * @param X input array -* @param strideX stride length +* @param strideX X stride length * @return index value */ -int c_idamax( const int N, const double *X, const int strideX ) { - return cblas_idamax( N, X, strideX ); +CBLAS_INT API_SUFFIX(c_idamax)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX ) { + CBLAS_INT idx; + double *copyX; + + if ( strideX < 0 ) { + // Allocate memory for a temporary workspace: + copyX = (double *)malloc( N * sizeof(double) ); + if ( copyX == NULL ) { + API_SUFFIX(c_xerbla)( 1, "idamax", "Memory allocation failed when copying the input array to a temporary workspace.\n" ); + } + // Copy the input array to a temporary workspace: + API_SUFFIX(c_dcopy)( N, X, strideX, copyX, 1 ); + + // Perform operation: + idx = API_SUFFIX(cblas_idamax)( N, copyX, 1 ); + + // Free allocated memory: + free( copyX ); + + return idx; + } + return API_SUFFIX(cblas_idamax)( N, X, strideX ); +} + +/** +* Finds the index of the first element having the maximum absolute value using alternative indexing semantics. +* +* @param N number of indexed elements +* @param X input array +* @param strideX X stride length +* @param offsetX starting index for X +* @return index value +*/ +CBLAS_INT API_SUFFIX(c_idamax_ndarray)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ) { + CBLAS_INT idx; + double *copyX; + + if ( strideX < 0 ) { + // Allocate memory for a temporary workspace: + copyX = (double *)malloc( N * sizeof(double) ); + if ( copyX == NULL ) { + API_SUFFIX(c_xerbla)( 1, "idamax", "Memory allocation failed when copying the input array to a temporary workspace.\n" ); + } + // Copy values to a temporary workspace: + API_SUFFIX(c_dcopy_ndarray)( N, X, strideX, offsetX, copyX, 1, 0 ); + + // Perform operation: + idx = API_SUFFIX(cblas_idamax)( N, copyX, 1 ); + + // Free allocated memory: + free( copyX ); + + return idx; + } + X += stdlib_strided_min_view_buffer_index( N, strideX, offsetX ); // adjust array pointer + return API_SUFFIX(cblas_idamax)( N, X, strideX ); } diff --git a/lib/node_modules/@stdlib/blas/base/idamax/src/idamax_f.c b/lib/node_modules/@stdlib/blas/base/idamax/src/idamax_f.c index e86dc0cb504..9dee995e523 100644 --- a/lib/node_modules/@stdlib/blas/base/idamax/src/idamax_f.c +++ b/lib/node_modules/@stdlib/blas/base/idamax/src/idamax_f.c @@ -18,17 +18,80 @@ #include "stdlib/blas/base/idamax.h" #include "stdlib/blas/base/idamax_fortran.h" +#include "stdlib/blas/base/shared.h" +#include "stdlib/blas/base/xerbla.h" +#include "stdlib/blas/base/dcopy.h" +#include "stdlib/strided/base/min_view_buffer_index.h" +#include /** * Finds the index of the first element having the maximum absolute value. * * @param N number of indexed elements * @param X input array -* @param strideX stride length +* @param strideX X stride length * @return index value */ -int c_idamax( const int N, const double *X, const int strideX ) { - int idx; +CBLAS_INT API_SUFFIX(c_idamax)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX ) { + CBLAS_INT idx; + CBLAS_INT sx; + double *copyX; + + if ( strideX < 0 ) { + // Allocate memory for a temporary workspace: + copyX = (double *)malloc( N * sizeof(double) ); + if ( copyX == NULL ) { + API_SUFFIX(c_xerbla)( 1, "idamax", "Memory allocation failed when copying the input array to a temporary workspace.\n" ); + } + // Copy the input array to a temporary workspace: + API_SUFFIX(c_dcopy)( N, X, strideX, copyX, 1 ); + + // Perform operation: + sx = 1; + idamaxsub( &N, copyX, &sx, &idx ); + + // Free allocated memory: + free( copyX ); + + return idx - 1; + } + idamaxsub( &N, X, &strideX, &idx ); + return idx - 1; +} + +/** +* Finds the index of the first element having the maximum absolute value using alternative indexing semantics. +* +* @param N number of indexed elements +* @param X input array +* @param strideX X stride length +* @param offsetX starting index for X +* @return index value +*/ +CBLAS_INT API_SUFFIX(c_idamax_ndarray)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ) { + CBLAS_INT idx; + CBLAS_INT sx; + double *copyX; + + if ( strideX < 0 ) { + // Allocate memory for a temporary workspace: + copyX = (double *)malloc( N * sizeof(double) ); + if ( copyX == NULL ) { + API_SUFFIX(c_xerbla)( 1, "idamax", "Memory allocation failed when copying the input array to a temporary workspace.\n" ); + } + // Copy the input array to a temporary workspace: + API_SUFFIX(c_dcopy_ndarray)( N, X, strideX, offsetX, copyX, 1, 0 ); + + // Perform operation: + sx = 1; + idamaxsub( &N, copyX, &sx, &idx ); + + // Free allocated memory: + free( copyX ); + + return idx - 1; + } + X += stdlib_strided_min_view_buffer_index( N, strideX, offsetX ); // adjust array pointer idamaxsub( &N, X, &strideX, &idx ); return idx - 1; } diff --git a/lib/node_modules/@stdlib/blas/base/idamax/src/idamax_ndarray.c b/lib/node_modules/@stdlib/blas/base/idamax/src/idamax_ndarray.c new file mode 100644 index 00000000000..41dd16b4a38 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/idamax/src/idamax_ndarray.c @@ -0,0 +1,57 @@ +/** +* @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/idamax.h" +#include "stdlib/blas/base/shared.h" +#include "stdlib/math/base/special/abs.h" + +/** +* Finds the index of the first element having the maximum absolute value using alternative indexing semantics. +* +* @param N number of indexed elements +* @param X input array +* @param strideX X stride length +* @param offsetX starting index for X +* @return index value +*/ +CBLAS_INT API_SUFFIX(c_idamax_ndarray)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ) { + CBLAS_INT idx; + CBLAS_INT ix; + CBLAS_INT i; + double smax; + double v; + + if ( N < 1 ) { + return -1; + } + idx = 0; + if ( N == 1 ) { + return idx; + } + smax = stdlib_base_abs( X[ offsetX ] ); + ix = offsetX + strideX; + for ( i = 1; i < N; i++ ) { + v = stdlib_base_abs( X[ ix ] ); + if ( v > smax ) { + idx = i; + smax = v; + } + ix += strideX; + } + return idx; +} diff --git a/lib/node_modules/@stdlib/blas/base/idamax/test/test.idamax.js b/lib/node_modules/@stdlib/blas/base/idamax/test/test.idamax.js index 7cb184e1c9a..85222626c6d 100644 --- a/lib/node_modules/@stdlib/blas/base/idamax/test/test.idamax.js +++ b/lib/node_modules/@stdlib/blas/base/idamax/test/test.idamax.js @@ -108,23 +108,6 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns `0`', fun t.end(); }); -tape( 'if provided a `strideX` parameter less than or equal to `0`, the function returns `-1`', function test( t ) { - var expected; - var idx; - var x; - - x = new Float64Array( [ 3.0, -4.0, 1.0, 15.0, 4.0, 3.0 ] ); - expected = -1; - - idx = idamax( x.length, x, 0 ); - t.strictEqual( idx, expected, 'returns expected value' ); - - idx = idamax( x.length, x, -1 ); - t.strictEqual( idx, expected, 'returns expected value' ); - - t.end(); -}); - tape( 'the function supports specifying a stride', function test( t ) { var expected; var idx; @@ -147,6 +130,22 @@ tape( 'the function supports specifying a stride', function test( t ) { t.end(); }); +tape( 'the function supports specifying a negative stride', function test( t ) { + var idx; + var x; + + x = new Float64Array( [ 3.0, -4.0, 1.0, 15.0, 4.0, 3.0 ] ); + + idx = idamax( x.length, x, -1 ); + t.strictEqual( idx, 2, 'returns expected value' ); + + x = new Float64Array( [ 3.0, 999.9, 999.9, -4.0, 999.9, 999.9, 1.0, 999.9, 999.9, 15.0, 999.9, 999.9, 4.0, 999.9, 999.9, 3.0 ] ); + idx = idamax( 6, x, -3 ); + t.strictEqual( idx, 2, 'returns expected value' ); + + t.end(); +}); + tape( 'the function supports view offsets', function test( t ) { var expected; var idx; diff --git a/lib/node_modules/@stdlib/blas/base/idamax/test/test.idamax.native.js b/lib/node_modules/@stdlib/blas/base/idamax/test/test.idamax.native.js index 4da6703e813..1b2491bde64 100644 --- a/lib/node_modules/@stdlib/blas/base/idamax/test/test.idamax.native.js +++ b/lib/node_modules/@stdlib/blas/base/idamax/test/test.idamax.native.js @@ -117,23 +117,6 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns `0`', opt t.end(); }); -tape( 'if provided a `strideX` parameter less than or equal to `0`, the function returns `-1`', opts, function test( t ) { - var expected; - var idx; - var x; - - x = new Float64Array( [ 3.0, -4.0, 1.0, 15.0, 4.0, 3.0 ] ); - expected = -1; - - idx = idamax( x.length, x, 0 ); - t.strictEqual( idx, expected, 'returns expected value' ); - - idx = idamax( x.length, x, -1 ); - t.strictEqual( idx, expected, 'returns expected value' ); - - t.end(); -}); - tape( 'the function supports specifying a stride', opts, function test( t ) { var expected; var idx; @@ -156,6 +139,22 @@ tape( 'the function supports specifying a stride', opts, function test( t ) { t.end(); }); +tape( 'the function supports specifying a negative stride', opts, function test( t ) { + var idx; + var x; + + x = new Float64Array( [ 3.0, -4.0, 1.0, 15.0, 4.0, 3.0 ] ); + + idx = idamax( x.length, x, -1 ); + t.strictEqual( idx, 2, 'returns expected value' ); + + x = new Float64Array( [ 3.0, 999.9, 999.9, -4.0, 999.9, 999.9, 1.0, 999.9, 999.9, 15.0, 999.9, 999.9, 4.0, 999.9, 999.9, 3.0 ] ); + idx = idamax( 6, x, -3 ); + t.strictEqual( idx, 2, 'returns expected value' ); + + t.end(); +}); + tape( 'the function supports view offsets', opts, function test( t ) { var expected; var idx; From cb35c53d80a07a58fbca00d60becefd17c45f171 Mon Sep 17 00:00:00 2001 From: Athan Date: Wed, 2 Oct 2024 13:43:21 -0700 Subject: [PATCH 2/2] Apply suggestions from code review Signed-off-by: Athan --- lib/node_modules/@stdlib/blas/base/idamax/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/base/idamax/README.md b/lib/node_modules/@stdlib/blas/base/idamax/README.md index 71a4dacd637..0600c90b7bd 100644 --- a/lib/node_modules/@stdlib/blas/base/idamax/README.md +++ b/lib/node_modules/@stdlib/blas/base/idamax/README.md @@ -183,7 +183,7 @@ int idx = c_idamax( 5, x, 1 ); The function accepts the following arguments: - **N**: `[in] CBLAS_INT` number of indexed elements. -- **X**: `[in] double*` first input array. +- **X**: `[in] double*` input array. - **strideX**: `[in] CBLAS_INT` index increment for `X`. ```c @@ -204,7 +204,7 @@ int idx = c_idamax_ndarray( 5, x, 1, 0 ); The function accepts the following arguments: - **N**: `[in] CBLAS_INT` number of indexed elements. -- **X**: `[in] double*` first input array. +- **X**: `[in] double*` input array. - **strideX**: `[in] CBLAS_INT` index increment for `X`. - **offsetX**: `[in] CBLAS_INT` starting index for `X`.