Skip to content

Commit 5c457e2

Browse files
Shabareesh ShettyShabareesh Shetty
authored andcommitted
chore: update documentation
--- 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: 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 336d7b9 commit 5c457e2

File tree

3 files changed

+10
-10
lines changed

3 files changed

+10
-10
lines changed

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

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

2121
# dsyrk
2222

23-
> Perform one of the symmetric rank `K` operations `C = α*A*A**T + β*C` or `C = α*A**T*A + β*C`.
23+
> Perform one of the symmetric rank `K` operations `C = α*A*A^T + β*C` or `C = α*A^T*A + β*C`.
2424
2525
<section class="usage">
2626

@@ -32,7 +32,7 @@ var dsyrk = require( '@stdlib/blas/base/dsyrk' );
3232

3333
#### dsyrk( order, uplo, trans, N, K, α, A, lda, β, C, ldc )
3434

35-
Performs one of the symmetric rank `K` operations `C = α*A*A**T + β*C` or `C = α*A**T*A + β*C` where `α` and `β` are scalars, `C` is an `N` by `N` symmetric matrix and `A` is an `N` by `K` matrix in the first case and a `K` by `N` matrix in the second case.
35+
Performs one of the symmetric rank `K` operations `C = α*A*A^T + β*C` or `C = α*A^T*A + β*C` where `α` and `β` are scalars, `C` is an `N` by `N` symmetric matrix and `A` is an `N` by `K` matrix in the first case and a `K` by `N` matrix in the second case.
3636

3737
```javascript
3838
var Float64Array = require( '@stdlib/array/float64' );
@@ -47,7 +47,7 @@ dsyrk( 'row-major', 'upper', 'no-transpose', 3, 3, 1.0, A, 3, 1.0, C, 3 );
4747
The function has the following parameters:
4848

4949
- **order**: storage layout.
50-
- **uplo**: specifies whether the upper or lower triangular part of the symmetric matrix `C` is supplied.
50+
- **uplo**: specifies whether the upper or lower triangular part of the symmetric matrix `C` to be referenced.
5151
- **trans**: specifies whether `C` should be transposed, conjugate-transposed, or not transposed.
5252
- **N**: order of the matrix `C`.
5353
- **K**: number of columns or number of rows of the matrix `A`.
@@ -76,7 +76,7 @@ dsyrk( 'row-major', 'upper', 'no-transpose', 3, 3, 1.0, A, 6, 1.0, C, 3 );
7676

7777
#### dsyrk.ndarray( uplo, trans, N, K, α, A, sa1, sa2, oa, β, C, sc1, sc2, oc )
7878

79-
Performs one of the symmetric rank `K` operations `C = α*A*A**T + β*C` or `C = α*A**T*A + β*C`, using alternative indexing semantics and where `α` and `β` are scalars, `C` is an `N` by `N` symmetric matrix and `A` is an `N` by `K` matrix in the first case and a `K` by `N` matrix in the second case.
79+
Performs one of the symmetric rank `K` operations `C = α*A*A^T + β*C` or `C = α*A^T*A + β*C`, using alternative indexing semantics and where `α` and `β` are scalars, `C` is an `N` by `N` symmetric matrix and `A` is an `N` by `K` matrix in the first case and a `K` by `N` matrix in the second case.
8080

8181
```javascript
8282
var Float64Array = require( '@stdlib/array/float64' );

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ var base = require( './base.js' );
3535
* Performs one of the symmetric rank `K` operations `C = α*A*A^T + β*C` or `C = α*A^T*A + β*C` where `α` and `β` are scalars, `C` is an `N` by `N` symmetric matrix and `A` is an `N` by `K` matrix in the first case and a `K` by `N` matrix in the second case.
3636
*
3737
* @param {string} order - storage layout
38-
* @param {string} uplo - specifies whether the upper or lower triangular part of the symmetric matrix `C` is supplied
38+
* @param {string} uplo - specifies whether the upper or lower triangular part of the symmetric matrix `C` to be referenced
3939
* @param {string} trans - specifies whether `A` should be transposed, conjugate-transposed, or not transposed
4040
* @param {NonNegativeInteger} N - order of the matrix `C`
4141
* @param {NonNegativeInteger} K - number of columns or number of rows of the matrix `A`
@@ -47,7 +47,7 @@ var base = require( './base.js' );
4747
* @param {PositiveInteger} LDC - stride of the first dimension of `C` (a.k.a., leading dimension of the matrix `C`)
4848
* @throws {TypeError} first argument must be a valid order
4949
* @throws {TypeError} second argument must be a valid side
50-
* @throws {TypeError} third argument must specify whether the lower or upper triangular matrix is supplied.
50+
* @throws {TypeError} third argument must specify whether the lower or upper triangular matrix to be referenced.
5151
* @throws {RangeError} fourth argument must be a nonnegative integer
5252
* @throws {RangeError} fifth argument must be a nonnegative integer
5353
* @throws {RangeError} eighth argument must be greater than or equal to max(1,N) when `A` is not transposed and max(1,K) otherwise
@@ -75,7 +75,7 @@ function dsyrk( order, uplo, trans, N, K, alpha, A, LDA, beta, C, LDC ) { // esl
7575
throw new TypeError( format( 'invalid argument. First argument must be a valid order. Value: `%s`.', order ) );
7676
}
7777
if ( !isMatrixTriangle( uplo ) ) {
78-
throw new TypeError( format( 'invalid argument. Second argument must specify whether the lower or upper triangular matrix is supplied. Value: `%s`.', uplo ) );
78+
throw new TypeError( format( 'invalid argument. Second argument must specify whether the lower or upper triangular matrix to be referenced. Value: `%s`.', uplo ) );
7979
}
8080
if ( !isMatrixTranspose( trans ) ) {
8181
throw new TypeError( format( 'invalid argument. Third argument must be a valid transpose operation. Value: `%s`.', trans ) );

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ var base = require( './base.js' );
3131
/**
3232
* Performs one of the symmetric rank `K` operations `C = α*A*A^T + β*C` or `C = α*A^T*A + β*C` where `α` and `β` are scalars, `C` is an `N` by `N` symmetric matrix and `A` is an `N` by `K` matrix in the first case and a `K` by `N` matrix in the second case.
3333
*
34-
* @param {string} uplo - specifies whether the upper or lower triangular part of the symmetric matrix `C` is supplied
34+
* @param {string} uplo - specifies whether the upper or lower triangular part of the symmetric matrix `C` to be referenced
3535
* @param {string} trans - specifies whether `A` should be transposed, conjugate-transposed, or not transposed
3636
* @param {NonNegativeInteger} N - order of the matrix `C`
3737
* @param {NonNegativeInteger} K - number of columns or number of rows of the matrix `A`
@@ -46,7 +46,7 @@ var base = require( './base.js' );
4646
* @param {integer} strideC2 - stride of the second dimension of `C`
4747
* @param {NonNegativeInteger} offsetC - starting index for `C`
4848
* @throws {TypeError} first argument must be a valid side
49-
* @throws {TypeError} second argument must specify whether the lower or upper triangular matrix is supplied.
49+
* @throws {TypeError} second argument must specify whether the lower or upper triangular matrix to be referenced.
5050
* @throws {RangeError} third argument must be a nonnegative integer
5151
* @throws {RangeError} fourth argument must be a nonnegative integer
5252
* @throws {RangeError} twelfth argument must be non-zero
@@ -64,7 +64,7 @@ var base = require( './base.js' );
6464
*/
6565
function dsyrk( uplo, trans, N, K, alpha, A, strideA1, strideA2, offsetA, beta, C, strideC1, strideC2, offsetC ) { // eslint-disable-line max-params, max-len
6666
if ( !isMatrixTriangle( uplo ) ) {
67-
throw new TypeError( format( 'invalid argument. First argument must specify whether the lower or upper triangular matrix is supplied. Value: `%s`.', uplo ) );
67+
throw new TypeError( format( 'invalid argument. First argument must specify whether the lower or upper triangular matrix to be referenced. Value: `%s`.', uplo ) );
6868
}
6969
if ( !isMatrixTranspose( trans ) ) {
7070
throw new TypeError( format( 'invalid argument. Second argument must be a valid transpose operation. Value: `%s`.', trans ) );

0 commit comments

Comments
 (0)