Scippy

SCIP

Solving Constraint Integer Programs

pub_event.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-2016 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_event.h
17  * @ingroup PUBLICMETHODS
18  * @brief public methods for managing events
19  * @author Tobias Achterberg
20  */
21 
22 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
23 
24 #ifndef __SCIP_PUB_EVENT_H__
25 #define __SCIP_PUB_EVENT_H__
26 
27 
28 #include "scip/def.h"
29 #include "scip/type_retcode.h"
30 #include "scip/type_event.h"
31 #include "scip/type_var.h"
32 #include "scip/type_sol.h"
33 #include "scip/type_tree.h"
34 
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38 
39 /*
40  * Event handler methods
41  */
42 
43 /** gets name of event handler */
44 extern
45 const char* SCIPeventhdlrGetName(
46  SCIP_EVENTHDLR* eventhdlr /**< event handler */
47  );
48 
49 /** gets user data of event handler */
50 extern
52  SCIP_EVENTHDLR* eventhdlr /**< event handler */
53  );
54 
55 /** sets user data of event handler; user has to free old data in advance! */
56 extern
58  SCIP_EVENTHDLR* eventhdlr, /**< event handler */
59  SCIP_EVENTHDLRDATA* eventhdlrdata /**< new event handler user data */
60  );
61 
62 /** is event handler initialized? */
63 extern
65  SCIP_EVENTHDLR* eventhdlr /**< event handler */
66  );
67 
68 /** gets time in seconds used in this event handler for setting up for next stages */
69 extern
71  SCIP_EVENTHDLR* eventhdlr /**< event handler */
72  );
73 
74 /** gets time in seconds used in this event handler */
75 extern
77  SCIP_EVENTHDLR* eventhdlr /**< event handler */
78  );
79 
80 
81 /*
82  * Event methods
83  */
84 
85 /** gets type of event */
86 extern
88  SCIP_EVENT* event /**< event */
89  );
90 
91 /** gets variable for a variable event (var added, var deleted, var fixed,
92  * objective value or domain change, domain hole added or removed) */
93 extern
95  SCIP_EVENT* event /**< event */
96  );
97 
98 /** gets old objective value for an objective value change event */
99 extern
101  SCIP_EVENT* event /**< event */
102  );
103 
104 /** gets new objective value for an objective value change event */
105 extern
107  SCIP_EVENT* event /**< event */
108  );
109 
110 /** gets old bound for a bound change event */
111 extern
113  SCIP_EVENT* event /**< event */
114  );
115 
116 /** gets new bound for a bound change event */
117 extern
119  SCIP_EVENT* event /**< event */
120  );
121 
122 /** gets node for a node or LP event */
123 extern
125  SCIP_EVENT* event /**< event */
126  );
127 
128 /** gets solution for a primal solution event */
129 extern
131  SCIP_EVENT* event /**< event */
132  );
133 
134 /** gets the left bound of open interval in the hole */
135 extern
137  SCIP_EVENT* event /**< event */
138  );
139 
140 /** gets the right bound of open interval in the hole */
141 extern
143  SCIP_EVENT* event /**< event */
144  );
145 
146 /** gets row for a row event */
147 extern
149  SCIP_EVENT* event /**< event */
150  );
151 
152 /** gets column for a row change coefficient event */
153 extern
155  SCIP_EVENT* event /**< event */
156  );
157 
158 /** gets old coefficient value for a row change coefficient event */
159 extern
161  SCIP_EVENT* event /**< event */
162  );
163 
164 /** gets new coefficient value for a row change coefficient event */
165 extern
167  SCIP_EVENT* event /**< event */
168  );
169 
170 /** gets old constant value for a row change constant event */
171 extern
173  SCIP_EVENT* event /**< event */
174  );
175 
176 /** gets new constant value for a row change constant event */
177 extern
179  SCIP_EVENT* event /**< event */
180  );
181 
182 /** gets side for a row change side event */
183 extern
185  SCIP_EVENT* event /**< event */
186  );
187 
188 /** gets old side value for a row change side event */
189 extern
191  SCIP_EVENT* event /**< event */
192  );
193 
194 /** gets new side value for a row change side event */
195 extern
197  SCIP_EVENT* event /**< event */
198  );
199 
200 #ifdef __cplusplus
201 }
202 #endif
203 
204 #endif
SCIP_ROW * SCIPeventGetRow(SCIP_EVENT *event)
struct SCIP_Row SCIP_ROW
Definition: type_lp.h:93
struct SCIP_Eventhdlr SCIP_EVENTHDLR
Definition: type_event.h:128
struct SCIP_EventhdlrData SCIP_EVENTHDLRDATA
Definition: type_event.h:129
SCIP_SOL * SCIPeventGetSol(SCIP_EVENT *event)
SCIP_Real SCIPeventGetHoleRight(SCIP_EVENT *event)
SCIP_Real SCIPeventGetRowOldCoefVal(SCIP_EVENT *event)
type definitions for return codes for SCIP methods
SCIP_Real SCIPeventGetRowNewCoefVal(SCIP_EVENT *event)
SCIP_COL * SCIPeventGetRowCol(SCIP_EVENT *event)
SCIP_Real SCIPeventGetHoleLeft(SCIP_EVENT *event)
SCIP_EVENTHDLRDATA * SCIPeventhdlrGetData(SCIP_EVENTHDLR *eventhdlr)
SCIP_Real SCIPeventhdlrGetTime(SCIP_EVENTHDLR *eventhdlr)
SCIP_Real SCIPeventGetRowOldConstVal(SCIP_EVENT *event)
SCIP_Real SCIPeventhdlrGetSetupTime(SCIP_EVENTHDLR *eventhdlr)
struct SCIP_Col SCIP_COL
Definition: type_lp.h:87
SCIP_Real SCIPeventGetNewbound(SCIP_EVENT *event)
SCIP_NODE * SCIPeventGetNode(SCIP_EVENT *event)
type definitions for problem variables
type definitions for managing events
SCIP_Real SCIPeventGetOldobj(SCIP_EVENT *event)
unsigned int SCIP_EVENTTYPE
Definition: type_event.h:125
struct SCIP_Sol SCIP_SOL
Definition: type_sol.h:45
SCIP_VAR * SCIPeventGetVar(SCIP_EVENT *event)
#define SCIP_Bool
Definition: def.h:53
SCIP_Real SCIPeventGetOldbound(SCIP_EVENT *event)
const char * SCIPeventhdlrGetName(SCIP_EVENTHDLR *eventhdlr)
SCIP_SIDETYPE SCIPeventGetRowSide(SCIP_EVENT *event)
type definitions for branch and bound tree
void SCIPeventhdlrSetData(SCIP_EVENTHDLR *eventhdlr, SCIP_EVENTHDLRDATA *eventhdlrdata)
struct SCIP_Var SCIP_VAR
Definition: type_var.h:95
SCIP_Bool SCIPeventhdlrIsInitialized(SCIP_EVENTHDLR *eventhdlr)
type definitions for storing primal CIP solutions
SCIP_Real SCIPeventGetRowNewSideVal(SCIP_EVENT *event)
SCIP_Real SCIPeventGetNewobj(SCIP_EVENT *event)
SCIP_Real SCIPeventGetRowNewConstVal(SCIP_EVENT *event)
#define SCIP_Real
Definition: def.h:127
common defines and data types used in all packages of SCIP
struct SCIP_Node SCIP_NODE
Definition: type_tree.h:54
SCIP_Real SCIPeventGetRowOldSideVal(SCIP_EVENT *event)
SCIP_EVENTTYPE SCIPeventGetType(SCIP_EVENT *event)
enum SCIP_SideType SCIP_SIDETYPE
Definition: type_lp.h:58
struct SCIP_Event SCIP_EVENT
Definition: type_event.h:130