SCIP

Solving Constraint Integer Programs

prop_pseudoobj.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 /* */
7 /* fuer Informationstechnik Berlin */
8 /* */
10 /* */
12 /* along with SCIP; see the file COPYING. If not visit scipopt.org. */
13 /* */
14 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
15
16 /**@file prop_pseudoobj.h
17  * @ingroup PROPAGATORS
18  * @brief Pseudo objective propagator
19  * @author Tobias Achterberg
20  * @author Stefan Heinz
21  *
22  * This propagator propagates the objective function using the cutoff bound and the pseudo objective value. The pseudo
23  * objective value can be seen as minimum activity of the linear objective function. Using this, this propagator checks
24  * if variables with non-zero objective coefficients can exceed the cutoff bound. If this is the case the corresponding
25  * bound can be tightened.
26  */
27
28 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
29
30 #ifndef __SCIP_PROP_PSEUDOOBJ_H__
31 #define __SCIP_PROP_PSEUDOOBJ_H__
32
33 #include "scip/def.h"
34 #include "scip/type_prop.h"
35 #include "scip/type_retcode.h"
36 #include "scip/type_scip.h"
37 #include "scip/type_var.h"
38
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42
43 /** creates the pseudo objective function propagator and includes it in SCIP
44  *
45  * @ingroup PropagatorIncludes
46  */
49  SCIP* scip /**< SCIP data structure */
50  );
51
53  *
54  * @{
55  */
56
57 /** propagates the cutoff bound for the given variables */
60  SCIP* scip, /**< SCIP data structure */
61  SCIP_PROP* prop, /**< propagator, or NULL */
62  SCIP_VAR* var, /**< variables to propagate */
63  SCIP_Real cutoffbound, /**< cutoff bound to use */
64  SCIP_Real pseudoobjval, /**< pseudo objective value to use */
65  SCIP_Bool* tightened /**< pointer to if the domain was tightened */
66  );
67
68 /** @} */
69
70 #ifdef __cplusplus
71 }
72 #endif
73
74 #endif
SCIP_EXPORT SCIP_RETCODE SCIPpropagateCutoffboundVar(SCIP *scip, SCIP_PROP *prop, SCIP_VAR *var, SCIP_Real cutoffbound, SCIP_Real pseudoobjval, SCIP_Bool *tightened)
#define SCIP_EXPORT
Definition: def.h:100
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:54
type definitions for return codes for SCIP methods
type definitions for SCIP&#39;s main datastructure
type definitions for problem variables
#define SCIP_Bool
Definition: def.h:70
type definitions for propagators
#define SCIP_Real
Definition: def.h:163
SCIP_EXPORT SCIP_RETCODE SCIPincludePropPseudoobj(SCIP *scip)
common defines and data types used in all packages of SCIP