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::const_step_iterator< Stepper, System, State, StepperTag > Class Template Reference

ODE Iterator with constant step size. More...

#include <const_step_iterator.hpp>

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

Public Member Functions

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

Detailed Description

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

ODE Iterator with constant step size.

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 steps with constant step size dt. After each iteration the iterator dereferences to the state x at the next time t+dt. This iterator can be used with Steppers 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_const routine.

const_step_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.

Constructor & Destructor Documentation

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

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