MIRA
Public Member Functions | List of all members
LinearInterpolatorExtrapolationLimit Class Reference

1D linear interpolator. More...

#include <math/LinearInterpolator.h>

Inheritance diagram for LinearInterpolatorExtrapolationLimit:
Inheritance graph
[legend]

Public Member Functions

 LinearInterpolatorExtrapolationLimit (double limit=1.0)
 
bool canExtrapolate () const
 
int samples () const
 
int samplesBefore () const
 
int samplesAfter () const
 
template<typename Tx , typename Ty , typename ContainerTx , typename ContainerTy >
Ty apply (const ContainerTx &x, const ContainerTy &y, const Tx &xx)
 

Detailed Description

1D linear interpolator.

This interpolator internally uses the lerp() method, and hence can be applied for all types that are supported by the lerp() method or implement their own lerp() method. Does support extrapolation with supplied limit. If alpha for lerp is < limit or > 1 + limit an exception is thrown. A limit of 0 means no extrapolation allowed. A limit of 1 means extrapolation about the same length of the sample interval is allowed, and so on...

Constructor & Destructor Documentation

◆ LinearInterpolatorExtrapolationLimit()

LinearInterpolatorExtrapolationLimit ( double  limit = 1.0)
inline

Member Function Documentation

◆ canExtrapolate()

bool canExtrapolate ( ) const
inline

◆ samples()

int samples ( ) const
inline

◆ samplesBefore()

int samplesBefore ( ) const
inline

◆ samplesAfter()

int samplesAfter ( ) const
inline

◆ apply()

Ty apply ( const ContainerTx &  x,
const ContainerTy &  y,
const Tx &  xx 
)
inline

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