Scippy

GCG

Branch-and-Price & Column Generation for Everyone

sepa_basis.h
Go to the documentation of this file.
1 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2 /* */
3 /* This file is part of the program */
4 /* GCG --- Generic Column Generation */
5 /* a Dantzig-Wolfe decomposition based extension */
6 /* of the branch-cut-and-price framework */
7 /* SCIP --- Solving Constraint Integer Programs */
8 /* */
9 /* Copyright (C) 2010-2021 Operations Research, RWTH Aachen University */
10 /* Zuse Institute Berlin (ZIB) */
11 /* */
12 /* This program is free software; you can redistribute it and/or */
13 /* modify it under the terms of the GNU Lesser General Public License */
14 /* as published by the Free Software Foundation; either version 3 */
15 /* of the License, or (at your option) any later version. */
16 /* */
17 /* This program is distributed in the hope that it will be useful, */
18 /* but WITHOUT ANY WARRANTY; without even the implied warranty of */
19 /* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the */
20 /* GNU Lesser General Public License for more details. */
21 /* */
22 /* You should have received a copy of the GNU Lesser General Public License */
23 /* along with this program; if not, write to the Free Software */
24 /* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.*/
25 /* */
26 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
27 
28 /**@file sepa_basis.h
29  * @ingroup SEPARATORS
30  * @brief basis separator
31  * @author Jonas Witt
32  */
33 
34 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
35 
36 #ifndef __SCIP_SEPA_BASIS_H__
37 #define __SCIP_SEPA_BASIS_H__
38 
39 
40 #include "scip/scip.h"
41 
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45 
46 /** creates the basis separator and includes it in SCIP */
47 extern
48 SCIP_RETCODE SCIPincludeSepaBasis(
49  SCIP* scip /**< SCIP data structure */
50  );
51 
52 /** returns the array of original cuts saved in the separator data */
53 extern
54 SCIP_ROW** GCGsepaBasisGetOrigcuts(
55  SCIP* scip /**< SCIP data structure */
56  );
57 
58 /** returns the number of original cuts saved in the separator data */
59 extern
61  SCIP* scip /**< SCIP data structure */
62  );
63 
64 /** returns the array of master cuts saved in the separator data */
65 extern
66 SCIP_ROW** GCGsepaBasisGetMastercuts(
67  SCIP* scip /**< SCIP data structure */
68  );
69 
70 /** returns the number of master cuts saved in the separator data */
71 extern
73  SCIP* scip /**< SCIP data structure */
74  );
75 
76 /** transforms cut in pricing variables to cut in original variables and adds it to newcuts array */
77 extern
78 SCIP_RETCODE GCGsepaBasisAddPricingCut(
79  SCIP* scip, /**< SCIP data structure */
80  int ppnumber, /**< number of pricing problem */
81  SCIP_ROW* cut /**< cut to be added */
82  );
83 
84 /** add cuts which are due to the latest objective function of the pricing problems
85  * (reduced cost non-negative) */
86 extern
87 SCIP_RETCODE SCIPsepaBasisAddPPObjConss(
88  SCIP* scip, /**< SCIP data structure */
89  int ppnumber, /**< number of pricing problem */
90  SCIP_Real dualsolconv, /**< dual solution corresponding to convexity constraint */
91  SCIP_Bool newcuts /**< add cut to newcuts in sepadata? (otherwise add it just to the cutpool) */
92  );
93 
94 #ifdef __cplusplus
95 }
96 #endif
97 
98 #endif
SCIP_ROW ** GCGsepaBasisGetOrigcuts(SCIP *scip)
Definition: sepa_basis.c:1683
int GCGsepaBasisGetNMastercuts(SCIP *scip)
Definition: sepa_basis.c:1740
SCIP_ROW ** GCGsepaBasisGetMastercuts(SCIP *scip)
Definition: sepa_basis.c:1721
SCIP_RETCODE GCGsepaBasisAddPricingCut(SCIP *scip, int ppnumber, SCIP_ROW *cut)
Definition: sepa_basis.c:1759
SCIP_RETCODE SCIPsepaBasisAddPPObjConss(SCIP *scip, int ppnumber, SCIP_Real dualsolconv, SCIP_Bool newcuts)
Definition: sepa_basis.c:1869
SCIP_RETCODE SCIPincludeSepaBasis(SCIP *scip)
Definition: sepa_basis.c:1592
int GCGsepaBasisGetNOrigcuts(SCIP *scip)
Definition: sepa_basis.c:1702