1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/* */
/* This file is part of the program and library */
/* SCIP --- Solving Constraint Integer Programs */
/* */
/* Copyright 2002-2022 Zuse Institute Berlin */
/* */
/* Licensed under the Apache License, Version 2.0 (the "License"); */
/* you may not use this file except in compliance with the License. */
/* You may obtain a copy of the License at */
/* */
/* http://www.apache.org/licenses/LICENSE-2.0 */
/* */
/* Unless required by applicable law or agreed to in writing, software */
/* distributed under the License is distributed on an "AS IS" BASIS, */
/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. */
/* See the License for the specific language governing permissions and */
/* limitations under the License. */
/* */
/* You should have received a copy of the Apache-2.0 license */
/* along with SCIP; see the file LICENSE. If not visit scipopt.org. */
/* */
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/**@file pub_tree.h
* @ingroup PUBLICCOREAPI
* @brief public methods for branch and bound tree
* @author Tobias Achterberg
*/
/*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
#ifndef __SCIP_PUB_TREE_H__
#define __SCIP_PUB_TREE_H__
#include "scip/def.h"
#include "scip/type_cons.h"
#include "scip/type_lp.h"
#include "scip/type_misc.h"
#include "scip/type_reopt.h"
#include "scip/type_retcode.h"
#include "scip/type_tree.h"
#include "scip/type_var.h"
#ifdef NDEBUG
#include "scip/struct_tree.h"
#endif
#ifdef __cplusplus
extern "C" {
#endif
/*
* Node methods
*/
/**@addtogroup PublicNodeMethods
*
* @{
*/
/** node comparator for best lower bound */
SCIP_EXPORT
SCIP_DECL_SORTPTRCOMP(SCIPnodeCompLowerbound);
/** returns the set of variable branchings that were performed in the parent node to create this node */
SCIP_EXPORT
void SCIPnodeGetParentBranchings(
SCIP_NODE* node, /**< node data */
SCIP_VAR** branchvars, /**< array of variables on which the branching has been performed in the parent node */
SCIP_Real* branchbounds, /**< array of bounds which the branching in the parent node set */
SCIP_BOUNDTYPE* boundtypes, /**< array of boundtypes which the branching in the parent node set */
int* nbranchvars, /**< number of variables on which branching has been performed in the parent node
* if this is larger than the array size, arrays should be reallocated and method should be called again */
int branchvarssize /**< available slots in arrays */
);
/** returns the set of variable branchings that were performed in all ancestor nodes (nodes on the path to the root) to create this node */
SCIP_EXPORT
void SCIPnodeGetAncestorBranchings(
SCIP_NODE* node, /**< node data */
SCIP_VAR** branchvars, /**< array of variables on which the branchings has been performed in all ancestors */
SCIP_Real* branchbounds, /**< array of bounds which the branchings in all ancestors set */
SCIP_BOUNDTYPE* boundtypes, /**< array of boundtypes which the branchings in all ancestors set */
int* nbranchvars, /**< number of variables on which branchings have been performed in all ancestors
* if this is larger than the array size, arrays should be reallocated and method should be called again */
int branchvarssize /**< available slots in arrays */
);
/** returns the set of variable branchings that were performed between the given @p node and the given @p parent node. */
SCIP_EXPORT
void SCIPnodeGetAncestorBranchingsPart(
SCIP_NODE* node, /**< node data */
SCIP_NODE* parent, /**< node data */
SCIP_VAR** branchvars, /**< array of variables on which the branchings has been performed in all ancestors */
SCIP_Real* branchbounds, /**< array of bounds which the branchings in all ancestors set */
SCIP_BOUNDTYPE* boundtypes, /**< array of boundtypes which the branchings in all ancestors set */
int* nbranchvars, /**< number of variables on which branchings have been performed in all ancestors
* if this is larger than the array size, arrays should be reallocated and method should be called again */
int branchvarssize /**< available slots in arrays */
);
/** outputs the path into given file stream in GML format */
SCIP_EXPORT
SCIP_RETCODE SCIPnodePrintAncestorBranchings(
SCIP_NODE* node, /**< node data */
FILE* file /**< file to output the path */
);
/** returns the set of variable branchings that were performed in all ancestor nodes (nodes on the path to the root) to create this node
* sorted by the nodes, starting from the current node going up to the root
*/
SCIP_EXPORT
void SCIPnodeGetAncestorBranchingPath(
SCIP_NODE* node, /**< node data */
SCIP_VAR** branchvars, /**< array of variables on which the branchings has been performed in all ancestors */
SCIP_Real* branchbounds, /**< array of bounds which the branchings in all ancestors set */
SCIP_BOUNDTYPE* boundtypes, /**< array of boundtypes which the branchings in all ancestors set */
int* nbranchvars, /**< number of variables on which branchings have been performed in all ancestors
* if this is larger than the array size, arrays should be reallocated and method
* should be called again */
int branchvarssize, /**< available slots in arrays */
int* nodeswitches, /**< marks, where in the arrays the branching decisions of the next node on the path
* start; branchings performed at the parent of node always start at position 0.
* For single variable branching, nodeswitches[i] = i holds */
int* nnodes, /**< number of nodes in the nodeswitch array */
int nodeswitchsize /**< available slots in node switch array */
);
/** checks for two nodes whether they share the same root path, i.e., whether one is an ancestor of the other */
SCIP_EXPORT
SCIP_Bool SCIPnodesSharePath(
SCIP_NODE* node1, /**< node data */
SCIP_NODE* node2 /**< node data */
);
/** finds the common ancestor node of two given nodes */
SCIP_EXPORT
SCIP_NODE* SCIPnodesGetCommonAncestor(
SCIP_NODE* node1, /**< node data */
SCIP_NODE* node2 /**< node data */
);
/** gets the type of the node */
SCIP_EXPORT
SCIP_NODETYPE SCIPnodeGetType(
SCIP_NODE* node /**< node */
);
/** gets successively assigned number of the node */
SCIP_EXPORT
SCIP_Longint SCIPnodeGetNumber(
SCIP_NODE* node /**< node */
);
/** gets the depth of the node */
SCIP_EXPORT
int SCIPnodeGetDepth(
SCIP_NODE* node /**< node */
);
/** gets the lower bound of the node */
SCIP_EXPORT
SCIP_Real SCIPnodeGetLowerbound(
SCIP_NODE* node /**< node */
);
/** gets the estimated value of the best feasible solution in subtree of the node */
SCIP_EXPORT
SCIP_Real SCIPnodeGetEstimate(
SCIP_NODE* node /**< node */
);
/** gets the reoptimization type of a node */
SCIP_EXPORT
SCIP_REOPTTYPE SCIPnodeGetReopttype(
SCIP_NODE* node /**< node */
);
/** gets the unique id to identify the node during reoptimization; id is 0 if the node is the root or not part of the
* reoptimization tree
*/
SCIP_EXPORT
unsigned int SCIPnodeGetReoptID(
SCIP_NODE* node /**< node */
);
/** sets the reoptimization type of the node */
SCIP_EXPORT
void SCIPnodeSetReopttype(
SCIP_NODE* node, /**< node */
SCIP_REOPTTYPE reopttype /**< reoptimization type */
);
/** sets a unique id to identify the node during reoptimization */
SCIP_EXPORT
void SCIPnodeSetReoptID(
SCIP_NODE* node, /**< node */
unsigned int id /**< unique id */
);
/** counts the number of bound changes due to branching, constraint propagation, and propagation */
SCIP_EXPORT
void SCIPnodeGetNDomchg(
SCIP_NODE* node, /**< node */
int* nbranchings, /**< pointer to store number of branchings (or NULL if not needed) */
int* nconsprop, /**< pointer to store number of constraint propagations (or NULL if not needed) */
int* nprop /**< pointer to store number of propagations (or NULL if not needed) */
);
/** gets the domain change information of the node, i.e., the information about the differences in the
* variables domains to the parent node
*/
SCIP_EXPORT
SCIP_DOMCHG* SCIPnodeGetDomchg(
SCIP_NODE* node /**< node */
);
/** gets the parent node of a node in the branch-and-bound tree, if any */
SCIP_EXPORT
SCIP_NODE* SCIPnodeGetParent(
SCIP_NODE* node /**< node */
);
/** returns all constraints added to a given node */
SCIP_EXPORT
void SCIPnodeGetAddedConss(
SCIP_NODE* node, /**< node */
SCIP_CONS** addedconss, /**< array to store the constraints */
int* naddedconss, /**< number of added constraints */
int addedconsssize /**< size of the constraint array */
);
/** returns the number of added constraints to the given node */
SCIP_EXPORT
int SCIPnodeGetNAddedConss(
SCIP_NODE* node
);
/** returns whether node is in the path to the current node */
SCIP_EXPORT
SCIP_Bool SCIPnodeIsActive(
SCIP_NODE* node /**< node */
);
/** returns whether the node is marked to be propagated again */
SCIP_EXPORT
SCIP_Bool SCIPnodeIsPropagatedAgain(
SCIP_NODE* node /**< node data */
);
/* returns the set of changed constraints for a particular node */
SCIP_EXPORT
SCIP_CONSSETCHG* SCIPnodeGetConssetchg(
SCIP_NODE* node /**< node data */
);
#ifdef NDEBUG
/* In optimized mode, the function calls are overwritten by defines to reduce the number of function calls and
* speed up the algorithms.
*/
#define SCIPnodeGetType(node) ((SCIP_NODETYPE)(node)->nodetype)
#define SCIPnodeGetNumber(node) ((node)->number)
#define SCIPnodeGetDepth(node) ((int) (node)->depth)
#define SCIPnodeGetLowerbound(node) ((node)->lowerbound)
#define SCIPnodeGetEstimate(node) ((node)->estimate)
#define SCIPnodeGetDomchg(node) ((node)->domchg)
#define SCIPnodeGetParent(node) ((node)->parent)
#define SCIPnodeIsActive(node) ((node)->active)
#define SCIPnodeIsPropagatedAgain(node) ((node)->reprop)
#define SCIPnodeGetConssetchg(node) ((node)->conssetchg)
#endif
/** @} */
#ifdef __cplusplus
}
#endif
#endif