NOMAD Source  Version 4.0.0 Beta
Initialization Class Referenceabstract

Class for initialization (step 0) of an Algorithm. More...

#include <Initialization.hpp>

Inheritance diagram for Initialization:
Collaboration diagram for Initialization:

Public Member Functions

 Initialization (const Step *parentStep)
 Constructor. More...
 
virtual ~Initialization ()
 Destructor. More...
 
const std::shared_ptr< Barrier > & getBarrier () const
 
virtual void startImp () override
 
virtual bool runImp () override=0
 
virtual void endImp () override
 
- 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...
 

Protected Attributes

std::shared_ptr< Barrier_barrier
 Barrier constructed from evaluated X0s. 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...
 

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. 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...
 
- 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 initialization (step 0) of an Algorithm.

This an abstract class, each algorithm should probably implement an initialization.

Definition at line 57 of file Initialization.hpp.

Constructor & Destructor Documentation

◆ Initialization()

Initialization::Initialization ( const Step parentStep)
inlineexplicit

Constructor.

Definition at line 67 of file Initialization.hpp.

68  : Step(parentStep),
69  _barrier(nullptr)
70  {
71  init();
72  }

◆ ~Initialization()

virtual Initialization::~Initialization ( )
virtual

Destructor.

Upon destruction, print all that is in the output queue.

Member Function Documentation

◆ endImp()

virtual void Initialization::endImp ( )
inlineoverridevirtual

Placeholder to be implemented by derived classes. Called by end.

Implements Step.

Reimplemented in NMInitialization, QuadModelInitialization, and SgtelibModelInitialization.

Definition at line 90 of file Initialization.hpp.

90 {}

◆ getBarrier()

const std::shared_ptr<Barrier>& Initialization::getBarrier ( ) const
inline

Definition at line 80 of file Initialization.hpp.

80 { return _barrier; }

◆ init()

void Initialization::init ( )
private

Helper for constructor.

◆ runImp()

virtual bool Initialization::runImp ( )
overridepure virtual

Placeholder to be implemented in derived classes. Called by run.

Implements Step.

Implemented in NMInitialization, MadsInitialization, QuadModelInitialization, and SgtelibModelInitialization.

◆ startImp()

virtual void Initialization::startImp ( )
inlineoverridevirtual

Placeholder to be implemented in derived classes. Called by start.

Implements Step.

Reimplemented in NMInitialization, QuadModelInitialization, and SgtelibModelInitialization.

Definition at line 88 of file Initialization.hpp.

88 {}

Member Data Documentation

◆ _barrier

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

Barrier constructed from evaluated X0s.

Definition at line 60 of file Initialization.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
Initialization::init
void init()
Helper for constructor.
Initialization::_barrier
std::shared_ptr< Barrier > _barrier
Barrier constructed from evaluated X0s.
Definition: Initialization.hpp:60