Skip to content

Commit a40daeb

Browse files
committed
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: na - 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 68c63b4 commit a40daeb

File tree

1 file changed

+9
-5
lines changed
  • lib/node_modules/@stdlib/blas/base/zher/docs/types

1 file changed

+9
-5
lines changed

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

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -79,12 +79,16 @@ interface Routine {
7979
}
8080

8181
/**
82-
* Scales a single-precision complex floating-point vector by a single-precision complex floating-point constant.
82+
* Performs the hermitian rank 1 operation `A = alpha*x*x**H + A`, where `alpha` is a real scalar, `x` is an `N` element vector and `A` is an `N` by `N` hermitian matrix.
8383
*
84-
* @param N - number of indexed elements
85-
* @param ca - scalar constant
86-
* @param cx - input array
87-
* @param strideX - `cx` stride length
84+
* @param order - storage layout
85+
* @param uplo - specifies whether `A` is an upper or lower triangular part of matrix is supplied.
86+
* @param N - number of elements along each dimension of `A`
87+
* @param alpha - scalar constant
88+
* @param x - input array
89+
* @param strideX - `x` stride length
90+
* @param A - input matrix
91+
* @param LDA - stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`)
8892
* @returns input array
8993
*
9094
* @example

0 commit comments

Comments
 (0)