Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

This is the documentation for a snapshot of the develop branch, built from commit 1aeed45f05.
Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

Class template times_time_iterator

boost::numeric::odeint::times_time_iterator — ODE Iterator with given evaluation points. The value type of this iterator is a std::pair containing state and time.

Synopsis

// In header: <boost/numeric/odeint/iterator/times_time_iterator.hpp>

template<typename Stepper, typename System, typename State, 
         typename TimeIterator> 
class times_time_iterator {
public:
  // construct/copy/destruct
  times_time_iterator(Stepper, System, State &, TimeIterator, TimeIterator, 
                      time_type);
  times_time_iterator(Stepper, System, State &);
};

Description

Implements an iterator representing the solution of an ODE from *t_start to *t_end evaluated at time points given by the sequence t_start to t_end. t_start and t_end are iterators representing a sequence of time points where the solution of the ODE should be evaluated. After each iteration the iterator dereferences to a pair with the state and the time at the next evaluation point *t_start++ until t_end is reached. This iterator can be used with Steppers, ControlledSteppers and DenseOutputSteppers and it always makes use of the all the given steppers capabilities. A for_each over such an iterator range behaves similar to the integrate_times routine.

times_time_iterator is a model of single-pass iterator.

The value type of this iterator is a pair of state and time type.

Template Parameters

  1. typename Stepper

    The stepper type which should be used during the iteration.

  2. typename System

    The type of the system function (ODE) which should be solved.

  3. typename State

    The state type of the ODE.

  4. typename TimeIterator

    The iterator type for the sequence of time points.

times_time_iterator public construct/copy/destruct

  1. times_time_iterator(Stepper stepper, System sys, State & s, 
                        TimeIterator t_start, TimeIterator t_end, time_type dt);
  2. times_time_iterator(Stepper stepper, System sys, State & s);

PrevUpHomeNext