HOPS
HOPS class reference
Public Member Functions | Public Attributes | List of all members
hops::MHO_FastFourierTransformWorkspace< XFloatType > Class Template Reference

navtive FFT workspace definitions More...

#include <MHO_FastFourierTransformWorkspace.hh>

Public Member Functions

 MHO_FastFourierTransformWorkspace ()
 
 MHO_FastFourierTransformWorkspace (const MHO_FastFourierTransformWorkspace &copy)
 
 MHO_FastFourierTransformWorkspace (unsigned int n)
 
virtual ~MHO_FastFourierTransformWorkspace ()
 
const std::complex< XFloatType > * GetCirculant () const
 Getter for circulant. More...
 
const std::complex< XFloatType > * GetConjTwiddle () const
 Getter for conj twiddle. More...
 
unsigned int GetM ()
 Getter for m. More...
 
unsigned int GetN ()
 Getter for n. More...
 
const unsigned int * GetPermutation () const
 Getter for permutation. More...
 
const std::complex< XFloatType > * GetScale () const
 Getter for scale. More...
 
const std::complex< XFloatType > * GetTwiddle () const
 Getter for twiddle. More...
 
std::complex< XFloatType > * GetWorkspace () const
 Getter for workspace. More...
 
bool IsRadix2 ()
 Checks if the current workspace is for radix-2 FFT. More...
 
void Resize (unsigned int n)
 Resizes the internal data structure to a new size and fills it. More...
 

Public Attributes

std::complex< XFloatType > * fCirculant
 
std::complex< XFloatType > * fConjugateTwiddle
 
unsigned int fM
 
unsigned int fN
 
unsigned int * fPermutation
 
std::complex< XFloatType > * fScale
 
std::complex< XFloatType > * fTwiddle
 
std::complex< XFloatType > * fWorkspace
 

Detailed Description

template<typename XFloatType>
class hops::MHO_FastFourierTransformWorkspace< XFloatType >

navtive FFT workspace definitions

Date
Mon Jul 31 15:44:01 2023 -0400
Author
J. Barrett - barre.nosp@m.ttj@.nosp@m.mit.e.nosp@m.du

Constructor & Destructor Documentation

◆ MHO_FastFourierTransformWorkspace() [1/3]

template<typename XFloatType >
hops::MHO_FastFourierTransformWorkspace< XFloatType >::MHO_FastFourierTransformWorkspace ( )
inline

◆ MHO_FastFourierTransformWorkspace() [2/3]

template<typename XFloatType >
hops::MHO_FastFourierTransformWorkspace< XFloatType >::MHO_FastFourierTransformWorkspace ( unsigned int  n)
inline

◆ MHO_FastFourierTransformWorkspace() [3/3]

template<typename XFloatType >
hops::MHO_FastFourierTransformWorkspace< XFloatType >::MHO_FastFourierTransformWorkspace ( const MHO_FastFourierTransformWorkspace< XFloatType > &  copy)
inline

◆ ~MHO_FastFourierTransformWorkspace()

template<typename XFloatType >
virtual hops::MHO_FastFourierTransformWorkspace< XFloatType >::~MHO_FastFourierTransformWorkspace ( )
inlinevirtual

Member Function Documentation

◆ GetCirculant()

template<typename XFloatType >
const std::complex< XFloatType >* hops::MHO_FastFourierTransformWorkspace< XFloatType >::GetCirculant ( ) const
inline

Getter for circulant.

Returns
Current circulant value of type XFloatType

◆ GetConjTwiddle()

template<typename XFloatType >
const std::complex< XFloatType >* hops::MHO_FastFourierTransformWorkspace< XFloatType >::GetConjTwiddle ( ) const
inline

Getter for conj twiddle.

Returns
Conjugate twiddle value of type XFloatType*

◆ GetM()

template<typename XFloatType >
unsigned int hops::MHO_FastFourierTransformWorkspace< XFloatType >::GetM ( )
inline

Getter for m.

Returns
unsigned int value of fM

◆ GetN()

template<typename XFloatType >
unsigned int hops::MHO_FastFourierTransformWorkspace< XFloatType >::GetN ( )
inline

Getter for n.

Returns
Current value of unsigned integer n

◆ GetPermutation()

template<typename XFloatType >
const unsigned int* hops::MHO_FastFourierTransformWorkspace< XFloatType >::GetPermutation ( ) const
inline

Getter for permutation.

Returns
Pointer to unsigned integer containing the permutation value.

◆ GetScale()

template<typename XFloatType >
const std::complex< XFloatType >* hops::MHO_FastFourierTransformWorkspace< XFloatType >::GetScale ( ) const
inline

Getter for scale.

Returns
Pointer to XFloatType representing the current scale.

◆ GetTwiddle()

template<typename XFloatType >
const std::complex< XFloatType >* hops::MHO_FastFourierTransformWorkspace< XFloatType >::GetTwiddle ( ) const
inline

Getter for twiddle.

Returns
Current value of twiddle as XFloatType pointer

◆ GetWorkspace()

template<typename XFloatType >
std::complex< XFloatType >* hops::MHO_FastFourierTransformWorkspace< XFloatType >::GetWorkspace ( ) const
inline

Getter for workspace.

Returns
Pointer to XFloatType workspace

◆ IsRadix2()

template<typename XFloatType >
bool hops::MHO_FastFourierTransformWorkspace< XFloatType >::IsRadix2 ( )
inline

Checks if the current workspace is for radix-2 FFT.

Returns
True if radix is 2, false otherwise (Bluestein).

◆ Resize()

template<typename XFloatType >
void hops::MHO_FastFourierTransformWorkspace< XFloatType >::Resize ( unsigned int  n)
inline

Resizes the internal data structure to a new size and fills it.

Parameters
nNew size for the data structure.

Member Data Documentation

◆ fCirculant

template<typename XFloatType >
std::complex< XFloatType >* hops::MHO_FastFourierTransformWorkspace< XFloatType >::fCirculant

◆ fConjugateTwiddle

template<typename XFloatType >
std::complex< XFloatType >* hops::MHO_FastFourierTransformWorkspace< XFloatType >::fConjugateTwiddle

◆ fM

template<typename XFloatType >
unsigned int hops::MHO_FastFourierTransformWorkspace< XFloatType >::fM

◆ fN

template<typename XFloatType >
unsigned int hops::MHO_FastFourierTransformWorkspace< XFloatType >::fN

◆ fPermutation

template<typename XFloatType >
unsigned int* hops::MHO_FastFourierTransformWorkspace< XFloatType >::fPermutation

◆ fScale

template<typename XFloatType >
std::complex< XFloatType >* hops::MHO_FastFourierTransformWorkspace< XFloatType >::fScale

◆ fTwiddle

template<typename XFloatType >
std::complex< XFloatType >* hops::MHO_FastFourierTransformWorkspace< XFloatType >::fTwiddle

◆ fWorkspace

template<typename XFloatType >
std::complex< XFloatType >* hops::MHO_FastFourierTransformWorkspace< XFloatType >::fWorkspace

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