TimeSeriesIteratorBase< Derived, FP, IsConstIter, ValueType, ReferenceType > Class Template Reference

CPP API: mio::details::TimeSeriesIteratorBase< Derived, FP, IsConstIter, ValueType, ReferenceType > Class Template Reference

CPP API

base class for TimeSeries iterators that iterate by time point (i.e. More...

#include <time_series.h>

Classes
struct	pointer
	Dereferencable type with a copy of a reference. More...

Public Types
using	difference_type = std::ptrdiff_t

using	iterator_category = std::random_access_iterator_tag

using	reference = ReferenceType

using	value_type = ValueType

Public Member Functions
bool	operator!= (const TimeSeriesIteratorBase &other) const

reference	operator* () const

Derived	operator+ (difference_type i) const

Derived &	operator++ ()

Derived	operator++ (int)

Derived &	operator+= (difference_type i)

difference_type	operator- (const TimeSeriesIteratorBase &other) const

Derived	operator- (difference_type i) const

Derived &	operator-- ()

Derived	operator-- (int)

Derived &	operator-= (difference_type i)

pointer	operator-> () const

bool	operator< (const TimeSeriesIteratorBase &other) const

bool	operator<= (const TimeSeriesIteratorBase &other) const

bool	operator== (const TimeSeriesIteratorBase &other) const

bool	operator> (const TimeSeriesIteratorBase &other) const

bool	operator>= (const TimeSeriesIteratorBase &other) const

reference	operator[] (difference_type i) const

	TimeSeriesIteratorBase ()=default

	TimeSeriesIteratorBase (MatrixPtr m, Eigen::Index col_idx=0)

Protected Types
using	MatrixPtr = typename Traits::MatrixPtr

using	Traits = details::TimeSeriesIterTraits< FP, IsConstIter >

Protected Attributes
Eigen::Index	m_col_idx = -1

MatrixPtr	m_matrix

Friends
Derived	operator+ (difference_type i, const TimeSeriesIteratorBase &b)

Detailed Description

template<class Derived, class FP, bool IsConstIter, class ValueType, class ReferenceType>
class mio::details::TimeSeriesIteratorBase< Derived, FP, IsConstIter, ValueType, ReferenceType >

base class for TimeSeries iterators that iterate by time point (i.e.

column)

Template Parameters

Derived	Iterator derived type, provides get_reference member function
FP	floating point type of the TimeSeries
IsConstIter	true for const_iterator
ValueType	define iterator::value_type
ReferenceType	define iterator::reference, must be the same type as returned by Derived::get_reference

Member Typedef Documentation

◆ difference_type

template<class Derived , class FP , bool IsConstIter, class ValueType , class ReferenceType >

using mio::details::TimeSeriesIteratorBase< Derived, FP, IsConstIter, ValueType, ReferenceType >::difference_type = std::ptrdiff_t

◆ iterator_category

template<class Derived , class FP , bool IsConstIter, class ValueType , class ReferenceType >

using mio::details::TimeSeriesIteratorBase< Derived, FP, IsConstIter, ValueType, ReferenceType >::iterator_category = std::random_access_iterator_tag

◆ MatrixPtr

template<class Derived , class FP , bool IsConstIter, class ValueType , class ReferenceType >

using mio::details::TimeSeriesIteratorBase< Derived, FP, IsConstIter, ValueType, ReferenceType >::MatrixPtr = typename Traits::MatrixPtr

protected

◆ reference

template<class Derived , class FP , bool IsConstIter, class ValueType , class ReferenceType >

using mio::details::TimeSeriesIteratorBase< Derived, FP, IsConstIter, ValueType, ReferenceType >::reference = ReferenceType

◆ Traits

template<class Derived , class FP , bool IsConstIter, class ValueType , class ReferenceType >

using mio::details::TimeSeriesIteratorBase< Derived, FP, IsConstIter, ValueType, ReferenceType >::Traits = details::TimeSeriesIterTraits<FP, IsConstIter>

protected

◆ value_type

template<class Derived , class FP , bool IsConstIter, class ValueType , class ReferenceType >

using mio::details::TimeSeriesIteratorBase< Derived, FP, IsConstIter, ValueType, ReferenceType >::value_type = ValueType

Constructor & Destructor Documentation

◆ TimeSeriesIteratorBase() [1/2]

template<class Derived , class FP , bool IsConstIter, class ValueType , class ReferenceType >

mio::details::TimeSeriesIteratorBase< Derived, FP, IsConstIter, ValueType, ReferenceType >::TimeSeriesIteratorBase ( )

default

◆ TimeSeriesIteratorBase() [2/2]

template<class Derived , class FP , bool IsConstIter, class ValueType , class ReferenceType >

mio::details::TimeSeriesIteratorBase< Derived, FP, IsConstIter, ValueType, ReferenceType >::TimeSeriesIteratorBase	(	MatrixPtr	m,
		Eigen::Index	col_idx = `0`
	)

inline

Member Function Documentation

◆ operator!=()

template<class Derived , class FP , bool IsConstIter, class ValueType , class ReferenceType >

bool mio::details::TimeSeriesIteratorBase< Derived, FP, IsConstIter, ValueType, ReferenceType >::operator!= ( const TimeSeriesIteratorBase< Derived, FP, IsConstIter, ValueType, ReferenceType > & other ) const

inline

◆ operator*()

template<class Derived , class FP , bool IsConstIter, class ValueType , class ReferenceType >

reference mio::details::TimeSeriesIteratorBase< Derived, FP, IsConstIter, ValueType, ReferenceType >::operator* ( ) const

inline

◆ operator+()

template<class Derived , class FP , bool IsConstIter, class ValueType , class ReferenceType >

Derived mio::details::TimeSeriesIteratorBase< Derived, FP, IsConstIter, ValueType, ReferenceType >::operator+ ( difference_type i ) const

inline

◆ operator++() [1/2]

template<class Derived , class FP , bool IsConstIter, class ValueType , class ReferenceType >

Derived& mio::details::TimeSeriesIteratorBase< Derived, FP, IsConstIter, ValueType, ReferenceType >::operator++ ( )

inline

◆ operator++() [2/2]

template<class Derived , class FP , bool IsConstIter, class ValueType , class ReferenceType >

Derived mio::details::TimeSeriesIteratorBase< Derived, FP, IsConstIter, ValueType, ReferenceType >::operator++ ( int )

inline

◆ operator+=()

template<class Derived , class FP , bool IsConstIter, class ValueType , class ReferenceType >

Derived& mio::details::TimeSeriesIteratorBase< Derived, FP, IsConstIter, ValueType, ReferenceType >::operator+= ( difference_type i )

inline

◆ operator-() [1/2]

template<class Derived , class FP , bool IsConstIter, class ValueType , class ReferenceType >

difference_type mio::details::TimeSeriesIteratorBase< Derived, FP, IsConstIter, ValueType, ReferenceType >::operator- ( const TimeSeriesIteratorBase< Derived, FP, IsConstIter, ValueType, ReferenceType > & other ) const

inline

◆ operator-() [2/2]

template<class Derived , class FP , bool IsConstIter, class ValueType , class ReferenceType >

Derived mio::details::TimeSeriesIteratorBase< Derived, FP, IsConstIter, ValueType, ReferenceType >::operator- ( difference_type i ) const

inline

◆ operator--() [1/2]

template<class Derived , class FP , bool IsConstIter, class ValueType , class ReferenceType >

Derived& mio::details::TimeSeriesIteratorBase< Derived, FP, IsConstIter, ValueType, ReferenceType >::operator-- ( )

inline

◆ operator--() [2/2]

template<class Derived , class FP , bool IsConstIter, class ValueType , class ReferenceType >

Derived mio::details::TimeSeriesIteratorBase< Derived, FP, IsConstIter, ValueType, ReferenceType >::operator-- ( int )

inline

◆ operator-=()

template<class Derived , class FP , bool IsConstIter, class ValueType , class ReferenceType >

Derived& mio::details::TimeSeriesIteratorBase< Derived, FP, IsConstIter, ValueType, ReferenceType >::operator-= ( difference_type i )

inline

◆ operator->()

template<class Derived , class FP , bool IsConstIter, class ValueType , class ReferenceType >

pointer mio::details::TimeSeriesIteratorBase< Derived, FP, IsConstIter, ValueType, ReferenceType >::operator-> ( ) const

inline

◆ operator<()

template<class Derived , class FP , bool IsConstIter, class ValueType , class ReferenceType >

bool mio::details::TimeSeriesIteratorBase< Derived, FP, IsConstIter, ValueType, ReferenceType >::operator< ( const TimeSeriesIteratorBase< Derived, FP, IsConstIter, ValueType, ReferenceType > & other ) const

inline

◆ operator<=()

template<class Derived , class FP , bool IsConstIter, class ValueType , class ReferenceType >

bool mio::details::TimeSeriesIteratorBase< Derived, FP, IsConstIter, ValueType, ReferenceType >::operator<= ( const TimeSeriesIteratorBase< Derived, FP, IsConstIter, ValueType, ReferenceType > & other ) const

inline

◆ operator==()

template<class Derived , class FP , bool IsConstIter, class ValueType , class ReferenceType >

bool mio::details::TimeSeriesIteratorBase< Derived, FP, IsConstIter, ValueType, ReferenceType >::operator== ( const TimeSeriesIteratorBase< Derived, FP, IsConstIter, ValueType, ReferenceType > & other ) const

inline

◆ operator>()

template<class Derived , class FP , bool IsConstIter, class ValueType , class ReferenceType >

bool mio::details::TimeSeriesIteratorBase< Derived, FP, IsConstIter, ValueType, ReferenceType >::operator> ( const TimeSeriesIteratorBase< Derived, FP, IsConstIter, ValueType, ReferenceType > & other ) const

inline

◆ operator>=()

template<class Derived , class FP , bool IsConstIter, class ValueType , class ReferenceType >

bool mio::details::TimeSeriesIteratorBase< Derived, FP, IsConstIter, ValueType, ReferenceType >::operator>= ( const TimeSeriesIteratorBase< Derived, FP, IsConstIter, ValueType, ReferenceType > & other ) const

inline

◆ operator[]()

template<class Derived , class FP , bool IsConstIter, class ValueType , class ReferenceType >

reference mio::details::TimeSeriesIteratorBase< Derived, FP, IsConstIter, ValueType, ReferenceType >::operator[] ( difference_type i ) const

inline

Friends And Related Function Documentation

◆ operator+

template<class Derived , class FP , bool IsConstIter, class ValueType , class ReferenceType >

Derived operator+	(	difference_type	i,
		const TimeSeriesIteratorBase< Derived, FP, IsConstIter, ValueType, ReferenceType > &	b
	)

friend

Member Data Documentation

◆ m_col_idx

template<class Derived , class FP , bool IsConstIter, class ValueType , class ReferenceType >

Eigen::Index mio::details::TimeSeriesIteratorBase< Derived, FP, IsConstIter, ValueType, ReferenceType >::m_col_idx = -1

protected

◆ m_matrix

template<class Derived , class FP , bool IsConstIter, class ValueType , class ReferenceType >

MatrixPtr mio::details::TimeSeriesIteratorBase< Derived, FP, IsConstIter, ValueType, ReferenceType >::m_matrix

protected