hermite  0.0.1
Public Member Functions | List of all members
hermite::BaseInterpol< D > Class Template Referenceabstract

Base class for interpolation functions. More...

#include <base_interpol.hpp>

Inheritance diagram for hermite::BaseInterpol< D >:
Inheritance graph
[legend]

Public Member Functions

virtual ~BaseInterpol ()=default
 Destructor.
 
virtual Vector< D > operator() (const double t) const
 Gets value of the interpolation function at a certain point. More...
 
virtual Vector< D > getPos (const double t) const =0
 Gets value of the interpolation function at a certain point. More...
 
virtual Vector< D > getVel (const double t) const =0
 Gets derivative of the function at a certain point. More...
 
virtual Vector< D > getAcc (const double t) const =0
 Gets second derivative of the function at a certain point. More...
 

Detailed Description

template<std::size_t D>
class hermite::BaseInterpol< D >

Base class for interpolation functions.

In the class, you must specify the number of dimensions that you want to interpolate. For example, if you want to calculate a 2D position over time, then speficy "2" in the template.

Member Function Documentation

◆ getAcc()

template<std::size_t D>
virtual Vector<D> hermite::BaseInterpol< D >::getAcc ( const double  t) const
pure virtual

Gets second derivative of the function at a certain point.

This will usually be the acceleration.

Parameters
tInput to get value from
Returns
Output from function's second derivative

Implemented in hermite::HermiteUnit< D >, hermite::HermiteSub< D >, hermite::Hermite< D >, hermite::Cubic< D >, and hermite::BaseSpline< D >.

◆ getPos()

template<std::size_t D>
virtual Vector<D> hermite::BaseInterpol< D >::getPos ( const double  t) const
pure virtual

Gets value of the interpolation function at a certain point.

Same as calling operator()()

Parameters
tInput to get value from
Returns
Output from function

Implemented in hermite::HermiteUnit< D >, hermite::HermiteSub< D >, hermite::Hermite< D >, hermite::Cubic< D >, and hermite::BaseSpline< D >.

◆ getVel()

template<std::size_t D>
virtual Vector<D> hermite::BaseInterpol< D >::getVel ( const double  t) const
pure virtual

Gets derivative of the function at a certain point.

This will usually be the velocity.

Parameters
tInput to get value from
Returns
Output from function's derivative

Implemented in hermite::HermiteUnit< D >, hermite::HermiteSub< D >, hermite::Hermite< D >, hermite::Cubic< D >, and hermite::BaseSpline< D >.

◆ operator()()

template<std::size_t D>
virtual Vector<D> hermite::BaseInterpol< D >::operator() ( const double  t) const
inlinevirtual

Gets value of the interpolation function at a certain point.

Same as calling getPos()

Parameters
tInput to get value from
Returns
Output from function

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