hpp-core  4.9.0
Implement basic classes for canonical path planning for kinematic chains.
hpp::core::Distance Class Referenceabstract

Abstract class for distance between configurations. More...

#include <hpp/core/distance.hh>

Inheritance diagram for hpp::core::Distance:

Public Member Functions

value_type operator() (ConfigurationIn_t q1, ConfigurationIn_t q2) const
 
value_type operator() (NodePtr_t n1, NodePtr_t n2) const
 
value_type compute (ConfigurationIn_t q1, ConfigurationIn_t q2) const
 
value_type compute (NodePtr_t n1, NodePtr_t n2) const
 
virtual DistancePtr_t clone () const =0
 
virtual ~Distance ()
 

Protected Member Functions

 Distance ()
 
virtual value_type impl_distance (ConfigurationIn_t q1, ConfigurationIn_t q2) const =0
 Derived class should implement this function. More...
 
virtual value_type impl_distance (NodePtr_t n1, NodePtr_t n2) const
 

Detailed Description

Abstract class for distance between configurations.

Constructor & Destructor Documentation

◆ ~Distance()

virtual hpp::core::Distance::~Distance ( )
inlinevirtual

◆ Distance()

hpp::core::Distance::Distance ( )
inlineprotected

Member Function Documentation

◆ clone()

virtual DistancePtr_t hpp::core::Distance::clone ( ) const
pure virtual

◆ compute() [1/2]

value_type hpp::core::Distance::compute ( ConfigurationIn_t  q1,
ConfigurationIn_t  q2 
) const
inline

◆ compute() [2/2]

value_type hpp::core::Distance::compute ( NodePtr_t  n1,
NodePtr_t  n2 
) const
inline

◆ impl_distance() [1/2]

virtual value_type hpp::core::Distance::impl_distance ( ConfigurationIn_t  q1,
ConfigurationIn_t  q2 
) const
protectedpure virtual

Derived class should implement this function.

Implemented in hpp::core::WeighedDistance, hpp::core::KinodynamicDistance, and hpp::core::distance::ReedsShepp.

◆ impl_distance() [2/2]

virtual value_type hpp::core::Distance::impl_distance ( NodePtr_t  n1,
NodePtr_t  n2 
) const
inlineprotectedvirtual

◆ operator()() [1/2]

value_type hpp::core::Distance::operator() ( ConfigurationIn_t  q1,
ConfigurationIn_t  q2 
) const
inline

◆ operator()() [2/2]

value_type hpp::core::Distance::operator() ( NodePtr_t  n1,
NodePtr_t  n2 
) const
inline

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