NOMAD Source  Version 4.0.0 Beta
MegaSearchPoll Class Reference

Class for the mega search and poll of MADS. More...

#include <MegaSearchPoll.hpp>

Inheritance diagram for MegaSearchPoll:
Collaboration diagram for MegaSearchPoll:

Public Member Functions

 MegaSearchPoll (const Step *parentStep)
 Constructor. More...
 
virtual ~MegaSearchPoll ()
 
const std::shared_ptr< MadsIterationgetIterForPoint (const EvalPoint &point) const
 
- Public Member Functions inherited from Step
 Step ()
 Constructor #1 for MainStep (no parent) More...
 
 Step (const Step *parentStep, const std::shared_ptr< RunParameters > &runParams=nullptr, const std::shared_ptr< PbParameters > &pbParams=nullptr)
 Constructor #2 for child step of a parent sharing the same stopReason. More...
 
 Step (const Step *parentStep, std::shared_ptr< AllStopReasons > stopReasons, const std::shared_ptr< RunParameters > &runParams=nullptr, const std::shared_ptr< PbParameters > &pbParams=nullptr)
 Constructor #3: for a child Step with a provided stopReason (such as an algorithm) More...
 
virtual ~Step ()
 Destructor. More...
 
const StepgetParentStep () const
 Get the parent step. More...
 
virtual const std::string & getName () const
 Get the name of this step. More...
 
void setName (const std::string &name)
 Set the name of this step. More...
 
const std::shared_ptr< AllStopReasons > & getAllStopReasons () const
 
const std::shared_ptr< RunParameters > & getRunParams () const
 
const std::shared_ptr< PbParameters > & getPbParams () const
 
void addCallback (const CallbackType &callbackType, const StepEndCbFunc &stepEndCbFunc)
 Set user callback. More...
 
void addCallback (const CallbackType &callbackType, const HotRestartCbFunc &hotRestartCbFunc)
 
void AddOutputInfo (const std::string &s, bool isBlockStart, bool isBlockEnd) const
 display output More...
 
void AddOutputInfo (const std::string &s, OutputLevel outputLevel=OutputLevel::LEVEL_INFO) const
 
void AddOutputError (const std::string &s) const
 
void AddOutputWarning (const std::string &s) const
 
void AddOutputVeryHigh (const std::string &s) const
 
void AddOutputHigh (const std::string &s) const
 
void AddOutputDebug (const std::string &s) const
 
void AddOutputInfo (OutputInfo outputInfo) const
 
template<typename T >
getParentOfType (const bool stopAtAlgo=true) const
 Template function to get the parent of given type. More...
 
bool isAnAlgorithm () const
 
const AlgorithmgetRootAlgorithm () const
 Get Algorithm ancestor that has no Algorithm ancestor. More...
 
std::string getAlgoName () const
 
virtual std::string getAlgoComment () const
 
virtual void setAlgoComment (const std::string &algoComment, const bool force=false)
 
virtual void resetPreviousAlgoComment (const bool force=false)
 
const std::shared_ptr< MeshBasegetIterationMesh () const
 
const std::shared_ptr< EvalPointgetIterationFrameCenter () const
 
const std::shared_ptr< BarriergetMegaIterationBarrier () const
 
void start ()
 
bool run ()
 
void end ()
 
virtual void hotRestartOnUserInterrupt ()
 Helper for hot restart functionalities. More...
 
void debugShowCallStack () const
 For debugging purposes. Show the stack of Steps for this step. More...
 
- Public Member Functions inherited from IterationUtils
 IterationUtils (const Step *parentStep)
 Constructor. More...
 
virtual ~IterationUtils ()
 Destructor. More...
 
const SuccessTypegetSuccessType () const
 
void setSuccessType (const SuccessType &success)
 
size_t getTrialPointsCount () const
 
const EvalPointSetgetTrialPoints () const
 
bool insertTrialPoint (const EvalPoint &evalPoint)
 Insert a trial point. More...
 
void clearTrialPoints (void)
 Clear trial points. More...
 
virtual bool postProcessing (const EvalType &evalType)
 Helper for end task. More...
 
void verifyPointsAreOnMesh (const std::string &name) const
 Helper for start task. More...
 
bool snapPointToBoundsAndProjectOnMesh (Point &point, const ArrayOfDouble &lowerBound, const ArrayOfDouble &upperBound)
 Snap a given trial point to the bounds and project on mesh. More...
 
bool evalTrialPoints (Step *step)
 Start evaluation of the trial points. More...
 
size_t getNbEvalPointsThatNeededEval () const
 Get the number of evaluation points in the queue for evaluation. More...
 
void updatePointsWithFrameCenter ()
 Add current frame center as originator of each point in trialPoints. More...
 

Private Member Functions

virtual void startImp () override
 Generate the trial poins for the search and poll steps. More...
 
virtual bool runImp () override
 Start evaluations. More...
 
virtual void endImp () override
 
void init ()
 
void generateTrialPoints () override
 Generate new points to evaluate. More...
 

Private Attributes

std::map< EvalPoint, std::shared_ptr< MadsIteration >, EvalPointCompare_iterForPoint
 

Additional Inherited Members

- Static Public Member Functions inherited from Step
static bool getUserTerminate ()
 Interruption call by user. More...
 
static void setUserTerminate ()
 Interruption requested. More...
 
static void userInterrupt (int signalValue)
 Interruption call by user. More...
 
static void debugSegFault (int signalValue)
 
static bool getUserInterrupt ()
 
static void runCallback (CallbackType callbackType, const Step &step, bool &stop)
 Run user callback. More...
 
static void runCallback (CallbackType callbackType, std::vector< std::string > &paramLines)
 
static void disableWarnings ()
 
- Protected Member Functions inherited from Step
void verifyParentNotNull ()
 Helper for constructors. More...
 
void verifyGenerateAllPointsBeforeEval (const std::string &method, const bool expected) const
 Helper for validating steps depending on parameter GENERATE_ALL_POINTS_BEFORE_EVAL. More...
 
void hotRestartBeginHelper ()
 Helpers for hot restart, to be called at the start and end of any override. More...
 
void hotRestartEndHelper ()
 Helpers for hot restart, to be called at the start and end of any override. More...
 
- Protected Attributes inherited from Step
const Step_parentStep
 The parent of this step. More...
 
std::string _name
 The name of this step. More...
 
std::shared_ptr< AllStopReasons_stopReasons
 The stop reasons of an algorithm. More...
 
std::shared_ptr< RunParameters_runParams
 The run parameters that control a step. More...
 
std::shared_ptr< PbParameters_pbParams
 The problem parameters that control a step. More...
 
- Protected Attributes inherited from IterationUtils
EvalPointSet _trialPoints
 The points generated during the start(). Used for run() and postProcessing(). More...
 
size_t _nbEvalPointsThatNeedEval
 
const Step_parentStep
 
SuccessType _success
 Success type of this step. More...
 
Iteration_iterAncestor
 
MegaIteration_megaIterAncestor
 
- Static Protected Attributes inherited from Step
static bool _userInterrupt
 Interrupt NOMAD if Ctrl-C is pressed. More...
 
static bool _userTerminate
 Terminate NOMAD if Ctrl-C is pressed again. More...
 
static StepEndCbFunc _cbIterationEnd
 
static StepEndCbFunc _cbMegaIterationEnd
 
static HotRestartCbFunc _cbHotRestart
 
static bool _showWarnings
 

Detailed Description

Class for the mega search and poll of MADS.

Calling the start function generates search and poll trial points at the same time before starting evaluation. Calling the run function starts the evaluaions. The postprocessing is performed when calling the end funcion.

Definition at line 60 of file MegaSearchPoll.hpp.

Constructor & Destructor Documentation

◆ MegaSearchPoll()

MegaSearchPoll::MegaSearchPoll ( const Step parentStep)
inlineexplicit

Constructor.

Parameters
parentStepThe parent of this step

Definition at line 76 of file MegaSearchPoll.hpp.

77  : Step( parentStep ),
78  IterationUtils( parentStep ),
80  {
81  init();
82  }

◆ ~MegaSearchPoll()

virtual MegaSearchPoll::~MegaSearchPoll ( )
inlinevirtual

Definition at line 85 of file MegaSearchPoll.hpp.

86  {
87  _iterForPoint.clear();
88  }

Member Function Documentation

◆ endImp()

virtual void MegaSearchPoll::endImp ( )
overrideprivatevirtual

Call for postprocessing: computation of a new hMax and update of the barrier.

Implements Step.

◆ generateTrialPoints()

void MegaSearchPoll::generateTrialPoints ( )
overrideprivatevirtual

Generate new points to evaluate.

The trial points are produced using poll and search. The duplicates are removed and they are merged all together.

Implements IterationUtils.

◆ getIterForPoint()

const std::shared_ptr<MadsIteration> MegaSearchPoll::getIterForPoint ( const EvalPoint point) const

Get which iteration generated a point. This is used by evaluator control interface. Having the iteration, gives access to the mesh and some of its attributes.

◆ init()

void MegaSearchPoll::init ( )
private

◆ runImp()

virtual bool MegaSearchPoll::runImp ( )
overrideprivatevirtual

Start evaluations.

Implements Step.

◆ startImp()

virtual void MegaSearchPoll::startImp ( )
overrideprivatevirtual

Generate the trial poins for the search and poll steps.

Call MegaSearchPoll::generateTrialPoints.

Implements Step.

Member Data Documentation

◆ _iterForPoint

std::map<EvalPoint, std::shared_ptr<MadsIteration>, EvalPointCompare> MegaSearchPoll::_iterForPoint
mutableprivate

Hash table to remember which iteration generated this point. I tried working around it, but in the end it is easier to just remember the iteration. Mutable because it is updated in generateTrialPoints().

Definition at line 69 of file MegaSearchPoll.hpp.


The documentation for this class was generated from the following file:
Step::Step
Step()
Constructor #1 for MainStep (no parent)
Definition: Step.hpp:98
MegaSearchPoll::_iterForPoint
std::map< EvalPoint, std::shared_ptr< MadsIteration >, EvalPointCompare > _iterForPoint
Definition: MegaSearchPoll.hpp:69
IterationUtils::IterationUtils
IterationUtils(const Step *parentStep)
Constructor.
Definition: IterationUtils.hpp:105
MegaSearchPoll::init
void init()