Skip to content

Drop AbstractFFT interface #79

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
andreasnoack wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Drop AbstractFFT interface #79

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ version = "0.3.0"
authors = ["Danny Sharp <dannys4@mit.edu> and contributors"]

[deps]
AbstractFFTs = "621f4979-c628-5d54-868e-fcf4e3e8185c"
DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
MuladdMacro = "46d2c3a1-f734-5fdb-9937-b9b9aeba4221"
Expand All @@ -13,7 +12,6 @@ Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
Reexport = "189a3867-3050-52da-a836-e630ba90ab69"

[compat]
AbstractFFTs = "1"
Aqua = "0.8"
DocStringExtensions = "0.9"
ExplicitImports = "1.12"
Expand Down
6 changes: 3 additions & 3 deletions src/FFTA.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
module FFTA

using AbstractFFTs: AbstractFFTs
using DocStringExtensions: TYPEDSIGNATURES
using LinearAlgebra: LinearAlgebra
using MuladdMacro: @muladd
using Primes: Primes
using Reexport: @reexport

@reexport using AbstractFFTs
export fft, bfft, ifft, rfft, brfft, irfft
export plan_fft, plan_bfft, plan_rfft, plan_brfft

include("callgraph.jl")
include("algos.jl")
include("plan.jl")

include("main.jl")

end
16 changes: 16 additions & 0 deletions src/main.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
fft(X::AbstractArray{<:Complex}, region::Union{Int,AbstractVector} = 1:ndims(X)) = plan_fft(X, region) * X
fft(X::AbstractArray, region::Union{Int,AbstractVector} = 1:ndims(X)) = fft(complex(X), region)

bfft(X::AbstractArray{<:Complex}, region::Union{Int,AbstractVector} = 1:ndims(X)) = plan_bfft(X, region) * X

ifft(X::AbstractArray{<:Complex}, region::Union{Int,AbstractVector} = 1:ndims(X)) = bfft(X, region) / mapreduce(Base.Fix1(size, X), *, region; init=1)

rfft(X::AbstractArray{<:Real}, region::Union{Int,AbstractVector} = 1:ndims(X)) = plan_rfft(X, region) * X

brfft(X::AbstractArray{<:Complex}, len::Int, region::Union{Int,AbstractVector} = 1:ndims(X)) = plan_brfft(X, len, region) * X

function irfft(X::AbstractArray{<:Complex}, len::Int, region::Union{Int,AbstractVector} = 1:ndims(X))
Y = brfft(X, len, region)
Y ./= mapreduce(Base.Fix1(size, Y), *, region; init=1)
return Y
end
11 changes: 5 additions & 6 deletions src/plan.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# Plans

abstract type FFTAPlan{T,N} <: AbstractFFTs.Plan{T} end
abstract type FFTAPlan{T,N} end

struct FFTAInvPlan{T,N} <: FFTAPlan{T,N} end

Expand All @@ -24,7 +23,7 @@ Base.size(p::FFTAPlan{<:Any,N}) where N = ntuple(Base.Fix1(size, p), Val{N}())

Base.complex(p::FFTAPlan_re{T,N}) where {T,N} = FFTAPlan_cx{T,N}(p.callgraph, p.region, p.dir, p.pinv)

function AbstractFFTs.plan_fft(x::AbstractArray{T,N}, region; kwargs...)::FFTAPlan_cx{T} where {T <: Complex, N}
function plan_fft(x::AbstractArray{T,N}, region::Union{Int,AbstractVector} = 1:N)::FFTAPlan_cx{T} where {T <: Complex, N}
FFTN = length(region)
if FFTN == 1
g = CallGraph{T}(size(x,region[]))
Expand All @@ -41,7 +40,7 @@ function AbstractFFTs.plan_fft(x::AbstractArray{T,N}, region; kwargs...)::FFTAPl
end
end

function AbstractFFTs.plan_bfft(x::AbstractArray{T,N}, region; kwargs...)::FFTAPlan_cx{T} where {T <: Complex,N}
function plan_bfft(x::AbstractArray{T,N}, region::Union{Int,AbstractVector} = 1:N)::FFTAPlan_cx{T} where {T <: Complex,N}
FFTN = length(region)
if FFTN == 1
g = CallGraph{T}(size(x,region[]))
Expand All @@ -58,7 +57,7 @@ function AbstractFFTs.plan_bfft(x::AbstractArray{T,N}, region; kwargs...)::FFTAP
end
end

function AbstractFFTs.plan_rfft(x::AbstractArray{T,N}, region; kwargs...)::FFTAPlan_re{Complex{T}} where {T <: Real,N}
function plan_rfft(x::AbstractArray{T,N}, region::Union{Int,AbstractVector} = 1:N)::FFTAPlan_re{Complex{T}} where {T <: Real,N}
FFTN = length(region)
if FFTN == 1
g = CallGraph{Complex{T}}(size(x,region[]))
Expand All @@ -75,7 +74,7 @@ function AbstractFFTs.plan_rfft(x::AbstractArray{T,N}, region; kwargs...)::FFTAP
end
end

function AbstractFFTs.plan_brfft(x::AbstractArray{T,N}, len, region; kwargs...)::FFTAPlan_re{T} where {T,N}
function plan_brfft(x::AbstractArray{T,N}, len::Int, region::Union{Int,AbstractVector} = 1:N)::FFTAPlan_re{T} where {T,N}
FFTN = length(region)
if FFTN == 1
g = CallGraph{T}(len)
Expand Down
9 changes: 0 additions & 9 deletions test/custom_element_types.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,6 @@ x = randn(2*3*4*5)
@testset "element type: $T" for T in (Float16, BigFloat)
Tx = T.(x)

@testset "AbstractFFTs believes that single and double precision is everything." begin
# Ref https://github.com/JuliaMath/FFTA.jl/issues/77
if T == BigFloat
@test_broken fft(Tx)
else
@test_broken fft(Tx) isa Vector{Complex{T}}
end
end

# Complex
cTx = complex(Tx)
new_cTx = ifft(fft(cTx))
Expand Down
1 change: 1 addition & 0 deletions test/onedim/complex_backward.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ end
end

@testset "allocation regression" begin
bfft(y) # warm up
@test (@test_allocations bfft(y)) <= 47
end
end
Expand Down
1 change: 1 addition & 0 deletions test/onedim/real_backward.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ end
end

@testset "allocation regression" begin
brfft(y, n) # warmup
@test (@test_allocations brfft(y, n)) <= 55
end
end
Expand Down
3 changes: 0 additions & 3 deletions test/qa/aqua.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,5 @@ import Aqua
@testset "Aqua" begin
Aqua.test_all(
FFTA;
# This type piracy is caused by the problematic design of AbstractFFTs.jl
# Ref https://github.com/JuliaMath/AbstractFFTs.jl/issues/32
piracies = (; treat_as_own = [plan_bfft, plan_brfft, plan_fft, plan_rfft]),
)
end
4 changes: 1 addition & 3 deletions test/qa/explicit_imports.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,7 @@ import ExplicitImports
@test ExplicitImports.check_all_qualified_accesses_via_owners(FFTA) === nothing

# No non-public accesses in FFTA (ie. no `... MyPkg._non_public_internal_func(...)`)
# AbstractFFTs requires subtyping of `Plan` but it is not public
# This is an upstream bug in AbstractFFTs.jl
@test ExplicitImports.check_all_qualified_accesses_are_public(FFTA; ignore = (:Plan, :require_one_based_indexing, :Fix1)) === nothing
@test ExplicitImports.check_all_qualified_accesses_are_public(FFTA; ignore = (:require_one_based_indexing, :Fix1)) === nothing

# No self-qualified accesses in FFTA (ie. no `... FFTA.func(...)`)
@test ExplicitImports.check_no_self_qualified_accesses(FFTA) === nothing
Expand Down
Loading