# BlisObjectInt Class Reference

`#include <BlisObjectInt.h>`

Inheritance diagram for BlisObjectInt:
[legend]
Collaboration diagram for BlisObjectInt:
[legend]

List of all members.

## Public Member Functions
| BlisObjectInt ()
| Default Constructor.
| BlisObjectInt (int objectIndex, int iColumn, double lb, double ub, double breakEven=0.5)
| Useful constructor - passed integer index and model index.
virtual | ~BlisObjectInt ()
| Destructor.
| BlisObjectInt (const BlisObjectInt &)
| Copy constructor.
virtual BcpsObject * | clone () const
| Clone an object.
BlisObjectInt & | operator= (const BlisObjectInt &rhs)
| Assignment operator.
virtual double | infeasibility (BcpsModel *m, int &preferredWay) const
| Infeasibility.
virtual void | feasibleRegion (BcpsModel *m)
| Set bounds to contain the current solution.
virtual BcpsBranchObject * | createBranchObject (BcpsModel *m, int direction) const
| Creates a branching object.
virtual BcpsBranchObject * | preferredNewFeasible (BcpsModel *m) const
| Given a valid solution (with reduced costs, etc.
virtual BcpsBranchObject * | notPreferredNewFeasible (BcpsModel *m) const
| Given a valid solution (with reduced costs, etc.
virtual void | resetBounds (BcpsModel *m)
| Reset original upper and lower bound values from the solver.
virtual int | columnIndex () const
| Column number if single column object, otherwise.
double | breakEven () const
| Breakeven e.g 0.7 -> >= 0.7 go up first.
void | setBreakEven (double value)
| Set breakeven e.g 0.7 -> >= 0.7 go up first.
BlisPseudocost & | pseudocost ()
| Access pseudocost.
| BlisObjectInt ()
| Default Constructor.
| BlisObjectInt (int objectIndex, int iColumn, double lb, double ub, double breakEven=0.5)
| Useful constructor - passed integer index and model index.
virtual | ~BlisObjectInt ()
| Destructor.
| BlisObjectInt (const BlisObjectInt &)
| Copy constructor.
virtual BcpsObject * | clone () const
| Clone an object.
BlisObjectInt & | operator= (const BlisObjectInt &rhs)
| Assignment operator.
virtual double | infeasibility (BcpsModel *m, int &preferredWay) const
| Infeasibility.
virtual void | feasibleRegion (BcpsModel *m)
| Set bounds to contain the current solution.
virtual BcpsBranchObject * | createBranchObject (BcpsModel *m, int direction) const
| Creates a branching object.
virtual BcpsBranchObject * | preferredNewFeasible (BcpsModel *m) const
| Given a valid solution (with reduced costs, etc.
virtual BcpsBranchObject * | notPreferredNewFeasible (BcpsModel *m) const
| Given a valid solution (with reduced costs, etc.
virtual void | resetBounds (BcpsModel *m)
| Reset original upper and lower bound values from the solver.
virtual int | columnIndex () const
| Column number if single column object, otherwise.
double | breakEven () const
| Breakeven e.g 0.7 -> >= 0.7 go up first.
void | setBreakEven (double value)
| Set breakeven e.g 0.7 -> >= 0.7 go up first.
BlisPseudocost & | pseudocost ()
| Access pseudocost.
Get or set Original bounds.
double | originalLowerBound () const
void | setOriginalLowerBound (double value)
double | originalUpperBound () const
void | setOriginalUpperBound (double value)
double | originalLowerBound () const
void | setOriginalLowerBound (double value)
double | originalUpperBound () const
void | setOriginalUpperBound (double value)
## Protected Attributes
int | columnIndex_
| Column index in the lp model.
double | originalLower_
| Original lower bound.
double | originalUpper_
| Original upper bound.
double | breakEven_
| Breakeven i.e.
BlisPseudocost | pseudocost_
| Pseudo cost.

## Detailed Description

Definition at line 36 of file BlisObjectInt.h.

## Constructor & Destructor Documentation

BlisObjectInt::BlisObjectInt | ( |  | ) |

Default Constructor.

BlisObjectInt::BlisObjectInt | ( | int | objectIndex,
|  | int | iColumn,
|  | double | lb,
|  | double | ub,
|  | double | breakEven = `0.5` |
| ) |  |  |

Useful constructor - passed integer index and model index.

virtual BlisObjectInt::~BlisObjectInt | ( |  | ) | `[inline, virtual]`

Destructor.

Definition at line 68 of file BlisObjectInt.h.

BlisObjectInt::BlisObjectInt | ( | const BlisObjectInt & |  | ) |

Copy constructor.

BlisObjectInt::BlisObjectInt | ( |  | ) |

Default Constructor.

BlisObjectInt::BlisObjectInt | ( | int | objectIndex,
|  | int | iColumn,
|  | double | lb,
|  | double | ub,
|  | double | breakEven = `0.5` |
| ) |  |  |

Useful constructor - passed integer index and model index.

virtual BlisObjectInt::~BlisObjectInt | ( |  | ) | `[inline, virtual]`

Destructor.

Definition at line 68 of file BlisObjectInt.h.

BlisObjectInt::BlisObjectInt | ( | const BlisObjectInt & |  | ) |

Copy constructor.

## Member Function Documentation

virtual BcpsObject* BlisObjectInt::clone | ( |  | ) | const`[inline, virtual]`

Clone an object.

Reimplemented from BcpsObject.

Definition at line 74 of file BlisObjectInt.h.

BlisObjectInt& BlisObjectInt::operator= | ( | const BlisObjectInt & | rhs | ) |

Assignment operator.

Reimplemented from BcpsObject.

virtual double BlisObjectInt::infeasibility | ( | BcpsModel * | m,
|  | int & | preferredWay |
| ) |  |  | const`[virtual]`

Infeasibility.

Range is [0.0, 0.5].

Parameters:

  | PreferredWay | the direction close to an integer.

Reimplemented from BcpsObject.

virtual void BlisObjectInt::feasibleRegion | ( | BcpsModel * | m | ) | `[virtual]`

Set bounds to contain the current solution.

More precisely, for the variable associated with this object, take the value given in the current solution, force it within the current bounds if required, then set the bounds to fix the variable at the integer nearest the solution value.

Reimplemented from BcpsObject.

virtual BcpsBranchObject* BlisObjectInt::createBranchObject | ( | BcpsModel * | m,
|  | int | direction |
| ) |  |  | const`[virtual]`

Creates a branching object.

Reimplemented from BcpsObject.

virtual BcpsBranchObject* BlisObjectInt::preferredNewFeasible | ( | BcpsModel * | m | ) | const`[virtual]`

Given a valid solution (with reduced costs, etc.

), return a branching object which would give a new feasible point in the good direction.

The preferred branching object will force the variable to be +/-1 from its current value, depending on the reduced cost and objective sense. If movement in the direction which improves the objective is impossible due to bounds on the variable, the branching object will move in the other direction. If no movement is possible, the method returns NULL.

Only the bounds on this variable are considered when determining if the new point is feasible.

Reimplemented from BcpsObject.

virtual BcpsBranchObject* BlisObjectInt::notPreferredNewFeasible | ( | BcpsModel * | m | ) | const`[virtual]`

Given a valid solution (with reduced costs, etc.

), return a branching object which would give a new feasible point in a bad direction.

As for preferredNewFeasible(), but the preferred branching object will force movement in a direction that degrades the objective.

Reimplemented from BcpsObject.

virtual void BlisObjectInt::resetBounds | ( | BcpsModel * | m | ) | `[virtual]`

Reset original upper and lower bound values from the solver.

Handy for updating bounds held in this object after bounds held in the solver have been tightened.

Reimplemented from BcpsObject.

virtual int BlisObjectInt::columnIndex | ( |  | ) | const`[inline, virtual]`

Column number if single column object, otherwise.

Definition at line 129 of file BlisObjectInt.h.

double BlisObjectInt::originalLowerBound | ( |  | ) | const`[inline]`

Definition at line 133 of file BlisObjectInt.h.

void BlisObjectInt::setOriginalLowerBound | ( | double | value | ) | `[inline]`

Definition at line 134 of file BlisObjectInt.h.

double BlisObjectInt::originalUpperBound | ( |  | ) | const`[inline]`

Definition at line 135 of file BlisObjectInt.h.

void BlisObjectInt::setOriginalUpperBound | ( | double | value | ) | `[inline]`

Definition at line 136 of file BlisObjectInt.h.

double BlisObjectInt::breakEven | ( |  | ) | const`[inline]`

Breakeven e.g 0.7 -> >= 0.7 go up first.

Definition at line 140 of file BlisObjectInt.h.

void BlisObjectInt::setBreakEven | ( | double | value | ) | `[inline]`

Set breakeven e.g 0.7 -> >= 0.7 go up first.

Definition at line 143 of file BlisObjectInt.h.

BlisPseudocost& BlisObjectInt::pseudocost | ( |  | ) | `[inline]`

Access pseudocost.

Definition at line 146 of file BlisObjectInt.h.

virtual BcpsObject* BlisObjectInt::clone | ( |  | ) | const`[inline, virtual]`

Clone an object.

Reimplemented from BcpsObject.

Definition at line 74 of file BlisObjectInt.h.

BlisObjectInt& BlisObjectInt::operator= | ( | const BlisObjectInt & | rhs | ) |

Assignment operator.

Reimplemented from BcpsObject.

virtual double BlisObjectInt::infeasibility | ( | BcpsModel * | m,
|  | int & | preferredWay |
| ) |  |  | const`[virtual]`

Infeasibility.

Range is [0.0, 0.5].

Parameters:

  | PreferredWay | the direction close to an integer.

Reimplemented from BcpsObject.

virtual void BlisObjectInt::feasibleRegion | ( | BcpsModel * | m | ) | `[virtual]`

Set bounds to contain the current solution.

More precisely, for the variable associated with this object, take the value given in the current solution, force it within the current bounds if required, then set the bounds to fix the variable at the integer nearest the solution value.

Reimplemented from BcpsObject.

virtual BcpsBranchObject* BlisObjectInt::createBranchObject | ( | BcpsModel * | m,
|  | int | direction |
| ) |  |  | const`[virtual]`

Creates a branching object.

Reimplemented from BcpsObject.

virtual BcpsBranchObject* BlisObjectInt::preferredNewFeasible | ( | BcpsModel * | m | ) | const`[virtual]`

Given a valid solution (with reduced costs, etc.

), return a branching object which would give a new feasible point in the good direction.

The preferred branching object will force the variable to be +/-1 from its current value, depending on the reduced cost and objective sense. If movement in the direction which improves the objective is impossible due to bounds on the variable, the branching object will move in the other direction. If no movement is possible, the method returns NULL.

Only the bounds on this variable are considered when determining if the new point is feasible.

Reimplemented from BcpsObject.

virtual BcpsBranchObject* BlisObjectInt::notPreferredNewFeasible | ( | BcpsModel * | m | ) | const`[virtual]`

Given a valid solution (with reduced costs, etc.

), return a branching object which would give a new feasible point in a bad direction.

As for preferredNewFeasible(), but the preferred branching object will force movement in a direction that degrades the objective.

Reimplemented from BcpsObject.

virtual void BlisObjectInt::resetBounds | ( | BcpsModel * | m | ) | `[virtual]`

Reset original upper and lower bound values from the solver.

Handy for updating bounds held in this object after bounds held in the solver have been tightened.

Reimplemented from BcpsObject.

virtual int BlisObjectInt::columnIndex | ( |  | ) | const`[inline, virtual]`

Column number if single column object, otherwise.

Definition at line 129 of file BlisObjectInt.h.

double BlisObjectInt::originalLowerBound | ( |  | ) | const`[inline]`

Definition at line 133 of file BlisObjectInt.h.

void BlisObjectInt::setOriginalLowerBound | ( | double | value | ) | `[inline]`

Definition at line 134 of file BlisObjectInt.h.

double BlisObjectInt::originalUpperBound | ( |  | ) | const`[inline]`

Definition at line 135 of file BlisObjectInt.h.

void BlisObjectInt::setOriginalUpperBound | ( | double | value | ) | `[inline]`

Definition at line 136 of file BlisObjectInt.h.

double BlisObjectInt::breakEven | ( |  | ) | const`[inline]`

Breakeven e.g 0.7 -> >= 0.7 go up first.

Definition at line 140 of file BlisObjectInt.h.

void BlisObjectInt::setBreakEven | ( | double | value | ) | `[inline]`

Set breakeven e.g 0.7 -> >= 0.7 go up first.

Definition at line 143 of file BlisObjectInt.h.

BlisPseudocost& BlisObjectInt::pseudocost | ( |  | ) | `[inline]`

Access pseudocost.

Definition at line 146 of file BlisObjectInt.h.

## Member Data Documentation

int BlisObjectInt::columnIndex_`[protected]`

Column index in the lp model.

Definition at line 41 of file BlisObjectInt.h.

double BlisObjectInt::originalLower_`[protected]`

Original lower bound.

Definition at line 44 of file BlisObjectInt.h.

double BlisObjectInt::originalUpper_`[protected]`

Original upper bound.

Definition at line 47 of file BlisObjectInt.h.

double BlisObjectInt::breakEven_`[protected]`

Breakeven i.e.

>= this preferred is up.

Definition at line 50 of file BlisObjectInt.h.

BlisPseudocost BlisObjectInt::pseudocost_`[protected]`

Pseudo cost.

Definition at line 53 of file BlisObjectInt.h.

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

- /home/coin/svn-release/Blis-0.93.2/Bcps/examples/Blis/BlisObjectInt.h
- /home/coin/svn-release/Blis-0.93.2/Blis/src/BlisObjectInt.h