Scippy

SCIP

Solving Constraint Integer Programs

heur_padm.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 heur_padm.h
26  * @ingroup PRIMALHEURISTICS
27  * @brief PADM primal heuristic based on ideas published in the paper
28  * "A Decomposition Heuristic for Mixed-Integer Supply Chain Problems"
29  * by Martin Schmidt, Lars Schewe, and Dieter Weninger
30  * @author Dieter Weninger
31  * @author Katrin Halbig
32  *
33  * The penalty alternating direction method (PADM) heuristic is a construction heuristic which additionally needs a
34  * user decomposition with linking variables only.
35  *
36  * PADM splits the problem into several sub-SCIPs according to the decomposition, whereby the linking variables get
37  * copied and the difference is penalized. Then the sub-SCIPs are solved on an alternating basis until they arrive at
38  * the same values of the linking variables (ADM-loop). If they don't reconcile after a couple of iterations,
39  * the penalty parameters are increased (penalty-loop) and the sub-SCIPs are solved again on an alternating basis.
40  */
41 
42 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
43 
44 #ifndef __SCIP_HEUR_PADM_H__
45 #define __SCIP_HEUR_PADM_H__
46 
47 #include "scip/def.h"
48 #include "scip/type_retcode.h"
49 #include "scip/type_scip.h"
50 
51 #ifdef __cplusplus
52 extern "C" {
53 #endif
54 
55 /** creates the PADM primal heuristic and includes it in SCIP
56  *
57  * @ingroup PrimalHeuristicIncludes
58  */
59 SCIP_EXPORT
61  SCIP* scip /**< SCIP data structure */
62  );
63 
64 #ifdef __cplusplus
65 }
66 #endif
67 
68 #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
common defines and data types used in all packages of SCIP
SCIP_RETCODE SCIPincludeHeurPADM(SCIP *scip)
Definition: heur_padm.c:2037