ipo::detail::Var Class Reference

Abstract base class for Variable and Array;. More...

#include <Var.hpp>

Inheritance diagram for ipo::detail::Var:

Collaboration diagram for ipo::detail::Var:

Public Member Functions
	Var (ModelBase &model)
	Constructor needs a model so that variable can only be attached to one model. More...
virtual	~Var ()=0
	Virtual destructor to make class abstract. More...
	Var (Var &var)
	Copy constructor. More...
Var &	operator= (Var &var)
	Copy assignment operator. More...
	Var (Var &&var)
	Move constructor. More...
Var &	operator= (Var &&var)
	Move assignment operator. More...
ModelBase const *const	getModel () const
	Get pointer to model. More...
virtual void	summary (std::ostream &ostream=std::cout, std::string const &prefix="") const =0
	Create a summary of this object. More...

Protected Attributes
ModelBase &	model
	A Model to attach this to. More...

Detailed Description

Abstract base class for Variable and Array;.

Definition at line 49 of file Var.hpp.

Constructor & Destructor Documentation

Var::Var

(

ModelBase &

model

)

Constructor needs a model so that variable can only be attached to one model.

Parameters

model

The Model

Definition at line 28 of file Var.cc.

Var::~Var ( )

pure virtual

Virtual destructor to make class abstract.

Definition at line 30 of file Var.cc.

ipo::detail::Var::Var ( Var &  var )

inline

Copy constructor.

Parameters

var	The Var to be copied

Definition at line 65 of file Var.hpp.

ipo::detail::Var::Var ( Var &&  var )

inline

Move constructor.

Parameters

var	The Var to be moved

Definition at line 77 of file Var.hpp.

Member Function Documentation

ModelBase const* const ipo::detail::Var::getModel ( ) const

inline

Get pointer to model.

Definition at line 88 of file Var.hpp.

References model.

Referenced by ipo::Objective::addArray(), ipo::Array::assign(), ipo::Array::emplace(), ipo::Array::emplace_back(), ipo::Array::insert(), ipo::Array::push_back(), ipo::Objective::removeArray(), ipo::Array::resize(), ipo::LinearConstraint::setLowerBound(), ipo::LinearConstraint::setUpperBound(), ipo::LinearConstraint::setValue(), and ipo::Array::swap().

Var & Var::operator=

(

Var &

var

)

Copy assignment operator.

Parameters

var	The var to be copied

Returns

*this

Exceptions

IPOException

if models differ

Definition at line 40 of file Var.cc.

References IPOE, and model.

Var & Var::operator=

(

Var &&

var

)

Move assignment operator.

Parameters

var	The var to be moved

Returns

*this

Exceptions

IPOException

if models differ

Definition at line 33 of file Var.cc.

References IPOE, and model.

virtual void ipo::detail::Var::summary ( std::ostream &  ostream = std::cout, std::string const &  prefix = ""  ) const

pure virtual

Create a summary of this object.

Parameters

ostream	The stream to print to.
prefix	This is put in front of every row of output, for example for indentation

Implemented in ipo::Array, ipo::Objective, ipo::Constraint, and ipo::Variable.

Member Data Documentation

ModelBase& ipo::detail::Var::model

protected

A Model to attach this to.

Definition at line 101 of file Var.hpp.

Referenced by ipo::Array::Array(), ipo::Array::assign(), ipo::Constraint::Constraint(), getModel(), ipo::Objective::getVariables(), ipo::Array::insert(), ipo::LinearConstraint::LinearConstraint(), ipo::Objective::Objective(), operator=(), ipo::Objective::operator=(), ipo::Variable::operator=(), ipo::Constraint::operator=(), ipo::Array::operator=(), ipo::Array::push_back(), ipo::Array::resize(), ipo::Array::swap(), ipo::Array::Data::testModelMatch(), and ipo::Variable::Variable().

---

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

• Var.hpp
• Var.cc