underling  0.3.2
Classes | Namespaces | Typedefs | Enumerations | Functions
underling_fftw.hpp File Reference

Detailed Description

Provides C++ wrappers for the C-based API in underling_fftw.h. In particular, provides RAII semantics for opaque types.

Go to the source code of this file.

Classes

class  underling::fftw::plan
 Provides a thin RAII wrapper for underling_fftw_plan. More...
 
struct  underling::fftw::plan::c2c_forward
 A tag type used to indicate a complex-to-complex forward transform. More...
 
struct  underling::fftw::plan::c2c_backward
 A tag type used to indicate a complex-to-complex backward transform. More...
 
struct  underling::fftw::plan::r2c_forward
 A tag type used to indicate a real-to-complex forward transform. More...
 
struct  underling::fftw::plan::c2r_backward
 A tag type used to indicate a complex-to-real backward transform. More...
 

Namespaces

 underling
 Provides C++ wrappers for underling's C-based API.
 
 underling::fftw
 
 underling::fftw::packed
 Wraps packed storage flags.
 

Typedefs

typedef underling_fftw_extents underling::fftw::extents
 

Enumerations

enum  { underling::fftw::packed::long_n2, underling::fftw::packed::long_n0, underling::fftw::packed::all, underling::fftw::packed::none }
 

Functions

template<typename charT , typename traits >
std::basic_ostream< charT, traits > & operator<< (std::basic_ostream< charT, traits > &os, const underling::fftw::extents &e)
 Outputs an underling_extents or underling::fftw::extents instance as a human-readable string on any std::basic_ostream. More...
 
bool operator== (const underling::fftw::extents &e1, const underling::fftw::extents &e2)
 

Function Documentation

◆ operator<<()

template<typename charT , typename traits >
std::basic_ostream<charT,traits>& operator<< ( std::basic_ostream< charT, traits > &  os,
const underling::fftw::extents e 
)

Outputs an underling_extents or underling::fftw::extents instance as a human-readable string on any std::basic_ostream.

Parameters
osOn which to output e.
eTo be output.
Returns
The modified os.

◆ operator==()

bool operator== ( const underling::fftw::extents e1,
const underling::fftw::extents e2 
)
inline

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