From 151e152207cca425a099045c43f8039e697c5e36 Mon Sep 17 00:00:00 2001 From: Ronny Bergmann Date: Wed, 11 Oct 2023 11:35:13 +0200 Subject: [PATCH] Fix documentation. --- src/TangentSpace.jl | 19 +++++++++++++++++++ src/retractions.jl | 2 +- 2 files changed, 20 insertions(+), 1 deletion(-) diff --git a/src/TangentSpace.jl b/src/TangentSpace.jl index e137e2fe..f08f3bbf 100644 --- a/src/TangentSpace.jl +++ b/src/TangentSpace.jl @@ -17,6 +17,25 @@ const TangentSpace{𝔽,M} = Fiber{𝔽,TangentSpaceType,M} where {𝔽,M<:Abstr TangentSpace(M::AbstractManifold, p) = Fiber(M, p, TangentSpaceType()) +@doc raw""" + CotangentSpace{𝔽,M} = Fiber{𝔽,CotangentSpaceType,M} where {𝔽,M<:AbstractManifold{𝔽}} + +A manifold for the Cotangent space ``T^*_p\mathcal M`` at a point ``p\in\mathcal M``. +This is modelled as an alias for [`VectorSpaceFiber`](@ref) corresponding to +[`CotangentSpaceType`](@ref). + +# Constructor + + CotangentSpace(M::AbstractManifold, p) + +Return the manifold (vector space) representing the cotangent space ``T^*_p\mathcal M`` +at point `p`, ``p\in\mathcal M``. +""" +const CotangentSpace{𝔽,M} = Fiber{𝔽,CotangentSpaceType,M} where {𝔽,M<:AbstractManifold{𝔽}} + +CotangentSpace(M::AbstractManifold, p) = Fiber(M, p, CotangentSpaceType()) + + function allocate_result(M::TangentSpace, ::typeof(rand)) return zero_vector(M.manifold, M.point) end diff --git a/src/retractions.jl b/src/retractions.jl index 5e68440d..6721511e 100644 --- a/src/retractions.jl +++ b/src/retractions.jl @@ -177,7 +177,7 @@ end @doc raw""" struct SasakiRetraction <: AbstractRetractionMethod end -Exponential map on [`TangentBundle`](@ref) computed via Euler integration as described +Exponential map on [`TangentBundle`](https://juliamanifolds.github.io/Manifolds.jl/stable/manifolds/vector_bundle.html#Manifolds.TangentBundle) computed via Euler integration as described in [MuralidharanFletcher:2012](@cite). The system of equations for ``\gamma : ℝ \to T\mathcal M`` such that ``\gamma(1) = \exp_{p,X}(X_M, X_F)`` and ``\gamma(0)=(p, X)`` reads