Function coarse

Function coarse_grain

boost::time_series::coarse_grain — Generate a series of a coarser discretization by picking the values at the coarse-grained points.

Synopsis

// In header: <boost/time_series/numeric/coarse_grain.hpp>


template<typename Series, typename Discretization, typename Out> 
  ordered_inserter< Out > 
  coarse_grain(Series const & series, Discretization discretization, 
               ordered_inserter< Out > out);
template<typename Series, typename Discretization> 
  sparse_series< typename concepts::TimeSeries< Series const  >::value_type Discretization > 
  coarse_grain(Series const & series, Discretization discretization);

Description

Generate a series of a coarser discretization by picking the values at the coarse-grained points.

Parameters:

`discretization`	The coarser discretization.
`out`	An `OrderedInserter` into which to write the coarser series.
`series`	The input series.

Requires:

The coarser discretization is a multiple of the finer discretization.

Returns:

Either a sparse_series<> containing the coarser series, or a copy of the OrderedInserter passed in.

Notes:

If using the version that takes an OrderedInserter, you must call .commit() on the returned OrderedInserter when you are done with it.