hpp::core::Equation Class Referenceabstract

This class represents an equation with the following format $ f(q) = \textbf{or} \le rhs $. More...

#include <hpp/core/equation.hh>

Inheritance diagram for hpp::core::Equation:

Public Member Functions

virtual void rightHandSideFromConfig (ConfigurationIn_t config)=0
 Set the right hand side from a configuration. More...
 
void rightHandSide (vectorIn_t rhs)
 Set the right hand side of the equation. More...
 
vectorIn_t rightHandSide () const
 Return the right hand side of the equation. More...
 
size_type rhsSize () const
 Return the size of the right hand side constraint. More...
 
const ComparisonTypePtr_tcomparisonType () const
 Return the ComparisonType. More...
 

Protected Member Functions

 Equation (const ComparisonTypePtr_t &comp, vectorIn_t rhs)
 
vectorOut_t nonConstRightHandSide ()
 Return the right hand side of the equation. More...
 

Detailed Description

This class represents an equation with the following format $ f(q) = \textbf{or} \le rhs $.

Constructor & Destructor Documentation

◆ Equation()

hpp::core::Equation::Equation ( const ComparisonTypePtr_t comp,
vectorIn_t  rhs 
)
protected

Member Function Documentation

◆ comparisonType()

const ComparisonTypePtr_t& hpp::core::Equation::comparisonType ( ) const

Return the ComparisonType.

◆ nonConstRightHandSide()

vectorOut_t hpp::core::Equation::nonConstRightHandSide ( )
protected

Return the right hand side of the equation.

◆ rhsSize()

size_type hpp::core::Equation::rhsSize ( ) const

Return the size of the right hand side constraint.

◆ rightHandSide() [1/2]

void hpp::core::Equation::rightHandSide ( vectorIn_t  rhs)

Set the right hand side of the equation.

Parameters
rhsthe right hand side.

◆ rightHandSide() [2/2]

vectorIn_t hpp::core::Equation::rightHandSide ( ) const

Return the right hand side of the equation.

◆ rightHandSideFromConfig()

virtual void hpp::core::Equation::rightHandSideFromConfig ( ConfigurationIn_t  config)
pure virtual

Set the right hand side from a configuration.

in such a way that the configuration satisfies the numerical constraints

Parameters
configthe input configuration.
Warning
Only values of the right hand side corresponding to "equality constraints" are set. As a result, the input configuration may not satisfy the other constraints. The rationale is the following. Equality constraints define a foliation of the configuration space. Leaves of the foliation are defined by the value of the right hand side of the equality constraints. This method is mainly used in manipulation planning to retrieve the leaf a configuration lies on.

Implemented in hpp::core::LockedJoint, and hpp::core::NumericalConstraint.