Struct template heaviside_series

Boost C++ Libraries

Struct template heaviside_series

boost::time_series::heaviside_series — A Mutable_TimeSeries that has a discrete value in the range [start,inf) and zero elsewhere.

Synopsis

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

template<typename Value, typename Discretization, typename Offset> 
struct heaviside_series : public boost::time_series::time_series_facade< Derived, Storage, Discretization >
{
  // types
  typedef time_series_facade< heaviside_series< Value, Discretization, Offset >, storage::heaviside_array< Value, Offset, storage::constant_elements< Value > >, Discretization > base_type;

  // construct/copy/destruct
  heaviside_series();
  template<typename A1> heaviside_series(A1 const &);
  template<typename A1, typename A2, ... > 
    heaviside_series(A1 const &, A2 const &, ...);
};

Description

A Mutable_TimeSeries that has a discrete value in the range [start,inf) and zero elsewhere.

The named parameters for the constructor are, in order:

start, with a default of Offset(0)
value, with a default of Value(1)
discretization, with a default of Discretization(1)
zero, with a default of Value(0)

`heaviside_series` public construct/copy/destruct

```
heaviside_series();
```

template<typename A1> heaviside_series(A1 const & a1);

template<typename A1, typename A2, ... > 
  heaviside_series(A1 const & a1, A2 const & a2, ...);