From f14cafa279a799e9e176bcb80b67765aeaeacd58 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 27 Apr 2024 20:33:36 +0000 Subject: [PATCH] Auto-generated commit --- README.md | 100 ++++++++++++++++++++++++++ include/stdlib/blas/base/ddot.h | 4 +- include/stdlib/blas/base/ddot_cblas.h | 4 +- manifest.json | 58 +++++++++++---- package.json | 1 + src/ddot.c | 11 +-- src/ddot_cblas.c | 3 +- src/ddot_f.c | 3 +- 8 files changed, 162 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 71ded00..c70c190 100644 --- a/README.md +++ b/README.md @@ -210,6 +210,106 @@ console.log( out ); + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/blas/base/ddot.h" +``` + +#### c_ddot( N, X, strideX, Y, strideY ) + +Computes the sum of absolute values. + +```c +const double x[] = { 4.0, 2.0, -3.0, 5.0, -1.0 }; +const double y[] = { 2.0, 6.0, -1.0, -4.0, 8.0 }; + +double v = c_ddot( 5, x, 1, y, 1 ); +// returns -5.0 +``` + +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`. +- **Y**: `[in] double*` second input array. +- **strideY**: `[in] CBLAS_INT` index increment for `Y`. + +```c +double c_ddot( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const double *Y, const CBLAS_INT strideY ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/blas/base/ddot.h" +#include + +int main( void ) { + // Create strided arrays: + const double x[] = { 1.0, -2.0, 3.0, -4.0, 5.0, -6.0, 7.0, -8.0 }; + const double y[] = { 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 strides: + const int strideX = 1; + const int strideY = -1; + + // Compute the dot product: + double d = c_ddot( N, x, strideX, y, strideY ); + + // Print the result: + printf( "dot product: %lf\n", d ); +} +``` + +
+ + + +
+ + +
diff --git a/include/stdlib/blas/base/ddot.h b/include/stdlib/blas/base/ddot.h index 66f7db2..3026b74 100644 --- a/include/stdlib/blas/base/ddot.h +++ b/include/stdlib/blas/base/ddot.h @@ -22,6 +22,8 @@ #ifndef DDOT_H #define DDOT_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 dot product of two double-precision floating-point vectors. */ -double c_ddot( const int N, const double *X, const int strideX, const double *Y, const int strideY ); +double c_ddot( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const double *Y, const CBLAS_INT strideY ); #ifdef __cplusplus } diff --git a/include/stdlib/blas/base/ddot_cblas.h b/include/stdlib/blas/base/ddot_cblas.h index d3c3525..479c5e5 100644 --- a/include/stdlib/blas/base/ddot_cblas.h +++ b/include/stdlib/blas/base/ddot_cblas.h @@ -22,6 +22,8 @@ #ifndef DDOT_CBLAS_H #define DDOT_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 dot product of two double-precision floating-point vectors. */ -double cblas_ddot( const int N, const double *X, const int strideX, const double *Y, const int strideY ); +double cblas_ddot( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const double *Y, const CBLAS_INT strideY ); #ifdef __cplusplus } diff --git a/manifest.json b/manifest.json index fe8f4a1..bcd1976 100644 --- a/manifest.json +++ b/manifest.json @@ -44,6 +44,7 @@ "libraries": [], "libpath": [], "dependencies": [ + "@stdlib/blas-base-shared", "@stdlib/napi-export", "@stdlib/napi-argv", "@stdlib/napi-argv-int64", @@ -64,7 +65,9 @@ ], "libraries": [], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas-base-shared" + ] }, { "task": "examples", @@ -79,7 +82,9 @@ ], "libraries": [], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas-base-shared" + ] }, { @@ -99,6 +104,7 @@ ], "libpath": [], "dependencies": [ + "@stdlib/blas-base-shared", "@stdlib/napi-export", "@stdlib/napi-argv", "@stdlib/napi-argv-int64", @@ -122,7 +128,9 @@ "-lpthread" ], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas-base-shared" + ] }, { "task": "examples", @@ -140,7 +148,9 @@ "-lpthread" ], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas-base-shared" + ] }, { @@ -159,6 +169,7 @@ "libraries": [], "libpath": [], "dependencies": [ + "@stdlib/blas-base-shared", "@stdlib/napi-export", "@stdlib/napi-argv", "@stdlib/napi-argv-int64", @@ -179,7 +190,9 @@ ], "libraries": [], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas-base-shared" + ] }, { "task": "examples", @@ -194,7 +207,9 @@ ], "libraries": [], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas-base-shared" + ] }, { @@ -213,6 +228,7 @@ ], "libpath": [], "dependencies": [ + "@stdlib/blas-base-shared", "@stdlib/napi-export", "@stdlib/napi-argv", "@stdlib/napi-argv-int64", @@ -235,7 +251,9 @@ "-lblas" ], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas-base-shared" + ] }, { "task": "examples", @@ -252,7 +270,9 @@ "-lblas" ], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas-base-shared" + ] }, { @@ -272,6 +292,7 @@ ], "libpath": [], "dependencies": [ + "@stdlib/blas-base-shared", "@stdlib/napi-export", "@stdlib/napi-argv", "@stdlib/napi-argv-int64", @@ -295,7 +316,9 @@ "-lpthread" ], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas-base-shared" + ] }, { "task": "examples", @@ -313,7 +336,9 @@ "-lpthread" ], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas-base-shared" + ] }, { @@ -330,6 +355,7 @@ "libraries": [], "libpath": [], "dependencies": [ + "@stdlib/blas-base-shared", "@stdlib/napi-export", "@stdlib/napi-argv", "@stdlib/napi-argv-int64", @@ -350,7 +376,9 @@ ], "libraries": [], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas-base-shared" + ] }, { "task": "examples", @@ -365,7 +393,9 @@ ], "libraries": [], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas-base-shared" + ] }, { @@ -381,7 +411,9 @@ ], "libraries": [], "libpath": [], - "dependencies": [] + "dependencies": [ + "@stdlib/blas-base-shared" + ] } ] } diff --git a/package.json b/package.json index ce44425..654e32d 100644 --- a/package.json +++ b/package.json @@ -42,6 +42,7 @@ }, "dependencies": { "@stdlib/assert-is-error": "^0.2.1", + "@stdlib/blas-base-shared": "github:stdlib-js/blas-base-shared#main", "@stdlib/napi-argv": "^0.2.1", "@stdlib/napi-argv-int64": "^0.2.1", "@stdlib/napi-argv-strided-float64array": "^0.2.1", diff --git a/src/ddot.c b/src/ddot.c index ce2e3f4..6fe9838 100644 --- a/src/ddot.c +++ b/src/ddot.c @@ -22,6 +22,7 @@ * @see ddot */ #include "stdlib/blas/base/ddot.h" +#include "stdlib/blas/base/shared.h" /** * Computes the dot product of two double-precision floating-point vectors. @@ -33,12 +34,12 @@ * @param strideY Y stride length * @return the dot product */ -double c_ddot( const int N, const double *X, const int strideX, const double *Y, const int strideY ) { +double c_ddot( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const double *Y, const CBLAS_INT strideY ) { double dot; - int ix; - int iy; - int m; - int i; + CBLAS_INT ix; + CBLAS_INT iy; + CBLAS_INT m; + CBLAS_INT i; dot = 0.0; if ( N <= 0 ) { diff --git a/src/ddot_cblas.c b/src/ddot_cblas.c index f4102a9..899c4d5 100644 --- a/src/ddot_cblas.c +++ b/src/ddot_cblas.c @@ -18,6 +18,7 @@ #include "stdlib/blas/base/ddot.h" #include "stdlib/blas/base/ddot_cblas.h" +#include "stdlib/blas/base/shared.h" /** * Computes the dot product of two double-precision floating-point vectors. @@ -29,6 +30,6 @@ * @param strideY Y stride length * @return the dot product */ -double c_ddot( const int N, const double *X, const int strideX, const double *Y, const int strideY ) { +double c_ddot( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const double *Y, const CBLAS_INT strideY ) { return cblas_ddot( N, X, strideX, Y, strideY ); } diff --git a/src/ddot_f.c b/src/ddot_f.c index a9fbcd2..9895614 100644 --- a/src/ddot_f.c +++ b/src/ddot_f.c @@ -23,6 +23,7 @@ */ #include "stdlib/blas/base/ddot.h" #include "stdlib/blas/base/ddot_fortran.h" +#include "stdlib/blas/base/shared.h" /** * Computes the dot product of two double-precision floating-point vectors. @@ -34,7 +35,7 @@ * @param strideY Y stride length * @return the dot product */ -double c_ddot( const int N, const double *X, const int strideX, const double *Y, const int strideY ) { +double c_ddot( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const double *Y, const CBLAS_INT strideY ) { double dot; ddotsub( &N, X, &strideX, Y, &strideY, &dot ); return dot;