@@ -67,7 +67,6 @@ of `R` are non-negative.
6767 Householder(; [driver], kwargs...)
6868
6969Algorithm type to denote the algorithm for computing QR, RQ, QL or LQ decompositions of a matrix using Householder reflectors.
70- The optional `driver` symbol can be used to choose between different implementations of this algorithm.
7170
7271### Keyword arguments
7372
@@ -76,6 +75,7 @@ The optional `driver` symbol can be used to choose between different implementat
7675- `blocksize::Int` : Use a blocked version of the algorithm if `blocksize > 1`. Use the default if `blocksize ≤ 0`.
7776
7877Depending on the driver, various other keywords may be (un)available to customize the implementation.
78+ The optional `driver` keyword can be used to choose between different implementations of this algorithm.
7979"""
8080@algdef Householder
8181function Householder (;
9191Algorithm type to denote the algorithm for computing the eigenvalue decomposition of a Hermitian matrix,
9292or the singular value decomposition of a general matrix using the divide-and-conquer algorithm.
9393
94- The optional `driver` symbol can be used to choose between different implementations of this algorithm.
9594$_fixgauge_docs
95+ The optional `driver` keyword can be used to choose between different implementations of this algorithm.
9696"""
9797@algdef DivideAndConquer
9898
@@ -103,8 +103,8 @@ Algorithm type to for computing the eigenvalue decomposition of a Hermitian matr
103103or the singular value decomposition of a general matrix using the divide-and-conquer algorithm,
104104with an additional fallback to the standard QR iteration algorithm in case the former fails to converge.
105105
106- The optional `driver` symbol can be used to choose between different implementations of this algorithm.
107106$_fixgauge_docs
107+ The optional `driver` keyword can be used to choose between different implementations of this algorithm.
108108
109109!!! warning
110110 This approach requires a copy of the input matrix, and is thus the most memory intensive SVD strategy.
@@ -121,8 +121,8 @@ See also [`DivideAndConquer`](@ref) and [`QRIteration`](@ref).
121121Algorithm type for computing the eigenvalue decomposition of a Hermitian matrix,
122122or the singular value decomposition of a general matrix via QR iteration.
123123
124- The optional `driver` symbol can be used to choose between different implementations of this algorithm.
125124$_fixgauge_docs
125+ The optional `driver` keyword can be used to choose between different implementations of this algorithm.
126126"""
127127@algdef QRIteration
128128
@@ -132,8 +132,8 @@ $_fixgauge_docs
132132Algorithm type for computing the eigenvalue decomposition of a Hermitian matrix,
133133or the singular value decomposition of a general matrix via the bisection algorithm.
134134
135- The optional `driver` symbol can be used to choose between different implementations of this algorithm.
136135$_fixgauge_docs
136+ The optional `driver` keyword can be used to choose between different implementations of this algorithm.
137137"""
138138@algdef Bisection
139139
@@ -142,8 +142,8 @@ $_fixgauge_docs
142142
143143Algorithm type for computing the singular value decomposition of a general matrix using the Jacobi algorithm.
144144
145- The optional `driver` symbol can be used to choose between different implementations of this algorithm.
146145$_fixgauge_docs
146+ The optional `driver` keyword can be used to choose between different implementations of this algorithm.
147147"""
148148@algdef Jacobi
149149
@@ -154,9 +154,9 @@ Algorithm type to denote the algorithm for computing the singular value decompos
154154matrix via Halley's iterative algorithm for the polar decomposition followed by the Hermitian
155155eigenvalue decomposition of the positive definite factor.
156156
157- The optional `driver` symbol can be used to choose between different implementations of this algorithm.
158157$_fixgauge_docs
159158The tolerance `tol` can optionally be used to emit a warning if the decomposition failed to converge beyond that given value.
159+ The optional `driver` keyword can be used to choose between different implementations of this algorithm.
160160"""
161161@algdef SVDViaPolar
162162
0 commit comments