Scippy

SCIP

Solving Constraint Integer Programs

struct_benderscut.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 struct_benderscut.h
26  * @ingroup INTERNALAPI
27  * @brief datastructures for Benders' decomposition cuts techniques
28  * @author Stephen J. Maher
29  */
30 
31 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
32 
33 #ifndef __SCIP_STRUCT_BENDERSCUT_H__
34 #define __SCIP_STRUCT_BENDERSCUT_H__
35 
36 
37 #include "scip/def.h"
38 #include "scip/type_clock.h"
39 #include "scip/type_benderscut.h"
40 
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44 
45 /** Benders' decomposition cuts data */
47 {
48  SCIP_Longint ncalls; /**< number of times, this Benders' decomposition cut was called */
49  SCIP_Longint nfound; /**< number of cuts found so far by this Benders' decomposition cut */
50  char* name; /**< name of the Benders' decomposition cut */
51  char* desc; /**< description of the Benders' decomposition cut */
52  SCIP_DECL_BENDERSCUTCOPY((*benderscutcopy));/**< copy method of the Benders' decomposition cut or NULL if you don't want to copy your plugin into sub-SCIPs */
53  SCIP_DECL_BENDERSCUTFREE((*benderscutfree));/**< destructor of the Benders' decomposition cut */
54  SCIP_DECL_BENDERSCUTINIT((*benderscutinit));/**< initialize the Benders' decomposition cut */
55  SCIP_DECL_BENDERSCUTEXIT((*benderscutexit));/**< deinitialize the Benders' decomposition cut */
56  SCIP_DECL_BENDERSCUTINITSOL((*benderscutinitsol));/**< solving process initialization method of the Benders' decomposition cut */
57  SCIP_DECL_BENDERSCUTEXITSOL((*benderscutexitsol));/**< solving process deinitialization method of the Benders' decomposition cut */
58  SCIP_DECL_BENDERSCUTEXEC((*benderscutexec));/**< execution method of the Benders' decomposition cut */
59  SCIP_BENDERSCUTDATA* benderscutdata; /**< Benders' decomposition cuts local data */
60  SCIP_CLOCK* setuptime; /**< time spend for setting up the Benders' decomposition cut plugin */
61  SCIP_CLOCK* benderscutclock; /**< the execution time of the Benders' decomposition cut plugin */
62  int priority; /**< priority of the Benders' decomposition cuts */
63  SCIP_Bool islpcut; /**< does this Benders' cut use LP information? */
64  SCIP_Bool initialized; /**< has the Benders' decomposition cut been initialized? */
65 
66  /* additional Benders' decomposition cuts parameters */
67  SCIP_Bool enabled; /**< is this Benders' decomposition cut enabled? */
68 };
69 
70 #ifdef __cplusplus
71 }
72 #endif
73 
74 #endif
struct SCIP_BenderscutData SCIP_BENDERSCUTDATA
SCIP_DECL_BENDERSCUTINIT((*benderscutinit))
SCIP_DECL_BENDERSCUTEXITSOL((*benderscutexitsol))
SCIP_Longint ncalls
SCIP_DECL_BENDERSCUTEXEC((*benderscutexec))
SCIP_CLOCK * setuptime
SCIP_DECL_BENDERSCUTCOPY((*benderscutcopy))
#define SCIP_Bool
Definition: def.h:93
SCIP_DECL_BENDERSCUTFREE((*benderscutfree))
SCIP_CLOCK * benderscutclock
type definitions for clocks and timing issues
type definitions for Benders&#39; decomposition cut
SCIP_Longint nfound
#define SCIP_Longint
Definition: def.h:171
SCIP_BENDERSCUTDATA * benderscutdata
SCIP_DECL_BENDERSCUTINITSOL((*benderscutinitsol))
common defines and data types used in all packages of SCIP
SCIP_DECL_BENDERSCUTEXIT((*benderscutexit))