Cbc trunk
CbcCutGenerator Class Reference

Interface between Cbc and Cut Generation Library. More...

#include <CbcCutGenerator.hpp>

Collaboration diagram for CbcCutGenerator:

List of all members.

Public Member Functions

Generate Cuts
bool generateCuts (OsiCuts &cs, int fullScan, OsiSolverInterface *solver, CbcNode *node)
 Generate cuts for the client model.
Constructors and destructors
 CbcCutGenerator ()
 Default constructor.
 CbcCutGenerator (CbcModel *model, CglCutGenerator *generator, int howOften=1, const char *name=NULL, bool normal=true, bool atSolution=false, bool infeasible=false, int howOftenInsub=-100, int whatDepth=-1, int whatDepthInSub=-1, int switchOffIfLessThan=0)
 Normal constructor.
 CbcCutGenerator (const CbcCutGenerator &)
 Copy constructor.
CbcCutGeneratoroperator= (const CbcCutGenerator &rhs)
 Assignment operator.
 ~CbcCutGenerator ()
 Destructor.
Gets and sets
void refreshModel (CbcModel *model)
 Set the client model.
const char * cutGeneratorName () const
 return name of generator
void generateTuning (FILE *fp)
 Create C++ lines to show how to tune.
void setHowOften (int value)
 Set the cut generation interval.
int howOften () const
 Get the cut generation interval.
int howOftenInSub () const
 Get the cut generation interval.in sub tree.
int inaccuracy () const
 Get level of cut inaccuracy (0 means exact e.g. cliques)
void setInaccuracy (int level)
 Set level of cut inaccuracy (0 means exact e.g. cliques)
void setWhatDepth (int value)
 Set the cut generation depth.
void setWhatDepthInSub (int value)
 Set the cut generation depth in sub tree.
int whatDepth () const
 Get the cut generation depth criterion.
int whatDepthInSub () const
 Get the cut generation depth criterion.in sub tree.
bool normal () const
 Get whether the cut generator should be called in the normal place.
void setNormal (bool value)
 Set whether the cut generator should be called in the normal place.
bool atSolution () const
 Get whether the cut generator should be called when a solution is found.
void setAtSolution (bool value)
 Set whether the cut generator should be called when a solution is found.
bool whenInfeasible () const
 Get whether the cut generator should be called when the subproblem is found to be infeasible.
void setWhenInfeasible (bool value)
 Set whether the cut generator should be called when the subproblem is found to be infeasible.
bool timing () const
 Get whether the cut generator is being timed.
void setTiming (bool value)
 Set whether the cut generator is being timed.
double timeInCutGenerator () const
 Return time taken in cut generator.
void incrementTimeInCutGenerator (double value)
CglCutGenerator * generator () const
 Get the CglCutGenerator corresponding to this CbcCutGenerator.
int numberTimesEntered () const
 Number times cut generator entered.
void setNumberTimesEntered (int value)
void incrementNumberTimesEntered (int value=1)
int numberCutsInTotal () const
 Total number of cuts added.
void setNumberCutsInTotal (int value)
void incrementNumberCutsInTotal (int value=1)
int numberElementsInTotal () const
 Total number of elements added.
void setNumberElementsInTotal (int value)
void incrementNumberElementsInTotal (int value=1)
int numberColumnCuts () const
 Total number of column cuts.
void setNumberColumnCuts (int value)
void incrementNumberColumnCuts (int value=1)
int numberCutsActive () const
 Total number of cuts active after (at end of n cut passes at each node)
void setNumberCutsActive (int value)
void incrementNumberCutsActive (int value=1)
void setSwitchOffIfLessThan (int value)
int switchOffIfLessThan () const
bool needsOptimalBasis () const
 Say if optimal basis needed.
void setNeedsOptimalBasis (bool yesNo)
 Set if optimal basis needed.
bool mustCallAgain () const
 Whether generator MUST be called again if any cuts (i.e. ignore break from loop)
void setMustCallAgain (bool yesNo)
 Set whether generator MUST be called again if any cuts (i.e. ignore break from loop)
bool switchedOff () const
 Whether generator switched off for moment.
void setSwitchedOff (bool yesNo)
 Set whether generator switched off for moment.
bool ineffectualCuts () const
 Whether last round of cuts did little.
void setIneffectualCuts (bool yesNo)
 Set whether last round of cuts did little.
bool whetherToUse () const
 Whether to use if any cuts generated.
void setWhetherToUse (bool yesNo)
 Set whether to use if any cuts generated.
int numberCutsAtRoot () const
 Number of cuts generated at root.
void setNumberCutsAtRoot (int value)
int numberActiveCutsAtRoot () const
 Number of cuts active at root.
void setNumberActiveCutsAtRoot (int value)
int numberShortCutsAtRoot () const
 Number of short cuts at root.
void setModel (CbcModel *model)
 Set model.
bool globalCutsAtRoot () const
 Whether global cuts at root.
void setGlobalCutsAtRoot (bool yesNo)
 Set whether global cuts at root.
bool globalCuts () const
 Whether global cuts.
void setGlobalCuts (bool yesNo)
 Set whether global cuts.

Detailed Description

Interface between Cbc and Cut Generation Library.

CbcCutGenerator is intended to provide an intelligent interface between Cbc and the cutting plane algorithms in the CGL. A CbcCutGenerator is bound to a CglCutGenerator and to an CbcModel. It contains parameters which control when and how the generateCuts method of the CglCutGenerator will be called.

The builtin decision criteria available to use when deciding whether to generate cuts are limited: every X nodes, when a solution is found, and when a subproblem is found to be infeasible. The idea is that the class will grow more intelligent with time.

Todo:
Add a pointer to function member which will allow a client to install their own decision algorithm to decide whether or not to call the CGL generateCuts method. Create a default decision method that looks at the builtin criteria.
Todo:
It strikes me as not good that generateCuts contains code specific to individual CGL algorithms. Another set of pointer to function members, so that the client can specify the cut generation method as well as pre- and post-generation methods? Taken a bit further, should this class contain a bunch of pointer to function members, one for each of the places where the cut generator might be referenced? Initialization, root node, search tree node, discovery of solution, and termination all come to mind. Initialization and termination would also be useful for instrumenting cbc.

Definition at line 49 of file CbcCutGenerator.hpp.


Constructor & Destructor Documentation

CbcCutGenerator::CbcCutGenerator ( )

Default constructor.

CbcCutGenerator::CbcCutGenerator ( CbcModel model,
CglCutGenerator *  generator,
int  howOften = 1,
const char *  name = NULL,
bool  normal = true,
bool  atSolution = false,
bool  infeasible = false,
int  howOftenInsub = -100,
int  whatDepth = -1,
int  whatDepthInSub = -1,
int  switchOffIfLessThan = 0 
)

Normal constructor.

CbcCutGenerator::CbcCutGenerator ( const CbcCutGenerator )

Copy constructor.

CbcCutGenerator::~CbcCutGenerator ( )

Destructor.


Member Function Documentation

bool CbcCutGenerator::generateCuts ( OsiCuts &  cs,
int  fullScan,
OsiSolverInterface *  solver,
CbcNode node 
)

Generate cuts for the client model.

Evaluate the state of the client model and decide whether to generate cuts. The generated cuts are inserted into and returned in the collection of cuts cs.

If fullScan is !=0, the generator is obliged to call the CGL generateCuts routine. Otherwise, it is free to make a local decision. Negative fullScan says things like at integer solution The current implementation uses whenCutGenerator_ to decide.

The routine returns true if reoptimisation is needed (because the state of the solver interface has been modified).

If node then can find out depth

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

Assignment operator.

void CbcCutGenerator::refreshModel ( CbcModel model)

Set the client model.

In addition to setting the client model, refreshModel also calls the refreshSolver method of the CglCutGenerator object.

const char* CbcCutGenerator::cutGeneratorName ( ) const [inline]

return name of generator

Definition at line 108 of file CbcCutGenerator.hpp.

void CbcCutGenerator::generateTuning ( FILE *  fp)

Create C++ lines to show how to tune.

void CbcCutGenerator::setHowOften ( int  value)

Set the cut generation interval.

Set the number of nodes evaluated between calls to the Cgl object's generateCuts routine.

If value is positive, cuts will always be generated at the specified interval. If value is negative, cuts will initially be generated at the specified interval, but Cbc may adjust the value depending on the success of cuts produced by this generator.

A value of -100 disables the generator, while a value of -99 means just at root.

int CbcCutGenerator::howOften ( ) const [inline]

Get the cut generation interval.

Definition at line 131 of file CbcCutGenerator.hpp.

int CbcCutGenerator::howOftenInSub ( ) const [inline]

Get the cut generation interval.in sub tree.

Definition at line 135 of file CbcCutGenerator.hpp.

int CbcCutGenerator::inaccuracy ( ) const [inline]

Get level of cut inaccuracy (0 means exact e.g. cliques)

Definition at line 139 of file CbcCutGenerator.hpp.

void CbcCutGenerator::setInaccuracy ( int  level) [inline]

Set level of cut inaccuracy (0 means exact e.g. cliques)

Definition at line 143 of file CbcCutGenerator.hpp.

void CbcCutGenerator::setWhatDepth ( int  value)

Set the cut generation depth.

Set the depth criterion for calls to the Cgl object's generateCuts routine. Only active if > 0.

If whenCutGenerator is positive and this is positive then this overrides. If whenCutGenerator is -1 then this is used as criterion if any cuts were generated at root node. If whenCutGenerator is anything else this is ignored.

void CbcCutGenerator::setWhatDepthInSub ( int  value)

Set the cut generation depth in sub tree.

int CbcCutGenerator::whatDepth ( ) const [inline]

Get the cut generation depth criterion.

Definition at line 161 of file CbcCutGenerator.hpp.

int CbcCutGenerator::whatDepthInSub ( ) const [inline]

Get the cut generation depth criterion.in sub tree.

Definition at line 165 of file CbcCutGenerator.hpp.

bool CbcCutGenerator::normal ( ) const [inline]

Get whether the cut generator should be called in the normal place.

Definition at line 170 of file CbcCutGenerator.hpp.

void CbcCutGenerator::setNormal ( bool  value) [inline]

Set whether the cut generator should be called in the normal place.

Definition at line 174 of file CbcCutGenerator.hpp.

bool CbcCutGenerator::atSolution ( ) const [inline]

Get whether the cut generator should be called when a solution is found.

Definition at line 179 of file CbcCutGenerator.hpp.

void CbcCutGenerator::setAtSolution ( bool  value) [inline]

Set whether the cut generator should be called when a solution is found.

Definition at line 183 of file CbcCutGenerator.hpp.

bool CbcCutGenerator::whenInfeasible ( ) const [inline]

Get whether the cut generator should be called when the subproblem is found to be infeasible.

Definition at line 190 of file CbcCutGenerator.hpp.

void CbcCutGenerator::setWhenInfeasible ( bool  value) [inline]

Set whether the cut generator should be called when the subproblem is found to be infeasible.

Definition at line 196 of file CbcCutGenerator.hpp.

bool CbcCutGenerator::timing ( ) const [inline]

Get whether the cut generator is being timed.

Definition at line 201 of file CbcCutGenerator.hpp.

void CbcCutGenerator::setTiming ( bool  value) [inline]

Set whether the cut generator is being timed.

Definition at line 205 of file CbcCutGenerator.hpp.

double CbcCutGenerator::timeInCutGenerator ( ) const [inline]

Return time taken in cut generator.

Definition at line 211 of file CbcCutGenerator.hpp.

void CbcCutGenerator::incrementTimeInCutGenerator ( double  value) [inline]

Definition at line 214 of file CbcCutGenerator.hpp.

CglCutGenerator* CbcCutGenerator::generator ( ) const [inline]

Get the CglCutGenerator corresponding to this CbcCutGenerator.

Definition at line 218 of file CbcCutGenerator.hpp.

int CbcCutGenerator::numberTimesEntered ( ) const [inline]

Number times cut generator entered.

Definition at line 222 of file CbcCutGenerator.hpp.

void CbcCutGenerator::setNumberTimesEntered ( int  value) [inline]

Definition at line 225 of file CbcCutGenerator.hpp.

void CbcCutGenerator::incrementNumberTimesEntered ( int  value = 1) [inline]

Definition at line 228 of file CbcCutGenerator.hpp.

int CbcCutGenerator::numberCutsInTotal ( ) const [inline]

Total number of cuts added.

Definition at line 232 of file CbcCutGenerator.hpp.

void CbcCutGenerator::setNumberCutsInTotal ( int  value) [inline]

Definition at line 235 of file CbcCutGenerator.hpp.

void CbcCutGenerator::incrementNumberCutsInTotal ( int  value = 1) [inline]

Definition at line 238 of file CbcCutGenerator.hpp.

int CbcCutGenerator::numberElementsInTotal ( ) const [inline]

Total number of elements added.

Definition at line 242 of file CbcCutGenerator.hpp.

void CbcCutGenerator::setNumberElementsInTotal ( int  value) [inline]

Definition at line 245 of file CbcCutGenerator.hpp.

void CbcCutGenerator::incrementNumberElementsInTotal ( int  value = 1) [inline]

Definition at line 248 of file CbcCutGenerator.hpp.

int CbcCutGenerator::numberColumnCuts ( ) const [inline]

Total number of column cuts.

Definition at line 252 of file CbcCutGenerator.hpp.

void CbcCutGenerator::setNumberColumnCuts ( int  value) [inline]

Definition at line 255 of file CbcCutGenerator.hpp.

void CbcCutGenerator::incrementNumberColumnCuts ( int  value = 1) [inline]

Definition at line 258 of file CbcCutGenerator.hpp.

int CbcCutGenerator::numberCutsActive ( ) const [inline]

Total number of cuts active after (at end of n cut passes at each node)

Definition at line 262 of file CbcCutGenerator.hpp.

void CbcCutGenerator::setNumberCutsActive ( int  value) [inline]

Definition at line 265 of file CbcCutGenerator.hpp.

void CbcCutGenerator::incrementNumberCutsActive ( int  value = 1) [inline]

Definition at line 268 of file CbcCutGenerator.hpp.

void CbcCutGenerator::setSwitchOffIfLessThan ( int  value) [inline]

Definition at line 271 of file CbcCutGenerator.hpp.

int CbcCutGenerator::switchOffIfLessThan ( ) const [inline]

Definition at line 274 of file CbcCutGenerator.hpp.

bool CbcCutGenerator::needsOptimalBasis ( ) const [inline]

Say if optimal basis needed.

Definition at line 278 of file CbcCutGenerator.hpp.

void CbcCutGenerator::setNeedsOptimalBasis ( bool  yesNo) [inline]

Set if optimal basis needed.

Definition at line 282 of file CbcCutGenerator.hpp.

bool CbcCutGenerator::mustCallAgain ( ) const [inline]

Whether generator MUST be called again if any cuts (i.e. ignore break from loop)

Definition at line 287 of file CbcCutGenerator.hpp.

void CbcCutGenerator::setMustCallAgain ( bool  yesNo) [inline]

Set whether generator MUST be called again if any cuts (i.e. ignore break from loop)

Definition at line 291 of file CbcCutGenerator.hpp.

bool CbcCutGenerator::switchedOff ( ) const [inline]

Whether generator switched off for moment.

Definition at line 296 of file CbcCutGenerator.hpp.

void CbcCutGenerator::setSwitchedOff ( bool  yesNo) [inline]

Set whether generator switched off for moment.

Definition at line 300 of file CbcCutGenerator.hpp.

bool CbcCutGenerator::ineffectualCuts ( ) const [inline]

Whether last round of cuts did little.

Definition at line 305 of file CbcCutGenerator.hpp.

void CbcCutGenerator::setIneffectualCuts ( bool  yesNo) [inline]

Set whether last round of cuts did little.

Definition at line 309 of file CbcCutGenerator.hpp.

bool CbcCutGenerator::whetherToUse ( ) const [inline]

Whether to use if any cuts generated.

Definition at line 314 of file CbcCutGenerator.hpp.

void CbcCutGenerator::setWhetherToUse ( bool  yesNo) [inline]

Set whether to use if any cuts generated.

Definition at line 318 of file CbcCutGenerator.hpp.

int CbcCutGenerator::numberCutsAtRoot ( ) const [inline]

Number of cuts generated at root.

Definition at line 323 of file CbcCutGenerator.hpp.

void CbcCutGenerator::setNumberCutsAtRoot ( int  value) [inline]

Definition at line 326 of file CbcCutGenerator.hpp.

int CbcCutGenerator::numberActiveCutsAtRoot ( ) const [inline]

Number of cuts active at root.

Definition at line 330 of file CbcCutGenerator.hpp.

void CbcCutGenerator::setNumberActiveCutsAtRoot ( int  value) [inline]

Definition at line 333 of file CbcCutGenerator.hpp.

int CbcCutGenerator::numberShortCutsAtRoot ( ) const [inline]

Number of short cuts at root.

Definition at line 337 of file CbcCutGenerator.hpp.

void CbcCutGenerator::setModel ( CbcModel model) [inline]

Set model.

Definition at line 341 of file CbcCutGenerator.hpp.

bool CbcCutGenerator::globalCutsAtRoot ( ) const [inline]

Whether global cuts at root.

Definition at line 345 of file CbcCutGenerator.hpp.

void CbcCutGenerator::setGlobalCutsAtRoot ( bool  yesNo) [inline]

Set whether global cuts at root.

Definition at line 349 of file CbcCutGenerator.hpp.

bool CbcCutGenerator::globalCuts ( ) const [inline]

Whether global cuts.

Definition at line 354 of file CbcCutGenerator.hpp.

void CbcCutGenerator::setGlobalCuts ( bool  yesNo) [inline]

Set whether global cuts.

Definition at line 358 of file CbcCutGenerator.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines