Scippy

SCIP

Solving Constraint Integer Programs

struct_benderscut.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-2019 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 scip.zib.de. */
13 /* */
14 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
15 
16 /**@file struct_benderscut.h
17  * @ingroup INTERNALAPI
18  * @brief datastructures for Benders' decomposition cuts techniques
19  * @author Stephen J. Maher
20  */
21 
22 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
23 
24 #ifndef __SCIP_STRUCT_BENDERSCUT_H__
25 #define __SCIP_STRUCT_BENDERSCUT_H__
26 
27 
28 #include "scip/def.h"
29 #include "scip/type_clock.h"
30 #include "scip/type_benderscut.h"
31 
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35 
37 {
38  SCIP_VAR** vars; /**< the variables forming the cut */
39  SCIP_Real* vals; /**< the coefficients of the variables in the cut */
40  SCIP_Real lhs; /**< the left hand side of the cut */
41  SCIP_Real rhs; /**< the right hand side of the cut */
42  int nvars; /**< the number of variables in the cut */
43 };
45 
46 /** Benders' decomposition cuts data */
48 {
49  SCIP_Longint ncalls; /**< number of times, this Benders' decomposition cut was called */
50  SCIP_Longint nfound; /**< number of cuts found so far by this Benders' decomposition cut */
51  char* name; /**< name of the Benders' decomposition cut */
52  char* desc; /**< description of the Benders' decomposition cut */
53  SCIP_DECL_BENDERSCUTCOPY((*benderscutcopy));/**< copy method of the Benders' decomposition cut or NULL if you don't want to copy your plugin into sub-SCIPs */
54  SCIP_DECL_BENDERSCUTFREE((*benderscutfree));/**< destructor of the Benders' decomposition cut */
55  SCIP_DECL_BENDERSCUTINIT((*benderscutinit));/**< initialize the Benders' decomposition cut */
56  SCIP_DECL_BENDERSCUTEXIT((*benderscutexit));/**< deinitialize the Benders' decomposition cut */
57  SCIP_DECL_BENDERSCUTINITSOL((*benderscutinitsol));/**< solving process initialization method of the Benders' decomposition cut */
58  SCIP_DECL_BENDERSCUTEXITSOL((*benderscutexitsol));/**< solving process deinitialization method of the Benders' decomposition cut */
59  SCIP_DECL_BENDERSCUTEXEC((*benderscutexec));/**< execution method of the Benders' decomposition cut */
60  SCIP_BENDERSCUTDATA* benderscutdata; /**< Benders' decomposition cuts local data */
61  SCIP_CLOCK* setuptime; /**< time spend for setting up the Benders' decomposition cut plugin */
62  SCIP_CLOCK* benderscutclock; /**< the execution time of the Benders' decomposition cut plugin */
63  int priority; /**< priority of the Benders' decomposition cuts */
64  SCIP_Bool islpcut; /**< does this Benders' cut use LP information? */
65  SCIP_Bool initialized; /**< has the Benders' decomposition cut been initialized? */
66 
67  SCIP_BENDERSCUTCUT** addedcuts; /**< array to store the data required to form a cut/constraint */
68  int addedcutssize; /**< the size of the added cuts array */
69  int naddedcuts; /**< the number of the added cuts */
70 
71  /* additional Benders' decomposition cuts parameters */
72  SCIP_Bool enabled; /**< is this Benders' decomposition cut enabled? */
73 };
74 
75 #ifdef __cplusplus
76 }
77 #endif
78 
79 #endif
struct SCIP_BenderscutData SCIP_BENDERSCUTDATA
#define SCIP_DECL_BENDERSCUTFREE(x)
SCIP_Longint ncalls
#define SCIP_DECL_BENDERSCUTEXEC(x)
#define SCIP_DECL_BENDERSCUTCOPY(x)
#define SCIP_DECL_BENDERSCUTINIT(x)
SCIP_CLOCK * setuptime
#define SCIP_DECL_BENDERSCUTEXIT(x)
#define SCIP_Bool
Definition: def.h:69
SCIP_CLOCK * benderscutclock
type definitions for clocks and timing issues
type definitions for Benders&#39; decomposition cut
SCIP_Longint nfound
#define SCIP_Real
Definition: def.h:157
#define SCIP_DECL_BENDERSCUTEXITSOL(x)
#define SCIP_Longint
Definition: def.h:142
SCIP_BENDERSCUTDATA * benderscutdata
SCIP_BENDERSCUTCUT ** addedcuts
common defines and data types used in all packages of SCIP
#define SCIP_DECL_BENDERSCUTINITSOL(x)