Scippy

GCG

Branch-and-Price & Column Generation for Everyone

struct_pricestore_gcg.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 struct_pricestore_gcg.h
29  * @ingroup DATASTRUCTURES
30  * @brief datastructures for storing priced cols
31  * @author Jonas Witt
32  */
33 
34 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
35 
36 #ifndef __GCG_STRUCT_PRICESTORE_H__
37 #define __GCG_STRUCT_PRICESTORE_H__
38 
39 
40 #include "scip/def.h"
41 #include "scip/type_lp.h"
42 #include "scip/type_var.h"
43 #include "type_pricestore_gcg.h"
44 #include "pub_gcgcol.h"
45 #include "type_gcgcol.h"
46 
47 #ifdef __cplusplus
48 extern "C" {
49 #endif
50 
51 /** storage for priced cols */
53 {
54  SCIP* scip; /**< SCIP data structure */
55  GCG_COL** cols; /**< array with priced cols sorted by score */
56  SCIP_Real* objparallelisms; /**< parallelism of col to the objective function */
57  SCIP_Real* orthogonalities; /**< minimal orthogonality of col with all other cols of larger score */
58  SCIP_Real* scores; /**< score for each priced col: weighted sum of efficacy and orthogonality */
59  int colssize; /**< size of cols and score arrays */
60  int ncols; /**< number of priced cols (max. is set->price_maxcols) */
61  int nforcedcols; /**< number of forced priced cols (first positions in cols array) */
62  int nefficaciouscols; /**< number of improving priced cols */
63  int ncolsfound; /**< total number of cols found so far */
64  int ncolsfoundround; /**< number of cols found so far in this pricing round */
65  int ncolsapplied; /**< total number of cols applied to the LPs */
66  SCIP_Bool infarkas; /**< is the price storage currently being filled with the columns from farkas pricing? */
67  SCIP_Bool forcecols; /**< should the cols be used despite the number of cols parameter limit? */
68  SCIP_Real efficiacyfac; /**< factor of efficiacy in score function */
69  SCIP_Real objparalfac; /**< factor of objective parallelism in score function */
70  SCIP_Real orthofac; /**< factor of orthogonalities in score function */
71  SCIP_Real mincolorth; /**< minimal orthogonality of columns to add
72  (with respect to columns added in the current round) */
73  SCIP_CLOCK* priceclock; /**< pricing time */
74  GCG_EFFICIACYCHOICE efficiacychoice; /**< choice to base efficiacy on */
75 };
76 
77 #ifdef __cplusplus
78 }
79 #endif
80 
81 #endif
enum GCG_Efficiacychoice GCG_EFFICIACYCHOICE
type definitions for gcg column data structure
type definitions for storing priced cols
GCG_EFFICIACYCHOICE efficiacychoice
public methods for working with gcg columns
SCIP_Real * orthogonalities
SCIP_Real * objparallelisms
SCIP_CLOCK * priceclock