Skip to content

Commit 39a7e3c

Browse files
inkydragonCNOT
andauthored
docs: fix unexported function names in svd doc (#1151)
> QRIteration() is not exported, so I updated the svd.jl documentation section that suggests such a method exists for the `svd` function. Now it says to use `alg = LinearAlgebra.QRIteration()` instead of `alg = QRIteration()` which would produce an error before. ```jl julia> VERSION v"1.11.2" julia> using LinearAlgebra julia> DivideAndConquer ERROR: UndefVarError: `DivideAndConquer` not defined in `Main` Suggestion: check for spelling errors or missing imports. julia> QRIteration ERROR: UndefVarError: `QRIteration` not defined in `Main` Suggestion: check for spelling errors or missing imports. julia> LinearAlgebra.DivideAndConquer LinearAlgebra.DivideAndConquer julia> LinearAlgebra.QRIteration LinearAlgebra.QRIteration ``` Moved from JuliaLang/julia#56611 --------- Signed-off-by: Chengyu HAN <cyhan.dev@outlook.com> Co-authored-by: Ali Hamed Moosavian <sahmosavian@gmail.com>
1 parent 1137b4c commit 39a7e3c

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

src/svd.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -150,8 +150,8 @@ and `V` is ``N \\times N``, while in the thin factorization `U` is ``M
150150
number of singular values.
151151
152152
`alg` specifies which algorithm and LAPACK method to use for SVD:
153-
- `alg = DivideAndConquer()` (default): Calls `LAPACK.gesdd!`.
154-
- `alg = QRIteration()`: Calls `LAPACK.gesvd!` (typically slower but more accurate) .
153+
- `alg = LinearAlgebra.DivideAndConquer()` (default): Calls `LAPACK.gesdd!`.
154+
- `alg = LinearAlgebra.QRIteration()`: Calls `LAPACK.gesvd!` (typically slower but more accurate) .
155155
156156
!!! compat "Julia 1.3"
157157
The `alg` keyword argument requires Julia 1.3 or later.

0 commit comments

Comments
 (0)