Skip to content

Commit 871bf32

Browse files
committed
Update docstring
1 parent 84d2c87 commit 871bf32

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

src/symmetriceigen.jl

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -140,14 +140,18 @@ end
140140
Return the eigenvalues of `A`.
141141
142142
`alg` specifies which algorithm and LAPACK method to use for eigenvalue decomposition:
143-
- `alg = DivideAndConquer()` (default): Calls `LAPACK.syevd!`.
143+
- `alg = DivideAndConquer()`: Calls `LAPACK.syevd!`.
144144
- `alg = QRIteration()`: Calls `LAPACK.syev!`.
145-
- `alg = RobustRepresentations()`: Multiple relatively robust representations method, Calls `LAPACK.syevr!`.
145+
- `alg = RobustRepresentations()` (default): Multiple relatively robust representations method, Calls `LAPACK.syevr!`.
146146
147147
See James W. Demmel et al, SIAM J. Sci. Comput. 30, 3, 1508 (2008) for
148148
a comparison of the accuracy and performance of different methods.
149149
150150
The default `alg` used may change in the future.
151+
152+
!!! compat "Julia 1.12"
153+
The `alg` keyword argument requires Julia 1.12 or later.
154+
151155
"""
152156
function eigvals(A::RealHermSymComplexHerm; alg::Algorithm = default_eigen_alg(A), sortby::Union{Function,Nothing}=nothing)
153157
S = eigtype(eltype(A))

0 commit comments

Comments
 (0)