Highly Efficient FFT for Exascale: HeFFTe v2.4
Loading...
Searching...
No Matches
heffte::plan_fftw< std::complex< float >, dir > Struct Template Reference

Plan for the single precision complex transform. More...

#include <heffte_backend_fftw.h>

Public Member Functions

 plan_fftw (int size, int howmanyffts, int stride, int dist)
 Constructor, takes inputs identical to fftwf_plan_many_dft().
 
 plan_fftw (int size1, int size2, std::array< int, 2 > const &embed, int howmanyffts, int stride, int dist)
 Constructor, takes inputs identical to fftwf_plan_many_dft().
 
 plan_fftw (int size1, int size2, int size3)
 Identical to the float-complex specialization.
 
 ~plan_fftw ()
 Destructor, deletes the plan.
 
 operator fftwf_plan () const
 Custom conversion to the FFTW3 plan.
 

Public Attributes

fftwf_plan plan
 The FFTW3 opaque structure (pointer to struct).
 

Detailed Description

template<direction dir>
struct heffte::plan_fftw< std::complex< float >, dir >

Plan for the single precision complex transform.

Template Parameters
dirindicates a forward or backward transform

Constructor & Destructor Documentation

◆ plan_fftw() [1/2]

template<direction dir>
heffte::plan_fftw< std::complex< float >, dir >::plan_fftw ( int size,
int howmanyffts,
int stride,
int dist )
inline

Constructor, takes inputs identical to fftwf_plan_many_dft().

Parameters
sizeis the number of entries in a 1-D transform
howmanyfftsis the number of transforms in the batch
strideis the distance between entries of the same transform
distis the distance between the first entries of consecutive sequences

◆ plan_fftw() [2/2]

template<direction dir>
heffte::plan_fftw< std::complex< float >, dir >::plan_fftw ( int size1,
int size2,
std::array< int, 2 > const & embed,
int howmanyffts,
int stride,
int dist )
inline

Constructor, takes inputs identical to fftwf_plan_many_dft().

Parameters
size1is the number of entries in a 2-D transform, dimension 1
size2is the number of entries in a 2-D transform, dimension 2
embedis the size of the leading dimensions of the data array
howmanyfftsis the number of transforms in the batch
strideis the distance between entries of the same transform
distis the distance between the first entries of consecutive sequences

The documentation for this struct was generated from the following file: