From 8f3624cacff63c52db0af6e43b8dcf0ed4d5fd69 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 27 Apr 2024 20:41:30 +0000 Subject: [PATCH] Auto-generated commit --- base/ddot/README.md | 2 +- base/dnrm2/README.md | 95 +++++++++++++++++++ base/dnrm2/include/stdlib/blas/base/dnrm2.h | 4 +- .../include/stdlib/blas/base/dnrm2_cblas.h | 4 +- base/dnrm2/manifest.json | 76 ++++++++++++--- base/dnrm2/src/dnrm2.c | 13 ++- base/dnrm2/src/dnrm2_cblas.c | 3 +- base/dnrm2/src/dnrm2_f.c | 3 +- 8 files changed, 176 insertions(+), 24 deletions(-) diff --git a/base/ddot/README.md b/base/ddot/README.md index 38e6d267b..cd0c3c490 100644 --- a/base/ddot/README.md +++ b/base/ddot/README.md @@ -205,7 +205,7 @@ console.log( out ); #### c_ddot( N, X, strideX, Y, strideY ) -Computes the sum of absolute values. +Computes the dot product of two double-precision floating-point vectors. ```c const double x[] = { 4.0, 2.0, -3.0, 5.0, -1.0 }; diff --git a/base/dnrm2/README.md b/base/dnrm2/README.md index f2ef7a448..0080d2020 100644 --- a/base/dnrm2/README.md +++ b/base/dnrm2/README.md @@ -160,6 +160,101 @@ console.log( out ); + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/blas/base/dnrm2.h" +``` + +#### c_dnrm2( N, X, stride ) + +Computes the L2-norm of a double-precision floating-point vector. + +```c +const double x[] = { 1.0, -2.0, 2.0 }; + +double v = c_dnrm2( 3, x, 1 ); +// returns 3.0 +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **X**: `[in] double*` input array. +- **stride**: `[in] CBLAS_INT` index increment for `X`. + +```c +double c_dnrm2( const CBLAS_INT N, const double *X, const CBLAS_INT stride ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/blas/base/dnrm2.h" +#include + +int main( void ) { + // Create a 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 elements: + const int N = 8; + + // Specify a stride: + const int strideX = 1; + + // Compute the L2-norm: + double l2 = c_dnrm2( N, x, strideX ); + + // Print the result: + printf( "L2-norm: %lf\n", l2 ); +} +``` + +
+ + + +
+ + +
diff --git a/base/dnrm2/include/stdlib/blas/base/dnrm2.h b/base/dnrm2/include/stdlib/blas/base/dnrm2.h index 224dc2316..6fccb31a6 100644 --- a/base/dnrm2/include/stdlib/blas/base/dnrm2.h +++ b/base/dnrm2/include/stdlib/blas/base/dnrm2.h @@ -22,6 +22,8 @@ #ifndef DNRM2_H #define DNRM2_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" { /** * Computes the L2-norm of a double-precision floating-point vector. */ -double c_dnrm2( const int N, const double *X, const int stride ); +double c_dnrm2( const CBLAS_INT N, const double *X, const CBLAS_INT stride ); #ifdef __cplusplus } diff --git a/base/dnrm2/include/stdlib/blas/base/dnrm2_cblas.h b/base/dnrm2/include/stdlib/blas/base/dnrm2_cblas.h index c2a9ddcc3..263cbfe8d 100644 --- a/base/dnrm2/include/stdlib/blas/base/dnrm2_cblas.h +++ b/base/dnrm2/include/stdlib/blas/base/dnrm2_cblas.h @@ -22,6 +22,8 @@ #ifndef DNRM2_CBLAS_H #define DNRM2_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" { /** * Computes the L2-norm of a double-precision floating-point vector. */ -double cblas_dnrm2( const int N, const double *X, const int stride ); +double cblas_dnrm2( const CBLAS_INT N, const double *X, const CBLAS_INT stride ); #ifdef __cplusplus } diff --git a/base/dnrm2/manifest.json b/base/dnrm2/manifest.json index a4416f360..b9cd52fd6 100644 --- a/base/dnrm2/manifest.json +++ b/base/dnrm2/manifest.json @@ -44,6 +44,7 @@ "libraries": [], "libpath": [], "dependencies": [ + "@stdlib/blas/base/shared", "@stdlib/napi/export", "@stdlib/napi/argv", "@stdlib/napi/argv-int64", @@ -66,7 +67,11 @@ "-lm" ], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/math/base/special/abs", + "@stdlib/math/base/special/sqrt" + ] }, { "task": "examples", @@ -83,7 +88,11 @@ "-lm" ], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/math/base/special/abs", + "@stdlib/math/base/special/sqrt" + ] }, { @@ -103,6 +112,7 @@ ], "libpath": [], "dependencies": [ + "@stdlib/blas/base/shared", "@stdlib/napi/export", "@stdlib/napi/argv", "@stdlib/napi/argv-int64", @@ -126,7 +136,9 @@ "-lpthread" ], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas/base/shared" + ] }, { "task": "examples", @@ -144,7 +156,9 @@ "-lpthread" ], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas/base/shared" + ] }, { @@ -163,6 +177,7 @@ "libraries": [], "libpath": [], "dependencies": [ + "@stdlib/blas/base/shared", "@stdlib/napi/export", "@stdlib/napi/argv", "@stdlib/napi/argv-int64", @@ -185,7 +200,11 @@ "-lm" ], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/math/base/special/abs", + "@stdlib/math/base/special/sqrt" + ] }, { "task": "examples", @@ -202,7 +221,11 @@ "-lm" ], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/math/base/special/abs", + "@stdlib/math/base/special/sqrt" + ] }, { @@ -221,6 +244,7 @@ ], "libpath": [], "dependencies": [ + "@stdlib/blas/base/shared", "@stdlib/napi/export", "@stdlib/napi/argv", "@stdlib/napi/argv-int64", @@ -243,7 +267,9 @@ "-lblas" ], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas/base/shared" + ] }, { "task": "examples", @@ -260,7 +286,9 @@ "-lblas" ], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas/base/shared" + ] }, { @@ -280,6 +308,7 @@ ], "libpath": [], "dependencies": [ + "@stdlib/blas/base/shared", "@stdlib/napi/export", "@stdlib/napi/argv", "@stdlib/napi/argv-int64", @@ -303,7 +332,9 @@ "-lpthread" ], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas/base/shared" + ] }, { "task": "examples", @@ -321,7 +352,9 @@ "-lpthread" ], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas/base/shared" + ] }, { @@ -340,11 +373,14 @@ ], "libpath": [], "dependencies": [ + "@stdlib/blas/base/shared", "@stdlib/napi/export", "@stdlib/napi/argv", "@stdlib/napi/argv-int64", "@stdlib/napi/argv-strided-float64array", - "@stdlib/napi/create-double" + "@stdlib/napi/create-double", + "@stdlib/math/base/special/abs", + "@stdlib/math/base/special/sqrt" ] }, { @@ -362,7 +398,11 @@ "-lm" ], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/math/base/special/abs", + "@stdlib/math/base/special/sqrt" + ] }, { "task": "examples", @@ -379,7 +419,11 @@ "-lm" ], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/math/base/special/abs", + "@stdlib/math/base/special/sqrt" + ] }, { @@ -397,7 +441,11 @@ "-lm" ], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/math/base/special/abs", + "@stdlib/math/base/special/sqrt" + ] } ] } diff --git a/base/dnrm2/src/dnrm2.c b/base/dnrm2/src/dnrm2.c index 14b32c58e..dce5ad119 100644 --- a/base/dnrm2/src/dnrm2.c +++ b/base/dnrm2/src/dnrm2.c @@ -17,6 +17,9 @@ */ #include "stdlib/blas/base/dnrm2.h" +#include "stdlib/blas/base/shared.h" +#include "stdlib/math/base/special/abs.h" +#include "stdlib/math/base/special/sqrt.h" #include /** @@ -27,23 +30,23 @@ * @param stride stride length * @return L2-norm */ -double c_dnrm2( const int N, const double *X, const int stride ) { +double c_dnrm2( const CBLAS_INT N, const double *X, const CBLAS_INT stride ) { double scale; double ssq; double ax; - int i; + CBLAS_INT i; if ( N <= 0 || stride <= 0 ) { return 0.0; } if ( N == 1 ) { - return fabs( X[ 0 ] ); + return stdlib_base_abs( X[ 0 ] ); } scale = 0.0; ssq = 1.0; for ( i = 0; i < N*stride; i += stride ) { if ( X[ i ] != 0.0 ) { - ax = fabs( X[ i ] ); + ax = stdlib_base_abs( X[ i ] ); if ( scale < ax ) { ssq = 1.0 + ( ssq * pow( scale/ax, 2 ) ); scale = ax; @@ -52,5 +55,5 @@ double c_dnrm2( const int N, const double *X, const int stride ) { } } } - return scale * sqrt( ssq ); + return scale * stdlib_base_sqrt( ssq ); } diff --git a/base/dnrm2/src/dnrm2_cblas.c b/base/dnrm2/src/dnrm2_cblas.c index 15fa317a1..077651881 100644 --- a/base/dnrm2/src/dnrm2_cblas.c +++ b/base/dnrm2/src/dnrm2_cblas.c @@ -18,6 +18,7 @@ #include "stdlib/blas/base/dnrm2.h" #include "stdlib/blas/base/dnrm2_cblas.h" +#include "stdlib/blas/base/shared.h" /** * Computes the L2-norm of a double-precision floating-point vector. @@ -27,6 +28,6 @@ * @param stride stride length * @return L2-norm */ -double c_dnrm2( const int N, const double *X, const int stride ) { +double c_dnrm2( const CBLAS_INT N, const double *X, const CBLAS_INT stride ) { return cblas_dnrm2( N, X, stride ); } diff --git a/base/dnrm2/src/dnrm2_f.c b/base/dnrm2/src/dnrm2_f.c index 4396d4fe0..941d8a451 100644 --- a/base/dnrm2/src/dnrm2_f.c +++ b/base/dnrm2/src/dnrm2_f.c @@ -18,6 +18,7 @@ #include "stdlib/blas/base/dnrm2.h" #include "stdlib/blas/base/dnrm2_fortran.h" +#include "stdlib/blas/base/shared.h" /** * Computes the L2-norm of a double-precision floating-point vector. @@ -27,7 +28,7 @@ * @param stride stride length * @return L2-norm */ -double c_dnrm2( const int N, const double *X, const int stride ) { +double c_dnrm2( const CBLAS_INT N, const double *X, const CBLAS_INT stride ) { double nrm2; dnrm2sub( &N, X, &stride, &nrm2 ); return nrm2;