TimeSeriesValueIterator< FP, IsConstIter > Class Template Reference

CPP API: mio::TimeSeriesValueIterator< FP, IsConstIter > Class Template Reference
mio::TimeSeriesValueIterator< FP, IsConstIter > Class Template Reference

Iterate over vector values of a time series by time point. More...

#include <time_series.h>

Inheritance diagram for mio::TimeSeriesValueIterator< FP, IsConstIter >:
Collaboration diagram for mio::TimeSeriesValueIterator< FP, IsConstIter >:

Public Types

using difference_type = typename Base::difference_type
 
using iterator_category = typename Base::iterator_category
 
using pointer = typename Base::pointer
 
using reference = typename Base::reference
 
using value_type = typename Base::value_type
 
- Public Types inherited from mio::details::TimeSeriesIteratorBase< TimeSeriesValueIterator< FP, IsConstIter >, FP, IsConstIter, details::TimeSeriesIterTraits< FP, IsConstIter >::VectorValue, details::TimeSeriesIterTraits< FP, IsConstIter >::VectorReference >
using difference_type = std::ptrdiff_t
 
using iterator_category = std::random_access_iterator_tag
 
using reference = details::TimeSeriesIterTraits< FP, IsConstIter >::VectorReference
 
using value_type = details::TimeSeriesIterTraits< FP, IsConstIter >::VectorValue
 

Public Member Functions

reference get_reference () const
 
- Public Member Functions inherited from mio::details::TimeSeriesIteratorBase< TimeSeriesValueIterator< FP, IsConstIter >, FP, IsConstIter, details::TimeSeriesIterTraits< FP, IsConstIter >::VectorValue, details::TimeSeriesIterTraits< FP, IsConstIter >::VectorReference >
bool operator!= (const TimeSeriesIteratorBase &other) const
 
reference operator* () const
 
TimeSeriesValueIterator< FP, IsConstIter > operator+ (difference_type i) const
 
TimeSeriesValueIterator< FP, IsConstIter > & operator++ ()
 
TimeSeriesValueIterator< FP, IsConstIter > operator++ (int)
 
TimeSeriesValueIterator< FP, IsConstIter > & operator+= (difference_type i)
 
difference_type operator- (const TimeSeriesIteratorBase &other) const
 
TimeSeriesValueIterator< FP, IsConstIter > operator- (difference_type i) const
 
TimeSeriesValueIterator< FP, IsConstIter > & operator-- ()
 
TimeSeriesValueIterator< FP, IsConstIter > operator-- (int)
 
TimeSeriesValueIterator< FP, IsConstIter > & 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)
 

Private Types

using Base = details::TimeSeriesIteratorBase< TimeSeriesValueIterator< FP, IsConstIter >, FP, IsConstIter, typename details::TimeSeriesIterTraits< FP, IsConstIter >::VectorValue, typename details::TimeSeriesIterTraits< FP, IsConstIter >::VectorReference >
 

Private Attributes

Eigen::Index m_col_idx
 
MatrixPtr m_matrix
 

Additional Inherited Members

- Protected Types inherited from mio::details::TimeSeriesIteratorBase< TimeSeriesValueIterator< FP, IsConstIter >, FP, IsConstIter, details::TimeSeriesIterTraits< FP, IsConstIter >::VectorValue, details::TimeSeriesIterTraits< FP, IsConstIter >::VectorReference >
using MatrixPtr = typename Traits::MatrixPtr
 
using Traits = details::TimeSeriesIterTraits< FP, IsConstIter >
 
- Protected Attributes inherited from mio::details::TimeSeriesIteratorBase< TimeSeriesValueIterator< FP, IsConstIter >, FP, IsConstIter, details::TimeSeriesIterTraits< FP, IsConstIter >::VectorValue, details::TimeSeriesIterTraits< FP, IsConstIter >::VectorReference >
Eigen::Index m_col_idx
 
MatrixPtr m_matrix
 

Detailed Description

template<class FP, bool IsConstIter>
class mio::TimeSeriesValueIterator< FP, IsConstIter >

Iterate over vector values of a time series by time point.

Member Typedef Documentation

◆ Base

template<class FP , bool IsConstIter>
using mio::TimeSeriesValueIterator< FP, IsConstIter >::Base = details::TimeSeriesIteratorBase<TimeSeriesValueIterator<FP, IsConstIter>, FP, IsConstIter, typename details::TimeSeriesIterTraits<FP, IsConstIter>::VectorValue, typename details::TimeSeriesIterTraits<FP, IsConstIter>::VectorReference>
private

◆ difference_type

template<class FP , bool IsConstIter>
using mio::TimeSeriesValueIterator< FP, IsConstIter >::difference_type = typename Base::difference_type

◆ iterator_category

template<class FP , bool IsConstIter>
using mio::TimeSeriesValueIterator< FP, IsConstIter >::iterator_category = typename Base::iterator_category

◆ pointer

template<class FP , bool IsConstIter>
using mio::TimeSeriesValueIterator< FP, IsConstIter >::pointer = typename Base::pointer

◆ reference

template<class FP , bool IsConstIter>
using mio::TimeSeriesValueIterator< FP, IsConstIter >::reference = typename Base::reference

◆ value_type

template<class FP , bool IsConstIter>
using mio::TimeSeriesValueIterator< FP, IsConstIter >::value_type = typename Base::value_type

Member Function Documentation

◆ get_reference()

template<class FP , bool IsConstIter>
reference mio::TimeSeriesValueIterator< FP, IsConstIter >::get_reference ( ) const
inline

Member Data Documentation

◆ m_col_idx

template<class FP , bool IsConstIter>
Eigen::Index mio::details::TimeSeriesIteratorBase< Derived, FP, IsConstIter, ValueType, ReferenceType >::m_col_idx
private

◆ m_matrix

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