Skip to content

Commit 76f37d0

Browse files
Shabareesh ShettyShabareesh Shetty
authored andcommitted
chore: update jsdoc
--- 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: na - task: lint_package_json status: na - task: lint_repl_help status: na - 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: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent a0d7b5f commit 76f37d0

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ function scal( M, N, beta, X, strideX1, strideX2, offsetX ) { // TODO: consider
158158
*
159159
* @private
160160
* @param {string} side - specifies whether `A` appears on the left or right of `B`
161-
* @param {string} uplo - specifies whether the upper or lower triangular part of the symmetric matrix `A` is supplied
161+
* @param {string} uplo - specifies whether the upper or lower triangular part of the symmetric matrix `A` to be referenced
162162
* @param {NonNegativeInteger} M - number of rows in the matrix `C`
163163
* @param {NonNegativeInteger} N - number of columns in the matrix `C`
164164
* @param {number} alpha - scalar constant

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ var base = require( './base.js' );
3737
*
3838
* @param {string} order - storage layout
3939
* @param {string} side - specifies whether `A` appears on the left or right of `B`
40-
* @param {string} uplo - specifies whether the upper or lower triangular part of the symmetric matrix `A` is supplied
40+
* @param {string} uplo - specifies whether the upper or lower triangular part of the symmetric matrix `A` to be referenced
4141
* @param {NonNegativeInteger} M - number of rows in the matrix `op(A)` and in the matrix `C`
4242
* @param {NonNegativeInteger} N - number of columns in the matrix `op(B)` and in the matrix `C`
4343
* @param {number} alpha - scalar constant
@@ -50,7 +50,7 @@ var base = require( './base.js' );
5050
* @param {PositiveInteger} LDC - stride of the first dimension of `C` (a.k.a., leading dimension of the matrix `C`)
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 to be referenced.
5454
* @throws {RangeError} fourth argument must be a nonnegative integer
5555
* @throws {RangeError} fifth argument must be a nonnegative integer
5656
* @throws {RangeError} eighth argument must be greater than or equal to max(1,M) when `A` is on the left of `B` and max(1,N) otherwise
@@ -87,7 +87,7 @@ function dsymm( order, side, uplo, M, N, alpha, A, LDA, B, LDB, beta, C, LDC ) {
8787
throw new TypeError( format( 'invalid argument. Second argument must be a valid side. Value: `%s`.', side ) );
8888
}
8989
if ( !isMatrixTriangle( uplo ) ) {
90-
throw new TypeError( format( 'invalid argument. Third argument must specify whether the lower or upper triangular matrix is supplied. Value: `%s`.', uplo ) );
90+
throw new TypeError( format( 'invalid argument. Third argument must specify whether the lower or upper triangular matrix to be referenced. Value: `%s`.', uplo ) );
9191
}
9292
if ( M < 0 ) {
9393
throw new RangeError( format( 'invalid argument. Fourth argument must be a nonnegative integer. Value: `%d`.', M ) );

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ var base = require( './base.js' );
3232
* Performs the matrix-matrix operation `C = α*A*B + β*C` or `C = α*B*A + β*C` where `α` and `β` are scalars, `A` is a symmetric matrix and `B` and `C` are `M` by `N` matrices.
3333
*
3434
* @param {string} side - specifies whether `A` appears on the left or right of `B`
35-
* @param {string} uplo - specifies whether the upper or lower triangular part of the symmetric matrix `A` is supplied
35+
* @param {string} uplo - specifies whether the upper or lower triangular part of the symmetric matrix `A` to be referenced
3636
* @param {NonNegativeInteger} M - number of rows in the matrix `C`
3737
* @param {NonNegativeInteger} N - number of columns in the matrix `C`
3838
* @param {number} alpha - scalar constant
@@ -50,7 +50,7 @@ var base = require( './base.js' );
5050
* @param {integer} strideC2 - stride of the second dimension of `C`
5151
* @param {NonNegativeInteger} offsetC - starting index for `C`
5252
* @throws {TypeError} first argument must be a valid side
53-
* @throws {TypeError} second argument must specify whether the lower or upper triangular matrix is supplied.
53+
* @throws {TypeError} second argument must specify whether the lower or upper triangular matrix to be referenced.
5454
* @throws {RangeError} third argument must be a nonnegative integer
5555
* @throws {RangeError} fourth argument must be a nonnegative integer
5656
* @throws {RangeError} sixteenth argument must be non-zero
@@ -72,7 +72,7 @@ function dsymm( side, uplo, M, N, alpha, A, strideA1, strideA2, offsetA, B, stri
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 to be referenced. Value: `%s`.', uplo ) );
7676
}
7777
if ( M < 0 ) {
7878
throw new RangeError( format( 'invalid argument. Third argument must be a nonnegative integer. Value: `%d`.', M ) );

0 commit comments

Comments
 (0)