Skip to content

Commit bd61b1e

Browse files
committed
docs: add repl.txt
--- 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: passed - 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 213300c commit bd61b1e

File tree

1 file changed

+112
-0
lines changed
  • lib/node_modules/@stdlib/lapack/base/dlascl/docs

1 file changed

+112
-0
lines changed
Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
{{alias}}( order, type, KL, KU, CFROM, CTO, M, N, A, LDA )
2+
Multiplies a real M by N matrix `A` by a real scalar `CTO/CFROM`.
3+
4+
Indexing is relative to the first index. To introduce an offset, use
5+
typed array views.
6+
7+
Parameters
8+
----------
9+
order: string
10+
Row-major (C-style) or column-major (Fortran-style) order. Must be
11+
either 'row-major' or 'column-major'.
12+
13+
type: string
14+
Specifies the type of matrix `A`.
15+
16+
KL: nonNegativeInteger
17+
Lower band width of `A`. Referenced only if type is
18+
`symmetric-banded-lower` or `banded`.
19+
20+
KU: nonNegativeInteger
21+
Upper band width of `A`. Referenced only if type is
22+
`symmetric-banded-upper` or `banded`.
23+
24+
CFROM: number
25+
The matrix `A` are multiplied by `CTO / CFROM`.
26+
27+
CTO: number
28+
The matrix `A` are multiplied by `CTO / CFROM`.
29+
30+
M: nonNegativeInteger
31+
Number of rows in matrix `A`.
32+
33+
N: nonNegativeInteger
34+
Number of columns in matrix `A`.
35+
36+
A: Float64Array
37+
Input matrix `A`.
38+
39+
LDA: positiveInteger
40+
Stride of the first dimension of `A` (a.k.a., leading dimension of
41+
the matrix `A`).
42+
43+
Returns
44+
-------
45+
A: Float64Array
46+
Scaled matrix `A`.
47+
48+
Examples
49+
--------
50+
> var A = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
51+
> {{alias}}( 'row-major', 'general', 0, 0, 1.0, 2.0, 3, 2, A, 2 )
52+
<Float64Array>[ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ]
53+
54+
55+
{{alias}}.ndarray( type, KL, KU, CFROM, CTO, M, N, A, sa1, sa2, oa )
56+
Multiplies a real M by N matrix `A` by a real scalar `CTO/CFROM` using
57+
alternative indexing semantics.
58+
59+
While typed array views mandate a view offset based on the underlying
60+
buffer, the offset parameters support indexing semantics based on starting
61+
indices.
62+
63+
Parameters
64+
----------
65+
type: string
66+
Specifies the type of matrix `A`.
67+
68+
KL: nonNegativeInteger
69+
Lower band width of `A`. Referenced only if type is
70+
`symmetric-banded-lower` or `banded`.
71+
72+
KU: nonNegativeInteger
73+
Upper band width of `A`. Referenced only if type is
74+
`symmetric-banded-upper` or `banded`.
75+
76+
CFROM: number
77+
The matrix `A` are multiplied by `CTO / CFROM`.
78+
79+
CTO: number
80+
The matrix `A` are multiplied by `CTO / CFROM`.
81+
82+
M: nonNegativeInteger
83+
Number of rows in matrix `A`.
84+
85+
N: nonNegativeInteger
86+
Number of columns in matrix `A`.
87+
88+
A: Float64Array
89+
Input matrix `A`.
90+
91+
sa1: integer
92+
Stride of the first dimension of `A`.
93+
94+
sa2: integer
95+
Stride of the second dimension of `A`.
96+
97+
oa: nonNegativeInteger
98+
Starting index for `A`.
99+
100+
Returns
101+
-------
102+
A: Float64Array
103+
Scaled matrix `A`.
104+
105+
Examples
106+
--------
107+
> var A = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
108+
> {{alias}}.ndarray( 'general', 0, 0, 1.0, 2.0, 3, 2, A, 2, 1, 0 )
109+
<Float64Array>[ 2.0, 4.0, 6.0, 8.0, 10.0, 12.0 ]
110+
111+
See Also
112+
--------

0 commit comments

Comments
 (0)