File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -116,20 +116,23 @@ See also [`DivideAndConquer`](@ref) and [`QRIteration`](@ref).
116116@algdef SafeDivideAndConquer
117117
118118"""
119- QRIteration(; [driver], fixgauge = default_fixgauge(), balanced = false )
119+ QRIteration(; [driver], fixgauge = default_fixgauge(), kwargs... )
120120
121121Algorithm type for computing the eigenvalue, Schur or singular value decomposition of a matrix via QR iteration.
122122
123+ ## Keyword arguments
123124
124- For non-Hermitian eigenvalue decomposition and Schur decomposition, the `balanced`
125- keyword argument can be used to enable balancing of the matrix before the QR iteration,
126- which can improve numerical accuracy for badly scaled matrices:
127- - `balanced = false` (default): use the simple driver (`geev!`/`gees!`)
128- - `balanced = true`: use the expert balanced driver (`geevx!`/`geesx!`)
125+ Various customizations are available, depending on the type of decomposition this algorithm is used for.
129126
127+ For Schur decompositions, `expert = false` can be used to switch between `gees` and `geesx`.
128+
129+ For non-Hermitian eigenvalue decompositions there is `permute = true` and `scale = true` to control whether
130+ or not to balance the input matrix before starting the QR iterations.
131+
132+ For SVD and eigenvalue decompositions, there is residual freedom in the outputs that can be resolved.
130133$_fixgauge_docs
131134
132- The optional `driver` keyword can be used to choose between different implementations of this algorithm.
135+ In all cases, the optional `driver` keyword can be used to choose between different implementations of this algorithm.
133136"""
134137@algdef QRIteration
135138
You can’t perform that action at this time.
0 commit comments