Skip to content

Commit c86cd76

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 3f05266 commit c86cd76

File tree

1 file changed

+134
-0
lines changed
  • lib/node_modules/@stdlib/lapack/base/dgebal/docs

1 file changed

+134
-0
lines changed
Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
2+
{{alias}}( order, job, N, A, LDA, out, scale )
3+
Balances a general real matrix `A`.
4+
5+
The matrix `A` is overwritten by the balanced matrix. Scale factors are
6+
stored in the `scale` array. Where the indices `0` to `out[ 0 ] - 1` and
7+
`out[ 1 ] + 1` to `N-1` contain the index of the interchanged row/column
8+
(zero based), and the indices `out[ 0 ]` to `out[ 1 ]` contains the
9+
scaling factor applied.
10+
11+
Indexing is relative to the first index. To introduce an offset, use typed
12+
array views.
13+
14+
Parameters
15+
----------
16+
order: string
17+
Row-major (C-style) or column-major (Fortran-style) order. Must be
18+
either 'row-major' or 'column-major'.
19+
20+
job: string
21+
Indicates the operations to be performed. The `job` parameter can be
22+
one of the following. 'none' (do nothing), 'permute' (permute only),
23+
'scale' (scale only) and 'both' (both permute and scale).
24+
25+
N: integer
26+
Number of row/columns in `A`.
27+
28+
A: Float64Array
29+
Input matrix `A`.
30+
31+
LDA: integer
32+
Stride of the first dimension of `A` (a.k.a., leading dimension of the
33+
matrix `A`).
34+
35+
out: Int32Array
36+
Output matrix `out`.
37+
38+
scale: Float64Array
39+
Array containing permutation and scaling information.
40+
41+
Returns
42+
-------
43+
info: integer
44+
Status code.
45+
46+
Examples
47+
--------
48+
> var A = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 3.0, 4.0 ] );
49+
> var out = new {{alias:@stdlib/array/int32}}( 2 );
50+
> var scale = new {{alias:@stdlib/array/float64}}( 2 );
51+
> {{alias}}( 'row-major', 'both', 2, A, 2, out, scale )
52+
0
53+
> A
54+
<Float64Array>[ 1.0, 2.0, 3.0, 4.0 ]
55+
> out
56+
<Int32Array>[ 0, 1 ]
57+
> scale
58+
<Float64Array>[ 1.0, 1.0 ]
59+
60+
61+
{{alias}}.ndarray( job, N, A, sa1, sa2, oa, out, so, oo, scale, ss, os )
62+
Balances a general real matrix `A` using alternative indexing semantics.
63+
64+
The matrix `A` is overwritten by the balanced matrix. Scale factors are
65+
stored in the `scale` array. Where the indices `0` to `out[ 0 ] - 1` and
66+
`out[ 1 ] + 1` to `N-1` contain the index of the interchanged row/column
67+
(zero based), and the indices `out[ 0 ]` to `out[ 1 ]` contains the
68+
scaling factor applied.
69+
70+
While typed array views mandate a view offset based on the underlying
71+
buffer, the offset parameters support indexing semantics based on starting
72+
indices.
73+
74+
Parameters
75+
----------
76+
job: string
77+
Indicates the operations to be performed. The `job` parameter can be
78+
one of the following. 'none' (do nothing), 'permute' (permute only),
79+
'scale' (scale only) and 'both' (both permute and scale).
80+
81+
N: integer
82+
Number of row/columns in `A`.
83+
84+
A: Float64Array
85+
Input matrix `A`.
86+
87+
sa1: integer
88+
Stride of the first dimension of `A`.
89+
90+
sa2: integer
91+
Stride of the second dimension of `A`.
92+
93+
oa: integer
94+
Starting index for `A`.
95+
96+
out: Int32Array
97+
Output matrix `out`.
98+
99+
so: integer
100+
Stride length of `out`.
101+
102+
oo: integer
103+
Starting index of `out`.
104+
105+
scale: Float64Array
106+
Array containing permutation and scaling information.
107+
108+
ss: integer
109+
Stride length for `scale`.
110+
111+
os: integer
112+
Starting index for `scale`.
113+
114+
Returns
115+
-------
116+
info: integer
117+
Status code.
118+
119+
Examples
120+
--------
121+
> var A = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 3.0, 4.0 ] );
122+
> var out = new {{alias:@stdlib/array/int32}}( 2 );
123+
> var scale = new {{alias:@stdlib/array/float64}}( 2 );
124+
> {{alias}}.ndarray( 'both', 2, A, 2, 1, 0, out, 1, 0, scale, 1, 0 )
125+
0
126+
> A
127+
<Float64Array>[ 1.0, 2.0, 3.0, 4.0 ]
128+
> out
129+
<Int32Array>[ 0, 1 ]
130+
> scale
131+
<Float64Array>[ 1.0, 1.0 ]
132+
133+
See Also
134+
--------

0 commit comments

Comments
 (0)