Class MHO_ExtremaSearch. More...
#include <MHO_ExtremaSearch.hh>
Inheritance diagram for hops::MHO_ExtremaSearch< XArgType >:
Public Member Functions | |
| MHO_ExtremaSearch () | |
| virtual | ~MHO_ExtremaSearch () |
| double | GetMax () |
| Getter for maximum value across the array. More... | |
| std::size_t | GetMaxLocation () |
| Getter for max location (offset into the array) More... | |
| double | GetMin () |
| Getter for minimum value across the. More... | |
| std::size_t | GetMinLocation () |
| Getter for min location (offset into the array) More... | |
 Public Member Functions inherited from hops::MHO_InspectingOperator< XArgType > | |
| 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) override |
| Executes search operation using input argument and returns true. More... | |
| virtual bool | InitializeImpl (const XArgType *) override |
| Initializes the operator. More... | |
Additional Inherited Members | |
| Protected Attributes inherited from hops::MHO_InspectingOperator< XArgType > | |
| const XArgType * | fArg |
Detailed Description
template<class XArgType>
class hops::MHO_ExtremaSearch< XArgType >
Class MHO_ExtremaSearch.
- Date
- Thu Jan 5 09:13:09 2023 -0500
Constructor & Destructor Documentation
◆ MHO_ExtremaSearch()
template<class XArgType >
|
inline |
◆ ~MHO_ExtremaSearch()
template<class XArgType >
|
inlinevirtual |
Member Function Documentation
◆ ExecuteImpl()
template<class XArgType >
|
inlineoverrideprotectedvirtual |
Executes search operation using input argument and returns true.
- Parameters
-
in Input argument of type const XArgType* for search operation.
- Returns
- Boolean value indicating successful execution.
- Note
- This is a virtual function.
Implements hops::MHO_InspectingOperator< XArgType >.
◆ GetMax()
template<class XArgType >
|
inline |
Getter for maximum value across the array.
- Returns
- The current maximum value as a double.
◆ GetMaxLocation()
template<class XArgType >
|
inline |
Getter for max location (offset into the array)
- Returns
- std::size_t - Maximum location value
◆ GetMin()
template<class XArgType >
|
inline |
Getter for minimum value across the.
- Returns
- The minimum value as a double.
◆ GetMinLocation()
template<class XArgType >
|
inline |
Getter for min location (offset into the array)
- Returns
- std::size_t representing the minimum location.
◆ InitializeImpl()
template<class XArgType >
|
inlineoverrideprotectedvirtual |
Initializes the operator.
- Parameters
-
!in Pointer to constant XArgType
- Returns
- True if initialization is successful, false otherwise.
- Note
- This is a virtual function.
Implements hops::MHO_InspectingOperator< XArgType >.
The documentation for this class was generated from the following file:
