Scippy

SCIP

Solving Constraint Integer Programs

struct_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-2023 Zuse Institute Berlin (ZIB) */
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 struct_pricer.h
26  * @ingroup INTERNALAPI
27  * @brief data structures for variable pricers
28  * @author Tobias Achterberg
29  */
30 
31 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
32 
33 #ifndef __SCIP_STRUCT_PRICER_H__
34 #define __SCIP_STRUCT_PRICER_H__
35 
36 
37 #include "scip/def.h"
38 #include "scip/type_clock.h"
39 #include "scip/type_pricer.h"
40 
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44 
45 /** variable pricers data */
47 {
48  char* name; /**< name of variable pricer */
49  char* desc; /**< description of variable pricer */
50  SCIP_DECL_PRICERCOPY ((*pricercopy)); /**< copy method of pricer or NULL if you don't want to copy your plugin into sub-SCIPs */
51  SCIP_DECL_PRICERFREE ((*pricerfree)); /**< destructor of variable pricer */
52  SCIP_DECL_PRICERINIT ((*pricerinit)); /**< initialize variable pricer */
53  SCIP_DECL_PRICEREXIT ((*pricerexit)); /**< deinitialize variable pricer */
54  SCIP_DECL_PRICERINITSOL((*pricerinitsol));/**< solving process initialization method of variable pricer */
55  SCIP_DECL_PRICEREXITSOL((*pricerexitsol));/**< solving process deinitialization method of variable pricer */
56  SCIP_DECL_PRICERREDCOST((*pricerredcost));/**< reduced cost pricing method of variable pricer for feasible LPs */
57  SCIP_DECL_PRICERFARKAS((*pricerfarkas)); /**< Farkas pricing method of variable pricer for infeasible LPs */
58  SCIP_PRICERDATA* pricerdata; /**< variable pricers local data */
59  SCIP_CLOCK* setuptime; /**< time spend for setting up this pricer for the next stages */
60  SCIP_CLOCK* pricerclock; /**< pricer execution time */
61  int priority; /**< priority of the variable pricer */
62  int ncalls; /**< number of times, this pricer was called */
63  int nvarsfound; /**< number of variables priced in found so far by this pricer */
64  SCIP_Bool delay; /**< should the pricer be delayed until no other pricers or already existing
65  * problem variables with negative reduced costs are found */
66  SCIP_Bool active; /**< is variable pricer in use for the current problem? */
67  SCIP_Bool initialized; /**< is variable pricer initialized? */
68 };
69 
70 #ifdef __cplusplus
71 }
72 #endif
73 
74 #endif
SCIP_DECL_PRICERCOPY((*pricercopy))
SCIP_Bool delay
Definition: struct_pricer.h:64
SCIP_DECL_PRICERINIT((*pricerinit))
type definitions for variable pricers
SCIP_CLOCK * setuptime
Definition: struct_pricer.h:59
SCIP_DECL_PRICEREXIT((*pricerexit))
SCIP_DECL_PRICEREXITSOL((*pricerexitsol))
SCIP_CLOCK * pricerclock
Definition: struct_pricer.h:60
SCIP_DECL_PRICERINITSOL((*pricerinitsol))
SCIP_PRICERDATA * pricerdata
Definition: struct_pricer.h:58
SCIP_Bool initialized
Definition: struct_pricer.h:67
#define SCIP_Bool
Definition: def.h:93
type definitions for clocks and timing issues
SCIP_DECL_PRICERFREE((*pricerfree))
SCIP_Bool active
Definition: struct_pricer.h:66
SCIP_DECL_PRICERFARKAS((*pricerfarkas))
struct SCIP_PricerData SCIP_PRICERDATA
Definition: type_pricer.h:45
common defines and data types used in all packages of SCIP
SCIP_DECL_PRICERREDCOST((*pricerredcost))