Struct template clipped_series

Boost C++ Libraries

Struct template clipped_series

boost::time_series::clipped_series —

Synopsis

// In header: <boost/time_series/clipped_series.hpp>

template<typename Series> 
struct clipped_series :
  public boost::time_series::time_series_base< Derived >
{
  // types
  typedef Series                                                                               storage_type;       
  typedef concepts::TimeSeries< Series >                                                       series_concept;     
  typedef series_concept::value_type                                                           value_type;         
  typedef series_concept::cursor                                                               cursor;             
  typedef series_concept::elements                                                             elements;           
  typedef series_concept::runs                                                                 runs;               
  typedef series_concept::run_type                                                             run_type;           
  typedef series_concept::offset_type                                                          offset_type;        
  typedef series_concept::pre_run_type                                                         pre_run_type;       
  typedef series_concept::post_run_type                                                        post_run_type;      
  typedef series_concept::discretization_type                                                  discretization_type;
  typedef std::pair< offset_type, offset_type >                                                period_type;        
  typedef result_of< range_run_storage::op::get_at(storage_type &, offset_type &) >::type      get_at_type;        
  typedef mpl::if_< is_reference< get_at_type >, value_type const &, value_type const  >::type reference;          
  typedef series_stl_iterator< clipped_series< Series > const  >                               iterator;           
  typedef series_stl_iterator< clipped_series< Series > const  >                               const_iterator;     

  // construct/copy/destruct
  clipped_series(Series &, offset_type, offset_type);

  // public member functions
  discretization_type discretization() const;
  reference operator[](offset_type) const;
  iterator begin() const;
  iterator end() const;
  offset_type start() const;
  offset_type stop() const;
  storage_type & data() const;
  cursor sequence_begin() const;
  cursor sequence_end() const;

  // private static functions
  static std::pair< cursor, cursor > 
  equal_range(Series &, offset_type, offset_type) ;
};

Description

`clipped_series` public construct/copy/destruct

clipped_series(Series & series, offset_type start, offset_type stop);

`clipped_series` public member functions

discretization_type discretization() const;

reference operator[](offset_type n) const;

```
iterator begin() const;
```
```
iterator end() const;
```
```
offset_type start() const;
```
```
offset_type stop() const;
```
```
storage_type & data() const;
```
```
cursor sequence_begin() const;
```
```
cursor sequence_end() const;
```

`clipped_series` private static functions

static std::pair< cursor, cursor > 
equal_range(Series & series, offset_type start, offset_type stop) ;