controlpp::TimeSeries< T > Class Template Reference

Contiains time and values pairs. More...

#include <controlpp/TimeSeries.hpp>

Public Member Functions
	TimeSeries ()=default
	TimeSeries (int size)
	Initialises an empty (= uninitialised) timeseries with a given allocation size (number of value-time pairs)
	TimeSeries (const Eigen::Vector< T, Eigen::Dynamic > &t, const Eigen::Vector< T, Eigen::Dynamic > &v)
	TimeSeries (Eigen::Vector< T, Eigen::Dynamic > &&t, Eigen::Vector< T, Eigen::Dynamic > &&v)
	TimeSeries (const Eigen::Vector< T, Eigen::Dynamic > &t, Eigen::Vector< T, Eigen::Dynamic > &&v)
	TimeSeries (Eigen::Vector< T, Eigen::Dynamic > &&t, const Eigen::Vector< T, Eigen::Dynamic > &v)
Eigen::Vector< T, Eigen::Dynamic > &	times ()
const Eigen::Vector< T, Eigen::Dynamic > &	times () const
T &	times (size_t i)
const T &	times (size_t i) const
Eigen::Vector< T, Eigen::Dynamic > &	values ()
const Eigen::Vector< T, Eigen::Dynamic > &	values () const
T &	values (size_t i)
const T &	values (size_t i) const
	TimeSeries (const TimeSeries &)=default
	Default copy constructor.
	TimeSeries (TimeSeries &&)=default
	Default move constructor.
TimeSeries &	operator= (const TimeSeries &)=default
	Default copy assignment.
TimeSeries &	operator= (TimeSeries &&)=default
	Default move assignment.
void	resize (int n)
size_t	size () const

Detailed Description

template<class T>
class controlpp::TimeSeries< T >

Contiains time and values pairs.

Overload that for the case with runtime size using N=Eigen::Dynamic as a template parameter (=default). Offers constructors to set the size of the vectors.

Stores two Eigen vectors: .times and .values that store the time series and are puplicly accessible.

Template Parameters

T	The datatype used for the times and values vectors
N	The size of the timeseries. Can be a static size or Eigen::Dynamic to determine the size at runtime.

Constructor & Destructor Documentation

TimeSeries() [1/8]

template<class T >

controlpp::TimeSeries< T >::TimeSeries ( )

default

TimeSeries() [2/8]

template<class T >

controlpp::TimeSeries< T >::TimeSeries ( int  size )

inline

Initialises an empty (= uninitialised) timeseries with a given allocation size (number of value-time pairs)

Only allocates the storage. You have to fill the storage yourself

Parameters

size	The number of value time pairs that this timeseries holds

See also

resize(size_t)

TimeSeries() [3/8]

template<class T >

controlpp::TimeSeries< T >::TimeSeries ( const Eigen::Vector< T, Eigen::Dynamic > &  t, const Eigen::Vector< T, Eigen::Dynamic > &  v  )

inline

Parameters

t	Time vector (Needs to be ordered ascending)
v	Value vector

TimeSeries() [4/8]

template<class T >

controlpp::TimeSeries< T >::TimeSeries ( Eigen::Vector< T, Eigen::Dynamic > &&  t, Eigen::Vector< T, Eigen::Dynamic > &&  v  )

inline

Parameters

t	Time vector (Needs to be ordered ascending)
v	Value vector

TimeSeries() [5/8]

template<class T >

controlpp::TimeSeries< T >::TimeSeries ( const Eigen::Vector< T, Eigen::Dynamic > &  t, Eigen::Vector< T, Eigen::Dynamic > &&  v  )

inline

TimeSeries() [6/8]

template<class T >

controlpp::TimeSeries< T >::TimeSeries ( Eigen::Vector< T, Eigen::Dynamic > &&  t, const Eigen::Vector< T, Eigen::Dynamic > &  v  )

inline

TimeSeries() [7/8]

template<class T >

controlpp::TimeSeries< T >::TimeSeries ( const TimeSeries< T > &  )

default

Default copy constructor.

TimeSeries() [8/8]

template<class T >

controlpp::TimeSeries< T >::TimeSeries ( TimeSeries< T > &&  )

default

Default move constructor.

Member Function Documentation

operator=() [1/2]

template<class T >

TimeSeries & controlpp::TimeSeries< T >::operator= ( const TimeSeries< T > &  )

default

Default copy assignment.

operator=() [2/2]

template<class T >

TimeSeries & controlpp::TimeSeries< T >::operator= ( TimeSeries< T > &&  )

default

Default move assignment.

resize()

template<class T >

void controlpp::TimeSeries< T >::resize ( int  n )

inline

size()

template<class T >

size_t controlpp::TimeSeries< T >::size ( ) const

inline

times() [1/4]

template<class T >

Eigen::Vector< T, Eigen::Dynamic > & controlpp::TimeSeries< T >::times ( )

inline

times() [2/4]

template<class T >

const Eigen::Vector< T, Eigen::Dynamic > & controlpp::TimeSeries< T >::times ( ) const

inline

times() [3/4]

template<class T >

T & controlpp::TimeSeries< T >::times ( size_t  i )

inline

times() [4/4]

template<class T >

const T & controlpp::TimeSeries< T >::times ( size_t  i ) const

inline

values() [1/4]

template<class T >

Eigen::Vector< T, Eigen::Dynamic > & controlpp::TimeSeries< T >::values ( )

inline

values() [2/4]

template<class T >

const Eigen::Vector< T, Eigen::Dynamic > & controlpp::TimeSeries< T >::values ( ) const

inline

values() [3/4]

template<class T >

T & controlpp::TimeSeries< T >::values ( size_t  i )

inline

values() [4/4]

template<class T >

const T & controlpp::TimeSeries< T >::values ( size_t  i ) const

inline

---

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

• include/controlpp/TimeSeries.hpp