-
Notifications
You must be signed in to change notification settings - Fork 56
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
Rename Symplectic to SymplecticMatrices? #701
Comments
I think this renaming makes sense. We can schedule it for the next breaking release. |
Cool. I will carefully add the functionality I need on #700, and will maybe already add a few notes what might change in the future as comments |
If we just deprecate the constructors, the only breaking part would be if someone dispatches on the old |
I think we can do the first two points in #700 with deprecation and aliases but the third one IMO needs to wait for a breaking release. |
That sounds fair enough. I will do those two then next in that PR. |
Currently we usually suffix
Matrices
for quite a few manifolds where the name itself is not specific enough, e.g.SymmetricMatrices
since we useSymmetric
for the single matrix.This is a bit inconsistent to one other case we have, which I therefore would like to rename
Symplectic
should be calledSymplecticMatrices
SynplecticMatrix
should be calledSymplecticElement
Symplectic
could be introduced as a type indicating a symplectic matrix (similar toSymmetric
)I think this would even only be mildly breaking, only the constructors need to be deprecated but could still keep working for a while. Breaking would be if other use these types, since we could not const them when reusing them. But it would be nice to have this consistently with LinearAlgebra in the naming
What are opinions on this? I am reworking a bit of this in #700, so I could even include it in there is the breaking part is considered fine enough.
The text was updated successfully, but these errors were encountered: