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-2021 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 pub_cutpool.h
17  * @ingroup PUBLICCOREAPI
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 /**@addtogroup PublicCutMethods
36  *
37  * @{
38  */
39 
40 /** gets the row of the cut */
43  SCIP_CUT* cut /**< cut */
44  );
45 
46 /** gets the age of the cut: the number of consecutive cut pool separation rounds where the cut was neither in the LP nor violated */
48 int SCIPcutGetAge(
49  SCIP_CUT* cut /**< cut */
50  );
51 
52 /** returns the ratio of LPs where the row belonging to this cut was active in an LP solution, i.e.
53  * where the age of its row has not been increased
54  *
55  * @see SCIPcutGetAge() to get the age of a cut
56  */
59  SCIP_CUT* cut /**< cut */
60  );
61 
62 /** gets array of cuts in the cut pool */
65  SCIP_CUTPOOL* cutpool /**< cut pool */
66  );
67 
68 /** get number of cuts in the cut pool */
71  SCIP_CUTPOOL* cutpool /**< cut pool */
72  );
73 
74 /** get maximum number of cuts that were stored in the cut pool at the same time */
77  SCIP_CUTPOOL* cutpool /**< cut pool */
78  );
79 
80 /** gets time in seconds used for separating cuts from the pool */
83  SCIP_CUTPOOL* cutpool /**< cut pool */
84  );
85 
86 /** get number of times, the cut pool was separated */
89  SCIP_CUTPOOL* cutpool /**< cut pool */
90  );
91 
92 /** get total number of cuts that were separated from the cut pool */
95  SCIP_CUTPOOL* cutpool /**< cut pool */
96  );
97 
98 /** @} */
99 
100 #ifdef __cplusplus
101 }
102 #endif
103 
104 #endif
SCIP_EXPORT int SCIPcutpoolGetMaxNCuts(SCIP_CUTPOOL *cutpool)
Definition: cutpool.c:1062
#define SCIP_EXPORT
Definition: def.h:100
SCIP_EXPORT int SCIPcutpoolGetNCuts(SCIP_CUTPOOL *cutpool)
Definition: cutpool.c:1052
SCIP_EXPORT SCIP_Real SCIPcutGetLPActivityQuot(SCIP_CUT *cut)
Definition: cutpool.c:397
SCIP_EXPORT SCIP_Real SCIPcutpoolGetTime(SCIP_CUTPOOL *cutpool)
Definition: cutpool.c:1072
type definitions for storing cuts in a cut pool
SCIP_EXPORT SCIP_Longint SCIPcutpoolGetNCutsFound(SCIP_CUTPOOL *cutpool)
Definition: cutpool.c:1092
SCIP_EXPORT SCIP_CUT ** SCIPcutpoolGetCuts(SCIP_CUTPOOL *cutpool)
Definition: cutpool.c:1042
SCIP_EXPORT int SCIPcutGetAge(SCIP_CUT *cut)
Definition: cutpool.c:383
#define SCIP_Real
Definition: def.h:163
SCIP_EXPORT SCIP_ROW * SCIPcutGetRow(SCIP_CUT *cut)
Definition: cutpool.c:373
#define SCIP_Longint
Definition: def.h:148
SCIP_EXPORT SCIP_Longint SCIPcutpoolGetNCalls(SCIP_CUTPOOL *cutpool)
Definition: cutpool.c:1082
common defines and data types used in all packages of SCIP