Skip to content

Commit 4d5a16f

Browse files
Shabareesh ShettyShabareesh Shetty
authored andcommitted
docs: 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: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 7d4e34f commit 4d5a16f

File tree

4 files changed

+10
-10
lines changed

4 files changed

+10
-10
lines changed

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@ import { Layout, MatrixTriangle, TransposeOperation } from '@stdlib/types/blas';
2727
*/
2828
interface Routine {
2929
/**
30-
* 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.
30+
* 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.
3131
*
3232
* @param order - storage layout
33-
* @param uplo - specifies whether the upper or lower triangular part of the symmetric matrix `C` is supplied
33+
* @param uplo - specifies whether the upper or lower triangular part of the symmetric matrix `C` to be referenced
3434
* @param trans - specifies whether `A` should be transposed, conjugate-transposed, or not transposed
3535
* @param N - order of the matrix `C`
3636
* @param K - number of columns or number of rows of the matrix `A`
@@ -54,10 +54,10 @@ interface Routine {
5454
( order: Layout, uplo: MatrixTriangle, trans: TransposeOperation, N: number, K: number, alpha: number, A: Float64Array, LDA: number, beta: number, C: Float64Array, LDC: number ): Float64Array;
5555

5656
/**
57-
* 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.
57+
* 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.
5858
*
5959
* @param order - storage layout
60-
* @param uplo - specifies whether the upper or lower triangular part of the symmetric matrix `C` is supplied
60+
* @param uplo - specifies whether the upper or lower triangular part of the symmetric matrix `C` to be referenced
6161
* @param trans - specifies whether `A` should be transposed, conjugate-transposed, or not transposed
6262
* @param N - order of the matrix `C`
6363
* @param K - number of columns or number of rows of the matrix `A`
@@ -79,17 +79,17 @@ interface Routine {
7979
* var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0 ] );
8080
* var C = new Float64Array( [ 1.0, 2.0, 3.0, 0.0, 4.0, 5.0, 0.0, 0.0, 6.0 ] );
8181
*
82-
* dsyrk( 'upper', 'no-transpose', 3, 3, 1.0, A, 3, 1, 0, 1.0, C, 3, 1, 0 );
82+
* dsyrk.ndarray( 'upper', 'no-transpose', 3, 3, 1.0, A, 3, 1, 0, 1.0, C, 3, 1, 0 );
8383
* // C => <Float64Array>[ 15.0, 34.0, 53.0, 0.0, 81.0, 127.0, 0.0, 0.0, 200.0 ]
8484
*/
8585
ndarray( uplo: MatrixTriangle, trans: TransposeOperation, N: number, K: number, alpha: number, A: Float64Array, strideA1: number, strideA2: number, offsetA: number, beta: number, C: Float64Array, strideC1: number, strideC2: number, offsetC: number ): Float64Array;
8686
}
8787

8888
/**
89-
* 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.
89+
* 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.
9090
*
9191
* @param order - storage layout
92-
* @param uplo - specifies whether the upper or lower triangular part of the symmetric matrix `C` is supplied
92+
* @param uplo - specifies whether the upper or lower triangular part of the symmetric matrix `C` to be referenced
9393
* @param trans - specifies whether `A` should be transposed, conjugate-transposed, or not transposed
9494
* @param N - order of the matrix `C`
9595
* @param K - number of columns or number of rows of the matrix `A`

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

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

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
* @param {string} order - storage layout
3838
* @param {string} uplo - specifies whether the upper or lower triangular part of the symmetric matrix `C` is supplied

lib/node_modules/@stdlib/blas/base/dsyrk/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 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.
22+
* BLAS level 3 routine to perform 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.
2323
*
2424
* @module @stdlib/blas/base/dsyrk
2525
*

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

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

3131
/**
32-
* 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.
32+
* 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
*
3434
* @param {string} uplo - specifies whether the upper or lower triangular part of the symmetric matrix `C` is supplied
3535
* @param {string} trans - specifies whether `A` should be transposed, conjugate-transposed, or not transposed

0 commit comments

Comments
 (0)