flopc::MP_variable Class Reference

Symantic representation of a variable. More...

#include <MP_variable.hpp>

Inheritance diagram for flopc::MP_variable:

Collaboration diagram for flopc::MP_variable:

Public Member Functions
	MP_variable (const MP_set_base &s1=MP_set::getEmpty(), const MP_set_base &s2=MP_set::getEmpty(), const MP_set_base &s3=MP_set::getEmpty(), const MP_set_base &s4=MP_set::getEmpty(), const MP_set_base &s5=MP_set::getEmpty())
void	display (const std::string &s="")
	~MP_variable ()
double	level (int i1=0, int i2=0, int i3=0, int i4=0, int i5=0)
	Returns the value of the variable given the specific index values.
const VariableRef &	operator() (const MP_index_exp &d1=MP_index_exp::getEmpty(), const MP_index_exp &d2=MP_index_exp::getEmpty(), const MP_index_exp &d3=MP_index_exp::getEmpty(), const MP_index_exp &d4=MP_index_exp::getEmpty(), const MP_index_exp &d5=MP_index_exp::getEmpty())
	Interal use only.
void	binary ()
	Call this method to turn the variable into a binary variable.
void	integer ()
	Call this method to turn the MP_variable into an integer variable.
Public Member Functions inherited from flopc::RowMajor
int	size () const
Public Member Functions inherited from flopc::Named
std::string	getName () const
void	setName (const std::string &n)

Public Attributes
MP_data	upperLimit
	Upper bound on the variable value.
MP_data	lowerLimit
	Lower bound on the variable value.

Friends
class	MP_model
class	DisplayVariable
class	VariableRef

Additional Inherited Members
Protected Member Functions inherited from flopc::RowMajor
	RowMajor (int s1, int s2, int s3, int s4, int s5)
int	f (int i1=0, int i2=0, int i3=0, int i4=0, int i5=0) const
Protected Member Functions inherited from flopc::Functor
	Functor ()
virtual	~Functor ()
Protected Attributes inherited from flopc::RowMajor
int	size1
int	size2
int	size3
int	size4
int	size5
int	size_

Detailed Description

Symantic representation of a variable.

This is one of the main public interface classes.
It should be directly declared by clients of the FlopC++. The parametersof construction are MP_set s which specify the indexes over which the variable is defined.

Definition at line 75 of file MP_variable.hpp.

Constructor & Destructor Documentation

MP_variable()

flopc::MP_variable::MP_variable	(	const MP_set_base &	s1 = MP_set::getEmpty(),
		const MP_set_base &	s2 = MP_set::getEmpty(),
		const MP_set_base &	s3 = MP_set::getEmpty(),
		const MP_set_base &	s4 = MP_set::getEmpty(),
		const MP_set_base &	s5 = MP_set::getEmpty() )

~MP_variable()

flopc::MP_variable::~MP_variable ( )

inline

Definition at line 88 of file MP_variable.hpp.

Member Function Documentation

display()

void flopc::MP_variable::display

(

const std::string &

s = ""

)

level()

double flopc::MP_variable::level	(	int	i1 = 0,
		int	i2 = 0,
		int	i3 = 0,
		int	i4 = 0,
		int	i5 = 0 )

Returns the value of the variable given the specific index values.

operator()()

const VariableRef & flopc::MP_variable::operator() ( const MP_index_exp & d1 = MP_index_exp::getEmpty(), const MP_index_exp & d2 = MP_index_exp::getEmpty(), const MP_index_exp & d3 = MP_index_exp::getEmpty(), const MP_index_exp & d4 = MP_index_exp::getEmpty(), const MP_index_exp & d5 = MP_index_exp::getEmpty() )

inline

Interal use only.

Definition at line 95 of file MP_variable.hpp.

binary()

void flopc::MP_variable::binary ( )

inline

Call this method to turn the variable into a binary variable.

Definition at line 108 of file MP_variable.hpp.

integer()

void flopc::MP_variable::integer ( )

inline

Call this method to turn the MP_variable into an integer variable.

Definition at line 114 of file MP_variable.hpp.

Friends And Related Symbol Documentation

MP_model

friend class MP_model

friend

Definition at line 76 of file MP_variable.hpp.

DisplayVariable

friend class DisplayVariable

friend

Definition at line 77 of file MP_variable.hpp.

VariableRef

friend class VariableRef

friend

Definition at line 78 of file MP_variable.hpp.

Member Data Documentation

upperLimit

MP_data flopc::MP_variable::upperLimit

Upper bound on the variable value.

Definition at line 119 of file MP_variable.hpp.

lowerLimit

MP_data flopc::MP_variable::lowerLimit

Lower bound on the variable value.

Definition at line 121 of file MP_variable.hpp.

---

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

• /builddir/build/BUILD/FlopC++-1.2.5/src/MP_variable.hpp