libs/numeric/odeint/doc/html/boost/numeric/odeint/modified_midpo_idp61395968.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template modified_midpoint_dense_out</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&#160;1.&#160;Boost.Numeric.Odeint">
   8 <link rel="up" href="../../../header/boost/numeric/odeint/stepper/modified_midpoint_hpp.html" title="Header &lt;boost/numeric/odeint/stepper/modified_midpoint.hpp&gt;">
   9 <link rel="prev" href="modified_midpoint.html" title="Class template modified_midpoint">
  10 <link rel="next" href="../../../header/boost/numeric/odeint/stepper/rosenbrock4_hpp.html" title="Header &lt;boost/numeric/odeint/stepper/rosenbrock4.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="modified_midpoint.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/numeric/odeint/stepper/modified_midpoint_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/stepper/rosenbrock4_hpp.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.numeric.odeint.modified_midpo_idp61395968"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class template modified_midpoint_dense_out</span></h2>
  29 <p>boost::numeric::odeint::modified_midpoint_dense_out</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/stepper/modified_midpoint_hpp.html" title="Header &lt;boost/numeric/odeint/stepper/modified_midpoint.hpp&gt;">boost/numeric/odeint/stepper/modified_midpoint.hpp</a>&gt;
  33
  34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> State<span class="special">,</span> <span class="keyword">typename</span> Value <span class="special">=</span> <span class="keyword">double</span><span class="special">,</span> <span class="keyword">typename</span> Deriv <span class="special">=</span> <span class="identifier">State</span><span class="special">,</span>
  35          <span class="keyword">typename</span> Time <span class="special">=</span> <span class="identifier">Value</span><span class="special">,</span>
  36          <span class="keyword">typename</span> Algebra <span class="special">=</span> <span class="keyword">typename</span> <span class="identifier">algebra_dispatcher</span><span class="special">&lt;</span> <span class="identifier">State</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">algebra_type</span><span class="special">,</span>
  37          <span class="keyword">typename</span> Operations <span class="special">=</span> <span class="keyword">typename</span> <span class="identifier">operations_dispatcher</span><span class="special">&lt;</span> <span class="identifier">State</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">operations_type</span><span class="special">,</span>
  38          <span class="keyword">typename</span> Resizer <span class="special">=</span> <span class="identifier">initially_resizer</span><span class="special">&gt;</span>
  39 <span class="keyword">class</span> <a class="link" href="modified_midpo_idp61395968.html" title="Class template modified_midpoint_dense_out">modified_midpoint_dense_out</a> <span class="special">{</span>
  40 <span class="keyword">public</span><span class="special">:</span>
  41   <span class="comment">// types</span>
  42   <span class="keyword">typedef</span> <span class="identifier">State</span>                                                                                  <a name="boost.numeric.odeint.modified_midpo_idp61395968.state_type"></a><span class="identifier">state_type</span><span class="special">;</span>
  43   <span class="keyword">typedef</span> <span class="identifier">Value</span>                                                                                  <a name="boost.numeric.odeint.modified_midpo_idp61395968.value_type"></a><span class="identifier">value_type</span><span class="special">;</span>
  44   <span class="keyword">typedef</span> <span class="identifier">Deriv</span>                                                                                  <a name="boost.numeric.odeint.modified_midpo_idp61395968.deriv_type"></a><span class="identifier">deriv_type</span><span class="special">;</span>
  45   <span class="keyword">typedef</span> <span class="identifier">Time</span>                                                                                   <a name="boost.numeric.odeint.modified_midpo_idp61395968.time_type"></a><span class="identifier">time_type</span><span class="special">;</span>
  46   <span class="keyword">typedef</span> <span class="identifier">Algebra</span>                                                                                <a name="boost.numeric.odeint.modified_midpo_idp61395968.algebra_type"></a><span class="identifier">algebra_type</span><span class="special">;</span>
  47   <span class="keyword">typedef</span> <span class="identifier">Operations</span>                                                                             <a name="boost.numeric.odeint.modified_midpo_idp61395968.operations_type"></a><span class="identifier">operations_type</span><span class="special">;</span>
  48   <span class="keyword">typedef</span> <span class="identifier">Resizer</span>                                                                                <a name="boost.numeric.odeint.modified_midpo_idp61395968.resizer_type"></a><span class="identifier">resizer_type</span><span class="special">;</span>
  49   <span class="keyword">typedef</span> <span class="identifier">state_wrapper</span><span class="special">&lt;</span> <span class="identifier">state_type</span> <span class="special">&gt;</span>                                                            <a name="boost.numeric.odeint.modified_midpo_idp61395968.wrapped_state_type"></a><span class="identifier">wrapped_state_type</span><span class="special">;</span>
  50   <span class="keyword">typedef</span> <span class="identifier">state_wrapper</span><span class="special">&lt;</span> <span class="identifier">deriv_type</span> <span class="special">&gt;</span>                                                            <a name="boost.numeric.odeint.modified_midpo_idp61395968.wrapped_deriv_type"></a><span class="identifier">wrapped_deriv_type</span><span class="special">;</span>
  51   <span class="keyword">typedef</span> <a class="link" href="modified_midpo_idp61395968.html" title="Class template modified_midpoint_dense_out">modified_midpoint_dense_out</a><span class="special">&lt;</span> <span class="identifier">State</span><span class="special">,</span> <span class="identifier">Value</span><span class="special">,</span> <span class="identifier">Deriv</span><span class="special">,</span> <span class="identifier">Time</span><span class="special">,</span> <span class="identifier">Algebra</span><span class="special">,</span> <span class="identifier">Operations</span><span class="special">,</span> <span class="identifier">Resizer</span> <span class="special">&gt;</span> <a name="boost.numeric.odeint.modified_midpo_idp61395968.stepper_type"></a><span class="identifier">stepper_type</span><span class="special">;</span>
  52   <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">wrapped_deriv_type</span> <span class="special">&gt;</span>                                                      <a name="boost.numeric.odeint.modified_midpo_idp61395968.deriv_table_type"></a><span class="identifier">deriv_table_type</span><span class="special">;</span>
  53
  54   <span class="comment">// <a class="link" href="modified_midpo_idp61395968.html#boost.numeric.odeint.modified_midpo_idp61395968construct-copy-destruct">construct/copy/destruct</a></span>
  55   <a class="link" href="modified_midpo_idp61395968.html#idp61431072-bb"><span class="identifier">modified_midpoint_dense_out</span></a><span class="special">(</span><span class="keyword">unsigned</span> <span class="keyword">short</span> <span class="special">=</span> <span class="number">2</span><span class="special">,</span>
  56                               <span class="keyword">const</span> <span class="identifier">algebra_type</span> <span class="special">&amp;</span> <span class="special">=</span> <span class="identifier">algebra_type</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span>
  57
  58   <span class="comment">// <a class="link" href="modified_midpo_idp61395968.html#idp61413360-bb">public member functions</a></span>
  59   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> System<span class="special">,</span> <span class="keyword">typename</span> StateIn<span class="special">,</span> <span class="keyword">typename</span> DerivIn<span class="special">,</span>
  60            <span class="keyword">typename</span> StateOut<span class="special">&gt;</span>
  61     <span class="keyword">void</span> <a class="link" href="modified_midpo_idp61395968.html#idp61413920-bb"><span class="identifier">do_step</span></a><span class="special">(</span><span class="identifier">System</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">StateIn</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">DerivIn</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">time_type</span><span class="special">,</span>
  62                  <span class="identifier">StateOut</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">time_type</span><span class="special">,</span> <span class="identifier">state_type</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">deriv_table_type</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  63   <span class="keyword">void</span> <a class="link" href="modified_midpo_idp61395968.html#idp61422800-bb"><span class="identifier">set_steps</span></a><span class="special">(</span><span class="keyword">unsigned</span> <span class="keyword">short</span><span class="special">)</span><span class="special">;</span>
  64   <span class="keyword">unsigned</span> <span class="keyword">short</span> <a class="link" href="modified_midpo_idp61395968.html#idp61424336-bb"><span class="identifier">steps</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  65   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> StateIn<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="modified_midpo_idp61395968.html#idp61426144-bb"><span class="identifier">resize</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">StateIn</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  66   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> StateIn<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="modified_midpo_idp61395968.html#idp61428528-bb"><span class="identifier">adjust_size</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">StateIn</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  67 <span class="special">}</span><span class="special">;</span></pre></div>
  68 <div class="refsect1">
  69 <a name="idp97166752"></a><h2>Description</h2>
  70 <p>Implementation of the modified midpoint method with a configurable number of intermediate steps. This class is used by the dense output Bulirsch-Stoer algorithm and is not meant for direct usage. </p>
  71 <div class="note"><table border="0" summary="Note">
  72 <tr>
  73 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../../doc/src/images/note.png"></td>
  74 <th align="left">Note</th>
  75 </tr>
  76 <tr><td align="left" valign="top"><p>This stepper is for internal use only and does not meet any stepper concept. </p></td></tr>
  77 </table></div>
  78 <p>
  79 </p>
  80 <div class="refsect2">
  81 <a name="idp97168240"></a><h3>
  82 <a name="boost.numeric.odeint.modified_midpo_idp61395968construct-copy-destruct"></a><code class="computeroutput">modified_midpoint_dense_out</code>
  83         public
  84        construct/copy/destruct</h3>
  85 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idp61431072-bb"></a><span class="identifier">modified_midpoint_dense_out</span><span class="special">(</span><span class="keyword">unsigned</span> <span class="keyword">short</span> steps <span class="special">=</span> <span class="number">2</span><span class="special">,</span>
  86                             <span class="keyword">const</span> <span class="identifier">algebra_type</span> <span class="special">&amp;</span> algebra <span class="special">=</span> <span class="identifier">algebra_type</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div>
  87 </div>
  88 <div class="refsect2">
  89 <a name="idp97181936"></a><h3>
  90 <a name="idp61413360-bb"></a><code class="computeroutput">modified_midpoint_dense_out</code> public member functions</h3>
  91 <div class="orderedlist"><ol class="orderedlist" type="1">
  92 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> System<span class="special">,</span> <span class="keyword">typename</span> StateIn<span class="special">,</span> <span class="keyword">typename</span> DerivIn<span class="special">,</span>
  93          <span class="keyword">typename</span> StateOut<span class="special">&gt;</span>
  94   <span class="keyword">void</span> <a name="idp61413920-bb"></a><span class="identifier">do_step</span><span class="special">(</span><span class="identifier">System</span> system<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">StateIn</span> <span class="special">&amp;</span> in<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">DerivIn</span> <span class="special">&amp;</span> dxdt<span class="special">,</span>
  95                <span class="identifier">time_type</span> t<span class="special">,</span> <span class="identifier">StateOut</span> <span class="special">&amp;</span> out<span class="special">,</span> <span class="identifier">time_type</span> dt<span class="special">,</span> <span class="identifier">state_type</span> <span class="special">&amp;</span> x_mp<span class="special">,</span>
  96                <span class="identifier">deriv_table_type</span> <span class="special">&amp;</span> derivs<span class="special">)</span><span class="special">;</span></pre></li>
  97 <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idp61422800-bb"></a><span class="identifier">set_steps</span><span class="special">(</span><span class="keyword">unsigned</span> <span class="keyword">short</span> steps<span class="special">)</span><span class="special">;</span></pre></li>
  98 <li class="listitem"><pre class="literallayout"><span class="keyword">unsigned</span> <span class="keyword">short</span> <a name="idp61424336-bb"></a><span class="identifier">steps</span><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  99 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> StateIn<span class="special">&gt;</span> <span class="keyword">bool</span> <a name="idp61426144-bb"></a><span class="identifier">resize</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">StateIn</span> <span class="special">&amp;</span> x<span class="special">)</span><span class="special">;</span></pre></li>
 100 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> StateIn<span class="special">&gt;</span> <span class="keyword">void</span> <a name="idp61428528-bb"></a><span class="identifier">adjust_size</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">StateIn</span> <span class="special">&amp;</span> x<span class="special">)</span><span class="special">;</span></pre></li>
 101 </ol></div>
 102 </div>
 103 </div>
 104 </div>
 105 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 106 <td align="left"></td>
 107 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2015 Karsten Ahnert and Mario Mulansky<p>
 108         Distributed under the Boost Software License, Version 1.0. (See accompanying
 109         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>)
 110       </p>
 111 </div></td>
 112 </tr></table>
 113 <hr>
 114 <div class="spirit-nav">
 115 <a accesskey="p" href="modified_midpoint.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/numeric/odeint/stepper/modified_midpoint_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/stepper/rosenbrock4_hpp.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
 116 </div>
 117 </body>
 118 </html>