Development Documentation

Here is the documentation for key parts of the development side of the package.

FFTA.CallGraphNode — Type
struct CallGraphNode

Node of a call graph

Arguments

  • left: Offset to the left child node
  • right: Offset to the right child node
  • type: Object representing the type of FFT
  • sz: Size of this FFT
  • s_in: The stride of the input
  • s_out: The stride of the output
source
FFTA.CallGraph — Type
struct CallGraph{T<:Complex}

Object representing a graph of FFT Calls

Arguments

  • nodes: Nodes keeping track of the graph
  • workspace: Preallocated Workspace
  • BLUESTEIN_CUTOFF: Minimum prime that will be FFTed with the Bluestein algorithm, below which the O(N^2) DFT is used.
source
FFTA.CallGraphNode! — Function
CallGraphNode!(
    nodes::Vector{FFTA.CallGraphNode},
    N::Int64,
    workspace::Array{Vector{T}, 1},
    BLUESTEIN_CUTOFF::Int64,
    s_in::Int64,
    s_out::Int64
) where T -> Int64

Recursively instantiate a set of CallGraphNodes

Arguments

  • nodes: A vector (which gets expanded) of CallGraphNodes
  • N: The size of the FFT
  • workspace: A vector (which gets expanded) of preallocated workspaces
  • BLUESTEIN_CUTOFF: Minimum prime that will be FFTed with the Bluestein algorithm, below which the O(N^2) DFT is used.
  • s_in: The stride of the input
  • s_out: The stride of the output
source
Missing docstring.

Missing docstring for fft!. Check Documenter's build log for details.

FFTA.fft_dft! — Function
fft_dft!(
    out::AbstractVector{T},
    in::AbstractVector{T},
    N::Int64,
    start_out::Int64,
    stride_out::Int64,
    start_in::Int64,
    stride_in::Int64,
    d::FFTA.Direction
) where T<:Complex

Discrete Fourier Transform, O(N^2) algorithm, in place.

Arguments

  • out: Output vector
  • in: Input vector
  • N: Size of the transform
  • start_out: Index of the first element of the output vector
  • stride_out: Stride of the output vector
  • start_in: Index of the first element of the input vector
  • stride_in: Stride of the input vector
  • d: Direction of the transform
source
FFTA.fft_pow3! — Function
fft_pow3!(
    out::AbstractVector{T},
    in::AbstractVector{U},
    N::Int64,
    start_out::Int64,
    stride_out::Int64,
    start_in::Int64,
    stride_in::Int64,
    minus120::T,
    d::FFTA.Direction
) where {T, U}

Power of 3 FFT, in place

Arguments

  • out: Output vector
  • in: Input vector
  • N: Size of the transform
  • start_out: Index of the first element of the output vector
  • stride_out: Stride of the output vector
  • start_in: Index of the first element of the input vector
  • stride_in: Stride of the input vector
  • minus120: Depending on direction, perform either ∓120° rotation
  • d: Direction of the transform
source