Scippy

SCIP

Solving Constraint Integer Programs

objbenderscut.cpp
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-2022 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 visit scipopt.org. */
13 /* */
14 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
15 
16 /**@file objbenderscut.cpp
17  * @brief C++ wrapper for the Benders' decomposition cut plugins
18  * @author Stephen J. Maher
19  */
20 
21 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
22 
23 #include <cassert>
24 
25 #include "objbenderscut.h"
26 
27 
28 
29 
30 /*
31  * Data structures
32  */
33 
34 /** Benders' decomposition data */
35 struct SCIP_BenderscutData
36 {
37  scip::ObjBenderscut* objbenderscut; /**< the Benders' decomposition object */
38  SCIP_Bool deleteobject; /**< should the Benders' decomposition object be deleted when benders is freed? */
39 };
40 
41 
42 
43 
44 /*
45  * Callback methods of the Benders' decomposition framework
46  */
47 
48 extern "C"
49 {
50 
51 /** copy method for Benders' decomposition cuts (called when SCIP copies plugins) */
52 static
53 SCIP_DECL_BENDERSCUTCOPY(benderscutCopyObj)
54 { /*lint --e{715}*/
55  SCIP_BENDERSCUTDATA* benderscutdata;
56 
57  assert(scip != NULL);
58 
59  benderscutdata = SCIPbenderscutGetData(benderscut);
60  assert(benderscutdata != NULL);
61  assert(benderscutdata->objbenderscut != NULL);
62  assert(benderscutdata->objbenderscut->scip_ != scip);
63 
64  if( benderscutdata->objbenderscut->iscloneable() )
65  {
66  scip::ObjBenderscut* newobjbenderscut;
67  newobjbenderscut = dynamic_cast<scip::ObjBenderscut*> (benderscutdata->objbenderscut->clone(scip));
68 
69  /* call include method of Benders' decomposition object */
70  SCIP_CALL( SCIPincludeObjBenderscut(scip, SCIPgetObjBenders(scip, benders), newobjbenderscut, TRUE) );
71  }
72 
73  return SCIP_OKAY;
74 }
75 
76 /** destructor of Benders' decomposition cut to free user data (called when SCIP is exiting) */
77 static
78 SCIP_DECL_BENDERSCUTFREE(benderscutFreeObj)
79 { /*lint --e{715}*/
80  SCIP_BENDERSCUTDATA* benderscutdata;
81 
82  benderscutdata = SCIPbenderscutGetData(benderscut);
83  assert(benderscutdata != NULL);
84  assert(benderscutdata->objbenderscut != NULL);
85  assert(benderscutdata->objbenderscut->scip_ == scip);
86 
87  /* call virtual method of benderscut object */
88  SCIP_CALL( benderscutdata->objbenderscut->scip_free(scip, benderscut) );
89 
90  /* free benderscut object */
91  if( benderscutdata->deleteobject )
92  delete benderscutdata->objbenderscut;
93 
94  /* free benderscut data */
95  delete benderscutdata;
96  SCIPbenderscutSetData(benderscut, NULL); /*lint !e64*/
97 
98  return SCIP_OKAY;
99 }
100 
101 
102 /** initialization method of Benders' decomposition cut (called after problem was transformed) */
103 static
104 SCIP_DECL_BENDERSCUTINIT(benderscutInitObj)
105 { /*lint --e{715}*/
106  SCIP_BENDERSCUTDATA* benderscutdata;
107 
108  benderscutdata = SCIPbenderscutGetData(benderscut);
109  assert(benderscutdata != NULL);
110  assert(benderscutdata->objbenderscut != NULL);
111  assert(benderscutdata->objbenderscut->scip_ == scip);
112 
113  /* call virtual method of benderscut object */
114  SCIP_CALL( benderscutdata->objbenderscut->scip_init(scip, benderscut) );
115 
116  return SCIP_OKAY;
117 }
118 
119 
120 /** deinitialization method of Benders' decomposition cut (called before transformed problem is freed) */
121 static
122 SCIP_DECL_BENDERSCUTEXIT(benderscutExitObj)
123 { /*lint --e{715}*/
124  SCIP_BENDERSCUTDATA* benderscutdata;
125 
126  benderscutdata = SCIPbenderscutGetData(benderscut);
127  assert(benderscutdata != NULL);
128  assert(benderscutdata->objbenderscut != NULL);
129 
130  /* call virtual method of benderscut object */
131  SCIP_CALL( benderscutdata->objbenderscut->scip_exit(scip, benderscut) );
132 
133  return SCIP_OKAY;
134 }
135 
136 
137 /** solving process initialization method of Benders' decomposition cut (called when branch and bound process is about to begin) */
138 static
139 SCIP_DECL_BENDERSCUTINITSOL(benderscutInitsolObj)
140 { /*lint --e{715}*/
141  SCIP_BENDERSCUTDATA* benderscutdata;
142 
143  benderscutdata = SCIPbenderscutGetData(benderscut);
144  assert(benderscutdata != NULL);
145  assert(benderscutdata->objbenderscut != NULL);
146 
147  /* call virtual method of benderscut object */
148  SCIP_CALL( benderscutdata->objbenderscut->scip_initsol(scip, benderscut) );
149 
150  return SCIP_OKAY;
151 }
152 
153 
154 /** solving process deinitialization method of Benders' decomposition cut (called before branch and bound process data is freed) */
155 static
156 SCIP_DECL_BENDERSCUTEXITSOL(benderscutExitsolObj)
157 { /*lint --e{715}*/
158  SCIP_BENDERSCUTDATA* benderscutdata;
159 
160  benderscutdata = SCIPbenderscutGetData(benderscut);
161  assert(benderscutdata != NULL);
162  assert(benderscutdata->objbenderscut != NULL);
163 
164  /* call virtual method of benderscut object */
165  SCIP_CALL( benderscutdata->objbenderscut->scip_exitsol(scip, benderscut) );
166 
167  return SCIP_OKAY;
168 }
169 
170 
171 /** execution method of the Benders' decomposition cuts */
172 static
173 SCIP_DECL_BENDERSCUTEXEC(benderscutExecObj)
174 { /*lint --e{715}*/
175  SCIP_BENDERSCUTDATA* benderscutdata;
176 
177  benderscutdata = SCIPbenderscutGetData(benderscut);
178  assert(benderscutdata != NULL);
179  assert(benderscutdata->objbenderscut != NULL);
180 
181  /* call virtual method of benderscut object */
182  SCIP_CALL( benderscutdata->objbenderscut->scip_exec(scip, benders, benderscut, sol, probnumber, type, result) );
183 
184  return SCIP_OKAY;
185 }
186 
187 
188 }
189 
190 
191 /*
192  * Benders' decomposition cut specific interface methods
193  */
194 
195 /** creates the Benders' decomposition cut for the given Benders' decomposition cut object and includes it in SCIP */
197  SCIP* scip, /**< SCIP data structure */
198  scip::ObjBenders* objbenders, /**< Benders' decomposition object */
199  scip::ObjBenderscut* objbenderscut, /**< Benders' decomposition cut object */
200  SCIP_Bool deleteobject /**< should the Benders' decomposition cut object be deleted when benderscut is freed? */
201  )
202 {
203  SCIP_BENDERS* benders;
204  SCIP_BENDERSCUTDATA* benderscutdata;
205 
206  assert(scip != NULL);
207  assert(objbenderscut != NULL);
208  assert(objbenderscut->scip_ == scip);
209 
210  /* create obj Benderscut' decomposition data */
211  benderscutdata = new SCIP_BENDERSCUTDATA;
212  benderscutdata->objbenderscut = objbenderscut;
213  benderscutdata->deleteobject = deleteobject;
214 
215  benders = SCIPfindBenders(scip, objbenders->scip_name_);
216  assert(benders != NULL);
217 
218  /* include Benderscut' decomposition */
219  SCIP_CALL( SCIPincludeBenderscut(scip, benders, objbenderscut->scip_name_, objbenderscut->scip_desc_,
220  objbenderscut->scip_priority_, objbenderscut->scip_islpcut_, benderscutCopyObj, benderscutFreeObj,
221  benderscutInitObj, benderscutExitObj, benderscutInitsolObj, benderscutExitsolObj, benderscutExecObj,
222  benderscutdata) ); /*lint !e429*/
223 
224  return SCIP_OKAY; /*lint !e429*/
225 }
226 
227 /** returns the benderscut object of the given name, or 0 if not existing */
229  scip::ObjBenders* objbenders, /**< Benders' decomposition object */
230  const char* name /**< name of Benderscut' decomposition */
231  )
232 {
233  SCIP_BENDERS* benders;
234  SCIP_BENDERSCUT* benderscut;
235  SCIP_BENDERSCUTDATA* benderscutdata;
236 
237  benders = SCIPfindBenders(objbenders->scip_, objbenders->scip_name_);
238  assert(benders != NULL);
239 
240  benderscut = SCIPfindBenderscut(benders, name);
241  if( benderscut == NULL )
242  return 0;
243 
244  benderscutdata = SCIPbenderscutGetData(benderscut);
245  assert(benderscutdata != NULL);
246 
247  return benderscutdata->objbenderscut;
248 }
249 
250 /** returns the benderscut object for the given Benderscut' decomposition */
252  SCIP* scip, /**< SCIP data structure */
253  SCIP_BENDERSCUT* benderscut /**< Benderscut' decomposition */
254  )
255 {
256  SCIP_BENDERSCUTDATA* benderscutdata;
257 
258  assert(scip != NULL);
259  benderscutdata = SCIPbenderscutGetData(benderscut);
260  assert(benderscutdata != NULL);
261 
262  return benderscutdata->objbenderscut;
263 }
scip::ObjBenders * SCIPgetObjBenders(SCIP *scip, SCIP_BENDERS *benders)
Definition: objbenders.cpp:383
struct SCIP_BenderscutData SCIP_BENDERSCUTDATA
SCIP_BENDERSCUTDATA * SCIPbenderscutGetData(SCIP_BENDERSCUT *benderscut)
Definition: benderscut.c:394
scip::ObjBenderscut * SCIPgetObjBenderscut(SCIP *scip, SCIP_BENDERSCUT *benderscut)
static SCIP_DECL_BENDERSCUTEXIT(benderscutExitObj)
static SCIP_DECL_BENDERSCUTINIT(benderscutInitObj)
char * scip_name_
Definition: objbenders.h:56
void SCIPbenderscutSetData(SCIP_BENDERSCUT *benderscut, SCIP_BENDERSCUTDATA *benderscutdata)
Definition: benderscut.c:404
#define TRUE
Definition: def.h:86
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:54
SCIP_RETCODE SCIPincludeBenderscut(SCIP *scip, SCIP_BENDERS *benders, const char *name, const char *desc, int priority, SCIP_Bool islpcut, SCIP_DECL_BENDERSCUTCOPY((*benderscutcopy)), SCIP_DECL_BENDERSCUTFREE((*benderscutfree)), SCIP_DECL_BENDERSCUTINIT((*benderscutinit)), SCIP_DECL_BENDERSCUTEXIT((*benderscutexit)), SCIP_DECL_BENDERSCUTINITSOL((*benderscutinitsol)), SCIP_DECL_BENDERSCUTEXITSOL((*benderscutexitsol)), SCIP_DECL_BENDERSCUTEXEC((*benderscutexec)), SCIP_BENDERSCUTDATA *benderscutdata)
static SCIP_DECL_BENDERSCUTFREE(benderscutFreeObj)
C++ wrapper for Benders&#39; decomposition plugins.
Definition: objbenders.h:47
static SCIP_DECL_BENDERSCUTINITSOL(benderscutInitsolObj)
#define NULL
Definition: lpi_spx1.cpp:155
SCIP_BENDERSCUT * SCIPfindBenderscut(SCIP_BENDERS *benders, const char *name)
Definition: benders.c:6888
const SCIP_Bool scip_islpcut_
Definition: objbenderscut.h:65
#define SCIP_CALL(x)
Definition: def.h:384
SCIP_BENDERS * SCIPfindBenders(SCIP *scip, const char *name)
Definition: scip_benders.c:484
#define SCIP_Bool
Definition: def.h:84
const int scip_priority_
Definition: objbenderscut.h:62
C++ wrapper for Benders&#39; decomposition cuts.
SCIP_RETCODE SCIPincludeObjBenderscut(SCIP *scip, scip::ObjBenders *objbenders, scip::ObjBenderscut *objbenderscut, SCIP_Bool deleteobject)
C++ wrapper for Benders&#39; decomposition cut.
Definition: objbenderscut.h:47
scip::ObjBenderscut * SCIPfindObjBenderscut(scip::ObjBenders *objbenders, const char *name)
static SCIP_DECL_BENDERSCUTEXITSOL(benderscutExitsolObj)
static SCIP_DECL_BENDERSCUTCOPY(benderscutCopyObj)
static SCIP_DECL_BENDERSCUTEXEC(benderscutExecObj)