add documentation for overwriting behaviour of in-place application of real-input fft plans #88
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 noted in JuliaMath/FFTW.jl#158, application of inverse plans of real-input ffts via
mul!
orldiv!
potentially overwrites the input array.This might be quite unexpected to many people (including me), especially since this is not the case for the complex-input versions.
This PR is an attempt at documenting this behaviour.