Limbo
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
limbo::solvers::VariableProperty< V > Class Template Reference

Describe properties of a variable. More...

#include <Solvers.h>

Public Types

typedef V variable_value_type
 type of bounds
 

Public Member Functions

 VariableProperty (variable_value_type lb, variable_value_type ub, SolverProperty nt, std::string const &n)
 constructor More...
 
 VariableProperty (VariableProperty const &rhs)
 copy constructor More...
 
VariablePropertyoperator= (VariableProperty const &rhs)
 assignment More...
 
variable_value_type lowerBound () const
 
void setLowerBound (variable_value_type lb)
 
void updateLowerBound (variable_value_type lb)
 
variable_value_type upperBound () const
 
void setUpperBound (variable_value_type ub)
 
void updateUpperBound (variable_value_type ub)
 
SolverProperty numericType () const
 
void setNumericType (SolverProperty nt)
 
std::string const & name () const
 
void setName (std::string const &n)
 

Protected Member Functions

void copy (VariableProperty const &rhs)
 copy object More...
 

Protected Attributes

variable_value_type m_lowerBound
 lower bound
 
variable_value_type m_upperBound
 upper bound
 
SolverProperty m_numericType
 numeric type, BINARY, INTEGER, CONTINUOUS
 
std::string m_name
 name of variable
 

Detailed Description

template<typename V>
class limbo::solvers::VariableProperty< V >

Describe properties of a variable.

Template Parameters
Vtype of variable bound

Definition at line 72 of file Solvers.h.

Constructor & Destructor Documentation

template<typename V >
limbo::solvers::VariableProperty< V >::VariableProperty ( variable_value_type  lb,
variable_value_type  ub,
SolverProperty  nt,
std::string const &  n 
)
inline

constructor

Parameters
lblower bound
ubupper bound
ntnumeric type
nname

Definition at line 277 of file Solvers.h.

template<typename V >
limbo::solvers::VariableProperty< V >::VariableProperty ( VariableProperty< V > const &  rhs)
inline

copy constructor

Parameters
rhsright hand side

Definition at line 286 of file Solvers.h.

Member Function Documentation

template<typename V >
void limbo::solvers::VariableProperty< V >::copy ( VariableProperty< V > const &  rhs)
inlineprotected

copy object

Parameters
rhsright hand side

Definition at line 331 of file Solvers.h.

template<typename V >
variable_value_type limbo::solvers::VariableProperty< V >::lowerBound ( ) const
inline
Returns
lower bound

Definition at line 300 of file Solvers.h.

template<typename V >
std::string const& limbo::solvers::VariableProperty< V >::name ( ) const
inline
Returns
name of variable

Definition at line 324 of file Solvers.h.

template<typename V >
SolverProperty limbo::solvers::VariableProperty< V >::numericType ( ) const
inline
Returns
numeric type

Definition at line 312 of file Solvers.h.

template<typename V >
VariableProperty& limbo::solvers::VariableProperty< V >::operator= ( VariableProperty< V > const &  rhs)
inline

assignment

Parameters
rhsright hand side

Definition at line 292 of file Solvers.h.

template<typename V >
void limbo::solvers::VariableProperty< V >::setLowerBound ( variable_value_type  lb)
inline
Parameters
lblower bound

Definition at line 302 of file Solvers.h.

template<typename V >
void limbo::solvers::VariableProperty< V >::setName ( std::string const &  n)
inline
Parameters
nname

Definition at line 326 of file Solvers.h.

template<typename V >
void limbo::solvers::VariableProperty< V >::setNumericType ( SolverProperty  nt)
inline
Parameters
ntnumeric type

Definition at line 314 of file Solvers.h.

template<typename V >
void limbo::solvers::VariableProperty< V >::setUpperBound ( variable_value_type  ub)
inline
Parameters
ubupper bound

Definition at line 308 of file Solvers.h.

template<typename V >
void limbo::solvers::VariableProperty< V >::updateLowerBound ( variable_value_type  lb)
inline
Parameters
lblower bound

Definition at line 304 of file Solvers.h.

template<typename V >
void limbo::solvers::VariableProperty< V >::updateUpperBound ( variable_value_type  ub)
inline
Parameters
ubupper bound

Definition at line 310 of file Solvers.h.

template<typename V >
variable_value_type limbo::solvers::VariableProperty< V >::upperBound ( ) const
inline
Returns
upper bound

Definition at line 306 of file Solvers.h.


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