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

Class for the poll (step 3) of MADS algorithm. More...

#include <Poll.hpp>

Inheritance diagram for Poll:
Collaboration diagram for Poll:

Public Member Functions

 Poll (const Step *parentStep)
 Constructor. More...
 
 ~Poll ()
 
virtual void start () override
 What a step does. More...
 
virtual bool run () override
 What a step does. More...
 
virtual void end () override
 What a step does. More...
 
void generateTrialPoints () override
 Generate new points to evaluate. More...
 
- 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...
 
- Public Member Functions inherited from MadsIterationUtils
 MadsIterationUtils (const Step *parentStep)
 Constructor. More...
 
- Public Member Functions inherited from IterationUtils
 IterationUtils (const Step *parentStep)
 Constructor. More...
 
 ~IterationUtils ()
 Destructor. More...
 
const SuccessTypegetSuccessType () const
 
void setSuccessType (const SuccessType &success)
 
size_t getTrialPointsCount () const
 
EvalPointSetgetTrialPoints ()
 
bool insertTrialPoint (const EvalPoint &evalPoint)
 Insert a trial point. More...
 
void clearTrialPoints (void)
 Clear trial points. More...
 
virtual void postProcessing ()
 Helper for end() More...
 
virtual void verifyPointsAreOnMesh ()
 Helper for start() 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...
 
virtual void updatePointsWithFrameCenter ()
 Add current frame center as originator of each point in trialPoints. More...
 

Private Member Functions

void init ()
 Helper for constructor. More...
 
void setPollDirections (std::list< Direction > &directions) const
 Helper generateTrialPoints. More...
 
bool computeDirOnUnitSphere (Direction &randomDir) const
 Helper generateTrialPoints. More...
 
void householder (const Direction &dir, bool completeTo2n, Direction **H) const
 Helper generateTrialPoints. 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)
 
- Static Public Member Functions inherited from IterationUtils
static void snapPointToBoundsAndProjectOnMesh (Point &xt, const ArrayOfDouble &lb, const ArrayOfDouble &ub, const std::shared_ptr< Point > frameCenter, const std::shared_ptr< MeshBase > mesh=nullptr)
 Helper for start() More...
 
- 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...
 
- 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
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 NOMAD::StepEndCbFunc _cbIterationEnd
 
static NOMAD::StepEndCbFunc _cbMegaIterationEnd
 
static NOMAD::HotRestartCbFunc _cbHotRestart
 

Detailed Description

Class for the poll (step 3) of MADS algorithm.

Generate the trial points (::start), launch evaluation (::run) and postprocecssing (::end).

Definition at line 16 of file Poll.hpp.

Constructor & Destructor Documentation

Poll::Poll ( const Step parentStep)
inlineexplicit

Constructor.

Parameters
parentStepThe parent of this poll step

Definition at line 25 of file Poll.hpp.

26  : Step(parentStep ) ,
27  MadsIterationUtils ( parentStep )
28  {
29  init();
30  }
Step()
Constructor #1 for MainStep (no parent)
Definition: Step.hpp:51
void init()
Helper for constructor.
MadsIterationUtils(const Step *parentStep)
Constructor.
Poll::~Poll ( )
inline

Definition at line 31 of file Poll.hpp.

31 {}

Member Function Documentation

bool Poll::computeDirOnUnitSphere ( Direction randomDir) const
private

Helper generateTrialPoints.

Compute a random direction on a unit n-sphere. See http://en.wikipedia.org/wiki/N-sphere

virtual void Poll::end ( )
overridevirtual

What a step does.

Reimplemented from Step.

void Poll::generateTrialPoints ( )
overridevirtual

Generate new points to evaluate.

The trial points are obtained by:

  • adding poll directions (::setPollDirections) to the frame center.
  • snaping points (and directions) to bounds.
  • projecting points on mesh.

Implements IterationUtils.

void Poll::householder ( const Direction dir,
bool  completeTo2n,
Direction **  H 
) const
private

Helper generateTrialPoints.

void Poll::init ( )
private

Helper for constructor.

virtual bool Poll::run ( )
overridevirtual

What a step does.

Reimplemented from Step.

void Poll::setPollDirections ( std::list< Direction > &  directions) const
private

Helper generateTrialPoints.

  • A single direction on unit n-sphere is computer (::computeDirOnUnitSphere).
  • This direction is transformed into 2n directions on a uni n-sphere using the householder transformation.
  • The 2n directions are scaled and projected on the mesh.

/param directions The directions obtained for this poll – OUT.

virtual void Poll::start ( )
overridevirtual

What a step does.

Todo:
Consider the us

Reimplemented from Step.


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