CglResidualCapacity Class Reference

Residual Capacity Inequalities Cut Generator Class. More...

#include <CglResidualCapacity.hpp>

Inheritance diagram for CglResidualCapacity:

Collaboration diagram for CglResidualCapacity:

List of all members.

Public Member Functions
Get and Set Parameters
void	setEpsilon (double value)
	Set Epsilon.
double	getEpsilon () const
	Get Epsilon.
void	setTolerance (double value)
	Set Tolerance.
double	getTolerance () const
	Get Tolerance.
void	setDoPreproc (int value)
	Set doPreproc.
bool	getDoPreproc () const
	Get doPreproc.
Generate Cuts
virtual void	generateCuts (const OsiSolverInterface &si, OsiCuts &cs, const CglTreeInfo info=CglTreeInfo()) const
	Generate Residual Capacity cuts for the model data contained in si.
Constructors and destructors
	CglResidualCapacity ()
	Default constructor.
	CglResidualCapacity (const double tolerance)
	Alternate Constructor.
	CglResidualCapacity (const CglResidualCapacity &)
	Copy constructor.
virtual CglCutGenerator *	clone () const
	Clone.
CglResidualCapacity &	operator= (const CglResidualCapacity &rhs)
	Assignment operator.
virtual	~CglResidualCapacity ()
	Destructor.
virtual void	refreshPrep ()
	This is to refresh preprocessing.
Friends
void	CglResidualCapacityUnitTest (const OsiSolverInterface *siP, const std::string mpdDir)
	A function that tests the methods in the CglResidualCapacity class.

---

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()
	)		const [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:

• src/CglResidualCapacity/CglResidualCapacity.hpp