coin-Cgl
Public Attributes
CglCutGenerator Class Reference

Cut Generator Base Class. More...

#include <CglCutGenerator.hpp>

Inheritance diagram for CglCutGenerator:
Inheritance graph
[legend]

List of all members.

Public Member Functions

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

Public Attributes

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

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 21 of file CglCutGenerator.hpp.


Constructor & Destructor Documentation

Default constructor.

Copy constructor.

virtual CglCutGenerator::~CglCutGenerator ( ) [virtual]

Destructor.


Member Function Documentation

virtual void CglCutGenerator::generateCuts ( const OsiSolverInterface &  si,
OsiCuts &  cs,
const CglTreeInfo  info = CglTreeInfo() 
) const [pure virtual]

Generate cuts for the model data contained in si.

The generated cuts are inserted into and returned in the collection of cuts cs.

Implemented in CglImplication, CglFakeClique, CglLandP, CglFlowCover, CglMixedIntegerRounding2, CglMixedIntegerRounding, CglTwomir, CglResidualCapacity, CglProbing, CglRedSplit, CglOddHole, CglDuplicateRow, CglSimpleRounding, CglGomory, CglStored, CglAllDifferent, CglClique, CglKnapsackCover, and CglLiftAndProject.

virtual CglCutGenerator* CglCutGenerator::clone ( ) const [pure virtual]
CglCutGenerator& CglCutGenerator::operator= ( const CglCutGenerator rhs)

Assignment operator.

virtual std::string CglCutGenerator::generateCpp ( FILE *  ) [inline, virtual]

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, CglGomory, CglDuplicateRow, CglLiftAndProject, CglSimpleRounding, CglAllDifferent, CglClique, and CglKnapsackCover.

Definition at line 63 of file CglCutGenerator.hpp.

virtual void CglCutGenerator::refreshSolver ( OsiSolverInterface *  ) [inline, virtual]

This can be used to refresh any information.

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

Definition at line 66 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 75 of file CglCutGenerator.hpp.

References aggressive_.

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 82 of file CglCutGenerator.hpp.

References aggressive_.

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, CglRedSplit, and CglGomory.

virtual int CglCutGenerator::maximumLengthOfCutInTree ( ) const [inline, virtual]

Return maximum length of cut in tree.

Reimplemented in CglTwomir, and CglGomory.

Definition at line 96 of file CglCutGenerator.hpp.


Member Data Documentation

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

Really just a hint to cut generator

Definition at line 109 of file CglCutGenerator.hpp.

Referenced by getAggressiveness(), and setAggressiveness().


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