Skip to content

Commit 9d99886

Browse files
committed
Document adjoint plans
1 parent aa8e575 commit 9d99886

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
@@ -601,6 +601,14 @@ mutable struct AdjointPlan{T,P<:Plan} <: Plan{T}
601601
AdjointPlan{T,P}(p) where {T,P} = new(p)
602602
end
603603

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

0 commit comments

Comments
 (0)