Scippy

SCIP

Solving Constraint Integer Programs

pub_sepa.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-2014 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 pub_sepa.h
17  * @ingroup PUBLICMETHODS
18  * @brief public methods for separators
19  * @author Tobias Achterberg
20  */
21 
22 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
23 
24 #ifndef __SCIP_PUB_SEPA_H__
25 #define __SCIP_PUB_SEPA_H__
26 
27 
28 #include "scip/def.h"
29 #include "scip/type_misc.h"
30 #include "scip/type_sepa.h"
31 
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35 
36 /** compares two separators w. r. to their priority */
37 extern
38 SCIP_DECL_SORTPTRCOMP(SCIPsepaComp);
39 
40 /** comparison method for sorting separators w.r.t. to their name */
41 extern
42 SCIP_DECL_SORTPTRCOMP(SCIPsepaCompName);
43 
44 /** gets user data of separator */
45 extern
47  SCIP_SEPA* sepa /**< separator */
48  );
49 
50 /** sets user data of separator; user has to free old data in advance! */
51 extern
52 void SCIPsepaSetData(
53  SCIP_SEPA* sepa, /**< separator */
54  SCIP_SEPADATA* sepadata /**< new separator user data */
55  );
56 
57 /** gets name of separator */
58 extern
59 const char* SCIPsepaGetName(
60  SCIP_SEPA* sepa /**< separator */
61  );
62 
63 /** gets description of separator */
64 extern
65 const char* SCIPsepaGetDesc(
66  SCIP_SEPA* sepa /**< separator */
67  );
68 
69 /** gets priority of separator */
70 extern
72  SCIP_SEPA* sepa /**< separator */
73  );
74 
75 /** gets frequency of separator */
76 extern
77 int SCIPsepaGetFreq(
78  SCIP_SEPA* sepa /**< separator */
79  );
80 
81 /** sets frequency of separator */
82 extern
83 void SCIPsepaSetFreq(
84  SCIP_SEPA* sepa, /**< separator */
85  int freq /**< new frequency of separator */
86  );
87 
88 /** get maximal bound distance at which the separator is called */
89 extern
91  SCIP_SEPA* sepa /**< separator */
92  );
93 
94 /** does the separator use a secondary SCIP instance? */
95 extern
97  SCIP_SEPA* sepa /**< separator */
98  );
99 
100 /** gets time in seconds used in this separator for setting up for next stages */
101 extern
103  SCIP_SEPA* sepa /**< separator */
104  );
105 
106 /** gets time in seconds used in this separator */
107 extern
109  SCIP_SEPA* sepa /**< separator */
110  );
111 
112 /** gets the total number of times, the separator was called */
113 extern
115  SCIP_SEPA* sepa /**< separator */
116  );
117 
118 /** gets the number of times, the separator was called at the current node */
119 extern
121  SCIP_SEPA* sepa /**< separator */
122  );
123 
124 /** gets total number of times, the separator detected a cutoff */
125 extern
127  SCIP_SEPA* sepa /**< separator */
128  );
129 
130 /** gets the total number of cutting planes found by this separator */
131 extern
133  SCIP_SEPA* sepa /**< separator */
134  );
135 
136 /** gets the total number of cutting planes applied to lp */
137 extern
139  SCIP_SEPA* sepa /**< separator */
140  );
141 
142 /** gets the number of cutting planes found by this separator at the current node */
143 extern
145  SCIP_SEPA* sepa /**< separator */
146  );
147 
148 /** gets total number of additional constraints added by this separator */
149 extern
151  SCIP_SEPA* sepa /**< separator */
152  );
153 
154 /** gets total number of domain reductions found by this separator */
155 extern
157  SCIP_SEPA* sepa /**< separator */
158  );
159 
160 /** should separator be delayed, if other separators found cuts? */
161 extern
163  SCIP_SEPA* sepa /**< separator */
164  );
165 
166 /** was separation of the LP solution delayed at the last call? */
167 extern
169  SCIP_SEPA* sepa /**< separator */
170  );
171 
172 /** was separation of the primal solution delayed at the last call? */
173 extern
175  SCIP_SEPA* sepa /**< separator */
176  );
177 
178 /** is separator initialized? */
179 extern
181  SCIP_SEPA* sepa /**< separator */
182  );
183 
184 #ifdef __cplusplus
185 }
186 #endif
187 
188 #endif
SCIP_Bool SCIPsepaIsInitialized(SCIP_SEPA *sepa)
SCIP_Longint SCIPsepaGetNCutsApplied(SCIP_SEPA *sepa)
type definitions for miscellaneous datastructures
SCIP_DECL_SORTPTRCOMP(SCIPsepaComp)
SCIP_Bool SCIPsepaUsesSubscip(SCIP_SEPA *sepa)
const char * SCIPsepaGetDesc(SCIP_SEPA *sepa)
int SCIPsepaGetFreq(SCIP_SEPA *sepa)
SCIP_Longint SCIPsepaGetNDomredsFound(SCIP_SEPA *sepa)
SCIP_SEPADATA * SCIPsepaGetData(SCIP_SEPA *sepa)
const char * SCIPsepaGetName(SCIP_SEPA *sepa)
SCIP_Bool SCIPsepaIsDelayed(SCIP_SEPA *sepa)
SCIP_Bool SCIPsepaWasSolDelayed(SCIP_SEPA *sepa)
void SCIPsepaSetFreq(SCIP_SEPA *sepa, int freq)
SCIP_Longint SCIPsepaGetNCalls(SCIP_SEPA *sepa)
int SCIPsepaGetPriority(SCIP_SEPA *sepa)
SCIP_Real SCIPsepaGetSetupTime(SCIP_SEPA *sepa)
struct SCIP_Sepa SCIP_SEPA
Definition: type_sepa.h:37
void SCIPsepaSetData(SCIP_SEPA *sepa, SCIP_SEPADATA *sepadata)
#define SCIP_Bool
Definition: def.h:49
SCIP_Longint SCIPsepaGetNCutoffs(SCIP_SEPA *sepa)
SCIP_Bool SCIPsepaWasLPDelayed(SCIP_SEPA *sepa)
SCIP_Real SCIPsepaGetMaxbounddist(SCIP_SEPA *sepa)
type definitions for separators
SCIP_Real SCIPsepaGetTime(SCIP_SEPA *sepa)
#define SCIP_Real
Definition: def.h:123
SCIP_Longint SCIPsepaGetNConssFound(SCIP_SEPA *sepa)
#define SCIP_Longint
Definition: def.h:107
int SCIPsepaGetNCallsAtNode(SCIP_SEPA *sepa)
SCIP_Longint SCIPsepaGetNCutsFoundAtNode(SCIP_SEPA *sepa)
common defines and data types used in all packages of SCIP
SCIP_Longint SCIPsepaGetNCutsFound(SCIP_SEPA *sepa)
struct SCIP_SepaData SCIP_SEPADATA
Definition: type_sepa.h:38