HOPS
HOPS class reference
Classes | Public Member Functions | Protected Member Functions | List of all members
hops::MHO_SelectRepack< XArgType > Class Template Reference

Class MHO_SelectRepack. More...

#include <MHO_SelectRepack.hh>

Inheritance diagram for hops::MHO_SelectRepack< XArgType >:
[legend]

Public Member Functions

 MHO_SelectRepack ()
 
virtual ~MHO_SelectRepack ()
 
void Reset ()
 Clears all entries from fAxisSelectionMap. More...
 
void SelectAxisItems (std::size_t axis_index, const std::vector< std::size_t > &valid_indexes)
 Stores valid indexes for a given axis and marks selection as uninitialized. More...
 
- Public Member Functions inherited from hops::MHO_UnaryOperator< XArgType >
 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 XArgType *in, XArgType *out)
 Setter for args. 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) override
 Executes operation in-place by calling ExecuteOutOfPlace and copying result back to input. More...
 
virtual bool ExecuteOutOfPlace (const XArgType *in, XArgType *out) override
 Function ExecuteOutOfPlace. More...
 
virtual bool InitializeInPlace (XArgType *in) override
 Initializes in-place by calling InitializeOutOfPlace with workspace. More...
 
virtual bool InitializeOutOfPlace (const XArgType *in, XArgType *out) override
 Initializes out-of-place processing for given input and output arguments. More...
 

Additional Inherited Members

- Protected Attributes inherited from hops::MHO_UnaryOperator< XArgType >
bool fInPlace
 
std::tuple< XArgType * > fInPlaceArgs
 
std::tuple< const XArgType *, XArgType * > fOutOfPlaceArgs
 

Detailed Description

template<class XArgType>
class hops::MHO_SelectRepack< XArgType >

Class MHO_SelectRepack.

operator to select data from table and repack it into an entirely new table, this typically would involve lots of copying (expensive), so it should be used sparringly (e.g. initial or final coarse data selection)

Author
J. Barrett - barre.nosp@m.ttj@.nosp@m.mit.e.nosp@m.du
Date
Thu Dec 15 16:45:22 2022 -0500

Constructor & Destructor Documentation

◆ MHO_SelectRepack()

template<class XArgType >
hops::MHO_SelectRepack< XArgType >::MHO_SelectRepack ( )
inline

◆ ~MHO_SelectRepack()

template<class XArgType >
virtual hops::MHO_SelectRepack< XArgType >::~MHO_SelectRepack ( )
inlinevirtual

Member Function Documentation

◆ ExecuteInPlace()

template<class XArgType >
virtual bool hops::MHO_SelectRepack< XArgType >::ExecuteInPlace ( XArgType *  in)
inlineoverrideprotectedvirtual

Executes operation in-place by calling ExecuteOutOfPlace and copying result back to input.

Parameters
inInput object of type XArgType* that will be modified in-place
Returns
Status of the execution operation
Note
This is a virtual function.

Implements hops::MHO_UnaryOperator< XArgType >.

◆ ExecuteOutOfPlace()

template<class XArgType >
virtual bool hops::MHO_SelectRepack< XArgType >::ExecuteOutOfPlace ( const XArgType *  in,
XArgType *  out 
)
inlineoverrideprotectedvirtual

Function ExecuteOutOfPlace.

Parameters
in(const XArgType*)
out(XArgType*)
Returns
Return value (bool)
Note
This is a virtual function.

Implements hops::MHO_UnaryOperator< XArgType >.

◆ InitializeInPlace()

template<class XArgType >
virtual bool hops::MHO_SelectRepack< XArgType >::InitializeInPlace ( XArgType *  in)
inlineoverrideprotectedvirtual

Initializes in-place by calling InitializeOutOfPlace with workspace.

Parameters
inInput pointer to XArgType object
Returns
Boolean indicating success of initialization
Note
This is a virtual function.

Implements hops::MHO_UnaryOperator< XArgType >.

◆ InitializeOutOfPlace()

template<class XArgType >
virtual bool hops::MHO_SelectRepack< XArgType >::InitializeOutOfPlace ( const XArgType *  in,
XArgType *  out 
)
inlineoverrideprotectedvirtual

Initializes out-of-place processing for given input and output arguments.

Parameters
inConst reference to input argument of type XArgType
outReference to output argument of type XArgType
Returns
Boolean indicating success or failure of initialization
Note
This is a virtual function.

Implements hops::MHO_UnaryOperator< XArgType >.

◆ Reset()

template<class XArgType >
void hops::MHO_SelectRepack< XArgType >::Reset ( )
inline

Clears all entries from fAxisSelectionMap.

◆ SelectAxisItems()

template<class XArgType >
void hops::MHO_SelectRepack< XArgType >::SelectAxisItems ( std::size_t  axis_index,
const std::vector< std::size_t > &  valid_indexes 
)
inline

Stores valid indexes for a given axis and marks selection as uninitialized.

Parameters
axis_indexIndex of the axis to store valid indexes for.
valid_indexesVector of valid indexes for the specified axis.

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