Boost  v1.57.0
doxygen for www.boost.org
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
boost::numeric::odeint::times_iterator< Stepper, System, State, TimeIterator, StepperTag > Class Template Reference

ODE Iterator with given evaluation points. More...

#include <times_iterator.hpp>

Inheritance diagram for boost::numeric::odeint::times_iterator< Stepper, System, State, TimeIterator, StepperTag >:
Collaboration diagram for boost::numeric::odeint::times_iterator< Stepper, System, State, TimeIterator, StepperTag >:

Public Member Functions

 times_iterator (Stepper stepper, System sys, State &s, TimeIterator t_start, TimeIterator t_end, time_type dt)
 
 times_iterator (Stepper stepper, System sys, State &s)
 

Detailed Description

template<class Stepper, class System, class State, class TimeIterator, class StepperTag = typename base_tag< typename traits::stepper_category< Stepper >::type >::type>
class boost::numeric::odeint::times_iterator< Stepper, System, State, TimeIterator, StepperTag >

ODE Iterator with given evaluation points.

The value type of this iterator is the state type of the stepper.

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 the state x at the next time *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_iterator is a model of single-pass iterator.

The value type of this iterator is the state type of the stepper. Hence one can only access the state and not the current time.

Template Parameters
StepperThe stepper type which should be used during the iteration.
SystemThe type of the system function (ODE) which should be solved.
StateThe state type of the ODE.
TimeIteratorThe iterator type for the sequence of time points.

Constructor & Destructor Documentation

template<class Stepper, class System, class State, class TimeIterator, class StepperTag = typename base_tag< typename traits::stepper_category< Stepper >::type >::type>
boost::numeric::odeint::times_iterator< Stepper, System, State, TimeIterator, StepperTag >::times_iterator ( Stepper  stepper,
System  sys,
State &  s,
TimeIterator  t_start,
TimeIterator  t_end,
time_type  dt 
)
inline
template<class Stepper, class System, class State, class TimeIterator, class StepperTag = typename base_tag< typename traits::stepper_category< Stepper >::type >::type>
boost::numeric::odeint::times_iterator< Stepper, System, State, TimeIterator, StepperTag >::times_iterator ( Stepper  stepper,
System  sys,
State &  s 
)
inline

The documentation for this class was generated from the following file: