rename SVDViaPolar

Author: lkdvos

src/MatrixAlgebraKit.jl

@@ -32,7 +32,7 @@ export left_orth, right_orth, left_null, right_null
 export left_orth!, right_orth!, left_null!, right_null!
 
 export Householder, Native_HouseholderQR, Native_HouseholderLQ
-export DivideAndConquer, SafeDivideAndConquer, QRIteration, Bisection, Jacobi, SVDPolar
+export DivideAndConquer, SafeDivideAndConquer, QRIteration, Bisection, Jacobi, SVDViaPolar
 export LAPACK_HouseholderQR, LAPACK_HouseholderLQ, LAPACK_Simple, LAPACK_Expert,
     LAPACK_QRIteration, LAPACK_Bisection, LAPACK_MultipleRelativelyRobustRepresentations,
     LAPACK_DivideAndConquer, LAPACK_Jacobi, LAPACK_SafeDivideAndConquer

src/implementations/svd.jl

@@ -147,7 +147,7 @@ for (f, f_lapack!, Alg) in (
         (:qr_iteration, :gesvd!, :QRIteration),
         (:bisection, :gesvdx!, :Bisection),
         (:jacobi, :gesvdj!, :Jacobi),
-        (:svd_polar, :gesvdp!, :SVDPolar),
+        (:svd_polar, :gesvdp!, :SVDViaPolar),
     )
     f_svd! = Symbol(f, :_svd!)
     f_svd_full! = Symbol(f, :_svd_full!)
@@ -376,7 +376,7 @@ end
 for (algtype, newtype, drivertype) in (
         (:CUSOLVER_QRIteration, :QRIteration, :CUSOLVER),
         (:CUSOLVER_Jacobi, :Jacobi, :CUSOLVER),
-        (:CUSOLVER_SVDPolar, :SVDPolar, :CUSOLVER),
+        (:CUSOLVER_SVDPolar, :SVDViaPolar, :CUSOLVER),
         (:ROCSOLVER_QRIteration, :QRIteration, :ROCSOLVER),
         (:ROCSOLVER_Jacobi, :Jacobi, :ROCSOLVER),
     )

src/interface/decompositions.jl

@@ -161,7 +161,7 @@ The `fixgauge` keyword can be used to toggle whether or not to fix the gauge of
 @algdef Jacobi
 
 """
-    SVDPolar(; [driver], kwargs...)
+    SVDViaPolar(; [driver], kwargs...)
 
 Algorithm type to denote the algorithm for computing the singular value decomposition of a general
 matrix via Halley's iterative algorithm for the polar decomposition followed by the Hermitian
@@ -170,7 +170,7 @@ eigenvalue decomposition of the positive definite factor.
 The optional `driver` symbol can be used to choose between different implementations of this algorithm.
 The `fixgauge` keyword can be used to toggle whether or not to fix the gauge of the eigen or singular vectors, see also [`gaugefix!`](@ref).
 """
-@algdef SVDPolar
+@algdef SVDViaPolar
 
 for f in (:safe_divide_and_conquer, :divide_and_conquer, :qr_iteration, :bisection, :jacobi, :svd_polar)
     default_f_driver = Symbol(:default_, f, :_driver)

test/linearmap.jl

@@ -38,7 +38,7 @@ module LinearMaps
     # Using AbstractAlgorithm here would be ambiguous since neither A-type nor alg-type would
     # be strictly more specific.
     for f! in (:svd_compact!, :svd_full!)
-        for Alg in (:SafeDivideAndConquer, :DivideAndConquer, :QRIteration, :Bisection, :Jacobi, :SVDPolar)
+        for Alg in (:SafeDivideAndConquer, :DivideAndConquer, :QRIteration, :Bisection, :Jacobi, :SVDViaPolar)
             @eval MAK.$f!(A::LinearMap, USVᴴ, alg::MAK.$Alg) =
                 LinearMap.(MAK.$f!(parent(A), parent.(USVᴴ), alg))
         end