Skip to content

Commit 3bee5cd

Browse files
committed
update docstrings
1 parent b3e19bb commit 3bee5cd

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

src/implementations/decompositions.jl

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ Algorithm type to denote the standard LAPACK algorithm for computing the QR deco
1616
a matrix using Householder reflectors. The specific LAPACK function can be controlled using
1717
the keyword arugments, i.e. `?geqrt` will be chosen if `blocksize > 1`. With
1818
`blocksize == 1`, `?geqrf` will be chosen if `pivoted == false` and `?geqp3` will be chosen
19-
if `pivoted == true`.
19+
if `pivoted == true`. The keyword `positive =true` can be used to ensure that the diagonal
20+
elements of `R` are non-negative.
2021
"""
2122
@algdef LAPACK_HouseholderQR
2223

@@ -25,8 +26,9 @@ if `pivoted == true`.
2526
2627
Algorithm type to denote the standard LAPACK algorithm for computing the LQ decomposition of
2728
a matrix using Householder reflectors. The specific LAPACK function can be controlled using
28-
the keyword arugments, i.e. `?gelqt` will be chosen if `blocksize > 1` or `?gelqf` will be
29-
chosen if `pivoted == false`.
29+
the keyword arugments, i.e. `?gelqt` will be chosen if `blocksize > 1` or `?gelqf` will be
30+
chosen if `blocksize == 1`. The keyword `positive =true` can be used to ensure that the diagonal
31+
elements of `L` are non-negative.
3032
"""
3133
@algdef LAPACK_HouseholderLQ
3234

0 commit comments

Comments
 (0)