Minotaur 0.4.1
Docs for developers
Public Member Functions | List of all members
Minotaur::SOSBrCand Class Reference

Derived class of BrCand, it defines candidates for branching on bounds SOS type 1 and 2 constraints. More...

#include <SOSBrCand.h>

Inheritance diagram for Minotaur::SOSBrCand:
Inheritance graph
[legend]
Collaboration diagram for Minotaur::SOSBrCand:
Collaboration graph
[legend]

Public Member Functions

 SOSBrCand ()
 Constructor.
 
 SOSBrCand (const SOS *sos, VarVector &left, VarVector &right, double lsum, double rsum)
 
 ~SOSBrCand ()
 Destroy.
 
double getDDist ()
 
double getLSum () const
 
std::string getName () const
 Display for debugging. More...
 
double getRSum () const
 
double getUDist ()
 
VariableConstIterator lVarsBegin () const
 
VariableConstIterator lVarsEnd () const
 
VariableConstIterator rVarsBegin () const
 
VariableConstIterator rVarsEnd () const
 
- Public Member Functions inherited from Minotaur::BrCand
 BrCand ()
 Constructor.
 
virtual ~BrCand ()
 Destroy.
 
virtual void decrBranches ()
 Decrement the number of branches currently associated with this candidate.
 
virtual double getDDist ()=0
 
virtual BranchDirection getDir () const
 Get the preferred direction.
 
virtual HandlerPtr getHandler ()
 Return the handler that created this candidate.
 
virtual std::string getName () const
 Display for debugging. More...
 
virtual int getPCostIndex () const
 Return the index in the pseudo cost array. If it is not in the array, return a value less than 0.
 
virtual double getScore ()
 Return the score for this candidate.
 
virtual double getUDist ()=0
 
virtual int numBranches ()
 Return the number of branches currently associated with this candidate.
 
virtual void setDir (BranchDirection d)
 Set the preferred direction that will be processed first in the branch-and-bound tree.
 
void setDist (double ddist, double udist)
 Set the distance of the current solution from the down branch and the up branch.
 
virtual void setHandler (HandlerPtr h)
 Set the handler that created this candidate.
 
virtual void setNumBranches (int n)
 Set the number of branches associated with this candidate.
 
virtual void setScore (const double score)
 Set score for this candidate. More...
 

Additional Inherited Members

- Protected Attributes inherited from Minotaur::BrCand
HandlerPtr h_
 Handler that created this candidate.
 
int branches_
 Number of branches still in the tree which were created by this candidate.
 
int pCostIndex_
 Index of the this candidate in the pseudo-cost array.
 
BranchDirection prefDir_
 Which is preferred for processing next? UpBranch or DownBranch?
 
double score_
 Score of this candidate.
 

Detailed Description

Derived class of BrCand, it defines candidates for branching on bounds SOS type 1 and 2 constraints.

Member Function Documentation

◆ getDDist()

double SOSBrCand::getDDist ( )
virtual

Return the distance of the current point from the branching constraint: down direction. For an integer constrained variable, x, it would be $ x - \lfloor x \rfloor $.

Implements Minotaur::BrCand.

◆ getName()

std::string SOSBrCand::getName ( ) const
virtual

Display for debugging.

Reimplemented from Minotaur::BrCand.

◆ getUDist()

double SOSBrCand::getUDist ( )
virtual

Return the distance of the current point from the branching constraint: up direction For an integer constrained variable, x, it would be $
x - \lceil x \rceil $.

Implements Minotaur::BrCand.


The documentation for this class was generated from the following files:

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