Scippy

SCIP

Solving Constraint Integer Programs

scip_param.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 scip_param.h
17  * @ingroup PUBLICCOREAPI
18  * @brief public methods for SCIP parameter handling
19  * @author Tobias Achterberg
20  * @author Timo Berthold
21  * @author Thorsten Koch
22  * @author Alexander Martin
23  * @author Marc Pfetsch
24  * @author Kati Wolter
25  * @author Gregor Hendel
26  * @author Robert Lion Gottwald
27  */
28 
29 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
30 
31 #ifndef __SCIP_SCIP_PARAM_H__
32 #define __SCIP_SCIP_PARAM_H__
33 
34 
35 #include "scip/def.h"
36 #include "scip/type_paramset.h"
37 #include "scip/type_retcode.h"
38 #include "scip/type_scip.h"
39 
40 /* In debug mode, we include the SCIP's structure in scip.c, such that no one can access
41  * this structure except the interface methods in scip.c.
42  * In optimized mode, the structure is included in scip.h, because some of the methods
43  * are implemented as defines for performance reasons (e.g. the numerical comparisons).
44  * Additionally, the internal "set.h" is included, such that the defines in set.h are
45  * available in optimized mode.
46  */
47 #ifdef NDEBUG
48 #include "scip/struct_scip.h"
49 #include "scip/struct_stat.h"
50 #include "scip/set.h"
51 #include "scip/tree.h"
52 #include "scip/misc.h"
53 #include "scip/var.h"
54 #include "scip/cons.h"
55 #include "scip/solve.h"
56 #include "scip/debug.h"
57 #endif
58 
59 #ifdef __cplusplus
60 extern "C" {
61 #endif
62 
63 /**@addtogroup ParameterMethods
64  *
65  * @{
66  */
67 
68 /** creates a SCIP_Bool parameter, sets it to its default value, and adds it to the parameter set
69  *
70  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
71  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
72  */
73 extern
75  SCIP* scip, /**< SCIP data structure */
76  const char* name, /**< name of the parameter */
77  const char* desc, /**< description of the parameter */
78  SCIP_Bool* valueptr, /**< pointer to store the current parameter value, or NULL */
79  SCIP_Bool isadvanced, /**< is this parameter an advanced parameter? */
80  SCIP_Bool defaultvalue, /**< default value of the parameter */
81  SCIP_DECL_PARAMCHGD ((*paramchgd)), /**< change information method of parameter */
82  SCIP_PARAMDATA* paramdata /**< locally defined parameter specific data */
83  );
84 
85 /** creates a int parameter, sets it to its default value, and adds it to the parameter set
86  *
87  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
88  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
89  */
90 extern
92  SCIP* scip, /**< SCIP data structure */
93  const char* name, /**< name of the parameter */
94  const char* desc, /**< description of the parameter */
95  int* valueptr, /**< pointer to store the current parameter value, or NULL */
96  SCIP_Bool isadvanced, /**< is this parameter an advanced parameter? */
97  int defaultvalue, /**< default value of the parameter */
98  int minvalue, /**< minimum value for parameter */
99  int maxvalue, /**< maximum value for parameter */
100  SCIP_DECL_PARAMCHGD ((*paramchgd)), /**< change information method of parameter */
101  SCIP_PARAMDATA* paramdata /**< locally defined parameter specific data */
102  );
103 
104 /** creates a SCIP_Longint parameter, sets it to its default value, and adds it to the parameter set
105  *
106  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
107  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
108  */
109 extern
111  SCIP* scip, /**< SCIP data structure */
112  const char* name, /**< name of the parameter */
113  const char* desc, /**< description of the parameter */
114  SCIP_Longint* valueptr, /**< pointer to store the current parameter value, or NULL */
115  SCIP_Bool isadvanced, /**< is this parameter an advanced parameter? */
116  SCIP_Longint defaultvalue, /**< default value of the parameter */
117  SCIP_Longint minvalue, /**< minimum value for parameter */
118  SCIP_Longint maxvalue, /**< maximum value for parameter */
119  SCIP_DECL_PARAMCHGD ((*paramchgd)), /**< change information method of parameter */
120  SCIP_PARAMDATA* paramdata /**< locally defined parameter specific data */
121  );
122 
123 /** creates a SCIP_Real parameter, sets it to its default value, and adds it to the parameter set
124  *
125  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
126  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
127  */
128 extern
130  SCIP* scip, /**< SCIP data structure */
131  const char* name, /**< name of the parameter */
132  const char* desc, /**< description of the parameter */
133  SCIP_Real* valueptr, /**< pointer to store the current parameter value, or NULL */
134  SCIP_Bool isadvanced, /**< is this parameter an advanced parameter? */
135  SCIP_Real defaultvalue, /**< default value of the parameter */
136  SCIP_Real minvalue, /**< minimum value for parameter */
137  SCIP_Real maxvalue, /**< maximum value for parameter */
138  SCIP_DECL_PARAMCHGD ((*paramchgd)), /**< change information method of parameter */
139  SCIP_PARAMDATA* paramdata /**< locally defined parameter specific data */
140  );
141 
142 /** creates a char parameter, sets it to its default value, and adds it to the parameter set
143  *
144  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
145  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
146  */
147 extern
149  SCIP* scip, /**< SCIP data structure */
150  const char* name, /**< name of the parameter */
151  const char* desc, /**< description of the parameter */
152  char* valueptr, /**< pointer to store the current parameter value, or NULL */
153  SCIP_Bool isadvanced, /**< is this parameter an advanced parameter? */
154  char defaultvalue, /**< default value of the parameter */
155  const char* allowedvalues, /**< array with possible parameter values, or NULL if not restricted */
156  SCIP_DECL_PARAMCHGD ((*paramchgd)), /**< change information method of parameter */
157  SCIP_PARAMDATA* paramdata /**< locally defined parameter specific data */
158  );
159 
160 /** creates a string(char*) parameter, sets it to its default value, and adds it to the parameter set
161  *
162  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
163  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
164  */
165 extern
167  SCIP* scip, /**< SCIP data structure */
168  const char* name, /**< name of the parameter */
169  const char* desc, /**< description of the parameter */
170  char** valueptr, /**< pointer to store the current parameter value, or NULL; if not NULL then *valueptr should be NULL */
171  SCIP_Bool isadvanced, /**< is this parameter an advanced parameter? */
172  const char* defaultvalue, /**< default value of the parameter */
173  SCIP_DECL_PARAMCHGD ((*paramchgd)), /**< change information method of parameter */
174  SCIP_PARAMDATA* paramdata /**< locally defined parameter specific data */
175  );
176 
177 /** gets the fixing status of an existing parameter
178  *
179  * @return TRUE if the parameter is fixed to a value, otherwise FALSE.
180  */
181 extern
183  SCIP* scip, /**< SCIP data structure */
184  const char* name /**< name of the parameter */
185  );
186 
187 /** returns the pointer to the SCIP parameter with the given name
188  *
189  * @return pointer to the parameter with the given name
190  */
191 extern
193  SCIP* scip, /**< SCIP data structure */
194  const char* name /**< name of the parameter */
195  );
196 
197 /** gets the value of an existing SCIP_Bool parameter
198  *
199  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
200  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
201  */
202 extern
204  SCIP* scip, /**< SCIP data structure */
205  const char* name, /**< name of the parameter */
206  SCIP_Bool* value /**< pointer to store the parameter */
207  );
208 
209 /** gets the value of an existing int parameter
210  *
211  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
212  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
213  */
214 extern
216  SCIP* scip, /**< SCIP data structure */
217  const char* name, /**< name of the parameter */
218  int* value /**< pointer to store the parameter */
219  );
220 
221 /** gets the value of an existing SCIP_Longint parameter
222  *
223  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
224  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
225  */
226 extern
228  SCIP* scip, /**< SCIP data structure */
229  const char* name, /**< name of the parameter */
230  SCIP_Longint* value /**< pointer to store the parameter */
231  );
232 
233 /** gets the value of an existing SCIP_Real parameter
234  *
235  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
236  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
237  */
238 extern
240  SCIP* scip, /**< SCIP data structure */
241  const char* name, /**< name of the parameter */
242  SCIP_Real* value /**< pointer to store the parameter */
243  );
244 
245 /** gets the value of an existing char parameter
246  *
247  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
248  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
249  */
250 extern
252  SCIP* scip, /**< SCIP data structure */
253  const char* name, /**< name of the parameter */
254  char* value /**< pointer to store the parameter */
255  );
256 
257 /** gets the value of an existing string(char*) parameter
258  *
259  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
260  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
261  */
262 extern
264  SCIP* scip, /**< SCIP data structure */
265  const char* name, /**< name of the parameter */
266  char** value /**< pointer to store the parameter */
267  );
268 
269 /** fixes the value of an existing parameter
270  *
271  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
272  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
273  *
274  * @note: Be careful with this method! Some general settings, e.g., the time or node limit, should not be fixed because
275  * they have to be changed for sub-SCIPs.
276  */
277 extern
279  SCIP* scip, /**< SCIP data structure */
280  const char* name /**< name of the parameter */
281  );
282 
283 /** unfixes the value of an existing parameter
284  *
285  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
286  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
287  */
288 extern
290  SCIP* scip, /**< SCIP data structure */
291  const char* name /**< name of the parameter */
292  );
293 
294 /** changes the value of an existing parameter
295  *
296  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
297  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
298  */
299 extern
301  SCIP* scip, /**< SCIP data structure */
302  const char* name, /**< name of the parameter */
303  void* value /**< new value of the parameter */
304  );
305 
306 /** changes the value of an existing SCIP_Bool parameter
307  *
308  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
309  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
310  */
311 extern
313  SCIP* scip, /**< SCIP data structure */
314  SCIP_PARAM* param, /**< parameter */
315  SCIP_Bool value /**< new value of the parameter */
316  );
317 
318 /** changes the value of an existing SCIP_Bool parameter
319  *
320  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
321  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
322  */
323 extern
325  SCIP* scip, /**< SCIP data structure */
326  const char* name, /**< name of the parameter */
327  SCIP_Bool value /**< new value of the parameter */
328  );
329 
330 /** checks whether the value of an existing SCIP_Bool parameter is valid */
331 extern
333  SCIP* scip, /**< SCIP data structure */
334  SCIP_PARAM* param, /**< parameter */
335  SCIP_Bool value /**< value to check */
336  );
337 
338 /** changes the value of an existing int parameter
339  *
340  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
341  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
342  */
343 extern
345  SCIP* scip, /**< SCIP data structure */
346  SCIP_PARAM* param, /**< parameter */
347  int value /**< new value of the parameter */
348  );
349 
350 /** changes the value of an existing int parameter
351  *
352  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
353  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
354  */
355 extern
357  SCIP* scip, /**< SCIP data structure */
358  const char* name, /**< name of the parameter */
359  int value /**< new value of the parameter */
360  );
361 
362 /** checks whether the value of an existing int parameter is valid */
363 extern
365  SCIP* scip, /**< SCIP data structure */
366  SCIP_PARAM* param, /**< parameter */
367  int value /**< value to check */
368  );
369 
370 /** changes the value of an existing SCIP_Longint parameter
371  *
372  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
373  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
374  */
375 extern
377  SCIP* scip, /**< SCIP data structure */
378  SCIP_PARAM* param, /**< parameter */
379  SCIP_Longint value /**< new value of the parameter */
380  );
381 
382 /** changes the value of an existing SCIP_Longint parameter
383  *
384  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
385  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
386  */
387 extern
389  SCIP* scip, /**< SCIP data structure */
390  const char* name, /**< name of the parameter */
391  SCIP_Longint value /**< new value of the parameter */
392  );
393 
394 /** checks whether parameter value of an existing SCIP_Longint paramter is valid */
395 extern
397  SCIP* scip, /**< SCIP data structure */
398  SCIP_PARAM* param, /**< parameter */
399  SCIP_Longint value /**< value to check */
400  );
401 
402 /** changes the value of an existing SCIP_Real parameter
403  *
404  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
405  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
406  */
407 extern
409  SCIP* scip, /**< SCIP data structure */
410  SCIP_PARAM* param, /**< parameter */
411  SCIP_Real value /**< new value of the parameter */
412  );
413 
414 /** changes the value of an existing SCIP_Real parameter
415  *
416  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
417  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
418  */
419 extern
421  SCIP* scip, /**< SCIP data structure */
422  const char* name, /**< name of the parameter */
423  SCIP_Real value /**< new value of the parameter */
424  );
425 
426 /** checks whether parameter value of an existing SCIP_Real paramter is valid */
427 extern
429  SCIP* scip, /**< SCIP data structure */
430  SCIP_PARAM* param, /**< parameter */
431  SCIP_Real value /**< value to check */
432  );
433 
434 /** changes the value of an existing char parameter
435  *
436  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
437  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
438  */
439 extern
441  SCIP* scip, /**< SCIP data structure */
442  SCIP_PARAM* param, /**< parameter */
443  char value /**< new value of the parameter */
444  );
445 
446 /** changes the value of an existing char parameter
447  *
448  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
449  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
450  */
451 extern
453  SCIP* scip, /**< SCIP data structure */
454  const char* name, /**< name of the parameter */
455  char value /**< new value of the parameter */
456  );
457 
458 /** checks whether parameter value for a given SCIP_Real parameter is valid */
459 extern
461  SCIP* scip, /**< SCIP data structure */
462  SCIP_PARAM* param, /**< parameter */
463  const char value /**< value to check */
464  );
465 
466 /** changes the value of an existing string(char*) parameter
467  *
468  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
469  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
470  */
471 extern
473  SCIP* scip, /**< SCIP data structure */
474  SCIP_PARAM* param, /**< parameter */
475  const char* value /**< new value of the parameter */
476  );
477 
478 /** changes the value of an existing string(char*) parameter
479  *
480  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
481  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
482  */
483 extern
485  SCIP* scip, /**< SCIP data structure */
486  const char* name, /**< name of the parameter */
487  const char* value /**< new value of the parameter */
488  );
489 
490 /** checks whether parameter value for a given string parameter is valid */
491 extern
493  SCIP* scip, /**< SCIP data structure */
494  SCIP_PARAM* param, /**< parameter */
495  const char* value /**< value to check */
496  );
497 
498 /** reads parameters from a file
499  *
500  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
501  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
502  */
503 extern
505  SCIP* scip, /**< SCIP data structure */
506  const char* filename /**< file name */
507  );
508 
509 /** writes a single parameter to a file
510  *
511  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
512  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
513  */
514 extern
516  SCIP* scip, /**< SCIP data structure */
517  SCIP_PARAM* param, /**< parameter */
518  const char* filename, /**< file name, or NULL for stdout */
519  SCIP_Bool comments, /**< should parameter descriptions be written as comments? */
520  SCIP_Bool onlychanged /**< should only those parameters be written that are changed from their
521  * default value?
522  */
523  );
524 
525 /** writes all parameters in the parameter set to a file
526  *
527  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
528  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
529  */
530 extern
532  SCIP* scip, /**< SCIP data structure */
533  const char* filename, /**< file name, or NULL for stdout */
534  SCIP_Bool comments, /**< should parameter descriptions be written as comments? */
535  SCIP_Bool onlychanged /**< should only those parameters be written that are changed from their
536  * default value?
537  */
538  );
539 
540 /** resets a single parameter to its default value
541  *
542  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
543  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
544  */
545 extern
547  SCIP* scip, /**< SCIP data structure */
548  const char* name /**< name of the parameter */
549  );
550 
551 /** resets all parameters to their default values
552  *
553  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
554  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
555  */
556 extern
558  SCIP* scip /**< SCIP data structure */
559  );
560 
561 /** sets parameters to
562  *
563  * - \ref SCIP_PARAMEMPHASIS_DEFAULT to use default values (see also SCIPresetParams())
564  * - \ref SCIP_PARAMEMPHASIS_COUNTER to get feasible and "fast" counting process
565  * - \ref SCIP_PARAMEMPHASIS_CPSOLVER to get CP like search (e.g. no LP relaxation)
566  * - \ref SCIP_PARAMEMPHASIS_EASYCIP to solve easy problems fast
567  * - \ref SCIP_PARAMEMPHASIS_FEASIBILITY to detect feasibility fast
568  * - \ref SCIP_PARAMEMPHASIS_HARDLP to be capable to handle hard LPs
569  * - \ref SCIP_PARAMEMPHASIS_OPTIMALITY to prove optimality fast
570  * - \ref SCIP_PARAMEMPHASIS_PHASEFEAS to find feasible solutions during a 3 phase solution process
571  * - \ref SCIP_PARAMEMPHASIS_PHASEIMPROVE to find improved solutions during a 3 phase solution process
572  * - \ref SCIP_PARAMEMPHASIS_PHASEPROOF to proof optimality during a 3 phase solution process
573  *
574  *
575  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
576  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
577  */
578 extern
580  SCIP* scip, /**< SCIP data structure */
581  SCIP_PARAMEMPHASIS paramemphasis, /**< parameter settings */
582  SCIP_Bool quiet /**< should the parameter be set quiet (no output) */
583  );
584 
585 /** sets parameters to deactivate separators and heuristics that use auxiliary SCIP instances; should be called for
586  * auxiliary SCIP instances to avoid recursion
587  *
588  * @note only deactivates plugins which could cause recursion, some plugins which use sub-SCIPs stay activated
589  *
590  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
591  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
592  */
593 extern
595  SCIP* scip, /**< (auxiliary) SCIP data structure */
596  SCIP_Bool quiet /**< should the parameter be set quiet (no output) */
597  );
598 
599 /** sets heuristic parameters values to
600  *
601  * - SCIP_PARAMSETTING_DEFAULT which are the default values of all heuristic parameters
602  * - SCIP_PARAMSETTING_FAST such that the time spend for heuristic is decreased
603  * - SCIP_PARAMSETTING_AGGRESSIVE such that the heuristic are called more aggregative
604  * - SCIP_PARAMSETTING_OFF which turn off all heuristics
605  *
606  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
607  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
608  */
609 extern
611  SCIP* scip, /**< SCIP data structure */
612  SCIP_PARAMSETTING paramsetting, /**< parameter settings */
613  SCIP_Bool quiet /**< should the parameter be set quiet (no output) */
614  );
615 
616 /** sets presolving parameters to
617  *
618  * - SCIP_PARAMSETTING_DEFAULT which are the default values of all presolving parameters
619  * - SCIP_PARAMSETTING_FAST such that the time spend for presolving is decreased
620  * - SCIP_PARAMSETTING_AGGRESSIVE such that the presolving is more aggregative
621  * - SCIP_PARAMSETTING_OFF which turn off all presolving
622  *
623  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
624  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
625  */
626 extern
628  SCIP* scip, /**< SCIP data structure */
629  SCIP_PARAMSETTING paramsetting, /**< parameter settings */
630  SCIP_Bool quiet /**< should the parameter be set quiet (no output) */
631  );
632 
633 /** sets separating parameters to
634  *
635  * - SCIP_PARAMSETTING_DEFAULT which are the default values of all separating parameters
636  * - SCIP_PARAMSETTING_FAST such that the time spend for separating is decreased
637  * - SCIP_PARAMSETTING_AGGRESSIVE such that the separating is done more aggregative
638  * - SCIP_PARAMSETTING_OFF which turn off all separating
639  *
640  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
641  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
642  */
643 extern
645  SCIP* scip, /**< SCIP data structure */
646  SCIP_PARAMSETTING paramsetting, /**< parameter settings */
647  SCIP_Bool quiet /**< should the parameter be set quiet (no output) */
648  );
649 
650 /** returns the array of all available SCIP parameters
651  *
652  * @return SCIP_PARAM* array, containing all SCIP parameters.
653  */
654 extern
656  SCIP* scip /**< SCIP data structure */
657  );
658 
659 /** returns the total number of all available SCIP parameters
660  *
661  * @return number of all SCIP parameters.
662  */
663 extern
664 int SCIPgetNParams(
665  SCIP* scip /**< SCIP data structure */
666  );
667 
668 /**@} */
669 
670 #ifdef __cplusplus
671 }
672 #endif
673 
674 #endif
SCIP_PARAM ** SCIPgetParams(SCIP *scip)
Definition: scip_param.c:1068
SCIP_RETCODE SCIPgetStringParam(SCIP *scip, const char *name, char **value)
Definition: scip_param.c:417
SCIP_RETCODE SCIPgetCharParam(SCIP *scip, const char *name, char *value)
Definition: scip_param.c:398
SCIP_RETCODE SCIPsetSeparating(SCIP *scip, SCIP_PARAMSETTING paramsetting, SCIP_Bool quiet)
Definition: scip_param.c:1048
internal methods for branch and bound tree
SCIP_RETCODE SCIPgetRealParam(SCIP *scip, const char *name, SCIP_Real *value)
Definition: scip_param.c:379
SCIP_RETCODE SCIPsetParam(SCIP *scip, const char *name, void *value)
Definition: scip_param.c:475
struct SCIP_ParamData SCIP_PARAMDATA
Definition: type_paramset.h:76
SCIP_Bool SCIPisStringParamValid(SCIP *scip, SCIP_PARAM *param, const char *value)
Definition: scip_param.c:825
SCIP_RETCODE SCIPsetHeuristics(SCIP *scip, SCIP_PARAMSETTING paramsetting, SCIP_Bool quiet)
Definition: scip_param.c:996
SCIP_RETCODE SCIPaddLongintParam(SCIP *scip, 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: scip_param.c:183
SCIP_Bool SCIPisIntParamValid(SCIP *scip, SCIP_PARAM *param, int value)
Definition: scip_param.c:593
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:53
SCIP_RETCODE SCIPsetPresolving(SCIP *scip, SCIP_PARAMSETTING paramsetting, SCIP_Bool quiet)
Definition: scip_param.c:1022
SCIP_RETCODE SCIPchgRealParam(SCIP *scip, SCIP_PARAM *param, SCIP_Real value)
Definition: scip_param.c:668
SCIP_RETCODE SCIPaddStringParam(SCIP *scip, const char *name, const char *desc, char **valueptr, SCIP_Bool isadvanced, const char *defaultvalue, SCIP_DECL_PARAMCHGD((*paramchgd)), SCIP_PARAMDATA *paramdata)
Definition: scip_param.c:266
type definitions for return codes for SCIP methods
SCIP_RETCODE SCIPwriteParam(SCIP *scip, SCIP_PARAM *param, const char *filename, SCIP_Bool comments, SCIP_Bool onlychanged)
Definition: scip_param.c:860
SCIP_RETCODE SCIPsetRealParam(SCIP *scip, const char *name, SCIP_Real value)
Definition: scip_param.c:694
SCIP_RETCODE SCIPchgStringParam(SCIP *scip, SCIP_PARAM *param, const char *value)
Definition: scip_param.c:784
SCIP_RETCODE SCIPaddIntParam(SCIP *scip, 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: scip_param.c:155
enum SCIP_ParamSetting SCIP_PARAMSETTING
Definition: type_paramset.h:56
SCIP_Bool SCIPisCharParamValid(SCIP *scip, SCIP_PARAM *param, const char value)
Definition: scip_param.c:767
SCIP_RETCODE SCIPresetParams(SCIP *scip)
Definition: scip_param.c:923
SCIP_Bool SCIPisBoolParamValid(SCIP *scip, SCIP_PARAM *param, SCIP_Bool value)
Definition: scip_param.c:535
SCIP_Bool SCIPisParamFixed(SCIP *scip, const char *name)
Definition: scip_param.c:291
SCIP_RETCODE SCIPchgCharParam(SCIP *scip, SCIP_PARAM *param, char value)
Definition: scip_param.c:726
type definitions for SCIP&#39;s main datastructure
SCIP_RETCODE SCIPsetBoolParam(SCIP *scip, const char *name, SCIP_Bool value)
Definition: scip_param.c:520
#define SCIP_DECL_PARAMCHGD(x)
Definition: type_paramset.h:91
SCIP_RETCODE SCIPgetBoolParam(SCIP *scip, const char *name, SCIP_Bool *value)
Definition: scip_param.c:322
internal miscellaneous methods
SCIP_RETCODE SCIPgetIntParam(SCIP *scip, const char *name, int *value)
Definition: scip_param.c:341
SCIP_RETCODE SCIPunfixParam(SCIP *scip, const char *name)
Definition: scip_param.c:457
SCIP_PARAM * SCIPgetParam(SCIP *scip, const char *name)
Definition: scip_param.c:306
internal methods for global SCIP settings
SCIP main data structure.
SCIP_RETCODE SCIPsetEmphasis(SCIP *scip, SCIP_PARAMEMPHASIS paramemphasis, SCIP_Bool quiet)
Definition: scip_param.c:951
SCIP_Bool SCIPisLongintParamValid(SCIP *scip, SCIP_PARAM *param, SCIP_Longint value)
Definition: scip_param.c:651
SCIP_RETCODE SCIPgetLongintParam(SCIP *scip, const char *name, SCIP_Longint *value)
Definition: scip_param.c:360
internal methods for problem variables
#define SCIP_Bool
Definition: def.h:69
SCIP_RETCODE SCIPchgLongintParam(SCIP *scip, SCIP_PARAM *param, SCIP_Longint value)
Definition: scip_param.c:610
methods for debugging
SCIP_RETCODE SCIPsetIntParam(SCIP *scip, const char *name, int value)
Definition: scip_param.c:578
SCIP_RETCODE SCIPsetStringParam(SCIP *scip, const char *name, const char *value)
Definition: scip_param.c:810
SCIP_RETCODE SCIPfixParam(SCIP *scip, const char *name)
Definition: scip_param.c:439
datastructures for problem statistics
SCIP_Bool SCIPisRealParamValid(SCIP *scip, SCIP_PARAM *param, SCIP_Real value)
Definition: scip_param.c:709
SCIP_RETCODE SCIPsetCharParam(SCIP *scip, const char *name, char value)
Definition: scip_param.c:752
enum SCIP_ParamEmphasis SCIP_PARAMEMPHASIS
Definition: type_paramset.h:73
SCIP_RETCODE SCIPaddCharParam(SCIP *scip, const char *name, const char *desc, char *valueptr, SCIP_Bool isadvanced, char defaultvalue, const char *allowedvalues, SCIP_DECL_PARAMCHGD((*paramchgd)), SCIP_PARAMDATA *paramdata)
Definition: scip_param.c:239
internal methods for main solving loop and node processing
SCIP_RETCODE SCIPreadParams(SCIP *scip, const char *filename)
Definition: scip_param.c:842
type definitions for handling parameter settings
#define SCIP_Real
Definition: def.h:157
internal methods for constraints and constraint handlers
#define SCIP_Longint
Definition: def.h:142
SCIP_RETCODE SCIPwriteParams(SCIP *scip, const char *filename, SCIP_Bool comments, SCIP_Bool onlychanged)
Definition: scip_param.c:883
common defines and data types used in all packages of SCIP
SCIP_RETCODE SCIPchgIntParam(SCIP *scip, SCIP_PARAM *param, int value)
Definition: scip_param.c:552
SCIP_RETCODE SCIPresetParam(SCIP *scip, const char *name)
Definition: scip_param.c:905
int SCIPgetNParams(SCIP *scip)
Definition: scip_param.c:1082
SCIP_RETCODE SCIPchgBoolParam(SCIP *scip, SCIP_PARAM *param, SCIP_Bool value)
Definition: scip_param.c:494
SCIP_RETCODE SCIPaddRealParam(SCIP *scip, 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: scip_param.c:211
SCIP_RETCODE SCIPsetSubscipsOff(SCIP *scip, SCIP_Bool quiet)
Definition: scip_param.c:973
SCIP_RETCODE SCIPsetLongintParam(SCIP *scip, const char *name, SCIP_Longint value)
Definition: scip_param.c:636
SCIP_RETCODE SCIPaddBoolParam(SCIP *scip, const char *name, const char *desc, SCIP_Bool *valueptr, SCIP_Bool isadvanced, SCIP_Bool defaultvalue, SCIP_DECL_PARAMCHGD((*paramchgd)), SCIP_PARAMDATA *paramdata)
Definition: scip_param.c:129