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

Unify the signatures of decomp.bidiag, decomp.tridiag_sym, and decomp.hessenberg #195

Open
pnkraemer opened this issue May 27, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@pnkraemer
Copy link
Owner

Currently, all three functions return similar outputs but (needlessly) differ in their arguments.
For example, bidiag assumes a normalised input, but the other two normalise inputs internally and return lengths of inputs.

I suggest implementing a test that asserts that their outputs are identical if called in settings where the outputs are expected to be identical and fixing all mismatches until this test passes.

For instance, if we call hessenberg with a symmetric matrix, all outputs should match that of tridiag_sym,
and if we call tridiag_sym with a matrix $A=X^\top X$ and bidiag with $X$, the outputs should match, too.
As a result, users will have a much easier time switching between methods.

@pnkraemer pnkraemer added the enhancement New feature or request label May 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant