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

logabsdet has a weird name #53238

Closed
ParadaCarleton opened this issue Sep 23, 2023 · 4 comments
Closed

logabsdet has a weird name #53238

ParadaCarleton opened this issue Sep 23, 2023 · 4 comments
Labels

Comments

@ParadaCarleton
Copy link
Contributor

It's not a bug per se, but logabsdet's name makes it sound like it's supposed to return the log-absolute value of the determinant. Would it make sense to create a log_det_sign or log_det_parity function and then document that it should be preferred to logabsdet?

@stevengj
Copy link
Member

The name seems fine to me. It does return the log of the absolute value of the determinant; it just returns the sign too if you want it.

SAS calls it logabsdet. Numpy calls it slogdet (but documents one of the return values as logabsdet).

It's been around for quite some time in Julia (#3070) and hasn't seemed particularly problematic or controversial. It seems past the time for bikeshedding the name.

@ParadaCarleton
Copy link
Contributor Author

ParadaCarleton commented Sep 23, 2023

Numpy calls it slogdet (but documents one of the return values as logabsdet).

slogdet would be a good name too. It follows the rule that function names should say what they do (sign and logdet).

SAS calls it logabsdet.

If it's common in other languages that seems fine to me.

It's been around for quite some time in Julia (JuliaLang/julia#3070) and hasn't seemed particularly problematic or controversial. It seems past the time for bikeshedding the name.

Allowing multiple names is not a breaking change.

@ararslan
Copy link
Member

Allowing multiple names is not a breaking change.

...nor is it a good design.

@ViralBShah ViralBShah transferred this issue from another repository Feb 7, 2024
@oscardssmith
Copy link
Member

We don't seem likely to do this, so closing as not planned.

@oscardssmith oscardssmith closed this as not planned Won't fix, can't repro, duplicate, stale Feb 7, 2024
@mbauman mbauman added the domain:linear algebra Linear algebra label Feb 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

5 participants