te::st::AbstractTimeSeriesInterp Class Referenceabstract

An abstract class for an interpolation function or interpolator that estimate a value at non-observaved times of a time series. More...

#include <AbstractTimeSeriesInterp.h>

Inheritance diagram for te::st::AbstractTimeSeriesInterp:
te::st::NearestValueAtTimeInterp

Public Member Functions

virtual std::unique_ptr< te::dt::AbstractDataestimate (const TimeSeries &ts, te::dt::DateTime *time) const =0
 It estimates a value at a given non-observed time of a time series. More...
 
virtual te::common::AbstractParametersgetParams ()=0
 It gets the parameters associated to the interpolator. More...
 
virtual void setParams (te::common::AbstractParameters *p)=0
 It sets the parameters associated to the interpolator. More...
 
virtual ~AbstractTimeSeriesInterp ()
 Virtual destructor. More...
 

Protected Member Functions

 AbstractTimeSeriesInterp ()
 Constructor. More...
 

Detailed Description

An abstract class for an interpolation function or interpolator that estimate a value at non-observaved times of a time series.

This is an abstract class for every class that implements interpolation functions that estimate value at non-observaved times of a time series.

See also
Time Series

Definition at line 62 of file AbstractTimeSeriesInterp.h.

Constructor & Destructor Documentation

◆ ~AbstractTimeSeriesInterp()

virtual te::st::AbstractTimeSeriesInterp::~AbstractTimeSeriesInterp ( )
virtual

Virtual destructor.

◆ AbstractTimeSeriesInterp()

te::st::AbstractTimeSeriesInterp::AbstractTimeSeriesInterp ( )
protected

Constructor.

Member Function Documentation

◆ estimate()

virtual std::unique_ptr<te::dt::AbstractData> te::st::AbstractTimeSeriesInterp::estimate ( const TimeSeries ts,
te::dt::DateTime time 
) const
pure virtual

It estimates a value at a given non-observed time of a time series.

Parameters
tsA time series used in the estimation.
timeThe given non-observed time.
Returns
The estimated value.
Note
It will NOT take the ownership of the given pointer.
The caller will take the ownership of the output pointer.

Implemented in te::st::NearestValueAtTimeInterp.

◆ getParams()

virtual te::common::AbstractParameters* te::st::AbstractTimeSeriesInterp::getParams ( )
pure virtual

It gets the parameters associated to the interpolator.

Returns
It returns the parameters associated to the interpolator.
Note
The caller will not take the ownership of the returned pointer.

Implemented in te::st::NearestValueAtTimeInterp.

◆ setParams()

virtual void te::st::AbstractTimeSeriesInterp::setParams ( te::common::AbstractParameters p)
pure virtual

It sets the parameters associated to the interpolator.

Parameters
pThe parameters to be associated to the interpolator.
Note
It will take the ownership of the given pointer.

Implemented in te::st::NearestValueAtTimeInterp.


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