Cbc  2.9.9
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Attributes | List of all members
CglCutGenerator Class Referenceabstract

Cut Generator Base Class. More...

#include <CglCutGenerator.hpp>

+ Inheritance diagram for CglCutGenerator:

Public Member Functions

Generate Cuts
virtual void generateCuts (const OsiSolverInterface &si, OsiCuts &cs, const CglTreeInfo info=CglTreeInfo())=0
 Generate cuts for the model data contained in si. More...
 
Constructors and destructors
 CglCutGenerator ()
 Default constructor. More...
 
 CglCutGenerator (const CglCutGenerator &)
 Copy constructor. More...
 
virtual CglCutGeneratorclone () const =0
 Clone. More...
 
CglCutGeneratoroperator= (const CglCutGenerator &rhs)
 Assignment operator. More...
 
virtual ~CglCutGenerator ()
 Destructor. More...
 
virtual std::string generateCpp (FILE *)
 Create C++ lines to set the generator in the current state. More...
 
virtual void refreshSolver (OsiSolverInterface *)
 This can be used to refresh any information. More...
 
Gets and Sets
int getAggressiveness () const
 Get Aggressiveness - 0 = neutral, 100 is normal root node. More...
 
void setAggressiveness (int value)
 Set Aggressiveness - 0 = neutral, 100 is normal root node. More...
 
void setGlobalCuts (bool trueOrFalse)
 Set whether can do global cuts. More...
 
bool canDoGlobalCuts () const
 Say whether can do global cuts. More...
 
virtual bool mayGenerateRowCutsInTree () const
 Returns true if may generate Row cuts in tree (rather than root node). More...
 
virtual bool needsOptimalBasis () const
 Return true if needs optimal basis to do cuts. More...
 
virtual int maximumLengthOfCutInTree () const
 Return maximum length of cut in tree. More...
 

Public Attributes

int aggressive_
 Aggressiveness - 0 = neutral, 100 is normal root node. More...
 
bool canDoGlobalCuts_
 True if can do global cuts i.e. no general integers. More...
 

Detailed Description

Cut Generator Base Class.

This is an abstract base class for generating cuts. A specific cut generator will inherit from this class.

Definition at line 23 of file CglCutGenerator.hpp.

Constructor & Destructor Documentation

CglCutGenerator::CglCutGenerator ( )

Default constructor.

CglCutGenerator::CglCutGenerator ( const CglCutGenerator )

Copy constructor.

virtual CglCutGenerator::~CglCutGenerator ( )
virtual

Destructor.

Member Function Documentation

virtual void CglCutGenerator::generateCuts ( const OsiSolverInterface si,
OsiCuts cs,
const CglTreeInfo  info = CglTreeInfo() 
)
pure virtual
virtual CglCutGenerator* CglCutGenerator::clone ( ) const
pure virtual
CglCutGenerator& CglCutGenerator::operator= ( const CglCutGenerator rhs)

Assignment operator.

virtual std::string CglCutGenerator::generateCpp ( FILE *  )
inlinevirtual

Create C++ lines to set the generator in the current state.

The output must be parsed by the calling code, as each line starts with a key indicating the following:
0: must be kept (for #includes etc)
3: Set to changed (not default) values
4: Set to default values (redundant)

Keys 1, 2, 5, 6, 7, 8 are defined, but not applicable to cut generators.

Reimplemented in CglImplication, CglProbing, CglFlowCover, CglRedSplit, CglTwomir, CglMixedIntegerRounding2, CglMixedIntegerRounding, CglGMI, CglGomory, CglDuplicateRow, CglZeroHalf, CglLiftAndProject, CglSimpleRounding, CglAllDifferent, CglClique, and CglKnapsackCover.

Definition at line 65 of file CglCutGenerator.hpp.

virtual void CglCutGenerator::refreshSolver ( OsiSolverInterface )
inlinevirtual

This can be used to refresh any information.

Reimplemented in CglProbing, CglTwomir, CglMixedIntegerRounding2, CglMixedIntegerRounding, CglGomory, CglDuplicateRow, CglOddHole, CglZeroHalf, CglAllDifferent, and CglKnapsackCover.

Definition at line 68 of file CglCutGenerator.hpp.

int CglCutGenerator::getAggressiveness ( ) const
inline

Get Aggressiveness - 0 = neutral, 100 is normal root node.

Really just a hint to cut generator

Definition at line 77 of file CglCutGenerator.hpp.

void CglCutGenerator::setAggressiveness ( int  value)
inline

Set Aggressiveness - 0 = neutral, 100 is normal root node.

Really just a hint to cut generator

Definition at line 84 of file CglCutGenerator.hpp.

void CglCutGenerator::setGlobalCuts ( bool  trueOrFalse)
inline

Set whether can do global cuts.

Definition at line 87 of file CglCutGenerator.hpp.

bool CglCutGenerator::canDoGlobalCuts ( ) const
inline

Say whether can do global cuts.

Definition at line 90 of file CglCutGenerator.hpp.

virtual bool CglCutGenerator::mayGenerateRowCutsInTree ( ) const
virtual

Returns true if may generate Row cuts in tree (rather than root node).

Used so know if matrix will change in tree. Really meant so column cut generators can still be active without worrying code. Default is true

Reimplemented in CglProbing, and CglAllDifferent.

virtual bool CglCutGenerator::needsOptimalBasis ( ) const
virtual

Return true if needs optimal basis to do cuts.

Reimplemented in CglLandP, CglTwomir, CglRedSplit2, CglGMI, CglRedSplit, and CglGomory.

virtual int CglCutGenerator::maximumLengthOfCutInTree ( ) const
inlinevirtual

Return maximum length of cut in tree.

Reimplemented in CglTwomir, and CglGomory.

Definition at line 103 of file CglCutGenerator.hpp.

Member Data Documentation

int CglCutGenerator::aggressive_

Aggressiveness - 0 = neutral, 100 is normal root node.

Really just a hint to cut generator

Definition at line 116 of file CglCutGenerator.hpp.

bool CglCutGenerator::canDoGlobalCuts_

True if can do global cuts i.e. no general integers.

Definition at line 118 of file CglCutGenerator.hpp.


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