Toggle navigation
SCIP Optimization Suite
SCIP
SoPlex
ZIMPL
UG
GCG
Documentation
SCIP 9.2.0
SCIP 8.1.0
SCIP 7.0.3
SCIP 6.0.2
SCIP 5.0.1
SCIP 4.0.1
SCIP 3.2.1
SCIP
Solving Constraint Integer Programs
type_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-2017 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 email to scip@zib.de. */
13
/* */
14
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
15
16
/**@file type_paramset.h
17
* @ingroup TYPEDEFINITIONS
18
* @brief type definitions 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_TYPE_PARAMSET_H__
25
#define __SCIP_TYPE_PARAMSET_H__
26
27
#include "
scip/def.h
"
28
#include "
scip/type_retcode.h
"
29
#include "
scip/type_scip.h
"
30
31
#ifdef __cplusplus
32
extern
"C"
{
33
#endif
34
35
/** possible parameter types */
36
enum
SCIP_ParamType
37
{
38
SCIP_PARAMTYPE_BOOL
= 0,
/**< bool values: TRUE or FALSE */
39
SCIP_PARAMTYPE_INT
= 1,
/**< integer values */
40
SCIP_PARAMTYPE_LONGINT
= 2,
/**< long integer values */
41
SCIP_PARAMTYPE_REAL
= 3,
/**< real values */
42
SCIP_PARAMTYPE_CHAR
= 4,
/**< characters */
43
SCIP_PARAMTYPE_STRING
= 5
/**< strings: arrays of characters */
44
};
45
typedef
enum
SCIP_ParamType
SCIP_PARAMTYPE
;
46
47
/** possible parameter settings - used to determine the behavior of different SCIP components, e.g., heuristics, separators, ... */
48
enum
SCIP_ParamSetting
49
{
50
SCIP_PARAMSETTING_DEFAULT
= 0,
/**< use default values */
51
52
SCIP_PARAMSETTING_AGGRESSIVE
= 1,
/**< set to aggressive settings */
53
SCIP_PARAMSETTING_FAST
= 2,
/**< set to fast settings */
54
SCIP_PARAMSETTING_OFF
= 3
/**< turn off */
55
};
56
typedef
enum
SCIP_ParamSetting
SCIP_PARAMSETTING
;
57
58
/** possible parameter emphases - used to determine the general SCIP behavior */
59
enum
SCIP_ParamEmphasis
60
{
61
SCIP_PARAMEMPHASIS_DEFAULT
= 0,
/**< use default values */
62
63
SCIP_PARAMEMPHASIS_CPSOLVER
= 1,
/**< get CP like search (e.g. no LP relaxation) */
64
SCIP_PARAMEMPHASIS_EASYCIP
= 2,
/**< solve easy problems fast */
65
SCIP_PARAMEMPHASIS_FEASIBILITY
= 3,
/**< detect feasibility fast */
66
SCIP_PARAMEMPHASIS_HARDLP
= 4,
/**< be capable to handle hard LPs */
67
SCIP_PARAMEMPHASIS_OPTIMALITY
= 5,
/**< prove optimality fast */
68
SCIP_PARAMEMPHASIS_COUNTER
= 6,
/**< get a feasible and "fast" counting process */
69
SCIP_PARAMEMPHASIS_PHASEFEAS
= 7,
/**< feasibility phase settings during 3-phase solving approach */
70
SCIP_PARAMEMPHASIS_PHASEIMPROVE
= 8,
/**< improvement phase settings during 3-phase solving approach */
71
SCIP_PARAMEMPHASIS_PHASEPROOF
= 9
/**< proof phase settings during 3-phase solving approach */
72
};
73
typedef
enum
SCIP_ParamEmphasis
SCIP_PARAMEMPHASIS
;
74
75
typedef
struct
SCIP_Param
SCIP_PARAM
;
/**< single parameter */
76
typedef
struct
SCIP_ParamData
SCIP_PARAMDATA
;
/**< locally defined parameter specific data */
77
typedef
struct
SCIP_ParamSet
SCIP_PARAMSET
;
/**< set of parameters */
78
79
80
/** information method for changes in the parameter
81
*
82
* Method is called if the parameter was changed through a SCIPparamsetSetXyz() call
83
* (which is called by SCIPsetXyzParam()).
84
* It will not be called, if the parameter was changed directly by changing the value
85
* in the memory location.
86
*
87
* input:
88
* scip : SCIP main data structure
89
* param : the changed parameter (already set to its new value)
90
*/
91
#define SCIP_DECL_PARAMCHGD(x) SCIP_RETCODE x (SCIP* scip, SCIP_PARAM* param)
92
93
#ifdef __cplusplus
94
}
95
#endif
96
97
#endif
SCIP_PARAMEMPHASIS_CPSOLVER
Definition:
type_paramset.h:63
SCIP_PARAMTYPE
enum SCIP_ParamType SCIP_PARAMTYPE
Definition:
type_paramset.h:45
SCIP_PARAMEMPHASIS_PHASEIMPROVE
Definition:
type_paramset.h:70
SCIP_PARAMEMPHASIS_DEFAULT
Definition:
type_paramset.h:61
SCIP_PARAMDATA
struct SCIP_ParamData SCIP_PARAMDATA
Definition:
type_paramset.h:76
SCIP_PARAMEMPHASIS_OPTIMALITY
Definition:
type_paramset.h:67
SCIP_PARAMTYPE_INT
Definition:
type_paramset.h:39
SCIP_PARAMEMPHASIS_PHASEFEAS
Definition:
type_paramset.h:69
SCIP_Param
Definition:
struct_paramset.h:99
SCIP_PARAMSETTING_DEFAULT
Definition:
type_paramset.h:50
type_retcode.h
type definitions for return codes for SCIP methods
SCIP_PARAMSETTING
enum SCIP_ParamSetting SCIP_PARAMSETTING
Definition:
type_paramset.h:56
SCIP_PARAMSETTING_OFF
Definition:
type_paramset.h:54
type_scip.h
type definitions for SCIP's main datastructure
SCIP_PARAMEMPHASIS_EASYCIP
Definition:
type_paramset.h:64
SCIP_PARAMTYPE_BOOL
Definition:
type_paramset.h:38
SCIP_PARAMTYPE_LONGINT
Definition:
type_paramset.h:40
SCIP_PARAMEMPHASIS_FEASIBILITY
Definition:
type_paramset.h:65
SCIP_PARAMEMPHASIS_PHASEPROOF
Definition:
type_paramset.h:71
SCIP_PARAMTYPE_STRING
Definition:
type_paramset.h:43
SCIP_PARAMEMPHASIS
enum SCIP_ParamEmphasis SCIP_PARAMEMPHASIS
Definition:
type_paramset.h:73
SCIP_PARAMEMPHASIS_COUNTER
Definition:
type_paramset.h:68
SCIP_PARAMTYPE_CHAR
Definition:
type_paramset.h:42
SCIP_ParamType
SCIP_ParamType
Definition:
type_paramset.h:36
SCIP_ParamSet
Definition:
struct_paramset.h:120
def.h
common defines and data types used in all packages of SCIP
SCIP_PARAMSETTING_FAST
Definition:
type_paramset.h:53
SCIP_ParamSetting
SCIP_ParamSetting
Definition:
type_paramset.h:48
SCIP_PARAMEMPHASIS_HARDLP
Definition:
type_paramset.h:66
SCIP_PARAMSETTING_AGGRESSIVE
Definition:
type_paramset.h:52
SCIP_ParamEmphasis
SCIP_ParamEmphasis
Definition:
type_paramset.h:59
SCIP_PARAMTYPE_REAL
Definition:
type_paramset.h:41