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

Why is the Quaternion logarithmic map given a private-looking name? #26552

Closed
jpreiss opened this issue Apr 29, 2024 · 3 comments · Fixed by #26597
Closed

Why is the Quaternion logarithmic map given a private-looking name? #26552

jpreiss opened this issue Apr 29, 2024 · 3 comments · Fixed by #26597
Labels

Comments

@jpreiss
Copy link
Contributor

jpreiss commented Apr 29, 2024

Why is Quaternion._ln not given a name like Quaternion.log and documented as part of the public interface?

This was asked a while back, but it was tangential to the main topic and thus ignored:

BTW, Is it any reason to avoid conventional log name for method. There is only _ln. Leading underscore in the method name may confuse since it looks like a private method. Maybe, adding log = _ln to the class definition makes sense.

Originally posted by @vr050714 in #21576 (comment)

It seems odd to me, especially since Quaternion.exp is public. There are many use cases of quaternions where we wish to go between the Lie group and Lie algebra in both directions.

@oscarbenjamin
Copy link
Contributor

I think it could be made a public method. I'm not sure if more tidying up or something is needed.

@jpreiss
Copy link
Contributor Author

jpreiss commented May 3, 2024

I can make a PR if desired!

@oscarbenjamin
Copy link
Contributor

Yes, go ahead.

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

Successfully merging a pull request may close this issue.

2 participants