#include <OSDipInterface.h>

Collaboration diagram for OS_DipInterface:

Public Attributes
bool	m_isProvenOptimal
	Best known LB/UB. More...

double	m_bestKnownLB

double	m_bestKnownUB

OSInstance *	m_osinstance

OSOption *	m_osoption

OSiLReader *	m_osilreader

OSoLReader *	m_osolreader

char *	m_integerVars

CoinPackedMatrix *	m_coinpm

CoinPackedVector *	m_row

Helper Methods.
std::vector< std::set< int > >	m_blockVariableIndexes
	Returns array[getNumCols()] specifying if a variable is integer. More...

bool	m_blockVariableIndexesProcessed
	Returns array[getNumCols()] specifying if a variable is integer. More...

std::set< int >	m_coreConstraintIndexes
	Returns array[getNumCols()] specifying if a variable is integer. More...

bool	m_coreConstraintIndexesProcessed
	Returns array[getNumCols()] specifying if a variable is integer. More...

std::vector< std::map< int, int > >	m_blockConstraintIndexes
	Returns array[getNumCols()] specifying if a variable is integer. More...

bool	m_blockConstraintIndexesProcessed
	Returns array[getNumCols()] specifying if a variable is integer. More...

std::vector< OSInstance * >	m_blockOSInstances
	Returns array[getNumCols()] specifying if a variable is integer. More...

bool	m_blockOSInstancesProcessed
	Returns array[getNumCols()] specifying if a variable is integer. More...

std::vector< std::string >	m_blockFactories
	Returns array[getNumCols()] specifying if a variable is integer. More...

bool	m_blockFactoriesProcessed
	Returns array[getNumCols()] specifying if a variable is integer. More...

void	readOSiL (std::string &filename)
	Returns array[getNumCols()] specifying if a variable is integer. More...

void	readOSoL (std::string &filename)
	Returns array[getNumCols()] specifying if a variable is integer. More...

CoinPackedVector *	getRow (int i)
	Returns array[getNumCols()] specifying if a variable is integer. More...

CoinPackedMatrix *	getCoinPackedMatrix ()
	Returns array[getNumCols()] specifying if a variable is integer. More...

const char *	getIntegerColumns ()
	Returns array[getNumCols()] specifying if a variable is integer. More...

double	getObjectiveOffset ()
	Returns array[getNumCols()] specifying if a variable is integer. More...

std::vector< std::set< int > >	getBlockVarIndexes ()
	Returns array[getNumCols()] specifying if a variable is integer. More...

std::set< int >	getCoreConstraintIndexes ()
	Returns array[getNumCols()] specifying if a variable is integer. More...

std::vector< std::map< int, int > >	getBlockConstraintIndexes ()
	Returns array[getNumCols()] specifying if a variable is integer. More...

std::vector< OSInstance * >	getBlockOSInstances ()
	Returns array[getNumCols()] specifying if a variable is integer. More...

std::vector< std::string >	getBlockFactories ()
	Returns array[getNumCols()] specifying if a variable is integer. More...

double *	getObjectiveFunctionCoeff ()
	Returns array[getNumCols()] specifying if a variable is integer. More...

const double	getBestKnownLB () const
	Returns array[getNumCols()] specifying if a variable is integer. More...

const double	getBestKnownUB () const
	Returns array[getNumCols()] specifying if a variable is integer. More...

const std::string *	getObjectiveMaxOrMins () const
	Get objective maxOrMins. More...

const double *	getObjectiveConstants () const
	Get objective constants. More...

const double *	getObjectiveWeights () const
	Get objective weights. More...

const int	getNumberOfIntegerVariables () const
	getNumberOfIntegerVariables More...

const int	getNumberOfBinaryVariables () const
	getNumberOfBinaryVariables More...

const int	getVariableNumber () const
	Get variable number. More...

const int	getConstraintNumber () const
	Get constraint number. More...

const double *	getColLower () const
	Get variable lower bounds. More...

const double *	getColUpper () const
	Get variable upper bounds. More...

const std::string *	getVariableNames () const
	Get variable names. More...

const double *	getRowLower () const
	Get constraint lower bounds. More...

const double *	getRowUpper () const
	Get constraint upper bounds. More...

const std::string *	getConstraintNames () const
	Get constraint names. More...

std::map< int, std::vector< int > >	generateInitialMaster ()
	Returns array[getNumCols()] specifying if a variable is integer. More...

	OS_DipInterface ()
	class constructor More...

	~OS_DipInterface ()
	class destructor More...

Detailed Description

A generic class to interface with Optimization Services (OS) for use in Dip (Decomposition in Integer Programming).

Definition at line 57 of file OSDipInterface.h.

Constructor & Destructor Documentation

OS_DipInterface::OS_DipInterface ( )

class constructor

Default constructor.

Definition at line 680 of file OSDipInterface.cpp.

OS_DipInterface::~OS_DipInterface ( )

class destructor

Definition at line 699 of file OSDipInterface.cpp.

Member Function Documentation

void OS_DipInterface::readOSiL ( std::string & filename )

Returns array[getNumCols()] specifying if a variable is integer.

At present, simply coded as zero (continuous) and non-zero (integer) May be extended at a later date.

Definition at line 23 of file OSDipInterface.cpp.

void OS_DipInterface::readOSoL ( std::string & filename )

Returns array[getNumCols()] specifying if a variable is integer.

At present, simply coded as zero (continuous) and non-zero (integer) May be extended at a later date.

Definition at line 74 of file OSDipInterface.cpp.

CoinPackedVector * OS_DipInterface::getRow ( int i )

Returns array[getNumCols()] specifying if a variable is integer.

At present, simply coded as zero (continuous) and non-zero (integer) May be extended at a later date.

Definition at line 108 of file OSDipInterface.cpp.

CoinPackedMatrix * OS_DipInterface::getCoinPackedMatrix ( )

Returns array[getNumCols()] specifying if a variable is integer.

At present, simply coded as zero (continuous) and non-zero (integer) May be extended at a later date.

Definition at line 103 of file OSDipInterface.cpp.

const char * OS_DipInterface::getIntegerColumns ( )

Returns array[getNumCols()] specifying if a variable is integer.

At present, simply coded as zero (continuous) and non-zero (integer) May be extended at a later date.

Definition at line 127 of file OSDipInterface.cpp.

double OS_DipInterface::getObjectiveOffset ( )

Returns array[getNumCols()] specifying if a variable is integer.

At present, simply coded as zero (continuous) and non-zero (integer) May be extended at a later date.

Definition at line 147 of file OSDipInterface.cpp.

std::vector< std::set< int > > OS_DipInterface::getBlockVarIndexes ( )

Returns array[getNumCols()] specifying if a variable is integer.

At present, simply coded as zero (continuous) and non-zero (integer) May be extended at a later date.

Definition at line 211 of file OSDipInterface.cpp.

std::set< int > OS_DipInterface::getCoreConstraintIndexes ( )

Returns array[getNumCols()] specifying if a variable is integer.

At present, simply coded as zero (continuous) and non-zero (integer) May be extended at a later date.

Definition at line 603 of file OSDipInterface.cpp.

std::vector< std::map< int, int > > OS_DipInterface::getBlockConstraintIndexes ( )

Returns array[getNumCols()] specifying if a variable is integer.

At present, simply coded as zero (continuous) and non-zero (integer) May be extended at a later date.

Definition at line 279 of file OSDipInterface.cpp.

std::vector< OSInstance * > OS_DipInterface::getBlockOSInstances ( )

Returns array[getNumCols()] specifying if a variable is integer.

At present, simply coded as zero (continuous) and non-zero (integer) May be extended at a later date.

Definition at line 359 of file OSDipInterface.cpp.

std::vector< std::string > OS_DipInterface::getBlockFactories ( )

Returns array[getNumCols()] specifying if a variable is integer.

At present, simply coded as zero (continuous) and non-zero (integer) May be extended at a later date.

Definition at line 160 of file OSDipInterface.cpp.

double * OS_DipInterface::getObjectiveFunctionCoeff ( )

Returns array[getNumCols()] specifying if a variable is integer.

At present, simply coded as zero (continuous) and non-zero (integer) May be extended at a later date.

Definition at line 671 of file OSDipInterface.cpp.

const double OS_DipInterface::getBestKnownLB ( ) const

inline

Returns array[getNumCols()] specifying if a variable is integer.

At present, simply coded as zero (continuous) and non-zero (integer) May be extended at a later date.

Definition at line 132 of file OSDipInterface.h.

const double OS_DipInterface::getBestKnownUB ( ) const

inline

Returns array[getNumCols()] specifying if a variable is integer.

At present, simply coded as zero (continuous) and non-zero (integer) May be extended at a later date.

Definition at line 133 of file OSDipInterface.h.

const std::string* OS_DipInterface::getObjectiveMaxOrMins ( ) const

inline

Get objective maxOrMins.

One maxOrMin for each objective.

Returns: a std::string array of objective maxOrMins ("max" or "min"), null if no objectives.

Exceptions

Exception if the elements in objectives are logically inconsistent.

Definition at line 144 of file OSDipInterface.h.

const double* OS_DipInterface::getObjectiveConstants ( ) const

inline

Get objective constants.

One constant for each objective.

Returns: a double array of objective constants, null if no objectives.

Exceptions

Exception if the elements in objectives are logically inconsistent.

Definition at line 153 of file OSDipInterface.h.

const double* OS_DipInterface::getObjectiveWeights ( ) const

inline

Get objective weights.

One weight for each objective.

Returns: a double array of objective weights, null if no objectives.

Exceptions

Exception if the elements in objectives are logically inconsistent.

Definition at line 161 of file OSDipInterface.h.

const int OS_DipInterface::getNumberOfIntegerVariables ( ) const

inline

getNumberOfIntegerVariables

Returns: an integer which is the number of general integer variables.

Definition at line 167 of file OSDipInterface.h.

const int OS_DipInterface::getNumberOfBinaryVariables ( ) const

inline

getNumberOfBinaryVariables

Returns: an integer which is the number of binary variables.

Definition at line 173 of file OSDipInterface.h.

const int OS_DipInterface::getVariableNumber ( ) const

inline

Get variable number.

Returns: variable number.

Definition at line 181 of file OSDipInterface.h.

const int OS_DipInterface::getConstraintNumber ( ) const

inline

Get constraint number.

Returns: constraint number.

Definition at line 188 of file OSDipInterface.h.

const double* OS_DipInterface::getColLower ( ) const

inline

Get variable lower bounds.

Returns: pointer to variable lower bounds.

Definition at line 195 of file OSDipInterface.h.

const double* OS_DipInterface::getColUpper ( ) const

inline

Get variable upper bounds.

Returns: pointer to variable upper bounds.

Definition at line 203 of file OSDipInterface.h.

const std::string* OS_DipInterface::getVariableNames ( ) const

inline

Get variable names.

Returns: array of variable names.

Definition at line 211 of file OSDipInterface.h.

const double* OS_DipInterface::getRowLower ( ) const

inline

Get constraint lower bounds.

Returns: pointer to constraint lower bounds.

Definition at line 219 of file OSDipInterface.h.

const double* OS_DipInterface::getRowUpper ( ) const

inline

Get constraint upper bounds.

Returns: pointer to constraint upper bounds.

Definition at line 227 of file OSDipInterface.h.

const std::string* OS_DipInterface::getConstraintNames ( ) const

inline

Get constraint names.

Returns: array of constraint names.

Definition at line 235 of file OSDipInterface.h.

std::map< int, std::vector< int > > OS_DipInterface::generateInitialMaster ( )

Returns array[getNumCols()] specifying if a variable is integer.

At present, simply coded as zero (continuous) and non-zero (integer) May be extended at a later date.

Definition at line 719 of file OSDipInterface.cpp.

Member Data Documentation

bool OS_DipInterface::m_isProvenOptimal

Best known LB/UB.

Definition at line 63 of file OSDipInterface.h.

double OS_DipInterface::m_bestKnownLB

Definition at line 64 of file OSDipInterface.h.

double OS_DipInterface::m_bestKnownUB

Definition at line 65 of file OSDipInterface.h.

OSInstance* OS_DipInterface::m_osinstance

Definition at line 69 of file OSDipInterface.h.

OSOption* OS_DipInterface::m_osoption

Definition at line 70 of file OSDipInterface.h.

OSiLReader* OS_DipInterface::m_osilreader

Definition at line 71 of file OSDipInterface.h.

OSoLReader* OS_DipInterface::m_osolreader

Definition at line 72 of file OSDipInterface.h.

char* OS_DipInterface::m_integerVars

Definition at line 73 of file OSDipInterface.h.

CoinPackedMatrix* OS_DipInterface::m_coinpm

Definition at line 74 of file OSDipInterface.h.

CoinPackedVector* OS_DipInterface::m_row

Definition at line 75 of file OSDipInterface.h.

std::vector<std::set<int> > OS_DipInterface::m_blockVariableIndexes

Returns array[getNumCols()] specifying if a variable is integer.

At present, simply coded as zero (continuous) and non-zero (integer) May be extended at a later date.

Definition at line 101 of file OSDipInterface.h.

bool OS_DipInterface::m_blockVariableIndexesProcessed

Returns array[getNumCols()] specifying if a variable is integer.

At present, simply coded as zero (continuous) and non-zero (integer) May be extended at a later date.

Definition at line 102 of file OSDipInterface.h.

std::set<int> OS_DipInterface::m_coreConstraintIndexes

Returns array[getNumCols()] specifying if a variable is integer.

At present, simply coded as zero (continuous) and non-zero (integer) May be extended at a later date.

Definition at line 106 of file OSDipInterface.h.

bool OS_DipInterface::m_coreConstraintIndexesProcessed

Returns array[getNumCols()] specifying if a variable is integer.

At present, simply coded as zero (continuous) and non-zero (integer) May be extended at a later date.

Definition at line 107 of file OSDipInterface.h.

std::vector<std::map<int, int> > OS_DipInterface::m_blockConstraintIndexes

Returns array[getNumCols()] specifying if a variable is integer.

At present, simply coded as zero (continuous) and non-zero (integer) May be extended at a later date.

Definition at line 113 of file OSDipInterface.h.

bool OS_DipInterface::m_blockConstraintIndexesProcessed

Returns array[getNumCols()] specifying if a variable is integer.

At present, simply coded as zero (continuous) and non-zero (integer) May be extended at a later date.

Definition at line 114 of file OSDipInterface.h.

std::vector<OSInstance* > OS_DipInterface::m_blockOSInstances

Returns array[getNumCols()] specifying if a variable is integer.

At present, simply coded as zero (continuous) and non-zero (integer) May be extended at a later date.

Definition at line 118 of file OSDipInterface.h.

bool OS_DipInterface::m_blockOSInstancesProcessed

Returns array[getNumCols()] specifying if a variable is integer.

At present, simply coded as zero (continuous) and non-zero (integer) May be extended at a later date.

Definition at line 119 of file OSDipInterface.h.

std::vector<std::string > OS_DipInterface::m_blockFactories

Returns array[getNumCols()] specifying if a variable is integer.

At present, simply coded as zero (continuous) and non-zero (integer) May be extended at a later date.

Definition at line 124 of file OSDipInterface.h.

bool OS_DipInterface::m_blockFactoriesProcessed

Returns array[getNumCols()] specifying if a variable is integer.

At present, simply coded as zero (continuous) and non-zero (integer) May be extended at a later date.

Definition at line 125 of file OSDipInterface.h.

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

/tmp/OS-2.10.2/examples/osDip/OSDipInterface.h
/tmp/OS-2.10.2/examples/osDip/OSDipInterface.cpp

Public Attributes

Helper Methods.

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation