• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>Function template make_n_step_iterator_end</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/n_step_iterator_hpp.html" title="Header &lt;boost/numeric/odeint/iterator/n_step_iterator.hpp&gt;">
9<link rel="prev" href="make_n_step_iterator_begin.html" title="Function template make_n_step_iterator_begin">
10<link rel="next" href="make_n_step_range.html" title="Function template make_n_step_range">
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="make_n_step_iterator_begin.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/numeric/odeint/iterator/n_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_n_step_range.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
24</div>
25<div class="refentry">
26<a name="boost.numeric.odeint.make_n_step_iterator_end"></a><div class="titlepage"></div>
27<div class="refnamediv">
28<h2><span class="refentrytitle">Function template make_n_step_iterator_end</span></h2>
29<p>boost::numeric::odeint::make_n_step_iterator_end — Factory function for <a class="link" href="n_step_iterator.html" title="Class template n_step_iterator">n_step_iterator</a>. Constructs an end iterator. </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/n_step_iterator_hpp.html" title="Header &lt;boost/numeric/odeint/iterator/n_step_iterator.hpp&gt;">boost/numeric/odeint/iterator/n_step_iterator.hpp</a>&gt;
33
34</span>
35<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>
36  <a class="link" href="n_step_iterator.html" title="Class template n_step_iterator">n_step_iterator</a><span class="special">&lt;</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">&gt;</span>
37  <span class="identifier">make_n_step_iterator_end</span><span class="special">(</span><span class="identifier">Stepper</span> stepper<span class="special">,</span> <span class="identifier">System</span> system<span class="special">,</span> <span class="identifier">State</span> <span class="special">&amp;</span> x<span class="special">)</span><span class="special">;</span></pre></div>
38<div class="refsect1">
39<a name="idm45600381361776"></a><h2>Description</h2>
40<p>
41
42</p>
43<div class="variablelist"><table border="0" class="variablelist compact">
44<colgroup>
45<col align="left" valign="top">
46<col>
47</colgroup>
48<tbody>
49<tr>
50<td><p><span class="term">Parameters:</span></p></td>
51<td><div class="variablelist"><table border="0" class="variablelist compact">
52<colgroup>
53<col align="left" valign="top">
54<col>
55</colgroup>
56<tbody>
57<tr>
58<td><p><span class="term"><code class="computeroutput">stepper</code></span></p></td>
59<td><p>The stepper to use during the iteration. </p></td>
60</tr>
61<tr>
62<td><p><span class="term"><code class="computeroutput">system</code></span></p></td>
63<td><p>The system function (ODE) to solve. </p></td>
64</tr>
65<tr>
66<td><p><span class="term"><code class="computeroutput">x</code></span></p></td>
67<td><p>The initial state. <code class="computeroutput"><a class="link" href="const_step_iterator.html" title="Class template const_step_iterator">const_step_iterator</a></code> stores a reference of s and changes its value during the iteration. </p></td>
68</tr>
69</tbody>
70</table></div></td>
71</tr>
72<tr>
73<td><p><span class="term">Returns:</span></p></td>
74<td><p>The <a class="link" href="const_step_iterator.html" title="Class template const_step_iterator">const_step_iterator</a>. </p></td>
75</tr>
76</tbody>
77</table></div>
78</div>
79</div>
80<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
81<td align="left"></td>
82<td align="right"><div class="copyright-footer">Copyright © 2009-2015 Karsten Ahnert and Mario Mulansky<p>
83        Distributed under the Boost Software License, Version 1.0. (See accompanying
84        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>)
85      </p>
86</div></td>
87</tr></table>
88<hr>
89<div class="spirit-nav">
90<a accesskey="p" href="make_n_step_iterator_begin.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/numeric/odeint/iterator/n_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_n_step_range.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
91</div>
92</body>
93</html>
94