Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document the order of the elements in the tangent space, in a prominent place #321

Open
joansola opened this issue Mar 3, 2025 · 0 comments

Comments

@joansola
Copy link
Collaborator

joansola commented Mar 3, 2025

An important detail in the usage of manif is the meaning of the Jacobians. In particular, the order of the different elements in the tangent vector is crucial.

For example, in SE(3) we may have [theta,p] or [p,theta]. Mathematically, this is irrelevant. But code-wise, the order matters.

In SGal(3) there are 4 elements, so the number of options is huge, and only one is valid, It happens that the selected order (rho, nu, theta, t) does not match the order in the constructor of SGal3 (p, q, v, t), leading to possible confusion. The only good solution is a good documentation.

The arbitrary choice of these orderings should be clearly documented in a prominent place (e.g. in the GroupTangent classes), and appear in the documentation pages generated by doxygen.

I also noticed a few Error404 when browsing the doxygen documentation, especially when looking for specific files in the SGal3 class impl folders.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant