NOMAD Source  Version 4.0.0 Beta
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ParametersNomad3.hpp File Reference
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define __NOMAD400_PARAMETERSNOMAD3__
 

Functions

int get_seed () const
 Access to the seed. More...
 
int get_max_bb_eval () const
 Access to the MAX_BB_EVAL parameter. More...
 
int get_max_iterations () const
 Access to the maximum number of iterations. More...
 
std::string get_problem_dir () const
 
void set_SEED (int seed)
 Set the seed. More...
 
void set_MAX_BB_EVAL (int bbe)
 Set the MAX_BB_EVAL parameter. More...
 
void set_MAX_EVAL (int maxEval)
 Set the MAX_EVAL parameter. More...
 
void set_MAX_ITERATIONS (int max_iterations)
 Set the MAX_ITERATIONS parameter. More...
 
void set_EPSILON (const Double &eps)
 Set the EPSILON parameter. More...
 
const Double get_epsilon () const
 Access to the EPSILON parameter. More...
 
void set_UNDEF_STR (const std::string &undefStr)
 Set the UNDEF_STR parameter. More...
 
void set_INF_STR (const std::string &infStr)
 Set the INF_STR parameter. More...
 
const std::string get_undef_str () const
 Access to the UNDEF_STR parameter. More...
 
const std::string get_inf_str () const
 Access to the INF_STR parameter. More...
 
const ArrayOfDoubleget_initial_mesh_size () const
 Access to the INITIAL_MESH_SIZE parameter. More...
 
const ArrayOfDoubleget_initial_poll_size () const
 Access to the INITIAL_FRAME_SIZE parameter. More...
 
const ArrayOfDoubleget_min_mesh_size () const
 Access to the MIN_MESH_SIZE parameter. More...
 
const ArrayOfDoubleget_min_poll_size () const
 Access to the MIN_FRAME_SIZE parameter. More...
 
void set_MIN_MESH_SIZE (const ArrayOfDouble &mms)
 Set the MIN_MESH_SIZE parameter. More...
 
void set_MIN_POLL_SIZE (const ArrayOfDouble &mfs)
 Set the MIN_FRAME_SIZE parameter. More...
 
void set_INITIAL_MESH_SIZE (const ArrayOfDouble &ims)
 Set the INITIAL_MESH_SIZE parameter. More...
 
void set_INITIAL_POLL_SIZE (const ArrayOfDouble &ifs)
 Set the INITIAL_FRAME_SIZE parameter. More...
 
void set_X0 (const Point &x0)
 Add a starting point. More...
 
const Pointget_x0 () const
 Access to the starting point. More...
 
const ArrayOfPointget_x0s () const
 Access to the starting points. More...
 
int get_dimension () const
 Access to the dimension. More...
 
virtual void set_DIMENSION (size_t n)
 Set the dimension. More...
 
const ArrayOfDoubleget_lb () const
 Access to the lower bounds. More...
 
const ArrayOfDoubleget_ub () const
 Access to the upper bounds. More...
 
void reset_bounds ()
 Reset the bounds. More...
 
void set_LOWER_BOUND (const ArrayOfDouble &lb)
 Set all lower bounds. More...
 
void set_UPPER_BOUND (const ArrayOfDouble &ub)
 Set all upper bounds. More...
 
const ArrayOfDoubleget_granularity () const
 Access to the granular variables. More...
 
void set_GRANULARITY (const ArrayOfDouble &granularity)
 Set the granularity of a series of variables. More...
 
void set_TMP_DIR (const std::string &tmpdir)
 
std::string get_tmp_dir () const
 
void set_BB_EXE (const std::string &bbexe)
 
std::string get_bb_exe () const
 
void set_BB_INPUT_TYPE (const BBInputTypeList &bbInputType)
 
const std::vector< BBInputType > & get_bb_input_type () const
 
void set_BB_OUTPUT_TYPE (const BBOutputTypeList &bbOutputType)
 
const std::vector< BBOutputType > & get_bb_output_type () const
 
bool set_DISPLAY_DEGREE (const int displayDegree)
 
int get_display_degree () const
 
void set_DISPLAY_ALL_EVAL (const bool displayAllEval)
 
bool get_display_all_eval () const
 
void set_DISPLAY_STATS (const ArrayOfDouble stats)
 
ArrayOfDouble get_display_stats () const
 
void resetStatsFile ()
 
void set_STATS_FILE (const ArrayOfDouble stats)
 
ArrayOfDouble get_stats_file () const
 
void set_ADD_SEED_TO_FILE_NAMES (bool addseed)
 
bool get_add_seed_to_file_names () const
 

Macro Definition Documentation

#define __NOMAD400_PARAMETERSNOMAD3__

Definition at line 3 of file AllParameters.hpp.

Function Documentation

bool get_add_seed_to_file_names ( ) const
std::string get_bb_exe ( ) const
const std::vector<BBInputType>& get_bb_input_type ( ) const
const std::vector<BBOutputType>& get_bb_output_type ( ) const
int get_dimension ( ) const

Access to the dimension.

Returns
The dimension.
bool get_display_all_eval ( ) const
int get_display_degree ( ) const
ArrayOfDouble get_display_stats ( ) const
const Double get_epsilon ( ) const

Access to the EPSILON parameter.

Returns
The EPSILON parameter.
const ArrayOfDouble& get_granularity ( ) const

Access to the granular variables.

Returns
The granular variables.
const std::string get_inf_str ( ) const

Access to the INF_STR parameter.

Returns
The INF_STR parameter.
const ArrayOfDouble& get_initial_mesh_size ( ) const

Access to the INITIAL_MESH_SIZE parameter.

Returns
The INITIAL_MESH_SIZE parameter.
const ArrayOfDouble& get_initial_poll_size ( ) const

Access to the INITIAL_FRAME_SIZE parameter.

The POLL_SIZE parameters have been renamed FRAME_SIZE in Nomad 4. For compatibility with Nomad 3, the old function name is used.

Returns
The INITIAL_FRAME_SIZE parameter.
const ArrayOfDouble& get_lb ( ) const

Access to the lower bounds.

Returns
The lower bounds.
int get_max_bb_eval ( ) const

Access to the MAX_BB_EVAL parameter.

Returns
The MAX_BB_EVAL parameter.
int get_max_iterations ( ) const

Access to the maximum number of iterations.

Returns
The maximum number of iterations.
const ArrayOfDouble& get_min_mesh_size ( ) const

Access to the MIN_MESH_SIZE parameter.

Returns
The MIN_MESH_SIZE parameter.
const ArrayOfDouble& get_min_poll_size ( ) const

Access to the MIN_FRAME_SIZE parameter.

The ***_POLL_SIZE parameters have been renamed _FRAME_SIZE in Nomad 4. For compatibility with Nomad 3, the old function name is used.

Returns
The MIN_FRAME_SIZE parameter.
std::string get_problem_dir ( ) const
Returns
The path to the problem, when in batch mode. An empty string, when in library mode.
int get_seed ( ) const

Access to the seed.

Returns
The seed.

Definition at line 19 of file ParametersNomad3.hpp.

19 { return getAttributeValue<int>("SEED"); }
ArrayOfDouble get_stats_file ( ) const
std::string get_tmp_dir ( ) const
const ArrayOfDouble& get_ub ( ) const

Access to the upper bounds.

Returns
The upper bounds.
const std::string get_undef_str ( ) const

Access to the UNDEF_STR parameter.

Returns
The UNDEF_STR parameter.
const Point& get_x0 ( ) const

Access to the starting point.

Returns
The starting point.
const ArrayOfPoint& get_x0s ( ) const

Access to the starting points.

Returns
The starting points.
void reset_bounds ( )

Reset the bounds.

void resetStatsFile ( )
void set_ADD_SEED_TO_FILE_NAMES ( bool  addseed)
void set_BB_EXE ( const std::string &  bbexe)
void set_BB_INPUT_TYPE ( const BBInputTypeList bbInputType)
void set_BB_OUTPUT_TYPE ( const BBOutputTypeList bbOutputType)
virtual void set_DIMENSION ( size_t  n)
virtual

Set the dimension.

Parameters
nThe dimension – IN.
void set_DISPLAY_ALL_EVAL ( const bool  displayAllEval)
bool set_DISPLAY_DEGREE ( const int  displayDegree)
void set_DISPLAY_STATS ( const ArrayOfDouble  stats)
void set_EPSILON ( const Double eps)

Set the EPSILON parameter.

Parameters
epsThe EPSILON parameter – IN.
void set_GRANULARITY ( const ArrayOfDouble granularity)

Set the granularity of a series of variables.

Parameters
granularityThe granular variables; This point is of dimension n; regular variables have a granularity of zero – IN.
void set_INF_STR ( const std::string &  infStr)

Set the INF_STR parameter.

Parameters
infStrThe INF_STR parameter – IN.
void set_INITIAL_MESH_SIZE ( const ArrayOfDouble ims)

Set the INITIAL_MESH_SIZE parameter.

Parameters
imsInitial mesh size – IN. – IN (Opt) (default = false).
void set_INITIAL_POLL_SIZE ( const ArrayOfDouble ifs)

Set the INITIAL_FRAME_SIZE parameter.

The POLL_SIZE parameters have been renamed FRAME_SIZE in Nomad 4. For compatibility with Nomad 3, the old function name is used.

Parameters
ifsInitial frame size – IN. – IN (Opt) (default = false).
void set_LOWER_BOUND ( const ArrayOfDouble lb)

Set all lower bounds.

Use undefined values for variables without bounds.

Parameters
lbLower bounds – IN.
void set_MAX_BB_EVAL ( int  bbe)

Set the MAX_BB_EVAL parameter.

Parameters
bbeThe MAX_BB_EVAL parameter – IN.
void set_MAX_EVAL ( int  maxEval)

Set the MAX_EVAL parameter.

Parameters
maxEvalThe MAX_EVAL parameter – IN.
void set_MAX_ITERATIONS ( int  max_iterations)

Set the MAX_ITERATIONS parameter.

Parameters
max_iterationsThe MAX_ITERATIONS parameter – IN.
void set_MIN_MESH_SIZE ( const ArrayOfDouble mms)

Set the MIN_MESH_SIZE parameter.

Parameters
mmsMinimum mesh size – IN. – IN (Opt) (default = false).
void set_MIN_POLL_SIZE ( const ArrayOfDouble mfs)

Set the MIN_FRAME_SIZE parameter.

The POLL_SIZE parameters have been renamed FRAME_SIZE in Nomad 4. For compatibility with Nomad 3, the old function name is used.

Parameters
mfsMinimum frame size – IN. – IN (Opt) (default = false).
void set_SEED ( int  seed)

Set the seed.

Parameters
seedThe seed – IN.
void set_STATS_FILE ( const ArrayOfDouble  stats)
void set_TMP_DIR ( const std::string &  tmpdir)
void set_UNDEF_STR ( const std::string &  undefStr)

Set the UNDEF_STR parameter.

Parameters
undefStrThe UNDEF_STR parameter – IN.
void set_UPPER_BOUND ( const ArrayOfDouble ub)

Set all upper bounds.

Use undefined values for variables without bounds.

Parameters
ubUpper bounds – IN.
void set_X0 ( const Point x0)

Add a starting point.

Parameters
x0The new point – IN.