faif
Public Types | Public Member Functions | Public Attributes | List of all members
faif::timeseries::TimeSeriesDigit Class Reference

#include <TimeSeries.hpp>

Inheritance diagram for faif::timeseries::TimeSeriesDigit:
Inheritance graph
Collaboration diagram for faif::timeseries::TimeSeriesDigit:
Collaboration graph

Public Types

typedef std::vector< TimeValueDigit >::iterator iterator
 
typedef std::vector< TimeValueDigit >::const_iterator const_iterator
 

Public Member Functions

 TimeSeriesDigit ()
 c-tor, empty timeseries More...
 
 TimeSeriesDigit (const TimeValueDigit *begin, const TimeValueDigit *end)
 c-tor, from range More...
 
 TimeSeriesDigit (const_iterator begin, const_iterator end)
 c-tor, from range More...
 
 TimeSeriesDigit (const Value *begin, const Value *end)
 , c-tor from C style table of values. The timestamps are 0,1,..,n More...
 
 TimeSeriesDigit (const TimeSeriesDigit &t)
 copy c-tor More...
 
 TimeSeriesDigit (const TimeSeriesDigit &ts, const DigitTime &offset)
 c-tor from timeseries, the timestamps are modified, the offset is added More...
 
TimeSeriesDigitoperator= (const TimeSeriesDigit &t)
 
TimeSeriesDigit autoCorrelationE (int scope) const
 
double getSum () const
 
double getSumSquared () const
 
double getAvg () const
 
double getSigmaSquared () const
 
double getSigma () const
 

Public Attributes

elements
 STL member. More...
 

Detailed Description

the timeseries (collection), time as DigitTime

Constructor & Destructor Documentation

faif::timeseries::TimeSeriesDigit::TimeSeriesDigit ( )
inline

c-tor, empty timeseries

faif::timeseries::TimeSeriesDigit::TimeSeriesDigit ( const TimeValueDigit begin,
const TimeValueDigit end 
)
inline

c-tor, from range

faif::timeseries::TimeSeriesDigit::TimeSeriesDigit ( const_iterator  begin,
const_iterator  end 
)
inline

c-tor, from range

faif::timeseries::TimeSeriesDigit::TimeSeriesDigit ( const Value begin,
const Value end 
)
inline

, c-tor from C style table of values. The timestamps are 0,1,..,n

faif::timeseries::TimeSeriesDigit::TimeSeriesDigit ( const TimeSeriesDigit t)
inline

copy c-tor

faif::timeseries::TimeSeriesDigit::TimeSeriesDigit ( const TimeSeriesDigit ts,
const DigitTime offset 
)
inline

c-tor from timeseries, the timestamps are modified, the offset is added

Member Function Documentation

TimeSeriesDigit& faif::timeseries::TimeSeriesDigit::operator= ( const TimeSeriesDigit t)
inline

operator =

TimeSeriesDigit faif::timeseries::TimeSeriesDigit::autoCorrelationE ( int  scope) const
inline

the autocorelation of timeseries. The average is not substracted. out(0) = sum(i=0, i<n) in(i)*in(i) out(1) = sum(i=0, i<n-1) in(i)*in(i+1) out(2) = sum(i=0, i<n-2) in(i)*in(i+2) ...

double faif::timeseries::TimeSeriesDigit::getSum ( ) const
inline

the sum of values of timeseries

References faif::timeseries::TimeValueDigit::getValue().

double faif::timeseries::TimeSeriesDigit::getSumSquared ( ) const
inline

the sum of square of values of timeseries

References faif::timeseries::TimeValueDigit::getValue().

double faif::timeseries::TimeSeriesDigit::getAvg ( ) const
inline

the average of values of timeseries or 0.0 if the timeseries is empty

Referenced by faif::timeseries::correlation().

double faif::timeseries::TimeSeriesDigit::getSigmaSquared ( ) const
inline

the square of variation

double faif::timeseries::TimeSeriesDigit::getSigma ( ) const
inline

the variation (slower calculation)

Referenced by faif::timeseries::correlation().

Member Data Documentation

T std::vector< T >::elements
inherited

STL member.


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