Minotaur 0.4.1
Docs for developers
ReliabilityBrancher.h
Go to the documentation of this file.
1//
2// Minotaur -- It's only 1/2 bull
3//
4// (C)opyright 2009 - 2025 The Minotaur Team.
5//
6
14#ifndef MINOTAURRELIABILITYBRANCHER_H
15#define MINOTAURRELIABILITYBRANCHER_H
16
17#include "Brancher.h"
18
19namespace Minotaur {
20
21class Engine;
22class Timer;
23typedef Engine* EnginePtr;
24
25struct RelBrStats {
26 UInt bndChange;
31 double strTime;
32};
33
34
37
38public:
46 ReliabilityBrancher(EnvPtr env, HandlerVector & handlers);
47
50
51 // base class function.
52 Branches findBranches(RelaxationPtr rel, NodePtr node,
54 BrancherStatus & br_status, ModVector &mods);
55
57 bool getTrustCutoff();
58
61
62 // base class function.
63 std::string getName() const;
64
66 UInt getThresh() const;
67
73 void initialize(RelaxationPtr rel);
74
76 void setTrustCutoff(bool val);
77
83 void setEngine(EnginePtr engine);
84
90 void setIterLim(UInt k);
91
97 void setMaxDepth(UInt k);
98
104 void setMinNodeDist(UInt k);
105
113 void setThresh(UInt k);
114
115 // base class function.
117
119 void writeStats(std::ostream &out) const;
120
121private:
122
133 BrCandPtr findBestCandidate_(const double objval, double cutoff,
134 NodePtr node);
135
145 void findCandidates_();
146
151 void freeCandidates_(BrCandPtr no_del);
152
161 void getPCScore_(BrCandPtr cand, double *ch_down, double *ch_up,
162 double *score);
163
170 double getScore_(const double & up_score, const double & down_score);
171
186 bool shouldPrune_(const double &chcutoff, const double &change,
187 const EngineStatus & status, bool *is_rel);
188
197 void strongBranch_(BrCandPtr cand, double & obj_up, double & obj_down,
198 EngineStatus & status_up, EngineStatus & status_down);
199
210 void updatePCost_(const int &i, const double &new_cost,
211 DoubleVector &cost, UIntVector &count);
212
228 void useStrongBranchInfo_(BrCandPtr cand, const double & chcutoff,
229 double & change_up, double & change_down,
230 const EngineStatus & status_up,
231 const EngineStatus & status_down);
232
241 void writeScore_(BrCandPtr cand, double score, double change_up,
242 double change_down);
243
250 void writeScores_(std::ostream &out);
251
253 EnginePtr engine_;
254
256 const double eTol_;
257
262 HandlerVector handlers_;
263
265 bool init_;
266
268 UIntVector lastStrBranched_;
269
272 UInt maxDepth_;
273
278 UInt maxIterations_;
279
283 UInt maxStrongCands_;
284
286 const static std::string me_;
287
292 UInt minNodeDist_;
293
295 ModVector mods_;
296
298 DoubleVector pseudoDown_;
299
301 DoubleVector pseudoUp_;
302
304 RelaxationPtr rel_;
305
307 std::vector<BrCandPtr> relCands_;
308
310 RelBrStats * stats_;
311
313 BrancherStatus status_;
314
316 Timer *timer_;
317
322 UIntVector timesDown_;
323
328 UIntVector timesUp_;
329
331 UInt thresh_;
332
334 bool trustCutoff_;
335
340 std::vector<BrCandPtr> unrelCands_;
341
343 DoubleVector x_;
344
345};
347}
348#endif
349
Declare the base class Brancher for finding and creating branches in Branch-and-Bound.
Base class for describing candidates for branching on a node in branch-and-bound.
Definition: BrCand.h:32
A brancher is used to find suitable branches for a given node. e.g. LexicoBrancher....
Definition: Brancher.h:33
Definition: Engine.h:34
Definition: Environment.h:28
Definition: Node.h:54
Definition: Relaxation.h:53
A class to select a variable for branching using reliability branching.
Definition: ReliabilityBrancher.h:36
void setTrustCutoff(bool val)
Set value of trustCutoff parameter.
Definition: ReliabilityBrancher.cpp:400
UInt getThresh() const
Return the threshhold value.
Definition: ReliabilityBrancher.cpp:379
std::string getName() const
Return the name of this brancher.
Definition: ReliabilityBrancher.cpp:348
ReliabilityBrancher(EnvPtr env, HandlerVector &handlers)
Construct using an environment pointer and handlers.
Definition: ReliabilityBrancher.cpp:43
void setMaxDepth(UInt k)
Set the depth at which we stop strong branching.
Definition: ReliabilityBrancher.cpp:415
bool getTrustCutoff()
Return value of trustCutoff parameter.
Definition: ReliabilityBrancher.cpp:338
void setIterLim(UInt k)
Set iteration limit of engine.
Definition: ReliabilityBrancher.cpp:410
void setMinNodeDist(UInt k)
Don't do strong branching on a cand if we did it 'k' nodes or less ago.
Definition: ReliabilityBrancher.cpp:420
void writeStats(std::ostream &out) const
Write statistics.
Definition: ReliabilityBrancher.cpp:629
Branches findBranches(RelaxationPtr rel, NodePtr node, ConstSolutionPtr sol, SolutionPoolPtr s_pool, BrancherStatus &br_status, ModVector &mods)
Find a branching candidate.
Definition: ReliabilityBrancher.cpp:161
void initialize(RelaxationPtr rel)
Initialize data structures.
Definition: ReliabilityBrancher.cpp:384
void updateAfterSolve(NodePtr node, ConstSolutionPtr sol)
Update pseudo-costs after LP is solved.
Definition: ReliabilityBrancher.cpp:508
UInt getIterLim()
Get iteration limit of engine.
Definition: ReliabilityBrancher.cpp:343
~ReliabilityBrancher()
Destroy.
Definition: ReliabilityBrancher.cpp:69
void setThresh(UInt k)
Set reliability threshhold.
Definition: ReliabilityBrancher.cpp:425
void setEngine(EnginePtr engine)
Set engine.
Definition: ReliabilityBrancher.cpp:405
Definition: SolutionPool.h:28
Definition: Solution.h:30
Definition: Timer.h:40
Definition: ActiveNodeStore.h:20
BrancherStatus
What can a brancher do to a node in branch-and-bound.
Definition: Types.h:193
unsigned int UInt
Unsigned integer.
Definition: Types.h:30
EngineStatus
Different status that an external engine may report.
Definition: Types.h:176
Definition: ReliabilityBrancher.h:25
UInt iters
Number of times an unexpected engine status was met.
Definition: ReliabilityBrancher.h:29
UInt engProbs
Number of times called to find a branching candidate.
Definition: ReliabilityBrancher.h:28
UInt calls
Number of times variable bounds were changed.
Definition: ReliabilityBrancher.h:27
double strTime
Number of times strong branching on a variable.
Definition: ReliabilityBrancher.h:31
UInt strBrCalls
Number of iterations in strong-branching.
Definition: ReliabilityBrancher.h:30

Minotaur source code documented by Doxygen 1.9.4 on Thu Apr 24 2025