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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template rosenbrock4_dense_output</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/rosenbrock4_dense_output_hpp.html" title="Header &lt;boost/numeric/odeint/stepper/rosenbrock4_dense_output.hpp&gt;">
   9 <link rel="prev" href="../../../header/boost/numeric/odeint/stepper/rosenbrock4_dense_output_hpp.html" title="Header &lt;boost/numeric/odeint/stepper/rosenbrock4_dense_output.hpp&gt;">
  10 <link rel="next" href="../../../header/boost/numeric/odeint/stepper/runge_kutta4_hpp.html" title="Header &lt;boost/numeric/odeint/stepper/runge_kutta4.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="../../../header/boost/numeric/odeint/stepper/rosenbrock4_dense_output_hpp.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/numeric/odeint/stepper/rosenbrock4_dense_output_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/runge_kutta4_hpp.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.numeric.odeint.rosenbrock4_dense_output"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class template rosenbrock4_dense_output</span></h2>
  29 <p>boost::numeric::odeint::rosenbrock4_dense_output</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/rosenbrock4_dense_output_hpp.html" title="Header &lt;boost/numeric/odeint/stepper/rosenbrock4_dense_output.hpp&gt;">boost/numeric/odeint/stepper/rosenbrock4_dense_output.hpp</a>&gt;
  33
  34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ControlledStepper<span class="special">&gt;</span>
  35 <span class="keyword">class</span> <a class="link" href="rosenbrock4_dense_output.html" title="Class template rosenbrock4_dense_output">rosenbrock4_dense_output</a> <span class="special">{</span>
  36 <span class="keyword">public</span><span class="special">:</span>
  37   <span class="comment">// types</span>
  38   <span class="keyword">typedef</span> <span class="identifier">ControlledStepper</span>                                 <a name="boost.numeric.odeint.rosenbrock4_dense_output.controlled_stepper_type"></a><span class="identifier">controlled_stepper_type</span><span class="special">;</span>
  39   <span class="keyword">typedef</span> <span class="identifier">unwrap_reference</span><span class="special">&lt;</span> <span class="identifier">controlled_stepper_type</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> <a name="boost.numeric.odeint.rosenbrock4_dense_output.unwrappe_idm45853738930048"></a><span class="identifier">unwrapped_controlled_stepper_type</span><span class="special">;</span>
  40   <span class="keyword">typedef</span> <span class="identifier">unwrapped_controlled_stepper_type</span><span class="special">::</span><span class="identifier">stepper_type</span>   <a name="boost.numeric.odeint.rosenbrock4_dense_output.stepper_type"></a><span class="identifier">stepper_type</span><span class="special">;</span>
  41   <span class="keyword">typedef</span> <span class="identifier">stepper_type</span><span class="special">::</span><span class="identifier">value_type</span>                          <a name="boost.numeric.odeint.rosenbrock4_dense_output.value_type"></a><span class="identifier">value_type</span><span class="special">;</span>
  42   <span class="keyword">typedef</span> <span class="identifier">stepper_type</span><span class="special">::</span><span class="identifier">state_type</span>                          <a name="boost.numeric.odeint.rosenbrock4_dense_output.state_type"></a><span class="identifier">state_type</span><span class="special">;</span>
  43   <span class="keyword">typedef</span> <span class="identifier">stepper_type</span><span class="special">::</span><span class="identifier">wrapped_state_type</span>                  <a name="boost.numeric.odeint.rosenbrock4_dense_output.wrapped_state_type"></a><span class="identifier">wrapped_state_type</span><span class="special">;</span>
  44   <span class="keyword">typedef</span> <span class="identifier">stepper_type</span><span class="special">::</span><span class="identifier">time_type</span>                           <a name="boost.numeric.odeint.rosenbrock4_dense_output.time_type"></a><span class="identifier">time_type</span><span class="special">;</span>
  45   <span class="keyword">typedef</span> <span class="identifier">stepper_type</span><span class="special">::</span><span class="identifier">deriv_type</span>                          <a name="boost.numeric.odeint.rosenbrock4_dense_output.deriv_type"></a><span class="identifier">deriv_type</span><span class="special">;</span>
  46   <span class="keyword">typedef</span> <span class="identifier">stepper_type</span><span class="special">::</span><span class="identifier">wrapped_deriv_type</span>                  <a name="boost.numeric.odeint.rosenbrock4_dense_output.wrapped_deriv_type"></a><span class="identifier">wrapped_deriv_type</span><span class="special">;</span>
  47   <span class="keyword">typedef</span> <span class="identifier">stepper_type</span><span class="special">::</span><span class="identifier">resizer_type</span>                        <a name="boost.numeric.odeint.rosenbrock4_dense_output.resizer_type"></a><span class="identifier">resizer_type</span><span class="special">;</span>
  48   <span class="keyword">typedef</span> <span class="identifier">dense_output_stepper_tag</span>                          <a name="boost.numeric.odeint.rosenbrock4_dense_output.stepper_category"></a><span class="identifier">stepper_category</span><span class="special">;</span>
  49   <span class="keyword">typedef</span> <span class="identifier">rosenbrock4_dense_output</span><span class="special">&lt;</span> <span class="identifier">ControlledStepper</span> <span class="special">&gt;</span>     <a name="boost.numeric.odeint.rosenbrock4_dense_output.dense_output_stepper_type"></a><span class="identifier">dense_output_stepper_type</span><span class="special">;</span>
  50
  51   <span class="comment">// <a class="link" href="rosenbrock4_dense_output.html#boost.numeric.odeint.rosenbrock4_dense_outputconstruct-copy-destruct">construct/copy/destruct</a></span>
  52   <a class="link" href="rosenbrock4_dense_output.html#idm45853738896032-bb"><span class="identifier">rosenbrock4_dense_output</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">controlled_stepper_type</span> <span class="special">&amp;</span> <span class="special">=</span> <span class="identifier">controlled_stepper_type</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span>
  53
  54   <span class="comment">// <a class="link" href="rosenbrock4_dense_output.html#idm45853738920480-bb">public member functions</a></span>
  55   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> StateType<span class="special">&gt;</span>
  56     <span class="keyword">void</span> <a class="link" href="rosenbrock4_dense_output.html#idm45853738919920-bb"><span class="identifier">initialize</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">StateType</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><span class="special">;</span>
  57   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> System<span class="special">&gt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special">&lt;</span> <span class="identifier">time_type</span><span class="special">,</span> <span class="identifier">time_type</span> <span class="special">&gt;</span> <a class="link" href="rosenbrock4_dense_output.html#idm45853738916160-bb"><span class="identifier">do_step</span></a><span class="special">(</span><span class="identifier">System</span><span class="special">)</span><span class="special">;</span>
  58   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> StateOut<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="rosenbrock4_dense_output.html#idm45853738913760-bb"><span class="identifier">calc_state</span></a><span class="special">(</span><span class="identifier">time_type</span><span class="special">,</span> <span class="identifier">StateOut</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  59   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> StateOut<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="rosenbrock4_dense_output.html#idm45853738910688-bb"><span class="identifier">calc_state</span></a><span class="special">(</span><span class="identifier">time_type</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">StateOut</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  60   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> StateType<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="rosenbrock4_dense_output.html#idm45853738907616-bb"><span class="identifier">adjust_size</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">StateType</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  61   <span class="keyword">const</span> <span class="identifier">state_type</span> <span class="special">&amp;</span> <a class="link" href="rosenbrock4_dense_output.html#idm45853738905232-bb"><span class="identifier">current_state</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  62   <span class="identifier">time_type</span> <a class="link" href="rosenbrock4_dense_output.html#idm45853738903424-bb"><span class="identifier">current_time</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  63   <span class="keyword">const</span> <span class="identifier">state_type</span> <span class="special">&amp;</span> <a class="link" href="rosenbrock4_dense_output.html#idm45853738901616-bb"><span class="identifier">previous_state</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  64   <span class="identifier">time_type</span> <a class="link" href="rosenbrock4_dense_output.html#idm45853738899808-bb"><span class="identifier">previous_time</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="identifier">time_type</span> <a class="link" href="rosenbrock4_dense_output.html#idm45853738898000-bb"><span class="identifier">current_time_step</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  66
  67   <span class="comment">// <a class="link" href="rosenbrock4_dense_output.html#idm45853738894736-bb">private member functions</a></span>
  68   <span class="identifier">state_type</span> <span class="special">&amp;</span> <a class="link" href="rosenbrock4_dense_output.html#idm45853738894160-bb"><span class="identifier">get_current_state</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span><span class="special">;</span>
  69   <span class="keyword">const</span> <span class="identifier">state_type</span> <span class="special">&amp;</span> <a class="link" href="rosenbrock4_dense_output.html#idm45853738892624-bb"><span class="identifier">get_current_state</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  70   <span class="identifier">state_type</span> <span class="special">&amp;</span> <a class="link" href="rosenbrock4_dense_output.html#idm45853738890816-bb"><span class="identifier">get_old_state</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span><span class="special">;</span>
  71   <span class="keyword">const</span> <span class="identifier">state_type</span> <span class="special">&amp;</span> <a class="link" href="rosenbrock4_dense_output.html#idm45853738889280-bb"><span class="identifier">get_old_state</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  72   <span class="keyword">void</span> <a class="link" href="rosenbrock4_dense_output.html#idm45853738887472-bb"><span class="identifier">toggle_current_state</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span><span class="special">;</span>
  73   <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="rosenbrock4_dense_output.html#idm45853738885936-bb"><span class="identifier">resize_impl</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>
  74 <span class="special">}</span><span class="special">;</span></pre></div>
  75 <div class="refsect1">
  76 <a name="idm45221356867680"></a><h2>Description</h2>
  77 <div class="refsect2">
  78 <a name="idm45221356867296"></a><h3>
  79 <a name="boost.numeric.odeint.rosenbrock4_dense_outputconstruct-copy-destruct"></a><code class="computeroutput">rosenbrock4_dense_output</code>
  80         public
  81        construct/copy/destruct</h3>
  82 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idm45853738896032-bb"></a><span class="identifier">rosenbrock4_dense_output</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">controlled_stepper_type</span> <span class="special">&amp;</span> stepper <span class="special">=</span> <span class="identifier">controlled_stepper_type</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div>
  83 </div>
  84 <div class="refsect2">
  85 <a name="idm45221356856880"></a><h3>
  86 <a name="idm45853738920480-bb"></a><code class="computeroutput">rosenbrock4_dense_output</code> public member functions</h3>
  87 <div class="orderedlist"><ol class="orderedlist" type="1">
  88 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> StateType<span class="special">&gt;</span>
  89   <span class="keyword">void</span> <a name="idm45853738919920-bb"></a><span class="identifier">initialize</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">StateType</span> <span class="special">&amp;</span> x0<span class="special">,</span> <span class="identifier">time_type</span> t0<span class="special">,</span> <span class="identifier">time_type</span> dt0<span class="special">)</span><span class="special">;</span></pre></li>
  90 <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">&gt;</span>
  91   <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special">&lt;</span> <span class="identifier">time_type</span><span class="special">,</span> <span class="identifier">time_type</span> <span class="special">&gt;</span> <a name="idm45853738916160-bb"></a><span class="identifier">do_step</span><span class="special">(</span><span class="identifier">System</span> system<span class="special">)</span><span class="special">;</span></pre></li>
  92 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> StateOut<span class="special">&gt;</span> <span class="keyword">void</span> <a name="idm45853738913760-bb"></a><span class="identifier">calc_state</span><span class="special">(</span><span class="identifier">time_type</span> t<span class="special">,</span> <span class="identifier">StateOut</span> <span class="special">&amp;</span> x<span class="special">)</span><span class="special">;</span></pre></li>
  93 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> StateOut<span class="special">&gt;</span> <span class="keyword">void</span> <a name="idm45853738910688-bb"></a><span class="identifier">calc_state</span><span class="special">(</span><span class="identifier">time_type</span> t<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">StateOut</span> <span class="special">&amp;</span> x<span class="special">)</span><span class="special">;</span></pre></li>
  94 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> StateType<span class="special">&gt;</span> <span class="keyword">void</span> <a name="idm45853738907616-bb"></a><span class="identifier">adjust_size</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">StateType</span> <span class="special">&amp;</span> x<span class="special">)</span><span class="special">;</span></pre></li>
  95 <li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="identifier">state_type</span> <span class="special">&amp;</span> <a name="idm45853738905232-bb"></a><span class="identifier">current_state</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>
  96 <li class="listitem"><pre class="literallayout"><span class="identifier">time_type</span> <a name="idm45853738903424-bb"></a><span class="identifier">current_time</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>
  97 <li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="identifier">state_type</span> <span class="special">&amp;</span> <a name="idm45853738901616-bb"></a><span class="identifier">previous_state</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>
  98 <li class="listitem"><pre class="literallayout"><span class="identifier">time_type</span> <a name="idm45853738899808-bb"></a><span class="identifier">previous_time</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="identifier">time_type</span> <a name="idm45853738898000-bb"></a><span class="identifier">current_time_step</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>
 100 </ol></div>
 101 </div>
 102 <div class="refsect2">
 103 <a name="idm45221356771904"></a><h3>
 104 <a name="idm45853738894736-bb"></a><code class="computeroutput">rosenbrock4_dense_output</code> private member functions</h3>
 105 <div class="orderedlist"><ol class="orderedlist" type="1">
 106 <li class="listitem"><pre class="literallayout"><span class="identifier">state_type</span> <span class="special">&amp;</span> <a name="idm45853738894160-bb"></a><span class="identifier">get_current_state</span><span class="special">(</span><span class="keyword">void</span><span class="special">)</span><span class="special">;</span></pre></li>
 107 <li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="identifier">state_type</span> <span class="special">&amp;</span> <a name="idm45853738892624-bb"></a><span class="identifier">get_current_state</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>
 108 <li class="listitem"><pre class="literallayout"><span class="identifier">state_type</span> <span class="special">&amp;</span> <a name="idm45853738890816-bb"></a><span class="identifier">get_old_state</span><span class="special">(</span><span class="keyword">void</span><span class="special">)</span><span class="special">;</span></pre></li>
 109 <li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="identifier">state_type</span> <span class="special">&amp;</span> <a name="idm45853738889280-bb"></a><span class="identifier">get_old_state</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>
 110 <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm45853738887472-bb"></a><span class="identifier">toggle_current_state</span><span class="special">(</span><span class="keyword">void</span><span class="special">)</span><span class="special">;</span></pre></li>
 111 <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="idm45853738885936-bb"></a><span class="identifier">resize_impl</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>
 112 </ol></div>
 113 </div>
 114 </div>
 115 </div>
 116 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 117 <td align="left"></td>
 118 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2015 Karsten Ahnert and Mario Mulansky<p>
 119         Distributed under the Boost Software License, Version 1.0. (See accompanying
 120         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>)
 121       </p>
 122 </div></td>
 123 </tr></table>
 124 <hr>
 125 <div class="spirit-nav">
 126 <a accesskey="p" href="../../../header/boost/numeric/odeint/stepper/rosenbrock4_dense_output_hpp.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/numeric/odeint/stepper/rosenbrock4_dense_output_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/runge_kutta4_hpp.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
 127 </div>
 128 </body>
 129 </html>