Skip to content

Commit f590514

Browse files
committed
docs update
1 parent e19e9de commit f590514

2 files changed

Lines changed: 6 additions & 7 deletions

File tree

docs/src/user_interface/decompositions.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ The following algorithms are available for the hermitian eigenvalue decompositio
8181

8282
```@autodocs; canonical=false
8383
Modules = [MatrixAlgebraKit]
84-
Filter = t -> t isa Type && t <: MatrixAlgebraKit.LAPACK_EighAlgorithm
84+
Filter = t -> t isa Type && t <: MatrixAlgebraKit.EighAlgorithm
8585
```
8686

8787
### Eigenvalue Decomposition
@@ -103,7 +103,7 @@ The following algorithms are available for the standard eigenvalue decomposition
103103

104104
```@autodocs; canonical=false
105105
Modules = [MatrixAlgebraKit]
106-
Filter = t -> t isa Type && t <: MatrixAlgebraKit.LAPACK_EigAlgorithm
106+
Filter = t -> t isa Type && t <: MatrixAlgebraKit.EigAlgorithm
107107
```
108108

109109
## Schur Decomposition
@@ -123,7 +123,7 @@ The following algorithms are available for the Schur decomposition:
123123

124124
```@autodocs; canonical=false
125125
Modules = [MatrixAlgebraKit]
126-
Filter = t -> t isa Type && t <: MatrixAlgebraKit.LAPACK_EigAlgorithm
126+
Filter = t -> t isa Type && t <: MatrixAlgebraKit.EigAlgorithm
127127
```
128128

129129
## Singular Value Decomposition

src/interface/decompositions.jl

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -118,9 +118,8 @@ See also [`DivideAndConquer`](@ref) and [`QRIteration`](@ref).
118118
"""
119119
QRIteration(; [driver], fixgauge = default_fixgauge(), balanced = false)
120120
121-
Algorithm type for computing the eigenvalue decomposition of a Hermitian matrix,
122-
the singular value decomposition of a general matrix, the non-Hermitian eigenvalue
123-
decomposition, or the Schur decomposition of a general matrix via QR iteration.
121+
Algorithm type for computing the eigenvalue, Schur or singular value decomposition of a matrix via QR iteration.
122+
124123
125124
For non-Hermitian eigenvalue decomposition and Schur decomposition, the `balanced`
126125
keyword argument can be used to enable balancing of the matrix before the QR iteration,
@@ -129,6 +128,7 @@ which can improve numerical accuracy for badly scaled matrices:
129128
- `balanced = true`: use the expert balanced driver (`geevx!`/`geesx!`)
130129
131130
$_fixgauge_docs
131+
132132
The optional `driver` keyword can be used to choose between different implementations of this algorithm.
133133
"""
134134
@algdef QRIteration
@@ -165,7 +165,6 @@ $_fixgauge_docs
165165
The optional `driver` keyword can be used to choose between different implementations of this algorithm.
166166
"""
167167
@algdef RobustRepresentations
168-
Base.@deprecate_binding MultipleRelativelyRobustRepresentations RobustRepresentations false
169168

170169
"""
171170
SVDViaPolar(; [driver], fixgauge = default_fixgauge(), [tol])

0 commit comments

Comments
 (0)