Skip to content

Commit 125c2f7

Browse files
DivitJain26DivitJain26
committed
docs: add repl file
--- 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: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 65a5fc8 commit 125c2f7

1 file changed

Lines changed: 166 additions & 0 deletions

File tree

  • lib/node_modules/@stdlib/blas/base/ctrsv/docs

‎lib/node_modules/@stdlib/blas/base/ctrsv/docs/repl.txt‎

Lines changed: 166 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
1+
2+
{{alias}}( order, uplo, trans, diag, N, A, lda, x, sx )
3+
Solves one of the systems of equations `A*x = b` or `A^T*x = b` or
4+
`A^H*x = b` where `b` and `x` are `N` element complex vectors and `A` is an
5+
`N` by `N` unit, or non-unit, upper or lower triangular complex matrix.
6+
7+
Indexing is relative to the first index. To introduce an offset, use typed
8+
array views.
9+
10+
If `N` is equal to `0`, the function returns `x` unchanged.
11+
12+
Parameters
13+
----------
14+
order: string
15+
Row-major (C-style) or column-major (Fortran-style) order. Must be
16+
either 'row-major' or 'column-major'.
17+
18+
uplo: string
19+
Specifies whether `A` is an upper or lower triangular banded matrix.
20+
21+
trans: string
22+
Specifies whether `A` should be transposed, conjugate-transposed, or not
23+
transposed. Accepted values typically include: 'no-transpose',
24+
'transpose', 'conjugate-transpose'.
25+
26+
diag: string
27+
Specifies whether `A` has a unit diagonal.
28+
29+
N: integer
30+
Number of elements along each dimension of `A`.
31+
32+
A: Complex64Array
33+
Input matrix.
34+
35+
lda: integer
36+
Stride of the first dimension of `A` (a.k.a., leading dimension of the
37+
matrix `A`).
38+
39+
x: Complex64Array
40+
Input vector.
41+
42+
sx: integer
43+
Stride length for `x`.
44+
45+
Returns
46+
-------
47+
x: Complex64Array
48+
Input vector.
49+
50+
Examples
51+
--------
52+
// Standard usage:
53+
> var x = new {{alias:@stdlib/array/complex64}}([1.0,1.0,2.0,2.0,3.0,3.0]);
54+
> var buf1 = [1.0,1.0,0.0,0.0,0.0,0.0];
55+
> var buf2 = [2.0,2.0,4.0,4.0,0.0,0.0];
56+
> var buf3 = [3.0,3.0,5.0,5.0,6.0,6.0];
57+
> var buf = buf1.concat( buf2, buf3 );
58+
> var A = new {{alias:@stdlib/array/complex64}}( buf );
59+
> var ord = 'row-major';
60+
> var uplo = 'lower';
61+
> var trans = 'no-transpose';
62+
> var diag = 'non-unit';
63+
> {{alias}}( ord, uplo, trans, diag, 3, A, 3, x, 1 )
64+
<Complex64Array>[ 1.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]
65+
66+
// Advanced indexing:
67+
> x = new {{alias:@stdlib/array/complex64}}([3.0,3.0,2.0,2.0,1.0,1.0]);
68+
> buf1 = [1.0,1.0,0.0,0.0,0.0,0.0];
69+
> buf2 = [2.0,2.0,4.0,4.0,0.0,0.0];
70+
> buf3 = [3.0,3.0,5.0,5.0,6.0,6.0];
71+
> buf = buf1.concat( buf2, buf3 );
72+
> A = new {{alias:@stdlib/array/complex64}}( buf );
73+
> ord = 'row-major';
74+
> uplo = 'lower';
75+
> trans = 'no-transpose';
76+
> diag = 'non-unit';
77+
> {{alias}}( ord, uplo, trans, diag, 3, A, 3, x, -1 )
78+
<Complex64Array>[ 0.0, 0.0, 0.0, 0.0, 1.0, 0.0 ]
79+
80+
// Using typed array views:
81+
> var x0buf = [0.0,0.0,1.0,1.0,2.0,2.0,3.0,3.0];
82+
> var x0 = new {{alias:@stdlib/array/complex64}}( x0buf );
83+
> var x0bytes = x0.BYTES_PER_ELEMENT*1;
84+
> var x1 = new {{alias:@stdlib/array/complex64}}( x0.buffer, x0bytes );
85+
> buf1 = [1.0,1.0,0.0,0.0,0.0,0.0];
86+
> buf2 = [2.0,2.0,4.0,4.0,0.0,0.0];
87+
> buf3 = [3.0,3.0,5.0,5.0,6.0,6.0];
88+
> buf = buf1.concat( buf2, buf3 );
89+
> A = new {{alias:@stdlib/array/complex64}}( buf );
90+
> ord = 'row-major';
91+
> uplo = 'lower';
92+
> trans = 'no-transpose';
93+
> diag = 'non-unit';
94+
> {{alias}}( ord, uplo, trans, diag, 3, A, 3, x1, 1 )
95+
<Complex64Array>[ 1.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]
96+
97+
98+
{{alias}}.ndarray( uplo, trans, diag, N, A, sa1, sa2, oa, x, sx, ox )
99+
Solves one of the systems of equations `A*x = b` or `A^T*x = b` or
100+
`A^H*x = b` using alternative indexing semantics and where `b` and `x` are
101+
`N` element complex vectors and `A` is an `N` by `N` unit, or non-unit,
102+
upper or lower triangular complex matrix.
103+
104+
While typed array views mandate a view offset based on the underlying buffer
105+
, the offset parameters support indexing semantics based on starting
106+
indices.
107+
108+
Parameters
109+
----------
110+
uplo: string
111+
Specifies whether `A` is an upper or lower triangular banded matrix.
112+
113+
trans: string
114+
Specifies whether `A` should be transposed, conjugate-transposed, or not
115+
transposed. Accepted values typically include: 'no-transpose',
116+
'transpose', 'conjugate-transpose'.
117+
118+
diag: string
119+
Specifies whether `A` has a unit diagonal.
120+
121+
N: integer
122+
Number of elements along each dimension of `A`.
123+
124+
A: Complex64Array
125+
Input matrix.
126+
127+
sa1: integer
128+
Stride of the first dimension of `A`.
129+
130+
sa2: integer
131+
Stride of the second dimension of `A`.
132+
133+
oa: integer
134+
Starting index (offset) for `A`.
135+
136+
x: Complex64Array
137+
Input vector.
138+
139+
sx: integer
140+
Index increment for `x`.
141+
142+
ox: integer
143+
Starting index (offset) for `x`.
144+
145+
Returns
146+
-------
147+
x: Complex64Array
148+
Input vector.
149+
150+
Examples
151+
--------
152+
> x = new {{alias:@stdlib/array/complex64}}([1.0,1.0,2.0,2.0,3.0,3.0]);
153+
> buf1 = [1.0,1.0,0.0,0.0,0.0,0.0];
154+
> buf2 = [2.0,2.0,4.0,4.0,0.0,0.0];
155+
> buf3 = [3.0,3.0,5.0,5.0,6.0,6.0];
156+
> buf = buf1.concat( buf2, buf3 );
157+
> A = new {{alias:@stdlib/array/complex64}}( buf );
158+
> ord = 'row-major';
159+
> uplo = 'lower';
160+
> trans = 'no-transpose';
161+
> diag = 'non-unit';
162+
> {{alias}}.ndarray( uplo, trans, diag, 3, A, 3, 1, 0, x, 1, 0 )
163+
<Complex64Array>[ 1.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]
164+
165+
See Also
166+
--------

0 commit comments

Comments
 (0)