OneToOneVariableConverterIF Class Reference

Variable to variable converter interface. More...

#include <VariableConverter.hpp>

Inheritance diagram for OneToOneVariableConverterIF:

Collaboration diagram for OneToOneVariableConverterIF:

Public Types
typedef map< string, ROCPPVarIF_Ptr >::const_iterator	const_iterator
Public Types inherited from VariableConverterIF
typedef map< string, ROCPPVarIF_Ptr >::const_iterator	const_iterator_inv
	Constant iterator into inverse map. More...

Public Member Functions
	OneToOneVariableConverterIF ()
	Constructor of OneToOneVariableConverterIF class. More...
	~OneToOneVariableConverterIF ()
	Destructor of OneToOneVariableConverterIF class. More...
const_iterator	find (string varName) const
const_iterator	begin () const
const_iterator	end () const
void	convertVar (vector< ROCPPConstraintIF_Ptr >::const_iterator first, vector< ROCPPConstraintIF_Ptr >::const_iterator last, ROCPPObjectiveIF_Ptr obj, const dvContainer &origDVContainer, vector< ROCPPConstraintIF_Ptr > &toAdd, ROCPPObjectiveIF_Ptr &toSet, bool resetAndSave=false)
	Approximate the original variable with a new variable or a constant for all variables in the input model. More...
virtual void	createTranslationMap (const dvContainer &tmpContainer, map< string, ROCPPVarIF_Ptr > &translationMap, vector< ROCPPConstraintIF_Ptr > &toAdd)=0
	Create translation map for the variables in the given container. More...
void	createInverseMap (const dvContainer &origDVContainer)
	Create the map m_inverseMap. More...
double	evaluateVariableValue (string nme, const map< string, double > &binValuesMap) const
	Evaluate and return the value of the given variable after converting it. More...
virtual ROCPPOptModelIF_Ptr	convertVar (ROCPPOptModelIF_Ptr pIn, bool resetAndSave=false)
	Get the objective and constraints in the input model and then convert the variables. More...
virtual void	convertVar (vector< ROCPPConstraintIF_Ptr >::const_iterator first, vector< ROCPPConstraintIF_Ptr >::const_iterator last, ROCPPObjectiveIF_Ptr obj, const dvContainer &origDVContainer, vector< ROCPPConstraintIF_Ptr > &toAdd, ROCPPObjectiveIF_Ptr &toSet, bool resetAndSave=false)=0
	Approximate each variable in the given objective and contraints. More...
Public Member Functions inherited from VariableConverterIF
	VariableConverterIF ()
	Constructor of VariableConverterIF class. More...
	~VariableConverterIF ()
	Destructor of VariableConverterIF class. More...
const_iterator_inv	findInv (string varName) const
	Return a constant iterator pointing to the pair of the given variable and the old variable associated with it. More...
const_iterator_inv	beginInv () const
	Return a constant iterator pointing to the beginning of the inverse map (m_inverseMap) More...
const_iterator_inv	endInv () const
	Return a constant iterator pointing to the end of the inverse map (m_inverseMap) More...
virtual ROCPPOptModelIF_Ptr	convertVar (ROCPPOptModelIF_Ptr pIn, bool resetAndSave=false)
	Get the objective and constraints in the input model and then convert the variables. More...
virtual void	convertVar (vector< ROCPPConstraintIF_Ptr >::const_iterator first, vector< ROCPPConstraintIF_Ptr >::const_iterator last, ROCPPObjectiveIF_Ptr obj, const dvContainer &origDVContainer, vector< ROCPPConstraintIF_Ptr > &toAdd, ROCPPObjectiveIF_Ptr &toSet, bool resetAndSave=false)=0
	Approximate each variable in the given objective and contraints. More...
virtual void	findVarsToTranslate (vector< ROCPPConstraintIF_Ptr >::const_iterator first, vector< ROCPPConstraintIF_Ptr >::const_iterator last, ROCPPObjectiveIF_Ptr obj, dvContainer &container)=0
	Find the variable in the given ocnstraints and objective to be mapped and store them in the container. More...
virtual void	printOut (const ROCPPOptModelIF_Ptr pIn, const map< string, double > &variableValue, ROCPPVarIF_Ptr dv)
	Print the solution of the given decision variable. More...

Protected Attributes
map< string, ROCPPVarIF_Ptr >	m_translationMap
	Map from name of the original variable to the new variable. More...
Protected Attributes inherited from VariableConverterIF
map< string, ROCPPVarIF_Ptr >	m_inverseMap
	Map from the new variable name to old variable. More...

Detailed Description

Variable to variable converter interface.

Class for converting a variable to another variable

Member Typedef Documentation

const_iterator

typedef map<string,ROCPPVarIF_Ptr>::const_iterator OneToOneVariableConverterIF::const_iterator

Constructor & Destructor Documentation

OneToOneVariableConverterIF()

OneToOneVariableConverterIF::OneToOneVariableConverterIF ( )

inline

Constructor of OneToOneVariableConverterIF class.

~OneToOneVariableConverterIF()

OneToOneVariableConverterIF::~OneToOneVariableConverterIF ( )

inline

Destructor of OneToOneVariableConverterIF class.

Member Function Documentation

begin()

const_iterator OneToOneVariableConverterIF::begin ( ) const

inline

convertVar() [1/3]

ROCPPOptModelIF_Ptr VariableConverterIF::convertVar

Get the objective and constraints in the input model and then convert the variables.

Parameters

pIn	Model to be approximated
resetAndSave	Whether to set the translation map in class OneToExprVariableConverterIF

convertVar() [2/3]

void OneToOneVariableConverterIF::convertVar	(	vector< ROCPPConstraintIF_Ptr >::const_iterator	first,
		vector< ROCPPConstraintIF_Ptr >::const_iterator	last,
		ROCPPObjectiveIF_Ptr	obj,
		const dvContainer &	origDVContainer,
		vector< ROCPPConstraintIF_Ptr > &	toAdd,
		ROCPPObjectiveIF_Ptr &	toSet,
		bool	resetAndSave = false
	)

Approximate the original variable with a new variable or a constant for all variables in the input model.

Parameters

resetAndSave

Indicates whether to reset the translation map

convertVar() [3/3]

virtual void VariableConverterIF::convertVar

Approximate each variable in the given objective and contraints.

Parameters

first	Constant iterator pointing to the beginning of the vector of constraints to be mapped
last	Constant iterator pointing to the end of the vector of constraints to be mapped
obj	Objective to be mapped
origDVContainer	Container of decision variables to be approximated
toAdd	Constraints after mapping
toSet	Objective after mapping

createInverseMap()

void OneToOneVariableConverterIF::createInverseMap ( const dvContainer &  origDVContainer )

virtual

Create the map m_inverseMap.

Implements VariableConverterIF.

createTranslationMap()

virtual void OneToOneVariableConverterIF::createTranslationMap ( const dvContainer &  tmpContainer, map< string, ROCPPVarIF_Ptr > &  translationMap, vector< ROCPPConstraintIF_Ptr > &  toAdd  )

pure virtual

Create translation map for the variables in the given container.

Parameters

tmpContainer	Container contains variables to be mapped
translationMap	Map from the name of the variable to the new variable it will be mapped to
toAdd	Contains the upper and lower bounds of the original variables as constraints

Implemented in PredefO2OVariableConverter, and ConstantDecisionRule.

end()

const_iterator OneToOneVariableConverterIF::end ( ) const

inline

evaluateVariableValue()

double OneToOneVariableConverterIF::evaluateVariableValue ( string  nme, const map< string, double > &  binValuesMap  ) const

virtual

Evaluate and return the value of the given variable after converting it.

Implements VariableConverterIF.

find()

const_iterator OneToOneVariableConverterIF::find ( string  varName ) const

inline

Member Data Documentation

m_translationMap

map<string, ROCPPVarIF_Ptr> OneToOneVariableConverterIF::m_translationMap

protected

Map from name of the original variable to the new variable.