🛣️ Roadmap for LieGroups.jl

[kellertuer]

🛣️ Roadmap for LieGroups.jl

• [x] Add people to all if Project.toml, LICENSE, the authors= field in the docs/make.jl, and the .zenodo.json
• [x] start a notation.md to fix notation
• List of functions to “move to” (first define in ) this package – I want to make sure all their docs get a bit longer to also help starters a bit more (and myself)
  • [x] GroupManifold should become LieGroup
  • [x] Identity
  • [x] inv(G,p) (for types as above also inv(p)
  • [x] compose (for types as above also overload $\circ$)
  • [ ] _compose – that is handle interaction with the identity element in compose and document this to be implemented for groups actually.
  • [x] identity_element (an din-place)
  • [x] ActionDirection, left and right
  • [x] move some traits like HasRightInvariantMetric (and left- and bi-) maybe also introduce the trait IsLieGroup
  • [x] exp_inv should become the default exp(G, p, X) here. (similarly log)
  • [x] exp_lie should either become the exp(G, X) above, similarly (log)
  • [ ] get_vector_lie and get_coordinates_lie can maybe be refactored to work on groups without a base point? Or on a new LieAlgebra subtype (similar to the tangent space we have)
  • [x] inv_diff
  • [x] inverse_translate_diff we should probably decide whether we do shorten inv or we do not, we should probably not because there is inverse and invariant now already
  • is_group_manifold should probably become is_Lie_group since the Lie group is no longer a decorator this is obsolete
  • [x] is_idenity
  • [x] lie_bracket
  • [x] switch_direction -> switch
  • switch_side obsolete after unifying operations
  • [x] translate
  • [x] translate_diff
  • [ ] hat
  • [ ] vee
  • [x] AdditionOperation as AdditionGroupOpertaion
  • [ ] MultiplcationOperation
• List of Lie Groups to move here
  • [ ] CircleGroup
  • [ ] RealCircleGroup
  • [ ] GeneralLinear
  • [ ] HeisenbergGroup
  • [ ] (Special) Orthogonal and (Special) Unitary group
  • [ ] PowerGroup – or maybe discuss to turn a power manifold info a group instead?
  • [ ] ProductGroup – same as before, maybe LieGroup(product, tuple-of-operations) instead?
  • [ ] SemidirectProductGroup
  • [ ] SpecialEuclidean
  • [ ] SpecialLinear
  • [ ] TranslationGroup
• [ ] move according metrics and connections
• [x] move group actions.
• [ ] write a generic Lie group test suite
• [x] Discuss name and check with the maybe inactive package https://github.com/yuehhua/LieGroups.jl – opened an issue at https://github.com/yuehhua/LieGroups.jl/issues/4 (cf. also https://github.com/JuliaRegistries/General/issues/25367)
• [ ] Write a “Get started” tutorial
• [x] setup documentation, tests, tutorials (quarto), zenodo, JuliaFormater default, .gitignore
• [ ] check https://github.com/JuliaManifolds/ManifoldsBase.jl/pull/84 what we can maybe also use in ideas from there.
• [ ] Have a page about.md to mention contributors (and what they contributed) as well as interesting related projects, for example
  • https://gitlab.com/ExpandingMan/LorentzGroup.jl

Further ideas both in form on further issues (I will link here) as well as comments are are welcome. Let's first collect the ideas before we get started.

[dev10110]

This is awesome! Thanks Ronny!

[mateuszbaran]

Nice list! I think we should also move group actions here.

[kellertuer]

Well-spotted, sure they should move as well.

I will try to find time to write down a few design remarks and introduce the first main types maybe until or over the weekend. and then we could try to slowly move some parts

[kellertuer]

There might be a few small hiccups from now, since we are taking over the old LieGroups.jl and rebase this.

[kellertuer]

@ExpandingMan, @alxbnct, @oameye thanks for so early staring out repository again. Don't be confused, this is an old repository we took over to get the name LieGroups.jl, so while this might look like the one you stared, it is not. Feel free to star this one of course we stay up to date.

Og course any comments, remarks, feature requests are also always welcome why we continue the rework.