underling: underling::fftw::plan Class Reference

underling 0.3.2

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

Detailed Description

Provides a thin RAII wrapper for underling_fftw_plan.

See also: underling_fftw_plan.

Classes
struct	c2c_backward
	A tag type used to indicate a complex-to-complex backward transform. More...

struct	c2c_forward
	A tag type used to indicate a complex-to-complex forward transform. More...

struct	c2r_backward
	A tag type used to indicate a complex-to-real backward transform. More...

struct	r2c_forward
	A tag type used to indicate a real-to-complex forward transform. More...

Public Member Functions
	plan (const c2c_forward tag, const problem &p, int long_ni, underling_real in, underling_real out, unsigned fftw_rigor_flags=0, unsigned packed_flags=0)

	plan (const c2c_backward tag, const problem &p, int long_ni, underling_real in, underling_real out, unsigned fftw_rigor_flags=0, unsigned packed_flags=0)

	plan (const r2c_forward tag, const problem &p, int long_ni, underling_real in, underling_real out, unsigned fftw_rigor_flags=0, unsigned packed_flags=0)

	plan (const c2r_backward tag, const problem &p, int long_ni, underling_real in, underling_real out, unsigned fftw_rigor_flags=0, unsigned packed_flags=0)

	plan (const plan &plan_to_invert, underling_real in, underling_real out, unsigned fftw_rigor_flags=0)

	~plan ()

underling_fftw_plan	get () const

underling_fftw_extents	local_extents_input () const

underling_fftw_extents	local_extents_output () const

int	local_input (int start=NULL, int size=NULL, int stride=NULL, int order=NULL) const

int	local_output (int start=NULL, int size=NULL, int stride=NULL, int order=NULL) const

	operator bool () const

int	execute (underling_real in, underling_real out) const

Constructor & Destructor Documentation

◆ plan() [1/5]

underling::fftw::plan::plan	(	const c2c_forward	tag,
		const problem &	p,
		int	long_ni,
		underling_real *	in,
		underling_real *	out,
		unsigned	fftw_rigor_flags = `0`,
		unsigned	packed_flags = `0`
	)

inline

See also: underling_fftw_plan_create_c2c_forward

◆ plan() [2/5]

underling::fftw::plan::plan	(	const c2c_backward	tag,
		const problem &	p,
		int	long_ni,
		underling_real *	in,
		underling_real *	out,
		unsigned	fftw_rigor_flags = `0`,
		unsigned	packed_flags = `0`
	)

inline

See also: underling_fftw_plan_create_c2c_backward

◆ plan() [3/5]

underling::fftw::plan::plan	(	const r2c_forward	tag,
		const problem &	p,
		int	long_ni,
		underling_real *	in,
		underling_real *	out,
		unsigned	fftw_rigor_flags = `0`,
		unsigned	packed_flags = `0`
	)

inline

See also: underling_fftw_plan_create_r2c_forward

◆ plan() [4/5]

underling::fftw::plan::plan	(	const c2r_backward	tag,
		const problem &	p,
		int	long_ni,
		underling_real *	in,
		underling_real *	out,
		unsigned	fftw_rigor_flags = `0`,
		unsigned	packed_flags = `0`
	)

inline

See also: underling_fftw_plan_create_c2r_backward

◆ plan() [5/5]

underling::fftw::plan::plan	(	const plan &	plan_to_invert,
		underling_real *	in,
		underling_real *	out,
		unsigned	fftw_rigor_flags = `0`
	)

inline

See also: underling_fftw_plan_create_inverse

◆ ~plan()

underling::fftw::plan::~plan ( )

inline

See also: underling_fftw_plan_destroy

Member Function Documentation

◆ execute()

int underling::fftw::plan::execute	(	underling_real *	in,
		underling_real *	out
	)		const

inline

See also: underling_fftw_plan_execute

◆ get()

underling_fftw_plan underling::fftw::plan::get ( ) const

inline

Returns: The wrapped underling_fftw_plan instance.

◆ local_extents_input()

underling_fftw_extents underling::fftw::plan::local_extents_input ( ) const

inline

See also: underling_fftw_local_extents_input

◆ local_extents_output()

underling_fftw_extents underling::fftw::plan::local_extents_output ( ) const

inline

See also: underling_fftw_local_extents_output

◆ local_input()

int underling::fftw::plan::local_input	(	int *	start = `NULL`,
		int *	size = `NULL`,
		int *	stride = `NULL`,
		int *	order = `NULL`
	)		const

inline

See also: underling_fftw_local_input

◆ local_output()

int underling::fftw::plan::local_output	(	int *	start = `NULL`,
		int *	size = `NULL`,
		int *	stride = `NULL`,
		int *	order = `NULL`
	)		const

inline

See also: underling_fftw_local_output

◆ operator bool()

underling::fftw::plan::operator bool ( ) const

inline

Returns: True if wrapped underling_fftw_plan instance is non-NULL.

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

underling/underling_fftw.hpp

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