Scippy

SCIP

Solving Constraint Integer Programs

sepa_closecuts.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-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 sepa_closecuts.h
26  * @ingroup SEPARATORS
27  * @brief closecuts meta separator
28  * @author Marc Pfetsch
29  *
30  * This separator generates a convex combination of the current LP solution and either the best
31  * primal feasible solution or an interior point of the LP relaxation. If the convex combination is
32  * proper, the new point is closer to the convex hull of the feasible points. The separator then
33  * calls all other separators to separate this point. The idea is that in this way possibly "deeper"
34  * cuts are generated. Note, however, that the new point is not a basic solution, i.e., separators
35  * relying basis information, e.g., Gomory cuts, will not work.
36  */
37 
38 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
39 
40 #ifndef __SCIP_SEPA_CLOSECUTS_H__
41 #define __SCIP_SEPA_CLOSECUTS_H__
42 
43 
44 #include "scip/def.h"
45 #include "scip/type_retcode.h"
46 #include "scip/type_scip.h"
47 #include "scip/type_sol.h"
48 
49 #ifdef __cplusplus
50 extern "C" {
51 #endif
52 
53 /** creates the closecuts separator and includes it in SCIP
54  *
55  * @ingroup SeparatorIncludes
56  */
57 SCIP_EXPORT
59  SCIP* scip /**< SCIP data structure */
60  );
61 
62 /**@addtogroup SEPARATORS
63  *
64  * @{
65  */
66 
67 /** sets point to be used as base point for computing the point to be separated
68  *
69  * The point is only stored if separation of relative interior points is used. The solution is copied.
70  */
71 SCIP_EXPORT
73  SCIP* scip, /**< SCIP data structure */
74  SCIP_SOL* sol /**< base point solution */
75  );
76 
77 /** @} */
78 
79 #ifdef __cplusplus
80 }
81 #endif
82 
83 #endif
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:63
SCIP_RETCODE SCIPsetBasePointClosecuts(SCIP *scip, SCIP_SOL *sol)
type definitions for return codes for SCIP methods
type definitions for SCIP&#39;s main datastructure
type definitions for storing primal CIP solutions
SCIP_RETCODE SCIPincludeSepaClosecuts(SCIP *scip)
common defines and data types used in all packages of SCIP