Skip to content

Commit 162195b

Browse files
aayush0325aayush0325
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 6f9c1d8 commit 162195b

File tree

1 file changed

+151
-0
lines changed
  • lib/node_modules/@stdlib/lapack/base/dlatrs/docs

1 file changed

+151
-0
lines changed

‎lib/node_modules/@stdlib/lapack/base/dlatrs/docs/repl.txt‎

Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
2+
{{alias}}( order, uplo, trans, diag, normin, N, A, LDA, X, CNORM )
3+
Solves a triangular system of linear equations with a scaling factor
4+
to prevent overflow. It can handle either the original system or its
5+
transpose.
6+
7+
Indexing is relative to the first index. To introduce an offset, use typed
8+
array views.
9+
10+
Parameters
11+
----------
12+
order: string
13+
Row-major (C-style) or column-major (Fortran-style) order. Must be
14+
either 'row-major' or 'column-major'.
15+
16+
uplo: string
17+
Specifies whether to copy the upper or lower triangular/trapezoidal part
18+
of a matrix `A`.
19+
20+
trans: string
21+
Specifies whether `A` should be transposed, conjugate-transposed, or not
22+
transposed.
23+
24+
diag: string
25+
Specifies whether `A` has a unit diagonal.
26+
27+
normin: string
28+
Specifies whether `CNORM` has the column norms on entry or not, should
29+
be either `yes` or `no`.
30+
31+
N: integer
32+
Number of rows/columns in `A`.
33+
34+
A: Float64Array
35+
Input matrix `A`.
36+
37+
LDA: integer
38+
Stride of the first dimension of `A` (a.k.a., leading dimension of the
39+
matrix `A`).
40+
41+
X: Float64Array
42+
Input vector, stores the right hand side vector `B`, overwritten by the
43+
solution vector `X`.
44+
45+
CNORM: Float64Array
46+
Used to store the column norms of `A`, should have `N` elements.
47+
48+
Returns
49+
-------
50+
scale: number
51+
Scaling factor.
52+
53+
Examples
54+
--------
55+
> var A = new {{alias:@stdlib/array/float64}}( [ 4.0, 2.0, 0.0, 3.0 ] );
56+
> var X = new {{alias:@stdlib/array/float64}}( [ 10.0, 9.0 ] );
57+
> var CNORM = new {{alias:@stdlib/array/float64}}( 2 );
58+
> var ord = 'row-major';
59+
> var uplo = 'upper';
60+
> var tran = 'no-transpose';
61+
> var diag = 'non-unit';
62+
> {{alias}}( ord, uplo, tran, diag, 'no', 2, A, 2, X, CNORM )
63+
1.0
64+
> X
65+
<Float64Array>[ 1.0, 3.0 ]
66+
> CNORM
67+
<Float64Array>[ 0.0, 2.0 ]
68+
69+
70+
{{alias}}.ndarray( uplo,tran,dia,norm, N, A,sa1,sa2,oa, X,sx,ox, CNORM,sc,oc )
71+
Solves a triangular system of linear equations with a scaling factor
72+
to prevent overflow using alternative indexing semantics. It can handle
73+
either the original system or its transpose.
74+
75+
While typed array views mandate a view offset based on the underlying
76+
buffer, the offset parameters support indexing semantics based on starting
77+
indices.
78+
79+
Parameters
80+
----------
81+
uplo: string
82+
Specifies whether to copy the upper or lower triangular/trapezoidal part
83+
of a matrix `A`.
84+
85+
tran: string
86+
Specifies whether `A` should be transposed, conjugate-transposed, or not
87+
transposed.
88+
89+
dia: string
90+
Specifies whether `A` has a unit diagonal.
91+
92+
norm: string
93+
Specifies whether `CNORM` has the column norms on entry or not, should
94+
be either `yes` or `no`.
95+
96+
N: integer
97+
Number of rows/columns in `A`.
98+
99+
A: Float64Array
100+
Input matrix `A`.
101+
102+
sa1: integer
103+
Stride of the first dimension of `A`.
104+
105+
sa2: integer
106+
Stride of the second dimension of `A`.
107+
108+
oa: integer
109+
Starting index for `A`.
110+
111+
X: Float64Array
112+
Input vector, stores the right hand side vector `B`, overwritten by the
113+
solution vector `X`.
114+
115+
sx: integer
116+
Index increment for `X`.
117+
118+
ox: integer
119+
Starting index for `X`.
120+
121+
CNORM: Float64Array
122+
Used to store the column norms of `A`, should have `N` elements.
123+
124+
sc: integer
125+
Index increment for `CNORM`.
126+
127+
oc: integer
128+
Starting index for `CNORM`.
129+
130+
Returns
131+
-------
132+
scale: number
133+
Scaling factor.
134+
135+
Examples
136+
--------
137+
> var A = new {{alias:@stdlib/array/float64}}( [ 4.0, 2.0, 0.0, 3.0 ] );
138+
> var X = new {{alias:@stdlib/array/float64}}( [ 10.0, 9.0 ] );
139+
> var CNORM = new {{alias:@stdlib/array/float64}}( 2 );
140+
> var uplo = 'upper';
141+
> var tran = 'no-transpose';
142+
> var diag = 'non-unit';
143+
> {{alias}}.ndarray( uplo,tran,diag, 'no', 2, A, 2,1,0, X,1,0, CNORM,1,0 )
144+
1.0
145+
> X
146+
<Float64Array>[ 1.0, 3.0 ]
147+
> CNORM
148+
<Float64Array>[ 0.0, 2.0 ]
149+
150+
See Also
151+
--------

0 commit comments

Comments
 (0)