Scippy

SCIP

Solving Constraint Integer Programs

benders_default.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-2019 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 scip.zib.de. */
13 /* */
14 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
15 
16 /**@file benders_default.h
17  * @ingroup BENDERSDECOMPOSITION
18  * @brief default Benders' decomposition plugin
19  * @author Stephen J. Maher
20  */
21 
22 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
23 
24 #ifndef __SCIP_BENDERS_DEFAULT_H__
25 #define __SCIP_BENDERS_DEFAULT_H__
26 
27 
28 #include "scip/def.h"
29 #include "scip/type_retcode.h"
30 #include "scip/type_scip.h"
31 
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35 
36 /** creates the default Benders' decomposition and includes it in SCIP
37  *
38  * @ingroup BendersIncludes
39  */
42  SCIP* scip /**< SCIP data structure */
43  );
44 
45 
46 /**@addtogroup BENDERS
47  *
48  * @{
49  */
50 
51 /** Creates a default Benders' decomposition algorithm and activates it in SCIP */
54  SCIP* scip, /**< SCIP data structure */
55  SCIP** subproblems, /**< the Benders' decomposition subproblems */
56  int nsubproblems /**< the number of subproblems in the Benders' decomposition */
57  );
58 
59 /* @} */
60 
61 #ifdef __cplusplus
62 }
63 #endif
64 
65 #endif
SCIP_EXPORT SCIP_RETCODE SCIPincludeBendersDefault(SCIP *scip)
#define SCIP_EXPORT
Definition: def.h:98
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:53
type definitions for return codes for SCIP methods
type definitions for SCIP&#39;s main datastructure
SCIP_EXPORT SCIP_RETCODE SCIPcreateBendersDefault(SCIP *scip, SCIP **subproblems, int nsubproblems)
common defines and data types used in all packages of SCIP