Skip to content

Commit 6d77297

Browse files
committed
docs: improve documentation description
1 parent 763c18f commit 6d77297

File tree

7 files changed

+31
-31
lines changed

7 files changed

+31
-31
lines changed

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ var dtrmm = require( '@stdlib/blas/base/dtrmm' );
3333

3434
#### dtrmm( order, side, uplo, transa, diag, M, N, α, A, LDA, B, LDB )
3535

36-
Performs one of the matrix-matrix operations `B = α * op(A) * B` or `B = α * B * op(A)` where `α` is a scalar, `B` is an `M` by `N` matrix, `A` is a unit, or non-unit, upper or lower triangular matrix and `op( A )` is one of `op( A ) = A` or `op( A ) = A**T`.
36+
Performs one of the matrix-matrix operations `B = α * op(A) * B` or `B = α * B * op(A)` where `α` is a scalar, `B` is an `M` by `N` matrix, `A` is a unit, or non-unit, upper or lower triangular matrix and `op( A )` is one of `op( A ) = A` or `op( A ) = A^T`.
3737

3838
```javascript
3939
var Float64Array = require( '@stdlib/array/float64' );
@@ -49,8 +49,8 @@ The function has the following parameters:
4949

5050
- **order**: storage layout of `A` and `B`.
5151
- **side**: specifies whether `op( A )` appears on the left or right side of `B`.
52-
- **uplo**: specifies whether the upper or lower triangular part of the matrix `A` is supplied.
53-
- **transa**: specifies the form of `op( A )` to be used in the matrix multiplication.
52+
- **uplo**: specifies whether the upper or lower triangular part of the matrix `A` should be referenced.
53+
- **transa**: specifies whether `A` should be transposed, conjugate-transposed, or not transposed.
5454
- **diag**: specifies whether or not `A` is unit triangular.
5555
- **M**: number of rows in `B`.
5656
- **N**: number of columns in `B`.
@@ -81,7 +81,7 @@ dtrmm( 'row-major', 'left', 'lower', 'no-transpose', 'unit', 3, 3, 1.0, A1, 3, B
8181

8282
#### dtrmm.ndarray( s, ul, t, d, M, N, α, A, sa1, sa2, oa, B, sb1, sb2, ob )
8383

84-
Performs one of the matrix-matrix operations `B = α * op(A) * B` or `B = α * B * op(A)`, using alternative indexing semantics and where `α` is a scalar, `B` is an `M` by `N` matrix, `A` is a unit, or non-unit, upper or lower triangular matrix and `op( A )` is one of `op( A ) = A` or `op( A ) = A**T`.
84+
Performs one of the matrix-matrix operations `B = α * op(A) * B` or `B = α * B * op(A)`, using alternative indexing semantics and where `α` is a scalar, `B` is an `M` by `N` matrix, `A` is a unit, or non-unit, upper or lower triangular matrix and `op( A )` is one of `op( A ) = A` or `op( A ) = A^T`.
8585

8686
```javascript
8787
var Float64Array = require( '@stdlib/array/float64' );
@@ -96,8 +96,8 @@ dtrmm.ndarray( 'left', 'lower', 'no-transpose', 'unit', 3, 3, 1.0, A, 3, 1, 0, B
9696
The function has the following parameters:
9797

9898
- **side**: specifies whether `op( A )` appears on the left or right side of `B`.
99-
- **uplo**: specifies whether the upper or lower triangular part of the matrix `A` is supplied.
100-
- **transa**: specifies the form of `op( A )` to be used in the matrix multiplication.
99+
- **uplo**: specifies whether the upper or lower triangular part of the matrix `A` should be referenced.
100+
- **transa**: specifies whether `A` should be transposed, conjugate-transposed, or not transposed.
101101
- **diag**: specifies whether or not `A` is unit triangular.
102102
- **M**: number of rows in `B`.
103103
- **N**: number of columns in `B`.

lib/node_modules/@stdlib/blas/base/dtrmm/docs/repl.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Performs one of the matrix-matrix operations `B = α * op(A) * B` or
44
`B = α * B * op(A)` where `α` is a scalar, `B` is an `M` by `N` matrix, `A`
55
is a unit, or non-unit, upper or lower triangular matrix and `op( A )` is
6-
one of `op( A ) = A` or `op( A ) = A**T`.
6+
one of `op( A ) = A` or `op( A ) = A^T`.
77

88
Indexing is relative to the first index. To introduce an offset, use typed
99
array views.
@@ -77,7 +77,7 @@
7777
`B = α * B * op(A)`, using alternative indexing semantics and where `α` is
7878
a scalar, `B` is an `M` by `N` matrix, `A` is a unit, or non-unit, upper or
7979
lower triangular matrix and `op( A )` is one of `op( A ) = A` or
80-
`op( A ) = A**T`.
80+
`op( A ) = A^T`.
8181

8282
While typed array views mandate a view offset based on the underlying
8383
buffer, the offset parameters support indexing semantics based on starting

lib/node_modules/@stdlib/blas/base/dtrmm/docs/types/index.d.ts

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,12 @@ import { Layout, MatrixTriangle, DiagonalType, OperationSide, TransposeOperation
2727
*/
2828
interface Routine {
2929
/**
30-
* Performs one of the matrix-matrix operations `B = α * op(A) * B` or `B = α * B * op(A)` where `α` is a scalar, `B` is an `M` by `N` matrix, `A` is a unit, or non-unit, upper or lower triangular matrix and `op( A )` is one of `op( A ) = A` or `op( A ) = A**T`.
30+
* Performs one of the matrix-matrix operations `B = α * op(A) * B` or `B = α * B * op(A)` where `α` is a scalar, `B` is an `M` by `N` matrix, `A` is a unit, or non-unit, upper or lower triangular matrix and `op( A )` is one of `op( A ) = A` or `op( A ) = A^T`.
3131
*
3232
* @param order - storage layout of `A` and `B`
3333
* @param side - specifies whether `op( A )` appears on the left or right side of `B`
34-
* @param uplo - specifies whether the upper or lower triangular part of the matrix `A` is supplied
35-
* @param transa - specifies the form of `op( A )` to be used in matrix multiplication
34+
* @param uplo - specifies whether the upper or lower triangular part of the matrix `A` should be referenced
35+
* @param transa - specifies whether `A` should be transposed, conjugate-transposed, or not transposed
3636
* @param diag - specifies whether or not `A` is unit triangular
3737
* @param M - number of rows in `B`
3838
* @param N - number of columns in `B`
@@ -55,11 +55,11 @@ interface Routine {
5555
( order: Layout, side: OperationSide, uplo: MatrixTriangle, transa: TransposeOperation, diag: DiagonalType, M: number, N: number, alpha: number, A: Float64Array, LDA: number, B: Float64Array, LDB: number ): Float64Array;
5656

5757
/**
58-
* Performs one of the matrix-matrix operations `B = α * op(A) * B` or `B = α * B * op(A)` using alternative indexing semantics, where `α` is a scalar, `B` is an `M` by `N` matrix, `A` is a unit, or non-unit, upper or lower triangular matrix and `op( A )` is one of `op( A ) = A` or `op( A ) = A**T`.
58+
* Performs one of the matrix-matrix operations `B = α * op(A) * B` or `B = α * B * op(A)` using alternative indexing semantics, where `α` is a scalar, `B` is an `M` by `N` matrix, `A` is a unit, or non-unit, upper or lower triangular matrix and `op( A )` is one of `op( A ) = A` or `op( A ) = A^T`.
5959
*
6060
* @param side - specifies whether `op( A )` appears on the left or right side of `B`
61-
* @param uplo - specifies whether the upper or lower triangular part of the matrix `A` is supplied
62-
* @param transa - specifies the form of `op( A )` to be used in matrix multiplication
61+
* @param uplo - specifies whether the upper or lower triangular part of the matrix `A` should be referenced
62+
* @param transa - specifies whether `A` should be transposed, conjugate-transposed, or not transposed
6363
* @param diag - specifies whether or not `A` is unit triangular
6464
* @param M - number of rows in `B`
6565
* @param N - number of columns in `B`
@@ -87,12 +87,12 @@ interface Routine {
8787
}
8888

8989
/**
90-
* Performs one of the matrix-matrix operations `B = α * op(A) * B` or `B = α * B * op(A)` where `α` is a scalar, `B` is an `M` by `N` matrix, `A` is a unit, or non-unit, upper or lower triangular matrix and `op( A )` is one of `op( A ) = A` or `op( A ) = A**T`.
90+
* Performs one of the matrix-matrix operations `B = α * op(A) * B` or `B = α * B * op(A)` where `α` is a scalar, `B` is an `M` by `N` matrix, `A` is a unit, or non-unit, upper or lower triangular matrix and `op( A )` is one of `op( A ) = A` or `op( A ) = A^T`.
9191
*
9292
* @param order - storage layout of `A` and `B`
9393
* @param side - specifies whether `op( A )` appears on the left or right side of `B`
94-
* @param uplo - specifies whether the upper or lower triangular part of the matrix `A` is supplied
95-
* @param transa - specifies the form of `op( A )` to be used in matrix multiplication
94+
* @param uplo - specifies whether the upper or lower triangular part of the matrix `A` should be referenced
95+
* @param transa - specifies whether `A` should be transposed, conjugate-transposed, or not transposed
9696
* @param diag - specifies whether or not `A` is unit triangular
9797
* @param M - number of rows in `B`
9898
* @param N - number of columns in `B`

lib/node_modules/@stdlib/blas/base/dtrmm/lib/base.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -92,12 +92,12 @@ function zeros( M, N, X, strideX1, strideX2, offsetX ) { // TODO: consider movin
9292
// MAIN //
9393

9494
/**
95-
* Performs one of the matrix-matrix operations `B = α * op(A) * B` or `B = α * B * op(A)` where `α` is a scalar, `B` is an `M` by `N` matrix, `A` is a unit, or non-unit, upper or lower triangular matrix and `op( A )` is one of `op( A ) = A` or `op( A ) = A**T`.
95+
* Performs one of the matrix-matrix operations `B = α * op(A) * B` or `B = α * B * op(A)` where `α` is a scalar, `B` is an `M` by `N` matrix, `A` is a unit, or non-unit, upper or lower triangular matrix and `op( A )` is one of `op( A ) = A` or `op( A ) = A^T`.
9696
*
9797
* @private
9898
* @param {string} side - specifies whether `op( A )` appears on the left or right side of `B`
99-
* @param {string} uplo - specifies whether the upper or lower triangular part of the matrix `A` is supplied
100-
* @param {string} transa - specifies the form of `op( A )` to be used in matrix multiplication
99+
* @param {string} uplo - specifies whether the upper or lower triangular part of the matrix `A` should be referenced
100+
* @param {string} transa - specifies whether `A` should be transposed, conjugate-transposed, or not transposed
101101
* @param {string} diag - specifies whether or not `A` is unit triangular
102102
* @param {NonNegativeInteger} M - number of rows in `B`
103103
* @param {NonNegativeInteger} N - number of columns in `B`

lib/node_modules/@stdlib/blas/base/dtrmm/lib/dtrmm.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,12 @@ var base = require( './base.js' );
3434
// MAIN //
3535

3636
/**
37-
* Performs one of the matrix-matrix operations `B = α * op(A) * B` or `B = α * B * op(A)` where `α` is a scalar, `B` is an `M` by `N` matrix, `A` is a unit, or non-unit, upper or lower triangular matrix and `op( A )` is one of `op( A ) = A` or `op( A ) = A**T`.
37+
* Performs one of the matrix-matrix operations `B = α * op(A) * B` or `B = α * B * op(A)` where `α` is a scalar, `B` is an `M` by `N` matrix, `A` is a unit, or non-unit, upper or lower triangular matrix and `op( A )` is one of `op( A ) = A` or `op( A ) = A^T`.
3838
*
3939
* @param {string} order - storage layout of `A` and `B`
4040
* @param {string} side - specifies whether `op( A )` appears on the left or right side of `B`
41-
* @param {string} uplo - specifies whether the upper or lower triangular part of the matrix `A` is supplied
42-
* @param {string} transa - specifies the form of `op( A )` to be used in matrix multiplication
41+
* @param {string} uplo - specifies whether the upper or lower triangular part of the matrix `A` should be referenced
42+
* @param {string} transa - specifies whether `A` should be transposed, conjugate-transposed, or not transposed
4343
* @param {string} diag - specifies whether or not `A` is unit triangular
4444
* @param {NonNegativeInteger} M - number of rows in `B`
4545
* @param {NonNegativeInteger} N - number of columns in `B`
@@ -50,7 +50,7 @@ var base = require( './base.js' );
5050
* @param {NonNegativeInteger} LDB - stride of the first dimension of `B` (a.k.a., leading dimension of the matrix `B`)
5151
* @throws {TypeError} first argument must be a valid order
5252
* @throws {TypeError} second argument must be a valid side
53-
* @throws {TypeError} third argument must specify whether the lower or upper triangular matrix is supplied
53+
* @throws {TypeError} third argument must specify whether the lower or upper triangular matrix should be referenced
5454
* @throws {TypeError} fourth argument must specify correct transpose operation
5555
* @throws {TypeError} fifth argument must specify whether the matrix is unit triangular or not
5656
* @throws {RangeError} sixth argument must be a nonnegative integer
@@ -82,7 +82,7 @@ function dtrmm( order, side, uplo, transa, diag, M, N, alpha, A, LDA, B, LDB ) {
8282
throw new TypeError( format( 'invalid argument. Second argument must be a valid side. Value: `%s`.', side ) );
8383
}
8484
if ( !isMatrixTriangle( uplo ) ) {
85-
throw new TypeError( format( 'invalid argument. Third argument must specify whether the lower or upper triangular matrix is supplied. Value: `%s`.', uplo ) );
85+
throw new TypeError( format( 'invalid argument. Third argument must specify whether the lower or upper triangular matrix should be referenced. Value: `%s`.', uplo ) );
8686
}
8787
if ( !isTransposeOperation( transa ) ) {
8888
throw new TypeError( format( 'invalid argument. Fourth argument must specify correct transpose operation. Value: `%s`.', transa ) );

lib/node_modules/@stdlib/blas/base/dtrmm/lib/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
'use strict';
2020

2121
/**
22-
* BLAS level 3 routine to perform one of the matrix-matrix operations `B = α * op(A) * B` or `B = α * B * op(A)` where `α` is a scalar, `B` is an `M` by `N` matrix, `A` is a unit, or non-unit, upper or lower triangular matrix and `op( A )` is one of `op( A ) = A` or `op( A ) = A**T`.
22+
* BLAS level 3 routine to perform one of the matrix-matrix operations `B = α * op(A) * B` or `B = α * B * op(A)` where `α` is a scalar, `B` is an `M` by `N` matrix, `A` is a unit, or non-unit, upper or lower triangular matrix and `op( A )` is one of `op( A ) = A` or `op( A ) = A^T`.
2323
*
2424
* @module @stdlib/blas/base/dtrmm
2525
*

lib/node_modules/@stdlib/blas/base/dtrmm/lib/ndarray.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,11 @@ var base = require( './base.js' );
3131
// MAIN //
3232

3333
/**
34-
* Performs one of the matrix-matrix operations `B = α * op(A) * B` or `B = α * B * op(A)` where `α` is a scalar, `B` is an `M` by `N` matrix, `A` is a unit, or non-unit, upper or lower triangular matrix and `op( A )` is one of `op( A ) = A` or `op( A ) = A**T`.
34+
* Performs one of the matrix-matrix operations `B = α * op(A) * B` or `B = α * B * op(A)` where `α` is a scalar, `B` is an `M` by `N` matrix, `A` is a unit, or non-unit, upper or lower triangular matrix and `op( A )` is one of `op( A ) = A` or `op( A ) = A^T`.
3535
*
3636
* @param {string} side - specifies whether `op( A )` appears on the left or right side of `B`
37-
* @param {string} uplo - specifies whether the upper or lower triangular part of the matrix `A` is supplied
38-
* @param {string} transa - specifies the form of `op( A )` to be used in matrix multiplication
37+
* @param {string} uplo - specifies whether the upper or lower triangular part of the matrix `A` should be referenced
38+
* @param {string} transa - specifies whether `A` should be transposed, conjugate-transposed, or not transposed
3939
* @param {string} diag - specifies whether or not `A` is unit triangular
4040
* @param {NonNegativeInteger} M - number of rows in `B`
4141
* @param {NonNegativeInteger} N - number of columns in `B`
@@ -49,7 +49,7 @@ var base = require( './base.js' );
4949
* @param {integer} strideB2 - stride of the second dimension of `B`
5050
* @param {NonNegativeInteger} offsetB - starting index for `B`
5151
* @throws {TypeError} first argument must be a valid side
52-
* @throws {TypeError} second argument must specify whether the lower or upper triangular matrix is supplied.
52+
* @throws {TypeError} second argument must specify whether the lower or upper triangular matrix should be referenced.
5353
* @throws {TypeError} third argument must specify correct transpose operation
5454
* @throws {TypeError} fourth argument must specify whether the matrix is unit triangular or not
5555
* @throws {RangeError} fifth argument must be a nonnegative integer
@@ -72,7 +72,7 @@ function dtrmm( side, uplo, transa, diag, M, N, alpha, A, strideA1, strideA2, of
7272
throw new TypeError( format( 'invalid argument. First argument must be a valid side. Value: `%s`.', side ) );
7373
}
7474
if ( !isMatrixTriangle( uplo ) ) {
75-
throw new TypeError( format( 'invalid argument. Second argument must specify whether the lower or upper triangular matrix is supplied. Value: `%s`.', uplo ) );
75+
throw new TypeError( format( 'invalid argument. Second argument must specify whether the lower or upper triangular matrix should be referenced. Value: `%s`.', uplo ) );
7676
}
7777
if ( !isTransposeOperation( transa ) ) {
7878
throw new TypeError( format( 'invalid argument. Third argument must specify correct transpose operation. Value: `%s`.', transa ) );

0 commit comments

Comments
 (0)