Skip to content

Commit 16e470d

Browse files
committed
Document adjoint plans
1 parent f939e89 commit 16e470d

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

src/definitions.jl

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -600,6 +600,14 @@ mutable struct AdjointPlan{T,P<:Plan} <: Plan{T}
600600
AdjointPlan{T,P}(p) where {T,P} = new(p)
601601
end
602602

603+
"""
604+
Base.adjoint(p::Plan)
605+
606+
Form the adjoint operator of an FFT plan. Returns a plan `p'` which performs the adjoint operation
607+
the original plan. Note that this differs from the corresponding backwards plan in the case of real
608+
FFTs due to the halving of one of the dimensions of the FFT output, as described in [`rfft`](@ref).
609+
Adjoint plans do not currently support `mul!`.
610+
"""
603611
Base.adjoint(p::Plan{T}) where {T} = AdjointPlan{T, typeof(p)}(p)
604612
Base.adjoint(p::AdjointPlan) = p.p
605613
# always have AdjointPlan inside ScaledPlan.

0 commit comments

Comments
 (0)