hops::MHO_OpenCLScalarMultiply< XFactorType, XArrayType > Class Template Reference

#include <MHO_OpenCLScalarMultiply.hh>

Inheritance diagram for hops::MHO_OpenCLScalarMultiply< XFactorType, XArrayType >:

Public Member Functions
	MHO_OpenCLScalarMultiply ()
virtual	~MHO_OpenCLScalarMultiply ()
XFactorType	GetFactor () const
void	SetFactor (XFactorType factor)
void	SetReadFalse ()
void	SetReadTrue ()
void	SetWriteFalse ()
void	SetWriteTrue ()
Public Member Functions inherited from hops::MHO_UnaryOperator< XArrayType >
	MHO_UnaryOperator ()
virtual	~MHO_UnaryOperator ()
virtual bool	Execute () override
	Executes operation using provided arguments and return type. More...
virtual bool	Execute () override=0
	Function Execute. More...
virtual bool	Initialize () override
	Initializes the system using in-place or out-of-place arguments. More...
virtual bool	Initialize () override=0
	Function Initialize. More...
	MHO_Operator ()
virtual void	SetArgs (const XArrayType *in, XArrayType *out)
	Setter for args. More...
virtual void	SetArgs (XArrayType *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 (XArrayType *in)
	Function ExecuteInPlace. More...
virtual bool	ExecuteOutOfPlace (const XArrayType *in, XArrayType *out)
	Function ExecuteOutOfPlace. More...
virtual bool	InitializeInPlace (XArrayType *in)
	Function InitializeInPlace. More...
virtual bool	InitializeOutOfPlace (const XArrayType *in, XArrayType *out)
	Function InitializeOutOfPlace. More...

Additional Inherited Members
Protected Attributes inherited from hops::MHO_UnaryOperator< XArrayType >
bool	fInPlace
std::tuple< XArrayType * >	fInPlaceArgs
std::tuple< const XArrayType *, XArrayType * >	fOutOfPlaceArgs

Detailed Description

template<typename XFactorType, class XArrayType>
class hops::MHO_OpenCLScalarMultiply< XFactorType, XArrayType >

Author

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

Date

Constructor & Destructor Documentation

MHO_OpenCLScalarMultiply()

template<typename XFactorType , class XArrayType >

hops::MHO_OpenCLScalarMultiply< XFactorType, XArrayType >::MHO_OpenCLScalarMultiply ( )

inline

~MHO_OpenCLScalarMultiply()

template<typename XFactorType , class XArrayType >

virtual hops::MHO_OpenCLScalarMultiply< XFactorType, XArrayType >::~MHO_OpenCLScalarMultiply ( )

inlinevirtual

Member Function Documentation

ExecuteInPlace()

template<typename XFactorType , class XArrayType >

virtual bool hops::MHO_OpenCLScalarMultiply< XFactorType, XArrayType >::ExecuteInPlace ( XArrayType *  in )

inlineprotectedvirtual

Function ExecuteInPlace.

Parameters

in	(XArgType*)

Returns

Return value (bool)

Note

This is a virtual function.

Implements hops::MHO_UnaryOperator< XArrayType >.

ExecuteOutOfPlace()

template<typename XFactorType , class XArrayType >

virtual bool hops::MHO_OpenCLScalarMultiply< XFactorType, XArrayType >::ExecuteOutOfPlace ( const XArrayType *  in, XArrayType *  out  )

inlineprotectedvirtual

Function ExecuteOutOfPlace.

Parameters

in	(const XArgType*)
out	(XArgType*)

Returns

Return value (bool)

Note

This is a virtual function.

Implements hops::MHO_UnaryOperator< XArrayType >.

GetFactor()

template<typename XFactorType , class XArrayType >

XFactorType hops::MHO_OpenCLScalarMultiply< XFactorType, XArrayType >::GetFactor ( ) const

inline

InitializeInPlace()

template<typename XFactorType , class XArrayType >

virtual bool hops::MHO_OpenCLScalarMultiply< XFactorType, XArrayType >::InitializeInPlace ( XArrayType *  in )

inlineprotectedvirtual

Function InitializeInPlace.

Parameters

in	(XArgType*)

Returns

Return value (bool)

Note

This is a virtual function.

Implements hops::MHO_UnaryOperator< XArrayType >.

InitializeOutOfPlace()

template<typename XFactorType , class XArrayType >

virtual bool hops::MHO_OpenCLScalarMultiply< XFactorType, XArrayType >::InitializeOutOfPlace ( const XArrayType *  in, XArrayType *  out  )

inlineprotectedvirtual

Function InitializeOutOfPlace.

Parameters

in	(const XArgType*)
out	(XArgType*)

Returns

Return value (bool)

Note

This is a virtual function.

Implements hops::MHO_UnaryOperator< XArrayType >.

SetFactor()

template<typename XFactorType , class XArrayType >

void hops::MHO_OpenCLScalarMultiply< XFactorType, XArrayType >::SetFactor ( XFactorType  factor )

inline

SetReadFalse()

template<typename XFactorType , class XArrayType >

void hops::MHO_OpenCLScalarMultiply< XFactorType, XArrayType >::SetReadFalse ( )

inline

SetReadTrue()

template<typename XFactorType , class XArrayType >

void hops::MHO_OpenCLScalarMultiply< XFactorType, XArrayType >::SetReadTrue ( )

inline

SetWriteFalse()

template<typename XFactorType , class XArrayType >

void hops::MHO_OpenCLScalarMultiply< XFactorType, XArrayType >::SetWriteFalse ( )

inline

SetWriteTrue()

template<typename XFactorType , class XArrayType >

void hops::MHO_OpenCLScalarMultiply< XFactorType, XArrayType >::SetWriteTrue ( )

inline

---

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

• MHO_OpenCLScalarMultiply.hh