#include <MHO_FunctorBroadcaster.hh>

Inheritance diagram for hops::MHO_FunctorBroadcaster< XArrayType, XFunctorType >:

Public Member Functions
	MHO_FunctorBroadcaster ()

virtual	~MHO_FunctorBroadcaster ()

XFunctorType *	GetFunctor ()
	Getter for functor class object. More...

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) override
	Applies functor to input array in-place if initialized. More...

virtual bool	ExecuteOutOfPlace (const XArrayType in, XArrayType out) override
	Executes an out-of-place operation using a functor and input/output iterators. More...

virtual bool	InitializeInPlace (XArrayType *in) override
	Initializes in-place operation flag if input is not nullptr. More...

virtual bool	InitializeOutOfPlace (const XArrayType in, XArrayType out) override
	Function InitializeOutOfPlace - initialization for out-of-place transformation. 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<class XArrayType, class XFunctorType>
class hops::MHO_FunctorBroadcaster< XArrayType, XFunctorType >

Class MHO_FunctorBroadcaster.

Applys a functor (XFunctorType) across all the elements of a multidimensional array.

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

Date: Fri Nov 20 17:44:28 2020 -0500

Constructor & Destructor Documentation

◆ MHO_FunctorBroadcaster()

template<class XArrayType , class XFunctorType >

hops::MHO_FunctorBroadcaster< XArrayType, XFunctorType >::MHO_FunctorBroadcaster ( )

inline

◆ ~MHO_FunctorBroadcaster()

template<class XArrayType , class XFunctorType >

virtual hops::MHO_FunctorBroadcaster< XArrayType, XFunctorType >::~MHO_FunctorBroadcaster ( )

inlinevirtual

Member Function Documentation

◆ ExecuteInPlace()

template<class XArrayType , class XFunctorType >

virtual bool hops::MHO_FunctorBroadcaster< XArrayType, XFunctorType >::ExecuteInPlace ( XArrayType * in )

inlineoverrideprotectedvirtual

Applies functor to input array in-place if initialized.

Parameters

in	Input array of type XArrayType*

Returns: Boolean indicating whether processing was successful.

Note: This is a virtual function.

Implements hops::MHO_UnaryOperator< XArrayType >.

◆ ExecuteOutOfPlace()

template<class XArrayType , class XFunctorType >

virtual bool hops::MHO_FunctorBroadcaster< XArrayType, XFunctorType >::ExecuteOutOfPlace	(	const XArrayType *	in,
		XArrayType *	out
	)

inlineoverrideprotectedvirtual

Executes an out-of-place operation using a functor and input/output iterators.

Parameters

in	Const input array of type XArrayType
out	Output array of type XArrayType

Returns: True if operation is successful, false otherwise.

Note: This is a virtual function.

Implements hops::MHO_UnaryOperator< XArrayType >.

◆ GetFunctor()

template<class XArrayType , class XFunctorType >

XFunctorType* hops::MHO_FunctorBroadcaster< XArrayType, XFunctorType >::GetFunctor ( )

inline

Getter for functor class object.

Returns: Pointer to XFunctorType

◆ InitializeInPlace()

template<class XArrayType , class XFunctorType >

virtual bool hops::MHO_FunctorBroadcaster< XArrayType, XFunctorType >::InitializeInPlace ( XArrayType * in )

inlineoverrideprotectedvirtual

Initializes in-place operation flag if input is not nullptr.

Parameters

in	Input XArrayType pointer for initialization.

Returns: Current state of fInitialized boolean.

Note: This is a virtual function.

Implements hops::MHO_UnaryOperator< XArrayType >.

◆ InitializeOutOfPlace()

template<class XArrayType , class XFunctorType >

virtual bool hops::MHO_FunctorBroadcaster< XArrayType, XFunctorType >::InitializeOutOfPlace	(	const XArrayType *	in,
		XArrayType *	out
	)

inlineoverrideprotectedvirtual

Function InitializeOutOfPlace - initialization for out-of-place transformation.

Parameters

in	(const XArrayType*)
out	(XArrayType*)

Returns: Return value (bool)

Note: This is a virtual function.

Implements hops::MHO_UnaryOperator< XArrayType >.

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

MHO_FunctorBroadcaster.hh

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

template<class XArrayType, class XFunctorType> class hops::MHO_FunctorBroadcaster< XArrayType, XFunctorType >

Constructor & Destructor Documentation

◆ MHO_FunctorBroadcaster()

◆ ~MHO_FunctorBroadcaster()

Member Function Documentation

◆ ExecuteInPlace()

◆ ExecuteOutOfPlace()

◆ GetFunctor()

◆ InitializeInPlace()

◆ InitializeOutOfPlace()

template<class XArrayType, class XFunctorType>
class hops::MHO_FunctorBroadcaster< XArrayType, XFunctorType >