Sirius  0.0.0
Public Member Functions | Static Public Member Functions | Friends | List of all members
sirius::fftw::Fftw Class Reference

fftw3 management class More...

#include <sirius/fftw/fftw.h>

Public Member Functions

PlanSPtr GetRealToComplexPlan (const Size &size, double *in, fftw_complex *out)
 Get a r2c fftw plan of the given size. More...
 
PlanSPtr GetComplexToRealPlan (const Size &size, fftw_complex *in, double *out)
 Get a c2r fftw plan of the given size. More...
 

Static Public Member Functions

static FftwInstance ()
 Get Fftw singleton instance. More...
 

Friends

void detail::PlanDeleter::operator() (::fftw_plan)
 

Detailed Description

fftw3 management class

Member Function Documentation

◆ GetComplexToRealPlan()

PlanSPtr sirius::fftw::Fftw::GetComplexToRealPlan ( const Size size,
fftw_complex *  in,
double *  out 
)

Get a c2r fftw plan of the given size.

Parameters
sizeplan size
incomplex input array complying with the size
outreal output array complying with the size
Exceptions
sirius::fftw::Exceptionif the plan creation fails

◆ GetRealToComplexPlan()

PlanSPtr sirius::fftw::Fftw::GetRealToComplexPlan ( const Size size,
double *  in,
fftw_complex *  out 
)

Get a r2c fftw plan of the given size.

Parameters
inreal input array complying with the size
outcomplex output array complying with the size
Returns
unique ptr to the created plan
Exceptions
sirius::fftw::Exceptionif the plan creation fails

◆ Instance()

static Fftw& sirius::fftw::Fftw::Instance ( )
static

Get Fftw singleton instance.

Returns
Fftw instance

Friends And Related Function Documentation

◆ detail::PlanDeleter::operator()

void detail::PlanDeleter::operator() ( ::fftw_plan  )
friend

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