Refine documentation (#69)

* add a definition to the retraction documentation. * elaborate on the geodesic. * move abstract approximate retractions to base. * Refactor for better docs. * fix a typo and clarify what the differential is. * Apply suggestions from code review * Document what parallel transport is Co-authored-by: Mateusz Baran <[email protected]>
JuliaManifolds · May 23, 2021 · 194e27e · 194e27e · kellertuer · May 23, 2021
1 parent a805e8e
commit 194e27e
Show file tree

Hide file tree

Showing 9 changed files with 541 additions and 383 deletions.
diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "ManifoldsBase"
 uuid = "3362f125-f0bb-47a3-aa74-596ffd7ef2fb"
 authors = ["Seth Axen <[email protected]>", "Mateusz Baran <[email protected]>", "Ronny Bergmann <[email protected]>", "Antoine Levitt <[email protected]>"]
-version = "0.11.2"
+version = "0.11.3"
 
 [deps]
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"

diff --git a/src/DecoratorManifold.jl b/src/DecoratorManifold.jl
@@ -565,6 +565,21 @@ decorated_manifold(M::AbstractManifold) = M.manifold
     m::LogarithmicInverseRetraction,
 )
 
+@decorator_transparent_signature inverse_retract(
+    M::AbstractDecoratorManifold,
+    p,
+    q,
+    m::NLsolveInverseRetraction,
+)
+
+@decorator_transparent_signature inverse_retract!(
+    M::AbstractDecoratorManifold,
+    X,
+    p,
+    q,
+    m::NLsolveInverseRetraction,
+)
+
 @decorator_transparent_signature isapprox(M::AbstractDecoratorManifold, p, q; kwargs...)
 @decorator_transparent_signature isapprox(M::AbstractDecoratorManifold, p, X, Y; kwargs...)