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 *fp)
 Create C++ lines to get to current state.
virtual void refreshSolver (OsiSolverInterface *solver)
 This can be used to refresh any inforamtion.
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.

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 47 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() 
) 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 CglAllDifferent, CglClique, CglDuplicateRow, CglFlowCover, CglGomory, CglKnapsackCover, CglLiftAndProject, CglMixedIntegerRounding, CglMixedIntegerRounding2, CglOddHole, CglProbing, CglRedSplit, CglSimpleRounding, CglStored, and CglTwomir.

virtual CglCutGenerator* CglCutGenerator::clone (  )  const [pure virtual]

Clone.

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

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

Assignment operator.

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

Create C++ lines to get to current state.

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

Definition at line 80 of file CglCutGenerator.hpp.

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

This can be used to refresh any inforamtion.

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

Definition at line 83 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 92 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 99 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 CglAllDifferent, and CglProbing.

virtual bool CglCutGenerator::needsOptimalBasis (  )  const [virtual]

Return true if needs optimal basis to do cuts.

Reimplemented in CglGomory, CglRedSplit, and CglTwomir.

Referenced by CbcCutGenerator::needsOptimalBasis().


Member Data Documentation

int CglCutGenerator::aggressive_

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

Really just a hint to cut generator

Definition at line 123 of file CglCutGenerator.hpp.

Referenced by getAggressiveness(), and setAggressiveness().


The documentation for this class was generated from the following file:
Generated on Thu May 15 22:00:12 2008 by  doxygen 1.4.7