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-2020 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 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 Leona 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 #ifdef __cplusplus
41 extern "C" {
42 #endif
43 
44 /**@addtogroup ParameterMethods
45  *
46  * @{
47  */
48 
49 /** creates a SCIP_Bool parameter, sets it to its default value, and adds it to the parameter set
50  *
51  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
52  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
53  */
56  SCIP* scip, /**< SCIP data structure */
57  const char* name, /**< name of the parameter */
58  const char* desc, /**< description of the parameter */
59  SCIP_Bool* valueptr, /**< pointer to store the current parameter value, or NULL */
60  SCIP_Bool isadvanced, /**< is this parameter an advanced parameter? */
61  SCIP_Bool defaultvalue, /**< default value of the parameter */
62  SCIP_DECL_PARAMCHGD ((*paramchgd)), /**< change information method of parameter */
63  SCIP_PARAMDATA* paramdata /**< locally defined parameter specific data */
64  );
65 
66 /** creates a int parameter, sets it to its default value, and adds it to the parameter set
67  *
68  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
69  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
70  */
73  SCIP* scip, /**< SCIP data structure */
74  const char* name, /**< name of the parameter */
75  const char* desc, /**< description of the parameter */
76  int* valueptr, /**< pointer to store the current parameter value, or NULL */
77  SCIP_Bool isadvanced, /**< is this parameter an advanced parameter? */
78  int defaultvalue, /**< default value of the parameter */
79  int minvalue, /**< minimum value for parameter */
80  int maxvalue, /**< maximum value for 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 SCIP_Longint 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  */
92  SCIP* scip, /**< SCIP data structure */
93  const char* name, /**< name of the parameter */
94  const char* desc, /**< description of the parameter */
95  SCIP_Longint* valueptr, /**< pointer to store the current parameter value, or NULL */
96  SCIP_Bool isadvanced, /**< is this parameter an advanced parameter? */
97  SCIP_Longint defaultvalue, /**< default value of the parameter */
98  SCIP_Longint minvalue, /**< minimum value for parameter */
99  SCIP_Longint 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_Real 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  */
111  SCIP* scip, /**< SCIP data structure */
112  const char* name, /**< name of the parameter */
113  const char* desc, /**< description of the parameter */
114  SCIP_Real* valueptr, /**< pointer to store the current parameter value, or NULL */
115  SCIP_Bool isadvanced, /**< is this parameter an advanced parameter? */
116  SCIP_Real defaultvalue, /**< default value of the parameter */
117  SCIP_Real minvalue, /**< minimum value for parameter */
118  SCIP_Real 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 char 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  */
130  SCIP* scip, /**< SCIP data structure */
131  const char* name, /**< name of the parameter */
132  const char* desc, /**< description of the parameter */
133  char* valueptr, /**< pointer to store the current parameter value, or NULL */
134  SCIP_Bool isadvanced, /**< is this parameter an advanced parameter? */
135  char defaultvalue, /**< default value of the parameter */
136  const char* allowedvalues, /**< array with possible parameter values, or NULL if not restricted */
137  SCIP_DECL_PARAMCHGD ((*paramchgd)), /**< change information method of parameter */
138  SCIP_PARAMDATA* paramdata /**< locally defined parameter specific data */
139  );
140 
141 /** creates a string(char*) parameter, sets it to its default value, and adds it to the parameter set
142  *
143  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
144  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
145  */
148  SCIP* scip, /**< SCIP data structure */
149  const char* name, /**< name of the parameter */
150  const char* desc, /**< description of the parameter */
151  char** valueptr, /**< pointer to store the current parameter value, or NULL; if not NULL then *valueptr should be NULL */
152  SCIP_Bool isadvanced, /**< is this parameter an advanced parameter? */
153  const char* defaultvalue, /**< default value of the parameter */
154  SCIP_DECL_PARAMCHGD ((*paramchgd)), /**< change information method of parameter */
155  SCIP_PARAMDATA* paramdata /**< locally defined parameter specific data */
156  );
157 
158 /** gets the fixing status of an existing parameter
159  *
160  * @return TRUE if the parameter is fixed to a value, otherwise FALSE.
161  */
164  SCIP* scip, /**< SCIP data structure */
165  const char* name /**< name of the parameter */
166  );
167 
168 /** returns the pointer to the SCIP parameter with the given name
169  *
170  * @return pointer to the parameter with the given name
171  */
174  SCIP* scip, /**< SCIP data structure */
175  const char* name /**< name of the parameter */
176  );
177 
178 /** gets the value of an existing SCIP_Bool parameter
179  *
180  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
181  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
182  */
185  SCIP* scip, /**< SCIP data structure */
186  const char* name, /**< name of the parameter */
187  SCIP_Bool* value /**< pointer to store the parameter */
188  );
189 
190 /** gets the value of an existing int parameter
191  *
192  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
193  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
194  */
197  SCIP* scip, /**< SCIP data structure */
198  const char* name, /**< name of the parameter */
199  int* value /**< pointer to store the parameter */
200  );
201 
202 /** gets the value of an existing SCIP_Longint parameter
203  *
204  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
205  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
206  */
209  SCIP* scip, /**< SCIP data structure */
210  const char* name, /**< name of the parameter */
211  SCIP_Longint* value /**< pointer to store the parameter */
212  );
213 
214 /** gets the value of an existing SCIP_Real parameter
215  *
216  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
217  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
218  */
221  SCIP* scip, /**< SCIP data structure */
222  const char* name, /**< name of the parameter */
223  SCIP_Real* value /**< pointer to store the parameter */
224  );
225 
226 /** gets the value of an existing char parameter
227  *
228  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
229  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
230  */
233  SCIP* scip, /**< SCIP data structure */
234  const char* name, /**< name of the parameter */
235  char* value /**< pointer to store the parameter */
236  );
237 
238 /** gets the value of an existing string(char*) parameter
239  *
240  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
241  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
242  */
245  SCIP* scip, /**< SCIP data structure */
246  const char* name, /**< name of the parameter */
247  char** value /**< pointer to store the parameter */
248  );
249 
250 /** fixes the value of an existing parameter
251  *
252  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
253  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
254  *
255  * @note: Be careful with this method! Some general settings, e.g., the time or node limit, should not be fixed because
256  * they have to be changed for sub-SCIPs.
257  */
260  SCIP* scip, /**< SCIP data structure */
261  const char* name /**< name of the parameter */
262  );
263 
264 /** unfixes the value of an existing parameter
265  *
266  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
267  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
268  */
271  SCIP* scip, /**< SCIP data structure */
272  const char* name /**< name of the parameter */
273  );
274 
275 /** changes the value of an existing parameter
276  *
277  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
278  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
279  */
282  SCIP* scip, /**< SCIP data structure */
283  const char* name, /**< name of the parameter */
284  void* value /**< new value of the parameter */
285  );
286 
287 /** changes the value of an existing SCIP_Bool parameter
288  *
289  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
290  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
291  */
294  SCIP* scip, /**< SCIP data structure */
295  SCIP_PARAM* param, /**< parameter */
296  SCIP_Bool value /**< new value of the parameter */
297  );
298 
299 /** changes the value of an existing SCIP_Bool parameter
300  *
301  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
302  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
303  */
306  SCIP* scip, /**< SCIP data structure */
307  const char* name, /**< name of the parameter */
308  SCIP_Bool value /**< new value of the parameter */
309  );
310 
311 /** checks whether the value of an existing SCIP_Bool parameter is valid */
314  SCIP* scip, /**< SCIP data structure */
315  SCIP_PARAM* param, /**< parameter */
316  SCIP_Bool value /**< value to check */
317  );
318 
319 /** changes the value of an existing int parameter
320  *
321  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
322  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
323  */
326  SCIP* scip, /**< SCIP data structure */
327  SCIP_PARAM* param, /**< parameter */
328  int value /**< new value of the parameter */
329  );
330 
331 /** changes the value of an existing int parameter
332  *
333  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
334  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
335  */
338  SCIP* scip, /**< SCIP data structure */
339  const char* name, /**< name of the parameter */
340  int value /**< new value of the parameter */
341  );
342 
343 /** checks whether the value of an existing int parameter is valid */
346  SCIP* scip, /**< SCIP data structure */
347  SCIP_PARAM* param, /**< parameter */
348  int value /**< value to check */
349  );
350 
351 /** changes the value of an existing SCIP_Longint parameter
352  *
353  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
354  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
355  */
358  SCIP* scip, /**< SCIP data structure */
359  SCIP_PARAM* param, /**< parameter */
360  SCIP_Longint value /**< new value of the parameter */
361  );
362 
363 /** changes the value of an existing SCIP_Longint parameter
364  *
365  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
366  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
367  */
370  SCIP* scip, /**< SCIP data structure */
371  const char* name, /**< name of the parameter */
372  SCIP_Longint value /**< new value of the parameter */
373  );
374 
375 /** checks whether parameter value of an existing SCIP_Longint paramter is valid */
378  SCIP* scip, /**< SCIP data structure */
379  SCIP_PARAM* param, /**< parameter */
380  SCIP_Longint value /**< value to check */
381  );
382 
383 /** changes the value of an existing SCIP_Real parameter
384  *
385  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
386  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
387  */
390  SCIP* scip, /**< SCIP data structure */
391  SCIP_PARAM* param, /**< parameter */
392  SCIP_Real value /**< new value of the parameter */
393  );
394 
395 /** changes the value of an existing SCIP_Real parameter
396  *
397  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
398  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
399  */
402  SCIP* scip, /**< SCIP data structure */
403  const char* name, /**< name of the parameter */
404  SCIP_Real value /**< new value of the parameter */
405  );
406 
407 /** checks whether parameter value of an existing SCIP_Real paramter is valid */
410  SCIP* scip, /**< SCIP data structure */
411  SCIP_PARAM* param, /**< parameter */
412  SCIP_Real value /**< value to check */
413  );
414 
415 /** changes the value of an existing char parameter
416  *
417  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
418  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
419  */
422  SCIP* scip, /**< SCIP data structure */
423  SCIP_PARAM* param, /**< parameter */
424  char value /**< new value of the parameter */
425  );
426 
427 /** changes the value of an existing char parameter
428  *
429  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
430  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
431  */
434  SCIP* scip, /**< SCIP data structure */
435  const char* name, /**< name of the parameter */
436  char value /**< new value of the parameter */
437  );
438 
439 /** checks whether parameter value for a given SCIP_Real parameter is valid */
442  SCIP* scip, /**< SCIP data structure */
443  SCIP_PARAM* param, /**< parameter */
444  const char value /**< value to check */
445  );
446 
447 /** changes the value of an existing string(char*) parameter
448  *
449  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
450  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
451  */
454  SCIP* scip, /**< SCIP data structure */
455  SCIP_PARAM* param, /**< parameter */
456  const char* value /**< new value of the parameter */
457  );
458 
459 /** changes the value of an existing string(char*) parameter
460  *
461  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
462  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
463  */
466  SCIP* scip, /**< SCIP data structure */
467  const char* name, /**< name of the parameter */
468  const char* value /**< new value of the parameter */
469  );
470 
471 /** checks whether parameter value for a given string parameter is valid */
474  SCIP* scip, /**< SCIP data structure */
475  SCIP_PARAM* param, /**< parameter */
476  const char* value /**< value to check */
477  );
478 
479 /** reads parameters from a file
480  *
481  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
482  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
483  */
486  SCIP* scip, /**< SCIP data structure */
487  const char* filename /**< file name */
488  );
489 
490 /** writes a single parameter to a file
491  *
492  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
493  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
494  */
497  SCIP* scip, /**< SCIP data structure */
498  SCIP_PARAM* param, /**< parameter */
499  const char* filename, /**< file name, or NULL for stdout */
500  SCIP_Bool comments, /**< should parameter descriptions be written as comments? */
501  SCIP_Bool onlychanged /**< should only those parameters be written that are changed from their
502  * default value?
503  */
504  );
505 
506 /** writes all parameters in the parameter set to a file
507  *
508  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
509  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
510  */
513  SCIP* scip, /**< SCIP data structure */
514  const char* filename, /**< file name, or NULL for stdout */
515  SCIP_Bool comments, /**< should parameter descriptions be written as comments? */
516  SCIP_Bool onlychanged /**< should only those parameters be written that are changed from their
517  * default value?
518  */
519  );
520 
521 /** resets a single parameter to its default value
522  *
523  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
524  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
525  */
528  SCIP* scip, /**< SCIP data structure */
529  const char* name /**< name of the parameter */
530  );
531 
532 /** resets all parameters to their default values
533  *
534  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
535  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
536  */
539  SCIP* scip /**< SCIP data structure */
540  );
541 
542 /** sets parameters to
543  *
544  * - \ref SCIP_PARAMEMPHASIS_DEFAULT to use default values (see also SCIPresetParams())
545  * - \ref SCIP_PARAMEMPHASIS_COUNTER to get feasible and "fast" counting process
546  * - \ref SCIP_PARAMEMPHASIS_CPSOLVER to get CP like search (e.g. no LP relaxation)
547  * - \ref SCIP_PARAMEMPHASIS_EASYCIP to solve easy problems fast
548  * - \ref SCIP_PARAMEMPHASIS_FEASIBILITY to detect feasibility fast
549  * - \ref SCIP_PARAMEMPHASIS_HARDLP to be capable to handle hard LPs
550  * - \ref SCIP_PARAMEMPHASIS_OPTIMALITY to prove optimality fast
551  * - \ref SCIP_PARAMEMPHASIS_PHASEFEAS to find feasible solutions during a 3 phase solution process
552  * - \ref SCIP_PARAMEMPHASIS_PHASEIMPROVE to find improved solutions during a 3 phase solution process
553  * - \ref SCIP_PARAMEMPHASIS_PHASEPROOF to proof optimality during a 3 phase solution process
554  * - \ref SCIP_PARAMEMPHASIS_NUMERICS to solve problems which cause numerical issues
555  *
556  *
557  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
558  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
559  */
562  SCIP* scip, /**< SCIP data structure */
563  SCIP_PARAMEMPHASIS paramemphasis, /**< parameter settings */
564  SCIP_Bool quiet /**< should the parameter be set quiet (no output) */
565  );
566 
567 /** sets parameters to deactivate separators and heuristics that use auxiliary SCIP instances; should be called for
568  * auxiliary SCIP instances to avoid recursion
569  *
570  * @note only deactivates plugins which could cause recursion, some plugins which use sub-SCIPs stay activated
571  *
572  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
573  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
574  */
577  SCIP* scip, /**< (auxiliary) SCIP data structure */
578  SCIP_Bool quiet /**< should the parameter be set quiet (no output) */
579  );
580 
581 /** sets heuristic parameters values to
582  *
583  * - SCIP_PARAMSETTING_DEFAULT which are the default values of all heuristic parameters
584  * - SCIP_PARAMSETTING_FAST such that the time spend for heuristic is decreased
585  * - SCIP_PARAMSETTING_AGGRESSIVE such that the heuristic are called more aggregative
586  * - SCIP_PARAMSETTING_OFF which turn off all heuristics
587  *
588  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
589  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
590  */
593  SCIP* scip, /**< SCIP data structure */
594  SCIP_PARAMSETTING paramsetting, /**< parameter settings */
595  SCIP_Bool quiet /**< should the parameter be set quiet (no output) */
596  );
597 
598 /** sets presolving parameters to
599  *
600  * - SCIP_PARAMSETTING_DEFAULT which are the default values of all presolving parameters
601  * - SCIP_PARAMSETTING_FAST such that the time spend for presolving is decreased
602  * - SCIP_PARAMSETTING_AGGRESSIVE such that the presolving is more aggregative
603  * - SCIP_PARAMSETTING_OFF which turn off all presolving
604  *
605  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
606  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
607  */
610  SCIP* scip, /**< SCIP data structure */
611  SCIP_PARAMSETTING paramsetting, /**< parameter settings */
612  SCIP_Bool quiet /**< should the parameter be set quiet (no output) */
613  );
614 
615 /** sets separating parameters to
616  *
617  * - SCIP_PARAMSETTING_DEFAULT which are the default values of all separating parameters
618  * - SCIP_PARAMSETTING_FAST such that the time spend for separating is decreased
619  * - SCIP_PARAMSETTING_AGGRESSIVE such that the separating is done more aggregative
620  * - SCIP_PARAMSETTING_OFF which turn off all separating
621  *
622  * @return \ref SCIP_OKAY is returned if everything worked. Otherwise a suitable error code is passed. See \ref
623  * SCIP_Retcode "SCIP_RETCODE" for a complete list of error codes.
624  */
627  SCIP* scip, /**< SCIP data structure */
628  SCIP_PARAMSETTING paramsetting, /**< parameter settings */
629  SCIP_Bool quiet /**< should the parameter be set quiet (no output) */
630  );
631 
632 /** returns the array of all available SCIP parameters
633  *
634  * @return SCIP_PARAM* array, containing all SCIP parameters.
635  */
638  SCIP* scip /**< SCIP data structure */
639  );
640 
641 /** returns the total number of all available SCIP parameters
642  *
643  * @return number of all SCIP parameters.
644  */
646 int SCIPgetNParams(
647  SCIP* scip /**< SCIP data structure */
648  );
649 
650 /** returns whether plugins with sub-SCIPs that could cause recursion have been disabled
651  *
652  * @return the value of the variable set->subscipsoff
653  */
656  SCIP* scip /**< SCIP data structure */
657  );
658 
659 /**@} */
660 
661 #ifdef __cplusplus
662 }
663 #endif
664 
665 #endif
SCIP_EXPORT SCIP_RETCODE SCIPgetStringParam(SCIP *scip, const char *name, char **value)
Definition: scip_param.c:336
struct SCIP_ParamData SCIP_PARAMDATA
Definition: type_paramset.h:77
#define SCIP_EXPORT
Definition: def.h:100
SCIP_EXPORT SCIP_RETCODE SCIPgetBoolParam(SCIP *scip, const char *name, SCIP_Bool *value)
Definition: scip_param.c:241
SCIP_EXPORT SCIP_RETCODE SCIPchgIntParam(SCIP *scip, SCIP_PARAM *param, int value)
Definition: scip_param.c:471
SCIP_EXPORT SCIP_PARAM * SCIPgetParam(SCIP *scip, const char *name)
Definition: scip_param.c:225
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:54
SCIP_EXPORT SCIP_RETCODE SCIPsetHeuristics(SCIP *scip, SCIP_PARAMSETTING paramsetting, SCIP_Bool quiet)
Definition: scip_param.c:916
SCIP_EXPORT 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:48
type definitions for return codes for SCIP methods
SCIP_EXPORT SCIP_RETCODE SCIPsetSubscipsOff(SCIP *scip, SCIP_Bool quiet)
Definition: scip_param.c:893
SCIP_EXPORT SCIP_Bool SCIPisBoolParamValid(SCIP *scip, SCIP_PARAM *param, SCIP_Bool value)
Definition: scip_param.c:454
SCIP_EXPORT SCIP_RETCODE SCIPgetCharParam(SCIP *scip, const char *name, char *value)
Definition: scip_param.c:317
enum SCIP_ParamSetting SCIP_PARAMSETTING
Definition: type_paramset.h:56
SCIP_EXPORT SCIP_PARAM ** SCIPgetParams(SCIP *scip)
Definition: scip_param.c:988
SCIP_EXPORT SCIP_Bool SCIPisIntParamValid(SCIP *scip, SCIP_PARAM *param, int value)
Definition: scip_param.c:512
SCIP_EXPORT SCIP_RETCODE SCIPsetRealParam(SCIP *scip, const char *name, SCIP_Real value)
Definition: scip_param.c:613
SCIP_EXPORT SCIP_RETCODE SCIPchgBoolParam(SCIP *scip, SCIP_PARAM *param, SCIP_Bool value)
Definition: scip_param.c:413
SCIP_EXPORT SCIP_RETCODE SCIPfixParam(SCIP *scip, const char *name)
Definition: scip_param.c:358
SCIP_EXPORT SCIP_Bool SCIPisCharParamValid(SCIP *scip, SCIP_PARAM *param, const char value)
Definition: scip_param.c:686
type definitions for SCIP&#39;s main datastructure
SCIP_EXPORT SCIP_RETCODE SCIPresetParams(SCIP *scip)
Definition: scip_param.c:842
#define SCIP_DECL_PARAMCHGD(x)
Definition: type_paramset.h:92
SCIP_EXPORT SCIP_RETCODE SCIPwriteParams(SCIP *scip, const char *filename, SCIP_Bool comments, SCIP_Bool onlychanged)
Definition: scip_param.c:802
SCIP_EXPORT SCIP_RETCODE SCIPsetPresolving(SCIP *scip, SCIP_PARAMSETTING paramsetting, SCIP_Bool quiet)
Definition: scip_param.c:942
SCIP_EXPORT SCIP_RETCODE SCIPsetCharParam(SCIP *scip, const char *name, char value)
Definition: scip_param.c:671
SCIP_EXPORT 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:185
SCIP_EXPORT SCIP_RETCODE SCIPgetIntParam(SCIP *scip, const char *name, int *value)
Definition: scip_param.c:260
SCIP_EXPORT SCIP_RETCODE SCIPgetRealParam(SCIP *scip, const char *name, SCIP_Real *value)
Definition: scip_param.c:298
SCIP_EXPORT SCIP_RETCODE SCIPunfixParam(SCIP *scip, const char *name)
Definition: scip_param.c:376
SCIP_EXPORT SCIP_RETCODE SCIPsetParam(SCIP *scip, const char *name, void *value)
Definition: scip_param.c:394
#define SCIP_Bool
Definition: def.h:70
SCIP_EXPORT SCIP_Bool SCIPisRealParamValid(SCIP *scip, SCIP_PARAM *param, SCIP_Real value)
Definition: scip_param.c:628
SCIP_EXPORT SCIP_RETCODE SCIPchgCharParam(SCIP *scip, SCIP_PARAM *param, char value)
Definition: scip_param.c:645
SCIP_EXPORT SCIP_Bool SCIPisParamFixed(SCIP *scip, const char *name)
Definition: scip_param.c:210
SCIP_EXPORT SCIP_RETCODE SCIPsetEmphasis(SCIP *scip, SCIP_PARAMEMPHASIS paramemphasis, SCIP_Bool quiet)
Definition: scip_param.c:871
SCIP_EXPORT int SCIPgetNParams(SCIP *scip)
Definition: scip_param.c:1002
SCIP_EXPORT 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:130
enum SCIP_ParamEmphasis SCIP_PARAMEMPHASIS
Definition: type_paramset.h:74
SCIP_EXPORT SCIP_RETCODE SCIPsetLongintParam(SCIP *scip, const char *name, SCIP_Longint value)
Definition: scip_param.c:555
SCIP_EXPORT SCIP_RETCODE SCIPchgStringParam(SCIP *scip, SCIP_PARAM *param, const char *value)
Definition: scip_param.c:703
SCIP_EXPORT SCIP_RETCODE SCIPsetStringParam(SCIP *scip, const char *name, const char *value)
Definition: scip_param.c:729
SCIP_EXPORT SCIP_Bool SCIPisLongintParamValid(SCIP *scip, SCIP_PARAM *param, SCIP_Longint value)
Definition: scip_param.c:570
SCIP_EXPORT SCIP_RETCODE SCIPresetParam(SCIP *scip, const char *name)
Definition: scip_param.c:824
SCIP_EXPORT SCIP_RETCODE SCIPreadParams(SCIP *scip, const char *filename)
Definition: scip_param.c:761
SCIP_EXPORT SCIP_Bool SCIPisStringParamValid(SCIP *scip, SCIP_PARAM *param, const char *value)
Definition: scip_param.c:744
SCIP_EXPORT SCIP_Bool SCIPgetSubscipsOff(SCIP *scip)
Definition: scip_param.c:1016
SCIP_EXPORT 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:74
type definitions for handling parameter settings
SCIP_EXPORT SCIP_RETCODE SCIPchgRealParam(SCIP *scip, SCIP_PARAM *param, SCIP_Real value)
Definition: scip_param.c:587
#define SCIP_Real
Definition: def.h:163
SCIP_EXPORT SCIP_RETCODE SCIPgetLongintParam(SCIP *scip, const char *name, SCIP_Longint *value)
Definition: scip_param.c:279
#define SCIP_Longint
Definition: def.h:148
SCIP_EXPORT SCIP_RETCODE SCIPsetBoolParam(SCIP *scip, const char *name, SCIP_Bool value)
Definition: scip_param.c:439
SCIP_EXPORT 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:102
common defines and data types used in all packages of SCIP
SCIP_EXPORT SCIP_RETCODE SCIPchgLongintParam(SCIP *scip, SCIP_PARAM *param, SCIP_Longint value)
Definition: scip_param.c:529
SCIP_EXPORT SCIP_RETCODE SCIPwriteParam(SCIP *scip, SCIP_PARAM *param, const char *filename, SCIP_Bool comments, SCIP_Bool onlychanged)
Definition: scip_param.c:779
SCIP_EXPORT 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:158
SCIP_EXPORT SCIP_RETCODE SCIPsetIntParam(SCIP *scip, const char *name, int value)
Definition: scip_param.c:497
SCIP_EXPORT SCIP_RETCODE SCIPsetSeparating(SCIP *scip, SCIP_PARAMSETTING paramsetting, SCIP_Bool quiet)
Definition: scip_param.c:968