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 an old version of boost. Click here for the latest Boost documentation.
Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

Function template make_n_step_iterator_begin

boost::numeric::odeint::make_n_step_iterator_begin — Factory function for n_step_iterator. Constructs a begin iterator.

Synopsis

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


template<typename Stepper, typename System, typename State> 
  n_step_iterator< Stepper, System, State > 
  make_n_step_iterator_begin(Stepper stepper, System system, State & x, 
                             typename traits::time_type< Stepper >::type t, 
                             typename traits::time_type< Stepper >::type dt, 
                             size_t num_of_steps);

Description

Parameters:

dt

The initial time step.

num_of_steps

The number of steps to be executed.

stepper

The stepper to use during the iteration.

system

The system function (ODE) to solve.

t

The initial time.

x

The initial state. const_step_iterator stores a reference of s and changes its value during the iteration.

Returns:

The n-step iterator.


PrevUpHomeNext