sd_fft: Add lots of documentation#2678
Merged
Merged
Conversation
user202729
changed the title
Collaborator
|
It's very helpful to add this kind of comments for poorly-documented parts of the codebase. Thanks! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
As in the title. The module was originally added in #1337. (given Hoeven is the author of the cited paper, maybe Mathemagix has this implemented as well...?)
I choose to leave the documentation as code comment instead of
.rstfile.I've carefully checked the documentation is correct by reading the code, except the documentation for
sd_fftandsd_ifftis by reading the tests.There's one non-documentation change
n_nbitswhich is obviously safe.