Skip to content

Commit 6f9c1d8

Browse files
committed
chore: cleanup
--- 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 1f97555 commit 6f9c1d8

File tree

1 file changed

+10
-11
lines changed
  • lib/node_modules/@stdlib/lapack/base/dlatrs

1 file changed

+10
-11
lines changed

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

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ var scale = dlatrs( 'row-major', 'upper', 'no-transpose', 'non-unit', 'no', 3, A
146146

147147
<!-- lint disable maximum-heading-length -->
148148

149-
#### dlatrs.ndarray( uplo, trans, diag, normin, N, A, strideA1, strideA2, offsetA, X, strideX, offsetX, CNORM, strideCNORM, offsetCNORM )
149+
#### dlatrs.ndarray( uplo, trans, diag, normin, N, A, sa1, sa2, oa, X, sx, ox, CNORM, sc, oc )
150150

151151
Solves a triangular system of equations with the scale factor set to prevent overflow using alternative indexing semantics.
152152

@@ -157,21 +157,21 @@ var A = new Float64Array( [ 2.0, 1.0, -1.0, 0.0, 3.0, 2.0, 0.0, 0.0, 4.0 ] ); //
157157
var X = new Float64Array( [ 5.0, 10.0, 20.0 ] );
158158
var CNORM = new Float64Array( 3 );
159159

160-
var scale = dlatrs( 'upper', 'no-transpose', 'non-unit', 'no', 3, A, 3, 1, 0, X, 1, 0, CNORM, 1, 0 );
160+
var scale = dlatrs.ndarray( 'upper', 'no-transpose', 'non-unit', 'no', 3, A, 3, 1, 0, X, 1, 0, CNORM, 1, 0 );
161161
// returns 1.0
162162
// X => <Float64Array>[ 5.0, 0.0, 5.0 ]
163163
// CNORM => <Float64Array>[ 0.0, 1.0, 3.0 ]
164164
```
165165

166166
The function has the following additional parameters:
167167

168-
- **strideA1**: stride of the first dimensiosn of `A`.
169-
- **strideA2**: stride of the second dimension of `A`.
170-
- **offsetA**: starting index for `A`.
171-
- **strideX**: stride length for `X`.
172-
- **offsetX**: starting index for `X`.
173-
- **strideCNORM**: stride length for `CNORM`.
174-
- **offsetCNORM**: starting index for `CNORM`.
168+
- **sa1**: stride of the first dimensiosn of `A`.
169+
- **sa2**: stride of the second dimension of `A`.
170+
- **oa**: starting index for `A`.
171+
- **sx**: stride length for `X`.
172+
- **ox**: starting index for `X`.
173+
- **sc**: stride length for `CNORM`.
174+
- **oc**: starting index for `CNORM`.
175175

176176
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example,
177177

@@ -184,7 +184,7 @@ var A = new Float64Array( [ 9999.0, 2.0, 1.0, -1.0, 0.0, 3.0, 2.0, 0.0, 0.0, 4.0
184184
var X = new Float64Array( [ 9999.0, 5.0, 10.0, 20.0 ] );
185185
var CNORM = new Float64Array( 4 );
186186

187-
var scale = dlatrs( 'upper', 'no-transpose', 'non-unit', 'no', 3, A, 3, 1, 1, X, 1, 1, CNORM, 1, 1 );
187+
var scale = dlatrs.ndarray( 'upper', 'no-transpose', 'non-unit', 'no', 3, A, 3, 1, 1, X, 1, 1, CNORM, 1, 1 );
188188
// returns 1.0
189189
// X => <Float64Array>[ 9999.0, 5.0, 0.0, 5.0 ]
190190
// CNORM => <Float64Array>[ 0.0, 0.0, 1.0, 3.0 ]
@@ -199,7 +199,6 @@ var scale = dlatrs( 'upper', 'no-transpose', 'non-unit', 'no', 3, A, 3, 1, 1, X,
199199
## Notes
200200

201201
- Both functions mutate the input arrays `X` and `CNORM` (if `normin` = `no`).
202-
203202
- `dlatrs()` corresponds to the [LAPACK][LAPACK] routine [`dlatrs`][lapack-dlatrs].
204203

205204
</section>

0 commit comments

Comments
 (0)