Cgl  0.59.9
Friends | List of all members
CglResidualCapacity Class Reference

Residual Capacity Inequalities Cut Generator Class. More...

#include <CglResidualCapacity.hpp>

+ Inheritance diagram for CglResidualCapacity:
+ Collaboration diagram for CglResidualCapacity:

Public Member Functions

Get and Set Parameters
void setEpsilon (double value)
 Set Epsilon. More...
 
double getEpsilon () const
 Get Epsilon. More...
 
void setTolerance (double value)
 Set Tolerance. More...
 
double getTolerance () const
 Get Tolerance. More...
 
void setDoPreproc (int value)
 Set doPreproc. More...
 
bool getDoPreproc () const
 Get doPreproc. More...
 
Generate Cuts
virtual void generateCuts (const OsiSolverInterface &si, OsiCuts &cs, const CglTreeInfo info=CglTreeInfo())
 Generate Residual Capacity cuts for the model data contained in si. More...
 
Constructors and destructors
 CglResidualCapacity ()
 Default constructor. More...
 
 CglResidualCapacity (const double tolerance)
 Alternate Constructor. More...
 
 CglResidualCapacity (const CglResidualCapacity &)
 Copy constructor. More...
 
virtual CglCutGeneratorclone () const
 Clone. More...
 
CglResidualCapacityoperator= (const CglResidualCapacity &rhs)
 Assignment operator. More...
 
virtual ~CglResidualCapacity ()
 Destructor. More...
 
virtual void refreshPrep ()
 This is to refresh preprocessing. More...
 
- Public Member Functions inherited from CglCutGenerator
 CglCutGenerator ()
 Default constructor. More...
 
 CglCutGenerator (const CglCutGenerator &)
 Copy constructor. 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...
 
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...
 

Friends

void CglResidualCapacityUnitTest (const OsiSolverInterface *siP, const std::string mpdDir)
 A function that tests the methods in the CglResidualCapacity class. More...
 

Additional Inherited Members

- Public Attributes inherited from CglCutGenerator
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

Residual Capacity Inequalities Cut Generator Class.

References: T Magnanti, P Mirchandani, R Vachani, "The convex hull of two core capacitated network design problems," Math Programming 60 (1993), 233-250.

A Atamturk, D Rajan, "On splittable and unsplittable flow capacitated network design arc-set polyhedra," Math Programming 92 (2002), 315-333.

Definition at line 47 of file CglResidualCapacity.hpp.

Constructor & Destructor Documentation

CglResidualCapacity::CglResidualCapacity ( )

Default constructor.

CglResidualCapacity::CglResidualCapacity ( const double  tolerance)

Alternate Constructor.

CglResidualCapacity::CglResidualCapacity ( const CglResidualCapacity )

Copy constructor.

virtual CglResidualCapacity::~CglResidualCapacity ( )
virtual

Destructor.

Member Function Documentation

void CglResidualCapacity::setEpsilon ( double  value)

Set Epsilon.

double CglResidualCapacity::getEpsilon ( ) const

Get Epsilon.

void CglResidualCapacity::setTolerance ( double  value)

Set Tolerance.

double CglResidualCapacity::getTolerance ( ) const

Get Tolerance.

void CglResidualCapacity::setDoPreproc ( int  value)

Set doPreproc.

bool CglResidualCapacity::getDoPreproc ( ) const

Get doPreproc.

virtual void CglResidualCapacity::generateCuts ( const OsiSolverInterface &  si,
OsiCuts &  cs,
const CglTreeInfo  info = CglTreeInfo() 
)
virtual

Generate Residual Capacity cuts for the model data contained in si.

The generated cuts are inserted in the collection of cuts cs.

Implements CglCutGenerator.

virtual CglCutGenerator* CglResidualCapacity::clone ( ) const
virtual

Clone.

Implements CglCutGenerator.

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

Assignment operator.

virtual void CglResidualCapacity::refreshPrep ( )
virtual

This is to refresh preprocessing.

Friends And Related Function Documentation

void CglResidualCapacityUnitTest ( const OsiSolverInterface *  siP,
const std::string  mpdDir 
)
friend

A function that tests the methods in the CglResidualCapacity class.

The only reason for it not to be a member method is that this way it doesn't have to be compiled into the library. And that's a gain, because the library should be compiled with optimization on, but this method should be compiled with debugging.


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