Skip to content

Commit

Permalink
Add a dependency on AbstractFFTs
Browse files Browse the repository at this point in the history
  • Loading branch information
ararslan committed Jun 6, 2017
1 parent 245968f commit 9b70e08
Show file tree
Hide file tree
Showing 8 changed files with 47 additions and 494 deletions.
3 changes: 2 additions & 1 deletion REQUIRE
@@ -1,4 +1,5 @@
julia 0.6-
julia 0.6.0-rc1
AbstractFFTs
BinDeps 0.6.0
@osx Homebrew
@windows WinRPM
46 changes: 13 additions & 33 deletions docs/src/fft.md
@@ -1,43 +1,23 @@
# Fourier Transforms

```@docs
FFTW.fft
FFTW.fft!
FFTW.ifft
FFTW.ifft!
FFTW.bfft
FFTW.bfft!
FFTW.plan_fft
FFTW.plan_ifft
FFTW.plan_bfft
FFTW.plan_fft!
FFTW.plan_ifft!
FFTW.plan_bfft!
FFTW.rfft
FFTW.irfft
FFTW.brfft
FFTW.plan_rfft
FFTW.plan_brfft
FFTW.plan_irfft
FFTW.dct
FFTW.dct!
FFTW.idct
FFTW.idct!
FFTW.plan_dct
FFTW.plan_dct!
FFTW.plan_idct
FFTW.plan_idct!
FFTW.fftshift(::Any)
FFTW.fftshift(::Any, ::Any)
FFTW.ifftshift
```
This package extends the functionality provided by
[AbstractFFTs](https://github.com/JuliaMath/AbstractFFTs.jl).
To learn more about those functions, consult that package's
[documentation](https://juliamath.github.io/AbstractFFTs.jl/stable/api.html).

The following functions are not exported from the package and thus must be qualified
with the `FFTW.` prefix on use.
The following functions are unique to this package.

```@docs
FFTW.r2r
FFTW.r2r!
FFTW.plan_r2r
FFTW.plan_r2r!
FFTW.dct
FFTW.idct
FFTW.dct!
FFTW.idct!
FFTW.plan_dct
FFTW.plan_idct
FFTW.plan_dct!
FFTW.plan_idct!
```
19 changes: 18 additions & 1 deletion src/FFTW.jl
Expand Up @@ -2,6 +2,24 @@ __precompile__()

module FFTW

# Since nothing is exported from AbstractFFTs as long as the FFT functionality is
# defined (or deprecated) in Base, we need to be very explicit about the things we
# want to import
import AbstractFFTs: Plan, ScaledPlan,
fft, ifft, bfft, fft!, ifft!, bfft!,
plan_fft, plan_ifft, plan_bfft, plan_fft!, plan_ifft!, plan_bfft!,
rfft, irfft, brfft, plan_rfft, plan_irfft, plan_brfft,
fftshift, ifftshift,
rfft_output_size, brfft_output_size,
plan_inv, normalization

if !isdefined(Base, :FFTW)
export dct, idct, dct!, idct!, plan_dct, plan_idct, plan_dct!, plan_idct!
end
if !isdefined(Base, :DSP)
export filt, filt!, deconv, conv, conv2, xcorr
end

const depsfile = joinpath(dirname(@__DIR__), "deps", "deps.jl")
if isfile(depsfile)
include(depsfile)
Expand All @@ -24,7 +42,6 @@ else
const libfftwf_name = "libfftw3f_threads"
end

include("dft.jl")
include("fft.jl")
include("dct.jl")
include("dsp.jl") # TODO: Move these functions to DSP.jl
Expand Down
2 changes: 0 additions & 2 deletions src/dct.jl
Expand Up @@ -2,8 +2,6 @@

# (This is part of the FFTW module.)

export dct, idct, dct!, idct!, plan_dct, plan_idct, plan_dct!, plan_idct!

"""
plan_dct!(A [, dims [, flags [, timelimit]]])
Expand Down

0 comments on commit 9b70e08

Please sign in to comment.