hops::MHO_InspectingOperator< XArgType > Class Template Reference

Class MHO_InspectingOperator. More...

#include <MHO_InspectingOperator.hh>

Inheritance diagram for hops::MHO_InspectingOperator< XArgType >:

Public Member Functions
	MHO_InspectingOperator ()
virtual	~MHO_InspectingOperator ()
virtual bool	Execute () override
	Executes the inspection on the input array. More...
virtual bool	Initialize () override
	initializes inspection for a single const array of type XArgType. More...
virtual void	SetArgs (const 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	ExecuteImpl (const XArgType *in)=0
	Inspects a single const array. More...
virtual bool	InitializeImpl (const XArgType *in)=0
	initializes inspection for a single const array of type XArgType. More...

Protected Attributes
const XArgType *	fArg

Detailed Description

template<class XArgType>
class hops::MHO_InspectingOperator< XArgType >

Class MHO_InspectingOperator.

abstract base (template) class which inspects an N-D array object, operates on a single const array (just to inspect it)

Author

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

Date

Tue Jan 10 16:42:53 2023 -0500

Constructor & Destructor Documentation

MHO_InspectingOperator()

template<class XArgType >

hops::MHO_InspectingOperator< XArgType >::MHO_InspectingOperator ( )

inline

~MHO_InspectingOperator()

template<class XArgType >

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

inlinevirtual

Member Function Documentation

Execute()

template<class XArgType >

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

inlineoverridevirtual

Executes the inspection on the input array.

Returns

bool indicating success/failure of execution.

Note

This is a virtual function.

Implements hops::MHO_Operator.

ExecuteImpl()

template<class XArgType >

virtual bool hops::MHO_InspectingOperator< XArgType >::ExecuteImpl ( const XArgType *  in )

protectedpure virtual

Inspects a single const array.

Parameters

in	Input const array of type XArgType to inspect.

Returns

Boolean indicating successful execution.

Note

This is a virtual function.

Implemented in hops::MHO_MBDelaySearchCUDA, hops::MHO_ExtremaSearch< XArgType >, hops::MHO_MBDelaySearch, and hops::MHO_EstimatePCManual.

Initialize()

template<class XArgType >

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

inlineoverridevirtual

initializes inspection for a single const array of type XArgType.

Returns

True if initialization is successful, false otherwise.

Note

This is a virtual function.

Implements hops::MHO_Operator.

InitializeImpl()

template<class XArgType >

virtual bool hops::MHO_InspectingOperator< XArgType >::InitializeImpl ( const XArgType *  in )

protectedpure virtual

initializes inspection for a single const array of type XArgType.

Parameters

in	Input const array of type XArgType to inspect

Returns

True if inspection is successful, false otherwise

Note

This is a virtual function.

Implemented in hops::MHO_MBDelaySearchCUDA, hops::MHO_MBDelaySearch, hops::MHO_ExtremaSearch< XArgType >, and hops::MHO_EstimatePCManual.

SetArgs()

template<class XArgType >

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

inlinevirtual

Setter for args.

Parameters

in	Input const array of XArgType to inspect

Note

This is a virtual function.

Member Data Documentation

fArg

template<class XArgType >

const XArgType* hops::MHO_InspectingOperator< XArgType >::fArg

protected

---

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

• MHO_InspectingOperator.hh