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-2019 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 scip.zib.de. */
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_retcode.h"
32 #include "scip/type_paramset.h"
33 #include "scip/pub_paramset.h"
34 #include "scip/pub_misc.h"
35 
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39 
40 /** creates parameter set */
41 extern
43  SCIP_PARAMSET** paramset, /**< pointer to store the parameter set */
44  BMS_BLKMEM* blkmem /**< block memory */
45  );
46 
47 /** frees parameter set */
48 extern
49 void SCIPparamsetFree(
50  SCIP_PARAMSET** paramset, /**< pointer to the parameter set */
51  BMS_BLKMEM* blkmem /**< block memory */
52  );
53 
54 /** creates a bool parameter, sets it to its default value, and adds it to the parameter set */
55 extern
57  SCIP_PARAMSET* paramset, /**< parameter set */
58  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
59  BMS_BLKMEM* blkmem, /**< block memory */
60  const char* name, /**< name of the parameter */
61  const char* desc, /**< description of the parameter */
62  SCIP_Bool* valueptr, /**< pointer to store the current parameter value, or NULL */
63  SCIP_Bool isadvanced, /**< is this parameter an advanced parameter? */
64  SCIP_Bool defaultvalue, /**< default value of the parameter */
65  SCIP_DECL_PARAMCHGD ((*paramchgd)), /**< change information method of parameter */
66  SCIP_PARAMDATA* paramdata /**< locally defined parameter specific data */
67  );
68 
69 /** creates a int parameter, sets it to its default value, and adds it to the parameter set */
70 extern
72  SCIP_PARAMSET* paramset, /**< parameter set */
73  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
74  BMS_BLKMEM* blkmem, /**< block memory */
75  const char* name, /**< name of the parameter */
76  const char* desc, /**< description of the parameter */
77  int* valueptr, /**< pointer to store the current parameter value, or NULL */
78  SCIP_Bool isadvanced, /**< is this parameter an advanced parameter? */
79  int defaultvalue, /**< default value of the parameter */
80  int minvalue, /**< minimum value for parameter */
81  int maxvalue, /**< maximum value for parameter */
82  SCIP_DECL_PARAMCHGD ((*paramchgd)), /**< change information method of parameter */
83  SCIP_PARAMDATA* paramdata /**< locally defined parameter specific data */
84  );
85 
86 /** creates a SCIP_Longint parameter, sets it to its default value, and adds it to the parameter set */
87 extern
89  SCIP_PARAMSET* paramset, /**< parameter set */
90  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
91  BMS_BLKMEM* blkmem, /**< block memory */
92  const char* name, /**< name of the parameter */
93  const char* desc, /**< description of the parameter */
94  SCIP_Longint* valueptr, /**< pointer to store the current parameter value, or NULL */
95  SCIP_Bool isadvanced, /**< is this parameter an advanced parameter? */
96  SCIP_Longint defaultvalue, /**< default value of the parameter */
97  SCIP_Longint minvalue, /**< minimum value for parameter */
98  SCIP_Longint maxvalue, /**< maximum value for parameter */
99  SCIP_DECL_PARAMCHGD ((*paramchgd)), /**< change information method of parameter */
100  SCIP_PARAMDATA* paramdata /**< locally defined parameter specific data */
101  );
102 
103 /** creates a SCIP_Real parameter, sets it to its default value, and adds it to the parameter set */
104 extern
106  SCIP_PARAMSET* paramset, /**< parameter set */
107  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
108  BMS_BLKMEM* blkmem, /**< block memory */
109  const char* name, /**< name of the parameter */
110  const char* desc, /**< description of the parameter */
111  SCIP_Real* valueptr, /**< pointer to store the current parameter value, or NULL */
112  SCIP_Bool isadvanced, /**< is this parameter an advanced parameter? */
113  SCIP_Real defaultvalue, /**< default value of the parameter */
114  SCIP_Real minvalue, /**< minimum value for parameter */
115  SCIP_Real maxvalue, /**< maximum value for parameter */
116  SCIP_DECL_PARAMCHGD ((*paramchgd)), /**< change information method of parameter */
117  SCIP_PARAMDATA* paramdata /**< locally defined parameter specific data */
118  );
119 
120 /** creates a char parameter, sets it to its default value, and adds it to the parameter set */
121 extern
123  SCIP_PARAMSET* paramset, /**< parameter set */
124  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
125  BMS_BLKMEM* blkmem, /**< block memory */
126  const char* name, /**< name of the parameter */
127  const char* desc, /**< description of the parameter */
128  char* valueptr, /**< pointer to store the current parameter value, or NULL */
129  SCIP_Bool isadvanced, /**< is this parameter an advanced parameter? */
130  char defaultvalue, /**< default value of the parameter */
131  const char* allowedvalues, /**< array with possible parameter values, or NULL if not restricted */
132  SCIP_DECL_PARAMCHGD ((*paramchgd)), /**< change information method of parameter */
133  SCIP_PARAMDATA* paramdata /**< locally defined parameter specific data */
134  );
135 
136 /** creates a string parameter, sets it to its default value, and adds it to the parameter set */
137 extern
139  SCIP_PARAMSET* paramset, /**< parameter set */
140  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
141  BMS_BLKMEM* blkmem, /**< block memory */
142  const char* name, /**< name of the parameter */
143  const char* desc, /**< description of the parameter */
144  char** valueptr, /**< pointer to store the current parameter value, or NULL */
145  SCIP_Bool isadvanced, /**< is this parameter an advanced parameter? */
146  const char* defaultvalue, /**< default value of the parameter */
147  SCIP_DECL_PARAMCHGD ((*paramchgd)), /**< change information method of parameter */
148  SCIP_PARAMDATA* paramdata /**< locally defined parameter specific data */
149  );
150 
151 /** returns whether an existing parameter is fixed */
152 extern
154  SCIP_PARAMSET* paramset, /**< parameter set */
155  const char* name /**< name of the parameter */
156  );
157 
158 /** returns the pointer to an existing SCIP parameter */
159 extern
161  SCIP_PARAMSET* paramset, /**< parameter set */
162  const char* name /**< name of the parameter */
163  );
164 
165 /** gets the value of an existing SCIP_Bool parameter */
166 extern
168  SCIP_PARAMSET* paramset, /**< parameter set */
169  const char* name, /**< name of the parameter */
170  SCIP_Bool* value /**< pointer to store the parameter */
171  );
172 
173 /** gets the value of an existing int parameter */
174 extern
176  SCIP_PARAMSET* paramset, /**< parameter set */
177  const char* name, /**< name of the parameter */
178  int* value /**< pointer to store the parameter */
179  );
180 
181 /** gets the value of an existing SCIP_Longint parameter */
182 extern
184  SCIP_PARAMSET* paramset, /**< parameter set */
185  const char* name, /**< name of the parameter */
186  SCIP_Longint* value /**< pointer to store the parameter */
187  );
188 
189 /** gets the value of an existing SCIP_Real parameter */
190 extern
192  SCIP_PARAMSET* paramset, /**< parameter set */
193  const char* name, /**< name of the parameter */
194  SCIP_Real* value /**< pointer to store the parameter */
195  );
196 
197 /** gets the value of an existing char parameter */
198 extern
200  SCIP_PARAMSET* paramset, /**< parameter set */
201  const char* name, /**< name of the parameter */
202  char* value /**< pointer to store the parameter */
203  );
204 
205 /** gets the value of an existing string parameter */
206 extern
208  SCIP_PARAMSET* paramset, /**< parameter set */
209  const char* name, /**< name of the parameter */
210  char** value /**< pointer to store the parameter */
211  );
212 
213 /** changes the fixing status of an existing parameter */
215  SCIP_PARAMSET* paramset, /**< parameter set */
216  const char* name, /**< name of the parameter */
217  SCIP_Bool fixed /**< new fixing status of the parameter */
218  );
219 
220 /** changes the value of an existing parameter */
221 extern
223  SCIP_PARAMSET* paramset, /**< parameter set */
224  SCIP_SET* set, /**< global SCIP settings */
225  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
226  const char* name, /**< name of the parameter */
227  void* value /**< new value of the parameter */
228  );
229 
230 /** changes the value of an existing SCIP_Bool parameter */
231 extern
233  SCIP_PARAMSET* paramset, /**< parameter set */
234  SCIP_SET* set, /**< global SCIP settings */
235  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
236  const char* name, /**< name of the parameter */
237  SCIP_Bool value /**< new value of the parameter */
238  );
239 
240 /** changes the default value of an existing SCIP_Bool parameter */
241 extern
243  SCIP_PARAMSET* paramset, /**< parameter set */
244  const char* name, /**< name of the parameter */
245  SCIP_Bool defaultvalue /**< new default value of the parameter */
246  );
247 
248 /** changes the value of an existing int parameter */
249 extern
251  SCIP_PARAMSET* paramset, /**< parameter set */
252  SCIP_SET* set, /**< global SCIP settings */
253  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
254  const char* name, /**< name of the parameter */
255  int value /**< new value of the parameter */
256  );
257 
258 /** changes the default value of an existing int parameter */
259 extern
261  SCIP_PARAMSET* paramset, /**< parameter set */
262  const char* name, /**< name of the parameter */
263  int defaultvalue /**< new default value of the parameter */
264  );
265 
266 /** changes the value of an existing SCIP_Longint parameter */
267 extern
269  SCIP_PARAMSET* paramset, /**< parameter set */
270  SCIP_SET* set, /**< global SCIP settings */
271  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
272  const char* name, /**< name of the parameter */
273  SCIP_Longint value /**< new value of the parameter */
274  );
275 
276 /** changes the value of an existing SCIP_Real parameter */
277 extern
279  SCIP_PARAMSET* paramset, /**< parameter set */
280  SCIP_SET* set, /**< global SCIP settings */
281  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
282  const char* name, /**< name of the parameter */
283  SCIP_Real value /**< new value of the parameter */
284  );
285 
286 /** changes the value of an existing char parameter */
287 extern
289  SCIP_PARAMSET* paramset, /**< parameter set */
290  SCIP_SET* set, /**< global SCIP settings */
291  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
292  const char* name, /**< name of the parameter */
293  char value /**< new value of the parameter */
294  );
295 
296 /** changes the value of an existing string parameter */
297 extern
299  SCIP_PARAMSET* paramset, /**< parameter set */
300  SCIP_SET* set, /**< global SCIP settings */
301  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
302  const char* name, /**< name of the parameter */
303  const char* value /**< new value of the parameter */
304  );
305 
306 /** reads parameters from a file */
308  SCIP_PARAMSET* paramset, /**< parameter set */
309  SCIP_SET* set, /**< global SCIP settings */
310  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
311  const char* filename /**< file name */
312  );
313 
314 /** writes all parameters in the parameter set to a file */
316  SCIP_PARAMSET* paramset, /**< parameter set */
317  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
318  const char* filename, /**< file name, or NULL for stdout */
319  SCIP_Bool comments, /**< should parameter descriptions be written as comments? */
320  SCIP_Bool onlychanged /**< should only the parameters been written, that are changed from default? */
321  );
322 
323 /** installs default values for all parameters */
324 extern
326  SCIP_PARAMSET* paramset, /**< parameter set */
327  SCIP_SET* set, /**< global SCIP settings */
328  SCIP_MESSAGEHDLR* messagehdlr /**< message handler */
329  );
330 
331 /** installs default value for a single parameter */
332 extern
334  SCIP_PARAMSET* paramset, /**< parameter set */
335  SCIP_SET* set, /**< global SCIP settings */
336  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
337  const char* paramname /**< name of the parameter */
338  );
339 
340 /** sets parameters to
341  *
342  * - \ref SCIP_PARAMEMPHASIS_DEFAULT to use default values (see also SCIPparamsetSetToDefault())
343  * - \ref SCIP_PARAMEMPHASIS_COUNTER to get feasible and "fast" counting process
344  * - \ref SCIP_PARAMEMPHASIS_CPSOLVER to get CP like search (e.g. no LP relaxation)
345  * - \ref SCIP_PARAMEMPHASIS_EASYCIP to solve easy problems fast
346  * - \ref SCIP_PARAMEMPHASIS_FEASIBILITY to detect feasibility fast
347  * - \ref SCIP_PARAMEMPHASIS_HARDLP to be capable to handle hard LPs
348  * - \ref SCIP_PARAMEMPHASIS_OPTIMALITY to prove optimality fast
349  * - \ref SCIP_PARAMEMPHASIS_PHASEFEAS to find feasible solutions during a 3 phase solution process
350  * - \ref SCIP_PARAMEMPHASIS_PHASEIMPROVE to find improved solutions during a 3 phase solution process
351  * - \ref SCIP_PARAMEMPHASIS_PHASEPROOF to proof optimality during a 3 phase solution process
352  */
353 extern
355  SCIP_PARAMSET* paramset, /**< parameter set */
356  SCIP_SET* set, /**< global SCIP settings */
357  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
358  SCIP_PARAMEMPHASIS paramemphasis, /**< parameter emphasis */
359  SCIP_Bool quiet /**< should the parameter be set quiet (no output) */
360  );
361 
362 /** sets parameters to deactivate separators and heuristics that use auxiliary SCIP instances; should be called for
363  * auxiliary SCIP instances to avoid recursion
364  */
365 extern
367  SCIP_PARAMSET* paramset, /**< parameter set */
368  SCIP_SET* set, /**< global SCIP settings */
369  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
370  SCIP_Bool quiet /**< should the parameter be set quiet (no output) */
371  );
372 
373 /** sets heuristic parameters values to
374  * - SCIP_PARAMSETTING_DEFAULT which are the default values of all heuristic parameters
375  * - SCIP_PARAMSETTING_FAST such that the time spend for heuristic is decreased
376  * - SCIP_PARAMSETTING_AGGRESSIVE such that the heuristic are called more aggregative
377  * - SCIP_PARAMSETTING_OFF which turn off all heuristics
378  */
379 extern
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 /** sets presolving parameters to
389  * - SCIP_PARAMSETTING_DEFAULT which are the default values of all presolving parameters
390  * - SCIP_PARAMSETTING_FAST such that the time spend for presolving is decreased
391  * - SCIP_PARAMSETTING_AGGRESSIVE such that the presolving is more aggregative
392  * - SCIP_PARAMSETTING_OFF which turn off all presolving
393  */
394 extern
396  SCIP_PARAMSET* paramset, /**< parameter set */
397  SCIP_SET* set, /**< global SCIP settings */
398  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
399  SCIP_PARAMSETTING paramsetting, /**< parameter settings */
400  SCIP_Bool quiet /**< should the parameter be set quiet (no output) */
401  );
402 
403 /** sets separating parameters to
404  * - SCIP_PARAMSETTING_DEFAULT which are the default values of all separating parameters
405  * - SCIP_PARAMSETTING_FAST such that the time spend for separating is decreased
406  * - SCIP_PARAMSETTING_AGGRESSIVE such that the separating is done more aggregative
407  * - SCIP_PARAMSETTING_OFF which turn off all separating
408  */
409 extern
411  SCIP_PARAMSET* paramset, /**< parameter set */
412  SCIP_SET* set, /**< global SCIP settings */
413  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
414  SCIP_PARAMSETTING paramsetting, /**< parameter settings */
415  SCIP_Bool quiet /**< should the parameter be set quiet (no output) */
416  );
417 
418 /** returns the array of parameters */
419 extern
421  SCIP_PARAMSET* paramset /**< parameter set */
422  );
423 
424 /** returns the number of parameters in the parameter set */
425 extern
427  SCIP_PARAMSET* paramset /**< parameter set */
428  );
429 
430 /** copies all parameter values of the source parameter set to the corresponding parameters in the target set */
431 extern
433  SCIP_PARAMSET* sourceparamset, /**< source parameter set */
434  SCIP_PARAMSET* targetparamset, /**< target parameter set */
435  SCIP_SET* set, /**< global SCIP settings of target SCIP */
436  SCIP_MESSAGEHDLR* messagehdlr /**< message handler of target SCIP */
437  );
438 
439 /** checks whether value of SCIP_Bool parameter is valid */
440 extern
442  SCIP_PARAM* param, /**< parameter */
443  SCIP_Bool value /**< value to check */
444  );
445 
446 /** checks whether value of integer parameter is valid */
447 extern
449  SCIP_PARAM* param, /**< parameter */
450  int value /**< value to check */
451  );
452 
453 /** checks whether value of SCIP_Longint parameter is valid */
454 extern
456  SCIP_PARAM* param, /**< parameter */
457  SCIP_Longint value /**< value to check */
458  );
459 
460 /** checks whether value of SCIP_Real parameter is valid */
461 extern
463  SCIP_PARAM* param, /**< parameter */
464  SCIP_Real value /**< value to check */
465  );
466 
467 /** checks whether value of char parameter is valid */
468 extern
470  SCIP_PARAM* param, /**< parameter */
471  const char value /**< value to check */
472  );
473 
474 /** checks whether value of string parameter is valid */
475 extern
477  SCIP_PARAM* param, /**< parameter */
478  const char* value /**< value to check */
479  );
480 
481 /** sets value of SCIP_Bool parameter */
482 extern
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  SCIP_Bool 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 int parameter */
493 extern
495  SCIP_PARAM* param, /**< parameter */
496  SCIP_SET* set, /**< global SCIP settings, or NULL if param change method should not be called */
497  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
498  int value, /**< new value of the parameter */
499  SCIP_Bool initialize, /**< is this the initialization of the parameter? */
500  SCIP_Bool quiet /**< should the parameter be set quiet (no output) */
501  );
502 
503 /** sets value of SCIP_Longint parameter */
504 extern
506  SCIP_PARAM* param, /**< parameter */
507  SCIP_SET* set, /**< global SCIP settings, or NULL if param change method should not be called */
508  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
509  SCIP_Longint value, /**< new value of the parameter */
510  SCIP_Bool initialize, /**< is this the initialization of the parameter? */
511  SCIP_Bool quiet /**< should the parameter be set quiet (no output) */
512  );
513 
514 /** sets value of SCIP_Real parameter */
515 extern
517  SCIP_PARAM* param, /**< parameter */
518  SCIP_SET* set, /**< global SCIP settings, or NULL if param change method should not be called */
519  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
520  SCIP_Real value, /**< new value of the parameter */
521  SCIP_Bool initialize, /**< is this the initialization of the parameter? */
522  SCIP_Bool quiet /**< should the parameter be set quiet (no output) */
523  );
524 
525 /** sets value of char parameter */
526 extern
528  SCIP_PARAM* param, /**< parameter */
529  SCIP_SET* set, /**< global SCIP settings, or NULL if param change method should not be called */
530  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
531  char value, /**< new value of the parameter */
532  SCIP_Bool initialize, /**< is this the initialization of the parameter? */
533  SCIP_Bool quiet /**< should the parameter be set quiet (no output) */
534  );
535 
536 /** sets value of string parameter */
537 extern
539  SCIP_PARAM* param, /**< parameter */
540  SCIP_SET* set, /**< global SCIP settings, or NULL if param change method should not be called */
541  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
542  const char* value, /**< new value of the parameter */
543  SCIP_Bool quiet /**< should the parameter be set quiet (no output) */
544  );
545 
546 /** sets default value of SCIP_Bool parameter */
547 extern
549  SCIP_PARAM* param, /**< parameter */
550  SCIP_Bool defaultvalue /**< new default value */
551  );
552 
553 /** sets default value of int parameter */
555  SCIP_PARAM* param, /**< parameter */
556  int defaultvalue /**< new default value */
557  );
558 
559 /** sets the parameter to its default setting */
560 extern
562  SCIP_PARAM* param, /**< parameter */
563  SCIP_SET* set, /**< global SCIP settings */
564  SCIP_MESSAGEHDLR* messagehdlr /**< message handler */
565  );
566 
567 /** writes a single parameter to a file */
568 extern
570  SCIP_PARAM* param, /**< parameter */
571  SCIP_MESSAGEHDLR* messagehdlr, /**< message handler */
572  const char* filename, /**< file name, or NULL for stdout */
573  SCIP_Bool comments, /**< should parameter descriptions be written as comments? */
574  SCIP_Bool onlychanged /**< should only the parameters been written, that are changed from default? */
575  );
576 
577 #ifdef __cplusplus
578 }
579 #endif
580 
581 #endif
SCIP_Bool SCIPparamIsValidInt(SCIP_PARAM *param, int value)
Definition: paramset.c:4251
SCIP_RETCODE SCIPparamsetWrite(SCIP_PARAMSET *paramset, SCIP_MESSAGEHDLR *messagehdlr, const char *filename, SCIP_Bool comments, SCIP_Bool onlychanged)
Definition: paramset.c:2599
SCIP_RETCODE SCIPparamsetFix(SCIP_PARAMSET *paramset, const char *name, SCIP_Bool fixed)
Definition: paramset.c:1898
SCIP_Bool SCIPparamIsValidLongint(SCIP_PARAM *param, SCIP_Longint value)
Definition: paramset.c:4262
struct SCIP_ParamData SCIP_PARAMDATA
Definition: type_paramset.h:76
SCIP_RETCODE SCIPparamsetSetToDefault(SCIP_PARAMSET *paramset, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, const char *paramname)
Definition: paramset.c:2700
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:1598
SCIP_RETCODE SCIPparamsetSetToDefaults(SCIP_PARAMSET *paramset, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr)
Definition: paramset.c:2682
void SCIPparamSetDefaultBool(SCIP_PARAM *param, SCIP_Bool defaultvalue)
Definition: paramset.c:4580
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:53
SCIP_RETCODE SCIPparamsetGetInt(SCIP_PARAMSET *paramset, const char *name, int *value)
Definition: paramset.c:1738
SCIP_RETCODE SCIPparamsetSetReal(SCIP_PARAMSET *paramset, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, const char *name, SCIP_Real value)
Definition: paramset.c:2148
SCIP_RETCODE SCIPparamsetSetToSubscipsOff(SCIP_PARAMSET *paramset, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, SCIP_Bool quiet)
Definition: paramset.c:3908
SCIP_RETCODE SCIPparamsetGetBool(SCIP_PARAMSET *paramset, const char *name, SCIP_Bool *value)
Definition: paramset.c:1706
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:4082
SCIP_RETCODE SCIPparamSetString(SCIP_PARAM *param, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, const char *value, SCIP_Bool quiet)
Definition: paramset.c:4538
SCIP_PARAM * SCIPparamsetGetParam(SCIP_PARAMSET *paramset, const char *name)
Definition: paramset.c:1694
SCIP_RETCODE SCIPparamsetCreate(SCIP_PARAMSET **paramset, BMS_BLKMEM *blkmem)
Definition: paramset.c:1408
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:4496
SCIP_RETCODE SCIPparamSetLongint(SCIP_PARAM *param, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, SCIP_Longint value, SCIP_Bool initialize, SCIP_Bool quiet)
Definition: paramset.c:4410
int SCIPparamsetGetNParams(SCIP_PARAMSET *paramset)
Definition: paramset.c:4123
#define SCIP_DECL_PARAMCHGD(x)
Definition: type_paramset.h:91
SCIP_RETCODE SCIPparamsetSetHeuristics(SCIP_PARAMSET *paramset, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, SCIP_PARAMSETTING paramsetting, SCIP_Bool quiet)
Definition: paramset.c:4010
SCIP_RETCODE SCIPparamsetGetLongint(SCIP_PARAMSET *paramset, const char *name, SCIP_Longint *value)
Definition: paramset.c:1770
SCIP_RETCODE SCIPparamSetBool(SCIP_PARAM *param, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, SCIP_Bool value, SCIP_Bool initialize, SCIP_Bool quiet)
Definition: paramset.c:4326
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:1627
SCIP_RETCODE SCIPparamSetInt(SCIP_PARAM *param, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, int value, SCIP_Bool initialize, SCIP_Bool quiet)
Definition: paramset.c:4368
SCIP_RETCODE SCIPparamsetSetInt(SCIP_PARAMSET *paramset, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, const char *name, int value)
Definition: paramset.c:2049
SCIP_Bool SCIPparamIsValidReal(SCIP_PARAM *param, SCIP_Real value)
Definition: paramset.c:4273
public data structures and miscellaneous methods
#define SCIP_Bool
Definition: def.h:69
SCIP_RETCODE SCIPparamsetSetDefaultBool(SCIP_PARAMSET *paramset, const char *name, SCIP_Bool defaultvalue)
Definition: paramset.c:2018
SCIP_RETCODE SCIPparamsetSetDefaultInt(SCIP_PARAMSET *paramset, const char *name, int defaultvalue)
Definition: paramset.c:2083
SCIP_RETCODE SCIPparamsetSetBool(SCIP_PARAMSET *paramset, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, const char *name, SCIP_Bool value)
Definition: paramset.c:1984
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:1508
SCIP_Bool SCIPparamIsValidBool(SCIP_PARAM *param, SCIP_Bool value)
Definition: paramset.c:4242
SCIP_RETCODE SCIPparamsetGetReal(SCIP_PARAMSET *paramset, const char *name, SCIP_Real *value)
Definition: paramset.c:1802
void SCIPparamsetFree(SCIP_PARAMSET **paramset, BMS_BLKMEM *blkmem)
Definition: paramset.c:1428
SCIP_RETCODE SCIPparamsetRead(SCIP_PARAMSET *paramset, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, const char *filename)
Definition: paramset.c:2549
SCIP_RETCODE SCIPparamsetGetString(SCIP_PARAMSET *paramset, const char *name, char **value)
Definition: paramset.c:1866
SCIP_RETCODE SCIPparamsetSetEmphasis(SCIP_PARAMSET *paramset, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, SCIP_PARAMEMPHASIS paramemphasis, SCIP_Bool quiet)
Definition: paramset.c:3690
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:1538
SCIP_RETCODE SCIPparamsetGetChar(SCIP_PARAMSET *paramset, const char *name, char *value)
Definition: paramset.c:1834
enum SCIP_ParamEmphasis SCIP_PARAMEMPHASIS
Definition: type_paramset.h:73
SCIP_RETCODE SCIPparamsetSetChar(SCIP_PARAMSET *paramset, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, const char *name, char value)
Definition: paramset.c:2182
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:1481
SCIP_RETCODE SCIPparamsetSetPresolving(SCIP_PARAMSET *paramset, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, SCIP_PARAMSETTING paramsetting, SCIP_Bool quiet)
Definition: paramset.c:4046
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:1568
SCIP_RETCODE SCIPparamsetCopyParams(SCIP_PARAMSET *sourceparamset, SCIP_PARAMSET *targetparamset, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr)
Definition: paramset.c:4137
SCIP_RETCODE SCIPparamsetSetString(SCIP_PARAMSET *paramset, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, const char *name, const char *value)
Definition: paramset.c:2216
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:2114
#define SCIP_Real
Definition: def.h:157
SCIP_RETCODE SCIPparamWrite(SCIP_PARAM *param, SCIP_MESSAGEHDLR *messagehdlr, const char *filename, SCIP_Bool comments, SCIP_Bool onlychanged)
Definition: paramset.c:4657
SCIP_Bool SCIPparamIsValidString(SCIP_PARAM *param, const char *value)
Definition: paramset.c:4310
#define SCIP_Longint
Definition: def.h:142
SCIP_RETCODE SCIPparamsetSet(SCIP_PARAMSET *paramset, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, const char *name, void *value)
Definition: paramset.c:1922
SCIP_Bool SCIPparamIsValidChar(SCIP_PARAM *param, const char value)
Definition: paramset.c:4284
common defines and data types used in all packages of SCIP
struct BMS_BlkMem BMS_BLKMEM
Definition: memory.h:426
SCIP_PARAM ** SCIPparamsetGetParams(SCIP_PARAMSET *paramset)
Definition: paramset.c:4113
SCIP_RETCODE SCIPparamSetToDefault(SCIP_PARAM *param, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr)
Definition: paramset.c:4606
SCIP_Bool SCIPparamsetIsFixed(SCIP_PARAMSET *paramset, const char *name)
Definition: paramset.c:1672
void SCIPparamSetDefaultInt(SCIP_PARAM *param, int defaultvalue)
Definition: paramset.c:4592
SCIP_RETCODE SCIPparamSetReal(SCIP_PARAM *param, SCIP_SET *set, SCIP_MESSAGEHDLR *messagehdlr, SCIP_Real value, SCIP_Bool initialize, SCIP_Bool quiet)
Definition: paramset.c:4452
memory allocation routines