OsiColCut Class Reference

#include <OsiColCut.hpp>

Inheritance diagram for OsiColCut:

List of all members.

Public Member Functions
Setting column bounds
void	setLbs (int nElements, const int *colIndices, const double *lbElements)
	Set column lower bounds.
void	setLbs (const CoinPackedVector &lbs)
	Set column lower bounds from a packed vector.
void	setUbs (int nElements, const int *colIndices, const double *ubElements)
	Set column upper bounds.
void	setUbs (const CoinPackedVector &ubs)
	Set column upper bounds from a packed vector.
Getting column bounds
const CoinPackedVector &	lbs () const
	Get column lower bounds.
const CoinPackedVector &	ubs () const
	Get column upper bounds.
Comparison operators
virtual bool	operator== (const OsiColCut &rhs) const
virtual bool	operator!= (const OsiColCut &rhs) const
	not equal
Sanity checks on cut
virtual bool	consistent () const
virtual bool	consistent (const OsiSolverInterface &im) const
virtual bool	infeasible (const OsiSolverInterface &im) const
virtual double	violated (const double *solution) const
Constructors and destructors
OsiColCut &	operator= (const OsiColCut &rhs)
	Assignment operator.
	OsiColCut (const OsiColCut &)
	Copy constructor.
	OsiColCut ()
	Default Constructor.
virtual OsiColCut *	clone () const
	Clone.
virtual	~OsiColCut ()
	Destructor.
Debug stuff
virtual void	print () const
	Print cuts in collection.
Private Attributes
Private member data
CoinPackedVector	lbs_
	Lower bounds.
CoinPackedVector	ubs_
	Upper bounds.
Friends
void	OsiColCutUnitTest (const OsiSolverInterface *baseSiP, const std::string &mpsDir)

---

Detailed Description

Column Cut Class

Column Cut Class has:

• a sparse vector of column lower bounds
• a sparse vector of column upper bounds

Definition at line 21 of file OsiColCut.hpp.

---

Member Function Documentation

bool OsiColCut::consistent (  const OsiSolverInterface &  im  )  const [inline, virtual]

Returns true if cut is consistent with respect to the solver interface's model. This checks to ensure that the lower & upperbound packed vectors: do not have an index >= the number of column is the model. Implements OsiCut. Definition at line 230 of file OsiColCut.hpp. References CoinPackedVectorBase::getMaxIndex(), OsiSolverInterface::getNumCols(), lbs(), and ubs(). { const CoinPackedVector & lb = lbs(); const CoinPackedVector & ub = ubs(); // Test for consistent cut. if ( lb.getMaxIndex() >= im.getNumCols() ) return false; if ( ub.getMaxIndex() >= im.getNumCols() ) return false; return true; }

bool OsiColCut::consistent (   )  const [inline, virtual]

Returns true if the cut is consistent with respect to itself. This checks to ensure that: The bound vectors do not have duplicate indices, The bound vectors indices are >=0 Implements OsiCut. Definition at line 217 of file OsiColCut.hpp. References CoinPackedVectorBase::duplicateIndex(), CoinPackedVectorBase::getMinIndex(), lbs(), and ubs(). { const CoinPackedVector & lb = lbs(); const CoinPackedVector & ub = ubs(); // Test for consistent cut. // Are packed vectors consistent? lb.duplicateIndex("consistent", "OsiColCut"); ub.duplicateIndex("consistent", "OsiColCut"); if ( lb.getMinIndex() < 0 ) return false; if ( ub.getMinIndex() < 0 ) return false; return true; }

bool OsiColCut::infeasible (  const OsiSolverInterface &  im  )  const [inline, virtual]

Returns true if the cut is infeasible with respect to its bounds and the column bounds in the solver interface's models. This checks whether: the maximum of the new and existing lower bounds is strictly greater than the minimum of the new and existing upper bounds. Implements OsiCut. Definition at line 281 of file OsiColCut.hpp. References OsiSolverInterface::getColLower(), OsiSolverInterface::getColUpper(), CoinPackedVector::getElements(), CoinPackedVector::getIndices(), CoinPackedVector::getNumElements(), CoinPackedVectorBase::isExistingIndex(), lbs(), and ubs(). { const double * oldColLb = im.getColLower(); const double * oldColUb = im.getColUpper(); const CoinPackedVector & cutLbs = lbs(); const CoinPackedVector & cutUbs = ubs(); int i; for ( i=0; i<cutLbs.getNumElements(); i++ ) { int colIndx = cutLbs.getIndices()[i]; double newLb= cutLbs.getElements()[i] > oldColLb[colIndx] ? cutLbs.getElements()[i] : oldColLb[colIndx]; double newUb = oldColUb[colIndx]; if ( cutUbs.isExistingIndex(colIndx) ) if ( cutUbs[colIndx] < newUb ) newUb = cutUbs[colIndx]; if ( newLb > newUb ) return true; } for ( i=0; i<cutUbs.getNumElements(); i++ ) { int colIndx = cutUbs.getIndices()[i]; double newUb = cutUbs.getElements()[i] < oldColUb[colIndx] ? cutUbs.getElements()[i] : oldColUb[colIndx]; double newLb = oldColLb[colIndx]; if ( cutLbs.isExistingIndex(colIndx) ) if ( cutLbs[colIndx] > newLb ) newLb = cutLbs[colIndx]; if ( newUb < newLb ) return true; } return false; }

bool OsiColCut::operator== (  const OsiColCut &  rhs  )  const [inline, virtual]

equal - true if lower bounds, upper bounds, and OsiCut are equal. Definition at line 195 of file OsiColCut.hpp. References lbs(), OsiCut::operator!=(), and ubs(). { if ( this->OsiCut::operator!=(rhs) ) return false; if ( lbs() != rhs.lbs() ) return false; if ( ubs() != rhs.ubs() ) return false; return true; }

virtual double OsiColCut::violated (  const double *  solution  )  const [virtual]

Returns infeasibility of the cut with respect to solution passed in i.e. is positive if cuts off that solution. solution is getNumCols() long.. Implements OsiCut.

---

Friends And Related Function Documentation

void OsiColCutUnitTest (  const OsiSolverInterface *  baseSiP, const std::string &  mpsDir )  [friend]

A function that tests the methods in the OsiColCut class. The only reason for it not to be a member method is that this way it doesn't have to be compiled into the library. And that's a gain, because the library should be compiled with optimization on, but this method should be compiled with debugging. Definition at line 20 of file OsiColCutTest.cpp. { // Test default constructor { OsiColCut r; assert( r.lbs_.getIndices()==NULL ); assert( r.lbs_.getElements()==NULL ); assert( r.ubs_.getIndices()==NULL ); assert( r.ubs_.getElements()==NULL ); assert( r.lbs_.getNumElements()==0); assert( r.ubs_.getNumElements()==0); } // Test set and get methods const int ne = 4; int inx[ne] = { 1, 3, 4, 7 }; double el[ne] = { 1.2, 3.4, 5.6, 7.8 }; const int ne3 = 0; int * inx3=NULL; double * el3= NULL; { OsiColCut r; assert( r.lbs().getNumElements()==0 ); assert( r.ubs().getNumElements()==0 ); // Test setting/getting bounds r.setLbs( ne, inx, el ); r.setEffectiveness(222.); assert( r.lbs().getNumElements()==ne ); for ( int i=0; i<ne; i++ ) { assert( r.lbs().getIndices()[i] == inx[i] ); assert( r.lbs().getElements()[i] == el[i] ); } assert( r.effectiveness()==222. ); r.setUbs( ne3, inx3, el3 ); assert( r.ubs().getNumElements()==0 ); assert( r.ubs().getIndices()==NULL ); assert( r.ubs().getElements()==NULL ); } // Test copy constructor and assignment operator { OsiColCut rhs; { OsiColCut r; OsiColCut rC1(r); assert( rC1.lbs().getNumElements()==r.lbs().getNumElements() ); assert( rC1.ubs().getNumElements()==r.ubs().getNumElements() ); r.setLbs( ne, inx, el ); r.setUbs( ne, inx, el ); r.setEffectiveness(121.); assert( rC1.lbs().getNumElements()!=r.lbs().getNumElements() ); assert( rC1.ubs().getNumElements()!=r.ubs().getNumElements() ); OsiColCut rC2(r); assert( rC2.lbs().getNumElements()==r.lbs().getNumElements() ); assert( rC2.ubs().getNumElements()==r.ubs().getNumElements() ); assert( rC2.lbs().getNumElements()==ne ); assert( rC2.ubs().getNumElements()==ne ); for ( int i=0; i<ne; i++ ) { assert( rC2.lbs().getIndices()[i] == inx[i] ); assert( rC2.lbs().getElements()[i] == el[i] ); assert( rC2.ubs().getIndices()[i] == inx[i] ); assert( rC2.ubs().getElements()[i] == el[i] ); } assert( rC2.effectiveness()==121. ); rhs=rC2; } // Test that rhs has correct values even though lhs has gone out of scope assert( rhs.lbs().getNumElements()==ne ); assert( rhs.ubs().getNumElements()==ne ); for ( int i=0; i<ne; i++ ) { assert( rhs.lbs().getIndices()[i] == inx[i] ); assert( rhs.lbs().getElements()[i] == el[i] ); assert( rhs.ubs().getIndices()[i] == inx[i] ); assert( rhs.ubs().getElements()[i] == el[i] ); } assert( rhs.effectiveness()==121. ); } // Test setting bounds with packed vector and operator== { const int ne1 = 4; int inx1[ne] = { 1, 3, 4, 7 }; double el1[ne] = { 1.2, 3.4, 5.6, 7.8 }; const int ne2 = 2; int inx2[ne2]={ 1, 3 }; double el2[ne2]= { 1.2, 3.4 }; CoinPackedVector v1,v2; v1.setVector(ne1,inx1,el1); v2.setVector(ne2,inx2,el2); OsiColCut c1,c2; assert( c1==c2 ); assert( !(c1!=c2) ); c1.setLbs(v1); assert( c1 != c2 ); assert( !(c1 == c2) ); assert( c1.lbs()==v1 ); c1.setUbs(v2); assert( c1.ubs()==v2 ); c1.setEffectiveness(3.); assert( c1.effectiveness()==3. ); { OsiColCut c3(c1); assert( c3==c1 ); assert( !(c3!=c1) ); } { OsiColCut c3(c1); c3.setLbs(v2); assert( c3!=c1 ); assert( !(c3==c1) ); } { OsiColCut c3(c1); c3.setUbs(v1); assert( c3!=c1 ); assert( !(c3==c1) ); } { OsiColCut c3(c1); c3.setEffectiveness(5.); assert( c3!=c1 ); assert( !(c3==c1) ); } } // internal consistency { const int ne = 1; int inx[ne] = { -3 }; double el[ne] = { 1.2 }; OsiColCut r; r.setLbs( ne, inx, el ); assert( !r.consistent() ); } { const int ne = 1; int inx[ne] = { -3 }; double el[ne] = { 1.2 }; OsiColCut r; r.setUbs( ne, inx, el ); assert( !r.consistent() ); } { const int ne = 1; int inx[ne] = { 100 }; double el[ne] = { 1.2 }; const int ne1 = 2; int inx1[ne1] = { 50, 100 }; double el1[ne1] = { 100., 100. }; OsiColCut r; r.setUbs( ne, inx, el ); r.setLbs( ne1, inx1, el1 ); assert( r.consistent() ); OsiSolverInterface * imP = baseSiP->clone(); std::string fn = mpsDir+"exmip1"; imP->readMps(fn.c_str(),"mps"); assert( !r.consistent(*imP) ); delete imP; } { const int ne = 1; int inx[ne] = { 100 }; double el[ne] = { 1.2 }; const int ne1 = 2; int inx1[ne1] = { 50, 100 }; double el1[ne1] = { 100., 1. }; OsiColCut r; r.setUbs( ne, inx, el ); r.setLbs( ne1, inx1, el1 ); assert( r.consistent() ); } { // Test consistent(IntegerModel) method. OsiSolverInterface * imP = baseSiP->clone(); std::string fn = mpsDir+"exmip1"; imP->readMps(fn.c_str(),"mps"); OsiColCut cut; const int ne=1; int inx[ne]={20}; double el[ne]={0.25}; cut.setLbs(ne,inx,el); assert( !cut.consistent(*imP) ); cut.setLbs(0,NULL,NULL); cut.setUbs(ne,inx,el); assert( !cut.consistent(*imP) ); inx[0]=4; cut.setLbs(ne,inx,el); cut.setUbs(0,NULL,NULL); assert( cut.consistent(*imP) ); el[0]=4.5; cut.setLbs(0,NULL,NULL); cut.setUbs(ne,inx,el); assert( cut.consistent(*imP) ); cut.setLbs(ne,inx,el); cut.setUbs(0,NULL,NULL); assert( cut.consistent(*imP) ); // Vailid but infeasible assert( cut.infeasible(*imP) ); el[0]=3.0; cut.setLbs(ne,inx,el); cut.setUbs(ne,inx,el); assert( cut.consistent(*imP) ); delete imP; } { //Test infeasible(im) method // Test consistent(IntegerModel) method. OsiSolverInterface * imP = baseSiP->clone(); std::string fn = mpsDir+"exmip1"; imP->readMps(fn.c_str(),"mps"); OsiColCut cut; const int ne=1; int inx[ne]={4}; double el[ne]={4.5}; cut.setLbs(ne,inx,el); assert( cut.infeasible(*imP) ); el[0]=0.25; cut.setLbs(0,NULL,NULL); cut.setUbs(ne,inx,el); assert( cut.infeasible(*imP) ); el[0]=3.0; cut.setLbs(ne,inx,el); cut.setUbs(ne,inx,el); assert( !cut.infeasible(*imP) ); delete imP; } { //Test violation double solution[]={1.0}; OsiColCut cut; const int ne=1; int inx[ne]={0}; double el[ne]={4.5}; cut.setLbs(ne,inx,el); assert( cut.violated(solution) ); el[0]=0.25; cut.setLbs(0,NULL,NULL); cut.setUbs(ne,inx,el); assert( cut.violated(solution) ); el[0]=1.0; cut.setLbs(ne,inx,el); cut.setUbs(ne,inx,el); assert( !cut.violated(solution) ); } }

---

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

• OsiColCut.hpp

---