underling  0.3.2
List of all members | Public Member Functions
underling::plan Class Reference

Provides a thin RAII wrapper for underling_plan. More...

Detailed Description

Provides a thin RAII wrapper for underling_plan.

See also
underling_plan.

Public Member Functions

 plan (const problem &p, underling_real *in, underling_real *out, unsigned transpose_flags=0, unsigned fftw_rigor_flags=0)
 
 ~plan ()
 
underling_plan get () const
 
int execute_long_n2_to_long_n1 (underling_real *in, underling_real *out) const
 
int execute_long_n1_to_long_n0 (underling_real *in, underling_real *out) const
 
int execute_long_n0_to_long_n1 (underling_real *in, underling_real *out) const
 
int execute_long_n1_to_long_n2 (underling_real *in, underling_real *out) const
 
 operator bool () const
 

Constructor & Destructor Documentation

◆ plan()

underling::plan::plan ( const problem p,
underling_real in,
underling_real out,
unsigned  transpose_flags = 0,
unsigned  fftw_rigor_flags = 0 
)
inline

◆ ~plan()

underling::plan::~plan ( )
inline

Member Function Documentation

◆ execute_long_n0_to_long_n1()

int underling::plan::execute_long_n0_to_long_n1 ( underling_real in,
underling_real out 
) const
inline

◆ execute_long_n1_to_long_n0()

int underling::plan::execute_long_n1_to_long_n0 ( underling_real in,
underling_real out 
) const
inline

◆ execute_long_n1_to_long_n2()

int underling::plan::execute_long_n1_to_long_n2 ( underling_real in,
underling_real out 
) const
inline

◆ execute_long_n2_to_long_n1()

int underling::plan::execute_long_n2_to_long_n1 ( underling_real in,
underling_real out 
) const
inline

◆ get()

underling_plan underling::plan::get ( ) const
inline
Returns
The wrapped underling_plan instance.

◆ operator bool()

underling::plan::operator bool ( ) const
inline
Returns
True if the wrapped underling_problem instance is non-NULL.

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

Generated on Wed Jul 1 2026 13:22:58 for underling by  doxygen 1.8.17