#include <OsiCuts.hpp>
Classes | |
class | const_iterator |
Const Iterator. More... | |
class | iterator |
Iterator. More... | |
class | OsiCutCompare |
Public Member Functions | |
Inserting a cut into collection | |
void | insert (const OsiRowCut &rc) |
Insert a row cut. | |
void | insertIfNotDuplicate (OsiRowCut &rc, CoinAbsFltEq treatAsSame=CoinAbsFltEq(1.0e-12)) |
Insert a row cut unless it is a duplicate - cut may get sorted. | |
void | insertIfNotDuplicate (OsiRowCut &rc, CoinRelFltEq treatAsSame) |
Insert a row cut unless it is a duplicate - cut may get sorted. | |
void | insert (const OsiColCut &cc) |
Insert a column cut. | |
void | insert (OsiRowCut *&rcPtr) |
Insert a row cut. | |
void | insert (OsiColCut *&ccPtr) |
Insert a column cut. | |
void | insert (const OsiCuts &cs) |
Insert a set of cuts. | |
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. | |
OsiRowCut * | rowCutPtrAndZap (int i) |
Get pointer to i'th row cut and remove ptr from collection. | |
void | dumpCuts () |
Clear all row cuts without deleting them. | |
void | eraseAndDumpCuts (const std::vector< int > to_erase) |
Selective delete and clear for row cuts. | |
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 () |
A function that tests the methods in the OsiCuts class. |
Definition at line 20 of file OsiCuts.hpp.
OsiCuts::OsiCuts | ( | ) |
Default constructor.
OsiCuts::OsiCuts | ( | const OsiCuts & | ) |
Copy constructor.
virtual OsiCuts::~OsiCuts | ( | ) | [virtual] |
Destructor.
void OsiCuts::insert | ( | const OsiRowCut & | rc | ) | [inline] |
void OsiCuts::insertIfNotDuplicate | ( | OsiRowCut & | rc, | |
CoinAbsFltEq | treatAsSame = CoinAbsFltEq(1.0e-12) | |||
) |
Insert a row cut unless it is a duplicate - cut may get sorted.
Duplicate is defined as CoinAbsFltEq says same
void OsiCuts::insertIfNotDuplicate | ( | OsiRowCut & | rc, | |
CoinRelFltEq | treatAsSame | |||
) |
Insert a row cut unless it is a duplicate - cut may get sorted.
Duplicate is defined as CoinRelFltEq says same
void OsiCuts::insert | ( | const OsiColCut & | cc | ) | [inline] |
void OsiCuts::insert | ( | OsiRowCut *& | rcPtr | ) | [inline] |
Insert a row cut.
The OsiCuts object takes control of the cut object. On return, rcPtr
is NULL.
Definition at line 320 of file OsiCuts.hpp.
void OsiCuts::insert | ( | OsiColCut *& | ccPtr | ) | [inline] |
Insert a column cut.
The OsiCuts object takes control of the cut object. On return ccPtr
is NULL.
Definition at line 325 of file OsiCuts.hpp.
void OsiCuts::insert | ( | const OsiCuts & | cs | ) | [inline] |
int OsiCuts::sizeRowCuts | ( | ) | const [inline] |
int OsiCuts::sizeColCuts | ( | ) | const [inline] |
int OsiCuts::sizeCuts | ( | ) | const [inline] |
void OsiCuts::printCuts | ( | ) | const [inline] |
OsiRowCut * OsiCuts::rowCutPtr | ( | int | i | ) | [inline] |
const OsiRowCut * OsiCuts::rowCutPtr | ( | int | i | ) | const [inline] |
OsiColCut * OsiCuts::colCutPtr | ( | int | i | ) | [inline] |
const OsiColCut * OsiCuts::colCutPtr | ( | int | i | ) | const [inline] |
OsiRowCut & OsiCuts::rowCut | ( | int | i | ) | [inline] |
const OsiRowCut & OsiCuts::rowCut | ( | int | i | ) | const [inline] |
OsiColCut & OsiCuts::colCut | ( | int | i | ) | [inline] |
const OsiColCut & OsiCuts::colCut | ( | int | i | ) | const [inline] |
const OsiCut * OsiCuts::mostEffectiveCutPtr | ( | ) | const [inline] |
OsiCut * OsiCuts::mostEffectiveCutPtr | ( | ) | [inline] |
void OsiCuts::eraseRowCut | ( | int | i | ) | [inline] |
void OsiCuts::eraseColCut | ( | int | i | ) | [inline] |
OsiRowCut * OsiCuts::rowCutPtrAndZap | ( | int | i | ) | [inline] |
Get pointer to i'th row cut and remove ptr from collection.
Definition at line 455 of file OsiCuts.hpp.
void OsiCuts::dumpCuts | ( | ) | [inline] |
Clear all row cuts without deleting them.
Handy in case one wants to use CGL without managing cuts in one of the OSI containers. Client is ultimately responsible for deleting the data structures holding the row cuts.
Definition at line 462 of file OsiCuts.hpp.
void OsiCuts::eraseAndDumpCuts | ( | const std::vector< int > | to_erase | ) | [inline] |
Selective delete and clear for row cuts.
Deletes the cuts specified in to_erase
then clears remaining cuts without deleting them. A hybrid of eraseRowCut(int) and dumpCuts(). Client is ultimately responsible for deleting the data structures for row cuts not specified in to_erase
.
Definition at line 466 of file OsiCuts.hpp.
void OsiCuts::sort | ( | ) | [inline] |
iterator OsiCuts::begin | ( | ) | [inline] |
const_iterator OsiCuts::begin | ( | ) | const [inline] |
iterator OsiCuts::end | ( | ) | [inline] |
const_iterator OsiCuts::end | ( | ) | const [inline] |
void OsiCuts::gutsOfCopy | ( | const OsiCuts & | source | ) | [private] |
Copy internal data.
void OsiCuts::gutsOfDestructor | ( | ) | [private] |
Delete internal data.
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.
OsiVectorRowCutPtr OsiCuts::rowCutPtrs_ [private] |
OsiVectorColCutPtr OsiCuts::colCutPtrs_ [private] |