NOMAD Source  Version 4.0.0 Beta
EvalParameters.hpp
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------------*/
2 /* NOMAD - Nonlinear Optimization by Mesh Adaptive Direct Search - */
3 /* */
4 /* NOMAD - Version 4.0.0 has been created by */
5 /* Viviane Rochon Montplaisir - Polytechnique Montreal */
6 /* Christophe Tribes - Polytechnique Montreal */
7 /* */
8 /* The copyright of NOMAD - version 4.0.0 is owned by */
9 /* Charles Audet - Polytechnique Montreal */
10 /* Sebastien Le Digabel - Polytechnique Montreal */
11 /* Viviane Rochon Montplaisir - Polytechnique Montreal */
12 /* Christophe Tribes - Polytechnique Montreal */
13 /* */
14 /* NOMAD v4 has been funded by Rio Tinto, Hydro-Québec, NSERC (Natural */
15 /* Sciences and Engineering Research Council of Canada), InnovÉÉ (Innovation */
16 /* en Énergie Électrique) and IVADO (The Institute for Data Valorization) */
17 /* */
18 /* NOMAD v3 was created and developed by Charles Audet, Sebastien Le Digabel, */
19 /* Christophe Tribes and Viviane Rochon Montplaisir and was funded by AFOSR */
20 /* and Exxon Mobil. */
21 /* */
22 /* NOMAD v1 and v2 were created and developed by Mark Abramson, Charles Audet, */
23 /* Gilles Couture, and John E. Dennis Jr., and were funded by AFOSR and */
24 /* Exxon Mobil. */
25 /* */
26 /* Contact information: */
27 /* Polytechnique Montreal - GERAD */
28 /* C.P. 6079, Succ. Centre-ville, Montreal (Quebec) H3C 3A7 Canada */
29 /* e-mail: nomad@gerad.ca */
30 /* */
31 /* This program is free software: you can redistribute it and/or modify it */
32 /* under the terms of the GNU Lesser General Public License as published by */
33 /* the Free Software Foundation, either version 3 of the License, or (at your */
34 /* option) any later version. */
35 /* */
36 /* This program is distributed in the hope that it will be useful, but WITHOUT */
37 /* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or */
38 /* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License */
39 /* for more details. */
40 /* */
41 /* You should have received a copy of the GNU Lesser General Public License */
42 /* along with this program. If not, see <http://www.gnu.org/licenses/>. */
43 /* */
44 /* You can find information on the NOMAD software at www.gerad.ca/nomad */
45 /*---------------------------------------------------------------------------------*/
46 #ifndef __NOMAD400_EVALPARAMETERS__
47 #define __NOMAD400_EVALPARAMETERS__
48 
49 #include "../Param/Parameters.hpp"
50 #include "../Param/RunParameters.hpp"
51 
52 #include "../nomad_nsbegin.hpp"
53 
54 /// Class for Evaluator parameters
55 /**
56 - Register all parameters during construction.
57 - Implement the checkAndComply function for sanity check.
58 */
59 class EvalParameters final : public Parameters
60 {
61 public:
62 
63  explicit EvalParameters()
64  : Parameters()
65  {
66  init();
67  }
68 
69  /// Check the sanity of parameters.
70  void checkAndComply( const std::shared_ptr<RunParameters> & runParams );
71 
72 private:
73  /// Helper for constructor
74  /**
75  Register and set default values for all evaluation attributes. The information to register all the attributes is contained in evalAttributesDefinition.hpp as a set of strings to be interpreted. This file is created by the writeAttributeDefinition executable, called automatically by makefile when the evalAttributeDefinition.txt file is modified.
76  */
77  void init() override ;
78 
79 };
80 
81 #include "../nomad_nsend.hpp"
82 
83 #endif // __NOMAD400_EVALPARAMETERS__
84 
EvalParameters
Class for Evaluator parameters.
Definition: EvalParameters.hpp:59
Parameters
Abstract class for the NOMAD parameters.
Definition: Parameters.hpp:137
EvalParameters::checkAndComply
void checkAndComply(const std::shared_ptr< RunParameters > &runParams)
Check the sanity of parameters.
EvalParameters::EvalParameters
EvalParameters()
Definition: EvalParameters.hpp:63
EvalParameters::init
void init() override
Helper for constructor.