Group: dft¶

A¶

• variable kfr::dft_plan<T>::all_stages Internal data.
• variable kfr::dft_plan<T>::arblen True if Bluestein's FFT algorithm is selected.

B¶

• typedef kfr::dft_plan<T>::bitset
• variable kfr::dft_stage<T>::blocks
• enum constant kfr::dft_type::both

C¶

• function kfr::dft_plan<T>::calc_disposition() Internal function
• variable kfr::dft_stage<T>::can_inplace
• enum constant kfr::dft_pack_format::CCs Conjugate-symmetric format: {X[0].r, 0}, ... {X[i].r, X[i].i}, ... {X[N-1].r, X[N-1].i}, {X[N].r, 0} Number of complex samples is
• typedef kfr::cdirect_t
• typedef kfr::cinvert_t
• function kfr::generic::dft_cache_impl<int>::clear()
• function kfr::dft_plan_real<T>::complex_size()
• function kfr::dft_plan_md_real<T, Dims>::complex_size()
• function kfr::dft_plan_md_real<T, Dims>::complex_size_for(shape<Dims>)
• function kfr::dft_plan_real<T>::complex_size_for(size_t, dft_pack_format)
• function kfr::dft_stage<T>::copy_input(bool, complex<T> *, const complex<T> *, size_t)

D¶

• variable kfr::dft_stage<T>::data
• variable kfr::dft_plan<T>::data Internal data.
• variable kfr::dft_stage<T>::data_size
• variable kfr::dft_plan<T>::data_size Internal data size.
• class kfr::dct_plan<T> DCT type 2 (unscaled)
• constructor kfr::dct_plan<T>::dct_plan<T>(size_t)
• typedef kfr::generic::dft_cache
• class kfr::generic::dft_cache_impl<int>
• macro DFT_MAX_STAGES
• enum kfr::dft_order Specifies the desired order for DFT output (and IDFT input)
• enum kfr::dft_pack_format Specifies the packing format for real DFT output data. See https://www.kfr.dev/docs/latest/dft_format/ for details
• class kfr::dft_plan_md_real<T, Dims> Multidimensional DFT
• constructor kfr::dft_plan_md_real<T, Dims>::dft_plan_md_real<T, Dims>(const dft_plan_md_real<T, Dims> &)
• constructor kfr::dft_plan_md_real<T, Dims>::dft_plan_md_real<T, Dims>(dft_plan_md_real<T, Dims> &&)
• constructor kfr::dft_plan_md_real<T, Dims>::dft_plan_md_real<T, Dims>(shape<Dims>, bool)
• class kfr::dft_plan_md<T, Dims> Multidimensional DFT
• constructor kfr::dft_plan_md<T, Dims>::dft_plan_md<T, Dims>(const dft_plan_md<T, Dims> &)
• constructor kfr::dft_plan_md<T, Dims>::dft_plan_md<T, Dims>(dft_plan_md<T, Dims> &&)
• constructor kfr::dft_plan_md<T, Dims>::dft_plan_md<T, Dims>(shape<Dims>)
• typedef kfr::generic::dft_plan_ptr
• typedef kfr::generic::dft_plan_real_ptr
• class kfr::dft_plan_real<T> Real-to-complex and Complex-to-real 1D DFT
• constructor kfr::dft_plan_real<T>::dft_plan_real<T>()
• constructor kfr::dft_plan_real<T>::dft_plan_real<T>(const dft_plan_real<T> &)
• constructor kfr::dft_plan_real<T>::dft_plan_real<T>(dft_plan_real<T> &&)
• constructor kfr::dft_plan_real<T>::dft_plan_real<T>(size_t, dft_pack_format, bool)
• class kfr::dft_plan<T> Class for performing 1D DFT/FFT.
• constructor kfr::dft_plan<T>::dft_plan<T>() Constructs an empty DFT plan.
• destructor kfr::dft_plan<T>::~dft_plan<T>() Destructor.
• constructor kfr::dft_plan<T>::dft_plan<T>(const dft_plan<T> &) Copy constructor (deleted).
• constructor kfr::dft_plan<T>::dft_plan<T>(dft_plan<T> &&) Move constructor.
• constructor kfr::dft_plan<T>::dft_plan<T>(noinit, size_t, dft_order, bool)
• constructor kfr::dft_plan<T>::dft_plan<T>(size_t, dft_order, bool) Constructs a DFT plan with the specified size and order.
• typedef kfr::dft_stage_ptr
• class kfr::dft_stage<T> Internal structure representing a single DFT stage
• destructor kfr::dft_stage<T>::~dft_stage<T>()
• enum kfr::dft_type
• function kfr::generic::dft(const univector<complex<T>, Tag> &) Performs Direct DFT using cached plan
• enum constant kfr::dft_type::direct
• variable kfr::dft_plan<T>::progressive::disposition
• variable kfr::dft_plan<T>::disposition_inplace Internal data.
• variable kfr::dft_plan<T>::disposition_outofplace Internal data.
• function kfr::dft_stage<T>::do_execute(cdirect_t, complex<T> *, const complex<T> *, u8 *)
• function kfr::dft_stage<T>::do_execute(cinvert_t, complex<T> *, const complex<T> *, u8 *)
• function kfr::dft_stage<T>::do_initialize(size_t)
• function kfr::dft_stage<T>::dump()
• function kfr::dft_plan<T>::dump() Dumps details of the DFT plan to stdout for inspection.
• function kfr::dft_plan_md<T, Dims>::dump()
• function kfr::dft_plan_md_real<T, Dims>::dump()

E¶

• function kfr::dft_plan<T>::execute_dft(cbool_t<inverse>, complex<T> *, const complex<T> *, u8 *)
• function kfr::dft_stage<T>::execute(bool, complex<T> *, const complex<T> *, u8 *)
• function kfr::dft_stage<T>::execute(cdirect_t, complex<T> *, const complex<T> *, u8 *)
• function kfr::dft_stage<T>::execute(cinvert_t, complex<T> *, const complex<T> *, u8 *)
• function kfr::dft_plan<T>::execute(complex<T> *, const complex<T> *, u8 *, bool) Execute the complex DFT on in and write the result to out.
• function kfr::dft_plan_real<T>::execute(complex<T> *, const complex<T> *, u8 *, bool)
• function kfr::dft_plan_md<T, Dims>::execute(complex<T> *, const complex<T> *, u8 *, bool)
• function kfr::dft_plan<T>::execute(complex<T> *, const complex<T> *, u8 *, cbool_t<inverse>) Execute the complex DFT on in and write the result to out.
• function kfr::dft_plan_real<T>::execute(complex<T> *, const complex<T> *, u8 *, cbool_t<inverse>)
• function kfr::dft_plan_md<T, Dims>::execute(complex<T> *, const complex<T> *, u8 *, cbool_t<inverse>)
• function kfr::dft_plan_md_real<T, Dims>::execute(complex<T> *, const T *, u8 *, bool)
• function kfr::dft_plan_real<T>::execute(complex<T> *, const T *, u8 *, cdirect_t)
• function kfr::dft_plan_md_real<T, Dims>::execute(complex<T> *, const T *, u8 *, cdirect_t)
• function kfr::dft_plan_md<T, Dims>::execute(const tensor<complex<T>, Dims> &, const tensor<complex<T>, Dims> &, u8 *, bool)
• function kfr::dft_plan_md_real<T, Dims>::execute(const tensor<complex<T>, Dims> &, const tensor<T, Dims> &, u8 *, cdirect_t)
• function kfr::dft_plan_md_real<T, Dims>::execute(const tensor<T, Dims> &, const tensor<complex<T>, Dims> &, u8 *, cinvert_t)
• function kfr::dft_plan_md_real<T, Dims>::execute(T *, const complex<T> *, u8 *, bool)
• function kfr::dft_plan_real<T>::execute(T *, const complex<T> *, u8 *, cinvert_t)
• function kfr::dft_plan_md_real<T, Dims>::execute(T *, const complex<T> *, u8 *, cinvert_t)
• function kfr::dct_plan<T>::execute(T *, const T *, u8 *, bool)
• function kfr::dft_plan<T>::execute(univector<complex<T>, Tag1> &, const univector<complex<T>, Tag2> &, u8 *, bool) Execute the complex DFT on in and write the result to out.
• function kfr::dft_plan_real<T>::execute(univector<complex<T>, Tag1> &, const univector<complex<T>, Tag2> &, u8 *, bool)
• function kfr::dft_plan<T>::execute(univector<complex<T>, Tag1> &, const univector<complex<T>, Tag2> &, u8 *, cbool_t<inverse>) Execute the complex DFT on in and write the result to out.
• function kfr::dft_plan_real<T>::execute(univector<complex<T>, Tag1> &, const univector<complex<T>, Tag2> &, u8 *, cbool_t<inverse>)
• function kfr::dft_plan<T>::execute(univector<complex<T>, Tag1> &, const univector<complex<T>, Tag2> &, univector<u8, Tag3> &, bool) Execute the complex DFT on in and write the result to out.
• function kfr::dft_plan_real<T>::execute(univector<complex<T>, Tag1> &, const univector<complex<T>, Tag2> &, univector<u8, Tag3> &, bool)
• function kfr::dft_plan<T>::execute(univector<complex<T>, Tag1> &, const univector<complex<T>, Tag2> &, univector<u8, Tag3> &, cbool_t<inverse>) Execute the complex DFT on in and write the result to out.
• function kfr::dft_plan_real<T>::execute(univector<complex<T>, Tag1> &, const univector<complex<T>, Tag2> &, univector<u8, Tag3> &, cbool_t<inverse>)
• function kfr::dft_plan_real<T>::execute(univector<complex<T>, Tag1> &, const univector<T, Tag2> &, u8 *, cdirect_t)
• function kfr::dft_plan_real<T>::execute(univector<complex<T>, Tag1> &, const univector<T, Tag2> &, univector<u8, Tag3> &, cdirect_t)
• function kfr::dft_plan_real<T>::execute(univector<T, Tag1> &, const univector<complex<T>, Tag2> &, u8 *, cinvert_t)
• function kfr::dft_plan_real<T>::execute(univector<T, Tag1> &, const univector<complex<T>, Tag2> &, univector<u8, Tag3> &, cinvert_t)
• function kfr::dct_plan<T>::execute(univector<T, Tag1> &, const univector<T, Tag2> &, univector<u8, Tag3> &, bool)

F¶

• function kfr::generic::fft_multiply_accumulate(univector<complex<T>, Tag1> &, const univector<complex<T>, Tag2> &, const univector<complex<T>, Tag3> &, const univector<complex<T>, Tag4> &, dft_pack_format)
• function kfr::generic::fft_multiply_accumulate(univector<complex<T>, Tag1> &, const univector<complex<T>, Tag2> &, const univector<complex<T>, Tag3> &, dft_pack_format)
• function kfr::generic::fft_multiply(univector<complex<T>, Tag1> &, const univector<complex<T>, Tag2> &, const univector<complex<T>, Tag3> &, dft_pack_format)
• variable kfr::dft_plan_real<T>::fmt

G¶

• function kfr::generic::dft_cache_impl<int>::get(ctype_t<f32>, size_t)
• function kfr::generic::dft_cache_impl<int>::get(ctype_t<f64>, size_t)
• function kfr::generic::dft_cache_impl<int>::getreal(ctype_t<f32>, size_t)
• function kfr::generic::dft_cache_impl<int>::getreal(ctype_t<f64>, size_t)

I¶

• function kfr::generic::idft(const univector<complex<T>, Tag> &) Performs Inverse DFT using cached plan
• variable kfr::dft_plan<T>::progressive::in
• function kfr::dft_stage<T>::initialize(size_t)
• function kfr::generic::dft_cache_impl<int>::instance()
• enum constant kfr::dft_order::internal
• enum constant kfr::dft_type::inverse
• variable kfr::dft_plan<T>::progressive::inverse
• function kfr::generic::irealdft(const univector<complex<T>, Tag> &) Permorms Real Inverse DFT using cached plan
• function kfr::dft_plan<T>::is_initialized() Checks whether the plan is non-empty.
• function kfr::dft_plan_real<T>::is_initialized()
• function kfr::dft_plan_md<T, Dims>::is_initialized()
• function kfr::dft_plan_md_real<T, Dims>::is_initialized()

N¶

• variable kfr::dft_stage<T>::name
• variable kfr::dft_stage<T>::need_reorder
• struct kfr::dft_plan<T>::noinit
• enum constant kfr::dft_order::normal

O¶

• function kfr::dft_plan_md_real<T, Dims>::operator=(const dft_plan_md_real<T, Dims> &)
• function kfr::dft_plan_md<T, Dims>::operator=(const dft_plan_md<T, Dims> &)
• function kfr::dft_plan_real<T>::operator=(const dft_plan_real<T> &)
• function kfr::dft_plan<T>::operator=(const dft_plan<T> &) Copy assignment operator (deleted).
• function kfr::dft_plan_md_real<T, Dims>::operator=(dft_plan_md_real<T, Dims> &&)
• function kfr::dft_plan_md<T, Dims>::operator=(dft_plan_md<T, Dims> &&)
• function kfr::dft_plan_real<T>::operator=(dft_plan_real<T> &&)
• function kfr::dft_plan<T>::operator=(dft_plan<T> &&) Move assignment operator.
• variable kfr::dft_plan<T>::progressive::out
• variable kfr::dft_stage<T>::out_offset

P¶

• enum constant kfr::dft_pack_format::Perm Packed format: {X[0].r, X[N].r}, ... {X[i].r, X[i].i}, ... {X[N-1].r, X[N-1].i} Number of complex samples is
• function kfr::dft_plan<T>::precompute_disposition(int, bitset, bool) Internal function
• struct kfr::dft_plan<T>::progressive Internal data structure for progressive execution of the DFT. Do not access the members directly as they may change in future versions.
• typedef kfr::dft_plan_real<T>::progressive
• variable kfr::dft_plan<T>::progressive_optimized True if the plan is for progressive execution of the DFT.
• function kfr::dft_plan<T>::progressive_start(bool, complex<T> *, const complex<T> *, u8 *) Initiates the progressive execution of the DFT.
• function kfr::dft_plan_real<T>::progressive_start(complex<T> *, const T *, u8 *)
• function kfr::dft_plan_real<T>::progressive_start(T *, const complex<T> *, u8 *)
• function kfr::dft_plan<T>::progressive_step(progressive &) Steps the progressive execution of the DFT.
• function kfr::dft_plan<T>::progressive_total_steps() Returns the number of steps for progressive execution of the DFT.

R¶

• variable kfr::dft_stage<T>::radix
• variable kfr::dft_plan_md_real<T, Dims>::real_out_is_enough
• function kfr::dft_plan_md_real<T, Dims>::real_out_size()
• function kfr::dft_plan_md_real<T, Dims>::real_out_size_for(shape<Dims>)
• function kfr::generic::realdft(const univector<T, Tag> &) Performs Real Direct DFT using cached plan
• variable kfr::dft_stage<T>::recursion
• function kfr::reference_dft_md(complex<T> *, const complex<T> *, shape<dynamic_shape>, bool, size_t, size_t) Performs Multidimensional Complex DFT using reference implementation (slow, used for testing)
• function kfr::reference_dft_md(complex<T> *, const T *, shape<dynamic_shape>, bool, size_t, size_t) Performs Multidimensional Direct Real DFT using reference implementation (slow, used for testing)
• function kfr::reference_dft(complex<T> *, const complex<T> *, size_t, bool, size_t, size_t) Performs Complex DFT using reference implementation (slow, used for testing)
• function kfr::reference_dft(complex<T> *, const T *, size_t, size_t, size_t) Performs Direct Real DFT using reference implementation (slow, used for testing)
• variable kfr::dft_stage<T>::repeats

S¶

• variable kfr::dft_plan<T>::progressive::scratch
• variable kfr::dft_plan<T>::size The size of the DFT as passed to the contructor.
• variable kfr::dft_plan_real<T>::size
• variable kfr::dft_plan_md<T, Dims>::size
• variable kfr::dft_plan_md_real<T, Dims>::size
• variable kfr::dft_stage<T>::stage_size
• variable kfr::dft_plan<T>::stages Internal data.
• variable kfr::dft_plan<T>::progressive::step

T¶

• variable kfr::dft_plan<T>::progressive::temp
• variable kfr::dft_stage<T>::temp_size
• variable kfr::dft_plan<T>::temp_size The temporary (scratch) buffer size for the DFT plan.
• variable kfr::dft_plan_md<T, Dims>::temp_size
• variable kfr::dft_plan_md_real<T, Dims>::temp_size

U¶

• variable kfr::dft_stage<T>::user