OsiCuts Class Reference

#include <OsiCuts.hpp>

List of all members.

Public Member Functions
Inserting a cut into collection
void	insert (const OsiRowCut &rc)
	Insert row cut.
void	insert (const OsiColCut &cc)
	Insert column cut.
Inserting a cut into collection using a pointer reference
The OsiCuts class takes control of and manages the storage for the cut including the deletion of the cut.
void	insert (OsiRowCut *&rcPtr)
	Insert row cut. On return rcPtr is NULL.
void	insert (OsiColCut *&ccPtr)
	Insert column cut. On return ccPtr is NULL.
Number of cuts in collection
int	sizeRowCuts () const
	Number of row cuts in collection.
int	sizeColCuts () const
	Number of column cuts in collection.
int	sizeCuts () const
	Number of cuts in collection.
Debug stuff
void	printCuts () const
	Print cuts in collection.
Get a cut from collection
OsiRowCut *	rowCutPtr (int i)
	Get pointer to i'th row cut.
const OsiRowCut *	rowCutPtr (int i) const
	Get const pointer to i'th row cut.
OsiColCut *	colCutPtr (int i)
	Get pointer to i'th column cut.
const OsiColCut *	colCutPtr (int i) const
	Get const pointer to i'th column cut.
OsiRowCut &	rowCut (int i)
	Get reference to i'th row cut.
const OsiRowCut &	rowCut (int i) const
	Get const reference to i'th row cut.
OsiColCut &	colCut (int i)
	Get reference to i'th column cut.
const OsiColCut &	colCut (int i) const
	Get const reference to i'th column cut.
const OsiCut *	mostEffectiveCutPtr () const
	Get const pointer to the most effective cut.
OsiCut *	mostEffectiveCutPtr ()
	Get pointer to the most effective cut.
Deleting cut from collection
void	eraseRowCut (int i)
	Remove i'th row cut from collection.
void	eraseColCut (int i)
	Remove i'th column cut from collection.
Sorting collection
void	sort ()
	Cuts with greatest effectiveness are first.
Iterators
Example of using an iterator to sum effectiveness of all cuts in the collection. double sumEff=0.0; for ( OsiCuts::iterator it=cuts.begin(); it!=cuts.end(); ++it ) sumEff+= (*it)->effectiveness();
iterator	begin ()
	Get iterator to beginning of collection.
const_iterator	begin () const
	Get const iterator to beginning of collection.
iterator	end ()
	Get iterator to end of collection.
const_iterator	end () const
	Get const iterator to end of collection.
Constructors and destructors
	OsiCuts ()
	Default constructor.
	OsiCuts (const OsiCuts &)
	Copy constructor.
OsiCuts &	operator= (const OsiCuts &rhs)
	Assignment operator.
virtual	~OsiCuts ()
	Destructor.
Private Member Functions
Private methods
void	gutsOfCopy (const OsiCuts &source)
	Copy internal data.
void	gutsOfDestructor ()
	Delete internal data.
Private Attributes
Private member data
OsiVectorRowCutPtr	rowCutPtrs_
	Vector of row cuts pointers.
OsiVectorColCutPtr	colCutPtrs_
	Vector of column cuts pointers.
Friends
void	OsiCutsUnitTest ()

---

Detailed Description

Collections of row cuts and column cuts

Definition at line 19 of file OsiCuts.hpp.

---

Friends And Related Function Documentation

void OsiCutsUnitTest (   )  [friend]

A function that tests the methods in the OsiCuts 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 18 of file OsiCutsTest.cpp. { CoinRelFltEq eq; // Test default constructor { OsiCuts r; assert( r.colCutPtrs_.empty() ); assert( r.rowCutPtrs_.empty() ); assert( r.sizeColCuts()==0 ); assert( r.sizeRowCuts()==0 ); assert( r.sizeCuts()==0 ); assert( r.mostEffectiveCutPtr()==NULL ); } // Create some cuts OsiRowCut rcv[5]; OsiColCut ccv[5]; int i; for ( i=0; i<5; i++ ) { rcv[i].setEffectiveness(100.+i); ccv[i].setEffectiveness(200.+i); } OsiCuts rhs; { OsiCuts cs; // test inserting & accessing cut for ( i=0; i<5; i++ ) { assert( cs.sizeRowCuts()==i); assert( cs.sizeCuts()==2*i); cs.insert(rcv[i]); assert( cs.sizeRowCuts()==i+1); assert( cs.sizeCuts()==2*i+1); assert( cs.rowCut(i)==rcv[i] ); #if 0 const OsiCut * cp = cs.cutPtr(2*i); assert( cs.rowCut(i).effectiveness() == cp->effectiveness() ); const OsiRowCut * rcP = dynamic_cast<const OsiRowCut*>( cp ); assert( rcP != NULL ); assert( *rcP == rcv[i] ); const OsiColCut * ccP = dynamic_cast<const OsiColCut*>( cs.cutPtr(2*i) ); assert( ccP == NULL ); #endif assert( cs.sizeColCuts()==i); assert( cs.sizeCuts()==2*i+1); cs.insert(ccv[i]); assert( cs.sizeColCuts()==i+1); assert( cs.sizeCuts()==2*i+2); assert( cs.colCut(i)==ccv[i] ); #if 0 rcP = dynamic_cast<const OsiRowCut*>( cs.cutPtr(2*i+1) ); assert( rcP == NULL ); ccP = dynamic_cast<const OsiColCut*>( cs.cutPtr(2*i+1) ); assert( ccP != NULL ); assert( *ccP == ccv[i] ); #endif assert( eq(cs.mostEffectiveCutPtr()->effectiveness(),200.0+i) ); } { OsiCuts cs; // test inserting cut ptr & accessing cut for ( i=0; i<5; i++ ) { assert( cs.sizeRowCuts()==i); OsiRowCut * rcP = rcv[i].clone(); assert( rcP != NULL ); cs.insert(rcP); assert( rcP == NULL ); assert( cs.sizeRowCuts()==i+1); assert( cs.rowCut(i)==rcv[i] ); OsiColCut * ccP = ccv[i].clone(); assert( ccP != NULL ); assert( cs.sizeColCuts()==i); cs.insert(ccP); assert( ccP == NULL ); assert( cs.sizeColCuts()==i+1); assert( cs.colCut(i)==ccv[i] ); assert( eq(cs.mostEffectiveCutPtr()->effectiveness(),200.0+i) ); } } // Test copy constructor OsiCuts csC(cs); assert( csC.sizeRowCuts()==5 ); assert( csC.sizeColCuts()==5 ); for ( i=0; i<5; i++ ) { assert( csC.rowCut(i) == rcv[i] ); assert( csC.colCut(i) == ccv[i] ); assert( csC.rowCut(i) == cs.rowCut(i) ); assert( csC.colCut(i) == cs.colCut(i) ); } assert( eq(csC.mostEffectiveCutPtr()->effectiveness(),204.0) ); rhs=cs; } // Test results of assigmnet operation for ( i=0; i<5; i++ ) { assert( rhs.rowCut(i) == rcv[i] ); assert( rhs.colCut(i) == ccv[i] ); } assert( eq(rhs.mostEffectiveCutPtr()->effectiveness(),204.0) ); // Test removing cuts { OsiCuts t(rhs); assert( t.sizeRowCuts()==5 ); assert( t.sizeColCuts()==5 ); assert( eq(rhs.mostEffectiveCutPtr()->effectiveness(),204.0) ); assert( eq(t.mostEffectiveCutPtr()->effectiveness(),204.0) ); t.eraseRowCut(3); assert( t.sizeRowCuts()==4 ); assert( t.sizeColCuts()==5 ); for ( i=0; i<5; i++ ) { assert( t.colCut(i) == ccv[i] ); } assert( t.rowCut(0)==rcv[0] ); assert( t.rowCut(1)==rcv[1] ); assert( t.rowCut(2)==rcv[2] ); assert( t.rowCut(3)==rcv[4] ); assert( eq(t.mostEffectiveCutPtr()->effectiveness(),204.0) ); t.eraseColCut(4); assert( t.sizeRowCuts()==4 ); assert( t.sizeColCuts()==4 ); for ( i=0; i<4; i++ ) { assert( t.colCut(i) == ccv[i] ); } assert( t.rowCut(0)==rcv[0] ); assert( t.rowCut(1)==rcv[1] ); assert( t.rowCut(2)==rcv[2] ); assert( t.rowCut(3)==rcv[4] ); assert( eq(t.mostEffectiveCutPtr()->effectiveness(),203.0) ); } // sorting cuts { OsiCuts t(rhs); assert( t.sizeRowCuts()==5 ); assert( t.sizeColCuts()==5 ); t.rowCut(0).setEffectiveness(9.); t.rowCut(1).setEffectiveness(1.); t.rowCut(2).setEffectiveness(7.); t.rowCut(3).setEffectiveness(3.); t.rowCut(4).setEffectiveness(5.); t.colCut(0).setEffectiveness(2.); t.colCut(1).setEffectiveness(8.); t.colCut(2).setEffectiveness(4.); t.colCut(3).setEffectiveness(6.); t.colCut(4).setEffectiveness(.5); double totEff=1.+2.+3.+4.+5.+6.+7.+8.+9.+0.5; { // Test iterator over all cuts double sumEff=0.; for ( OsiCuts::iterator it=t.begin(); it!=t.end(); ++it ) { double eff=(*it)->effectiveness(); sumEff+= eff; } assert( sumEff == totEff ); } t.sort(); for ( i=1; i<5; i++ ) assert( t.colCut(i-1)>t.colCut(i) ); for ( i=1; i<5; i++ ) assert( t.rowCut(i-1)>t.rowCut(i) ); { // Test iterator over all cuts double sumEff=0.; for ( OsiCuts::iterator it=t.begin(); it!=t.end(); ++it ) { sumEff+= (*it)->effectiveness(); } assert( sumEff == totEff ); } { OsiCuts::iterator it=t.begin(); OsiCut * cm1 = *it; ++it; for( ; it!=t.end(); it++ ) { OsiCut * c = *it; assert( (*cm1)>(*c) ); cm1 = c; } } } }

---

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

• OsiCuts.hpp

---