1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/* */
/* This file is part of the program and library */
/* SCIP --- Solving Constraint Integer Programs */
/* */
/* Copyright 2002-2022 Zuse Institute Berlin */
/* */
/* Licensed under the Apache License, Version 2.0 (the "License"); */
/* you may not use this file except in compliance with the License. */
/* You may obtain a copy of the License at */
/* */
/* http://www.apache.org/licenses/LICENSE-2.0 */
/* */
/* Unless required by applicable law or agreed to in writing, software */
/* distributed under the License is distributed on an "AS IS" BASIS, */
/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. */
/* See the License for the specific language governing permissions and */
/* limitations under the License. */
/* */
/* You should have received a copy of the Apache-2.0 license */
/* along with SCIP; see the file LICENSE. If not visit scipopt.org. */
/* */
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/**@file pub_cutpool.h
* @ingroup PUBLICCOREAPI
* @brief public methods for storing cuts in a cut pool
* @author Tobias Achterberg
*/
/*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
#ifndef __SCIP_PUB_CUTPOOL_H__
#define __SCIP_PUB_CUTPOOL_H__
#include "scip/def.h"
#include "scip/type_cutpool.h"
#include "scip/type_lp.h"
#ifdef __cplusplus
extern "C" {
#endif
/**@addtogroup PublicCutMethods
*
* @{
*/
/** gets the row of the cut */
SCIP_EXPORT
SCIP_ROW* SCIPcutGetRow(
SCIP_CUT* cut /**< cut */
);
/** gets the age of the cut: the number of consecutive cut pool separation rounds where the cut was neither in the LP nor violated */
SCIP_EXPORT
int SCIPcutGetAge(
SCIP_CUT* cut /**< cut */
);
/** returns the ratio of LPs where the row belonging to this cut was active in an LP solution, i.e.
* where the age of its row has not been increased
*
* @see SCIPcutGetAge() to get the age of a cut
*/
SCIP_EXPORT
SCIP_Real SCIPcutGetLPActivityQuot(
SCIP_CUT* cut /**< cut */
);
/** gets array of cuts in the cut pool */
SCIP_EXPORT
SCIP_CUT** SCIPcutpoolGetCuts(
SCIP_CUTPOOL* cutpool /**< cut pool */
);
/** get number of cuts in the cut pool */
SCIP_EXPORT
int SCIPcutpoolGetNCuts(
SCIP_CUTPOOL* cutpool /**< cut pool */
);
/** get maximum number of cuts that were stored in the cut pool at the same time */
SCIP_EXPORT
SCIP_Longint SCIPcutpoolGetMaxNCuts(
SCIP_CUTPOOL* cutpool /**< cut pool */
);
/** gets time in seconds used for separating cuts from the pool */
SCIP_EXPORT
SCIP_Real SCIPcutpoolGetTime(
SCIP_CUTPOOL* cutpool /**< cut pool */
);
/** get number of times the cut pool was separated */
SCIP_EXPORT
SCIP_Longint SCIPcutpoolGetNCalls(
SCIP_CUTPOOL* cutpool /**< cut pool */
);
/** get number of times the cut pool was separated at the root */
SCIP_EXPORT
SCIP_Longint SCIPcutpoolGetNRootCalls(
SCIP_CUTPOOL* cutpool /**< cut pool */
);
/** get total number of cuts that were separated from the cut pool */
SCIP_EXPORT
SCIP_Longint SCIPcutpoolGetNCutsFound(
SCIP_CUTPOOL* cutpool /**< cut pool */
);
/** get total number of cuts that were added from the cut pool to sepastore */
SCIP_EXPORT
SCIP_Longint SCIPcutpoolGetNCutsAdded(
SCIP_CUTPOOL* cutpool /**< cut pool */
);
/** @} */
#ifdef __cplusplus
}
#endif
#endif