sd_fft: Add more documentation#2713
Merged
fredrik-johansson merged 1 commit intoJun 9, 2026
Merged
Conversation
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
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.
Mostly trying to understand the algorithm myself.
The notation
is probably not standard, but I think it's understandable enough. I didn't formally define it either, but (I hope…) the formal definition is clear from the examples.
(It seems to me that mathematicians prefer formal definitions, implementors prefer "definitions" by examples. We're both. Upside of formal definition is it can be understood eventually given enough effort, downside is if the examples can be understood then it would take more effort to read the formal definitions.)
While writing the documentation, I notice that the
internalvariants do not make sense withS != 1, so I simplify it by deleting that argument. Should translate to a tiny performance improvement.The numbering of the layers might have been backward (it's internally consistent, problem is it may be bad notation).