Skip to content

Commit e4d4501

Browse files
committed
docs: add intro section
--- 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 54696ce commit e4d4501

File tree

1 file changed

+27
-4
lines changed
  • lib/node_modules/@stdlib/lapack/base/dlascl

1 file changed

+27
-4
lines changed

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

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,32 @@ limitations under the License.
2222

2323
> LAPACK routine to multiply a double-precision floating-point M-by-N matrix `A` by a double-precision floating-point scalar.
2424
25+
<section class="intro">
26+
27+
The `dlascl` routine multiplies each element of an M-by-N matrix `A` by a scalar `α`
28+
29+
<!-- <equation class="equation" label="eq:scaling_operation" align="center" raw="B = \alpha \cdot A = \alpha \cdot \left[ a_{1,1} a_{1,2} \ldots a_{0,N} \quad \ldots \right] = \left[ \alpha a_{1,1} \alpha a_{1,2} \ldots \alpha a_{0,N} \quad \ldots \right]" alt="Equation for matrix scaling operation."> -->
30+
31+
```math
32+
B = \alpha \cdot A = \alpha \cdot \left[ a_{1,1} a_{1,2} \ldots a_{0,N} \quad \ldots \right] = \left[ \alpha a_{1,1} \alpha a_{1,2} \ldots \alpha a_{0,N} \quad \ldots \right]
33+
```
34+
35+
<!-- </equation> -->
36+
37+
In order to more readily avoid underflow/overflow, this routine chooses to represent `α` as the product of
38+
39+
<!-- <equation class="equation" label="eq:alpha_representation" align="center" raw="\alpha = \beta \cdot \frac{1}{\gamma}" alt="Equation for alpha representation as beta over gamma."> -->
40+
41+
```math
42+
\alpha = \beta \cdot \frac{1}{\gamma}
43+
```
44+
45+
<!-- </equation> -->
46+
47+
</section>
48+
49+
<!-- /.intro -->
50+
2551
<section class="usage">
2652

2753
## Usage
@@ -56,8 +82,6 @@ The function has the following parameters:
5682
- **A**: input [`Float64Array`][mdn-float64array].
5783
- **LDA**: stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`).
5884

59-
If `type` is `'banded'`, `'symmetric-banded-lower'`, or `'symmetric-banded-upper'`, the matrix should be stored in the [band storage][lapack-band-storage] format.
60-
6185
Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
6286

6387
<!-- eslint-disable stdlib/capitalized-comments -->
@@ -102,7 +126,6 @@ The function has the following parameters:
102126
- **strideA2**: stride of the second dimension of `A`.
103127
- **offsetA**: starting index for `A`.
104128

105-
If `type` is `'banded'`, `'symmetric-banded-lower'`, or `'symmetric-banded-upper'`, the matrix should be stored in the [band storage][lapack-band-storage] format.
106129

107130
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,
108131

@@ -124,7 +147,7 @@ dlascl.ndarray( 'general', 0, 0, 1.0, 2.0, 3, 2, A, 2, 1, 1 );
124147
## Notes
125148

126149
- `dlascl()` corresponds to the [LAPACK][lapack] routine [`dlascl`][lapack-dlascl].
127-
- If `type` is `banded`, `symmetric-banded-lower` or `symmetric-banded-upper` the matrix should be stored in the [`Band storage`][lapack-band-storage] format.
150+
- If `type` is `'banded'`, `'symmetric-banded-lower'`, or `'symmetric-banded-upper'`, the matrix should be stored in the [band storage][lapack-band-storage] format.
128151

129152
</section>
130153

0 commit comments

Comments
 (0)