Scippy

SCIP

Solving Constraint Integer Programs

pub_sepa.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_sepa.h
17  * @ingroup PUBLICCOREAPI
18  * @brief public methods for separators
19  * @author Tobias Achterberg
20  */
21 
22 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
23 
24 #ifndef __SCIP_PUB_SEPA_H__
25 #define __SCIP_PUB_SEPA_H__
26 
27 
28 #include "scip/def.h"
29 #include "scip/type_misc.h"
30 #include "scip/type_sepa.h"
31 
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35 
36 /*--+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
37 /**@addtogroup PublicSeparatorMethods
38  *
39  * @{
40  */
41 
42 
43 /** compares two separators w. r. to their priority */
45 SCIP_DECL_SORTPTRCOMP(SCIPsepaComp);
46 
47 /** comparison method for sorting separators w.r.t. to their name */
49 SCIP_DECL_SORTPTRCOMP(SCIPsepaCompName);
50 
51 /** gets user data of separator */
54  SCIP_SEPA* sepa /**< separator */
55  );
56 
57 /** sets user data of separator; user has to free old data in advance! */
59 void SCIPsepaSetData(
60  SCIP_SEPA* sepa, /**< separator */
61  SCIP_SEPADATA* sepadata /**< new separator user data */
62  );
63 
64 /** gets name of separator */
66 const char* SCIPsepaGetName(
67  SCIP_SEPA* sepa /**< separator */
68  );
69 
70 /** gets description of separator */
72 const char* SCIPsepaGetDesc(
73  SCIP_SEPA* sepa /**< separator */
74  );
75 
76 /** gets priority of separator */
79  SCIP_SEPA* sepa /**< separator */
80  );
81 
82 /** gets frequency of separator */
84 int SCIPsepaGetFreq(
85  SCIP_SEPA* sepa /**< separator */
86  );
87 
88 /** sets frequency of separator */
90 void SCIPsepaSetFreq(
91  SCIP_SEPA* sepa, /**< separator */
92  int freq /**< new frequency of separator */
93  );
94 
95 /** get maximal bound distance at which the separator is called */
98  SCIP_SEPA* sepa /**< separator */
99  );
100 
101 /** does the separator use a secondary SCIP instance? */
104  SCIP_SEPA* sepa /**< separator */
105  );
106 
107 /** gets time in seconds used in this separator for setting up for next stages */
110  SCIP_SEPA* sepa /**< separator */
111  );
112 
113 /** gets time in seconds used in this separator */
116  SCIP_SEPA* sepa /**< separator */
117  );
118 
119 /** gets the total number of times, the separator was called */
122  SCIP_SEPA* sepa /**< separator */
123  );
124 
125 /** gets the number of times, the separator was called at the current node */
128  SCIP_SEPA* sepa /**< separator */
129  );
130 
131 /** gets total number of times, the separator detected a cutoff */
134  SCIP_SEPA* sepa /**< separator */
135  );
136 
137 /** gets the total number of cutting planes found by this separator */
140  SCIP_SEPA* sepa /**< separator */
141  );
142 
143 /** gets the total number of cutting planes applied to lp */
146  SCIP_SEPA* sepa /**< separator */
147  );
148 
149 /** gets the number of cutting planes found by this separator at the current node */
152  SCIP_SEPA* sepa /**< separator */
153  );
154 
155 /** gets total number of additional constraints added by this separator */
158  SCIP_SEPA* sepa /**< separator */
159  );
160 
161 /** gets total number of domain reductions found by this separator */
164  SCIP_SEPA* sepa /**< separator */
165  );
166 
167 /** should separator be delayed, if other separators found cuts? */
170  SCIP_SEPA* sepa /**< separator */
171  );
172 
173 /** was separation of the LP solution delayed at the last call? */
176  SCIP_SEPA* sepa /**< separator */
177  );
178 
179 /** was separation of the primal solution delayed at the last call? */
182  SCIP_SEPA* sepa /**< separator */
183  );
184 
185 /** is separator initialized? */
188  SCIP_SEPA* sepa /**< separator */
189  );
190 
191 /** @} */
192 
193 #ifdef __cplusplus
194 }
195 #endif
196 
197 #endif
SCIP_EXPORT SCIP_Real SCIPsepaGetSetupTime(SCIP_SEPA *sepa)
Definition: sepa.c:794
SCIP_EXPORT int SCIPsepaGetFreq(SCIP_SEPA *sepa)
Definition: sepa.c:741
SCIP_EXPORT void SCIPsepaSetFreq(SCIP_SEPA *sepa, int freq)
Definition: sepa.c:751
type definitions for miscellaneous datastructures
SCIP_EXPORT SCIP_Real SCIPsepaGetTime(SCIP_SEPA *sepa)
Definition: sepa.c:804
SCIP_EXPORT SCIP_DECL_SORTPTRCOMP(SCIPsepaComp)
Definition: sepa.c:43
SCIP_EXPORT SCIP_Longint SCIPsepaGetNCutsFound(SCIP_SEPA *sepa)
Definition: sepa.c:844
#define SCIP_EXPORT
Definition: def.h:100
SCIP_EXPORT SCIP_Bool SCIPsepaUsesSubscip(SCIP_SEPA *sepa)
Definition: sepa.c:772
SCIP_EXPORT int SCIPsepaGetPriority(SCIP_SEPA *sepa)
Definition: sepa.c:717
SCIP_EXPORT SCIP_Longint SCIPsepaGetNCutsFoundAtNode(SCIP_SEPA *sepa)
Definition: sepa.c:894
SCIP_EXPORT SCIP_Bool SCIPsepaIsInitialized(SCIP_SEPA *sepa)
Definition: sepa.c:954
SCIP_EXPORT SCIP_Bool SCIPsepaIsDelayed(SCIP_SEPA *sepa)
Definition: sepa.c:924
SCIP_EXPORT SCIP_Bool SCIPsepaWasSolDelayed(SCIP_SEPA *sepa)
Definition: sepa.c:944
SCIP_EXPORT SCIP_SEPADATA * SCIPsepaGetData(SCIP_SEPA *sepa)
Definition: sepa.c:608
SCIP_EXPORT const char * SCIPsepaGetName(SCIP_SEPA *sepa)
Definition: sepa.c:697
SCIP_EXPORT SCIP_Real SCIPsepaGetMaxbounddist(SCIP_SEPA *sepa)
Definition: sepa.c:762
SCIP_EXPORT SCIP_Longint SCIPsepaGetNCutsApplied(SCIP_SEPA *sepa)
Definition: sepa.c:854
#define SCIP_Bool
Definition: def.h:70
SCIP_EXPORT SCIP_Longint SCIPsepaGetNDomredsFound(SCIP_SEPA *sepa)
Definition: sepa.c:914
SCIP_EXPORT SCIP_Bool SCIPsepaWasLPDelayed(SCIP_SEPA *sepa)
Definition: sepa.c:934
SCIP_EXPORT SCIP_Longint SCIPsepaGetNConssFound(SCIP_SEPA *sepa)
Definition: sepa.c:904
SCIP_EXPORT SCIP_Longint SCIPsepaGetNCutoffs(SCIP_SEPA *sepa)
Definition: sepa.c:834
type definitions for separators
#define SCIP_Real
Definition: def.h:163
#define SCIP_Longint
Definition: def.h:148
SCIP_EXPORT void SCIPsepaSetData(SCIP_SEPA *sepa, SCIP_SEPADATA *sepadata)
Definition: sepa.c:618
SCIP_EXPORT const char * SCIPsepaGetDesc(SCIP_SEPA *sepa)
Definition: sepa.c:707
common defines and data types used in all packages of SCIP
SCIP_EXPORT SCIP_Longint SCIPsepaGetNCalls(SCIP_SEPA *sepa)
Definition: sepa.c:814
SCIP_EXPORT int SCIPsepaGetNCallsAtNode(SCIP_SEPA *sepa)
Definition: sepa.c:824
struct SCIP_SepaData SCIP_SEPADATA
Definition: type_sepa.h:43