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.

Sign up for GitHub

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

add documentation for overwriting behaviour of in-place application of real-input fft plans #88

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

add documentation for overwriting behaviour of in-place application of real-input fft plans #88

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
db0b246
add documentation for overwriting behaviour
trahflow Mar 13, 2023
45f3531
drop examples that cannot be doctested
trahflow Apr 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions src/definitions.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -356,6 +356,12 @@ plan_irfft(x::AbstractArray{Complex{T}}, d::Integer, region; kws...) where {T} =
Pre-plan an optimized inverse real-input FFT, similar to [`plan_rfft`](@ref)
except for [`irfft`](@ref) and [`brfft`](@ref), respectively. The first
three arguments have the same meaning as for [`irfft`](@ref).

!!! note
In contrast to plans created by [`plan_ifft`](@ref), the application of
this plan via `mul!(A, P, Â)` will potentially **overwrite the input array** `Â`
with undefined data in the case of multidimensional transforms!

"""
plan_irfft

Expand Down Expand Up @@ -566,6 +572,12 @@ fft
Pre-plan an optimized real-input FFT, similar to [`plan_fft`](@ref) except for
[`rfft`](@ref) instead of [`fft`](@ref). The first two arguments, and the
size of the transformed result, are the same as for [`rfft`](@ref).

!!! note
In contrast to plans created by [`plan_fft`](@ref), the application of the
inverse of this plan via `ldiv!(A, P, Â)` will potentially **overwrite the input array**
`Â` with undefined data in the case of multidimensional transforms!

"""
plan_rfft

Expand All @@ -576,5 +588,11 @@ Pre-plan an optimized real-input unnormalized transform, similar to
[`plan_rfft`](@ref) except for [`brfft`](@ref) instead of
[`rfft`](@ref). The first two arguments and the size of the transformed result, are
the same as for [`brfft`](@ref).

!!! note
In contrast to plans created by [`plan_bfft`](@ref), the application of
this plan via `mul!(A, P, Â)` will potentially **overwrite the input array** `Â`
with undefined data in the case of multidimensional transforms!

"""
plan_brfft