tsid::math::ConstraintBase Class Reference

Abstract class representing a linear equality/inequality constraint. Equality constraints are represented by a matrix A and a vector b: A*x = b Inequality constraints are represented by a matrix A and two vectors lb and ub: lb <= A*x <= ub Bounds are represented by two vectors lb and ub: lb <= x <= ub. More...

#include <constraint-base.hpp>

Inheritance diagram for tsid::math::ConstraintBase:

Public Member Functions
virtual bool	checkConstraint (ConstRefVector x, double tol=1e-6) const =0
virtual unsigned int	cols () const =0
EIGEN_MAKE_ALIGNED_OPERATOR_NEW	ConstraintBase (const std::string &name)
	ConstraintBase (const std::string &name, const unsigned int rows, const unsigned int cols)
	ConstraintBase (const std::string &name, ConstRefMatrix A)
virtual bool	isBound () const =0
virtual bool	isEquality () const =0
virtual bool	isInequality () const =0
virtual const Vector &	lowerBound () const =0
virtual Vector &	lowerBound ()=0
virtual Matrix &	matrix ()
virtual const Matrix &	matrix () const
virtual const std::string &	name () const
virtual void	resize (const unsigned int r, const unsigned int c)=0
virtual unsigned int	rows () const =0
virtual bool	setLowerBound (ConstRefVector lb)=0
virtual bool	setMatrix (ConstRefMatrix A)
virtual bool	setUpperBound (ConstRefVector ub)=0
virtual bool	setVector (ConstRefVector b)=0
virtual const Vector &	upperBound () const =0
virtual Vector &	upperBound ()=0
virtual const Vector &	vector () const =0
virtual Vector &	vector ()=0
virtual	~ConstraintBase ()=default

Protected Attributes
Matrix	m_A
std::string	m_name

Detailed Description

Abstract class representing a linear equality/inequality constraint. Equality constraints are represented by a matrix A and a vector b: A*x = b Inequality constraints are represented by a matrix A and two vectors lb and ub: lb <= A*x <= ub Bounds are represented by two vectors lb and ub: lb <= x <= ub.

Definition at line 35 of file constraint-base.hpp.

Constructor & Destructor Documentation

ConstraintBase() [1/3]

ConstraintBase::ConstraintBase

(

const std::string &

name

)

Definition at line 22 of file constraint-base.cpp.

ConstraintBase() [2/3]

ConstraintBase::ConstraintBase	(	const std::string &	name,
		const unsigned int	rows,
		const unsigned int	cols
	)

Definition at line 24 of file constraint-base.cpp.

ConstraintBase() [3/3]

ConstraintBase::ConstraintBase	(	const std::string &	name,
		ConstRefMatrix	A
	)

Definition at line 30 of file constraint-base.cpp.

~ConstraintBase()

virtual tsid::math::ConstraintBase::~ConstraintBase ( )

virtualdefault

Member Function Documentation

checkConstraint()

virtual bool tsid::math::ConstraintBase::checkConstraint ( ConstRefVector  x, double  tol = 1e-6  ) const

pure virtual

Implemented in tsid::math::ConstraintEquality, tsid::math::ConstraintInequality, and tsid::math::ConstraintBound.

cols()

virtual unsigned int tsid::math::ConstraintBase::cols ( ) const

pure virtual

Implemented in tsid::math::ConstraintEquality, tsid::math::ConstraintInequality, and tsid::math::ConstraintBound.

isBound()

virtual bool tsid::math::ConstraintBase::isBound ( ) const

pure virtual

Implemented in tsid::math::ConstraintEquality, tsid::math::ConstraintInequality, and tsid::math::ConstraintBound.

isEquality()

virtual bool tsid::math::ConstraintBase::isEquality ( ) const

pure virtual

Implemented in tsid::math::ConstraintEquality, tsid::math::ConstraintInequality, and tsid::math::ConstraintBound.

isInequality()

virtual bool tsid::math::ConstraintBase::isInequality ( ) const

pure virtual

Implemented in tsid::math::ConstraintEquality, tsid::math::ConstraintInequality, and tsid::math::ConstraintBound.

lowerBound() [1/2]

virtual const Vector& tsid::math::ConstraintBase::lowerBound ( ) const

pure virtual

Implemented in tsid::math::ConstraintEquality, tsid::math::ConstraintInequality, and tsid::math::ConstraintBound.

lowerBound() [2/2]

virtual Vector& tsid::math::ConstraintBase::lowerBound ( )

pure virtual

Implemented in tsid::math::ConstraintEquality, tsid::math::ConstraintInequality, and tsid::math::ConstraintBound.

matrix() [1/2]

virtual Matrix& tsid::math::ConstraintBase::matrix ( )

virtual

matrix() [2/2]

Matrix & ConstraintBase::matrix ( ) const

virtual

Definition at line 35 of file constraint-base.cpp.

name()

const std::string & ConstraintBase::name ( ) const

virtual

Definition at line 33 of file constraint-base.cpp.

resize()

virtual void tsid::math::ConstraintBase::resize ( const unsigned int  r, const unsigned int  c  )

pure virtual

Implemented in tsid::math::ConstraintEquality, tsid::math::ConstraintInequality, and tsid::math::ConstraintBound.

rows()

virtual unsigned int tsid::math::ConstraintBase::rows ( ) const

pure virtual

Implemented in tsid::math::ConstraintEquality, tsid::math::ConstraintInequality, and tsid::math::ConstraintBound.

setLowerBound()

virtual bool tsid::math::ConstraintBase::setLowerBound ( ConstRefVector  lb )

pure virtual

Implemented in tsid::math::ConstraintEquality, tsid::math::ConstraintInequality, and tsid::math::ConstraintBound.

setMatrix()

bool ConstraintBase::setMatrix ( ConstRefMatrix  A )

virtual

Definition at line 39 of file constraint-base.cpp.

setUpperBound()

virtual bool tsid::math::ConstraintBase::setUpperBound ( ConstRefVector  ub )

pure virtual

Implemented in tsid::math::ConstraintEquality, tsid::math::ConstraintInequality, and tsid::math::ConstraintBound.

setVector()

virtual bool tsid::math::ConstraintBase::setVector ( ConstRefVector  b )

pure virtual

Implemented in tsid::math::ConstraintEquality, tsid::math::ConstraintInequality, and tsid::math::ConstraintBound.

upperBound() [1/2]

virtual const Vector& tsid::math::ConstraintBase::upperBound ( ) const

pure virtual

Implemented in tsid::math::ConstraintEquality, tsid::math::ConstraintInequality, and tsid::math::ConstraintBound.

upperBound() [2/2]

virtual Vector& tsid::math::ConstraintBase::upperBound ( )

pure virtual

Implemented in tsid::math::ConstraintEquality, tsid::math::ConstraintInequality, and tsid::math::ConstraintBound.

vector() [1/2]

virtual const Vector& tsid::math::ConstraintBase::vector ( ) const

pure virtual

Implemented in tsid::math::ConstraintEquality, tsid::math::ConstraintInequality, and tsid::math::ConstraintBound.

vector() [2/2]

virtual Vector& tsid::math::ConstraintBase::vector ( )

pure virtual

Implemented in tsid::math::ConstraintEquality, tsid::math::ConstraintInequality, and tsid::math::ConstraintBound.

Member Data Documentation

m_A

Matrix tsid::math::ConstraintBase::m_A

protected

Definition at line 75 of file constraint-base.hpp.

m_name

std::string tsid::math::ConstraintBase::m_name

protected

Definition at line 74 of file constraint-base.hpp.

---

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

• constraint-base.hpp
• constraint-base.cpp