Scippy

SCIP

Solving Constraint Integer Programs

paramset.h
Go to the documentation of this file.
1 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2 /* */
3 /* This file is part of the program and library */
4 /* SCIP --- Solving Constraint Integer Programs */
5 /* */
6 /* Copyright (C) 2002-2021 Konrad-Zuse-Zentrum */
7 /* fuer Informationstechnik Berlin */
8 /* */
9 /* SCIP is distributed under the terms of the ZIB Academic License. */
10 /* */
11 /* You should have received a copy of the ZIB Academic License */
12 /* along with SCIP; see the file COPYING. If not visit scipopt.org. */
13 /* */
14 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
15 
16 /**@file paramset.h
17  * @ingroup INTERNALAPI
18  * @brief internal methods for handling parameter settings
19  * @author Tobias Achterberg
20  * @author Timo Berthold
21  */
22 
23 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
24 
25 #ifndef __SCIP_PARAMSET_H__
26 #define __SCIP_PARAMSET_H__
27 
28 
29 #include "scip/def.h"
30 #include "blockmemshell/memory.h"
31 #include "scip/type_set.h"
32 #include "scip/type_retcode.h"
33 #include "scip/type_paramset.h"
34 #include "scip/pub_paramset.h"
35 #include "scip/pub_misc.h"
36 
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40 
41 /** creates parameter set */
43  SCIP_PARAMSET** paramset, /**< pointer to store the parameter set */
44  BMS_BLKMEM* blkmem /**< block memory */
45  );
46 
47 /** frees parameter set */
48 void SCIPparamsetFree(
49  SCIP_PARAMSET** paramset, /**< pointer to the parameter set */
50  BMS_BLKMEM* blkmem /**< block memory */
51  );
52 
53 /** creates a bool parameter, sets it to its default value, and adds it to the parameter set */
55  SCIP_PARAMSET* paramset, /**< parameter set */
56  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
57  BMS_BLKMEM* blkmem, /**< block memory */
58  const char* name, /**< name of the parameter */
59  const char* desc, /**< description of the parameter */
60  SCIP_Bool* valueptr, /**< pointer to store the current parameter value, or NULL */
61  SCIP_Bool isadvanced, /**< is this parameter an advanced parameter? */
62  SCIP_Bool defaultvalue, /**< default value of the parameter */
63  SCIP_DECL_PARAMCHGD ((*paramchgd)), /**< change information method of parameter */
64  SCIP_PARAMDATA* paramdata /**< locally defined parameter specific data */
65  );
66 
67 /** creates a int parameter, sets it to its default value, and adds it to the parameter set */
69  SCIP_PARAMSET* paramset, /**< parameter set */
70  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
71  BMS_BLKMEM* blkmem, /**< block memory */
72  const char* name, /**< name of the parameter */
73  const char* desc, /**< description of the parameter */
74  int* valueptr, /**< pointer to store the current parameter value, or NULL */
75  SCIP_Bool isadvanced, /**< is this parameter an advanced parameter? */
76  int defaultvalue, /**< default value of the parameter */
77  int minvalue, /**< minimum value for parameter */
78  int maxvalue, /**< maximum value for parameter */
79  SCIP_DECL_PARAMCHGD ((*paramchgd)), /**< change information method of parameter */
80  SCIP_PARAMDATA* paramdata /**< locally defined parameter specific data */
81  );
82 
83 /** creates a SCIP_Longint parameter, sets it to its default value, and adds it to the parameter set */
85  SCIP_PARAMSET* paramset, /**< parameter set */
86  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
87  BMS_BLKMEM* blkmem, /**< block memory */
88  const char* name, /**< name of the parameter */
89  const char* desc, /**< description of the parameter */
90  SCIP_Longint* valueptr, /**< pointer to store the current parameter value, or NULL */
91  SCIP_Bool isadvanced, /**< is this parameter an advanced parameter? */
92  SCIP_Longint defaultvalue, /**< default value of the parameter */
93  SCIP_Longint minvalue, /**< minimum value for parameter */
94  SCIP_Longint maxvalue, /**< maximum value for parameter */
95  SCIP_DECL_PARAMCHGD ((*paramchgd)), /**< change information method of parameter */
96  SCIP_PARAMDATA* paramdata /**< locally defined parameter specific data */
97  );
98 
99 /** creates a SCIP_Real parameter, sets it to its default value, and adds it to the parameter set */
101  SCIP_PARAMSET* paramset, /**< parameter set */
102  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
103  BMS_BLKMEM* blkmem, /**< block memory */
104  const char* name, /**< name of the parameter */
105  const char* desc, /**< description of the parameter */
106  SCIP_Real* valueptr, /**< pointer to store the current parameter value, or NULL */
107  SCIP_Bool isadvanced, /**< is this parameter an advanced parameter? */
108  SCIP_Real defaultvalue, /**< default value of the parameter */
109  SCIP_Real minvalue, /**< minimum value for parameter */
110  SCIP_Real maxvalue, /**< maximum value for parameter */
111  SCIP_DECL_PARAMCHGD ((*paramchgd)), /**< change information method of parameter */
112  SCIP_PARAMDATA* paramdata /**< locally defined parameter specific data */
113  );
114 
115 /** creates a char parameter, sets it to its default value, and adds it to the parameter set */
117  SCIP_PARAMSET* paramset, /**< parameter set */
118  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
119  BMS_BLKMEM* blkmem, /**< block memory */
120  const char* name, /**< name of the parameter */
121  const char* desc, /**< description of the parameter */
122  char* valueptr, /**< pointer to store the current parameter value, or NULL */
123  SCIP_Bool isadvanced, /**< is this parameter an advanced parameter? */
124  char defaultvalue, /**< default value of the parameter */
125  const char* allowedvalues, /**< array with possible parameter values, or NULL if not restricted */
126  SCIP_DECL_PARAMCHGD ((*paramchgd)), /**< change information method of parameter */
127  SCIP_PARAMDATA* paramdata /**< locally defined parameter specific data */
128  );
129 
130 /** creates a string parameter, sets it to its default value, and adds it to the parameter set */
132  SCIP_PARAMSET* paramset, /**< parameter set */
133  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
134  BMS_BLKMEM* blkmem, /**< block memory */
135  const char* name, /**< name of the parameter */
136  const char* desc, /**< description of the parameter */
137  char** valueptr, /**< pointer to store the current parameter value, or NULL */
138  SCIP_Bool isadvanced, /**< is this parameter an advanced parameter? */
139  const char* defaultvalue, /**< default value of the parameter */
140  SCIP_DECL_PARAMCHGD ((*paramchgd)), /**< change information method of parameter */
141  SCIP_PARAMDATA* paramdata /**< locally defined parameter specific data */
142  );
143 
144 /** returns whether an existing parameter is fixed */
146  SCIP_PARAMSET* paramset, /**< parameter set */
147  const char* name /**< name of the parameter */
148  );
149 
150 /** returns the pointer to an existing SCIP parameter */
152  SCIP_PARAMSET* paramset, /**< parameter set */
153  const char* name /**< name of the parameter */
154  );
155 
156 /** gets the value of an existing SCIP_Bool parameter */
158  SCIP_PARAMSET* paramset, /**< parameter set */
159  const char* name, /**< name of the parameter */
160  SCIP_Bool* value /**< pointer to store the parameter */
161  );
162 
163 /** gets the value of an existing int parameter */
165  SCIP_PARAMSET* paramset, /**< parameter set */
166  const char* name, /**< name of the parameter */
167  int* value /**< pointer to store the parameter */
168  );
169 
170 /** gets the value of an existing SCIP_Longint parameter */
172  SCIP_PARAMSET* paramset, /**< parameter set */
173  const char* name, /**< name of the parameter */
174  SCIP_Longint* value /**< pointer to store the parameter */
175  );
176 
177 /** gets the value of an existing SCIP_Real parameter */
179  SCIP_PARAMSET* paramset, /**< parameter set */
180  const char* name, /**< name of the parameter */
181  SCIP_Real* value /**< pointer to store the parameter */
182  );
183 
184 /** gets the value of an existing char parameter */
186  SCIP_PARAMSET* paramset, /**< parameter set */
187  const char* name, /**< name of the parameter */
188  char* value /**< pointer to store the parameter */
189  );
190 
191 /** gets the value of an existing string parameter */
193  SCIP_PARAMSET* paramset, /**< parameter set */
194  const char* name, /**< name of the parameter */
195  char** value /**< pointer to store the parameter */
196  );
197 
198 /** changes the fixing status of an existing parameter */
200  SCIP_PARAMSET* paramset, /**< parameter set */
201  const char* name, /**< name of the parameter */
202  SCIP_Bool fixed /**< new fixing status of the parameter */
203  );
204 
205 /** changes the value of an existing parameter */
207  SCIP_PARAMSET* paramset, /**< parameter set */
208  SCIP_SET* set, /**< global SCIP settings */
209  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
210  const char* name, /**< name of the parameter */
211  void* value /**< new value of the parameter */
212  );
213 
214 /** changes the value of an existing SCIP_Bool parameter */
216  SCIP_PARAMSET* paramset, /**< parameter set */
217  SCIP_SET* set, /**< global SCIP settings */
218  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
219  const char* name, /**< name of the parameter */
220  SCIP_Bool value /**< new value of the parameter */
221  );
222 
223 /** changes the default value of an existing SCIP_Bool parameter */
225  SCIP_PARAMSET* paramset, /**< parameter set */
226  const char* name, /**< name of the parameter */
227  SCIP_Bool defaultvalue /**< new default value of the parameter */
228  );
229 
230 /** changes the value of an existing int parameter */
232  SCIP_PARAMSET* paramset, /**< parameter set */
233  SCIP_SET* set, /**< global SCIP settings */
234  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
235  const char* name, /**< name of the parameter */
236  int value /**< new value of the parameter */
237  );
238 
239 /** changes the default value of an existing int parameter */
241  SCIP_PARAMSET* paramset, /**< parameter set */
242  const char* name, /**< name of the parameter */
243  int defaultvalue /**< new default value of the parameter */
244  );
245 
246 /** changes the value of an existing SCIP_Longint parameter */
248  SCIP_PARAMSET* paramset, /**< parameter set */
249  SCIP_SET* set, /**< global SCIP settings */
250  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
251  const char* name, /**< name of the parameter */
252  SCIP_Longint value /**< new value of the parameter */
253  );
254 
255 /** changes the value of an existing SCIP_Real parameter */
257  SCIP_PARAMSET* paramset, /**< parameter set */
258  SCIP_SET* set, /**< global SCIP settings */
259  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
260  const char* name, /**< name of the parameter */
261  SCIP_Real value /**< new value of the parameter */
262  );
263 
264 /** changes the value of an existing char parameter */
266  SCIP_PARAMSET* paramset, /**< parameter set */
267  SCIP_SET* set, /**< global SCIP settings */
268  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
269  const char* name, /**< name of the parameter */
270  char value /**< new value of the parameter */
271  );
272 
273 /** changes the value of an existing string parameter */
275  SCIP_PARAMSET* paramset, /**< parameter set */
276  SCIP_SET* set, /**< global SCIP settings */
277  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
278  const char* name, /**< name of the parameter */
279  const char* value /**< new value of the parameter */
280  );
281 
282 /** reads parameters from a file */
284  SCIP_PARAMSET* paramset, /**< parameter set */
285  SCIP_SET* set, /**< global SCIP settings */
286  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
287  const char* filename /**< file name */
288  );
289 
290 /** writes all parameters in the parameter set to a file */
292  SCIP_PARAMSET* paramset, /**< parameter set */
293  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
294  const char* filename, /**< file name, or NULL for stdout */
295  SCIP_Bool comments, /**< should parameter descriptions be written as comments? */
296  SCIP_Bool onlychanged /**< should only the parameters been written, that are changed from default? */
297  );
298 
299 /** installs default values for all parameters */
301  SCIP_PARAMSET* paramset, /**< parameter set */
302  SCIP_SET* set, /**< global SCIP settings */
303  SCIP_MESSAGEHDLR* messagehdlr /**< message handler */
304  );
305 
306 /** installs default value for a single parameter */
308  SCIP_PARAMSET* paramset, /**< parameter set */
309  SCIP_SET* set, /**< global SCIP settings */
310  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
311  const char* paramname /**< name of the parameter */
312  );
313 
314 /** sets parameters to
315  *
316  * - \ref SCIP_PARAMEMPHASIS_DEFAULT to use default values (see also SCIPparamsetSetToDefault())
317  * - \ref SCIP_PARAMEMPHASIS_COUNTER to get feasible and "fast" counting process
318  * - \ref SCIP_PARAMEMPHASIS_CPSOLVER to get CP like search (e.g. no LP relaxation)
319  * - \ref SCIP_PARAMEMPHASIS_EASYCIP to solve easy problems fast
320  * - \ref SCIP_PARAMEMPHASIS_FEASIBILITY to detect feasibility fast
321  * - \ref SCIP_PARAMEMPHASIS_HARDLP to be capable to handle hard LPs
322  * - \ref SCIP_PARAMEMPHASIS_OPTIMALITY to prove optimality fast
323  * - \ref SCIP_PARAMEMPHASIS_PHASEFEAS to find feasible solutions during a 3 phase solution process
324  * - \ref SCIP_PARAMEMPHASIS_PHASEIMPROVE to find improved solutions during a 3 phase solution process
325  * - \ref SCIP_PARAMEMPHASIS_PHASEPROOF to proof optimality during a 3 phase solution process
326  * - \ref SCIP_PARAMEMPHASIS_NUMERICS to solve problems which cause numerical issues
327  */
329  SCIP_PARAMSET* paramset, /**< parameter set */
330  SCIP_SET* set, /**< global SCIP settings */
331  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
332  SCIP_PARAMEMPHASIS paramemphasis, /**< parameter emphasis */
333  SCIP_Bool quiet /**< should the parameter be set quiet (no output) */
334  );
335 
336 /** sets parameters to deactivate separators and heuristics that use auxiliary SCIP instances; should be called for
337  * auxiliary SCIP instances to avoid recursion
338  */
340  SCIP_PARAMSET* paramset, /**< parameter set */
341  SCIP_SET* set, /**< global SCIP settings */
342  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
343  SCIP_Bool quiet /**< should the parameter be set quiet (no output) */
344  );
345 
346 /** sets heuristic parameters values to
347  * - SCIP_PARAMSETTING_DEFAULT which are the default values of all heuristic parameters
348  * - SCIP_PARAMSETTING_FAST such that the time spend for heuristic is decreased
349  * - SCIP_PARAMSETTING_AGGRESSIVE such that the heuristic are called more aggregative
350  * - SCIP_PARAMSETTING_OFF which turn off all heuristics
351  */
353  SCIP_PARAMSET* paramset, /**< parameter set */
354  SCIP_SET* set, /**< global SCIP settings */
355  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
356  SCIP_PARAMSETTING paramsetting, /**< parameter settings */
357  SCIP_Bool quiet /**< should the parameter be set quiet (no output) */
358  );
359 
360 /** sets presolving parameters to
361  * - SCIP_PARAMSETTING_DEFAULT which are the default values of all presolving parameters
362  * - SCIP_PARAMSETTING_FAST such that the time spend for presolving is decreased
363  * - SCIP_PARAMSETTING_AGGRESSIVE such that the presolving is more aggregative
364  * - SCIP_PARAMSETTING_OFF which turn off all presolving
365  */
367  SCIP_PARAMSET* paramset, /**< parameter set */
368  SCIP_SET* set, /**< global SCIP settings */
369  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
370  SCIP_PARAMSETTING paramsetting, /**< parameter settings */
371  SCIP_Bool quiet /**< should the parameter be set quiet (no output) */
372  );
373 
374 /** sets separating parameters to
375  * - SCIP_PARAMSETTING_DEFAULT which are the default values of all separating parameters
376  * - SCIP_PARAMSETTING_FAST such that the time spend for separating is decreased
377  * - SCIP_PARAMSETTING_AGGRESSIVE such that the separating is done more aggregative
378  * - SCIP_PARAMSETTING_OFF which turn off all separating
379  */
381  SCIP_PARAMSET* paramset, /**< parameter set */
382  SCIP_SET* set, /**< global SCIP settings */
383  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
384  SCIP_PARAMSETTING paramsetting, /**< parameter settings */
385  SCIP_Bool quiet /**< should the parameter be set quiet (no output) */
386  );
387 
388 /** returns the array of parameters */
390  SCIP_PARAMSET* paramset /**< parameter set */
391  );
392 
393 /** returns the number of parameters in the parameter set */
395  SCIP_PARAMSET* paramset /**< parameter set */
396  );
397 
398 /** copies all parameter values of the source parameter set to the corresponding parameters in the target set */
400  SCIP_PARAMSET* sourceparamset, /**< source parameter set */
401  SCIP_PARAMSET* targetparamset, /**< target parameter set */
402  SCIP_SET* set, /**< global SCIP settings of target SCIP */
403  SCIP_MESSAGEHDLR* messagehdlr /**< message handler of target SCIP */
404  );
405 
406 /** checks whether value of SCIP_Bool parameter is valid */
408  SCIP_PARAM* param, /**< parameter */
409  SCIP_Bool value /**< value to check */
410  );
411 
412 /** checks whether value of integer parameter is valid */
414  SCIP_PARAM* param, /**< parameter */
415  int value /**< value to check */
416  );
417 
418 /** checks whether value of SCIP_Longint parameter is valid */
420  SCIP_PARAM* param, /**< parameter */
421  SCIP_Longint value /**< value to check */
422  );
423 
424 /** checks whether value of SCIP_Real parameter is valid */
426  SCIP_PARAM* param, /**< parameter */
427  SCIP_Real value /**< value to check */
428  );
429 
430 /** checks whether value of char parameter is valid */
432  SCIP_PARAM* param, /**< parameter */
433  const char value /**< value to check */
434  );
435 
436 /** checks whether value of string parameter is valid */
438  SCIP_PARAM* param, /**< parameter */
439  const char* value /**< value to check */
440  );
441 
442 /** sets value of SCIP_Bool parameter */
444  SCIP_PARAM* param, /**< parameter */
445  SCIP_SET* set, /**< global SCIP settings, or NULL if param change method should not be called */
446  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
447  SCIP_Bool value, /**< new value of the parameter */
448  SCIP_Bool initialize, /**< is this the initialization of the parameter? */
449  SCIP_Bool quiet /**< should the parameter be set quiet (no output) */
450  );
451 
452 /** sets value of int parameter */
454  SCIP_PARAM* param, /**< parameter */
455  SCIP_SET* set, /**< global SCIP settings, or NULL if param change method should not be called */
456  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
457  int value, /**< new value of the parameter */
458  SCIP_Bool initialize, /**< is this the initialization of the parameter? */
459  SCIP_Bool quiet /**< should the parameter be set quiet (no output) */
460  );
461 
462 /** sets value of SCIP_Longint parameter */
464  SCIP_PARAM* param, /**< parameter */
465  SCIP_SET* set, /**< global SCIP settings, or NULL if param change method should not be called */
466  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
467  SCIP_Longint value, /**< new value of the parameter */
468  SCIP_Bool initialize, /**< is this the initialization of the parameter? */
469  SCIP_Bool quiet /**< should the parameter be set quiet (no output) */
470  );
471 
472 /** sets value of SCIP_Real parameter */
474  SCIP_PARAM* param, /**< parameter */
475  SCIP_SET* set, /**< global SCIP settings, or NULL if param change method should not be called */
476  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
477  SCIP_Real value, /**< new value of the parameter */
478  SCIP_Bool initialize, /**< is this the initialization of the parameter? */
479  SCIP_Bool quiet /**< should the parameter be set quiet (no output) */
480  );
481 
482 /** sets value of char parameter */
484  SCIP_PARAM* param, /**< parameter */
485  SCIP_SET* set, /**< global SCIP settings, or NULL if param change method should not be called */
486  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
487  char value, /**< new value of the parameter */
488  SCIP_Bool initialize, /**< is this the initialization of the parameter? */
489  SCIP_Bool quiet /**< should the parameter be set quiet (no output) */
490  );
491 
492 /** sets value of string parameter */
494  SCIP_PARAM* param, /**< parameter */
495  SCIP_SET* set, /**< global SCIP settings, or NULL if param change method should not be called */
496  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
497  const char* value, /**< new value of the parameter */
498  SCIP_Bool quiet /**< should the parameter be set quiet (no output) */
499  );
500 
501 /** sets default value of SCIP_Bool parameter */
503  SCIP_PARAM* param, /**< parameter */
504  SCIP_Bool defaultvalue /**< new default value */
505  );
506 
507 /** sets default value of int parameter */
509  SCIP_PARAM* param, /**< parameter */
510  int defaultvalue /**< new default value */
511  );
512 
513 /** sets the parameter to its default setting */
515  SCIP_PARAM* param, /**< parameter */
516  SCIP_SET* set, /**< global SCIP settings */
517  SCIP_MESSAGEHDLR* messagehdlr /**< message handler */
518  );
519 
520 /** writes a single parameter to a file */
522  SCIP_PARAM* param, /**< parameter */
523  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
524  const char* filename, /**< file name, or NULL for stdout */
525  SCIP_Bool comments, /**< should parameter descriptions be written as comments? */
526  SCIP_Bool onlychanged /**< should only the parameters been written, that are changed from default? */
527  );
528 
529 #ifdef __cplusplus
530 }
531 #endif
532 
533 #endif
SCIP_Bool SCIPparamIsValidInt(SCIP_PARAM *param, int value)
Definition: paramset.c:4351
SCIP_RETCODE SCIPparamsetWrite(SCIP_PARAMSET *paramset, SCIP_MESSAGEHDLR *messagehdlr, const char *filename, SCIP_Bool comments, SCIP_Bool onlychanged)
Definition: paramset.c:2613
SCIP_RETCODE SCIPparamsetFix(SCIP_PARAMSET *paramset, const char *name, SCIP_Bool fixed)
Definition: paramset.c:1907
SCIP_Bool SCIPparamIsValidLongint(SCIP_PARAM *param, SCIP_Longint value)
Definition: paramset.c:4362
struct SCIP_ParamData SCIP_PARAMDATA
Definition: type_paramset.h:77
SCIP_RETCODE SCIPparamsetSetToDefault(SCIP_PARAMSET *paramset, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, const char *paramname)
Definition: paramset.c:2714
SCIP_RETCODE SCIPparamsetAddChar(SCIP_PARAMSET *paramset, SCIP_MESSAGEHDLR *messagehdlr, BMS_BLKMEM *blkmem, const char *name, const char *desc, char *valueptr, SCIP_Bool isadvanced, char defaultvalue, const char *allowedvalues, SCIP_DECL_PARAMCHGD((*paramchgd)), SCIP_PARAMDATA *paramdata)
Definition: paramset.c:1607
SCIP_RETCODE SCIPparamsetSetToDefaults(SCIP_PARAMSET *paramset, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr)
Definition: paramset.c:2696
void SCIPparamSetDefaultBool(SCIP_PARAM *param, SCIP_Bool defaultvalue)
Definition: paramset.c:4798
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:54
SCIP_RETCODE SCIPparamsetGetInt(SCIP_PARAMSET *paramset, const char *name, int *value)
Definition: paramset.c:1747
type definitions for global SCIP settings
SCIP_RETCODE SCIPparamsetSetReal(SCIP_PARAMSET *paramset, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, const char *name, SCIP_Real value)
Definition: paramset.c:2157
SCIP_RETCODE SCIPparamsetSetToSubscipsOff(SCIP_PARAMSET *paramset, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, SCIP_Bool quiet)
Definition: paramset.c:4004
SCIP_RETCODE SCIPparamsetGetBool(SCIP_PARAMSET *paramset, const char *name, SCIP_Bool *value)
Definition: paramset.c:1715
type definitions for return codes for SCIP methods
SCIP_RETCODE SCIPparamsetSetSeparating(SCIP_PARAMSET *paramset, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, SCIP_PARAMSETTING paramsetting, SCIP_Bool quiet)
Definition: paramset.c:4181
SCIP_RETCODE SCIPparamSetString(SCIP_PARAM *param, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, const char *value, SCIP_Bool quiet)
Definition: paramset.c:4729
SCIP_PARAM * SCIPparamsetGetParam(SCIP_PARAMSET *paramset, const char *name)
Definition: paramset.c:1703
SCIP_RETCODE SCIPparamsetCreate(SCIP_PARAMSET **paramset, BMS_BLKMEM *blkmem)
Definition: paramset.c:1417
enum SCIP_ParamSetting SCIP_PARAMSETTING
Definition: type_paramset.h:56
public methods for handling parameter settings
SCIP_RETCODE SCIPparamSetChar(SCIP_PARAM *param, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, char value, SCIP_Bool initialize, SCIP_Bool quiet)
Definition: paramset.c:4670
SCIP_RETCODE SCIPparamSetLongint(SCIP_PARAM *param, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, SCIP_Longint value, SCIP_Bool initialize, SCIP_Bool quiet)
Definition: paramset.c:4548
int SCIPparamsetGetNParams(SCIP_PARAMSET *paramset)
Definition: paramset.c:4222
#define SCIP_DECL_PARAMCHGD(x)
Definition: type_paramset.h:92
SCIP_RETCODE SCIPparamsetSetHeuristics(SCIP_PARAMSET *paramset, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, SCIP_PARAMSETTING paramsetting, SCIP_Bool quiet)
Definition: paramset.c:4109
SCIP_RETCODE SCIPparamsetGetLongint(SCIP_PARAMSET *paramset, const char *name, SCIP_Longint *value)
Definition: paramset.c:1779
SCIP_RETCODE SCIPparamSetBool(SCIP_PARAM *param, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, SCIP_Bool value, SCIP_Bool initialize, SCIP_Bool quiet)
Definition: paramset.c:4428
SCIP_RETCODE SCIPparamsetAddString(SCIP_PARAMSET *paramset, SCIP_MESSAGEHDLR *messagehdlr, BMS_BLKMEM *blkmem, const char *name, const char *desc, char **valueptr, SCIP_Bool isadvanced, const char *defaultvalue, SCIP_DECL_PARAMCHGD((*paramchgd)), SCIP_PARAMDATA *paramdata)
Definition: paramset.c:1636
SCIP_RETCODE SCIPparamSetInt(SCIP_PARAM *param, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, int value, SCIP_Bool initialize, SCIP_Bool quiet)
Definition: paramset.c:4488
SCIP_RETCODE SCIPparamsetSetInt(SCIP_PARAMSET *paramset, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, const char *name, int value)
Definition: paramset.c:2058
SCIP_Bool SCIPparamIsValidReal(SCIP_PARAM *param, SCIP_Real value)
Definition: paramset.c:4373
public data structures and miscellaneous methods
#define SCIP_Bool
Definition: def.h:70
SCIP_RETCODE SCIPparamsetSetDefaultBool(SCIP_PARAMSET *paramset, const char *name, SCIP_Bool defaultvalue)
Definition: paramset.c:2027
static const char * paramname[]
Definition: lpi_msk.c:4974
SCIP_RETCODE SCIPparamsetSetDefaultInt(SCIP_PARAMSET *paramset, const char *name, int defaultvalue)
Definition: paramset.c:2092
SCIP_RETCODE SCIPparamsetSetBool(SCIP_PARAMSET *paramset, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, const char *name, SCIP_Bool value)
Definition: paramset.c:1993
SCIP_RETCODE SCIPparamsetAddInt(SCIP_PARAMSET *paramset, SCIP_MESSAGEHDLR *messagehdlr, BMS_BLKMEM *blkmem, const char *name, const char *desc, int *valueptr, SCIP_Bool isadvanced, int defaultvalue, int minvalue, int maxvalue, SCIP_DECL_PARAMCHGD((*paramchgd)), SCIP_PARAMDATA *paramdata)
Definition: paramset.c:1517
SCIP_Bool SCIPparamIsValidBool(SCIP_PARAM *param, SCIP_Bool value)
Definition: paramset.c:4341
SCIP_RETCODE SCIPparamsetGetReal(SCIP_PARAMSET *paramset, const char *name, SCIP_Real *value)
Definition: paramset.c:1811
void SCIPparamsetFree(SCIP_PARAMSET **paramset, BMS_BLKMEM *blkmem)
Definition: paramset.c:1437
SCIP_RETCODE SCIPparamsetRead(SCIP_PARAMSET *paramset, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, const char *filename)
Definition: paramset.c:2563
SCIP_RETCODE SCIPparamsetGetString(SCIP_PARAMSET *paramset, const char *name, char **value)
Definition: paramset.c:1875
SCIP_RETCODE SCIPparamsetSetEmphasis(SCIP_PARAMSET *paramset, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, SCIP_PARAMEMPHASIS paramemphasis, SCIP_Bool quiet)
Definition: paramset.c:3747
SCIP_RETCODE SCIPparamsetAddLongint(SCIP_PARAMSET *paramset, SCIP_MESSAGEHDLR *messagehdlr, BMS_BLKMEM *blkmem, const char *name, const char *desc, SCIP_Longint *valueptr, SCIP_Bool isadvanced, SCIP_Longint defaultvalue, SCIP_Longint minvalue, SCIP_Longint maxvalue, SCIP_DECL_PARAMCHGD((*paramchgd)), SCIP_PARAMDATA *paramdata)
Definition: paramset.c:1547
SCIP_RETCODE SCIPparamsetGetChar(SCIP_PARAMSET *paramset, const char *name, char *value)
Definition: paramset.c:1843
enum SCIP_ParamEmphasis SCIP_PARAMEMPHASIS
Definition: type_paramset.h:74
SCIP_RETCODE SCIPparamsetSetChar(SCIP_PARAMSET *paramset, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, const char *name, char value)
Definition: paramset.c:2191
SCIP_RETCODE SCIPparamsetAddBool(SCIP_PARAMSET *paramset, SCIP_MESSAGEHDLR *messagehdlr, BMS_BLKMEM *blkmem, const char *name, const char *desc, SCIP_Bool *valueptr, SCIP_Bool isadvanced, SCIP_Bool defaultvalue, SCIP_DECL_PARAMCHGD((*paramchgd)), SCIP_PARAMDATA *paramdata)
Definition: paramset.c:1490
SCIP_RETCODE SCIPparamsetSetPresolving(SCIP_PARAMSET *paramset, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, SCIP_PARAMSETTING paramsetting, SCIP_Bool quiet)
Definition: paramset.c:4145
SCIP_RETCODE SCIPparamsetAddReal(SCIP_PARAMSET *paramset, SCIP_MESSAGEHDLR *messagehdlr, BMS_BLKMEM *blkmem, const char *name, const char *desc, SCIP_Real *valueptr, SCIP_Bool isadvanced, SCIP_Real defaultvalue, SCIP_Real minvalue, SCIP_Real maxvalue, SCIP_DECL_PARAMCHGD((*paramchgd)), SCIP_PARAMDATA *paramdata)
Definition: paramset.c:1577
SCIP_RETCODE SCIPparamsetCopyParams(SCIP_PARAMSET *sourceparamset, SCIP_PARAMSET *targetparamset, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr)
Definition: paramset.c:4236
SCIP_RETCODE SCIPparamsetSetString(SCIP_PARAMSET *paramset, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, const char *name, const char *value)
Definition: paramset.c:2225
type definitions for handling parameter settings
SCIP_RETCODE SCIPparamsetSetLongint(SCIP_PARAMSET *paramset, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, const char *name, SCIP_Longint value)
Definition: paramset.c:2123
#define SCIP_Real
Definition: def.h:163
SCIP_RETCODE SCIPparamWrite(SCIP_PARAM *param, SCIP_MESSAGEHDLR *messagehdlr, const char *filename, SCIP_Bool comments, SCIP_Bool onlychanged)
Definition: paramset.c:4875
SCIP_Bool SCIPparamIsValidString(SCIP_PARAM *param, const char *value)
Definition: paramset.c:4410
#define SCIP_Longint
Definition: def.h:148
SCIP_RETCODE SCIPparamsetSet(SCIP_PARAMSET *paramset, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, const char *name, void *value)
Definition: paramset.c:1931
SCIP_Bool SCIPparamIsValidChar(SCIP_PARAM *param, const char value)
Definition: paramset.c:4384
common defines and data types used in all packages of SCIP
struct BMS_BlkMem BMS_BLKMEM
Definition: memory.h:429
SCIP_PARAM ** SCIPparamsetGetParams(SCIP_PARAMSET *paramset)
Definition: paramset.c:4212
SCIP_RETCODE SCIPparamSetToDefault(SCIP_PARAM *param, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr)
Definition: paramset.c:4824
SCIP_Bool SCIPparamsetIsFixed(SCIP_PARAMSET *paramset, const char *name)
Definition: paramset.c:1681
void SCIPparamSetDefaultInt(SCIP_PARAM *param, int defaultvalue)
Definition: paramset.c:4810
SCIP_RETCODE SCIPparamSetReal(SCIP_PARAM *param, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, SCIP_Real value, SCIP_Bool initialize, SCIP_Bool quiet)
Definition: paramset.c:4608
memory allocation routines