Skip to content

Commit

Permalink
Fix documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
kellertuer committed Oct 27, 2024
1 parent 4ec07bd commit df8478e
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
1 change: 1 addition & 0 deletions docs/src/interface/algebra.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

```@docs
LieAlgebra
LieAlgebraOrthogonalBasis
```

## Functions on Lie algebras
Expand Down
10 changes: 5 additions & 5 deletions src/interface.jl
Original file line number Diff line number Diff line change
Expand Up @@ -396,14 +396,14 @@ _doc_get_coordinates = """
get_coordinates!(G::LieGroup, c, g, X, B::AbstractBasis)
get_coordinates!(𝔤::LieAlgebra, c, X, B::AbstractBasis)
Return the vector of coordinates to the decomposition of `X` with respect to an [`AbstractBasis`](@extref `ManifoldsBase.AsbtractBasis`)
of the [`LieAgreba`](@ref) `𝔤`.
Return the vector of coordinates to the decomposition of `X` with respect to an [`AbstractBasis`](@extref `ManifoldsBase.AbstractBasis`)
of the [`LieAlgebra`](@ref) `𝔤`.
Since all tangent vectors are assumed to be represented in the Lie algebra,
both signatures are equivalend.
The operation can be performed in-place of `c`.
By default this function requires [`identity_element`](@ref)`(G)` and calls
the corresponding [`get_coordinates`](@extref `ManifoldsBase.get_coordinates-Tuple{AbstractManifold, Any, Any, ManifoldsBase.AbstractBasis}) function
the corresponding [`get_coordinates`](@extref `ManifoldsBase.get_coordinates-Tuple{AbstractManifold, Any, Any, ManifoldsBase.AbstractBasis}`) function
of the Riemannian manifold the Lie group is build on.
The inverse operation is [`get_vector`](@ref).
Expand All @@ -423,8 +423,8 @@ _doc_get_vector = """
get_vector!(G::LieGroup, X, g, c, B::AbstractBasis)
get_vector!(𝔤::LieAlgebra, X, c, B::AbstractBasis)
Return the vector corresponding to a set of coefficients in an [`AbstractBasis`](@extref `ManifoldsBase.AsbtractBasis`)
of the [`LieAgreba`](@ref) `𝔤`.
Return the vector corresponding to a set of coefficients in an [`AbstractBasis`](@extref `ManifoldsBase.AbstractBasis`)
of the [`LieAlgebra`](@ref) `𝔤`.
Since all tangent vectors are assumed to be represented in the Lie algebra,
both signatures are equivalend.
The operation can be performed in-place of a tangent vector `X`.
Expand Down

0 comments on commit df8478e

Please sign in to comment.