Skip to content

Commit 4c9b7e9

Browse files
committed
docs: use links for int32array and float64array
--- 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: 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: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent f22e05a commit 4c9b7e9

File tree

1 file changed

+14
-12
lines changed
  • lib/node_modules/@stdlib/lapack/base/dgtts2

1 file changed

+14
-12
lines changed

lib/node_modules/@stdlib/lapack/base/dgtts2/README.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -57,12 +57,12 @@ The function has the following parameters:
5757
- **itrans**: specifies the form of the system of equations.
5858
- **N**: order of the matrix `A`.
5959
- **nrhs**: number of right-hand sides, i.e., the number of columns of the matrix `B`.
60-
- **DL**: multipliers that define the matrix `L`.
61-
- **D**: diagonal elements of the upper triangular matrix `U`.
62-
- **DU**: elements of the first super-diagonal of `U`.
63-
- **DU2**: elements of the second super-diagonal of `U`.
64-
- **IPIV**: vector of pivot indices.
65-
- **B**: right-hand side matrix B, overwritten by the solution matrix `X`.
60+
- **DL**: multipliers that define the matrix `L` as a [`Float64Array`][mdn-float64array].
61+
- **D**: diagonal elements of the upper triangular matrix `U` as a [`Float64Array`][mdn-float64array].
62+
- **DU**: elements of the first super-diagonal of `U` as a [`Float64Array`][mdn-float64array].
63+
- **DU2**: elements of the second super-diagonal of `U` as a [`Float64Array`][mdn-float64array].
64+
- **IPIV**: vector of pivot indices as an [`Int32Array`][mdn-int32array].
65+
- **B**: right-hand side matrix B, overwritten by the solution matrix `X` as a [`Float64Array`][mdn-float64array].
6666
- **LDB**: stride of the first dimension of `B` (a.k.a., leading dimension of the matrix `B`).
6767

6868
Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
@@ -117,22 +117,22 @@ The function has the following parameters:
117117
- **itrans**: specifies the form of the system of equations.
118118
- **N**: order of the matrix `A`.
119119
- **nrhs**: number of right-hand sides, i.e., the number of columns of the matrix `B`.
120-
- **DL**: multipliers that define the matrix `L`.
120+
- **DL**: multipliers that define the matrix `L` as a [`Float64Array`][mdn-float64array].
121121
- **sdl**: stride length for `DL`.
122122
- **odl**: starting index for `DL`.
123-
- **D**: diagonal elements of the upper triangular matrix `U`.
123+
- **D**: diagonal elements of the upper triangular matrix `U` as a [`Float64Array`][mdn-float64array].
124124
- **sd**: stride length for `D`.
125125
- **od**: starting index for `D`.
126-
- **DU**: elements of the first super-diagonal of `U`.
126+
- **DU**: elements of the first super-diagonal of `U` as a [`Float64Array`][mdn-float64array].
127127
- **sdu**: stride length for `DU`.
128128
- **odu**: starting index for `DU`.
129-
- **DU2**: elements of the second super-diagonal of `U`.
129+
- **DU2**: elements of the second super-diagonal of `U` as a [`Float64Array`][mdn-float64array].
130130
- **sdu2**: stride length for `DU2`.
131131
- **odu2**: starting index for `DU2`.
132-
- **IPIV**: vector of pivot indices.
132+
- **IPIV**: vector of pivot indices as an [`Int32Array`][mdn-int32array].
133133
- **si**: stride length for `IPIV`.
134134
- **oi**: starting index for `IPIV`.
135-
- **B**: right-hand side matrix B, overwritten by the solution matrix `X`.
135+
- **B**: right-hand side matrix B, overwritten by the solution matrix `X` as a [`Float64Array`][mdn-float64array].
136136
- **sb1**: stride length for first dimension of `B`.
137137
- **sb2**: stride length for second dimension of `B`.
138138
- **ob**: starting index for `B`.
@@ -292,6 +292,8 @@ TODO
292292

293293
[mdn-float64array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float64Array
294294

295+
[mdn-int32array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int32Array
296+
295297
[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
296298

297299
</section>

0 commit comments

Comments
 (0)