hpp-constraints  4.9.1
Definition of basic geometric constraints for motion planning
hpp::constraints::ConfigurationConstraint Class Reference

Square distance between input configuration and reference configuration. More...

#include <hpp/constraints/configuration-constraint.hh>

Inheritance diagram for hpp::constraints::ConfigurationConstraint:
Collaboration diagram for hpp::constraints::ConfigurationConstraint:

Public Member Functions

virtual ~ConfigurationConstraint ()
 
 ConfigurationConstraint (const std::string &name, const DevicePtr_t &robot, ConfigurationIn_t goal, const vector_t &weights)
 
- Public Member Functions inherited from hpp::constraints::DifferentiableFunction
virtual ~DifferentiableFunction ()
 
LiegroupElement operator() (vectorIn_t argument) const
 
void value (LiegroupElementRef result, vectorIn_t argument) const
 
void jacobian (matrixOut_t jacobian, vectorIn_t argument) const
 
const ArrayXbactiveParameters () const
 
const ArrayXbactiveDerivativeParameters () const
 
size_type inputSize () const
 Get dimension of input vector. More...
 
size_type inputDerivativeSize () const
 
LiegroupSpacePtr_t outputSpace () const
 Get output space. More...
 
size_type outputSize () const
 Get dimension of output vector. More...
 
size_type outputDerivativeSize () const
 Get dimension of output derivative vector. More...
 
const std::string & name () const
 Get function name. More...
 
virtual std::ostream & print (std::ostream &o) const
 Display object in a stream. More...
 
std::string context () const
 
void context (const std::string &c)
 
void finiteDifferenceForward (matrixOut_t jacobian, vectorIn_t arg, DevicePtr_t robot=DevicePtr_t(), value_type eps=std::sqrt(Eigen::NumTraits< value_type >::epsilon())) const
 
void finiteDifferenceCentral (matrixOut_t jacobian, vectorIn_t arg, DevicePtr_t robot=DevicePtr_t(), value_type eps=std::sqrt(Eigen::NumTraits< value_type >::epsilon())) const
 

Static Public Member Functions

static EIGEN_MAKE_ALIGNED_OPERATOR_NEW ConfigurationConstraintPtr_t create (const std::string &name, const DevicePtr_t &robot, ConfigurationIn_t goal, std::vector< bool > mask=std::vector< bool >(0))
 Return a shared pointer to a new instance. More...
 
static ConfigurationConstraintPtr_t create (const std::string &name, const DevicePtr_t &robot, ConfigurationIn_t goal, const vector_t &weights)
 

Protected Member Functions

virtual void impl_compute (LiegroupElementRef result, ConfigurationIn_t argument) const
 
virtual void impl_jacobian (matrixOut_t jacobian, ConfigurationIn_t arg) const
 
- Protected Member Functions inherited from hpp::constraints::DifferentiableFunction
 DifferentiableFunction (size_type sizeInput, size_type sizeInputDerivative, size_type sizeOutput, std::string name=std::string())
 Concrete class constructor should call this constructor. More...
 
 DifferentiableFunction (size_type sizeInput, size_type sizeInputDerivative, const LiegroupSpacePtr_t &outputSpace, std::string name=std::string())
 Concrete class constructor should call this constructor. More...
 
virtual void impl_compute (LiegroupElementRef result, vectorIn_t argument) const =0
 User implementation of function evaluation. More...
 
virtual void impl_jacobian (matrixOut_t jacobian, vectorIn_t arg) const =0
 

Additional Inherited Members

- Protected Attributes inherited from hpp::constraints::DifferentiableFunction
size_type inputSize_
 Dimension of input vector. More...
 
size_type inputDerivativeSize_
 Dimension of input derivative. More...
 
LiegroupSpacePtr_t outputSpace_
 Dimension of output vector. More...
 
ArrayXb activeParameters_
 
ArrayXb activeDerivativeParameters_
 

Detailed Description

Square distance between input configuration and reference configuration.

Constructor & Destructor Documentation

◆ ~ConfigurationConstraint()

virtual hpp::constraints::ConfigurationConstraint::~ConfigurationConstraint ( )
inlinevirtual

◆ ConfigurationConstraint()

hpp::constraints::ConfigurationConstraint::ConfigurationConstraint ( const std::string &  name,
const DevicePtr_t robot,
ConfigurationIn_t  goal,
const vector_t weights 
)
Parameters
weightsvector of size robot->numberDof()

Member Function Documentation

◆ create() [1/2]

static EIGEN_MAKE_ALIGNED_OPERATOR_NEW ConfigurationConstraintPtr_t hpp::constraints::ConfigurationConstraint::create ( const std::string &  name,
const DevicePtr_t robot,
ConfigurationIn_t  goal,
std::vector< bool >  mask = std::vector< bool >(0) 
)
static

Return a shared pointer to a new instance.

◆ create() [2/2]

static ConfigurationConstraintPtr_t hpp::constraints::ConfigurationConstraint::create ( const std::string &  name,
const DevicePtr_t robot,
ConfigurationIn_t  goal,
const vector_t weights 
)
static

Return a shared pointer to a new instance

Parameters
weightsvector of size robot->numberDof()

◆ impl_compute()

virtual void hpp::constraints::ConfigurationConstraint::impl_compute ( LiegroupElementRef  result,
ConfigurationIn_t  argument 
) const
protectedvirtual

Compute value of error

Parameters
argumentconfiguration of the robot,
Return values
resulterror vector

◆ impl_jacobian()

virtual void hpp::constraints::ConfigurationConstraint::impl_jacobian ( matrixOut_t  jacobian,
ConfigurationIn_t  arg 
) const
protectedvirtual

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