NOMAD Source  Version 4.0.0 Beta
pbAttributesDefinition.hpp
Go to the documentation of this file.
1 //////////// THIS FILE MUST BE CREATED BY EXECUTING WriteAttributeDefinitionFile ////////////
2 //////////// DO NOT MODIFY THIS FILE MANUALLY ///////////////////////////////////////////////
3 
4 #ifndef __NOMAD400_PBATTRIBUTESDEFINITION__
5 #define __NOMAD400_PBATTRIBUTESDEFINITION__
6 
8 { "DIMENSION", "size_t", "0", " Dimension of the optimization problem (required) ", " \n \n . Number of variables \n \n . Argument: one positive integer \n \n . Example: DIMENSION 3 \n \n . Default: 0\n\n", " basic dimension dimensions dim dims problem problems prob pb pbs optimization size " , "false" , "false" , "true" },
9 { "X0", "NOMAD::ArrayOfPoint", "-", " The initial point(s) ", " \n \n . Vector of starting point(s) \n \n . Arguments: text file name or DIMENSION reals \n \n . More than one starting point can be defined. All points are evaluated: \n X0 evaluations are not opportunistic. \n \n . May be infeasible \n \n . Cannot be outside bounds \n \n . Must respect fixed variables (parameter FIXED_VARIABLE) \n \n . Examples: \n . X0 x0.txt \n \n . X0 * 0.0 # First starting point \n X0 1 * 1.0 # Second starting point \n \n . X0 ( 0 1 2 ) # if DIMENSION = 3 \n \n . No default value.\n\n", " basic initial variable variables var vars init point points bound bounds lower upper cache start starting " , "false" , "false" , "false" },
10 { "LOWER_BOUND", "NOMAD::ArrayOfDouble", "-", " The optimization problem lower bounds for each variable ", " \n \n . Lower bounds for each variable \n \n . Arguments: DIMENSION reals \n \n . Examples: \n LOWER_BOUND * 0.0 # all variables are nonnegative \n LOWER_BOUND 0-2 0.0 # the 3 first variables are nonnegative \n LOWER_BOUND 0 0.0 # the first variable is nonnegative \n \n . No default value.\n\n", " basic bound bounds lower variable variables constraint constraints " , "false" , "false" , "true" },
11 { "UPPER_BOUND", "NOMAD::ArrayOfDouble", "-", " The optimization problem upper bounds for each variable ", " \n \n . Upper bounds for each variable \n \n . Arguments: DIMENSION reals \n \n . Examples: \n UPPER_BOUND * 10.0 # all variables are less than or equal to 10.0 \n UPPER_BOUND 0-2 10.0 # the 3 first variables are less than or equal to 10.0 \n UPPER_BOUND 0 10.0 # the first variable is less than or equal to 10.0 \n \n . No default value.\n\n", " basic bound bounds upper variable variables constraint constraints " , "false" , "false" , "true" },
12 { "BB_INPUT_TYPE", "NOMAD::BBInputTypeList", "* R", " The variable blackbox input types ", " \n \n . Blackbox input types \n \n . List of types for each variable \n \n . Available types: \n . B: binary \n . I: integer \n . R: continuous \n \n . Examples: \n . BB_INPUT_TYPE * I # all variables are integers \n . BB_INPUT_TYPE ( R I B ) # for all 3 variables \n . BB_INPUT_TYPE 1-3 B # NOT YET SUPPORTED ( variables 1 to 3 are binary ) \n . BB_INPUT_TYPE 0 I # NOT YET SUPPORTED ( first variable is integer ) \n \n . Default: * R\n\n", " basic blackbox blackboxes input inputs type types int integer integers binary bin continuous \n categorical " , "false" , "false" , "true" },
13 { "INITIAL_MESH_SIZE", "NOMAD::ArrayOfDouble", "-", " The initial mesh size of MADS ", " \n \n . Initial mesh size \n \n . Arguments: one or DIMENSION positive real(s) \n \n . NOMAD uses one mesh size per variable. \n \n . Initial frame size is determined from initial mesh size when provided \n \n . Examples: \n . INITIAL_MESH_SIZE 1.0 # for all variables \n . INITIAL_MESH_SIZE 1 0.5 # for variable 1 only \n . INITIAL_MESH_SIZE 2-4 0.25 # for variables 2 to 4 \n \n . No default value.\n\n", " advanced initial mesh size mads gmesh " , "false" , "false" , "true" },
14 { "INITIAL_POLL_SIZE", "NOMAD::ArrayOfDouble", "-", " Deprecated, see INITIAL_FRAME_SIZE ", " \n \n . This is a deprecated parameter from Nomad 3. Renamed INITIAL_FRAME_SIZE. \n \n . No default value.\n\n", " advanced " , "false" , "false" , "true" },
15 { "INITIAL_FRAME_SIZE", "NOMAD::ArrayOfDouble", "-", " The initial frame size of MADS ", " \n \n . Initial frame size \n \n . Arguments: one or DIMENSION positive real(s) \n \n . Reinterpreted empty default: \n 10% of the range if bounds are defined, |x0|/10 otherwise \n \n . NOMAD uses one frame size per variable to achieve scaling \n \n . The initial mesh size is determined from initial frame size when provided, but \n providing both is not allowed. \n \n . Examples \n . INITIAL_FRAME_SIZE 1.0 # for all variables \n . INITIAL_FRAME_SIZE 1 0.5 # for variable 1 only \n . INITIAL_FRAME_SIZE 2-4 0.25 # for variable 2 to 4 \n \n . No default value.\n\n", " advanced intial poll frame mesh size mads gmesh " , "false" , "false" , "true" },
16 { "MIN_POLL_SIZE", "NOMAD::ArrayOfDouble", "-", " Deprecated, see MIN_FRAME_SIZE ", " \n \n . This is a deprecated parameter from Nomad 3. Renamed MIN_FRAME_SIZE. \n \n . No default value.\n\n", " advanced " , "false" , "false" , "true" },
17 { "MIN_FRAME_SIZE", "NOMAD::ArrayOfDouble", "-", " Termination criterion on minimal frame size of MADS ", " \n \n . Minimum frame size. Can be set explicitely or automatically to 1 for \n integer or binary variables (during check). \n \n . Arguments: same logic as INITIAL_FRAME_SIZE ('r' can be used) \n \n . Example: MIN_FRAME_SIZE r1E-5 \n \n . No default value.\n\n", " advanced min minimum poll frame size stop stopping terminate terminates \n termination terminations mads " , "false" , "false" , "true" },
18 { "MIN_MESH_SIZE", "NOMAD::ArrayOfDouble", "-", " Termination criterion on minimal mesh size of MADS ", " \n \n . Minimum mesh size \n \n . Arguments: same logic as INITIAL_MESH_SIZE ('r' can be used) \n \n . Example: MIN_MESH_SIZE r1E-5 \n \n . No default value.\n\n", " advanced min minimum frame mesh size stop stopping terminate terminates termination terminations \n mads " , "false" , "false" , "true" },
19 { "GRANULARITY", "NOMAD::ArrayOfDouble", "-", " The granularity of the variables ", " \n \n . Set the granularity of variables to some specific values \n \n . Arguments: granularity indexes and values (positive) \n \n . Examples: \n . GRANULARITY ( 0.01 0.0 0.01 ) # granularity of variables 0 and 2 are \n # set to 0.01. \n Variable 1 is real. \n . GRANULARITY 0-1 0.01 # 2 first variables set granularity to 0.01 \n . GRANULARITY * 0.01 # all variables set to granularity 0.01 \n \n . No default value.\n\n", " advanced granular integer integers variable variables step " , "false" , "false" , "true" },
20 { "FIXED_VARIABLE", "NOMAD::Point", "-", " Fix some variables to some specific values ", " \n \n . Fix some variables to some specific values \n \n . Arguments: variable indexes and values \n \n . Values for fixed variables are optional. Values of X0 will be used. \n \n . Examples: \n . FIXED_VARIABLE ( 0.0 - 0.0 ) # Variables 0 and 2 are fixed to value 0.0. \n # Variable 1 is not fixed. \n \n . FIXED_VARIABLE 0 # Variable 0 is fixed to its X0 value. \n . FIXED_VARIABLE 2-4 # Variables 2, 3 and 4 are fixed \n # to their X0 values. \n . No default value.\n\n", " advanced fixed variable variables " , "false" , "false" , "true" },
21 { "STOP_IF_FEASIBLE", "bool", "false", " Stop algorithm once a feasible point is obtained ", " \n \n . Stopping criterion on feasibility. Can be use directly. Used by \n the PhaseOneSearch strategy to obtain a feasible point when EB constraints are \n set and the starting point is infeasible. \n \n . Argument: boolean. \n \n . Example: \n . STOP_IF_FEASIBLE true. \n \n . Default: false\n\n", " advanced stopping terminate terminates termination terminations phase one " , "false" , "false" , "true" },
22 { "DIRECTION_TYPE", "NOMAD::DirectionType", "ORTHO 2N", " Type of direction for Mads poll ", " \n . Type of direction used by Mads poll to generate trial points. In NOMAD 4, this \n is can be set only once (UNIQUE_ENTRY true) but in Nomad 3 several direction \n types can be combined. See issue #397. \n \n . Arguments: one direction type in {ORTHO 2N, N+1 UNI, SINGLE, DOUBLE} \n \n \n . Example: \n . DIRECTION_TYPE N+1 UNI \n \n . Default: ORTHO 2N\n\n", " advanced poll direction ortho " , "true" , "false" , "true" },
23 { "VARIABLE_GROUP", "NOMAD::ListOfVariableGroup", "-", " The groups of variables) ", " \n \n . When defined, Mads poll generates trial points in a separate subspace for \n each group of variables. \n \n . Arguments: a list of variable indices or a range of indices \n \n . More than one group of variables can be defined. Providing a single group of \n variables puts the remaining indices into another variable group. \n \n . The indices in the groups of variables must be unique. \n \n . Examples: \n . VARIABLE_GROUP 0 1 2 6 \n . VARIABLE_GROUP 2-6 \n \n . No default value.\n\n", " advanced group groups variable variables var vars poll " , "true" , "false" , "false" } };
24 
25 #endif
_definition
_definition
Definition: pbAttributesDefinition.hpp:7