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-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 pub_nodesel.h
26  * @ingroup PUBLICCOREAPI
27  * @brief public methods for node selectors
28  * @author Tobias Achterberg
29  */
30 
31 /*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
32 
33 #ifndef __SCIP_PUB_NODESEL_H__
34 #define __SCIP_PUB_NODESEL_H__
35 
36 
37 #include "scip/def.h"
38 #include "scip/type_nodesel.h"
39 
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43 
44 /**@addtogroup PublicNodeSelectorMethods
45  *
46  * @{
47  */
48 
49 /** gets name of node selector */
50 SCIP_EXPORT
51 const char* SCIPnodeselGetName(
52  SCIP_NODESEL* nodesel /**< node selector */
53  );
54 
55 /** gets description of node selector */
56 SCIP_EXPORT
57 const char* SCIPnodeselGetDesc(
58  SCIP_NODESEL* nodesel /**< node selector */
59  );
60 
61 /** gets priority of node selector in standard mode */
62 SCIP_EXPORT
64  SCIP_NODESEL* nodesel /**< node selector */
65  );
66 
67 /** gets priority of node selector in memory saving mode */
68 SCIP_EXPORT
70  SCIP_NODESEL* nodesel /**< node selector */
71  );
72 
73 /** gets user data of node selector */
74 SCIP_EXPORT
76  SCIP_NODESEL* nodesel /**< node selector */
77  );
78 
79 /** sets user data of node selector; user has to free old data in advance! */
80 SCIP_EXPORT
82  SCIP_NODESEL* nodesel, /**< node selector */
83  SCIP_NODESELDATA* nodeseldata /**< new node selector user data */
84  );
85 
86 /** is node selector initialized? */
87 SCIP_EXPORT
89  SCIP_NODESEL* nodesel /**< node selector */
90  );
91 
92 /** gets time in seconds used in this node selector for setting up for next stages */
93 SCIP_EXPORT
95  SCIP_NODESEL* nodesel /**< node selector */
96  );
97 
98 /** gets time in seconds used in this node selector */
99 SCIP_EXPORT
101  SCIP_NODESEL* nodesel /**< node selector */
102  );
103 
104 /** @} */
105 
106 #ifdef __cplusplus
107 }
108 #endif
109 
110 #endif
int SCIPnodeselGetMemsavePriority(SCIP_NODESEL *nodesel)
Definition: nodesel.c:1096
const char * SCIPnodeselGetDesc(SCIP_NODESEL *nodesel)
Definition: nodesel.c:1062
struct SCIP_NodeselData SCIP_NODESELDATA
Definition: type_nodesel.h:52
SCIP_NODESELDATA * SCIPnodeselGetData(SCIP_NODESEL *nodesel)
Definition: nodesel.c:1120
SCIP_Real SCIPnodeselGetTime(SCIP_NODESEL *nodesel)
Definition: nodesel.c:1241
#define SCIP_Bool
Definition: def.h:93
const char * SCIPnodeselGetName(SCIP_NODESEL *nodesel)
Definition: nodesel.c:1052
SCIP_Real SCIPnodeselGetSetupTime(SCIP_NODESEL *nodesel)
Definition: nodesel.c:1231
#define SCIP_Real
Definition: def.h:186
common defines and data types used in all packages of SCIP
type definitions for node selectors
int SCIPnodeselGetStdPriority(SCIP_NODESEL *nodesel)
Definition: nodesel.c:1072
void SCIPnodeselSetData(SCIP_NODESEL *nodesel, SCIP_NODESELDATA *nodeseldata)
Definition: nodesel.c:1130
SCIP_Bool SCIPnodeselIsInitialized(SCIP_NODESEL *nodesel)
Definition: nodesel.c:1209