• 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_time_range</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_time_iterator_hpp.html" title="Header &lt;boost/numeric/odeint/iterator/n_step_time_iterator.hpp&gt;">
9<link rel="prev" href="make_n_s_idm45875527741248.html" title="Function template make_n_step_time_iterator_end">
10<link rel="next" href="../../../header/boost/numeric/odeint/iterator/times_iterator_hpp.html" title="Header &lt;boost/numeric/odeint/iterator/times_iterator.hpp&gt;">
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_s_idm45875527741248.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/numeric/odeint/iterator/n_step_time_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="../../../header/boost/numeric/odeint/iterator/times_iterator_hpp.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_time_range"></a><div class="titlepage"></div>
27<div class="refnamediv">
28<h2><span class="refentrytitle">Function template make_n_step_time_range</span></h2>
29<p>boost::numeric::odeint::make_n_step_time_range — Factory function to construct a single pass range of n-step iterators. A range is here a pair of <a class="link" href="n_step_time_iterator.html" title="Class template n_step_time_iterator">n_step_time_iterator</a>. </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_time_iterator_hpp.html" title="Header &lt;boost/numeric/odeint/iterator/n_step_time_iterator.hpp&gt;">boost/numeric/odeint/iterator/n_step_time_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  <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special">&lt;</span> <a class="link" href="n_step_time_iterator.html" title="Class template n_step_time_iterator">n_step_time_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><span class="special">,</span> <a class="link" href="n_step_time_iterator.html" title="Class template n_step_time_iterator">n_step_time_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> <span class="special">&gt;</span>
37  <span class="identifier">make_n_step_time_range</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>
38                         <span class="keyword">typename</span> <span class="identifier">traits</span><span class="special">::</span><span class="identifier">time_type</span><span class="special">&lt;</span> <span class="identifier">Stepper</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> t<span class="special">,</span>
39                         <span class="keyword">typename</span> <span class="identifier">traits</span><span class="special">::</span><span class="identifier">time_type</span><span class="special">&lt;</span> <span class="identifier">Stepper</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> dt<span class="special">,</span>
40                         <span class="identifier">size_t</span> num_of_steps<span class="special">)</span><span class="special">;</span></pre></div>
41<div class="refsect1">
42<a name="idm45600381003248"></a><h2>Description</h2>
43<p>
44
45</p>
46<div class="variablelist"><table border="0" class="variablelist compact">
47<colgroup>
48<col align="left" valign="top">
49<col>
50</colgroup>
51<tbody>
52<tr>
53<td><p><span class="term">Parameters:</span></p></td>
54<td><div class="variablelist"><table border="0" class="variablelist compact">
55<colgroup>
56<col align="left" valign="top">
57<col>
58</colgroup>
59<tbody>
60<tr>
61<td><p><span class="term"><code class="computeroutput">dt</code></span></p></td>
62<td><p>The initial time step. </p></td>
63</tr>
64<tr>
65<td><p><span class="term"><code class="computeroutput">num_of_steps</code></span></p></td>
66<td><p>The number of steps to be executed. </p></td>
67</tr>
68<tr>
69<td><p><span class="term"><code class="computeroutput">stepper</code></span></p></td>
70<td><p>The stepper to use during the iteration. </p></td>
71</tr>
72<tr>
73<td><p><span class="term"><code class="computeroutput">system</code></span></p></td>
74<td><p>The system function (ODE) to solve. </p></td>
75</tr>
76<tr>
77<td><p><span class="term"><code class="computeroutput">t</code></span></p></td>
78<td><p>The initial time. </p></td>
79</tr>
80<tr>
81<td><p><span class="term"><code class="computeroutput">x</code></span></p></td>
82<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> store a reference of s and changes its value during the iteration. </p></td>
83</tr>
84</tbody>
85</table></div></td>
86</tr>
87<tr>
88<td><p><span class="term">Returns:</span></p></td>
89<td><p>The n-step range. </p></td>
90</tr>
91</tbody>
92</table></div>
93</div>
94</div>
95<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
96<td align="left"></td>
97<td align="right"><div class="copyright-footer">Copyright © 2009-2015 Karsten Ahnert and Mario Mulansky<p>
98        Distributed under the Boost Software License, Version 1.0. (See accompanying
99        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>)
100      </p>
101</div></td>
102</tr></table>
103<hr>
104<div class="spirit-nav">
105<a accesskey="p" href="make_n_s_idm45875527741248.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/numeric/odeint/iterator/n_step_time_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="../../../header/boost/numeric/odeint/iterator/times_iterator_hpp.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
106</div>
107</body>
108</html>
109