Scippy

SCIP

Solving Constraint Integer Programs

pub_pricer.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-2016 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 email to scip@zib.de. */
13 /* */
14 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
15 
16 /**@file pub_pricer.h
17  * @ingroup PUBLICMETHODS
18  * @brief public methods for variable pricers
19  * @author Tobias Achterberg
20  */
21 
22 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
23 
24 #ifndef __SCIP_PUB_PRICER_H__
25 #define __SCIP_PUB_PRICER_H__
26 
27 
28 #include "scip/def.h"
29 #include "scip/type_misc.h"
30 #include "scip/type_pricer.h"
31 
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35 
36 /** compares two pricers w. r. to their priority */
37 extern
38 SCIP_DECL_SORTPTRCOMP(SCIPpricerComp);
39 
40 /** comparison method for sorting pricers w.r.t. to their name */
41 extern
42 SCIP_DECL_SORTPTRCOMP(SCIPpricerCompName);
43 
44 /** gets user data of variable pricer */
45 extern
47  SCIP_PRICER* pricer /**< variable pricer */
48  );
49 
50 /** sets user data of variable pricer; user has to free old data in advance! */
51 extern
53  SCIP_PRICER* pricer, /**< variable pricer */
54  SCIP_PRICERDATA* pricerdata /**< new variable pricer user data */
55  );
56 
57 /** gets name of variable pricer */
58 extern
59 const char* SCIPpricerGetName(
60  SCIP_PRICER* pricer /**< variable pricer */
61  );
62 
63 /** gets description of variable pricer */
64 extern
65 const char* SCIPpricerGetDesc(
66  SCIP_PRICER* pricer /**< variable pricer */
67  );
68 
69 /** gets priority of variable pricer */
70 extern
72  SCIP_PRICER* pricer /**< variable pricer */
73  );
74 
75 /** gets the number of times, the pricer was called and tried to find a variable with negative reduced costs */
76 extern
78  SCIP_PRICER* pricer /**< variable pricer */
79  );
80 
81 /** gets the number of variables with negative reduced costs found by this pricer */
82 extern
84  SCIP_PRICER* pricer /**< variable pricer */
85  );
86 
87 /** gets time in seconds used in this pricer for setting up for next stages */
88 extern
90  SCIP_PRICER* pricer /**< variable pricer */
91  );
92 
93 /** gets time in seconds used in this pricer */
94 extern
96  SCIP_PRICER* pricer /**< variable pricer */
97  );
98 
99 /** returns whether the given pricer is in use in the current problem */
100 extern
102  SCIP_PRICER* pricer /**< variable pricer */
103  );
104 
105 /** returns whether the pricer should be delayed until no other pricer finds a new variable */
106 extern
108  SCIP_PRICER* pricer /**< variable pricer */
109  );
110 
111 /** is variable pricer initialized? */
112 extern
114  SCIP_PRICER* pricer /**< variable pricer */
115  );
116 
117 #ifdef __cplusplus
118 }
119 #endif
120 
121 #endif
SCIP_Bool SCIPpricerIsActive(SCIP_PRICER *pricer)
Definition: pricer.c:646
type definitions for miscellaneous datastructures
SCIP_DECL_SORTPTRCOMP(SCIPpricerComp)
Definition: pricer.c:44
int SCIPpricerGetNCalls(SCIP_PRICER *pricer)
Definition: pricer.c:594
const char * SCIPpricerGetDesc(SCIP_PRICER *pricer)
Definition: pricer.c:560
type definitions for variable pricers
SCIP_Real SCIPpricerGetTime(SCIP_PRICER *pricer)
Definition: pricer.c:624
int SCIPpricerGetPriority(SCIP_PRICER *pricer)
Definition: pricer.c:570
void SCIPpricerSetData(SCIP_PRICER *pricer, SCIP_PRICERDATA *pricerdata)
Definition: pricer.c:473
#define SCIP_Bool
Definition: def.h:53
SCIP_Bool SCIPpricerIsDelayed(SCIP_PRICER *pricer)
Definition: pricer.c:656
SCIP_Bool SCIPpricerIsInitialized(SCIP_PRICER *pricer)
Definition: pricer.c:666
SCIP_Real SCIPpricerGetSetupTime(SCIP_PRICER *pricer)
Definition: pricer.c:614
SCIP_PRICERDATA * SCIPpricerGetData(SCIP_PRICER *pricer)
Definition: pricer.c:463
#define SCIP_Real
Definition: def.h:127
const char * SCIPpricerGetName(SCIP_PRICER *pricer)
Definition: pricer.c:550
int SCIPpricerGetNVarsFound(SCIP_PRICER *pricer)
Definition: pricer.c:604
struct SCIP_PricerData SCIP_PRICERDATA
Definition: type_pricer.h:36
common defines and data types used in all packages of SCIP