Scippy

SCIP

Solving Constraint Integer Programs

cons_optcumulative.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 cons_optcumulative.h
17  * @brief constraint handler for cumulative constraints with optional activities
18  * @author Chris Beck
19  * @author Stefan Heinz
20  */
21 
22 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
23 
24 #ifndef __SCIP_CONS_OPTCUMULATIVE_H__
25 #define __SCIP_CONS_OPTCUMULATIVE_H__
26 
27 
28 #include "scip/scip.h"
29 
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33 
34 /** creates the handler for cumulative constraints with optional activities and includes it in SCIP */
36  SCIP* scip /**< SCIP data structure */
37  );
38 
39 /** creates and captures a optcumulative constraint */
41  SCIP* scip, /**< SCIP data structure */
42  SCIP_CONS** cons, /**< pointer to hold the created constraint */
43  const char* name, /**< name of constraint */
44  int nvars, /**< number of variables (jobs) */
45  SCIP_VAR** vars, /**< array of integer variable which corresponds to starting times for a job */
46  SCIP_VAR** binvars, /**< array of variable representing if the job has to be processed on this machine */
47  int* durations, /**< array containing corresponding durations */
48  int* demands, /**< array containing corresponding demands */
49  int capacity, /**< available cumulative capacity */
50  SCIP_Bool initial, /**< should the LP relaxation of constraint be in the initial LP?
51  * Usually set to TRUE. Set to FALSE for 'lazy constraints'. */
52  SCIP_Bool separate, /**< should the constraint be separated during LP processing?
53  * Usually set to TRUE. */
54  SCIP_Bool enforce, /**< should the constraint be enforced during node processing?
55  * TRUE for model constraints, FALSE for additional, redundant constraints. */
56  SCIP_Bool check, /**< should the constraint be checked for feasibility?
57  * TRUE for model constraints, FALSE for additional, redundant constraints. */
58  SCIP_Bool propagate, /**< should the constraint be propagated during node processing?
59  * Usually set to TRUE. */
60  SCIP_Bool local, /**< is constraint only valid locally?
61  * Usually set to FALSE. Has to be set to TRUE, e.g., for branching constraints. */
62  SCIP_Bool modifiable, /**< is constraint modifiable (subject to column generation)?
63  * Usually set to FALSE. In column generation applications, set to TRUE if pricing
64  * adds coefficients to this constraint. */
65  SCIP_Bool dynamic, /**< is constraint subject to aging?
66  * Usually set to FALSE. Set to TRUE for own cuts which
67  * are seperated as constraints. */
68  SCIP_Bool removable, /**< should the relaxation be removed from the LP due to aging or cleanup?
69  * Usually set to FALSE. Set to TRUE for 'lazy constraints' and 'user cuts'. */
70  SCIP_Bool stickingatnode /**< should the constraint always be kept at the node where it was added, even
71  * if it may be moved to a more global node?
72  * Usually set to FALSE. Set to TRUE to for constraints that represent node data. */
73  );
74 
75 #ifdef __cplusplus
76 }
77 #endif
78 
79 #endif
SCIP_RETCODE SCIPincludeConshdlrOptcumulative(SCIP *scip)
SCIP_RETCODE SCIPcreateConsOptcumulative(SCIP *scip, SCIP_CONS **cons, const char *name, int nvars, SCIP_VAR **vars, SCIP_VAR **binvars, int *durations, int *demands, int capacity, SCIP_Bool initial, SCIP_Bool separate, SCIP_Bool enforce, SCIP_Bool check, SCIP_Bool propagate, SCIP_Bool local, SCIP_Bool modifiable, SCIP_Bool dynamic, SCIP_Bool removable, SCIP_Bool stickingatnode)
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:53
#define SCIP_Bool
Definition: def.h:70
SCIP callable library.