Skip to content

Commit d765274

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 9bdf5a8 commit d765274

File tree

1 file changed

+116
-0
lines changed
  • lib/node_modules/@stdlib/lapack/base/dlarf1f/docs

1 file changed

+116
-0
lines changed
Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
2+
{{alias}}( order, side, M, N, V, incv, tau, C, LDC, work )
3+
Applies a real elementary reflector `H = I - tau * v * v ^ T`
4+
to a real M by N matrix `C`.
5+
6+
Parameters
7+
----------
8+
order: string
9+
Storage layout. Must be either 'row-major' or 'column-major'.
10+
11+
side: string
12+
Specifies whether to form `H * C` ('left') or
13+
`C * H` ('right').
14+
15+
M: integer
16+
Number of rows in `C`.
17+
18+
N: integer
19+
Number of columns in `C`.
20+
21+
V: Float64Array
22+
The vector `v` in the representation of `H`.
23+
24+
incv: integer
25+
Stride length for `V`.
26+
27+
tau: number
28+
The value of `tau` in representation of `H`.
29+
30+
C: Float64Array
31+
Input matrix.
32+
33+
LDC: integer
34+
Stride of the first dimension of `C` (a.k.a., leading
35+
dimension of the matrix `C`).
36+
37+
work: Float64Array
38+
Workspace array.
39+
40+
Returns
41+
-------
42+
C: Float64Array
43+
Output matrix.
44+
45+
Examples
46+
--------
47+
> var C = new {{alias:@stdlib/array/float64}}( [ 1.0, 3.0, 2.0, 4.0 ] );
48+
> var V = new {{alias:@stdlib/array/float64}}( [ 0.5, 0.5 ] );
49+
> var work = new {{alias:@stdlib/array/float64}}( 2 );
50+
> {{alias}}( 'row-major', 'left', 2, 2, V, 1, 1.0, C, 2, work )
51+
<Float64Array>[ -1.0, -2.0, 1.0, 1.5 ]
52+
53+
54+
{{alias}}.ndarray( side, M, N, V, sv, ov, tau, C, sc1, sc2, oc, work, sw, ow )
55+
Applies a real elementary reflector `H = I - tau * v * v ^ T`
56+
to a real M by N matrix `C` using alternative indexing semantics.
57+
58+
Parameters
59+
----------
60+
side: string
61+
Specifies whether to form `H * C` ('left') or `C * H` ('right').
62+
63+
M: integer
64+
Number of rows in `C`.
65+
66+
N: integer
67+
Number of columns in `C`.
68+
69+
V: Float64Array
70+
The vector `v` in the representation of `H`.
71+
72+
sv: integer
73+
Stride length for `V`.
74+
75+
ov: integer
76+
Starting index for `V`.
77+
78+
tau: number
79+
The value of `tau` in representation of `H`.
80+
81+
C: Float64Array
82+
Input matrix.
83+
84+
sc1: integer
85+
Stride of the first dimension of `C`.
86+
87+
sc2: integer
88+
Stride of the second dimension of `C`.
89+
90+
oc: integer
91+
Starting index for `C`.
92+
93+
work: Float64Array
94+
Workspace array.
95+
96+
sw: integer
97+
Stride length for `work`.
98+
99+
ow: integer
100+
Starting index for `work`.
101+
102+
Returns
103+
-------
104+
C: Float64Array
105+
Output matrix.
106+
107+
Examples
108+
--------
109+
> var C = new {{alias:@stdlib/array/float64}}( [ 1.0, 3.0, 2.0, 4.0 ] );
110+
> var V = new {{alias:@stdlib/array/float64}}( [ 0.5, 0.5 ] );
111+
> var work = new {{alias:@stdlib/array/float64}}( 2 );
112+
> {{alias}}.ndarray( 'left', 2, 2, V, 1, 0, 1.0, C, 2, 1, 0, work, 1, 0 )
113+
<Float64Array>[ -1.0, -2.0, 1.0, 1.5 ]
114+
115+
See Also
116+
--------

0 commit comments

Comments
 (0)