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-2024 Zuse Institute Berlin (ZIB) */
7 /* */
8 /* Licensed under the Apache License, Version 2.0 (the "License"); */
9 /* you may not use this file except in compliance with the License. */
10 /* You may obtain a copy of the License at */
11 /* */
12 /* http://www.apache.org/licenses/LICENSE-2.0 */
13 /* */
14 /* Unless required by applicable law or agreed to in writing, software */
15 /* distributed under the License is distributed on an "AS IS" BASIS, */
16 /* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. */
17 /* See the License for the specific language governing permissions and */
18 /* limitations under the License. */
19 /* */
20 /* You should have received a copy of the Apache-2.0 license */
21 /* along with SCIP; see the file LICENSE. If not visit scipopt.org. */
22 /* */
23 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
24 
25 /**@file pub_paramset.h
26  * @ingroup PUBLICCOREAPI
27  * @brief public methods for handling parameter settings
28  * @author Tobias Achterberg
29  */
30 
31 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
32 
33 #ifndef __SCIP_PUB_PARAMSET_H__
34 #define __SCIP_PUB_PARAMSET_H__
35 
36 
37 #include "scip/def.h"
38 #include "scip/type_paramset.h"
39 #include "scip/type_scip.h"
40 
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44 
45 /** returns type of parameter */
46 SCIP_EXPORT
48  SCIP_PARAM* param /**< parameter */
49  );
50 
51 /** returns name of parameter */
52 SCIP_EXPORT
53 const char* SCIPparamGetName(
54  SCIP_PARAM* param /**< parameter */
55  );
56 
57 /** returns description of parameter */
58 SCIP_EXPORT
59 const char* SCIPparamGetDesc(
60  SCIP_PARAM* param /**< parameter */
61  );
62 
63 /** returns locally defined parameter specific data */
64 SCIP_EXPORT
66  SCIP_PARAM* param /**< parameter */
67  );
68 
69 /** returns whether parameter is advanced */
70 SCIP_EXPORT
72  SCIP_PARAM* param /**< parameter */
73  );
74 
75 /** returns whether parameter is fixed */
76 SCIP_EXPORT
78  SCIP_PARAM* param /**< parameter */
79  );
80 
81 /** sets fixing status of given parameter */
82 SCIP_EXPORT
84  SCIP_PARAM* param, /**< parameter */
85  SCIP_Bool fixed /**< new fixing status of the parameter */
86  );
87 
88 /** returns value of SCIP_Bool parameter */
89 SCIP_EXPORT
91  SCIP_PARAM* param /**< parameter */
92  );
93 
94 /** returns default value of SCIP_Bool parameter */
95 SCIP_EXPORT
97  SCIP_PARAM* param /**< parameter */
98  );
99 
100 /** returns value of int parameter */
101 SCIP_EXPORT
102 int SCIPparamGetInt(
103  SCIP_PARAM* param /**< parameter */
104  );
105 
106 /** returns minimal value of int parameter */
107 SCIP_EXPORT
109  SCIP_PARAM* param /**< parameter */
110  );
111 
112 /** returns maximal value of int parameter */
113 SCIP_EXPORT
115  SCIP_PARAM* param /**< parameter */
116  );
117 
118 /** returns default value of int parameter */
119 SCIP_EXPORT
121  SCIP_PARAM* param /**< parameter */
122  );
123 
124 /** returns value of SCIP_Longint parameter */
125 SCIP_EXPORT
127  SCIP_PARAM* param /**< parameter */
128  );
129 
130 /** returns minimal value of longint parameter */
131 SCIP_EXPORT
133  SCIP_PARAM* param /**< parameter */
134  );
135 
136 /** returns maximal value of longint parameter */
137 SCIP_EXPORT
139  SCIP_PARAM* param /**< parameter */
140  );
141 
142 /** returns default value of SCIP_Longint parameter */
143 SCIP_EXPORT
145  SCIP_PARAM* param /**< parameter */
146  );
147 
148 /** returns value of SCIP_Real parameter */
149 SCIP_EXPORT
151  SCIP_PARAM* param /**< parameter */
152  );
153 
154 /** returns minimal value of real parameter */
155 SCIP_EXPORT
157  SCIP_PARAM* param /**< parameter */
158  );
159 
160 /** returns maximal value of real parameter */
161 SCIP_EXPORT
163  SCIP_PARAM* param /**< parameter */
164  );
165 
166 /** returns default value of SCIP_Real parameter */
167 SCIP_EXPORT
169  SCIP_PARAM* param /**< parameter */
170  );
171 
172 /** returns value of char parameter */
173 SCIP_EXPORT
174 char SCIPparamGetChar(
175  SCIP_PARAM* param /**< parameter */
176  );
177 
178 /** returns allowed values of char parameter, or NULL if everything is allowed */
179 SCIP_EXPORT
181  SCIP_PARAM* param /**< parameter */
182  );
183 
184 /** returns default value of char parameter */
185 SCIP_EXPORT
187  SCIP_PARAM* param /**< parameter */
188  );
189 
190 /** returns value of string parameter */
191 SCIP_EXPORT
192 char* SCIPparamGetString(
193  SCIP_PARAM* param /**< parameter */
194  );
195 
196 /** returns default value of String parameter */
197 SCIP_EXPORT
199  SCIP_PARAM* param /**< parameter */
200  );
201 
202 /** returns whether the parameter is on its default setting */
203 SCIP_EXPORT
205  SCIP_PARAM* param /**< parameter */
206  );
207 
208 #ifdef __cplusplus
209 }
210 #endif
211 
212 #endif
enum SCIP_ParamType SCIP_PARAMTYPE
Definition: type_paramset.h:54
char SCIPparamGetChar(SCIP_PARAM *param)
Definition: paramset.c:875
char * SCIPparamGetStringDefault(SCIP_PARAM *param)
Definition: paramset.c:925
SCIP_Bool SCIPparamIsDefault(SCIP_PARAM *param)
Definition: paramset.c:936
SCIP_Real SCIPparamGetRealMax(SCIP_PARAM *param)
Definition: paramset.c:853
struct SCIP_ParamData SCIP_PARAMDATA
Definition: type_paramset.h:87
SCIP_Longint SCIPparamGetLongintMin(SCIP_PARAM *param)
Definition: paramset.c:795
int SCIPparamGetInt(SCIP_PARAM *param)
Definition: paramset.c:734
SCIP_Real SCIPparamGetRealDefault(SCIP_PARAM *param)
Definition: paramset.c:864
SCIP_Longint SCIPparamGetLongint(SCIP_PARAM *param)
Definition: paramset.c:781
SCIP_PARAMDATA * SCIPparamGetData(SCIP_PARAM *param)
Definition: paramset.c:679
char SCIPparamGetCharDefault(SCIP_PARAM *param)
Definition: paramset.c:900
type definitions for SCIP&#39;s main datastructure
SCIP_Longint SCIPparamGetLongintDefault(SCIP_PARAM *param)
Definition: paramset.c:817
SCIP_Bool SCIPparamIsFixed(SCIP_PARAM *param)
Definition: paramset.c:699
int SCIPparamGetIntDefault(SCIP_PARAM *param)
Definition: paramset.c:770
SCIP_Real SCIPparamGetRealMin(SCIP_PARAM *param)
Definition: paramset.c:842
void SCIPparamSetFixed(SCIP_PARAM *param, SCIP_Bool fixed)
Definition: paramset.c:4435
SCIP_Bool SCIPparamGetBool(SCIP_PARAM *param)
Definition: paramset.c:709
#define SCIP_Bool
Definition: def.h:91
SCIP_Longint SCIPparamGetLongintMax(SCIP_PARAM *param)
Definition: paramset.c:806
const char * SCIPparamGetDesc(SCIP_PARAM *param)
Definition: paramset.c:669
char * SCIPparamGetString(SCIP_PARAM *param)
Definition: paramset.c:911
const char * SCIPparamGetName(SCIP_PARAM *param)
Definition: paramset.c:659
type definitions for handling parameter settings
#define SCIP_Real
Definition: def.h:173
#define SCIP_Longint
Definition: def.h:158
char * SCIPparamGetCharAllowedValues(SCIP_PARAM *param)
Definition: paramset.c:889
SCIP_Bool SCIPparamIsAdvanced(SCIP_PARAM *param)
Definition: paramset.c:689
SCIP_PARAMTYPE SCIPparamGetType(SCIP_PARAM *param)
Definition: paramset.c:649
int SCIPparamGetIntMin(SCIP_PARAM *param)
Definition: paramset.c:748
common defines and data types used in all packages of SCIP
SCIP_Bool SCIPparamGetBoolDefault(SCIP_PARAM *param)
Definition: paramset.c:723
int SCIPparamGetIntMax(SCIP_PARAM *param)
Definition: paramset.c:759
SCIP_Real SCIPparamGetReal(SCIP_PARAM *param)
Definition: paramset.c:828