ConstraintComponent Class Reference

Data class for symbolically formulating constraints within optimal control problems. More...

#include <constraint_component.hpp>

Public Member Functions
	ConstraintComponent ()
	ConstraintComponent (const ConstraintComponent &arg)
uint	getDim () const
Expression	getExpression () const
const DVector &	getLB () const
const VariablesGrid &	getLBgrid () const
const DVector &	getUB () const
const VariablesGrid &	getUBgrid () const
BooleanType	hasLBgrid () const
BooleanType	hasUBgrid () const
returnValue	initialize (const DVector &lb, Expression arg, const DVector &ub)
returnValue	initialize (const VariablesGrid &lb, Expression arg, const VariablesGrid &ub)
ConstraintComponent	operator() (const uint &index) const
ConstraintComponent	operator<= (const double &ub) const
ConstraintComponent	operator<= (const DVector &ub) const
ConstraintComponent	operator<= (const VariablesGrid &ub) const
ConstraintComponent &	operator= (const ConstraintComponent &arg)
ConstraintComponent	operator== (const double &b) const
ConstraintComponent	operator== (const DVector &b) const
ConstraintComponent	operator== (const VariablesGrid &b) const
ConstraintComponent	operator>= (const double &lb) const
ConstraintComponent	operator>= (const DVector &lb) const
ConstraintComponent	operator>= (const VariablesGrid &lb) const
returnValue	setLB (const double &lb_)
returnValue	setLB (const DVector &lb_)
returnValue	setLB (const VariablesGrid &lb_)
returnValue	setUB (const double &lb_)
returnValue	setUB (const DVector &lb_)
returnValue	setUB (const VariablesGrid &lb_)
	~ConstraintComponent ()

Protected Attributes
Expression	expression
DVector	lb
VariablesGrid	lbGrid
DVector	ub
VariablesGrid	ubGrid

Friends
ConstraintComponent	operator<= (double lb_, const ConstraintComponent &arg)
ConstraintComponent	operator<= (DVector lb_, const ConstraintComponent &arg)
ConstraintComponent	operator<= (VariablesGrid lb_, const ConstraintComponent &arg)
ConstraintComponent	operator>= (double ub_, const ConstraintComponent &arg)
ConstraintComponent	operator>= (DVector ub_, const ConstraintComponent &arg)
ConstraintComponent	operator>= (VariablesGrid ub_, const ConstraintComponent &arg)

Detailed Description

Data class for symbolically formulating constraints within optimal control problems.

The class ConstraintComponent is a data class for symbolically formulating constraints within optimal control problems.

\author Boris Houska, Hans Joachim Ferreau

Definition at line 56 of file constraint_component.hpp.

Constructor & Destructor Documentation

BEGIN_NAMESPACE_ACADO ConstraintComponent::ConstraintComponent

(

)

Default constructor

Definition at line 48 of file constraint_component.cpp.

ConstraintComponent::ConstraintComponent

(

const ConstraintComponent &

arg

)

Copy constructor (deep copy).

Definition at line 56 of file constraint_component.cpp.

ConstraintComponent::~ConstraintComponent

(

)

Default destructor.

Definition at line 66 of file constraint_component.cpp.

Member Function Documentation

uint ConstraintComponent::getDim ( ) const

inline

Expression ConstraintComponent::getExpression ( ) const

inline

const DVector& ConstraintComponent::getLB ( ) const

inline

const VariablesGrid& ConstraintComponent::getLBgrid ( ) const

inline

const DVector& ConstraintComponent::getUB ( ) const

inline

const VariablesGrid& ConstraintComponent::getUBgrid ( ) const

inline

BooleanType ConstraintComponent::hasLBgrid ( ) const

inline

BooleanType ConstraintComponent::hasUBgrid ( ) const

inline

returnValue ConstraintComponent::initialize	(	const DVector &	lb,
		Expression	arg,
		const DVector &	ub
	)

Initializes the constraint component.

Definition at line 85 of file constraint_component.cpp.

returnValue ConstraintComponent::initialize	(	const VariablesGrid &	lb,
		Expression	arg,
		const VariablesGrid &	ub
	)

Initializes the constraint component.

Definition at line 95 of file constraint_component.cpp.

ConstraintComponent ConstraintComponent::operator()

(

const uint &

index

)

const

Access Operator.

Definition at line 107 of file constraint_component.cpp.

ConstraintComponent ConstraintComponent::operator<= ( const double &  ub ) const

inline

ConstraintComponent ConstraintComponent::operator<= ( const DVector &  ub ) const

inline

ConstraintComponent ConstraintComponent::operator<= ( const VariablesGrid &  ub ) const

inline

ConstraintComponent & ConstraintComponent::operator=

(

const ConstraintComponent &

arg

)

Assignment Operator (deep copy).

Definition at line 71 of file constraint_component.cpp.

ConstraintComponent ConstraintComponent::operator== ( const double &  b ) const

inline

ConstraintComponent ConstraintComponent::operator== ( const DVector &  b ) const

inline

ConstraintComponent ConstraintComponent::operator== ( const VariablesGrid &  b ) const

inline

ConstraintComponent ConstraintComponent::operator>= ( const double &  lb ) const

inline

ConstraintComponent ConstraintComponent::operator>= ( const DVector &  lb ) const

inline

ConstraintComponent ConstraintComponent::operator>= ( const VariablesGrid &  lb ) const

inline

returnValue ConstraintComponent::setLB ( const double &  lb_ )

inline

returnValue ConstraintComponent::setLB ( const DVector &  lb_ )

inline

returnValue ConstraintComponent::setLB ( const VariablesGrid &  lb_ )

inline

returnValue ConstraintComponent::setUB ( const double &  lb_ )

inline

returnValue ConstraintComponent::setUB ( const DVector &  lb_ )

inline

returnValue ConstraintComponent::setUB ( const VariablesGrid &  lb_ )

inline

Friends And Related Function Documentation

ConstraintComponent operator<= ( double  lb_, const ConstraintComponent &  arg  )

friend

Definition at line 126 of file constraint_component.cpp.

ConstraintComponent operator<= ( DVector  lb_, const ConstraintComponent &  arg  )

friend

Definition at line 140 of file constraint_component.cpp.

ConstraintComponent operator<= ( VariablesGrid  lb_, const ConstraintComponent &  arg  )

friend

Definition at line 154 of file constraint_component.cpp.

ConstraintComponent operator>= ( double  ub_, const ConstraintComponent &  arg  )

friend

Definition at line 133 of file constraint_component.cpp.

ConstraintComponent operator>= ( DVector  ub_, const ConstraintComponent &  arg  )

friend

Definition at line 147 of file constraint_component.cpp.

ConstraintComponent operator>= ( VariablesGrid  ub_, const ConstraintComponent &  arg  )

friend

Definition at line 161 of file constraint_component.cpp.

Member Data Documentation

Expression ConstraintComponent::expression

protected

Definition at line 151 of file constraint_component.hpp.

DVector ConstraintComponent::lb

protected

Definition at line 153 of file constraint_component.hpp.

VariablesGrid ConstraintComponent::lbGrid

protected

Definition at line 156 of file constraint_component.hpp.

DVector ConstraintComponent::ub

protected

Definition at line 154 of file constraint_component.hpp.

VariablesGrid ConstraintComponent::ubGrid

protected

Definition at line 157 of file constraint_component.hpp.

---

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

• constraint_component.hpp
• constraint_component.cpp