Rename BRFFTAdjointStyle -> IRFFTAdjointStyle

Author: gaurav-arya

docs/src/api.md

@@ -23,7 +23,7 @@ AbstractFFTs.fftdims
 Base.adjoint
 AbstractFFTs.FFTAdjointStyle
 AbstractFFTs.RFFTAdjointStyle
-AbstractFFTs.BRFFTAdjointStyle
+AbstractFFTs.IRFFTAdjointStyle
 AbstractFFTs.UnitaryAdjointStyle
 AbstractFFTs.fftshift
 AbstractFFTs.fftshift!

docs/src/implementations.md

@@ -34,7 +34,7 @@ To define a new FFT implementation in your own module, you should
 
 * We offer an experimental `AdjointStyle` trait to enable automatic computation of adjoint plans via [`Base.adjoint`](@ref),
 (which `AbstractFFTs` uses to implement reverse-mode differentiation rules). To support adjoints in a new plan, define the trait `AbstractFFTs.AdjointStyle(::MyPlan)`. This should return a subtype of `AS <: AbstractFFTs.AdjointStyle` supporting `AbstractFFTs.adjoint_mul(::AdjointPlan, ::AbstractArray, ::AS)`. `AbstractFFTs` pre-implements [`AbstractFFTs.FFTAdjointStyle`](@ref), [`AbstractFFTs.RFFTAdjointStyle`](@ref),
-[`AbstractFFTs.BRFFTAdjointStyle`](@ref), and [`AbstractFFTs.UnitaryAdjointStyle`](@ref).
+[`AbstractFFTs.IRFFTAdjointStyle`](@ref), and [`AbstractFFTs.UnitaryAdjointStyle`](@ref).
 
 The normalization convention for your FFT should be that it computes ``y_k = \sum_j x_j \exp(-2\pi i j k/n)`` for a transform of
 length ``n``, and the "backwards" (unnormalized inverse) transform computes the same thing but with ``\exp(+2\pi i jk/n)``.

src/definitions.jl

@@ -608,7 +608,7 @@ to exploit its conjugate symmetry (see [`rfft`](@ref)).
 struct RFFTAdjointStyle <: AdjointStyle end 
 
 """
-    BRFFTAdjointStyle(d::Dim)
+    IRFFTAdjointStyle(d::Dim)
 
 Projection style for complex to real discrete Fourier transforms, for plans that 
 expect an input with a halved dimension analogously to [`irfft`](@ref), where `d` 
@@ -618,7 +618,7 @@ Since the Fourier transform is unitary up to a scaling, the adjoint applies the
 inverse, but with additional logic to handle the fact that the input is projected 
 to exploit its conjugate symmetry (see [`irfft`](@ref)). 
 """
-struct BRFFTAdjointStyle <: AdjointStyle
+struct IRFFTAdjointStyle <: AdjointStyle
     dim::Int
 end
 
@@ -632,7 +632,7 @@ struct UnitaryAdjointStyle <: AdjointStyle end
 output_size(p::Plan) = _output_size(p, AdjointStyle(p))
 _output_size(p::Plan, ::FFTAdjointStyle) = size(p)
 _output_size(p::Plan, ::RFFTAdjointStyle) = rfft_output_size(size(p), fftdims(p))
-_output_size(p::Plan, s::BRFFTAdjointStyle) = brfft_output_size(size(p), s.dim, fftdims(p))
+_output_size(p::Plan, s::IRFFTAdjointStyle) = brfft_output_size(size(p), s.dim, fftdims(p))
 _output_size(p::Plan, ::UnitaryAdjointStyle) = size(p)
 
 struct AdjointPlan{T,P<:Plan} <: Plan{T}
@@ -681,7 +681,7 @@ function adjoint_mul(p::AdjointPlan{T}, x::AbstractArray, ::RFFTAdjointStyle) wh
     return p.p \ (x ./ convert(typeof(x), scale))
 end
 
-function adjoint_mul(p::AdjointPlan{T}, x::AbstractArray, ::BRFFTAdjointStyle) where {T}
+function adjoint_mul(p::AdjointPlan{T}, x::AbstractArray, ::IRFFTAdjointStyle) where {T}
     dims = fftdims(p.p)
     N = normalization(real(T), output_size(p.p), dims)
     halfdim = first(dims)

test/testplans.jl

@@ -111,7 +111,7 @@ mutable struct InverseTestRPlan{T,N,G} <: Plan{Complex{T}}
 end
 
 AbstractFFTs.AdjointStyle(::TestRPlan) = AbstractFFTs.RFFTAdjointStyle()
-AbstractFFTs.AdjointStyle(p::InverseTestRPlan) = AbstractFFTs.BRFFTAdjointStyle(p.d)
+AbstractFFTs.AdjointStyle(p::InverseTestRPlan) = AbstractFFTs.IRFFTAdjointStyle(p.d)
 
 function AbstractFFTs.plan_rfft(x::AbstractArray{T}, region; kwargs...) where {T<:Real}
     return TestRPlan{T}(region, size(x))