hops::MHO_UnaryInPlaceOperator< XArgType > Class Template Reference

Class MHO_UnaryInPlaceOperator. More...

#include <MHO_UnaryInPlaceOperator.hh>

Inheritance diagram for hops::MHO_UnaryInPlaceOperator< XArgType >:

Public Member Functions
	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...

Protected Member Functions
virtual bool	ExecuteInPlace (XArgType *in)=0
	Executes an operation in-place using input argument. More...
virtual bool	InitializeInPlace (XArgType *in)=0
	Initializes in-place operation using input argument. More...

Protected Attributes
std::tuple< XArgType * >	fInPlaceArgs

Detailed Description

template<class XArgType>
class hops::MHO_UnaryInPlaceOperator< XArgType >

Class MHO_UnaryInPlaceOperator.

operator which only operates on a single array, input = ouput, but does the work in place without copying

Author

J. Barrett - barre.nosp@m.ttj@.nosp@m.mit.e.nosp@m.du

Date

Mon Jul 31 14:54:52 2023 -0400

Constructor & Destructor Documentation

MHO_UnaryInPlaceOperator()

template<class XArgType >

hops::MHO_UnaryInPlaceOperator< XArgType >::MHO_UnaryInPlaceOperator ( )

inline

~MHO_UnaryInPlaceOperator()

template<class XArgType >

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

inlinevirtual

Member Function Documentation

Execute()

template<class XArgType >

virtual bool hops::MHO_UnaryInPlaceOperator< XArgType >::Execute ( )

inlineoverridevirtual

Executes operation in place using provided argument.

Returns

bool indicating success of execution.

Note

This is a virtual function.

Implements hops::MHO_Operator.

ExecuteInPlace()

template<class XArgType >

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

protectedpure virtual

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.

Implemented in hops::MHO_OpenCLMultidimensionalFastFourierTransform< XArgType >, and hops::MHO_OpenCLFastFourierTransformRadix2Stage< XArgType >.

Initialize()

template<class XArgType >

virtual bool hops::MHO_UnaryInPlaceOperator< XArgType >::Initialize ( )

inlineoverridevirtual

Initializes the system by calling InitializeInPlace with the first argument from fInPlaceArgs.

Returns

bool indicating success/failure of initialization

Note

This is a virtual function.

Implements hops::MHO_Operator.

InitializeInPlace()

template<class XArgType >

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

protectedpure virtual

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.

Implemented in hops::MHO_OpenCLMultidimensionalFastFourierTransform< XArgType >, and hops::MHO_OpenCLFastFourierTransformRadix2Stage< XArgType >.

SetArgs()

template<class XArgType >

virtual void hops::MHO_UnaryInPlaceOperator< XArgType >::SetArgs ( XArgType *  in )

inlinevirtual

Setter for args.

Parameters

in	Input pointer to XArgType array

Note

This is a virtual function.

Member Data Documentation

fInPlaceArgs

template<class XArgType >

std::tuple< XArgType* > hops::MHO_UnaryInPlaceOperator< XArgType >::fInPlaceArgs

protected

---

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

• MHO_UnaryInPlaceOperator.hh