Skip to content

Commit 765c46e

Browse files
authored
docs: rename parameters
Signed-off-by: Athan <[email protected]>
1 parent 3a6aa9d commit 765c46e

File tree

1 file changed

+10
-13
lines changed
  • lib/node_modules/@stdlib/lapack/base/dlarfb/docs

1 file changed

+10
-13
lines changed

lib/node_modules/@stdlib/lapack/base/dlarfb/docs/repl.txt

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,21 @@
11

2-
{{alias}}( o, si, tr, dir, sto, M, N, K, V, LDV, T, LDT, C, LDC, W, LDWORK )
2+
{{alias}}( o, si, tr, dir, sto, M, N, K, V, LDV, T, LDT, C, LDC, WORK, LDW )
33
Applies a real block reflector `H` or its transpose `H^T` to a real `M` by
44
`N` matrix `C`, from either the left or the right.
55

66
Indexing is relative to the first index. To introduce an offset, use typed
77
array views.
88

9-
The function applies the block reflector `H` to matrix `C` according to the
10-
specified parameters. The `si` parameter determines whether the
11-
transformation is applied from the left (`C = H*C` or `C = H^T*C`) or from
12-
the right (`C = C*H` or `C = C*H^T`).
13-
149
Parameters
1510
----------
1611
o: string
1712
Row-major (C-style) or column-major (Fortran-style) order. Must be
1813
either 'row-major' or 'column-major'.
1914

2015
si: string
21-
Specifies whether `H` or `H^T` is applied from the left or right.
22-
Must be either 'left' or 'right'.
16+
Specifies whether `H` or `H^T` is applied from the left (`C = H*C` or
17+
`C = H^T*C`) or right (`C = C*H` or `C = C*H^T`). Must be either 'left'
18+
or 'right'.
2319

2420
tr: string
2521
Specifies whether to apply `H` or `H^T`. Must be either
@@ -60,11 +56,11 @@
6056
LDC: integer
6157
Leading dimension of `C`.
6258

63-
W: Float64Array
59+
WORK: Float64Array
6460
Work array.
6561

66-
LDWORK: integer
67-
Leading dimension of `W`.
62+
LDW: integer
63+
Leading dimension of `WORK`.
6864

6965
Returns
7066
-------
@@ -98,8 +94,9 @@
9894
Parameters
9995
----------
10096
si: string
101-
Specifies whether `H` or `H^T` is applied from the left or right.
102-
Must be either 'left' or 'right'.
97+
Specifies whether `H` or `H^T` is applied from the left (`C = H*C` or
98+
`C = H^T*C`) or right (`C = C*H` or `C = C*H^T`). Must be either 'left'
99+
or 'right'.
103100

104101
tr: string
105102
Specifies whether to apply `H` or `H^T`. Must be either

0 commit comments

Comments
 (0)