1    	/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2    	/*                                                                           */
3    	/*                  This file is part of the program and library             */
4    	/*         SCIP --- Solving Constraint Integer Programs                      */
5    	/*                                                                           */
6    	/*  Copyright (c) 2002-2023 Zuse Institute Berlin (ZIB)                      */
7    	/*                                                                           */
8    	/*  Licensed under the Apache License, Version 2.0 (the "License");          */
9    	/*  you may not use this file except in compliance with the License.         */
10   	/*  You may obtain a copy of the License at                                  */
11   	/*                                                                           */
12   	/*      http://www.apache.org/licenses/LICENSE-2.0                           */
13   	/*                                                                           */
14   	/*  Unless required by applicable law or agreed to in writing, software      */
15   	/*  distributed under the License is distributed on an "AS IS" BASIS,        */
16   	/*  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. */
17   	/*  See the License for the specific language governing permissions and      */
18   	/*  limitations under the License.                                           */
19   	/*                                                                           */
20   	/*  You should have received a copy of the Apache-2.0 license                */
21   	/*  along with SCIP; see the file LICENSE. If not visit scipopt.org.         */
22   	/*                                                                           */
23   	/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
24   	
25   	/**@file   pub_sepa.h
26   	 * @ingroup PUBLICCOREAPI
27   	 * @brief  public methods for separators
28   	 * @author Tobias Achterberg
29   	 */
30   	
31   	/*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
32   	
33   	#ifndef __SCIP_PUB_SEPA_H__
34   	#define __SCIP_PUB_SEPA_H__
35   	
36   	
37   	#include "scip/def.h"
38   	#include "scip/type_misc.h"
39   	#include "scip/type_sepa.h"
40   	
41   	#ifdef __cplusplus
42   	extern "C" {
43   	#endif
44   	
45   	/*--+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
46   	/**@addtogroup PublicSeparatorMethods
47   	 *
48   	 * @{
49   	 */
50   	
51   	
52   	/** compares two separators w. r. to their priority */
53   	SCIP_EXPORT
54   	SCIP_DECL_SORTPTRCOMP(SCIPsepaComp);
55   	
56   	/** comparison method for sorting separators w.r.t. to their name */
57   	SCIP_EXPORT
58   	SCIP_DECL_SORTPTRCOMP(SCIPsepaCompName);
59   	
60   	/** gets user data of separator */
61   	SCIP_EXPORT
62   	SCIP_SEPADATA* SCIPsepaGetData(
63   	   SCIP_SEPA*            sepa                /**< separator */
64   	   );
65   	
66   	/** sets user data of separator; user has to free old data in advance! */
67   	SCIP_EXPORT
68   	void SCIPsepaSetData(
69   	   SCIP_SEPA*            sepa,               /**< separator */
70   	   SCIP_SEPADATA*        sepadata            /**< new separator user data */
71   	   );
72   	
73   	/** gets name of separator */
74   	SCIP_EXPORT
75   	const char* SCIPsepaGetName(
76   	   SCIP_SEPA*            sepa                /**< separator */
77   	   );
78   	
79   	/** gets description of separator */
80   	SCIP_EXPORT
81   	const char* SCIPsepaGetDesc(
82   	   SCIP_SEPA*            sepa                /**< separator */
83   	   );
84   	
85   	/** gets priority of separator */
86   	SCIP_EXPORT
87   	int SCIPsepaGetPriority(
88   	   SCIP_SEPA*            sepa                /**< separator */
89   	   );
90   	
91   	/** gets frequency of separator */
92   	SCIP_EXPORT
93   	int SCIPsepaGetFreq(
94   	   SCIP_SEPA*            sepa                /**< separator */
95   	   );
96   	
97   	/** sets frequency of separator */
98   	SCIP_EXPORT
99   	void SCIPsepaSetFreq(
100  	   SCIP_SEPA*            sepa,               /**< separator */
101  	   int                   freq                /**< new frequency of separator */
102  	   );
103  	
104  	/** get maximal bound distance at which the separator is called */
105  	SCIP_EXPORT
106  	SCIP_Real SCIPsepaGetMaxbounddist(
107  	   SCIP_SEPA*            sepa                /**< separator */
108  	   );
109  	
110  	/** does the separator use a secondary SCIP instance? */
111  	SCIP_EXPORT
112  	SCIP_Bool SCIPsepaUsesSubscip(
113  	   SCIP_SEPA*            sepa                /**< separator */
114  	   );
115  	
116  	/** gets time in seconds used in this separator for setting up for next stages */
117  	SCIP_EXPORT
118  	SCIP_Real SCIPsepaGetSetupTime(
119  	   SCIP_SEPA*            sepa                /**< separator */
120  	   );
121  	
122  	/** gets time in seconds used in this separator */
123  	SCIP_EXPORT
124  	SCIP_Real SCIPsepaGetTime(
125  	   SCIP_SEPA*            sepa                /**< separator */
126  	   );
127  	
128  	/** gets the total number of times the separator was called */
129  	SCIP_EXPORT
130  	SCIP_Longint SCIPsepaGetNCalls(
131  	   SCIP_SEPA*            sepa                /**< separator */
132  	   );
133  	
134  	/** gets the total number of times the separator was called at the root */
135  	SCIP_EXPORT
136  	SCIP_Longint SCIPsepaGetNRootCalls(
137  	   SCIP_SEPA*            sepa                /**< separator */
138  	   );
139  	
140  	/** gets the number of times, the separator was called at the current node */
141  	SCIP_EXPORT
142  	int SCIPsepaGetNCallsAtNode(
143  	   SCIP_SEPA*            sepa                /**< separator */
144  	   );
145  	
146  	/** gets total number of times, the separator detected a cutoff */
147  	SCIP_EXPORT
148  	SCIP_Longint SCIPsepaGetNCutoffs(
149  	   SCIP_SEPA*            sepa                /**< separator */
150  	   );
151  	
152  	/** gets the total number of cutting planes added from the separator to the cut pool
153  	 *  and to the sepastore directly */
154  	SCIP_EXPORT
155  	SCIP_Longint SCIPsepaGetNCutsFound(
156  	   SCIP_SEPA*            sepa                /**< separator */
157  	   );
158  	
159  	/** gets the total number of cutting planes added from the separator to the sepastore;
160  	 *  equal to the sum of added cuts directly and via the pool. */
161  	SCIP_EXPORT
162  	SCIP_Longint SCIPsepaGetNCutsAdded(
163  	   SCIP_SEPA*            sepa                /**< separator */
164  	   );
165  	
166  	/** gets the number of cutting planes from the separator added from the cut pool */
167  	SCIP_EXPORT
168  	SCIP_Longint SCIPsepaGetNCutsAddedViaPool(
169  	   SCIP_SEPA*            sepa                /**< separator */
170  	   );
171  	
172  	/** gets the number of cutting planes from the separator added directly to the sepastore */
173  	SCIP_EXPORT
174  	SCIP_Longint SCIPsepaGetNCutsAddedDirect(
175  	   SCIP_SEPA*            sepa                /**< separator */
176  	   );
177  	
178  	/** gets the total number of cutting planes from the separator applied to the LP */
179  	SCIP_EXPORT
180  	SCIP_Longint SCIPsepaGetNCutsApplied(
181  	   SCIP_SEPA*            sepa                /**< separator */
182  	   );
183  	
184  	/** gets the total number of cutting planes from the separator applied to the LP from the cutpool */
185  	SCIP_EXPORT
186  	SCIP_Longint SCIPsepaGetNCutsAppliedViaPool(
187  	   SCIP_SEPA*            sepa                /**< separator */
188  	   );
189  	
190  	/** gets the total number of cutting planes from the separator applied directly to the LP */
191  	SCIP_EXPORT
192  	SCIP_Longint SCIPsepaGetNCutsAppliedDirect(
193  	   SCIP_SEPA*            sepa                /**< separator */
194  	   );
195  	
196  	/** gets the number of cutting planes found by this separator at the current node */
197  	SCIP_EXPORT
198  	SCIP_Longint SCIPsepaGetNCutsFoundAtNode(
199  	   SCIP_SEPA*            sepa                /**< separator */
200  	   );
201  	
202  	/** gets total number of additional constraints added by this separator */
203  	SCIP_EXPORT
204  	SCIP_Longint SCIPsepaGetNConssFound(
205  	   SCIP_SEPA*            sepa                /**< separator */
206  	   );
207  	
208  	/** gets total number of domain reductions found by this separator */
209  	SCIP_EXPORT
210  	SCIP_Longint SCIPsepaGetNDomredsFound(
211  	   SCIP_SEPA*            sepa                /**< separator */
212  	   );
213  	
214  	/** should separator be delayed, if other separators found cuts? */
215  	SCIP_EXPORT
216  	SCIP_Bool SCIPsepaIsDelayed(
217  	   SCIP_SEPA*            sepa                /**< separator */
218  	   );
219  	
220  	/** was separation of the LP solution delayed at the last call? */
221  	SCIP_EXPORT
222  	SCIP_Bool SCIPsepaWasLPDelayed(
223  	   SCIP_SEPA*            sepa                /**< separator */
224  	   );
225  	
226  	/** was separation of the primal solution delayed at the last call? */
227  	SCIP_EXPORT
228  	SCIP_Bool SCIPsepaWasSolDelayed(
229  	   SCIP_SEPA*            sepa                /**< separator */
230  	   );
231  	
232  	/** is separator initialized? */
233  	SCIP_EXPORT
234  	SCIP_Bool SCIPsepaIsInitialized(
235  	   SCIP_SEPA*            sepa                /**< separator */
236  	   );
237  	
238  	/** gets whether separator is a parent separator */
239  	SCIP_EXPORT
240  	SCIP_Bool SCIPsepaIsParentsepa(
241  	   SCIP_SEPA*            sepa                /**< separator */
242  	   );
243  	
244  	/** gets parent separator (or NULL) */
245  	SCIP_EXPORT
246  	SCIP_SEPA* SCIPsepaGetParentsepa(
247  	   SCIP_SEPA*            sepa                /**< separator */
248  	   );
249  	
250  	/** @} */
251  	
252  	#ifdef __cplusplus
253  	}
254  	#endif
255  	
256  	#endif
257