Scippy

SCIP

Solving Constraint Integer Programs

cons_benderslp.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 2002-2022 Zuse Institute Berlin */
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 cons_benderslp.h
26  * @ingroup CONSHDLRS
27  * @brief constraint handler for benderslp decomposition
28  * @author Stephen J. Maher
29  */
30 
31 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
32 
33 #ifndef __SCIP_CONS_BENDERSLP_H__
34 #define __SCIP_CONS_BENDERSLP_H__
35 
36 
37 #include "scip/def.h"
38 #include "scip/type_retcode.h"
39 #include "scip/type_scip.h"
40 
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44 
45 /** creates the handler for benderslp constraints and includes it in SCIP
46  *
47  * @ingroup ConshdlrIncludes
48  * */
49 SCIP_EXPORT
51  SCIP* scip /**< SCIP data structure */
52  );
53 
54 /**@addtogroup CONSHDLRS
55  *
56  * @{
57  *
58  * @name Benders Constraints
59  *
60  * Two constraint handlers are implemented for the generation of Benders' decomposition cuts. When included in a
61  * problem, the Benders' decomposition constraint handlers generate cuts during the enforcement of LP and relaxation
62  * solutions. Additionally, Benders' decomposition cuts can be generated when checking the feasibility of solutions with
63  * respect to the subproblem constraints.
64  *
65  * This constraint handler has an enforcement priority that is greater than the integer constraint handler. This means
66  * that all LP solutions will be first checked for feasibility with respect to the Benders' decomposition second stage
67  * constraints before performing an integrality check. This is part of a multi-phase approach for solving mixed integer
68  * programs by Benders' decomposition.
69  *
70  * A parameter is available to control the depth at which the non-integer LP solution are enforced by solving the
71  * Benders' decomposition subproblems. This parameter is set to 0 by default, indicating that non-integer LP solutions
72  * are enforced only at the root node.
73  *
74  * @{
75  */
76 
77 /** @} */
78 
79 /** @} */
80 
81 #ifdef __cplusplus
82 }
83 #endif
84 
85 #endif
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:63
type definitions for return codes for SCIP methods
type definitions for SCIP&#39;s main datastructure
SCIP_RETCODE SCIPincludeConshdlrBenderslp(SCIP *scip)
common defines and data types used in all packages of SCIP