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-2021 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 scipopt.org. */
13 /* */
14 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
15 
16 /**@file pub_pricer.h
17  * @ingroup PUBLICCOREAPI
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 /**@addtogroup PublicPricerMethods
37  *
38  * @{
39  */
40 
41 /** compares two pricers w. r. to their priority */
43 SCIP_DECL_SORTPTRCOMP(SCIPpricerComp);
44 
45 /** comparison method for sorting pricers w.r.t. to their name */
47 SCIP_DECL_SORTPTRCOMP(SCIPpricerCompName);
48 
49 /** gets user data of variable pricer */
52  SCIP_PRICER* pricer /**< variable pricer */
53  );
54 
55 /** sets user data of variable pricer; user has to free old data in advance! */
58  SCIP_PRICER* pricer, /**< variable pricer */
59  SCIP_PRICERDATA* pricerdata /**< new variable pricer user data */
60  );
61 
62 /** gets name of variable pricer */
64 const char* SCIPpricerGetName(
65  SCIP_PRICER* pricer /**< variable pricer */
66  );
67 
68 /** gets description of variable pricer */
70 const char* SCIPpricerGetDesc(
71  SCIP_PRICER* pricer /**< variable pricer */
72  );
73 
74 /** gets priority of variable pricer */
77  SCIP_PRICER* pricer /**< variable pricer */
78  );
79 
80 /** gets the number of times, the pricer was called and tried to find a variable with negative reduced costs */
83  SCIP_PRICER* pricer /**< variable pricer */
84  );
85 
86 /** gets the number of variables with negative reduced costs found by this pricer */
89  SCIP_PRICER* pricer /**< variable pricer */
90  );
91 
92 /** gets time in seconds used in this pricer for setting up for next stages */
95  SCIP_PRICER* pricer /**< variable pricer */
96  );
97 
98 /** gets time in seconds used in this pricer */
101  SCIP_PRICER* pricer /**< variable pricer */
102  );
103 
104 /** returns whether the given pricer is in use in the current problem */
107  SCIP_PRICER* pricer /**< variable pricer */
108  );
109 
110 /** returns whether the pricer should be delayed until no other pricer finds a new variable */
113  SCIP_PRICER* pricer /**< variable pricer */
114  );
115 
116 /** is variable pricer initialized? */
119  SCIP_PRICER* pricer /**< variable pricer */
120  );
121 
122 /** @} */
123 
124 #ifdef __cplusplus
125 }
126 #endif
127 
128 #endif
SCIP_EXPORT SCIP_Real SCIPpricerGetSetupTime(SCIP_PRICER *pricer)
Definition: pricer.c:652
type definitions for miscellaneous datastructures
SCIP_EXPORT SCIP_Bool SCIPpricerIsActive(SCIP_PRICER *pricer)
Definition: pricer.c:684
SCIP_EXPORT int SCIPpricerGetNVarsFound(SCIP_PRICER *pricer)
Definition: pricer.c:642
#define SCIP_EXPORT
Definition: def.h:100
SCIP_EXPORT int SCIPpricerGetPriority(SCIP_PRICER *pricer)
Definition: pricer.c:608
SCIP_EXPORT SCIP_DECL_SORTPTRCOMP(SCIPpricerComp)
Definition: pricer.c:45
type definitions for variable pricers
SCIP_EXPORT SCIP_Bool SCIPpricerIsInitialized(SCIP_PRICER *pricer)
Definition: pricer.c:704
#define SCIP_Bool
Definition: def.h:70
SCIP_EXPORT SCIP_Bool SCIPpricerIsDelayed(SCIP_PRICER *pricer)
Definition: pricer.c:694
SCIP_EXPORT void SCIPpricerSetData(SCIP_PRICER *pricer, SCIP_PRICERDATA *pricerdata)
Definition: pricer.c:511
SCIP_EXPORT const char * SCIPpricerGetName(SCIP_PRICER *pricer)
Definition: pricer.c:588
SCIP_EXPORT SCIP_PRICERDATA * SCIPpricerGetData(SCIP_PRICER *pricer)
Definition: pricer.c:501
SCIP_EXPORT SCIP_Real SCIPpricerGetTime(SCIP_PRICER *pricer)
Definition: pricer.c:662
#define SCIP_Real
Definition: def.h:163
SCIP_EXPORT const char * SCIPpricerGetDesc(SCIP_PRICER *pricer)
Definition: pricer.c:598
struct SCIP_PricerData SCIP_PRICERDATA
Definition: type_pricer.h:36
common defines and data types used in all packages of SCIP
SCIP_EXPORT int SCIPpricerGetNCalls(SCIP_PRICER *pricer)
Definition: pricer.c:632