Scippy

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 /* */
6 /* Copyright 2002-2022 Zuse Institute Berlin */
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 prop_pseudoobj.h
26  * @ingroup PROPAGATORS
27  * @brief Pseudo objective propagator
28  * @author Tobias Achterberg
29  * @author Stefan Heinz
30  *
31  * This propagator propagates the objective function using the cutoff bound and the pseudo objective value. The pseudo
32  * objective value can be seen as minimum activity of the linear objective function. Using this, this propagator checks
33  * if variables with non-zero objective coefficients can exceed the cutoff bound. If this is the case the corresponding
34  * bound can be tightened.
35  */
36 
37 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
38 
39 #ifndef __SCIP_PROP_PSEUDOOBJ_H__
40 #define __SCIP_PROP_PSEUDOOBJ_H__
41 
42 #include "scip/def.h"
43 #include "scip/type_prop.h"
44 #include "scip/type_retcode.h"
45 #include "scip/type_scip.h"
46 #include "scip/type_var.h"
47 
48 #ifdef __cplusplus
49 extern "C" {
50 #endif
51 
52 /** creates the pseudo objective function propagator and includes it in SCIP
53  *
54  * @ingroup PropagatorIncludes
55  */
56 SCIP_EXPORT
58  SCIP* scip /**< SCIP data structure */
59  );
60 
61 /**@addtogroup PROPAGATORS
62  *
63  * @{
64  */
65 
66 /** propagates the cutoff bound for the given variables */
67 SCIP_EXPORT
69  SCIP* scip, /**< SCIP data structure */
70  SCIP_PROP* prop, /**< propagator, or NULL */
71  SCIP_VAR* var, /**< variables to propagate */
72  SCIP_Real cutoffbound, /**< cutoff bound to use */
73  SCIP_Real pseudoobjval, /**< pseudo objective value to use */
74  SCIP_Bool* tightened /**< pointer to if the domain was tightened */
75  );
76 
77 /** @} */
78 
79 #ifdef __cplusplus
80 }
81 #endif
82 
83 #endif
enum SCIP_Retcode SCIP_RETCODE
Definition: type_retcode.h:63
type definitions for return codes for SCIP methods
SCIP_RETCODE SCIPpropagateCutoffboundVar(SCIP *scip, SCIP_PROP *prop, SCIP_VAR *var, SCIP_Real cutoffbound, SCIP_Real pseudoobjval, SCIP_Bool *tightened)
type definitions for SCIP&#39;s main datastructure
type definitions for problem variables
#define SCIP_Bool
Definition: def.h:93
type definitions for propagators
SCIP_RETCODE SCIPincludePropPseudoobj(SCIP *scip)
#define SCIP_Real
Definition: def.h:186
common defines and data types used in all packages of SCIP