NOMAD Source  Version 4.0.0 Beta
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
MegaIteration Class Referenceabstract

Class to manage the iterations. More...

#include <MegaIteration.hpp>

Inheritance diagram for MegaIteration:
Collaboration diagram for MegaIteration:

Public Member Functions

 MegaIteration (const Step *parentStep, size_t k, std::shared_ptr< Barrier > barrier, SuccessType success)
 Constructor. More...
 
size_t getNbIterations () const
 
std::shared_ptr< IterationgetIter (size_t i) const
 
size_t getK () const
 
void setK (const size_t k)
 
size_t getNextK () const
 
const std::shared_ptr
< NOMAD::Barrier > 
getBarrier () const
 
void setBarrier (const std::shared_ptr< NOMAD::Barrier > &barrier)
 
virtual void start () override=0
 What a step does. More...
 
virtual bool run () override=0
 What a step does. More...
 
virtual void end () override
 What a step does. More...
 
const SuccessTypegetSuccessType () const
 
void setSuccessType (const SuccessType &success)
 
virtual void read (std::istream &is)
 
virtual void display (std::ostream &os) 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...
 
std::shared_ptr< AllStopReasonsgetAllStopReasons () const
 
void addCallback (const NOMAD::CallbackType &callbackType, const NOMAD::StepEndCbFunc &stepEndCbFunc)
 Set user callback. More...
 
void addCallback (const NOMAD::CallbackType &callbackType, const NOMAD::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 >
const StepgetParentOfType (const bool stopAtAlgo=true) const
 Template function to get the parent of given type. More...
 
bool isAnAlgorithm () const
 
const std::shared_ptr< MeshBasegetIterationMesh () const
 
const std::shared_ptr< EvalPointgetIterationFrameCenter () const
 
const std::shared_ptr< BarriergetMegaIterationBarrier () const
 
Point getSubFixedVariable () const
 
virtual void hotRestartOnUserInterrupt ()
 Helper for hot restart functionalities. More...
 

Protected Attributes

std::vector< std::shared_ptr
< Iteration > > 
_iterList
 A collection of additional iterations: Help generate more eval points. More...
 
std::shared_ptr< Barrier_barrier
 
size_t _k
 Main counter. More...
 
size_t _nbIterRun
 Number of iterations run within this MegaIteration. More...
 
SuccessType _success
 
- 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...
 

Private Member Functions

void init ()
 Helper for constructor. More...
 

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 with a signal value. More...
 
static bool getUserInterrupt ()
 
static void runCallback (NOMAD::CallbackType callbackType, const NOMAD::Step &step, bool &stop)
 Run user callback. More...
 
static void runCallback (NOMAD::CallbackType callbackType, std::vector< std::string > &paramLines)
 
- 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 init ()
 Helper for constructors. More...
 
void defaultStart ()
 
bool defaultRun ()
 
void defaultEnd ()
 
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...
 
- 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 NOMAD::StepEndCbFunc _cbIterationEnd
 
static NOMAD::StepEndCbFunc _cbMegaIterationEnd
 
static NOMAD::HotRestartCbFunc _cbHotRestart
 

Detailed Description

Class to manage the iterations.

A mega iteration of an algorithm:

  • generates a lot of points over multiple strategies (ex., Poll and Search for Mads).
  • evaluates points
  • performs post-processing

The run and start functions of mega iteration must be implemented for each optimizer that has several phases of points creation that we want to combine before launching evaluations (for example, MadsMegaIteration, NMMegaIteration, ...).

Note
As an hypothesis, the time load is taken by the evaluation, which is parallelized over all evaluations simultaneously. The iteration generation, including trial points generation, has little time load, so they do not need to be parallelized. It is also preferable to keep parallelization to the only place where it matters the most to avoid errors.
There is no parallelization at the algorithmic level. The algorithms are run in master thread only.

Definition at line 28 of file MegaIteration.hpp.

Constructor & Destructor Documentation

MegaIteration::MegaIteration ( const Step parentStep,
size_t  k,
std::shared_ptr< Barrier barrier,
SuccessType  success 
)
inlineexplicit

Constructor.

Parameters
parentStepThe parent step of this step – IN.
kThe main iteration counter – IN.
barrierThe barrier for constraints handling. Belongs to subproblem space. – IN.
successSuccess type of the previous MegaIteration. – IN.

Definition at line 66 of file MegaIteration.hpp.

70  : Step(parentStep ),
71  _iterList(),
72  _barrier(barrier),
73  _k(k),
74  _nbIterRun(0),
75  _success(success)
76  {
77  if (nullptr == _barrier)
78  {
79  throw Exception(__FILE__, __LINE__, "MegaIteration constructor: barrier must not be NULL.");
80  }
81  init();
82  }
Exception utility.
size_t _k
Main counter.
SuccessType _success
Step()
Constructor #1 for MainStep (no parent)
Definition: Step.hpp:51
std::vector< std::shared_ptr< Iteration > > _iterList
A collection of additional iterations: Help generate more eval points.
size_t _nbIterRun
Number of iterations run within this MegaIteration.
void init()
Helper for constructor.
std::shared_ptr< Barrier > _barrier

Member Function Documentation

virtual void MegaIteration::display ( std::ostream &  os) const
virtual

Reimplemented in MadsMegaIteration, and NMMegaIteration.

virtual void MegaIteration::end ( )
overridevirtual

What a step does.

Reimplemented from Step.

const std::shared_ptr<NOMAD::Barrier> MegaIteration::getBarrier ( ) const
inline

Definition at line 98 of file MegaIteration.hpp.

98 { return _barrier; }
std::shared_ptr< Barrier > _barrier
std::shared_ptr<Iteration> MegaIteration::getIter ( size_t  i) const
inline

Definition at line 91 of file MegaIteration.hpp.

91 { return _iterList[i]; }
std::vector< std::shared_ptr< Iteration > > _iterList
A collection of additional iterations: Help generate more eval points.
size_t MegaIteration::getK ( ) const
inline

Definition at line 93 of file MegaIteration.hpp.

93 { return _k; }
size_t _k
Main counter.
size_t MegaIteration::getNbIterations ( ) const
inline

Definition at line 90 of file MegaIteration.hpp.

90 { return _iterList.size(); }
std::vector< std::shared_ptr< Iteration > > _iterList
A collection of additional iterations: Help generate more eval points.
size_t MegaIteration::getNextK ( ) const
const SuccessType& MegaIteration::getSuccessType ( ) const
inline

Definition at line 107 of file MegaIteration.hpp.

107 { return _success; }
SuccessType _success
void MegaIteration::init ( )
private

Helper for constructor.

virtual void MegaIteration::read ( std::istream &  is)
virtual

Reimplemented in MadsMegaIteration, and NMMegaIteration.

virtual bool MegaIteration::run ( )
overridepure virtual

What a step does.

Reimplemented from Step.

Implemented in MadsMegaIteration, and NMMegaIteration.

void MegaIteration::setBarrier ( const std::shared_ptr< NOMAD::Barrier > &  barrier)
inline

Definition at line 99 of file MegaIteration.hpp.

99 { _barrier = barrier; }
std::shared_ptr< Barrier > _barrier
void MegaIteration::setK ( const size_t  k)
inline

Definition at line 94 of file MegaIteration.hpp.

94 { _k = k; }
size_t _k
Main counter.
void MegaIteration::setSuccessType ( const SuccessType success)
inline

Definition at line 109 of file MegaIteration.hpp.

109 { _success = success; }
SuccessType _success
virtual void MegaIteration::start ( )
overridepure virtual

What a step does.

Todo:
Consider the us

Reimplemented from Step.

Implemented in MadsMegaIteration, and NMMegaIteration.

Member Data Documentation

std::shared_ptr<Barrier> MegaIteration::_barrier
protected

The barrier holds xFeas, xInf and hMax. xFeas and xInf will be used as frame centers.

Note
This barrier is in subspace.

Definition at line 40 of file MegaIteration.hpp.

std::vector<std::shared_ptr<Iteration> > MegaIteration::_iterList
protected

A collection of additional iterations: Help generate more eval points.

Definition at line 33 of file MegaIteration.hpp.

size_t MegaIteration::_k
protected

Main counter.

Definition at line 43 of file MegaIteration.hpp.

size_t MegaIteration::_nbIterRun
protected

Number of iterations run within this MegaIteration.

Definition at line 44 of file MegaIteration.hpp.

SuccessType MegaIteration::_success
protected

Success type of this step. Initialized with the run of the previous mega iteration, so that the update step knows what to do (for example,enlarge or reduce the mesh). At the end of run step during the mega iteration of an algorithm, the success type is updated (::setSuccessType) with the latest success type.

Definition at line 54 of file MegaIteration.hpp.


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