Skip to content

Commit

Permalink
Fix documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
kellertuer committed Oct 19, 2024
1 parent 1128329 commit ff0a56a
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 3 deletions.
5 changes: 5 additions & 0 deletions src/documentation_glossary.jl
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,11 @@ define!(
:AbstractManifold,
"[`AbstractManifold`](@extref `ManifoldsBase.AbstractManifold`)",
)
define!(
:Link,
:AbstractPowerManifold,
"[`AbstractPowerManifold`](@extref `ManifoldsBase.AbstractPowerManifold`)",
)
define!(
:Link,
:injectivity_radius,
Expand Down
6 changes: 3 additions & 3 deletions src/plans/stopping_criterion.jl
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,7 @@ $(_var(:Field, :storage))
# Example
On an [`AbstractPowerManifold`](@extref) like ``$(_math(:M)) = $(_math(:M; M="N"))^n``
On an $(_link(:AbstractPowerManifold)) like ``$(_math(:M)) = $(_math(:M; M="N"))^n``
any point ``p = (p_1,…,p_n) ∈ $(_math(:M))`` is a vector of length ``n`` with of points ``p_i ∈ $(_math(:M; M="N"))``.
Then, denoting the `outer_norm` by ``r``, the distance of two points ``p,q ∈ $(_math(:M))``
is given by
Expand Down Expand Up @@ -486,7 +486,7 @@ $(_var(:Field, :storage))
# Example
On an [`AbstractPowerManifold`](@extref) like ``$(_math(:M)) = $(_math(:M; M="N"))^n``
On an $(_link(:AbstractPowerManifold)) like ``$(_math(:M)) = $(_math(:M; M="N"))^n``
any point ``p = (p_1,…,p_n) ∈ $(_math(:M))`` is a vector of length ``n`` with of points ``p_i ∈ $(_math(:M; M="N"))``.
Then, denoting the `outer_norm` by ``r``, the norm of the difference of tangent vectors like the last and current gradien ``X,Y ∈ $(_math(:M))``
is given by
Expand Down Expand Up @@ -615,7 +615,7 @@ A stopping criterion based on the current gradient norm.
# Example
On an [`AbstractPowerManifold`](@extref) like ``$(_math(:M)) = $(_math(:M; M="N"))^n``
On an $(_link(:AbstractPowerManifold)) like ``$(_math(:M)) = $(_math(:M; M="N"))^n``
any point ``p = (p_1,…,p_n) ∈ $(_math(:M))`` is a vector of length ``n`` with of points ``p_i ∈ $(_math(:M; M="N"))``.
Then, denoting the `outer_norm` by ``r``, the norm of a tangent vector like the current gradient ``X ∈ $(_math(:M))``
is given by
Expand Down

0 comments on commit ff0a56a

Please sign in to comment.