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
Autonne-Takagi decomposition #154
Conversation
Codecov Report
@@ Coverage Diff @@
## master #154 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 12 12
Lines 939 955 +16
=========================================
+ Hits 939 955 +16
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great! Nice tests. 💯
|
||
Returns: | ||
tuple[array, array]: (r, U), where r are the singular values, | ||
and U is the Autonne-Takagi unitary, such that :math:`A = U \diag(r) U^T`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What does the \diag(r)
in :math:'A = U \diag(r) U^T'
print? I don't think that's a regular latex command, or does it somehow work differently in Sphinx?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nothing really. Typically we just use a macro defined somewhere to replace \diag to \text{diag}.
|
||
Returns: | ||
tuple[array, array]: (r, U), where r are the singular values, | ||
and U is the Autonne-Takagi unitary, such that :math:`A = U \diag(r) U^T`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A bit late, but there is a typo here, this line should be de-indented!
tuple[array, array]: (r, U), where r are the singular values,
and U is the Autonne-Takagi unitary, such that :math:`A = U \diag(r) U^T`.
Adds the ability to perform the Autonne-Takagi decomposition of a complex-symmetric matrix.