humoto
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
humoto::constraints::BoundsLMixin< t_Base > Class Template Reference

Detailed Description

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

Mixin representing lower bound in an inequality constraint.

Template Parameters
t_BaseBase class: humoto::constraints::ConstraintsBase or humoto::TaskBase wrapped with other mixins.

Definition at line 207 of file constraints_mixins.h.

#include <constraints_mixins.h>

Inheritance diagram for humoto::constraints::BoundsLMixin< t_Base >:
Inheritance graph

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...
 

Protected Member Functions

 BoundsLMixin ()
 
 ~BoundsLMixin ()
 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_
 

Constructor & Destructor Documentation

◆ ~BoundsLMixin()

template<class t_Base>
humoto::constraints::BoundsLMixin< t_Base >::~BoundsLMixin ( )
inlineprotected

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

Definition at line 218 of file constraints_mixins.h.

◆ BoundsLMixin()

template<class t_Base>
humoto::constraints::BoundsLMixin< t_Base >::BoundsLMixin ( )
inlineprotected

Definition at line 219 of file constraints_mixins.h.

Member Function Documentation

◆ copyBoundsTo()

template<class t_Base>
void humoto::constraints::BoundsLMixin< 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]locationoffset and length

Reimplemented in humoto::constraints::BoundsLUMixin< TaskBase >.

Definition at line 267 of file constraints_mixins.h.

◆ getLowerBounds() [1/2]

template<class t_Base>
Eigen::VectorXd& humoto::constraints::BoundsLMixin< t_Base >::getLowerBounds ( )
inline

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]

template<class t_Base>
const Eigen::VectorXd& humoto::constraints::BoundsLMixin< t_Base >::getLowerBounds ( ) const
inline

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

Returns
lower bounds.

Definition at line 260 of file constraints_mixins.h.

◆ logBounds()

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

Log bounds.

Parameters
[in,out]loggerlogger
[in]parentparent
[in]namename

Reimplemented in humoto::constraints::BoundsLUMixin< TaskBase >, and humoto::constraints::BoundsLUMixin< ContainerBase >.

Definition at line 240 of file constraints_mixins.h.

◆ resetBounds()

template<class t_Base>
void humoto::constraints::BoundsLMixin< 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_constraintsnumber of constraints
[in]initialize_matricesinitialize matrices using defaults
Note
Initialization: lb is set to -humotog_infinity

Reimplemented in humoto::constraints::BoundsLUMixin< TaskBase >, and humoto::constraints::BoundsLUMixin< ContainerBase >.

Definition at line 226 of file constraints_mixins.h.

Member Data Documentation

◆ lb_

template<class t_Base>
Eigen::VectorXd humoto::constraints::BoundsLMixin< t_Base >::lb_
protected

Definition at line 210 of file constraints_mixins.h.


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