rename function

JuliaManifolds · Jan 10, 2025 · d2271c5 · d2271c5
1 parent 6a8bbf5
commit d2271c5
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 13 deletions.
diff --git a/docs/src/misc/internals.md b/docs/src/misc/internals.md
@@ -6,7 +6,7 @@ This page documents the internal types and methods of `Manifolds.jl`'s that migh
 
 ```@docs
 Manifolds.eigen_safe
-Manifolds.get_parameter_arg
+Manifolds.get_parameter_type
 Manifolds.isnormal
 Manifolds.log_safe
 Manifolds.log_safe!

diff --git a/src/Manifolds.jl b/src/Manifolds.jl
@@ -371,7 +371,7 @@ include("utils.jl")
 include("manifold_fallbacks.jl")
 
 """
-    get_parameter_arg(M::AbstractManifold)
+    get_parameter_type(M::AbstractManifold)
 
 Get `parameter` argument of the constructor of manifold `M`.
 Returns either `:field` or `:type`.
@@ -380,7 +380,7 @@ Returns either `:field` or `:type`.
 
 `get_parameter`, `TypeParameter`
 """
-get_parameter_arg(::AbstractManifold)
+get_parameter_type(::AbstractManifold)
 
 """
     projected_distribution(M::AbstractManifold, d, [p=rand(d)])

diff --git a/src/manifolds/SymmetricPositiveDefinite.jl b/src/manifolds/SymmetricPositiveDefinite.jl
@@ -236,8 +236,8 @@ function get_embedding(M::SymmetricPositiveDefinite{Tuple{Int}})
     return Euclidean(n, n; field=ℝ, parameter=:field)
 end
 
-get_parameter_arg(::SymmetricPositiveDefinite{<:TypeParameter}) = :type
-get_parameter_arg(::SymmetricPositiveDefinite{Tuple{Int}}) = :field
+get_parameter_type(::SymmetricPositiveDefinite{<:TypeParameter}) = :type
+get_parameter_type(::SymmetricPositiveDefinite{Tuple{Int}}) = :field
 
 @doc raw"""
     injectivity_radius(M::SymmetricPositiveDefinite[, p])

diff --git a/src/manifolds/SymmetricPositiveDefiniteLogCholesky.jl b/src/manifolds/SymmetricPositiveDefiniteLogCholesky.jl
@@ -38,7 +38,7 @@ and ``\lVert⋅\rVert_{\mathrm{F}}`` the Frobenius norm.
 function distance(M::MetricManifold{ℝ,<:SymmetricPositiveDefinite,LogCholeskyMetric}, p, q)
     N = get_parameter(M.manifold.size)[1]
     return distance(
-        CholeskySpace(N; parameter=get_parameter_arg(M.manifold)),
+        CholeskySpace(N; parameter=get_parameter_type(M.manifold)),
         cholesky(p).L,
         cholesky(q).L,
     )
@@ -64,7 +64,7 @@ exp(::MetricManifold{ℝ,SymmetricPositiveDefinite,LogCholeskyMetric}, ::Any...)
 function exp!(M::MetricManifold{ℝ,<:SymmetricPositiveDefinite,LogCholeskyMetric}, q, p, X)
     N = get_parameter(M.manifold.size)[1]
     (y, W) = spd_to_cholesky(p, X)
-    z = exp(CholeskySpace(N; parameter=get_parameter_arg(M.manifold)), y, W)
+    z = exp(CholeskySpace(N; parameter=get_parameter_type(M.manifold)), y, W)
     return copyto!(q, z * z')
 end
 function exp!(
@@ -85,7 +85,7 @@ function get_coordinates_orthonormal!(
     rn::RealNumbers,
 )
     N = get_parameter(M.manifold.size)[1]
-    MC = CholeskySpace(N; parameter=get_parameter_arg(M.manifold))
+    MC = CholeskySpace(N; parameter=get_parameter_type(M.manifold))
     (y, W) = spd_to_cholesky(p, X)
     get_coordinates_orthonormal!(MC, Xⁱ, y, W, rn)
     return Xⁱ
@@ -99,7 +99,7 @@ function get_vector_orthonormal!(
     rn::RealNumbers,
 )
     N = get_parameter(M.manifold.size)[1]
-    MC = CholeskySpace(N; parameter=get_parameter_arg(M.manifold))
+    MC = CholeskySpace(N; parameter=get_parameter_type(M.manifold))
     y = cholesky(p).L
     get_vector_orthonormal!(MC, X, y, Xⁱ, rn)
     tangent_cholesky_to_tangent_spd!(p, X)
@@ -126,7 +126,7 @@ function inner(M::MetricManifold{ℝ,<:SymmetricPositiveDefinite,LogCholeskyMetr
     N = get_parameter(M.manifold.size)[1]
     (z, Xz) = spd_to_cholesky(p, X)
     (z, Yz) = spd_to_cholesky(p, z, Y)
-    return inner(CholeskySpace(N; parameter=get_parameter_arg(M.manifold)), z, Xz, Yz)
+    return inner(CholeskySpace(N; parameter=get_parameter_type(M.manifold)), z, Xz, Yz)
 end
 
 """
@@ -155,7 +155,7 @@ function log!(M::MetricManifold{ℝ,<:SymmetricPositiveDefinite,LogCholeskyMetri
     N = get_parameter(M.manifold.size)[1]
     x = cholesky(p).L
     y = cholesky(q).L
-    log!(CholeskySpace(N; parameter=get_parameter_arg(M.manifold)), X, x, y)
+    log!(CholeskySpace(N; parameter=get_parameter_type(M.manifold)), X, x, y)
     return tangent_cholesky_to_tangent_spd!(x, X)
 end
 
@@ -198,7 +198,7 @@ function parallel_transport_to!(
     y = cholesky(q).L
     (x, W) = spd_to_cholesky(p, X)
     parallel_transport_to!(
-        CholeskySpace(N; parameter=get_parameter_arg(M.manifold)),
+        CholeskySpace(N; parameter=get_parameter_type(M.manifold)),
         Y,
         x,
         W,

diff --git a/test/manifolds/symmetric_positive_definite.jl b/test/manifolds/symmetric_positive_definite.jl
@@ -312,7 +312,7 @@ include("../header.jl")
         M = SymmetricPositiveDefinite(3; parameter=:field)
         @test typeof(get_embedding(M)) === Euclidean{Tuple{Int,Int},ℝ}
         @test repr(M) == "SymmetricPositiveDefinite(3; parameter=:field)"
-        @test Manifolds.get_parameter_arg(M) === :field
+        @test Manifolds.get_parameter_type(M) === :field
     end
 
     @testset "Curvature" begin