NOMAD Source  Version 4.0.0 Beta
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Eval.hpp File Reference

Evaluation at a point. More...

#include <functional>
#include "../Eval/BBOutput.hpp"
#include "../Math/Double.hpp"
#include "../Param/EvalParameters.hpp"
#include "../nomad_nsbegin.hpp"
#include "../nomad_nsend.hpp"
Include dependency graph for Eval.hpp:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  Eval
 Class for the representation of an evaluation at a point. More...
 

Typedefs

typedef std::unique_ptr< EvalEvalUPtr
 Definition for evaluation unique pointer. More...
 

Enumerations

enum  EvalStatusType {
  EvalStatusType::EVAL_NOT_STARTED,
  EvalStatusType::EVAL_FAILED,
  EvalStatusType::EVAL_ERROR,
  EvalStatusType::EVAL_USER_REJECTED,
  EvalStatusType::EVAL_CONS_H_OVER,
  EvalStatusType::EVAL_OK,
  EvalStatusType::EVAL_IN_PROGRESS,
  EvalStatusType::EVAL_STATUS_UNDEFINED
}
 Type for an evaluation status. More...
 

Functions

std::string enumStr (const EvalStatusType evalStatus)
 Utility to convert an eval status to a string. More...
 
std::ostream & operator<< (std::ostream &out, const EvalStatusType &evalStatus)
 Output raw eval status. More...
 
std::istream & operator>> (std::istream &is, EvalStatusType &evalStatus)
 Input eval status. More...
 

Detailed Description

Evaluation at a point.

Author
Viviane Rochon Montplaisir
Date
March 2017
See Also
Eval.cpp

Definition in file Eval.hpp.

Typedef Documentation

typedef std::unique_ptr<Eval> EvalUPtr

Definition for evaluation unique pointer.

Definition at line 314 of file Eval.hpp.

Enumeration Type Documentation

enum EvalStatusType
strong

Type for an evaluation status.

Idea to implement: Eval diffentiates between a BB evaluation that failed (failure of the black box) and an evaluation that was interrupted (failure cause is external to the black box).
There is also states for evaluations that are not yet started, and evaluations that are currently running.

Todo:
These statuses should be made 100% clear. Add something in the name that says if we can re-evaluate the point or not. Even add some User Cases.
Enumerator
EVAL_NOT_STARTED 

Evaluation has not been done yet. Initial status.

EVAL_FAILED 

Evaluation failure. Do not re-submit.

EVAL_ERROR 

Evaluation did not proceed normally. May be submitted again.

EVAL_USER_REJECTED 

Evaluation was rejected by user. May be submitted again.

EVAL_CONS_H_OVER 

Evaluation was rejected because constraint violation was higher than hMax. May be submitted again.

EVAL_OK 

Correct evaluation.

EVAL_IN_PROGRESS 

Evaluation in progress.

EVAL_STATUS_UNDEFINED 

Undefined evaluation status.

Definition at line 36 of file Eval.hpp.

37 {
38  EVAL_NOT_STARTED, ///< Evaluation has not been done yet. Initial status.
39  EVAL_FAILED, ///< Evaluation failure. Do not re-submit.
40  EVAL_ERROR, ///< Evaluation did not proceed normally. May be submitted again.
41  EVAL_USER_REJECTED, ///< Evaluation was rejected by user. May be submitted again
42  EVAL_CONS_H_OVER, ///< Evaluation was rejected because constraint violation was higher than hMax. May be submitted again.
43  EVAL_OK, ///< Correct evaluation
44  EVAL_IN_PROGRESS, ///< Evaluation in progress
45  EVAL_STATUS_UNDEFINED ///< Undefined evaluation status
46 };
Evaluation was rejected by user. May be submitted again.
Evaluation has not been done yet. Initial status.
Evaluation was rejected because constraint violation was higher than hMax. May be submitted again...
Evaluation failure. Do not re-submit.
Evaluation in progress.
Evaluation did not proceed normally. May be submitted again.
Undefined evaluation status.
Correct evaluation.

Function Documentation

std::string enumStr ( const EvalStatusType  evalStatus)

Utility to convert an eval status to a string.

std::ostream& operator<< ( std::ostream &  out,
const EvalStatusType evalStatus 
)

Output raw eval status.

Does not do the same as enumStr.

std::istream& operator>> ( std::istream &  is,
EvalStatusType evalStatus 
)

Input eval status.