NOMAD Source  Version 4.0.0 Beta
ParametersNomad3.hpp File Reference
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

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

Function Documentation

◆ get_add_seed_to_file_names()

bool NOMAD::AllParameters::get_add_seed_to_file_names ( ) const

Get ADD_SEED_TO_FILE_NAMES (compatibility NOMAD 3)

Definition at line 377 of file ParametersNomad3.cpp.

378 {
379  return getAttributeValue<bool>("ADD_SEED_TO_FILE_NAMES");
380 }

◆ get_bb_exe()

std::string NOMAD::AllParameters::get_bb_exe ( ) const

Access to blackbox executable (compatibility NOMAD 3)

Definition at line 318 of file ParametersNomad3.cpp.

319 {
320  return getAttributeValue<std::string>("BB_EXE");
321 }

◆ get_bb_input_type()

const NOMAD::BBInputTypeList & NOMAD::AllParameters::get_bb_input_type ( ) const

Access to blackbox input type (compatibility NOMAD 3)

Definition at line 329 of file ParametersNomad3.cpp.

330 {
331  return getAttributeValue<NOMAD::BBInputTypeList>("BB_INPUT_TYPE");
332 }

◆ get_bb_output_type()

const NOMAD::BBOutputTypeList & NOMAD::AllParameters::get_bb_output_type ( ) const

Access to blackbox output type (compatibility NOMAD 3)

Definition at line 341 of file ParametersNomad3.cpp.

342 {
343  return getAttributeValue<NOMAD::BBOutputTypeList>("BB_OUTPUT_TYPE");
344 }

◆ get_dimension()

int NOMAD::AllParameters::get_dimension ( ) const

Access to the dimension (compatibility NOMAD 3).

Definition at line 241 of file ParametersNomad3.cpp.

242 {
243  return static_cast<int>(getAttributeValue<size_t>("DIMENSION"));
244 }

◆ get_display_all_eval()

bool NOMAD::AllParameters::get_display_all_eval ( ) const

Get the flag DISPLAY_ALL_EVAL (compatibility NOMAD 3)

Definition at line 166 of file ParametersNomad3.cpp.

167 {
168  return getAttributeValue<bool>("DISPLAY_ALL_EVAL");
169 }

◆ get_display_degree()

int NOMAD::AllParameters::get_display_degree ( ) const

Access to display degree (compatibility NOMAD 3)

Definition at line 156 of file ParametersNomad3.cpp.

157 {
158  return getAttributeValue<int>("DISPLAY_DEGREE");
159 }

◆ get_display_stats()

NOMAD::ArrayOfDouble NOMAD::AllParameters::get_display_stats ( ) const

Get DISPLAY_STATS (compatibility NOMAD 3)

Definition at line 353 of file ParametersNomad3.cpp.

354 {
355  return getAttributeValue<NOMAD::ArrayOfDouble>("DISPLAY_STATS");
356 }

◆ get_epsilon()

const NOMAD::Double NOMAD::AllParameters::get_epsilon ( ) const

Access to the EPSILON parameter (compatibility NOMAD 3).

Definition at line 120 of file ParametersNomad3.cpp.

121 {
122  return getAttributeValue<NOMAD::Double>("EPSILON");
123 }

◆ get_granularity()

const NOMAD::ArrayOfDouble & NOMAD::AllParameters::get_granularity ( ) const

Access to the granular variables (compatibility NOMAD 3).

Definition at line 287 of file ParametersNomad3.cpp.

288 {
289  return getAttributeValue<NOMAD::ArrayOfDouble>("GRANULARITY");
290 }

◆ get_inf_str()

const std::string NOMAD::AllParameters::get_inf_str ( ) const

Access to the INF_STR parameter (compatibility NOMAD 3).

Definition at line 140 of file ParametersNomad3.cpp.

141 {
142  return getAttributeValue<std::string>("INF_STR");
143 }

◆ get_initial_mesh_size()

const NOMAD::ArrayOfDouble & NOMAD::AllParameters::get_initial_mesh_size ( ) const

Access to the INITIAL_MESH_SIZE parameter (compatibility NOMAD 3).

Definition at line 173 of file ParametersNomad3.cpp.

174 {
175  return getAttributeValue<NOMAD::ArrayOfDouble>("INITIAL_MESH_SIZE");
176 }

◆ get_initial_poll_size()

const NOMAD::ArrayOfDouble & NOMAD::AllParameters::get_initial_poll_size ( ) const

Access to the INITIAL_FRAME_SIZE parameter (compatibility NOMAD 3).

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.

Definition at line 179 of file ParametersNomad3.cpp.

180 {
181 // The ***_POLL_SIZE parameters have been renamed ***_FRAME_SIZE in Nomad 4
182  return getAttributeValue<NOMAD::ArrayOfDouble>("INITIAL_FRAME_SIZE");
183 }

◆ get_lb()

const NOMAD::ArrayOfDouble & NOMAD::AllParameters::get_lb ( ) const

Access to the lower bounds (compatibility NOMAD 3).

Definition at line 253 of file ParametersNomad3.cpp.

254 {
255  return getAttributeValue<NOMAD::ArrayOfDouble>("LOWER_BOUND");
256 }

◆ get_max_bb_eval()

int NOMAD::AllParameters::get_max_bb_eval ( ) const

Access to the MAX_BB_EVAL parameter (compatibility NOMAD 3).

Definition at line 65 of file ParametersNomad3.cpp.

66 {
67  auto max_bb_eval = getAttributeValue<size_t>("MAX_BB_EVAL");
68  int n3_max_bb_eval =-1;
69  if ( max_bb_eval < NOMAD::P_INF_INT )
70  n3_max_bb_eval = static_cast<int>(max_bb_eval);
71  return n3_max_bb_eval;
72 }

◆ get_max_iterations()

int NOMAD::AllParameters::get_max_iterations ( ) const

Access to the maximum number of iterations (compatibility NOMAD 3).

Definition at line 95 of file ParametersNomad3.cpp.

96 {
97  auto max_iterations = getAttributeValue<size_t>("MAX_ITERATIONS");
98  int n3_max_iterations =-1;
99  if ( max_iterations < NOMAD::P_INF_INT )
100  n3_max_iterations = static_cast<int>(max_iterations);
101  return n3_max_iterations;
102 
103 }

◆ get_min_mesh_size()

const NOMAD::ArrayOfDouble & NOMAD::AllParameters::get_min_mesh_size ( ) const

Access to the MIN_MESH_SIZE parameter (compatibility NOMAD 3).

Definition at line 186 of file ParametersNomad3.cpp.

187 {
188  return getAttributeValue<NOMAD::ArrayOfDouble>("MIN_MESH_SIZE");
189 }

◆ get_min_poll_size()

const NOMAD::ArrayOfDouble & NOMAD::AllParameters::get_min_poll_size ( ) const

Access to the MIN_FRAME_SIZE parameter (compatibility NOMAD 3).

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.

Definition at line 192 of file ParametersNomad3.cpp.

193 {
194 // The ***_POLL_SIZE parameters have been renamed ***_FRAME_SIZE in Nomad 4
195  return getAttributeValue<NOMAD::ArrayOfDouble>("MIN_FRAME_SIZE");
196 }

◆ get_problem_dir()

std::string NOMAD::AllParameters::get_problem_dir ( ) const
Returns
The path to the problem, when in batch mode. An empty string, when in library mode.

Definition at line 53 of file ParametersNomad3.cpp.

54 {
55  return getAttributeValue<std::string>("PROBLEM_DIR");
56 }

◆ get_seed()

int get_seed ( ) const

Access to the seed (compatibility NOMAD 3).

Definition at line 61 of file ParametersNomad3.hpp.

61 { return getAttributeValue<int>("SEED"); }

◆ get_stats_file()

NOMAD::ArrayOfDouble NOMAD::AllParameters::get_stats_file ( ) const

Get STATS_FILE (compatibility NOMAD 3)

Definition at line 365 of file ParametersNomad3.cpp.

366 {
367  return getAttributeValue<NOMAD::ArrayOfDouble>("STATS_FILE");
368 }

◆ get_tmp_dir()

std::string NOMAD::AllParameters::get_tmp_dir ( ) const

Access to tmp_dir (compatibility NOMAD 3)

Definition at line 305 of file ParametersNomad3.cpp.

306 {
307  return getAttributeValue<std::string>("TMP_DIR");
308 }

◆ get_ub()

const NOMAD::ArrayOfDouble & NOMAD::AllParameters::get_ub ( ) const

Access to the upper bounds (compatibility NOMAD 3).

Definition at line 259 of file ParametersNomad3.cpp.

260 {
261  return getAttributeValue<NOMAD::ArrayOfDouble>("UPPER_BOUND");
262 }

◆ get_undef_str()

const std::string NOMAD::AllParameters::get_undef_str ( ) const

Access to the UNDEF_STR parameter (compatibility NOMAD 3).

Definition at line 130 of file ParametersNomad3.cpp.

131 {
132  return getAttributeValue<std::string>("UNDEF_STR");
133 }

◆ get_x0()

const NOMAD::Point & NOMAD::AllParameters::get_x0 ( ) const

Access to the starting point (compatibility NOMAD 3).

Definition at line 229 of file ParametersNomad3.cpp.

230 {
231  return getAttributeValue<NOMAD::Point>("X0");
232 }

◆ get_x0s()

const NOMAD::ArrayOfPoint & NOMAD::AllParameters::get_x0s ( ) const

Access to the starting points (compatibility NOMAD 3).

Definition at line 235 of file ParametersNomad3.cpp.

236 {
237  return getAttributeValue<NOMAD::ArrayOfPoint>("X0");
238 }

◆ reset_bounds()

void NOMAD::AllParameters::reset_bounds ( )

Reset the bounds (compatibility NOMAD 3).

Reset the bounds.

Definition at line 266 of file ParametersNomad3.cpp.

267 {
268  getPbParams()->resetToDefaultValue("LOWER_BOUND");
269  getPbParams()->resetToDefaultValue("UPPER_BOUND");
270 }

◆ resetStatsFile()

void NOMAD::AllParameters::resetStatsFile ( )

Reset STATS_FILE (compatibility NOMAD 3)

Definition at line 371 of file ParametersNomad3.cpp.

372 {
373  getDispParams()->resetToDefaultValue("STATS_FILE");
374 }

◆ set_ADD_SEED_TO_FILE_NAMES()

void NOMAD::AllParameters::set_ADD_SEED_TO_FILE_NAMES ( bool  addseed)

Set ADD_SEED_TO_FILE_NAMES (compatibility NOMAD 3)

Definition at line 383 of file ParametersNomad3.cpp.

384 {
385  setAttributeValue("ADD_SEED_TO_FILE_NAMES", addseed);
386 }

◆ set_BB_EXE()

void NOMAD::AllParameters::set_BB_EXE ( const std::string &  bbexe)

Set blackbox executable (compatibility NOMAD 3)

Definition at line 312 of file ParametersNomad3.cpp.

313 {
314  setAttributeValue("BB_EXE", bbexe);
315 }

◆ set_BB_INPUT_TYPE()

void set_BB_INPUT_TYPE ( const BBInputTypeList bbInputType)

Set blackbox input type (compatibility NOMAD 3)

◆ set_BB_OUTPUT_TYPE()

void set_BB_OUTPUT_TYPE ( const BBOutputTypeList bbOutputType)

Set blackbox output type (compatibility NOMAD 3)

◆ set_DIMENSION()

void NOMAD::AllParameters::set_DIMENSION ( size_t  n)
virtual

Set the dimension (compatibility NOMAD 3).

Definition at line 247 of file ParametersNomad3.cpp.

248 {
249  setAttributeValue("DIMENSION", n);
250 }

◆ set_DISPLAY_ALL_EVAL()

void NOMAD::AllParameters::set_DISPLAY_ALL_EVAL ( const bool  displayAllEval)

Set DISPLAY_ALL_EVAL (compatibility NOMAD 3)

Definition at line 161 of file ParametersNomad3.cpp.

162 {
163  setAttributeValue("DISPLAY_ALL_EVAL", displayAllEval);
164 }

◆ set_DISPLAY_DEGREE()

bool NOMAD::AllParameters::set_DISPLAY_DEGREE ( const int  displayDegree)

Set display degree (compatibility NOMAD 3)

Definition at line 150 of file ParametersNomad3.cpp.

151 {
152  setAttributeValue("DISPLAY_DEGREE", displayDegree);
153  return true;
154 }

◆ set_DISPLAY_STATS()

void set_DISPLAY_STATS ( const ArrayOfDouble  stats)

set DISPLAY_STATS (compatibility NOMAD 3)

◆ set_EPSILON()

void set_EPSILON ( const Double eps)

Set the EPSILON parameter (compatibility NOMAD 3).

◆ set_GRANULARITY()

void set_GRANULARITY ( const ArrayOfDouble granularity)

Set the granularity of a series of variables (compatibility NOMAD 3).

Parameters
granularityThe granular variables; This point is of dimension n; regular variables have a granularity of zero – IN.

◆ set_INF_STR()

void NOMAD::AllParameters::set_INF_STR ( const std::string &  infStr)

Set the INF_STR parameter (compatibility NOMAD 3).

Definition at line 135 of file ParametersNomad3.cpp.

136 {
137  setAttributeValue("INF_STR", infStr);
138 }

◆ set_INITIAL_MESH_SIZE()

void set_INITIAL_MESH_SIZE ( const ArrayOfDouble ims)

Set the INITIAL_MESH_SIZE parameter (compatibility NOMAD 3).

◆ set_INITIAL_POLL_SIZE()

void set_INITIAL_POLL_SIZE ( const ArrayOfDouble ifs)

Set the INITIAL_FRAME_SIZE parameter (compatibility NOMAD 3).

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

◆ set_LOWER_BOUND()

void set_LOWER_BOUND ( const ArrayOfDouble lb)

Set all lower bounds (compatibility NOMAD 3).

Use undefined values for variables without bounds.

◆ set_MAX_BB_EVAL()

void NOMAD::AllParameters::set_MAX_BB_EVAL ( int  bbe)

Set the MAX_BB_EVAL parameter (compatibility NOMAD 3).

Definition at line 75 of file ParametersNomad3.cpp.

76 {
77  // -1 is the old way for INF
78  if ( bbe >= NOMAD::P_INF_INT || bbe == -1 )
79  setAttributeValue("MAX_BB_EVAL", NOMAD::INF_SIZE_T );
80  else
81  setAttributeValue("MAX_BB_EVAL", static_cast<size_t>(bbe) );
82 }

◆ set_MAX_EVAL()

void NOMAD::AllParameters::set_MAX_EVAL ( int  maxEval)

Set the MAX_EVAL parameter (compatibility NOMAD 3).

Definition at line 85 of file ParametersNomad3.cpp.

86 {
87  // -1 is the old way for INF
88  if ( bbe >= NOMAD::P_INF_INT || bbe == -1 )
89  setAttributeValue("MAX_EVAL", NOMAD::INF_SIZE_T );
90  else
91  setAttributeValue("MAX_EVAL", static_cast<size_t>(bbe) );
92 }

◆ set_MAX_ITERATIONS()

void NOMAD::AllParameters::set_MAX_ITERATIONS ( int  max_iterations)

Set the MAX_ITERATIONS parameter (compatibility NOMAD 3).

Definition at line 106 of file ParametersNomad3.cpp.

107 {
108  // -1 is the old way for INF
109  if ( max_iterations >= NOMAD::P_INF_INT || max_iterations == -1 )
110  setAttributeValue("MAX_ITERATIONS", NOMAD::INF_SIZE_T );
111  else
112  setAttributeValue("MAX_ITERATIONS", static_cast<size_t>(max_iterations) );
113 }

◆ set_MIN_MESH_SIZE()

void set_MIN_MESH_SIZE ( const ArrayOfDouble mms)

Set the MIN_MESH_SIZE parameter (compatibility NOMAD 3).

◆ set_MIN_POLL_SIZE()

void set_MIN_POLL_SIZE ( const ArrayOfDouble mfs)

Set the MIN_FRAME_SIZE parameter (compatibility NOMAD 3).

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

◆ set_SEED()

void NOMAD::AllParameters::set_SEED ( int  seed)

Set the seed (compatibility NOMAD 3).

Definition at line 59 of file ParametersNomad3.cpp.

60 {
61  setAttributeValue("SEED", t);
62 }

◆ set_STATS_FILE()

void set_STATS_FILE ( const ArrayOfDouble  stats)

Set STATS_FILE (compatibility NOMAD 3)

◆ set_TMP_DIR()

void NOMAD::AllParameters::set_TMP_DIR ( const std::string &  tmpdir)

Set temporary directory for blackbox execution (compatibility NOMAD 3)

Definition at line 299 of file ParametersNomad3.cpp.

300 {
301  setAttributeValue("TMP_DIR", tmpdir);
302 }

◆ set_UNDEF_STR()

void NOMAD::AllParameters::set_UNDEF_STR ( const std::string &  undefStr)

Set the UNDEF_STR parameter (compatibility NOMAD 3).

Definition at line 125 of file ParametersNomad3.cpp.

126 {
127  setAttributeValue("UNDEF_STR", undefStr);
128 }

◆ set_UPPER_BOUND()

void set_UPPER_BOUND ( const ArrayOfDouble ub)

Set all upper bounds (compatibility NOMAD 3).

Use undefined values for variables without bounds.

◆ set_X0()

void set_X0 ( const Point x0)

Add a starting point (compatibility NOMAD 3).

INF_SIZE_T
const size_t INF_SIZE_T
The infinity for size_t.
Definition: defines.hpp:129
P_INF_INT
const int P_INF_INT
plus infinity for int
Definition: defines.hpp:127