humoto::constraints::BoundsLUMixin< t_Base > Class Template Reference

Detailed Description

template<class t_Base>
class humoto::constraints::BoundsLUMixin< t_Base >

Mixin representing upper bound in an inequality constraint.

Template Parameters

t_Base

Base class: humoto::constraints::ConstraintsBase or humoto::TaskBase wrapped with other mixins.

Definition at line 365 of file constraints_mixins.h.

#include <constraints_mixins.h>

Inheritance diagram for humoto::constraints::BoundsLUMixin< t_Base >:

Public Member Functions
void	copyBoundsTo (Eigen::VectorXd &lb, Eigen::VectorXd &ub, const Location &location) const
	Copy bounds to given vectors. More...
Eigen::VectorXd &	getLowerBounds ()
	Get lower bounds (lb/ub vectors from 'lb <= A*x <= ub'). More...
const Eigen::VectorXd &	getLowerBounds () const
	Get lower bounds (lb/ub vectors from 'lb <= A*x <= ub'). More...
Eigen::VectorXd &	getUpperBounds ()
	Get upper bounds (ub vectors from 'A*x <= ub'). More...
const Eigen::VectorXd &	getUpperBounds () const
	Get upper bounds (ub vectors from 'A*x <= ub'). More...

Protected Member Functions
	BoundsLUMixin ()
	~BoundsLUMixin ()
	Protected destructor: prevent destruction of the child classes through a base pointer. More...
void	logBounds (humoto::Logger &logger, const LogEntryName &parent=LogEntryName(), const std::string &name="constraints") const
	Log bounds. More...
void	resetBounds (const std::size_t number_of_constraints, const bool initialize_matrices=false)
	Reset bounds of constraints (b, lb, ub) More...

Protected Attributes
Eigen::VectorXd	lb_
Eigen::VectorXd	ub_

Constructor & Destructor Documentation

~BoundsLUMixin()

template<class t_Base>

humoto::constraints::BoundsLUMixin< t_Base >::~BoundsLUMixin ( )

inlineprotected

Protected destructor: prevent destruction of the child classes through a base pointer.

Definition at line 372 of file constraints_mixins.h.

BoundsLUMixin()

template<class t_Base>

humoto::constraints::BoundsLUMixin< t_Base >::BoundsLUMixin ( )

inlineprotected

Definition at line 373 of file constraints_mixins.h.

Member Function Documentation

copyBoundsTo()

template<class t_Base>

void humoto::constraints::BoundsLUMixin< t_Base >::copyBoundsTo ( Eigen::VectorXd &  lb, Eigen::VectorXd &  ub, const Location &  location  ) const

inline

Copy bounds to given vectors.

Parameters

[in]	lb
[in]	ub
[in]	location	offset and length

Definition at line 401 of file constraints_mixins.h.

getLowerBounds() [1/2]

Eigen::VectorXd& humoto::constraints::BoundsLMixin< BoundsUMixin< t_Base > >::getLowerBounds ( )

inlineinherited

Get lower bounds (lb/ub vectors from 'lb <= A*x <= ub').

Returns

lower bounds.

Definition at line 254 of file constraints_mixins.h.

getLowerBounds() [2/2]

const Eigen::VectorXd& humoto::constraints::BoundsLMixin< BoundsUMixin< t_Base > >::getLowerBounds ( ) const

inlineinherited

Get lower bounds (lb/ub vectors from 'lb <= A*x <= ub').

Returns

lower bounds.

Definition at line 260 of file constraints_mixins.h.

getUpperBounds() [1/2]

template<class t_Base>

Eigen::VectorXd& humoto::constraints::BoundsUMixin< t_Base >::getUpperBounds ( )

inlineinherited

Get upper bounds (ub vectors from 'A*x <= ub').

Returns

upper bounds.

Definition at line 333 of file constraints_mixins.h.

getUpperBounds() [2/2]

template<class t_Base>

const Eigen::VectorXd& humoto::constraints::BoundsUMixin< t_Base >::getUpperBounds ( ) const

inlineinherited

Get upper bounds (ub vectors from 'A*x <= ub').

Returns

upper bounds.

Definition at line 340 of file constraints_mixins.h.

logBounds()

template<class t_Base>

void humoto::constraints::BoundsLUMixin< t_Base >::logBounds ( humoto::Logger &  logger, const LogEntryName &  parent = LogEntryName(), const std::string &  name = "constraints"  ) const

inlineprotected

Log bounds.

Parameters

[in,out]	logger	logger
[in]	parent	parent
[in]	name	name

Definition at line 388 of file constraints_mixins.h.

resetBounds()

template<class t_Base>

void humoto::constraints::BoundsLUMixin< t_Base >::resetBounds ( const std::size_t  number_of_constraints, const bool  initialize_matrices = false  )

inlineprotected

Reset bounds of constraints (b, lb, ub)

Parameters

[in]	number_of_constraints	number of constraints
[in]	initialize_matrices	initialize matrices using defaults

Note

Initialization: lb is set to -humotog_infinity, ub is set to humoto::g_infinity

Definition at line 380 of file constraints_mixins.h.

Member Data Documentation

lb_

Eigen::VectorXd humoto::constraints::BoundsLMixin< BoundsUMixin< t_Base > >::lb_

protectedinherited

Definition at line 210 of file constraints_mixins.h.

ub_

template<class t_Base>

Eigen::VectorXd humoto::constraints::BoundsUMixin< t_Base >::ub_

protectedinherited

Definition at line 288 of file constraints_mixins.h.

---

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

• core/include/humoto/constraints_mixins.h