From 1f8765252fec8d76c56d43234400ee5a8853e97a Mon Sep 17 00:00:00 2001 From: Jeff Fessler Date: Tue, 6 Dec 2022 20:51:22 -0500 Subject: [PATCH 1/2] Clarify the use of `plan_fft!` The existing docstring refers to the array `A` that is used to construct the plan, but that array is irrelevant (other than its eltype and size) when using the plan later. The old wording made it sound like the `A` in the constructor itself is used. --- src/definitions.jl | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/src/definitions.jl b/src/definitions.jl index 4532650..777ba47 100644 --- a/src/definitions.jl +++ b/src/definitions.jl @@ -130,7 +130,14 @@ plan_fft """ plan_fft!(A [, dims]; flags=FFTW.ESTIMATE, timelimit=Inf) -Same as [`plan_fft`](@ref), but operates in-place on `A`. +Same as [`plan_fft`](@ref), +but creates a plan that operates in-place. +`A` must be an array of complex floating-point numbers. +When `p = plan_fft!(A, ...)`, +one evaluates the FFT of an array `B` +of the same `size` +via `p * B` or via `mul!(B, p, B)`. +For the `mul!` use, `B` must have the same `eltype` as `A`. """ plan_fft! From cf0f5af9f7a039a5e9b5b4a49252c687bc04d4e3 Mon Sep 17 00:00:00 2001 From: Jeff Fessler Date: Tue, 20 Dec 2022 16:26:51 -0500 Subject: [PATCH 2/2] Add strides --- src/definitions.jl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/definitions.jl b/src/definitions.jl index 777ba47..84f10df 100644 --- a/src/definitions.jl +++ b/src/definitions.jl @@ -137,7 +137,7 @@ When `p = plan_fft!(A, ...)`, one evaluates the FFT of an array `B` of the same `size` via `p * B` or via `mul!(B, p, B)`. -For the `mul!` use, `B` must have the same `eltype` as `A`. +For the `mul!` use, `B` must have the same `eltype` and `strides` as `A`. """ plan_fft!