Struct template series_stl_iterator

Boost C++ Libraries

Struct template series_stl_iterator

boost::time_series::series_stl_iterator —

Synopsis

// In header: <boost/time_series/utility/series_stl_iterator.hpp>

template<typename Series> 
struct series_stl_iterator {
  // types
  typedef concepts::TimeSeries< Series > series_concept;
  typedef series_concept::value_type     value_type;    
  typedef series_concept::cursor         cursor_type;   
  typedef series_concept::offset_type    offset_type;   
  typedef series_concept::run_type       run_type;      
  typedef value_type const &             reference;     

  // construct/copy/destruct
  series_stl_iterator(Series &, cursor_type, offset_type);

  // private member functions
  void increment() ;
  bool equal(series_stl_iterator const &) const;
  reference dereference() const;
};

Description

An STL-compatible iterator over a range/run storage that makes it look like a continuous sequence

`series_stl_iterator` public construct/copy/destruct

series_stl_iterator(Series & series, cursor_type cursor, offset_type offset);

`series_stl_iterator` private member functions

```
void increment() ;
```

bool equal(series_stl_iterator const & that) const;

```
reference dereference() const;
```