Skip to content

Commit

Permalink
chore: apply review changes
Browse files Browse the repository at this point in the history
  • Loading branch information
aman-095 committed Sep 18, 2024
1 parent a9f5a9c commit 40af6b3
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions lib/node_modules/@stdlib/blas/base/sdot/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -205,14 +205,14 @@ console.log( out );

#### c_sdot( N, \*X, strideX, \*Y, strideY )

Computes the dot product of two double-precision floating-point vectors.
Computes the dot product of two single-precision floating-point vectors.

```c
const float x[] = { 4.0f, 2.0f, -3.0f, 5.0f, -1.0f };
const float y[] = { 2.0f, 6.0f, -1.0f, -4.0f, 8.0f };

float v = c_sdot( 5, x, 1, y, 1 );
// returns -5.0
float d = c_sdot( 5, x, 1, y, 1 );
// returns -5.0f
```
The function accepts the following arguments:
Expand All @@ -224,18 +224,19 @@ The function accepts the following arguments:
- **strideY**: `[in] CBLAS_INT` index increment for `Y`.
```c
float c_ddot( const CBLAS_INT N, const float *X, const CBLAS_INT strideX, const float *Y, const CBLAS_INT strideY );
float c_sdot( const CBLAS_INT N, const float *X, const CBLAS_INT strideX, const float *Y, const CBLAS_INT strideY );
```

#### c_sdot_ndarray( N, \*X, strideX, offsetX, \*Y, strideY, offsetY )

Computes the dot product of two double-precision floating-point vectors using alternative indexing semantics.
Computes the dot product of two single-precision floating-point vectors using alternative indexing semantics.

```c
const float x[] = { 4.0f, 2.0f, -3.0f, 5.0f, -1.0f };
const float y[] = { 2.0f, 6.0f, -1.0f, -4.0f, 8.0f };

c_sdot_ndarray( 3, x, 1, 2, y, 1, 2 );
float d = c_sdot_ndarray( 3, x, 1, 2, y, 1, 2 );
// returns -25.0f
```
The function accepts the following arguments:
Expand Down Expand Up @@ -316,7 +317,7 @@ int main( void ) {
## See Also
- <span class="package-name">[`@stdlib/blas/base/ddot`][@stdlib/blas/base/ddot]</span><span class="delimiter">: </span><span class="description">calculate the dot product of two double-precision floating-point vectors.</span>
- <span class="package-name">[`@stdlib/blas/base/ddot`][@stdlib/blas/base/ddot]</span><span class="delimiter">: </span><span class="description">calculate the dot product of two single-precision floating-point vectors.</span>
- <span class="package-name">[`@stdlib/blas/base/dsdot`][@stdlib/blas/base/dsdot]</span><span class="delimiter">: </span><span class="description">calculate the dot product with extended accumulation and result of two single-precision floating-point vectors.</span>
- <span class="package-name">[`@stdlib/blas/base/sdsdot`][@stdlib/blas/base/sdsdot]</span><span class="delimiter">: </span><span class="description">calculate the dot product of two single-precision floating-point vectors with extended accumulation.</span>
- <span class="package-name">[`@stdlib/blas/sdot`][@stdlib/blas/sdot]</span><span class="delimiter">: </span><span class="description">calculate the dot product of two single-precision floating-point vectors.</span>
Expand Down

0 comments on commit 40af6b3

Please sign in to comment.