Skip to content

Commit 4e8ace2

Browse files
authored
chore: update markdown
Signed-off-by: Shabareesh Shetty <[email protected]>
1 parent 602fae7 commit 4e8ace2

File tree

1 file changed

+12
-12
lines changed
  • lib/node_modules/@stdlib/blas/base/dtrmv

1 file changed

+12
-12
lines changed

lib/node_modules/@stdlib/blas/base/dtrmv/README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -191,15 +191,15 @@ console.log( x );
191191
#include "stdlib/blas/base/dtrmv.h"
192192
```
193193

194-
#### c_dtrmv( order, uplo, trans, diag, N, \*A, LDA, \*X, strideX )
194+
#### c_dtrmv( order, uplo, trans, diag, N, \*A, LDA, \*X, sx )
195195

196196
Performs one of the matrix-vector operations `x = A*x` or `x = A^T*x`, where `x` is an `N` element vector and `A` is an `N` by `N` unit, or non-unit, upper or lower triangular matrix.
197197

198198
```c
199199
#include "stdlib/blas/base/shared.h"
200200

201-
double A[] = { 1.0, 2.0, 3.0, 0.0, 1.0, 2.0, 0.0, 0.0, 1.0 };
202-
const double x[] = { 1.0, 2.0, 3.0 };
201+
const double A[] = { 1.0, 2.0, 3.0, 0.0, 1.0, 2.0, 0.0, 0.0, 1.0 };
202+
double x[] = { 1.0, 2.0, 3.0 };
203203

204204
c_dtrmv( CblasRowMajor, CblasUpper, CblasNoTrans, CblasUnit, 3, A, 3, x, 1 );
205205
```
@@ -211,24 +211,24 @@ The function accepts the following arguments:
211211
- **trans**: `[in] CBLAS_TRANSPOSE` specifies whether `A` should be transposed, conjugate-transposed, or not transposed.
212212
- **diag**: `[in] CBLAS_DIAG` specifies whether `A` has a unit diagonal.
213213
- **N**: `[in] CBLAS_INT` number of elements along each dimension of `A`.
214-
- **A**: `[inout] double*` input matrix.
214+
- **A**: `[in] double*` input matrix.
215215
- **LDA**: `[in] CBLAS_INT` stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`).
216-
- **X**: `[in] double*` input vector.
217-
- **strideX**: `[in] CBLAS_INT` index increment for `X`.
216+
- **X**: `[inout] double*` input vector.
217+
- **sx**: `[in] CBLAS_INT` stride length for `X`.
218218
219219
```c
220220
void c_dtrmv( const CBLAS_LAYOUT order, const CBLAS_UPLO uplo, const CBLAS_TRANSPOSE trans, const CBLAS_DIAG diag, const CBLAS_INT N, const double *A, const CBLAS_INT LDA, double *x, const CBLAS_INT strideX )
221221
```
222222

223-
#### c_dtrmv_ndarray( uplo, trans, diag, N, \*A, strideA1, strideA2, offsetA, \*X, strideX, offsetA )
223+
#### c_dtrmv_ndarray( uplo, trans, diag, N, \*A, sa1, sa2, oa, \*X, sx, ox )
224224

225225
Performs one of the matrix-vector operations `x = A*x` or `x = A^T*x` using alternative indexing semantics, where `x` is an `N` element vector and `A` is an `N` by `N` unit, or non-unit, upper or lower triangular matrix.
226226

227227
```c
228228
#include "stdlib/blas/base/shared.h"
229229

230-
double A[] = { 1.0, 2.0, 3.0, 0.0, 1.0, 2.0, 0.0, 0.0, 1.0 };
231-
const double x[] = { 1.0, 2.0, 3.0 };
230+
const double A[] = { 1.0, 2.0, 3.0, 0.0, 1.0, 2.0, 0.0, 0.0, 1.0 };
231+
double x[] = { 1.0, 2.0, 3.0 };
232232

233233
c_dtrmv_ndarray( CblasUpper, CblasNoTrans, CblasUnit, 3, A, 3, 1, 0, x, 1, 0 );
234234
```
@@ -239,12 +239,12 @@ The function accepts the following arguments:
239239
- **trans**: `[in] CBLAS_TRANSPOSE` specifies whether `A` should be transposed, conjugate-transposed, or not transposed.
240240
- **diag**: `[in] CBLAS_DIAG` specifies whether `A` has a unit diagonal.
241241
- **N**: `[in] CBLAS_INT` number of elements along each dimension of `A`.
242-
- **A**: `[inout] double*` input matrix.
242+
- **A**: `[in] double*` input matrix.
243243
- **strideA1**: `[in] CBLAS_INT` stride of the first dimension of `A`.
244244
- **strideA2**: `[in] CBLAS_INT` stride of the second dimension of `A`.
245245
- **offsetA**: `[in] CBLAS_INT` starting index for `A`.
246-
- **X**: `[in] double*` input vector.
247-
- **strideX**: `[in] CBLAS_INT` index increment for `X`.
246+
- **X**: `[inout] double*` input vector.
247+
- **sx**: `[in] CBLAS_INT` stride length for `X`.
248248
- **offsetX**: `[in] CBLAS_INT` starting index for `X`.
249249
250250
```c

0 commit comments

Comments
 (0)