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
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/* */
/* 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 pub_paramset.h
* @ingroup PUBLICCOREAPI
* @brief public methods for handling parameter settings
* @author Tobias Achterberg
*/
/*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
#ifndef __SCIP_PUB_PARAMSET_H__
#define __SCIP_PUB_PARAMSET_H__
#include "scip/def.h"
#include "scip/type_paramset.h"
#include "scip/type_scip.h"
#ifdef __cplusplus
extern "C" {
#endif
/** returns type of parameter */
SCIP_EXPORT
SCIP_PARAMTYPE SCIPparamGetType(
SCIP_PARAM* param /**< parameter */
);
/** returns name of parameter */
SCIP_EXPORT
const char* SCIPparamGetName(
SCIP_PARAM* param /**< parameter */
);
/** returns description of parameter */
SCIP_EXPORT
const char* SCIPparamGetDesc(
SCIP_PARAM* param /**< parameter */
);
/** returns locally defined parameter specific data */
SCIP_EXPORT
SCIP_PARAMDATA* SCIPparamGetData(
SCIP_PARAM* param /**< parameter */
);
/** returns whether parameter is advanced */
SCIP_EXPORT
SCIP_Bool SCIPparamIsAdvanced(
SCIP_PARAM* param /**< parameter */
);
/** returns whether parameter is fixed */
SCIP_EXPORT
SCIP_Bool SCIPparamIsFixed(
SCIP_PARAM* param /**< parameter */
);
/** sets fixing status of given parameter */
SCIP_EXPORT
void SCIPparamSetFixed(
SCIP_PARAM* param, /**< parameter */
SCIP_Bool fixed /**< new fixing status of the parameter */
);
/** returns value of SCIP_Bool parameter */
SCIP_EXPORT
SCIP_Bool SCIPparamGetBool(
SCIP_PARAM* param /**< parameter */
);
/** returns default value of SCIP_Bool parameter */
SCIP_EXPORT
SCIP_Bool SCIPparamGetBoolDefault(
SCIP_PARAM* param /**< parameter */
);
/** returns value of int parameter */
SCIP_EXPORT
int SCIPparamGetInt(
SCIP_PARAM* param /**< parameter */
);
/** returns minimal value of int parameter */
SCIP_EXPORT
int SCIPparamGetIntMin(
SCIP_PARAM* param /**< parameter */
);
/** returns maximal value of int parameter */
SCIP_EXPORT
int SCIPparamGetIntMax(
SCIP_PARAM* param /**< parameter */
);
/** returns default value of int parameter */
SCIP_EXPORT
int SCIPparamGetIntDefault(
SCIP_PARAM* param /**< parameter */
);
/** returns value of SCIP_Longint parameter */
SCIP_EXPORT
SCIP_Longint SCIPparamGetLongint(
SCIP_PARAM* param /**< parameter */
);
/** returns minimal value of longint parameter */
SCIP_EXPORT
SCIP_Longint SCIPparamGetLongintMin(
SCIP_PARAM* param /**< parameter */
);
/** returns maximal value of longint parameter */
SCIP_EXPORT
SCIP_Longint SCIPparamGetLongintMax(
SCIP_PARAM* param /**< parameter */
);
/** returns default value of SCIP_Longint parameter */
SCIP_EXPORT
SCIP_Longint SCIPparamGetLongintDefault(
SCIP_PARAM* param /**< parameter */
);
/** returns value of SCIP_Real parameter */
SCIP_EXPORT
SCIP_Real SCIPparamGetReal(
SCIP_PARAM* param /**< parameter */
);
/** returns minimal value of real parameter */
SCIP_EXPORT
SCIP_Real SCIPparamGetRealMin(
SCIP_PARAM* param /**< parameter */
);
/** returns maximal value of real parameter */
SCIP_EXPORT
SCIP_Real SCIPparamGetRealMax(
SCIP_PARAM* param /**< parameter */
);
/** returns default value of SCIP_Real parameter */
SCIP_EXPORT
SCIP_Real SCIPparamGetRealDefault(
SCIP_PARAM* param /**< parameter */
);
/** returns value of char parameter */
SCIP_EXPORT
char SCIPparamGetChar(
SCIP_PARAM* param /**< parameter */
);
/** returns allowed values of char parameter, or NULL if everything is allowed */
SCIP_EXPORT
char* SCIPparamGetCharAllowedValues(
SCIP_PARAM* param /**< parameter */
);
/** returns default value of char parameter */
SCIP_EXPORT
char SCIPparamGetCharDefault(
SCIP_PARAM* param /**< parameter */
);
/** returns value of string parameter */
SCIP_EXPORT
char* SCIPparamGetString(
SCIP_PARAM* param /**< parameter */
);
/** returns default value of String parameter */
SCIP_EXPORT
char* SCIPparamGetStringDefault(
SCIP_PARAM* param /**< parameter */
);
/** returns whether the parameter is on its default setting */
SCIP_EXPORT
SCIP_Bool SCIPparamIsDefault(
SCIP_PARAM* param /**< parameter */
);
#ifdef __cplusplus
}
#endif
#endif