hops::MHO_OpenCLMultidimensionalFastFourierTransform< XArgType > Class Template Reference

#include <MHO_OpenCLMultidimensionalFastFourierTransform.hh>

Inheritance diagram for hops::MHO_OpenCLMultidimensionalFastFourierTransform< XArgType >:

Public Types
using	complex_value_type = typename XArgType::value_type
using	floating_point_value_type = typename XArgType::value_type::value_type
Public Types inherited from hops::MHO_MultidimensionalFastFourierTransformInterface< XArgType >
using	complex_value_type = typename XArgType::value_type
using	floating_point_value_type = typename XArgType::value_type::value_type

Public Member Functions
	MHO_OpenCLMultidimensionalFastFourierTransform ()
virtual	~MHO_OpenCLMultidimensionalFastFourierTransform ()
Public Member Functions inherited from hops::MHO_UnaryInPlaceOperator< XArgType >
	MHO_UnaryInPlaceOperator ()
virtual	~MHO_UnaryInPlaceOperator ()
virtual bool	Execute () override
	Executes operation in place using provided argument. More...
virtual bool	Initialize () override
	Initializes the system by calling InitializeInPlace with the first argument from fInPlaceArgs. More...
virtual void	SetArgs (XArgType *in)
	Setter for args. More...
Public Member Functions inherited from hops::MHO_Operator
	MHO_Operator ()
virtual	~MHO_Operator ()
std::string	GetName () const
	Getter for operator name. More...
virtual double	Priority () const
	Get the the priority field value. More...
void	SetName (std::string name)
	Setter for operator name. More...
virtual void	SetPriority (const double &priority)
	Setter for operator priority (determines order of execution within a operator category) More...
Public Member Functions inherited from hops::MHO_MultidimensionalFastFourierTransformInterface< XArgType >
	MHO_MultidimensionalFastFourierTransformInterface ()
virtual	~MHO_MultidimensionalFastFourierTransformInterface ()
virtual void	DeselectAllAxes ()
	Deselects all axes by setting fAxesToXForm to false and resetting initialization. More...
void	DisableAxisLabelTransformation ()
	Disables axis label transformation by setting fTransformAxisLabels to false. More...
void	EnableAxisLabelTransformation ()
	Enables transformation for axis labels. More...
virtual void	SelectAllAxes ()
	Selects all axes for transformation. More...
virtual void	SelectAxis (std::size_t axis_index)
	Selects an axis for transformation if within array rank. More...
virtual void	SetBackward ()
	Setter for backward. More...
virtual void	SetForward ()
	Setter for forward. More...

Protected Member Functions
virtual bool	ExecuteInPlace (XArgType *in) override
	Executes an operation in-place using input argument. More...
virtual bool	InitializeInPlace (XArgType *in) override
	Initializes in-place operation using input argument. More...
Protected Member Functions inherited from hops::MHO_MultidimensionalFastFourierTransformInterface< XArgType >
template<typename XCheckType = XArgType>
std::enable_if< !std::is_base_of< MHO_TableContainerBase, XCheckType >::value, void >::type	IfTableTransformAxis (XArgType *, std::size_t)
	Transforms axis of input data if transformation is enabled and axis was transformed. More...
template<typename XCheckType = XArgType>
std::enable_if< std::is_base_of< MHO_TableContainerBase, XCheckType >::value, void >::type	IfTableTransformAxis (XArgType *in, std::size_t axis_index)
	Transforms axis of input table if specified dimension was transformed. More...

Additional Inherited Members
Protected Attributes inherited from hops::MHO_UnaryInPlaceOperator< XArgType >
std::tuple< XArgType * >	fInPlaceArgs
Protected Attributes inherited from hops::MHO_MultidimensionalFastFourierTransformInterface< XArgType >
bool	fAxesToXForm [XArgType::rank::value]
size_t	fDimensionSize [XArgType::rank::value]
bool	fForward
bool	fInitialized
bool	fIsValid
bool	fTransformAxisLabels

Member Typedef Documentation

complex_value_type

template<typename XArgType >

using hops::MHO_OpenCLMultidimensionalFastFourierTransform< XArgType >::complex_value_type = typename XArgType::value_type

floating_point_value_type

template<typename XArgType >

using hops::MHO_OpenCLMultidimensionalFastFourierTransform< XArgType >::floating_point_value_type = typename XArgType::value_type::value_type

Constructor & Destructor Documentation

MHO_OpenCLMultidimensionalFastFourierTransform()

template<typename XArgType >

hops::MHO_OpenCLMultidimensionalFastFourierTransform< XArgType >::MHO_OpenCLMultidimensionalFastFourierTransform ( )

inline

~MHO_OpenCLMultidimensionalFastFourierTransform()

template<typename XArgType >

virtual hops::MHO_OpenCLMultidimensionalFastFourierTransform< XArgType >::~MHO_OpenCLMultidimensionalFastFourierTransform ( )

inlinevirtual

Member Function Documentation

ExecuteInPlace()

template<typename XArgType >

virtual bool hops::MHO_OpenCLMultidimensionalFastFourierTransform< XArgType >::ExecuteInPlace ( XArgType *  in )

inlineoverrideprotectedvirtual

Executes an operation in-place using input argument.

Parameters

in	Input argument for executing operation.

Returns

True if execution is successful, false otherwise.

Note

This is a virtual function.

Implements hops::MHO_UnaryInPlaceOperator< XArgType >.

InitializeInPlace()

template<typename XArgType >

virtual bool hops::MHO_OpenCLMultidimensionalFastFourierTransform< XArgType >::InitializeInPlace ( XArgType *  in )

inlineoverrideprotectedvirtual

Initializes in-place operation using input argument.

Parameters

in	Input argument of type XArgType* for initialization.

Returns

Boolean indicating success of initialization.

Note

This is a virtual function.

Implements hops::MHO_UnaryInPlaceOperator< XArgType >.

---

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

• MHO_OpenCLMultidimensionalFastFourierTransform.hh