Skip to content

Class dft_plan_md

class dft_plan_md<T, Dims> dft

template <typename T, index_t Dims = dynamic_shape>
struct dft_plan_md { … }

Multidimensional complex DFT plan.

Template parameters
T Floating-point type ( float or double ).
Dims Number of dimensions, or dynamic_shape for a runtime rank.

variable size 

shape<Dims> size

Per-dimension sizes of the transform.

Fully qualified name: kfr::dft_plan_md<T, Dims>::size

Declared at dft/fft.hpp:805

variable temp_size 

size_t temp_size

Scratch buffer size in bytes required by

execute .

Fully qualified name: kfr::dft_plan_md<T, Dims>::temp_size

Declared at dft/fft.hpp:806

constructor dft_plan_md<T, Dims>(const dft_plan_md<T, Dims> &) 

dft_plan_md(const dft_plan_md&)            = delete

Fully qualified name: kfr::dft_plan_md<T, Dims>::dft_plan_md<T, Dims>(const dft_plan_md<T, Dims> &)

Declared at dft/fft.hpp:808

constructor dft_plan_md<T, Dims>(dft_plan_md<T, Dims> &&) 

dft_plan_md(dft_plan_md&&)                 = default

Fully qualified name: kfr::dft_plan_md<T, Dims>::dft_plan_md<T, Dims>(dft_plan_md<T, Dims> &&)

Declared at dft/fft.hpp:809

function operator=(const dft_plan_md<T, Dims> &) 

dft_plan_md& operator=(const dft_plan_md&) = delete

Fully qualified name: kfr::dft_plan_md<T, Dims>::operator=(const dft_plan_md<T, Dims> &)

Declared at dft/fft.hpp:810

function operator=(dft_plan_md<T, Dims> &&) 

dft_plan_md& operator=(dft_plan_md&&)      = default

Fully qualified name: kfr::dft_plan_md<T, Dims>::operator=(dft_plan_md<T, Dims> &&)

Declared at dft/fft.hpp:811

function is_initialized() 

bool is_initialized() const

Checks whether the plan is non-empty.

Fully qualified name: kfr::dft_plan_md<T, Dims>::is_initialized()

Declared at dft/fft.hpp:814

function dump() 

void dump() const

Dumps details of the underlying per-axis plans to stdout.

Fully qualified name: kfr::dft_plan_md<T, Dims>::dump()

Declared at dft/fft.hpp:817

constructor dft_plan_md<T, Dims>(shape<Dims>) 

explicit dft_plan_md(shape<Dims> size)

Constructs a multidimensional DFT plan for the given shape.

Parameters
size Per-dimension sizes of the transform.

Fully qualified name: kfr::dft_plan_md<T, Dims>::dft_plan_md<T, Dims>(shape<Dims>)

Declared at dft/fft.hpp:827

function execute(complex<T> *, const complex<T> *, u8 *, bool) 

void execute(complex<T>* out, const complex<T>* in, u8* temp, bool inverse = false) const

Executes the multidimensional DFT on raw pointers.

Parameters
out Output buffer of size.product() complex elements.
in Input buffer of size.product() complex elements.
temp Scratch buffer of at least temp_size bytes (may be nullptr ).
inverse If true, performs the inverse transform.

Fully qualified name: kfr::dft_plan_md<T, Dims>::execute(complex<T> *, const complex<T> *, u8 *, bool)

Declared at dft/fft.hpp:848

function execute(const tensor<complex<T>, Dims> &, const tensor<complex<T>, Dims> &, u8 *, bool) 

void execute(const tensor<complex<T>, Dims>& out, const tensor<complex<T>, Dims>& in, u8* temp,
             bool inverse = false) const
    requires(Dims != dynamic_shape)

Executes the multidimensional DFT on tensors.

Parameters
out Output tensor with shape equal to size .
in Input tensor with shape equal to size .
temp Scratch buffer of at least temp_size bytes (may be nullptr ).
inverse If true, performs the inverse transform.

Fully qualified name: kfr::dft_plan_md<T, Dims>::execute(const tensor<complex<T>, Dims> &, const tensor<complex<T>, Dims> &, u8 *, bool)

Declared at dft/fft.hpp:863

function execute(complex<T> *, const complex<T> *, u8 *, cbool_t<inverse>) 

template <bool inverse = false>
void execute(complex<T>* out, const complex<T>* in, u8* temp, cbool_t<inverse> = { … }

Executes the multidimensional DFT with a compile-time direction.

Template parameters
inverse If true, performs the inverse transform.
Parameters
out Output buffer of size.product() complex elements.
in Input buffer of size.product() complex elements.
temp Scratch buffer of at least temp_size bytes (may be nullptr ).

Fully qualified name: kfr::dft_plan_md<T, Dims>::execute(complex<T> *, const complex<T> *, u8 *, cbool_t<inverse>)

Declared at dft/fft.hpp:883

Fully qualified name: kfr::dft_plan_md<T, Dims>

Declared at dft/fft.hpp:803

This file was generated by cxxdox, a C++ documentation generator based on MkDocs Material and libclang.