Public Member Functions | Protected Attributes

CbcDynamicPseudoCostBranchingObject Class Reference

Simple branching object for an integer variable with pseudo costs. More...

#include <CbcBranchDynamic.hpp>

Inheritance diagram for CbcDynamicPseudoCostBranchingObject:
CbcIntegerBranchingObject CbcIntegerBranchingObject CbcBranchingObject CbcBranchingObject CbcBranchingObject CbcBranchingObject

List of all members.

Public Member Functions

 CbcDynamicPseudoCostBranchingObject ()
 Default constructor.
 CbcDynamicPseudoCostBranchingObject (CbcModel *model, int variable, int way, double value, CbcSimpleIntegerDynamicPseudoCost *object)
 Create a standard floor/ceiling branch object.
 CbcDynamicPseudoCostBranchingObject (CbcModel *model, int variable, int way, double lowerValue, double upperValue)
 Create a degenerate branch object.
 CbcDynamicPseudoCostBranchingObject (const CbcDynamicPseudoCostBranchingObject &)
 Copy constructor.
CbcDynamicPseudoCostBranchingObjectoperator= (const CbcDynamicPseudoCostBranchingObject &rhs)
 Assignment operator.
virtual CbcBranchingObjectclone () const
 Clone.
virtual ~CbcDynamicPseudoCostBranchingObject ()
 Destructor.
void fillPart (int variable, int way, double value, CbcSimpleIntegerDynamicPseudoCost *object)
 Does part of constructor.
virtual double branch ()
 Sets the bounds for the variable according to the current arm of the branch and advances the object state to the next arm.
virtual int fillStrongInfo (CbcStrongInfo &info)
 Some branchingObjects may claim to be able to skip strong branching.
double changeInGuessed () const
 Change in guessed.
void setChangeInGuessed (double value)
 Set change in guessed.
CbcSimpleIntegerDynamicPseudoCostobject () const
 Return object.
void setObject (CbcSimpleIntegerDynamicPseudoCost *object)
 Set object.
virtual CbcBranchObjType type () const
 Return the type (an integer identifier) of this.
 CbcDynamicPseudoCostBranchingObject ()
 Default constructor.
 CbcDynamicPseudoCostBranchingObject (CbcModel *model, int variable, int way, double value, CbcSimpleIntegerDynamicPseudoCost *object)
 Create a standard floor/ceiling branch object.
 CbcDynamicPseudoCostBranchingObject (CbcModel *model, int variable, int way, double lowerValue, double upperValue)
 Create a degenerate branch object.
 CbcDynamicPseudoCostBranchingObject (const CbcDynamicPseudoCostBranchingObject &)
 Copy constructor.
CbcDynamicPseudoCostBranchingObjectoperator= (const CbcDynamicPseudoCostBranchingObject &rhs)
 Assignment operator.
virtual CbcBranchingObjectclone () const
 Clone.
virtual ~CbcDynamicPseudoCostBranchingObject ()
 Destructor.
void fillPart (int variable, int way, double value, CbcSimpleIntegerDynamicPseudoCost *object)
 Does part of constructor.
virtual double branch ()
 Sets the bounds for the variable according to the current arm of the branch and advances the object state to the next arm.
virtual int fillStrongInfo (CbcStrongInfo &info)
 Some branchingObjects may claim to be able to skip strong branching.
double changeInGuessed () const
 Change in guessed.
void setChangeInGuessed (double value)
 Set change in guessed.
CbcSimpleIntegerDynamicPseudoCostobject () const
 Return object.
void setObject (CbcSimpleIntegerDynamicPseudoCost *object)
 Set object.
virtual CbcBranchObjType type () const
 Return the type (an integer identifier) of this.

Protected Attributes

double changeInGuessed_
 Change in guessed objective value for next branch.
CbcSimpleIntegerDynamicPseudoCostobject_
 Pointer back to object.

Detailed Description

Simple branching object for an integer variable with pseudo costs.

This object can specify a two-way branch on an integer variable. For each arm of the branch, the upper and lower bounds on the variable can be independently specified.

Variable_ holds the index of the integer variable in the integerVariable_ array of the model.

Definition at line 109 of file CbcBranchDynamic.hpp.


Constructor & Destructor Documentation

CbcDynamicPseudoCostBranchingObject::CbcDynamicPseudoCostBranchingObject (  ) 

Default constructor.

CbcDynamicPseudoCostBranchingObject::CbcDynamicPseudoCostBranchingObject ( CbcModel model,
int  variable,
int  way,
double  value,
CbcSimpleIntegerDynamicPseudoCost object 
)

Create a standard floor/ceiling branch object.

Specifies a simple two-way branch. Let value = x*. One arm of the branch will be is lb <= x <= floor(x*), the other ceil(x*) <= x <= ub. Specify way = -1 to set the object state to perform the down arm first, way = 1 for the up arm.

CbcDynamicPseudoCostBranchingObject::CbcDynamicPseudoCostBranchingObject ( CbcModel model,
int  variable,
int  way,
double  lowerValue,
double  upperValue 
)

Create a degenerate branch object.

Specifies a `one-way branch'. Calling branch() for this object will always result in lowerValue <= x <= upperValue. Used to fix a variable when lowerValue = upperValue.

CbcDynamicPseudoCostBranchingObject::CbcDynamicPseudoCostBranchingObject ( const CbcDynamicPseudoCostBranchingObject  ) 

Copy constructor.

virtual CbcDynamicPseudoCostBranchingObject::~CbcDynamicPseudoCostBranchingObject (  )  [virtual]

Destructor.

CbcDynamicPseudoCostBranchingObject::CbcDynamicPseudoCostBranchingObject (  ) 

Default constructor.

CbcDynamicPseudoCostBranchingObject::CbcDynamicPseudoCostBranchingObject ( CbcModel model,
int  variable,
int  way,
double  value,
CbcSimpleIntegerDynamicPseudoCost object 
)

Create a standard floor/ceiling branch object.

Specifies a simple two-way branch. Let value = x*. One arm of the branch will be is lb <= x <= floor(x*), the other ceil(x*) <= x <= ub. Specify way = -1 to set the object state to perform the down arm first, way = 1 for the up arm.

CbcDynamicPseudoCostBranchingObject::CbcDynamicPseudoCostBranchingObject ( CbcModel model,
int  variable,
int  way,
double  lowerValue,
double  upperValue 
)

Create a degenerate branch object.

Specifies a `one-way branch'. Calling branch() for this object will always result in lowerValue <= x <= upperValue. Used to fix a variable when lowerValue = upperValue.

CbcDynamicPseudoCostBranchingObject::CbcDynamicPseudoCostBranchingObject ( const CbcDynamicPseudoCostBranchingObject  ) 

Copy constructor.

virtual CbcDynamicPseudoCostBranchingObject::~CbcDynamicPseudoCostBranchingObject (  )  [virtual]

Destructor.


Member Function Documentation

CbcDynamicPseudoCostBranchingObject& CbcDynamicPseudoCostBranchingObject::operator= ( const CbcDynamicPseudoCostBranchingObject rhs  ) 

Assignment operator.

virtual CbcBranchingObject* CbcDynamicPseudoCostBranchingObject::clone (  )  const [virtual]

Clone.

Reimplemented from CbcIntegerBranchingObject.

void CbcDynamicPseudoCostBranchingObject::fillPart ( int  variable,
int  way,
double  value,
CbcSimpleIntegerDynamicPseudoCost object 
)

Does part of constructor.

virtual double CbcDynamicPseudoCostBranchingObject::branch (  )  [virtual]

Sets the bounds for the variable according to the current arm of the branch and advances the object state to the next arm.

This version also changes guessed objective value

Reimplemented from CbcIntegerBranchingObject.

virtual int CbcDynamicPseudoCostBranchingObject::fillStrongInfo ( CbcStrongInfo info  )  [virtual]

Some branchingObjects may claim to be able to skip strong branching.

If so they have to fill in CbcStrongInfo. The object mention in incoming CbcStrongInfo must match. Returns nonzero if skip is wanted

Reimplemented from CbcBranchingObject.

double CbcDynamicPseudoCostBranchingObject::changeInGuessed (  )  const [inline]

Change in guessed.

Definition at line 168 of file CbcBranchDynamic.hpp.

void CbcDynamicPseudoCostBranchingObject::setChangeInGuessed ( double  value  )  [inline]

Set change in guessed.

Definition at line 172 of file CbcBranchDynamic.hpp.

CbcSimpleIntegerDynamicPseudoCost* CbcDynamicPseudoCostBranchingObject::object (  )  const [inline]

Return object.

Reimplemented from CbcBranchingObject.

Definition at line 176 of file CbcBranchDynamic.hpp.

void CbcDynamicPseudoCostBranchingObject::setObject ( CbcSimpleIntegerDynamicPseudoCost object  )  [inline]

Set object.

Definition at line 180 of file CbcBranchDynamic.hpp.

virtual CbcBranchObjType CbcDynamicPseudoCostBranchingObject::type (  )  const [inline, virtual]

Return the type (an integer identifier) of this.

Reimplemented from CbcIntegerBranchingObject.

Definition at line 185 of file CbcBranchDynamic.hpp.

CbcDynamicPseudoCostBranchingObject& CbcDynamicPseudoCostBranchingObject::operator= ( const CbcDynamicPseudoCostBranchingObject rhs  ) 

Assignment operator.

virtual CbcBranchingObject* CbcDynamicPseudoCostBranchingObject::clone (  )  const [virtual]

Clone.

Reimplemented from CbcIntegerBranchingObject.

void CbcDynamicPseudoCostBranchingObject::fillPart ( int  variable,
int  way,
double  value,
CbcSimpleIntegerDynamicPseudoCost object 
)

Does part of constructor.

virtual double CbcDynamicPseudoCostBranchingObject::branch (  )  [virtual]

Sets the bounds for the variable according to the current arm of the branch and advances the object state to the next arm.

This version also changes guessed objective value

Reimplemented from CbcIntegerBranchingObject.

virtual int CbcDynamicPseudoCostBranchingObject::fillStrongInfo ( CbcStrongInfo info  )  [virtual]

Some branchingObjects may claim to be able to skip strong branching.

If so they have to fill in CbcStrongInfo. The object mention in incoming CbcStrongInfo must match. Returns nonzero if skip is wanted

Reimplemented from CbcBranchingObject.

double CbcDynamicPseudoCostBranchingObject::changeInGuessed (  )  const [inline]

Change in guessed.

Definition at line 168 of file CbcBranchDynamic.hpp.

void CbcDynamicPseudoCostBranchingObject::setChangeInGuessed ( double  value  )  [inline]

Set change in guessed.

Definition at line 172 of file CbcBranchDynamic.hpp.

CbcSimpleIntegerDynamicPseudoCost* CbcDynamicPseudoCostBranchingObject::object (  )  const [inline]

Return object.

Reimplemented from CbcBranchingObject.

Definition at line 176 of file CbcBranchDynamic.hpp.

void CbcDynamicPseudoCostBranchingObject::setObject ( CbcSimpleIntegerDynamicPseudoCost object  )  [inline]

Set object.

Definition at line 180 of file CbcBranchDynamic.hpp.

virtual CbcBranchObjType CbcDynamicPseudoCostBranchingObject::type (  )  const [inline, virtual]

Return the type (an integer identifier) of this.

Reimplemented from CbcIntegerBranchingObject.

Definition at line 185 of file CbcBranchDynamic.hpp.


Member Data Documentation

Change in guessed objective value for next branch.

Definition at line 197 of file CbcBranchDynamic.hpp.

Pointer back to object.

Definition at line 199 of file CbcBranchDynamic.hpp.


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