Scippy

SCIP

Solving Constraint Integer Programs

pub_cutpool.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_cutpool.h
17  * @ingroup PUBLICMETHODS
18  * @brief public methods for storing cuts in a cut pool
19  * @author Tobias Achterberg
20  */
21 
22 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
23 
24 #ifndef __SCIP_PUB_CUTPOOL_H__
25 #define __SCIP_PUB_CUTPOOL_H__
26 
27 
28 #include "scip/def.h"
29 #include "scip/type_cutpool.h"
30 
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
34 
35 /** gets the row of the cut */
36 extern
38  SCIP_CUT* cut /**< cut */
39  );
40 
41 /** gets the age of the cut: the number of consecutive cut pool separation rounds where the cut was neither in the LP nor violated */
42 extern
43 int SCIPcutGetAge(
44  SCIP_CUT* cut /**< cut */
45  );
46 
47 /** returns the ratio of LPs where the row belonging to this cut was active in an LP solution, i.e.
48  * where the age of its row has not been increased
49  *
50  * @see SCIPcutGetAge() to get the age of a cut
51  */
52 extern
54  SCIP_CUT* cut /**< cut */
55  );
56 
57 /** gets array of cuts in the cut pool */
58 extern
60  SCIP_CUTPOOL* cutpool /**< cut pool */
61  );
62 
63 /** get number of cuts in the cut pool */
64 extern
66  SCIP_CUTPOOL* cutpool /**< cut pool */
67  );
68 
69 /** get maximum number of cuts that were stored in the cut pool at the same time */
70 extern
72  SCIP_CUTPOOL* cutpool /**< cut pool */
73  );
74 
75 /** gets time in seconds used for separating cuts from the pool */
76 extern
78  SCIP_CUTPOOL* cutpool /**< cut pool */
79  );
80 
81 /** get number of times, the cut pool was separated */
82 extern
84  SCIP_CUTPOOL* cutpool /**< cut pool */
85  );
86 
87 /** get total number of cuts that were separated from the cut pool */
88 extern
90  SCIP_CUTPOOL* cutpool /**< cut pool */
91  );
92 
93 #ifdef __cplusplus
94 }
95 #endif
96 
97 #endif
struct SCIP_Row SCIP_ROW
Definition: type_lp.h:93
SCIP_Longint SCIPcutpoolGetNCalls(SCIP_CUTPOOL *cutpool)
struct SCIP_Cut SCIP_CUT
Definition: type_cutpool.h:31
struct SCIP_Cutpool SCIP_CUTPOOL
Definition: type_cutpool.h:30
SCIP_Longint SCIPcutpoolGetNCutsFound(SCIP_CUTPOOL *cutpool)
int SCIPcutpoolGetMaxNCuts(SCIP_CUTPOOL *cutpool)
SCIP_Real SCIPcutGetLPActivityQuot(SCIP_CUT *cut)
type definitions for storing cuts in a cut pool
int SCIPcutpoolGetNCuts(SCIP_CUTPOOL *cutpool)
SCIP_ROW * SCIPcutGetRow(SCIP_CUT *cut)
int SCIPcutGetAge(SCIP_CUT *cut)
SCIP_CUT ** SCIPcutpoolGetCuts(SCIP_CUTPOOL *cutpool)
SCIP_Real SCIPcutpoolGetTime(SCIP_CUTPOOL *cutpool)
#define SCIP_Real
Definition: def.h:127
#define SCIP_Longint
Definition: def.h:112
common defines and data types used in all packages of SCIP