ROC++  v1.2
Automatic Robust Optimization in C++
VariableIF Class Reference

Static decision variable interface class. More...

#include <DecisionVariable.hpp>

Inheritance diagram for VariableIF:
Collaboration diagram for VariableIF:

Public Member Functions

 VariableIF (string name, decVariableType type, double lb, double ub)
 Constructor of the VariableIF class. More...
 
virtual ~VariableIF ()
 Destructor of the VariableIF class. More...
 
bool isAdaptive () const
 Return indicator of adaptability, return value equals true if and only if the decision variable can adapt to the history of observations. More...
 
uint getTimeStage () const
 Return the time-stage when the decision is made. More...
 
- Public Member Functions inherited from DecisionVariableIF
 DecisionVariableIF (string name, decVariableType type, double lb, double ub)
 Constructor of the DecisionVariableIF class. More...
 
virtual ~DecisionVariableIF ()
 Destructor of the DecisionVariableIF class. More...
 
decVariableType getType () const
 Get the variable type. More...
 
string getName () const
 Return the name of the decision variable. More...
 
virtual bool isBooleanVar () const =0
 Return true if and only if the decision variable is of boolean type. More...
 
virtual bool isIntegerVar () const =0
 Return true if and only if the decision variable is of integer type. More...
 
virtual bool isRealVar () const =0
 Return true if and only if the decision variable is of real-valued type. More...
 
double getLB () const
 Return the lower bound of the decision variable. More...
 
double getUB () const
 Return the upper bound of the decision variable. More...
 
virtual void setLB (double lb)
 Set lower bound of the variable. More...
 
virtual void setUB (double ub)
 Set upper bound of the variable. More...
 
virtual ROCPPVarIF_Ptr Clone ()=0
 Return a copy of the decision variable. More...
 
string writeLB () const
 Return the lower bound of the decision variable as a string. More...
 
string writeUB () const
 Return the upper bound of the decision variable as a string. More...
 

Detailed Description

Static decision variable interface class.

Constructor & Destructor Documentation

◆ VariableIF()

VariableIF::VariableIF ( string  name,
decVariableType  type,
double  lb,
double  ub 
)
inline

Constructor of the VariableIF class.

Parameters
namename of the decision variable
typetype of the decision variable
lblower bound of the variable
ubupper bound of the variable

◆ ~VariableIF()

virtual VariableIF::~VariableIF ( )
inlinevirtual

Destructor of the VariableIF class.

Member Function Documentation

◆ getTimeStage()

uint VariableIF::getTimeStage ( ) const
inlinevirtual

Return the time-stage when the decision is made.

Returns
time-stage, uint type

An adaptive decision taken at time-stage t can depend on all uncertain parameters revealed up to and including time t

Implements DecisionVariableIF.

◆ isAdaptive()

bool VariableIF::isAdaptive ( ) const
inlinevirtual

Return indicator of adaptability, return value equals true if and only if the decision variable can adapt to the history of observations.

Returns
adaptability indicator, boolean type

Implements DecisionVariableIF.