Scippy

SCIP

Solving Constraint Integer Programs

pub_nodesel.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-2022 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_nodesel.h
17  * @ingroup PUBLICCOREAPI
18  * @brief public methods for node selectors
19  * @author Tobias Achterberg
20  */
21 
22 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
23 
24 #ifndef __SCIP_PUB_NODESEL_H__
25 #define __SCIP_PUB_NODESEL_H__
26 
27 
28 #include "scip/def.h"
29 #include "scip/type_nodesel.h"
30 
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
34 
35 /**@addtogroup PublicNodeSelectorMethods
36  *
37  * @{
38  */
39 
40 /** gets name of node selector */
41 SCIP_EXPORT
42 const char* SCIPnodeselGetName(
43  SCIP_NODESEL* nodesel /**< node selector */
44  );
45 
46 /** gets description of node selector */
47 SCIP_EXPORT
48 const char* SCIPnodeselGetDesc(
49  SCIP_NODESEL* nodesel /**< node selector */
50  );
51 
52 /** gets priority of node selector in standard mode */
53 SCIP_EXPORT
55  SCIP_NODESEL* nodesel /**< node selector */
56  );
57 
58 /** gets priority of node selector in memory saving mode */
59 SCIP_EXPORT
61  SCIP_NODESEL* nodesel /**< node selector */
62  );
63 
64 /** gets user data of node selector */
65 SCIP_EXPORT
67  SCIP_NODESEL* nodesel /**< node selector */
68  );
69 
70 /** sets user data of node selector; user has to free old data in advance! */
71 SCIP_EXPORT
73  SCIP_NODESEL* nodesel, /**< node selector */
74  SCIP_NODESELDATA* nodeseldata /**< new node selector user data */
75  );
76 
77 /** is node selector initialized? */
78 SCIP_EXPORT
80  SCIP_NODESEL* nodesel /**< node selector */
81  );
82 
83 /** gets time in seconds used in this node selector for setting up for next stages */
84 SCIP_EXPORT
86  SCIP_NODESEL* nodesel /**< node selector */
87  );
88 
89 /** gets time in seconds used in this node selector */
90 SCIP_EXPORT
92  SCIP_NODESEL* nodesel /**< node selector */
93  );
94 
95 /** @} */
96 
97 #ifdef __cplusplus
98 }
99 #endif
100 
101 #endif
int SCIPnodeselGetMemsavePriority(SCIP_NODESEL *nodesel)
Definition: nodesel.c:1087
const char * SCIPnodeselGetDesc(SCIP_NODESEL *nodesel)
Definition: nodesel.c:1053
struct SCIP_NodeselData SCIP_NODESELDATA
Definition: type_nodesel.h:43
SCIP_NODESELDATA * SCIPnodeselGetData(SCIP_NODESEL *nodesel)
Definition: nodesel.c:1111
SCIP_Real SCIPnodeselGetTime(SCIP_NODESEL *nodesel)
Definition: nodesel.c:1232
#define SCIP_Bool
Definition: def.h:84
const char * SCIPnodeselGetName(SCIP_NODESEL *nodesel)
Definition: nodesel.c:1043
SCIP_Real SCIPnodeselGetSetupTime(SCIP_NODESEL *nodesel)
Definition: nodesel.c:1222
#define SCIP_Real
Definition: def.h:177
common defines and data types used in all packages of SCIP
type definitions for node selectors
int SCIPnodeselGetStdPriority(SCIP_NODESEL *nodesel)
Definition: nodesel.c:1063
void SCIPnodeselSetData(SCIP_NODESEL *nodesel, SCIP_NODESELDATA *nodeseldata)
Definition: nodesel.c:1121
SCIP_Bool SCIPnodeselIsInitialized(SCIP_NODESEL *nodesel)
Definition: nodesel.c:1200