• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>Class template const_step_iterator</title>
5<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
7<link rel="home" href="../../../index.html" title="Chapter 1. Boost.Numeric.Odeint">
8<link rel="up" href="../../../header/boost/numeric/odeint/iterator/const_step_iterator_hpp.html" title="Header &lt;boost/numeric/odeint/iterator/const_step_iterator.hpp&gt;">
9<link rel="prev" href="../../../header/boost/numeric/odeint/iterator/const_step_iterator_hpp.html" title="Header &lt;boost/numeric/odeint/iterator/const_step_iterator.hpp&gt;">
10<link rel="next" href="make_con_idm45875527913936.html" title="Function template make_const_step_iterator_begin">
11</head>
12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13<table cellpadding="2" width="100%"><tr>
14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../logo.jpg"></td>
15<td align="center"><a href="../../../../../../../../index.html">Home</a></td>
16<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td>
17<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
18<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
19<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td>
20</tr></table>
21<hr>
22<div class="spirit-nav">
23<a accesskey="p" href="../../../header/boost/numeric/odeint/iterator/const_step_iterator_hpp.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/numeric/odeint/iterator/const_step_iterator_hpp.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="make_con_idm45875527913936.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
24</div>
25<div class="refentry">
26<a name="boost.numeric.odeint.const_step_iterator"></a><div class="titlepage"></div>
27<div class="refnamediv">
28<h2><span class="refentrytitle">Class template const_step_iterator</span></h2>
29<p>boost::numeric::odeint::const_step_iterator — ODE Iterator with constant step size. The value type of this iterator is the state type of the stepper. </p>
30</div>
31<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
32<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../../header/boost/numeric/odeint/iterator/const_step_iterator_hpp.html" title="Header &lt;boost/numeric/odeint/iterator/const_step_iterator.hpp&gt;">boost/numeric/odeint/iterator/const_step_iterator.hpp</a>&gt;
33
34</span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Stepper<span class="special">,</span> <span class="keyword">typename</span> System<span class="special">,</span> <span class="keyword">typename</span> State<span class="special">&gt;</span>
35<span class="keyword">class</span> <a class="link" href="const_step_iterator.html" title="Class template const_step_iterator">const_step_iterator</a> <span class="special">{</span>
36<span class="keyword">public</span><span class="special">:</span>
37  <span class="comment">// <a class="link" href="const_step_iterator.html#boost.numeric.odeint.const_step_iteratorconstruct-copy-destruct">construct/copy/destruct</a></span>
38  <a class="link" href="const_step_iterator.html#idm45875527920896-bb"><span class="identifier">const_step_iterator</span></a><span class="special">(</span><span class="identifier">Stepper</span><span class="special">,</span> <span class="identifier">System</span><span class="special">,</span> <span class="identifier">State</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">time_type</span><span class="special">,</span> <span class="identifier">time_type</span><span class="special">,</span>
39                      <span class="identifier">time_type</span><span class="special">)</span><span class="special">;</span>
40  <a class="link" href="const_step_iterator.html#idm45875527916480-bb"><span class="identifier">const_step_iterator</span></a><span class="special">(</span><span class="identifier">Stepper</span><span class="special">,</span> <span class="identifier">System</span><span class="special">,</span> <span class="identifier">State</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
41<span class="special">}</span><span class="special">;</span></pre></div>
42<div class="refsect1">
43<a name="idm45600382101920"></a><h2>Description</h2>
44<p>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.</p>
45<p><a class="link" href="const_step_iterator.html" title="Class template const_step_iterator">const_step_iterator</a> is a model of single-pass iterator.</p>
46<p>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.</p>
47<p>
48</p>
49<div class="refsect2">
50<a name="idm45600382099040"></a><h3>Template Parameters</h3>
51<div class="orderedlist"><ol class="orderedlist" type="1">
52<li class="listitem">
53<pre class="literallayout"><span class="keyword">typename</span> Stepper</pre>
54<p>The stepper type which should be used during the iteration. </p>
55</li>
56<li class="listitem">
57<pre class="literallayout"><span class="keyword">typename</span> System</pre>
58<p>The type of the system function (ODE) which should be solved. </p>
59</li>
60<li class="listitem">
61<pre class="literallayout"><span class="keyword">typename</span> State</pre>
62<p>The state type of the ODE. </p>
63</li>
64</ol></div>
65</div>
66<div class="refsect2">
67<a name="idm45600382091728"></a><h3>
68<a name="boost.numeric.odeint.const_step_iteratorconstruct-copy-destruct"></a><code class="computeroutput">const_step_iterator</code>
69        public
70       construct/copy/destruct</h3>
71<div class="orderedlist"><ol class="orderedlist" type="1">
72<li class="listitem"><pre class="literallayout"><a name="idm45875527920896-bb"></a><span class="identifier">const_step_iterator</span><span class="special">(</span><span class="identifier">Stepper</span> stepper<span class="special">,</span> <span class="identifier">System</span> sys<span class="special">,</span> <span class="identifier">State</span> <span class="special">&amp;</span> s<span class="special">,</span> <span class="identifier">time_type</span> t_start<span class="special">,</span>
73                    <span class="identifier">time_type</span> t_end<span class="special">,</span> <span class="identifier">time_type</span> dt<span class="special">)</span><span class="special">;</span></pre></li>
74<li class="listitem"><pre class="literallayout"><a name="idm45875527916480-bb"></a><span class="identifier">const_step_iterator</span><span class="special">(</span><span class="identifier">Stepper</span> stepper<span class="special">,</span> <span class="identifier">System</span> sys<span class="special">,</span> <span class="identifier">State</span> <span class="special">&amp;</span> s<span class="special">)</span><span class="special">;</span></pre></li>
75</ol></div>
76</div>
77</div>
78</div>
79<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
80<td align="left"></td>
81<td align="right"><div class="copyright-footer">Copyright © 2009-2015 Karsten Ahnert and Mario Mulansky<p>
82        Distributed under the Boost Software License, Version 1.0. (See accompanying
83        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
84      </p>
85</div></td>
86</tr></table>
87<hr>
88<div class="spirit-nav">
89<a accesskey="p" href="../../../header/boost/numeric/odeint/iterator/const_step_iterator_hpp.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/numeric/odeint/iterator/const_step_iterator_hpp.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="make_con_idm45875527913936.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
90</div>
91</body>
92</html>
93