limbo::solvers::Variable< T > Class Template Reference

Describe variables in optimization problem. More...

#include <Solvers.h>

Public Types
typedef T	coefficient_value_type
	coefficient type

Public Member Functions
	Variable (unsigned int id=std::numeric_limits< unsigned int >::max())
	constructor More...
	Variable (Variable const &rhs)
	copy constructor More...
Variable &	operator= (Variable const &rhs)
	assignment More...
	~Variable ()
	destructor
unsigned int	id () const
void	setId (unsigned int id)
	set variable index More...
bool	valid () const
bool	operator== (Variable const &rhs) const
bool	operator!= (Variable const &rhs) const
LinearTerm < coefficient_value_type >	operator- () const

Protected Member Functions
void	copy (Variable const &rhs)
	copy object

Protected Attributes
unsigned int	m_id
	variable index

Friends
LinearTerm < coefficient_value_type >	operator* (Variable const &var, coefficient_value_type coef)
LinearTerm < coefficient_value_type >	operator* (coefficient_value_type coef, Variable const &var)
LinearTerm < coefficient_value_type >	operator/ (Variable const &var, coefficient_value_type coef)
LinearExpression < coefficient_value_type >	operator+ (Variable const &var, coefficient_value_type constant)
LinearExpression < coefficient_value_type >	operator+ (coefficient_value_type constant, Variable const &var)
LinearExpression < coefficient_value_type >	operator+ (Variable const &var1, Variable const &var2)
LinearExpression < coefficient_value_type >	operator- (Variable const &var, coefficient_value_type constant)
LinearExpression < coefficient_value_type >	operator- (coefficient_value_type constant, Variable const &var)
LinearExpression < coefficient_value_type >	operator- (Variable const &var1, Variable const &var2)
LinearConstraint < coefficient_value_type >	operator< (Variable const &var, coefficient_value_type rhs)
	overload < More...
LinearConstraint < coefficient_value_type >	operator<= (Variable const &var, coefficient_value_type rhs)
	overload <= More...
LinearConstraint < coefficient_value_type >	operator> (Variable const &var, coefficient_value_type rhs)
	overload > More...
LinearConstraint < coefficient_value_type >	operator>= (Variable const &var, coefficient_value_type rhs)
	overload >= More...
LinearConstraint < coefficient_value_type >	operator== (Variable const &var, coefficient_value_type rhs)
	overload == More...

Detailed Description

template<typename T>
class limbo::solvers::Variable< T >

Describe variables in optimization problem.

Template Parameters

T	coefficient type of the variable, not the value type of variable itself. It is necessary for operator overloading

Definition at line 70 of file Solvers.h.

Constructor & Destructor Documentation

template<typename T>

limbo::solvers::Variable< T >::Variable ( unsigned int  id = std::numeric_limits<unsigned int>::max() )

inlineexplicit

constructor

Parameters

id	variable index

Definition at line 95 of file Solvers.h.

template<typename T>

limbo::solvers::Variable< T >::Variable ( Variable< T > const &  rhs )

inline

copy constructor

Parameters

rhs	right hand side

Definition at line 101 of file Solvers.h.

Member Function Documentation

template<typename T>

unsigned int limbo::solvers::Variable< T >::id ( ) const

inline

Returns

variable index

Definition at line 117 of file Solvers.h.

template<typename T>

bool limbo::solvers::Variable< T >::operator!= ( Variable< T > const &  rhs ) const

inline

overload inequal

Parameters

rhs	right hand side

Returns

true if the indices of variables are equal

Definition at line 135 of file Solvers.h.

template<typename T>

LinearTerm<coefficient_value_type> limbo::solvers::Variable< T >::operator- ( ) const

inline

overload negation

Returns

a copy of new object

Definition at line 141 of file Solvers.h.

template<typename T>

Variable& limbo::solvers::Variable< T >::operator= ( Variable< T > const &  rhs )

inline

assignment

Parameters

rhs	right hand side

Definition at line 107 of file Solvers.h.

template<typename T>

bool limbo::solvers::Variable< T >::operator== ( Variable< T > const &  rhs ) const

inline

overload equal

Parameters

rhs	right hand side

Returns

true if the indices of variables are equal

Definition at line 128 of file Solvers.h.

template<typename T>

void limbo::solvers::Variable< T >::setId ( unsigned int  id )

inline

set variable index

Parameters

id

index

Definition at line 120 of file Solvers.h.

template<typename T>

bool limbo::solvers::Variable< T >::valid ( ) const

inline

Returns

true if the variable is valid

Definition at line 123 of file Solvers.h.

Friends And Related Function Documentation

template<typename T>

LinearTerm<coefficient_value_type> operator* ( Variable< T > const &  var, coefficient_value_type  coef  )

friend

overload multiply var*coef

Parameters

var	variable
coef	coefficient

Returns

result object

Definition at line 150 of file Solvers.h.

template<typename T>

LinearTerm<coefficient_value_type> operator* ( coefficient_value_type  coef, Variable< T > const &  var  )

friend

overload multiply coef*var

Parameters

var	variable
coef	coefficient

Returns

result object

Definition at line 158 of file Solvers.h.

template<typename T>

LinearExpression<coefficient_value_type> operator+ ( Variable< T > const &  var, coefficient_value_type  constant  )

friend

overload plus var+constant

Parameters

var	variable
constant	constant

Returns

result object

Definition at line 174 of file Solvers.h.

template<typename T>

LinearExpression<coefficient_value_type> operator+ ( coefficient_value_type  constant, Variable< T > const &  var  )

friend

overload plus constant+var

Parameters

constant	coefficient
var	variable

Returns

result object

Definition at line 182 of file Solvers.h.

template<typename T>

LinearExpression<coefficient_value_type> operator+ ( Variable< T > const &  var1, Variable< T > const &  var2  )

friend

overload plus var+var

Parameters

var1	variable
var2	variable

Returns

result object

Definition at line 190 of file Solvers.h.

template<typename T>

LinearExpression<coefficient_value_type> operator- ( Variable< T > const &  var, coefficient_value_type  constant  )

friend

overload minus var-constant

Parameters

var	variable
constant	coefficient

Returns

result object

Definition at line 198 of file Solvers.h.

template<typename T>

LinearExpression<coefficient_value_type> operator- ( coefficient_value_type  constant, Variable< T > const &  var  )

friend

overload minus constant-var

Parameters

constant	coefficient
var	variable

Returns

result object

Definition at line 206 of file Solvers.h.

template<typename T>

LinearExpression<coefficient_value_type> operator- ( Variable< T > const &  var1, Variable< T > const &  var2  )

friend

overload minus var-var

Parameters

var1	variable
var2	variable

Returns

result object

Definition at line 214 of file Solvers.h.

template<typename T>

LinearTerm<coefficient_value_type> operator/ ( Variable< T > const &  var, coefficient_value_type  coef  )

friend

overload divide var/coef

Parameters

var	variable
coef	coefficient

Returns

result object

Definition at line 166 of file Solvers.h.

template<typename T>

LinearConstraint<coefficient_value_type> operator< ( Variable< T > const &  var, coefficient_value_type  rhs  )

friend

overload <

Parameters

var	variable
rhs	right hand side constant

Definition at line 221 of file Solvers.h.

template<typename T>

LinearConstraint<coefficient_value_type> operator<= ( Variable< T > const &  var, coefficient_value_type  rhs  )

friend

overload <=

Parameters

var	variable
rhs	right hand side constant

Definition at line 228 of file Solvers.h.

template<typename T>

LinearConstraint<coefficient_value_type> operator== ( Variable< T > const &  var, coefficient_value_type  rhs  )

friend

overload ==

Parameters

var	variable
rhs	right hand side constant

Definition at line 249 of file Solvers.h.

template<typename T>

LinearConstraint<coefficient_value_type> operator> ( Variable< T > const &  var, coefficient_value_type  rhs  )

friend

overload >

Parameters

var	variable
rhs	right hand side constant

Definition at line 235 of file Solvers.h.

template<typename T>

LinearConstraint<coefficient_value_type> operator>= ( Variable< T > const &  var, coefficient_value_type  rhs  )

friend

overload >=

Parameters

var	variable
rhs	right hand side constant

Definition at line 242 of file Solvers.h.

---

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

• /Users/yibolin/Documents/Projects/Limbo/limbo/solvers/Solvers.h