Skip to content

Commit 8bb4892

Browse files
committed
fix(docs): Move the comment before Base.adjoint before docstring
1 parent 0972583 commit 8bb4892

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

src/definitions.jl

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -649,6 +649,9 @@ struct AdjointPlan{T,P<:Plan} <: Plan{T}
649649
AdjointPlan{T,P}(p) where {T,P} = new(p)
650650
end
651651

652+
# We eagerly form the plan inverse in the adjoint(p) call, which will be cached for subsequent calls.
653+
# This is reasonable, as inv(p) would do the same, and necessary in order to compute the correct input
654+
# type for the adjoint plan and encode it in its type.
652655
"""
653656
(p::Plan)'
654657
adjoint(p::Plan)
@@ -659,9 +662,6 @@ Return a plan that performs the adjoint operation of the original plan.
659662
Adjoint plans do not currently support `LinearAlgebra.mul!`. Further, as a new addition to `AbstractFFTs`,
660663
coverage of `Base.adjoint` in downstream implementations may be limited.
661664
"""
662-
# We eagerly form the plan inverse in the adjoint(p) call, which will be cached for subsequent calls.
663-
# This is reasonable, as inv(p) would do the same, and necessary in order to compute the correct input
664-
# type for the adjoint plan and encode it in its type.
665665
Base.adjoint(p::Plan{T}) where {T} = AdjointPlan{eltype(inv(p)), typeof(p)}(p)
666666
Base.adjoint(p::AdjointPlan) = p.p
667667
# always have AdjointPlan inside ScaledPlan.

0 commit comments

Comments
 (0)