Skip to content

Commit

Permalink
translate_diff documentation clarification (#746)
Browse files Browse the repository at this point in the history
* translate_diff clarification

The order in description and equations was confusing

* Even clearer

Better show the definition of ``τ_p``
  • Loading branch information
olivierverdier authored Sep 13, 2024
1 parent fe3e49d commit 11f0a6c
Showing 1 changed file with 5 additions and 10 deletions.
15 changes: 5 additions & 10 deletions src/groups/group.jl
Original file line number Diff line number Diff line change
Expand Up @@ -837,16 +837,11 @@ _action_order(BG::AbstractDecoratorManifold, p, q, ::RightBackwardAction) = (q,
translate(G::AbstractDecoratorManifold, p, q, conv::ActionDirectionAndSide=LeftForwardAction()])
Translate group element ``q`` by ``p`` with the translation ``τ_p`` with the specified
`conv`ention, either left forward (``L_p``), left backward (``R'_p``), right backward (``R_p``)
or right forward (``L'_p``), defined as
```math
\begin{aligned}
L_p &: q ↦ p \circ q\\
L'_p &: q ↦ p^{-1} \circ q\\
R_p &: q ↦ q \circ p\\
R'_p &: q ↦ q \circ p^{-1}.
\end{aligned}
```
`conv`ention, either
- left forward ``τ_p(q) = p \circ q``
- left backward ``τ_p(q) = q \circ p^{-1}``
- right backward ``τ_p(q) = q \circ p``
- right forward ``τ_p(q) = p^{-1} \circ q``
"""
translate(::AbstractDecoratorManifold, ::Any...)
@trait_function translate(
Expand Down

0 comments on commit 11f0a6c

Please sign in to comment.