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