Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

Function jump_offset

boost::time_series::jump_offset — Fetches the offset at which the heaviside series jumps from zero to non-zero.

Synopsis

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


template<typename Value, typename Discretization, typename Offset> 
  Offset jump_offset(heaviside_series< Value, Discretization, Offset > const & series);
template<typename Value, typename Discretization, typename Offset> 
  Offset jump_offset(heaviside_unit_series< Value, Discretization, Offset > const & series);

Description

Fetches the offset at which the heaviside series jumps from zero to non-zero.

Throws: Will not throw.

PrevUpHomeNext