Scippy

SCIP

Solving Constraint Integer Programs

pub_paramset.h
Go to the documentation of this file.
1 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2 /* */
3 /* This file is part of the program and library */
4 /* SCIP --- Solving Constraint Integer Programs */
5 /* */
6 /* Copyright (C) 2002-2018 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 pub_paramset.h
17  * @ingroup PUBLICCOREAPI
18  * @brief public methods for handling parameter settings
19  * @author Tobias Achterberg
20  */
21 
22 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
23 
24 #ifndef __SCIP_PUB_PARAMSET_H__
25 #define __SCIP_PUB_PARAMSET_H__
26 
27 
28 #include "scip/def.h"
29 #include "scip/type_paramset.h"
30 #include "scip/type_scip.h"
31 
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35 
36 /** returns type of parameter */
37 extern
39  SCIP_PARAM* param /**< parameter */
40  );
41 
42 /** returns name of parameter */
43 extern
44 const char* SCIPparamGetName(
45  SCIP_PARAM* param /**< parameter */
46  );
47 
48 /** returns description of parameter */
49 extern
50 const char* SCIPparamGetDesc(
51  SCIP_PARAM* param /**< parameter */
52  );
53 
54 /** returns locally defined parameter specific data */
55 extern
57  SCIP_PARAM* param /**< parameter */
58  );
59 
60 /** returns whether parameter is advanced */
61 extern
63  SCIP_PARAM* param /**< parameter */
64  );
65 
66 /** returns whether parameter is fixed */
67 extern
69  SCIP_PARAM* param /**< parameter */
70  );
71 
72 /** sets fixing status of given parameter */
73 extern
75  SCIP_PARAM* param, /**< parameter */
76  SCIP_Bool fixed /**< new fixing status of the parameter */
77  );
78 
79 /** returns value of SCIP_Bool parameter */
80 extern
82  SCIP_PARAM* param /**< parameter */
83  );
84 
85 /** returns default value of SCIP_Bool parameter */
86 extern
88  SCIP_PARAM* param /**< parameter */
89  );
90 
91 /** returns value of int parameter */
92 extern
93 int SCIPparamGetInt(
94  SCIP_PARAM* param /**< parameter */
95  );
96 
97 /** returns minimal value of int parameter */
98 extern
100  SCIP_PARAM* param /**< parameter */
101  );
102 
103 /** returns maximal value of int parameter */
104 extern
106  SCIP_PARAM* param /**< parameter */
107  );
108 
109 /** returns default value of int parameter */
110 extern
112  SCIP_PARAM* param /**< parameter */
113  );
114 
115 /** returns value of SCIP_Longint parameter */
116 extern
118  SCIP_PARAM* param /**< parameter */
119  );
120 
121 /** returns minimal value of longint parameter */
122 extern
124  SCIP_PARAM* param /**< parameter */
125  );
126 
127 /** returns maximal value of longint parameter */
128 extern
130  SCIP_PARAM* param /**< parameter */
131  );
132 
133 /** returns default value of SCIP_Longint parameter */
134 extern
136  SCIP_PARAM* param /**< parameter */
137  );
138 
139 /** returns value of SCIP_Real parameter */
140 extern
142  SCIP_PARAM* param /**< parameter */
143  );
144 
145 /** returns minimal value of real parameter */
146 extern
148  SCIP_PARAM* param /**< parameter */
149  );
150 
151 /** returns maximal value of real parameter */
152 extern
154  SCIP_PARAM* param /**< parameter */
155  );
156 
157 /** returns default value of SCIP_Real parameter */
158 extern
160  SCIP_PARAM* param /**< parameter */
161  );
162 
163 /** returns value of char parameter */
164 extern
165 char SCIPparamGetChar(
166  SCIP_PARAM* param /**< parameter */
167  );
168 
169 /** returns allowed values of char parameter, or NULL if everything is allowed */
170 extern
172  SCIP_PARAM* param /**< parameter */
173  );
174 
175 /** returns default value of char parameter */
176 extern
178  SCIP_PARAM* param /**< parameter */
179  );
180 
181 /** returns value of string parameter */
182 extern
183 char* SCIPparamGetString(
184  SCIP_PARAM* param /**< parameter */
185  );
186 
187 /** returns default value of String parameter */
188 extern
190  SCIP_PARAM* param /**< parameter */
191  );
192 
193 /** returns whether the parameter is on its default setting */
194 extern
196  SCIP_PARAM* param /**< parameter */
197  );
198 
199 #ifdef __cplusplus
200 }
201 #endif
202 
203 #endif
enum SCIP_ParamType SCIP_PARAMTYPE
Definition: type_paramset.h:45
char SCIPparamGetChar(SCIP_PARAM *param)
Definition: paramset.c:857
char * SCIPparamGetStringDefault(SCIP_PARAM *param)
Definition: paramset.c:907
SCIP_Bool SCIPparamIsDefault(SCIP_PARAM *param)
Definition: paramset.c:918
SCIP_Real SCIPparamGetRealMax(SCIP_PARAM *param)
Definition: paramset.c:835
struct SCIP_ParamData SCIP_PARAMDATA
Definition: type_paramset.h:76
SCIP_Longint SCIPparamGetLongintMin(SCIP_PARAM *param)
Definition: paramset.c:777
int SCIPparamGetInt(SCIP_PARAM *param)
Definition: paramset.c:716
SCIP_Real SCIPparamGetRealDefault(SCIP_PARAM *param)
Definition: paramset.c:846
SCIP_Longint SCIPparamGetLongint(SCIP_PARAM *param)
Definition: paramset.c:763
SCIP_PARAMDATA * SCIPparamGetData(SCIP_PARAM *param)
Definition: paramset.c:661
char SCIPparamGetCharDefault(SCIP_PARAM *param)
Definition: paramset.c:882
type definitions for SCIP&#39;s main datastructure
SCIP_Longint SCIPparamGetLongintDefault(SCIP_PARAM *param)
Definition: paramset.c:799
SCIP_Bool SCIPparamIsFixed(SCIP_PARAM *param)
Definition: paramset.c:681
int SCIPparamGetIntDefault(SCIP_PARAM *param)
Definition: paramset.c:752
SCIP_Real SCIPparamGetRealMin(SCIP_PARAM *param)
Definition: paramset.c:824
void SCIPparamSetFixed(SCIP_PARAM *param, SCIP_Bool fixed)
Definition: paramset.c:4227
SCIP_Bool SCIPparamGetBool(SCIP_PARAM *param)
Definition: paramset.c:691
#define SCIP_Bool
Definition: def.h:62
SCIP_Longint SCIPparamGetLongintMax(SCIP_PARAM *param)
Definition: paramset.c:788
const char * SCIPparamGetDesc(SCIP_PARAM *param)
Definition: paramset.c:651
char * SCIPparamGetString(SCIP_PARAM *param)
Definition: paramset.c:893
const char * SCIPparamGetName(SCIP_PARAM *param)
Definition: paramset.c:641
type definitions for handling parameter settings
#define SCIP_Real
Definition: def.h:150
#define SCIP_Longint
Definition: def.h:135
char * SCIPparamGetCharAllowedValues(SCIP_PARAM *param)
Definition: paramset.c:871
SCIP_Bool SCIPparamIsAdvanced(SCIP_PARAM *param)
Definition: paramset.c:671
SCIP_PARAMTYPE SCIPparamGetType(SCIP_PARAM *param)
Definition: paramset.c:631
int SCIPparamGetIntMin(SCIP_PARAM *param)
Definition: paramset.c:730
common defines and data types used in all packages of SCIP
SCIP_Bool SCIPparamGetBoolDefault(SCIP_PARAM *param)
Definition: paramset.c:705
int SCIPparamGetIntMax(SCIP_PARAM *param)
Definition: paramset.c:741
SCIP_Real SCIPparamGetReal(SCIP_PARAM *param)
Definition: paramset.c:810