Twostep MIR Cut Generator Class. More...

#include <CglTwomir.hpp>

Inheritance diagram for CglTwomir:

Collaboration diagram for CglTwomir:

Public Member Functions
Generate Cuts
virtual void	generateCuts (const OsiSolverInterface &si, OsiCuts &cs, const CglTreeInfo info=CglTreeInfo())
	Generate Two step MIR cuts either from the tableau rows or from the formulation rows. More...

virtual bool	needsOptimalBasis () const
	Return true if needs optimal basis to do cuts (will return true) More...

Change criterion on which scalings to use (default = 1,1,1,1)
void	setMirScale (int tmin, int tmax)
	Set. More...

void	setTwomirScale (int qmin, int qmax)
	Set. More...

void	setAMax (int a)
	Set. More...

void	setMaxElements (int n)
	Set. More...

void	setMaxElementsRoot (int n)
	Set. More...

void	setCutTypes (bool mir, bool twomir, bool tab, bool form)
	Set. More...

void	setFormulationRows (int n)
	Set. More...

int	getTmin () const
	Get. More...

int	getTmax () const
	Set. More...

int	getQmin () const
	Set. More...

int	getQmax () const
	Set. More...

int	getAmax () const
	Set. More...

int	getMaxElements () const
	Set. More...

int	getMaxElementsRoot () const
	Set. More...

int	getIfMir () const
	Set. More...

int	getIfTwomir () const
	Set. More...

int	getIfTableau () const
	Set. More...

int	getIfFormulation () const
	Set. More...

Change criterion on which variables to look at. All ones
more than "away" away from integrality will be investigated (default 0.05)
void	setAway (double value)
	Set away. More...

double	getAway () const
	Get away. More...

void	setAwayAtRoot (double value)
	Set away at root. More...

double	getAwayAtRoot () const
	Get away at root. More...

virtual int	maximumLengthOfCutInTree () const
	Return maximum length of cut in tree. More...

Change way TwoMir works
void	passInOriginalSolver (OsiSolverInterface *solver)
	Pass in a copy of original solver (clone it) More...

OsiSolverInterface *	originalSolver () const
	Returns original solver. More...

void	setTwomirType (int type)
	Set type - 0 normal, 1 add original matrix one, 2 replace. More...

int	twomirType () const
	Return type. More...

Constructors and destructors
	CglTwomir ()
	Default constructor. More...

	CglTwomir (const CglTwomir &)
	Copy constructor. More...

virtual CglCutGenerator *	clone () const
	Clone. More...

CglTwomir &	operator= (const CglTwomir &rhs)
	Assignment operator. More...

virtual	~CglTwomir ()
	Destructor. More...

virtual std::string	generateCpp (FILE *fp)
	Create C++ lines to get to current state. More...

virtual void	refreshSolver (OsiSolverInterface *solver)
	This can be used to refresh any inforamtion. More...

Public Member Functions inherited from CglCutGenerator
	CglCutGenerator ()
	Default constructor. More...

	CglCutGenerator (const CglCutGenerator &)
	Copy constructor. More...

CglCutGenerator &	operator= (const CglCutGenerator &rhs)
	Assignment operator. More...

virtual	~CglCutGenerator ()
	Destructor. 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...

Public Attributes
std::string	probname_
	Problem name. More...

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...

Private Attributes
Private member data
CoinThreadRandom	randomNumberGenerator_
	Threadsafe random number generator. More...

OsiSolverInterface *	originalSolver_
	Original solver. More...

double	away_
	Only investigate if more than this away from integrality. More...

double	awayAtRoot_
	Only investigate if more than this away from integrality (at root) More...

int	twomirType_
	Type - 0 normal, 1 add original matrix one, 2 replace. More...

bool	do_mir_
	Threadsafe random number generator. More...

bool	do_2mir_
	Threadsafe random number generator. More...

bool	do_tab_
	Threadsafe random number generator. More...

bool	do_form_
	Threadsafe random number generator. More...

int	t_min_
	Threadsafe random number generator. More...

int	t_max_
	t_min - first value of t to use for tMIR inequalities More...

int	q_min_
	t_max - last value of t to use for tMIR inequalities More...

int	q_max_
	q_min - first value of t to use for 2-Step tMIR inequalities More...

int	a_max_
	q_max - last value of t to use for 2-Step tMIR inequalities More...

int	max_elements_
	a_max - maximum value of bhat/alpha More...

int	max_elements_root_
	Maximum number of elements in cut. More...

int	form_nrows_
	Maximum number of elements in cut at root. More...

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

Detailed Description

Twostep MIR Cut Generator Class.

Definition at line 91 of file CglTwomir.hpp.

Constructor & Destructor Documentation

CglTwomir::CglTwomir ( )

Default constructor.

CglTwomir::CglTwomir ( const CglTwomir & )

Copy constructor.

virtual CglTwomir::~CglTwomir ( )

virtual

Destructor.

Member Function Documentation

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

virtual

Generate Two step MIR cuts either from the tableau rows or from the formulation rows.

Implements CglCutGenerator.

virtual bool CglTwomir::needsOptimalBasis ( ) const

virtual

Return true if needs optimal basis to do cuts (will return true)

Reimplemented from CglCutGenerator.

void CglTwomir::setMirScale	(	int	tmin,
		int	tmax
	)

inline

Set.

Definition at line 115 of file CglTwomir.hpp.

void CglTwomir::setTwomirScale	(	int	qmin,
		int	qmax
	)

inline

Set.

Definition at line 116 of file CglTwomir.hpp.

References q_max_, and q_min_.

void CglTwomir::setAMax ( int a )

inline

Set.

Definition at line 117 of file CglTwomir.hpp.

References a_max_.

void CglTwomir::setMaxElements ( int n )

inline

Set.

Definition at line 118 of file CglTwomir.hpp.

References max_elements_.

void CglTwomir::setMaxElementsRoot ( int n )

inline

Set.

Definition at line 119 of file CglTwomir.hpp.

References max_elements_root_.

void CglTwomir::setCutTypes	(	bool	mir,
		bool	twomir,
		bool	tab,
		bool	form
	)

inline

Set.

Definition at line 120 of file CglTwomir.hpp.

References do_2mir_, do_form_, do_mir_, and do_tab_.

void CglTwomir::setFormulationRows ( int n )

inline

Set.

Definition at line 122 of file CglTwomir.hpp.

References form_nrows_.

int CglTwomir::getTmin ( ) const

inline

Get.

Definition at line 125 of file CglTwomir.hpp.

References t_min_.

int CglTwomir::getTmax ( ) const

inline

Set.

Definition at line 126 of file CglTwomir.hpp.

References t_max_.

int CglTwomir::getQmin ( ) const

inline

Set.

Definition at line 127 of file CglTwomir.hpp.

References q_min_.

int CglTwomir::getQmax ( ) const

inline

Set.

Definition at line 128 of file CglTwomir.hpp.

References q_max_.

int CglTwomir::getAmax ( ) const

inline

Set.

Definition at line 129 of file CglTwomir.hpp.

References a_max_.

int CglTwomir::getMaxElements ( ) const

inline

Set.

Definition at line 130 of file CglTwomir.hpp.

References max_elements_.

int CglTwomir::getMaxElementsRoot ( ) const

inline

Set.

Definition at line 131 of file CglTwomir.hpp.

References max_elements_root_.

int CglTwomir::getIfMir ( ) const

inline

Set.

Definition at line 132 of file CglTwomir.hpp.

References do_mir_.

int CglTwomir::getIfTwomir ( ) const

inline

Set.

Definition at line 133 of file CglTwomir.hpp.

References do_2mir_.

int CglTwomir::getIfTableau ( ) const

inline

Set.

Definition at line 134 of file CglTwomir.hpp.

References do_tab_.

int CglTwomir::getIfFormulation ( ) const

inline

Set.

Definition at line 135 of file CglTwomir.hpp.

References do_form_.

void CglTwomir::setAway ( double value )

Set away.

double CglTwomir::getAway ( ) const

Get away.

void CglTwomir::setAwayAtRoot ( double value )

Set away at root.

double CglTwomir::getAwayAtRoot ( ) const

Get away at root.

virtual int CglTwomir::maximumLengthOfCutInTree ( ) const

inlinevirtual

Return maximum length of cut in tree.

Reimplemented from CglCutGenerator.

Definition at line 151 of file CglTwomir.hpp.

References max_elements_.

void CglTwomir::passInOriginalSolver ( OsiSolverInterface * solver )

Pass in a copy of original solver (clone it)

OsiSolverInterface* CglTwomir::originalSolver ( ) const

inline

Returns original solver.

Definition at line 160 of file CglTwomir.hpp.

References originalSolver_.

void CglTwomir::setTwomirType ( int type )

inline

Set type - 0 normal, 1 add original matrix one, 2 replace.

Definition at line 163 of file CglTwomir.hpp.

References twomirType_.

int CglTwomir::twomirType ( ) const

inline

Return type.

Definition at line 166 of file CglTwomir.hpp.

References twomirType_.

virtual CglCutGenerator* CglTwomir::clone ( ) const

virtual

Clone.

Implements CglCutGenerator.

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

Assignment operator.

virtual std::string CglTwomir::generateCpp ( FILE * fp )

virtual

Create C++ lines to get to current state.

Reimplemented from CglCutGenerator.

virtual void CglTwomir::refreshSolver ( OsiSolverInterface * solver )

virtual

This can be used to refresh any inforamtion.

Reimplemented from CglCutGenerator.

Friends And Related Function Documentation

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

friend

A function that tests the methods in the CglTwomir 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.

Member Data Documentation

std::string CglTwomir::probname_

Problem name.

Definition at line 100 of file CglTwomir.hpp.

CoinThreadRandom CglTwomir::randomNumberGenerator_

private

Threadsafe random number generator.

Definition at line 197 of file CglTwomir.hpp.

OsiSolverInterface* CglTwomir::originalSolver_

private

Original solver.

Definition at line 199 of file CglTwomir.hpp.

Referenced by originalSolver().

double CglTwomir::away_

private

Only investigate if more than this away from integrality.

Definition at line 201 of file CglTwomir.hpp.

double CglTwomir::awayAtRoot_

private

Only investigate if more than this away from integrality (at root)

Definition at line 203 of file CglTwomir.hpp.

int CglTwomir::twomirType_

private

Type - 0 normal, 1 add original matrix one, 2 replace.

Definition at line 205 of file CglTwomir.hpp.

Referenced by setTwomirType(), and twomirType().

bool CglTwomir::do_mir_

private

Threadsafe random number generator.

Definition at line 206 of file CglTwomir.hpp.

Referenced by getIfMir(), and setCutTypes().

bool CglTwomir::do_2mir_

private

Threadsafe random number generator.

Definition at line 207 of file CglTwomir.hpp.

Referenced by getIfTwomir(), and setCutTypes().

bool CglTwomir::do_tab_

private

Threadsafe random number generator.

Definition at line 208 of file CglTwomir.hpp.

Referenced by getIfTableau(), and setCutTypes().

bool CglTwomir::do_form_

private

Threadsafe random number generator.

Definition at line 209 of file CglTwomir.hpp.

Referenced by getIfFormulation(), and setCutTypes().

int CglTwomir::t_min_

private

Threadsafe random number generator.

Definition at line 211 of file CglTwomir.hpp.

Referenced by getTmin().

int CglTwomir::t_max_

private

t_min - first value of t to use for tMIR inequalities

Definition at line 212 of file CglTwomir.hpp.

Referenced by getTmax().

int CglTwomir::q_min_

private

t_max - last value of t to use for tMIR inequalities

Definition at line 213 of file CglTwomir.hpp.

Referenced by getQmin(), and setTwomirScale().

int CglTwomir::q_max_

private

q_min - first value of t to use for 2-Step tMIR inequalities

Definition at line 214 of file CglTwomir.hpp.

Referenced by getQmax(), and setTwomirScale().

int CglTwomir::a_max_

private

q_max - last value of t to use for 2-Step tMIR inequalities

Definition at line 215 of file CglTwomir.hpp.

Referenced by getAmax(), and setAMax().

int CglTwomir::max_elements_

private

a_max - maximum value of bhat/alpha

Definition at line 216 of file CglTwomir.hpp.

Referenced by getMaxElements(), maximumLengthOfCutInTree(), and setMaxElements().

int CglTwomir::max_elements_root_

private

Maximum number of elements in cut.

Definition at line 217 of file CglTwomir.hpp.

Referenced by getMaxElementsRoot(), and setMaxElementsRoot().

int CglTwomir::form_nrows_

private

Maximum number of elements in cut at root.

Definition at line 218 of file CglTwomir.hpp.

Referenced by setFormulationRows().

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

/tmp/Dip-0.92.4/Cgl/src/CglTwomir/CglTwomir.hpp

Public Member Functions

Public Attributes

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation