SCIP Doxygen Documentation
Loading...
Searching...
No Matches
def.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-2025 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 def.h
26 * @ingroup INTERNALAPI
27 * @brief common defines and data types used in all packages of SCIP
28 * @author Tobias Achterberg
29 */
30
31/*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
32
33#ifndef __SCIP_DEF_H__
34#define __SCIP_DEF_H__
35
36#ifdef __cplusplus
37#define __STDC_LIMIT_MACROS
38#define __STDC_CONSTANT_MACROS
39#endif
40
41#include <stdio.h>
42#include <stdint.h>
43#include <math.h>
44#include <limits.h>
45#include <float.h>
46#include <assert.h>
47
48/*
49 * include build configuration flags
50 */
51#include "scip/config.h"
52#include "scip/scip_export.h"
53
54/*
55 * GNU COMPILER VERSION define
56 */
57#ifdef __GNUC__
58#ifndef GCC_VERSION
59#define GCC_VERSION (__GNUC__ * 100 \
60 + __GNUC_MINOR__ * 10 \
61 + __GNUC_PATCHLEVEL__)
62#endif
63#endif
64
65/*
66 * define whether compiler allows variadic macros
67 * __STDC_VERSION__ only exists for C code
68 * added the extra check using the GCC_VERSION to enable variadic macros also with C++ code with GCC atleast
69 *
70 */
71#if defined(_MSC_VER) || ( __STDC_VERSION__ >= 199901L ) || ( GCC_VERSION >= 480 )
72#define SCIP_HAVE_VARIADIC_MACROS 1
73#endif
74
75/** get the first parameter and all-but-the-first arguments from variadic arguments
76 *
77 * normally, SCIP_VARARGS_FIRST_ should be sufficient
78 * the SCIP_VARARGS_FIRST_/SCIP_VARARGS_FIRST kludge is to work around a bug in MSVC (https://stackoverflow.com/questions/4750688/how-to-single-out-the-first-parameter-sent-to-a-macro-taking-only-a-variadic-par)
79 */
80#define SCIP_VARARGS_FIRST_(firstarg, ...) firstarg
81#define SCIP_VARARGS_FIRST(args) SCIP_VARARGS_FIRST_ args
82
83/** get all but the first parameter from variadic arguments */
84#define SCIP_VARARGS_REST(firstarg, ...) __VA_ARGS__
85
86/*
87 * Boolean values
88 */
89
90#ifndef SCIP_Bool
91#define SCIP_Bool unsigned int /**< type used for Boolean values */
92#ifndef TRUE
93#define TRUE 1 /**< Boolean value TRUE */
94#define FALSE 0 /**< Boolean value FALSE */
95#endif
96#endif
97
98#ifndef SCIP_Shortbool
99#define SCIP_Shortbool uint8_t /**< type used for Boolean values with less space */
100#endif
101
102/*
103 * Define the macro SCIP_EXPORT if it is not included from the generated header
104 */
105#ifndef SCIP_EXPORT
106#if defined(_WIN32)
107#define SCIP_EXPORT __declspec(dllexport) /**< mark symbol to be exported in DLL */
108#elif defined(__GNUC__) && __GNUC__ >= 4
109#define SCIP_EXPORT __attribute__((__visibility__("default"))) /**< mark symbol to be visible in shared library */
110#else
111#define SCIP_EXPORT /**< no symbol export attribute known for current compiler */
112#endif
113#endif
114
115/* define INLINE */
116#ifndef INLINE
117#if defined(_WIN32) || defined(__STDC__)
118#define INLINE __inline
119#else
120#define INLINE inline
121#endif
122#endif
123
124
125#define SCIP_VERSION (100*SCIP_VERSION_MAJOR + 10*SCIP_VERSION_MINOR + SCIP_VERSION_PATCH) /**< SCIP version number (multiplied by 100 to get integer number) */
126#define SCIP_VERSION_SUB 0 /**< @deprecated SCIP sub version number. Always 0. */
127#define SCIP_SUBVERSION SCIP_VERSION_SUB /**< @deprecated SCIP sub version number. Always 0. */
128#define SCIP_APIVERSION SCIP_VERSION_API /**< SCIP API version number */
129#define SCIP_COPYRIGHT "Copyright (c) 2002-2025 Zuse Institute Berlin (ZIB)"
130
131
132/*
133 * Long Integer values
134 */
135
136#ifndef LLONG_MAX
137#define LLONG_MAX 9223372036854775807LL
138#define LLONG_MIN (-LLONG_MAX - 1LL)
139#endif
140
141#define SCIP_Longint long long /**< type used for long integer values */
142#define SCIP_LONGINT_MAX LLONG_MAX
143#define SCIP_LONGINT_MIN LLONG_MIN
144#ifndef SCIP_LONGINT_FORMAT
145#ifdef _WIN32
146#define SCIP_LONGINT_FORMAT "I64d"
147#else
148#define SCIP_LONGINT_FORMAT "lld"
149#endif
150#endif
151
152/*
153 * Floating point values
154 */
155
156#define SCIP_Real double /**< type used for floating point values */
157
158#define SCIP_REAL_MAX (SCIP_Real)DBL_MAX
159#define SCIP_REAL_MIN -(SCIP_Real)DBL_MAX
160#define SCIP_REAL_UNITROUNDOFF (1.0 / 9007199254740992)
161#define SCIP_REAL_FORMAT "lf"
162
163#define SCIP_DEFAULT_INFINITY 1e+20 /**< default value considered to be infinity */
164#define SCIP_DEFAULT_EPSILON 1e-09 /**< default upper bound for floating points to be considered zero */
165#define SCIP_DEFAULT_SUMEPSILON 1e-06 /**< default upper bound for sums of floating points to be considered zero */
166#define SCIP_DEFAULT_FEASTOL 1e-06 /**< default feasibility tolerance for constraints */
167#define SCIP_DEFAULT_CHECKFEASTOLFAC 1.0 /**< default factor to change the feasibility tolerance when testing the best solution for feasibility (after solving process) */
168#define SCIP_DEFAULT_LPFEASTOLFACTOR 1.0 /**< default factor w.r.t. primal feasibility tolerance that determines default (and maximal) primal feasibility tolerance of LP solver */
169#define SCIP_DEFAULT_DUALFEASTOL 1e-07 /**< default feasibility tolerance for reduced costs */
170#define SCIP_DEFAULT_BARRIERCONVTOL 1e-10 /**< default convergence tolerance used in barrier algorithm */
171#define SCIP_DEFAULT_BOUNDSTREPS 0.05 /**< default minimal relative improve for strengthening bounds */
172#define SCIP_DEFAULT_PSEUDOCOSTEPS 1e-01 /**< default minimal variable distance value to use for pseudo cost updates */
173#define SCIP_DEFAULT_PSEUDOCOSTDELTA 1e-04 /**< default minimal objective distance value to use for pseudo cost updates */
174#define SCIP_DEFAULT_RECOMPFAC 1e+06 /**< default minimal decrease factor that causes the recomputation of a value (e.g., pseudo objective) instead of an update */
175#define SCIP_DEFAULT_HUGEVAL 1e+15 /**< values larger than this are considered huge and should be handled separately (e.g., in activity computation) */
176#define SCIP_MAXEPSILON 1e-03 /**< maximum value for any numerical epsilon */
177#define SCIP_MINEPSILON 1e-20 /**< minimum value for any numerical epsilon */
178#define SCIP_INVALID (double)1e+99 /**< floating point value is not valid */
179#define SCIP_UNKNOWN (double)1e+98 /**< floating point value is not known (in primal solution) */
180#define SCIP_INTERVAL_INFINITY (double)1e+300 /**< infinity value for interval computations */
181
182#define REALABS(x) (fabs(x))
183#define EPSEQ(x,y,eps) (REALABS((x)-(y)) <= (eps))
184#define EPSLT(x,y,eps) ((x)-(y) < -(eps))
185#define EPSLE(x,y,eps) ((x)-(y) <= (eps))
186#define EPSGT(x,y,eps) ((x)-(y) > (eps))
187#define EPSGE(x,y,eps) ((x)-(y) >= -(eps))
188#define EPSZ(x,eps) (REALABS(x) <= (eps))
189#define EPSP(x,eps) ((x) > (eps))
190#define EPSN(x,eps) ((x) < -(eps))
191#define EPSFLOOR(x,eps) (floor((x)+(eps)))
192#define EPSCEIL(x,eps) (ceil((x)-(eps)))
193#define EPSROUND(x,eps) (ceil((x)-0.5+(eps)))
194#define EPSFRAC(x,eps) ((x)-EPSFLOOR(x,eps))
195#define EPSISINT(x,eps) (EPSFRAC(x,eps) <= (eps))
196
197
198#ifndef SQR
199#define SQR(x) ((x)*(x))
200#endif
201
202/* specification of log1p, which is numerically more stable around x = 0.0 */
203#ifndef LOG1P
204#define LOG1P(x) (log1p(x))
205#endif
206
207#ifndef LOG2
208#if defined(_MSC_VER) && (_MSC_VER < 1800)
209#define LOG2(x) (log(x) / log(2.0))
210#else
211#define LOG2(x) log2(x)
212#endif
213#endif
214
215#ifndef ABS
216#define ABS(x) ((x) >= 0 ? (x) : -(x))
217#endif
218
219#ifndef MAX
220#define MAX(x, y) ((x) >= (y) ? (x) : (y)) /**< returns maximum of x and y */
221#endif
222
223#ifndef MIN
224#define MIN(x, y) ((x) <= (y) ? (x) : (y)) /**< returns minimum of x and y */
225#endif
226
227#ifndef MAX3
228#define MAX3(x, y, z) ((x) >= (y) ? MAX(x, z) : MAX(y, z)) /**< returns maximum of x, y, and z */
229#endif
230
231#ifndef MIN3
232#define MIN3(x, y, z) ((x) <= (y) ? MIN(x, z) : MIN(y, z)) /**< returns minimum of x, y, and z */
233#endif
234
235#ifndef COPYSIGN
236#if defined(_MSC_VER) && (_MSC_VER < 1800)
237#define COPYSIGN _copysign
238#else
239#define COPYSIGN copysign
240#endif
241#endif
242
243/*
244 * Pointers
245 */
246
247#ifndef NULL
248#define NULL ((void*)0) /**< zero pointer */
249#endif
250
251#ifndef RESTRICT
252#if defined(_MSC_VER)
253#define RESTRICT __restrict
254#else
255#ifdef __cplusplus
256#define RESTRICT __restrict__
257#elif __STDC_VERSION__ >= 199901L
258#define RESTRICT restrict
259#else
260#define RESTRICT
261#endif
262#endif
263#endif
264
265/*
266 * Strings
267 */
268
269#define SCIP_MAXSTRLEN 1024 /**< maximum string length in SCIP */
270#define SCIP_SPACECONTROL " tnvfr" /**< control specifier for escaped spaces */
271
272/*
273 * Memory settings
274 */
275
276/* we use SIZE_MAX / 2 to detect negative sizes which got a very large value when casting to size_t */
277#define SCIP_MAXMEMSIZE (SIZE_MAX/2) /**< maximum size of allocated memory (array) */
278
279#define SCIP_HASHSIZE_PARAMS 2048 /**< size of hash table in parameter name tables */
280#define SCIP_HASHSIZE_NAMES 500 /**< size of hash table in name tables */
281#define SCIP_HASHSIZE_CUTPOOLS 500 /**< size of hash table in cut pools */
282#define SCIP_HASHSIZE_CLIQUES 500 /**< size of hash table in clique tables */
283#define SCIP_HASHSIZE_NAMES_SMALL 100 /**< size of hash table in name tables for small problems */
284#define SCIP_HASHSIZE_CUTPOOLS_SMALL 100 /**< size of hash table in cut pools for small problems */
285#define SCIP_HASHSIZE_CLIQUES_SMALL 100 /**< size of hash table in clique tables for small problems */
286#define SCIP_HASHSIZE_VBC 500 /**< size of hash map for node -> nodenum mapping used for VBC output */
287
288#define SCIP_DEFAULT_MEM_ARRAYGROWFAC 1.2 /**< memory growing factor for dynamically allocated arrays */
289#define SCIP_DEFAULT_MEM_ARRAYGROWINIT 4 /**< initial size of dynamically allocated arrays */
290
291#define SCIP_MEM_NOLIMIT (SCIP_Longint)(SCIP_LONGINT_MAX >> 20)/**< initial size of dynamically allocated arrays */
292
293/*
294 * Tree settings
295 */
296
297#define SCIP_MAXTREEDEPTH 1073741822 /**< maximal allowed depth of the branch-and-bound tree */
298
299/*
300 * Probing scoring settings
301 */
302
303#define SCIP_PROBINGSCORE_PENALTYRATIO 2 /**< ratio for penalizing too small fractionalities in diving heuristics.
304 * if the fractional part of a variable is smaller than a given threshold
305 * the corresponding score gets penalized. due to numerical troubles
306 * we will flip a coin whenever SCIPisEQ(scip, fractionality, threshold)
307 * evaluates to true. this parameter defines the chance that this results
308 * in penalizing the score, i.e., there is 1:2 chance for penalizing.
309 */
310
311/*
312 * Global debugging settings
313 */
314
315/*#define DEBUG*/
316
317
318/*
319 * Defines for handling SCIP return codes
320 */
321
322/** this macro is used to stop SCIP in debug mode such that errors can be debugged;
323 *
324 * @note In optimized mode this macro has no effect. That means, in case of an error it has to be ensured that code
325 * terminates with an error code or continues safely.
326 */
327#define SCIPABORT() assert(FALSE) /*lint --e{527} */
328
329#define SCIP_CALL_ABORT_QUIET(x) do { if( (x) != SCIP_OKAY ) SCIPABORT(); } while( FALSE )
330#define SCIP_CALL_QUIET(x) do { SCIP_RETCODE _restat_; if( (_restat_ = (x)) != SCIP_OKAY ) return _restat_; } while( FALSE )
331#define SCIP_ALLOC_ABORT_QUIET(x) do { if( NULL == (x) ) SCIPABORT(); } while( FALSE )
332#define SCIP_ALLOC_QUIET(x) do { if( NULL == (x) ) return SCIP_NOMEMORY; } while( FALSE )
333
334#define SCIP_CALL_ABORT(x) do \
335 { \
336 SCIP_RETCODE _restat_; /*lint -e{506,774}*/ \
337 if( (_restat_ = (x)) != SCIP_OKAY ) \
338 { \
339 SCIPerrorMessage("Error <%d> in function call\n", _restat_); \
340 SCIPABORT(); \
341 } \
342 } \
343 while( FALSE )
344
345#define SCIP_ALLOC_ABORT(x) do \
346 { \
347 if( NULL == (x) ) \
348 { \
349 SCIPerrorMessage("No memory in function call\n"); \
350 SCIPABORT(); \
351 } \
352 } \
353 while( FALSE )
354
355#define SCIP_CALL(x) do \
356 { \
357 SCIP_RETCODE _restat_; /*lint -e{506,774}*/ \
358 if( (_restat_ = (x)) != SCIP_OKAY ) \
359 { \
360 SCIPerrorMessage("Error <%d> in function call\n", _restat_); \
361 return _restat_; \
362 } \
363 } \
364 while( FALSE )
365
366#define SCIP_ALLOC(x) do \
367 { \
368 if( NULL == (x) ) \
369 { \
370 SCIPerrorMessage("No memory in function call\n"); \
371 return SCIP_NOMEMORY; \
372 } \
373 } \
374 while( FALSE )
375
376#define SCIP_CALL_TERMINATE(retcode, x, TERM) do \
377 { \
378 if( ((retcode) = (x)) != SCIP_OKAY ) \
379 { \
380 SCIPerrorMessage("Error <%d> in function call\n", retcode); \
381 goto TERM; \
382 } \
383 } \
384 while( FALSE )
385
386#define SCIP_ALLOC_TERMINATE(retcode, x, TERM) do \
387 { \
388 if( NULL == (x) ) \
389 { \
390 SCIPerrorMessage("No memory in function call\n"); \
391 retcode = SCIP_NOMEMORY; \
392 goto TERM; \
393 } \
394 } \
395 while( FALSE )
396
397#define SCIP_CALL_FINALLY(x, y) do \
398 { \
399 SCIP_RETCODE _restat_; \
400 if( (_restat_ = (x)) != SCIP_OKAY ) \
401 { \
402 SCIPerrorMessage("Error <%d> in function call\n", _restat_); \
403 (y); \
404 return _restat_; \
405 } \
406 } \
407 while( FALSE )
408
409#define SCIP_UNUSED(x) ((void) (x))
410
411/*
412 * Define to mark deprecated API functions
413 */
414
415#ifndef SCIP_DEPRECATED
416#if defined(_MSC_VER)
417# define SCIP_DEPRECATED __declspec(deprecated)
418#elif defined(__GNUC__)
419# define SCIP_DEPRECATED __attribute__ ((deprecated))
420#else
421# define SCIP_DEPRECATED
422#endif
423#endif
424
425#endif