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

#include <CbcCutGenerator.hpp>

Collaboration diagram for CbcCutGenerator:

Public Member Functions
Generate Cuts
bool	generateCuts (OsiCuts &cs, int fullScan, OsiSolverInterface solver, CbcNode node)
	Generate cuts for the client model. More...

Constructors and destructors
	CbcCutGenerator ()
	Default constructor. More...

	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. More...

	CbcCutGenerator (const CbcCutGenerator &)
	Copy constructor. More...

CbcCutGenerator &	operator= (const CbcCutGenerator &rhs)
	Assignment operator. More...

	~CbcCutGenerator ()
	Destructor. More...

Gets and sets
void	refreshModel (CbcModel *model)
	Set the client model. More...

const char *	cutGeneratorName () const
	return name of generator More...

void	generateTuning (FILE *fp)
	Create C++ lines to show how to tune. More...

void	setHowOften (int value)
	Set the cut generation interval. More...

int	howOften () const
	Get the cut generation interval. More...

int	howOftenInSub () const
	Get the cut generation interval.in sub tree. More...

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

void	setInaccuracy (int level)
	Set level of cut inaccuracy (0 means exact e.g. cliques) More...

void	setWhatDepth (int value)
	Set the cut generation depth. More...

void	setWhatDepthInSub (int value)
	Set the cut generation depth in sub tree. More...

int	whatDepth () const
	Get the cut generation depth criterion. More...

int	whatDepthInSub () const
	Get the cut generation depth criterion.in sub tree. More...

void	setMaximumTries (int value)
	Set maximum number of times to enter. More...

int	maximumTries () const
	Get maximum number of times to enter. More...

int	switches () const
	Get switches. More...

void	setSwitches (int value)
	Set switches (for copying from virgin state) More...

bool	normal () const
	Get whether the cut generator should be called in the normal place. More...

void	setNormal (bool value)
	Set whether the cut generator should be called in the normal place. More...

bool	atSolution () const
	Get whether the cut generator should be called when a solution is found. More...

void	setAtSolution (bool value)
	Set whether the cut generator should be called when a solution is found. More...

bool	whenInfeasible () const
	Get whether the cut generator should be called when the subproblem is found to be infeasible. More...

void	setWhenInfeasible (bool value)
	Set whether the cut generator should be called when the subproblem is found to be infeasible. More...

bool	timing () const
	Get whether the cut generator is being timed. More...

void	setTiming (bool value)
	Set whether the cut generator is being timed. More...

double	timeInCutGenerator () const
	Return time taken in cut generator. More...

void	incrementTimeInCutGenerator (double value)
	Set the client model. More...

CglCutGenerator *	generator () const
	Get the `CglCutGenerator` corresponding to this `CbcCutGenerator`. More...

int	numberTimesEntered () const
	Number times cut generator entered. More...

void	setNumberTimesEntered (int value)
	Set the client model. More...

void	incrementNumberTimesEntered (int value=1)
	Set the client model. More...

int	numberCutsInTotal () const
	Total number of cuts added. More...

void	setNumberCutsInTotal (int value)
	Set the client model. More...

void	incrementNumberCutsInTotal (int value=1)
	Set the client model. More...

int	numberElementsInTotal () const
	Total number of elements added. More...

void	setNumberElementsInTotal (int value)
	Set the client model. More...

void	incrementNumberElementsInTotal (int value=1)
	Set the client model. More...

int	numberColumnCuts () const
	Total number of column cuts. More...

void	setNumberColumnCuts (int value)
	Set the client model. More...

void	incrementNumberColumnCuts (int value=1)
	Set the client model. More...

int	numberCutsActive () const
	Total number of cuts active after (at end of n cut passes at each node) More...

void	setNumberCutsActive (int value)
	Set the client model. More...

void	incrementNumberCutsActive (int value=1)
	Set the client model. More...

void	setSwitchOffIfLessThan (int value)
	Set the client model. More...

int	switchOffIfLessThan () const
	Set the client model. More...

bool	needsOptimalBasis () const
	Say if optimal basis needed. More...

void	setNeedsOptimalBasis (bool yesNo)
	Set if optimal basis needed. More...

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

void	setMustCallAgain (bool yesNo)
	Set whether generator MUST be called again if any cuts (i.e. ignore break from loop) More...

bool	switchedOff () const
	Whether generator switched off for moment. More...

void	setSwitchedOff (bool yesNo)
	Set whether generator switched off for moment. More...

bool	ineffectualCuts () const
	Whether last round of cuts did little. More...

void	setIneffectualCuts (bool yesNo)
	Set whether last round of cuts did little. More...

bool	whetherToUse () const
	Whether to use if any cuts generated. More...

void	setWhetherToUse (bool yesNo)
	Set whether to use if any cuts generated. More...

bool	whetherInMustCallAgainMode () const
	Whether in must call again mode (or after others) More...

void	setWhetherInMustCallAgainMode (bool yesNo)
	Set whether in must call again mode (or after others) More...

bool	whetherCallAtEnd () const
	Whether to call at end. More...

void	setWhetherCallAtEnd (bool yesNo)
	Set whether to call at end. More...

bool	needsRefresh () const
	Whether needs refresh on copy. More...

void	setNeedsRefresh (bool yesNo)
	Set whether needs refresh on copy. More...

int	numberCutsAtRoot () const
	Number of cuts generated at root. More...

void	setNumberCutsAtRoot (int value)
	Set the client model. More...

int	numberActiveCutsAtRoot () const
	Number of cuts active at root. More...

void	setNumberActiveCutsAtRoot (int value)
	Set the client model. More...

int	numberShortCutsAtRoot () const
	Number of short cuts at root. More...

void	setNumberShortCutsAtRoot (int value)
	Set the client model. More...

void	setModel (CbcModel *model)
	Set model. More...

bool	globalCutsAtRoot () const
	Whether global cuts at root. More...

void	setGlobalCutsAtRoot (bool yesNo)
	Set whether global cuts at root. More...

bool	globalCuts () const
	Whether global cuts. More...

void	setGlobalCuts (bool yesNo)
	Set whether global cuts. More...

void	addStatistics (const CbcCutGenerator *other)
	Add in statistics from other. More...

void	scaleBackStatistics (int factor)
	Scale back statistics by factor. More...

Private Attributes
OsiCuts	savedCuts_
	Saved cuts. More...

double	timeInCutGenerator_
	Time in cut generator. More...

CbcModel *	model_
	The client model. More...

CglCutGenerator *	generator_

char *	generatorName_
	Name of generator. More...

int	whenCutGenerator_
	Number of nodes between calls to the CglCutGenerator::generateCuts routine. More...

int	whenCutGeneratorInSub_
	Number of nodes between calls to the CglCutGenerator::generateCuts routine in sub tree. More...

int	switchOffIfLessThan_
	If first pass at root produces fewer than this cuts then switch off. More...

int	depthCutGenerator_
	Depth at which to call the CglCutGenerator::generateCuts routine (If >0 then overrides when and is called if depthdepthCutGenerator==0). More...

int	depthCutGeneratorInSub_
	Depth at which to call the CglCutGenerator::generateCuts routine (If >0 then overrides when and is called if depthdepthCutGenerator==0). More...

int	inaccuracy_
	Level of cut inaccuracy (0 means exact e.g. cliques) More...

int	numberTimes_
	Number times cut generator entered. More...

int	numberCuts_
	Total number of cuts added. More...

int	numberElements_
	Total number of elements added. More...

int	numberColumnCuts_
	Total number of column cuts added. More...

int	numberCutsActive_
	Total number of cuts active after (at end of n cut passes at each node) More...

int	numberCutsAtRoot_
	Number of cuts generated at root. More...

int	numberActiveCutsAtRoot_
	Number of cuts active at root. More...

int	numberShortCutsAtRoot_
	Number of short cuts at root. More...

int	switches_
	Switches - see gets and sets. More...

int	maximumTries_
	Maximum number of times to enter. More...

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 106 of file CbcCutGenerator.hpp.

References generatorName_.

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 130 of file CbcCutGenerator.hpp.

References whenCutGenerator_.

int CbcCutGenerator::howOftenInSub ( ) const

inline

Get the cut generation interval.in sub tree.

Definition at line 135 of file CbcCutGenerator.hpp.

References whenCutGeneratorInSub_.

int CbcCutGenerator::inaccuracy ( ) const

inline

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

Definition at line 140 of file CbcCutGenerator.hpp.

References inaccuracy_.

void CbcCutGenerator::setInaccuracy ( int level )

inline

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

Definition at line 145 of file CbcCutGenerator.hpp.

References inaccuracy_.

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 164 of file CbcCutGenerator.hpp.

References depthCutGenerator_.

int CbcCutGenerator::whatDepthInSub ( ) const

inline

Get the cut generation depth criterion.in sub tree.

Definition at line 169 of file CbcCutGenerator.hpp.

References depthCutGeneratorInSub_.

void CbcCutGenerator::setMaximumTries ( int value )

inline

Set maximum number of times to enter.

Definition at line 174 of file CbcCutGenerator.hpp.

References maximumTries_.

int CbcCutGenerator::maximumTries ( ) const

inline

Get maximum number of times to enter.

Definition at line 179 of file CbcCutGenerator.hpp.

References maximumTries_.

int CbcCutGenerator::switches ( ) const

inline

Get switches.

Definition at line 185 of file CbcCutGenerator.hpp.

References switches_.

void CbcCutGenerator::setSwitches ( int value )

inline

Set switches (for copying from virgin state)

Definition at line 190 of file CbcCutGenerator.hpp.

References switches_.

bool CbcCutGenerator::normal ( ) const

inline

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

Definition at line 195 of file CbcCutGenerator.hpp.

References switches_.

void CbcCutGenerator::setNormal ( bool value )

inline

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

Definition at line 200 of file CbcCutGenerator.hpp.

References switches_.

bool CbcCutGenerator::atSolution ( ) const

inline

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

Definition at line 206 of file CbcCutGenerator.hpp.

References switches_.

void CbcCutGenerator::setAtSolution ( bool value )

inline

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

Definition at line 211 of file CbcCutGenerator.hpp.

References switches_.

bool CbcCutGenerator::whenInfeasible ( ) const

inline

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

Definition at line 219 of file CbcCutGenerator.hpp.

References switches_.

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 226 of file CbcCutGenerator.hpp.

References switches_.

bool CbcCutGenerator::timing ( ) const

inline

Get whether the cut generator is being timed.

Definition at line 232 of file CbcCutGenerator.hpp.

References switches_.

void CbcCutGenerator::setTiming ( bool value )

inline

Set whether the cut generator is being timed.

Definition at line 237 of file CbcCutGenerator.hpp.

References switches_, and timeInCutGenerator_.

double CbcCutGenerator::timeInCutGenerator ( ) const

inline

Return time taken in cut generator.

Definition at line 244 of file CbcCutGenerator.hpp.

References timeInCutGenerator_.

void CbcCutGenerator::incrementTimeInCutGenerator ( double value )

inline

Set the client model.

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

Definition at line 248 of file CbcCutGenerator.hpp.

References timeInCutGenerator_.

CglCutGenerator* CbcCutGenerator::generator ( ) const

inline

Get the CglCutGenerator corresponding to this CbcCutGenerator.

Definition at line 253 of file CbcCutGenerator.hpp.

References generator_.

int CbcCutGenerator::numberTimesEntered ( ) const

inline

Number times cut generator entered.

Definition at line 258 of file CbcCutGenerator.hpp.

References numberTimes_.

void CbcCutGenerator::setNumberTimesEntered ( int value )

inline

Set the client model.

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

Definition at line 262 of file CbcCutGenerator.hpp.

References numberTimes_.

void CbcCutGenerator::incrementNumberTimesEntered ( int value = 1 )

inline

Set the client model.

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

Definition at line 266 of file CbcCutGenerator.hpp.

References numberTimes_.

int CbcCutGenerator::numberCutsInTotal ( ) const

inline

Total number of cuts added.

Definition at line 271 of file CbcCutGenerator.hpp.

References numberCuts_.

void CbcCutGenerator::setNumberCutsInTotal ( int value )

inline

Set the client model.

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

Definition at line 275 of file CbcCutGenerator.hpp.

References numberCuts_.

void CbcCutGenerator::incrementNumberCutsInTotal ( int value = 1 )

inline

Set the client model.

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

Definition at line 279 of file CbcCutGenerator.hpp.

References numberCuts_.

int CbcCutGenerator::numberElementsInTotal ( ) const

inline

Total number of elements added.

Definition at line 284 of file CbcCutGenerator.hpp.

References numberElements_.

void CbcCutGenerator::setNumberElementsInTotal ( int value )

inline

Set the client model.

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

Definition at line 288 of file CbcCutGenerator.hpp.

References numberElements_.

void CbcCutGenerator::incrementNumberElementsInTotal ( int value = 1 )

inline

Set the client model.

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

Definition at line 292 of file CbcCutGenerator.hpp.

References numberElements_.

int CbcCutGenerator::numberColumnCuts ( ) const

inline

Total number of column cuts.

Definition at line 297 of file CbcCutGenerator.hpp.

References numberColumnCuts_.

void CbcCutGenerator::setNumberColumnCuts ( int value )

inline

Set the client model.

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

Definition at line 301 of file CbcCutGenerator.hpp.

References numberColumnCuts_.

void CbcCutGenerator::incrementNumberColumnCuts ( int value = 1 )

inline

Set the client model.

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

Definition at line 305 of file CbcCutGenerator.hpp.

References numberColumnCuts_.

int CbcCutGenerator::numberCutsActive ( ) const

inline

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

Definition at line 310 of file CbcCutGenerator.hpp.

References numberCutsActive_.

void CbcCutGenerator::setNumberCutsActive ( int value )

inline

Set the client model.

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

Definition at line 314 of file CbcCutGenerator.hpp.

References numberCutsActive_.

void CbcCutGenerator::incrementNumberCutsActive ( int value = 1 )

inline

Set the client model.

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

Definition at line 318 of file CbcCutGenerator.hpp.

References numberCutsActive_.

void CbcCutGenerator::setSwitchOffIfLessThan ( int value )

inline

Set the client model.

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

Definition at line 322 of file CbcCutGenerator.hpp.

References switchOffIfLessThan_.

int CbcCutGenerator::switchOffIfLessThan ( ) const

inline

Set the client model.

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

Definition at line 326 of file CbcCutGenerator.hpp.

References switchOffIfLessThan_.

bool CbcCutGenerator::needsOptimalBasis ( ) const

inline

Say if optimal basis needed.

Definition at line 331 of file CbcCutGenerator.hpp.

References switches_.

void CbcCutGenerator::setNeedsOptimalBasis ( bool yesNo )

inline

Set if optimal basis needed.

Definition at line 336 of file CbcCutGenerator.hpp.

References switches_.

bool CbcCutGenerator::mustCallAgain ( ) const

inline

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

Definition at line 342 of file CbcCutGenerator.hpp.

References switches_.

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 347 of file CbcCutGenerator.hpp.

References switches_.

bool CbcCutGenerator::switchedOff ( ) const

inline

Whether generator switched off for moment.

Definition at line 353 of file CbcCutGenerator.hpp.

References switches_.

void CbcCutGenerator::setSwitchedOff ( bool yesNo )

inline

Set whether generator switched off for moment.

Definition at line 358 of file CbcCutGenerator.hpp.

References switches_.

bool CbcCutGenerator::ineffectualCuts ( ) const

inline

Whether last round of cuts did little.

Definition at line 364 of file CbcCutGenerator.hpp.

References switches_.

void CbcCutGenerator::setIneffectualCuts ( bool yesNo )

inline

Set whether last round of cuts did little.

Definition at line 369 of file CbcCutGenerator.hpp.

References switches_.

bool CbcCutGenerator::whetherToUse ( ) const

inline

Whether to use if any cuts generated.

Definition at line 375 of file CbcCutGenerator.hpp.

References switches_.

void CbcCutGenerator::setWhetherToUse ( bool yesNo )

inline

Set whether to use if any cuts generated.

Definition at line 380 of file CbcCutGenerator.hpp.

References switches_.

bool CbcCutGenerator::whetherInMustCallAgainMode ( ) const

inline

Whether in must call again mode (or after others)

Definition at line 386 of file CbcCutGenerator.hpp.

References switches_.

void CbcCutGenerator::setWhetherInMustCallAgainMode ( bool yesNo )

inline

Set whether in must call again mode (or after others)

Definition at line 391 of file CbcCutGenerator.hpp.

References switches_.

bool CbcCutGenerator::whetherCallAtEnd ( ) const

inline

Whether to call at end.

Definition at line 397 of file CbcCutGenerator.hpp.

References switches_.

void CbcCutGenerator::setWhetherCallAtEnd ( bool yesNo )

inline

Set whether to call at end.

Definition at line 402 of file CbcCutGenerator.hpp.

References switches_.

bool CbcCutGenerator::needsRefresh ( ) const

inline

Whether needs refresh on copy.

Definition at line 408 of file CbcCutGenerator.hpp.

References switches_.

void CbcCutGenerator::setNeedsRefresh ( bool yesNo )

inline

Set whether needs refresh on copy.

Definition at line 413 of file CbcCutGenerator.hpp.

References switches_.

int CbcCutGenerator::numberCutsAtRoot ( ) const

inline

Number of cuts generated at root.

Definition at line 419 of file CbcCutGenerator.hpp.

References numberCutsAtRoot_.

void CbcCutGenerator::setNumberCutsAtRoot ( int value )

inline

Set the client model.

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

Definition at line 423 of file CbcCutGenerator.hpp.

References numberCutsAtRoot_.

int CbcCutGenerator::numberActiveCutsAtRoot ( ) const

inline

Number of cuts active at root.

Definition at line 428 of file CbcCutGenerator.hpp.

References numberActiveCutsAtRoot_.

void CbcCutGenerator::setNumberActiveCutsAtRoot ( int value )

inline

Set the client model.

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

Definition at line 432 of file CbcCutGenerator.hpp.

References numberActiveCutsAtRoot_.

int CbcCutGenerator::numberShortCutsAtRoot ( ) const

inline

Number of short cuts at root.

Definition at line 437 of file CbcCutGenerator.hpp.

References numberShortCutsAtRoot_.

void CbcCutGenerator::setNumberShortCutsAtRoot ( int value )

inline

Set the client model.

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

Definition at line 441 of file CbcCutGenerator.hpp.

References numberShortCutsAtRoot_.

void CbcCutGenerator::setModel ( CbcModel * model )

inline

Set model.

Definition at line 446 of file CbcCutGenerator.hpp.

References model_.

bool CbcCutGenerator::globalCutsAtRoot ( ) const

inline

Whether global cuts at root.

Definition at line 451 of file CbcCutGenerator.hpp.

References switches_.

void CbcCutGenerator::setGlobalCutsAtRoot ( bool yesNo )

inline

Set whether global cuts at root.

Definition at line 456 of file CbcCutGenerator.hpp.

References switches_.

bool CbcCutGenerator::globalCuts ( ) const

inline

Whether global cuts.

Definition at line 462 of file CbcCutGenerator.hpp.

References switches_.

void CbcCutGenerator::setGlobalCuts ( bool yesNo )

inline

Set whether global cuts.

Definition at line 467 of file CbcCutGenerator.hpp.

References switches_.

void CbcCutGenerator::addStatistics ( const CbcCutGenerator * other )

Add in statistics from other.

void CbcCutGenerator::scaleBackStatistics ( int factor )

Scale back statistics by factor.

Member Data Documentation

OsiCuts CbcCutGenerator::savedCuts_

private

Saved cuts.

Definition at line 483 of file CbcCutGenerator.hpp.

double CbcCutGenerator::timeInCutGenerator_

private

Time in cut generator.

Definition at line 485 of file CbcCutGenerator.hpp.

Referenced by incrementTimeInCutGenerator(), setTiming(), and timeInCutGenerator().

CbcModel* CbcCutGenerator::model_

private

The client model.

Definition at line 487 of file CbcCutGenerator.hpp.

Referenced by setModel().

CglCutGenerator* CbcCutGenerator::generator_

private

Definition at line 490 of file CbcCutGenerator.hpp.

Referenced by generator().

char* CbcCutGenerator::generatorName_

private

Name of generator.

Definition at line 493 of file CbcCutGenerator.hpp.

Referenced by cutGeneratorName().

int CbcCutGenerator::whenCutGenerator_

private

Number of nodes between calls to the CglCutGenerator::generateCuts routine.

Definition at line 498 of file CbcCutGenerator.hpp.

Referenced by howOften().

int CbcCutGenerator::whenCutGeneratorInSub_

private

Number of nodes between calls to the CglCutGenerator::generateCuts routine in sub tree.

Definition at line 502 of file CbcCutGenerator.hpp.

Referenced by howOftenInSub().

int CbcCutGenerator::switchOffIfLessThan_

private

If first pass at root produces fewer than this cuts then switch off.

Definition at line 505 of file CbcCutGenerator.hpp.

Referenced by setSwitchOffIfLessThan(), and switchOffIfLessThan().

int CbcCutGenerator::depthCutGenerator_

private

Depth at which to call the CglCutGenerator::generateCuts routine (If >0 then overrides when and is called if depthdepthCutGenerator==0).

Definition at line 510 of file CbcCutGenerator.hpp.

Referenced by whatDepth().

int CbcCutGenerator::depthCutGeneratorInSub_

private

Depth at which to call the CglCutGenerator::generateCuts routine (If >0 then overrides when and is called if depthdepthCutGenerator==0).

In sub tree.

Definition at line 516 of file CbcCutGenerator.hpp.

Referenced by whatDepthInSub().

int CbcCutGenerator::inaccuracy_

private

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

Definition at line 519 of file CbcCutGenerator.hpp.

Referenced by inaccuracy(), and setInaccuracy().

int CbcCutGenerator::numberTimes_

private

Number times cut generator entered.

Definition at line 521 of file CbcCutGenerator.hpp.

Referenced by incrementNumberTimesEntered(), numberTimesEntered(), and setNumberTimesEntered().

int CbcCutGenerator::numberCuts_

private

Total number of cuts added.

Definition at line 523 of file CbcCutGenerator.hpp.

Referenced by incrementNumberCutsInTotal(), numberCutsInTotal(), and setNumberCutsInTotal().

int CbcCutGenerator::numberElements_

private

Total number of elements added.

Definition at line 525 of file CbcCutGenerator.hpp.

Referenced by incrementNumberElementsInTotal(), numberElementsInTotal(), and setNumberElementsInTotal().

int CbcCutGenerator::numberColumnCuts_

private

Total number of column cuts added.

Definition at line 527 of file CbcCutGenerator.hpp.

Referenced by incrementNumberColumnCuts(), numberColumnCuts(), and setNumberColumnCuts().

int CbcCutGenerator::numberCutsActive_

private

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

Definition at line 529 of file CbcCutGenerator.hpp.

Referenced by incrementNumberCutsActive(), numberCutsActive(), and setNumberCutsActive().

int CbcCutGenerator::numberCutsAtRoot_

private

Number of cuts generated at root.

Definition at line 531 of file CbcCutGenerator.hpp.

Referenced by numberCutsAtRoot(), and setNumberCutsAtRoot().

int CbcCutGenerator::numberActiveCutsAtRoot_

private

Number of cuts active at root.

Definition at line 533 of file CbcCutGenerator.hpp.

Referenced by numberActiveCutsAtRoot(), and setNumberActiveCutsAtRoot().

int CbcCutGenerator::numberShortCutsAtRoot_

private

Number of short cuts at root.

Definition at line 535 of file CbcCutGenerator.hpp.

Referenced by numberShortCutsAtRoot(), and setNumberShortCutsAtRoot().

int CbcCutGenerator::switches_

private

Switches - see gets and sets.

Definition at line 537 of file CbcCutGenerator.hpp.

Referenced by atSolution(), globalCuts(), globalCutsAtRoot(), ineffectualCuts(), mustCallAgain(), needsOptimalBasis(), needsRefresh(), normal(), setAtSolution(), setGlobalCuts(), setGlobalCutsAtRoot(), setIneffectualCuts(), setMustCallAgain(), setNeedsOptimalBasis(), setNeedsRefresh(), setNormal(), setSwitchedOff(), setSwitches(), setTiming(), setWhenInfeasible(), setWhetherCallAtEnd(), setWhetherInMustCallAgainMode(), setWhetherToUse(), switchedOff(), switches(), timing(), whenInfeasible(), whetherCallAtEnd(), whetherInMustCallAgainMode(), and whetherToUse().

int CbcCutGenerator::maximumTries_

private

Maximum number of times to enter.

Definition at line 539 of file CbcCutGenerator.hpp.

Referenced by maximumTries(), and setMaximumTries().

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

/tmp/Dip-0.92.4/Cbc/src/CbcCutGenerator.hpp

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation