Aikido
aikido::distance::REuclidean< N > Class Template Reference

Implements a Euclidean distance metric. More...

#include <aikido/distance/RnEuclidean.hpp>

Inheritance diagram for aikido::distance::REuclidean< N >:
aikido::distance::DistanceMetric

Public Member Functions

 REuclidean (std::shared_ptr< const statespace::R< N >> _space)
 Constructor. More...
 
statespace::ConstStateSpacePtr getStateSpace () const override
 Get the StateSpace associated with this metric. More...
 
double distance (const statespace::StateSpace::State *_state1, const statespace::StateSpace::State *_state2) const override
 Computes Euclidean distance between two states. More...
 
- Public Member Functions inherited from aikido::distance::DistanceMetric
virtual ~DistanceMetric ()=default
 Destructor. More...
 

Private Attributes

std::shared_ptr< const statespace::R< N > > mStateSpace
 

Detailed Description

template<int N>
class aikido::distance::REuclidean< N >

Implements a Euclidean distance metric.

Constructor & Destructor Documentation

◆ REuclidean()

template<int N>
aikido::distance::REuclidean< N >::REuclidean ( std::shared_ptr< const statespace::R< N >>  _space)
explicit

Constructor.

Parameters
_spaceThe Rn this metric operates on

Member Function Documentation

◆ distance()

template<int N>
double aikido::distance::REuclidean< N >::distance ( const statespace::StateSpace::State _state1,
const statespace::StateSpace::State _state2 
) const
overridevirtual

Computes Euclidean distance between two states.

Parameters
_state1The first state (type Rn::State)
_state2The second state (type Rn::State)

Implements aikido::distance::DistanceMetric.

◆ getStateSpace()

template<int N>
statespace::ConstStateSpacePtr aikido::distance::REuclidean< N >::getStateSpace ( ) const
overridevirtual

Get the StateSpace associated with this metric.

Implements aikido::distance::DistanceMetric.

Member Data Documentation

◆ mStateSpace

template<int N>
std::shared_ptr<const statespace::R<N> > aikido::distance::REuclidean< N >::mStateSpace
private