added details section for iterators in the docs

This commit is contained in:
Karsten Ahnert 2012-08-11 09:39:02 +02:00
parent eb77949dbe
commit a7a71eea75
2 changed files with 22 additions and 0 deletions

View File

@ -6,6 +6,8 @@
[include details_integrate_functions.qbk]
[include details_iterators.qbk]
[include details_state_types_algebras_operations.qbk]
[include details_boost_ref.qbk]

View File

@ -0,0 +1,20 @@
[section ODE Iterators]
odeint supports iterators for iterating throught an ordinary differential equation. They offer you an alternative to the integrate functions. Furthermore, many of the standard algorithms in the C++ standard library and Boost.Range can be used with the odeint't iterators.
[warning odeint's iterators do not satisfy the iterator concepts defined in the standard completely. In detail the iterator transitivity is violated in some rare cases. But this is not relevant for all algorithms in the C++ standard library and in Boost.Range.]
odeint provides for four new iterators.
const step iterator, factory functions
const step time iterator, factory functions
adaptive iterator, factory functions
adaptive time iterator, factory functions
[endsect]