Skip to content

Commit eaad183

Browse files
committed
chore: clean-up
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 60ec836 commit eaad183

File tree

7 files changed

+32
-33
lines changed

7 files changed

+32
-33
lines changed

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ limitations under the License.
2020

2121
# strmm
2222

23-
> Perform one of the matrix-matrix operations `B = alpha * op(A) * B` or `B = alpha * B * op(A)` where alpha 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`.
23+
> 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`.
2424
2525
<section class = "usage">
2626

@@ -30,9 +30,9 @@ limitations under the License.
3030
var strmm = require( '@stdlib/blas/base/strmm' );
3131
```
3232

33-
#### strmm( order, side, uplo, transa, diag, m, n, alpha, A, LDA, B, LDB )
33+
#### strmm( order, side, uplo, transa, diag, M, N, alpha, A, LDA, B, LDB )
3434

35-
Performs one of the matrix-matrix operations `B = alpha * op(A) * B` or `B = alpha * B * op(A)` where alpha 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`.
35+
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`.
3636

3737
```javascript
3838
var Float32Array = require( '@stdlib/array/float32' );
@@ -51,8 +51,8 @@ The function has the following parameters:
5151
- **uplo**: specifies whether the upper or lower triangular part of the matrix `A` is supplied.
5252
- **transa**: specifies the form of `op( A )` to be used in the matrix multiplication.
5353
- **diag**: specifies whether or not `A` is unit triangular.
54-
- **m**: number of rows in `B`.
55-
- **n**: number of columns in `B`.
54+
- **M**: number of rows in `B`.
55+
- **N**: number of columns in `B`.
5656
- **alpha**: scalar constant.
5757
- **A**: input matrix `A`.
5858
- **LDA**: stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`).
@@ -78,9 +78,9 @@ strmm( 'row-major', 'left', 'lower', 'no-transpose', 'unit', 3, 3, 1.0, A1, 3, B
7878
// B1 => <Float32Array>[ 1.0, 2.0, 3.0, 6.0, 9.0, 12.0, 31.0, 41.0, 51.0 ]
7979
```
8080

81-
#### strmm.ndarray( s, ul, t, d, m, n, α, A, sa1, sa2, oa, B, sb1, sb2, ob )
81+
#### strmm.ndarray( s, ul, t, d, M, N, α, A, sa1, sa2, oa, B, sb1, sb2, ob )
8282

83-
Performs one of the matrix-matrix operations `B = alpha * op(A) * B` or `B = alpha * B * op(A)` using alternative indexing semantics and where alpha 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`.
83+
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`.
8484

8585
```javascript
8686
var Float32Array = require( '@stdlib/array/float32' );
@@ -98,8 +98,8 @@ The function has the following parameters:
9898
- **uplo**: specifies whether the upper or lower triangular part of the matrix `A` is supplied.
9999
- **transa**: specifies the form of `op( A )` to be used in the matrix multiplication.
100100
- **diag**: specifies whether or not `A` is unit triangular.
101-
- **m**: number of rows in `B`.
102-
- **n**: number of columns in `B`.
101+
- **M**: number of rows in `B`.
102+
- **N**: number of columns in `B`.
103103
- **alpha**: scalar constant.
104104
- **A**: input matrix `A`.
105105
- **sa1**: stride of the first dimension of `A`.

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

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11

22
{{alias}}( ord, side, uplo, transa, diag, M, N, α, A, lda, B, ldb )
3-
Performs one of the matrix-matrix operations `B = alpha * op(A) * B` or
4-
`B = alpha * B * op(A)` where alpha is a scalar, B is an m by n matrix,
5-
A 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`.
3+
Performs one of the matrix-matrix operations `B = α * op(A) * B` or
4+
`B = α * B * op(A)` where α is a scalar, `B` is an `M` by `N` matrix, A is
5+
a unit, or non-unit, upper or lower triangular matrix and `op( A )` is one
6+
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.
@@ -73,11 +73,10 @@
7373

7474

7575
{{alias}}.ndarray(side,uplo,transa,diag,M,N,α,A,sa1,sa2,oa,B,sb1,sb2,ob)
76-
Performs one of the matrix-matrix operations `B = alpha * op(A) * B` or
77-
`B = alpha * B * op(A)` where alpha is a scalar, B is an m by n matrix,
78-
A is a unit, or non-unit, upper or lower triangular matrix and op( A ) is
79-
one of `op( A ) = A` or `op( A ) = A**T` using alternative indexing
80-
semantics.
76+
Performs one of the matrix-matrix operations `B = α * op(A) * B` or
77+
`B = α * B * op(A)` where α is a scalar, `B` is an `M` by `N` matrix, A is
78+
a unit, or non-unit, upper or lower triangular matrix and `op( A )` is one
79+
of `op( A ) = A` or `op( A ) = A**T` using alternative indexing semantics.
8180

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

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

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,15 @@ import { Layout, MatrixTriangle, DiagonalType, OperationSide, TransposeOperation
2727
*/
2828
interface Routine {
2929
/**
30-
* Performs one of the matrix-matrix operations `B = alpha * op(A) * B` or `B = alpha * B * op(A)` where alpha 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 )` multiplies `B` from the left or right
3434
* @param uplo - specifies whether the upper or lower triangular part of the matrix `A` is supplied
3535
* @param transa - specifies the form of `op( A )` to be used in matrix multiplication
3636
* @param diag - specifies whether or not `A` is unit triangular
37-
* @param m - number of rows in `B`
38-
* @param n - number of columns in `B`
37+
* @param M - number of rows in `B`
38+
* @param N - number of columns in `B`
3939
* @param alpha - scalar constant
4040
* @param A - input matrix `A`
4141
* @param LDA - stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`)
@@ -52,17 +52,17 @@ interface Routine {
5252
* strmm( 'row-major', 'left', 'lower', 'no-transpose', 'unit', 3, 3, 1.0, A, 3, B, 3 );
5353
* // B => <Float32Array>[ 1.0, 2.0, 3.0, 6.0, 9.0, 12.0, 31.0, 41.0, 51.0 ]
5454
*/
55-
( order: Layout, side: OperationSide, uplo: MatrixTriangle, transa: TransposeOperation, diag: DiagonalType, m: number, n: number, alpha: number, A: Float32Array, LDA: number, B: Float32Array, LDB: number ): Float32Array;
55+
( order: Layout, side: OperationSide, uplo: MatrixTriangle, transa: TransposeOperation, diag: DiagonalType, M: number, N: number, alpha: number, A: Float32Array, LDA: number, B: Float32Array, LDB: number ): Float32Array;
5656

5757
/**
58-
* Performs one of the matrix-matrix operations `B = alpha * op(A) * B` or `B = alpha * B * op(A)` using alternative indexing semantics, where alpha 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 )` multiplies `B` from the left or right
6161
* @param uplo - specifies whether the upper or lower triangular part of the matrix `A` is supplied
6262
* @param transa - specifies the form of `op( A )` to be used in matrix multiplication
6363
* @param diag - specifies whether or not `A` is unit triangular
64-
* @param m - number of rows in `B`
65-
* @param n - number of columns in `B`
64+
* @param M - number of rows in `B`
65+
* @param N - number of columns in `B`
6666
* @param alpha - scalar constant
6767
* @param A - input matrix `A`
6868
* @param strideA1 - stride of the first dimension of `A`
@@ -83,19 +83,19 @@ interface Routine {
8383
* strmm.ndarray( 'left', 'lower', 'no-transpose', 'unit', 3, 3, 1.0, A, 3, 1, 0, B, 3, 1, 0 );
8484
* // B => <Float32Array>[ 1.0, 2.0, 3.0, 6.0, 9.0, 12.0, 31.0, 41.0, 51.0 ]
8585
*/
86-
ndarray( side: OperationSide, uplo: MatrixTriangle, transa: TransposeOperation, diag: DiagonalType, m: number, n: number, alpha: number, A: Float32Array, strideA1: number, strideA2: number, offsetA: number, B: Float32Array, strideB1: number, strideB2: number, offsetB: number ): Float32Array;
86+
ndarray( side: OperationSide, uplo: MatrixTriangle, transa: TransposeOperation, diag: DiagonalType, M: number, N: number, alpha: number, A: Float32Array, strideA1: number, strideA2: number, offsetA: number, B: Float32Array, strideB1: number, strideB2: number, offsetB: number ): Float32Array;
8787
}
8888

8989
/**
90-
* Performs one of the matrix-matrix operations `B = alpha * op(A) * B` or `B = alpha * B * op(A)` using alternative indexing semantics, where alpha 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 )` multiplies `B` from the left or right
9494
* @param uplo - specifies whether the upper or lower triangular part of the matrix `A` is supplied
9595
* @param transa - specifies the form of `op( A )` to be used in matrix multiplication
9696
* @param diag - specifies whether or not `A` is unit triangular
97-
* @param m - number of rows in `B`
98-
* @param n - number of columns in `B`
97+
* @param M - number of rows in `B`
98+
* @param N - number of columns in `B`
9999
* @param alpha - scalar constant
100100
* @param A - input matrix `A`
101101
* @param LDA - stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`)

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ function zeros( M, N, X, strideX1, strideX2, offsetX ) { // TODO: consider movin
9494
// MAIN //
9595

9696
/**
97-
* Performs one of the matrix-matrix operations `B = alpha * op(A) * B` or `B = alpha * B * op(A)` where alpha 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`.
97+
* 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`.
9898
*
9999
* @private
100100
* @param {string} side - specifies whether `op( A )` multiplies `B` from the left or right

lib/node_modules/@stdlib/blas/base/strmm/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 routine to perform one of the matrix-matrix operations `B = alpha * op(A) * B` or `B = alpha * B * op(A)` where alpha 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 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/strmm
2525
*

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ var base = require( './base.js' );
3131
// MAIN //
3232

3333
/**
34-
* Performs one of the matrix-matrix operations `B = alpha * op(A) * B` or `B = alpha * B * op(A)` where alpha 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 )` multiplies `B` from the left or right
3737
* @param {string} uplo - specifies whether the upper or lower triangular part of the matrix `A` is supplied

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ var base = require( './base.js' );
3535
// MAIN //
3636

3737
/**
38-
* Performs one of the matrix-matrix operations `B = alpha * op(A) * B` or `B = alpha * B * op(A)` where alpha 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`.
38+
* 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`.
3939
*
4040
* @param {string} order - storage layout of `A` and `B`
4141
* @param {string} side - specifies whether `op( A )` multiplies `B` from the left or right

0 commit comments

Comments
 (0)