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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template rosenbrock4</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_hpp.html" title="Header &lt;boost/numeric/odeint/stepper/rosenbrock4.hpp&gt;">
   9 <link rel="prev" href="default__idm45853739079648.html" title="Struct template default_rosenbrock_coefficients">
  10 <link rel="next" href="../../../header/boost/numeric/odeint/stepper/rosenbrock4_controller_hpp.html" title="Header &lt;boost/numeric/odeint/stepper/rosenbrock4_controller.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="default__idm45853739079648.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/numeric/odeint/stepper/rosenbrock4_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_controller_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"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class template rosenbrock4</span></h2>
  29 <p>boost::numeric::odeint::rosenbrock4</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_hpp.html" title="Header &lt;boost/numeric/odeint/stepper/rosenbrock4.hpp&gt;">boost/numeric/odeint/stepper/rosenbrock4.hpp</a>&gt;
  33
  34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Value<span class="special">,</span>
  35          <span class="keyword">typename</span> Coefficients <span class="special">=</span> <span class="identifier">default_rosenbrock_coefficients</span><span class="special">&lt;</span> <span class="identifier">Value</span> <span class="special">&gt;</span><span class="special">,</span>
  36          <span class="keyword">typename</span> Resizer <span class="special">=</span> <span class="identifier">initially_resizer</span><span class="special">&gt;</span>
  37 <span class="keyword">class</span> <a class="link" href="rosenbrock4.html" title="Class template rosenbrock4">rosenbrock4</a> <span class="special">{</span>
  38 <span class="keyword">public</span><span class="special">:</span>
  39   <span class="comment">// types</span>
  40   <span class="keyword">typedef</span> <span class="identifier">Value</span>                                               <a name="boost.numeric.odeint.rosenbrock4.value_type"></a><span class="identifier">value_type</span><span class="special">;</span>
  41   <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">numeric</span><span class="special">::</span><span class="identifier">ublas</span><span class="special">::</span><span class="identifier">vector</span><span class="special">&lt;</span> <span class="identifier">value_type</span> <span class="special">&gt;</span>         <a name="boost.numeric.odeint.rosenbrock4.state_type"></a><span class="identifier">state_type</span><span class="special">;</span>
  42   <span class="keyword">typedef</span> <span class="identifier">state_type</span>                                          <a name="boost.numeric.odeint.rosenbrock4.deriv_type"></a><span class="identifier">deriv_type</span><span class="special">;</span>
  43   <span class="keyword">typedef</span> <span class="identifier">value_type</span>                                          <a name="boost.numeric.odeint.rosenbrock4.time_type"></a><span class="identifier">time_type</span><span class="special">;</span>
  44   <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">numeric</span><span class="special">::</span><span class="identifier">ublas</span><span class="special">::</span><span class="identifier">matrix</span><span class="special">&lt;</span> <span class="identifier">value_type</span> <span class="special">&gt;</span>         <a name="boost.numeric.odeint.rosenbrock4.matrix_type"></a><span class="identifier">matrix_type</span><span class="special">;</span>
  45   <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">numeric</span><span class="special">::</span><span class="identifier">ublas</span><span class="special">::</span><span class="identifier">permutation_matrix</span><span class="special">&lt;</span> <span class="identifier">size_t</span> <span class="special">&gt;</span> <a name="boost.numeric.odeint.rosenbrock4.pmatrix_type"></a><span class="identifier">pmatrix_type</span><span class="special">;</span>
  46   <span class="keyword">typedef</span> <span class="identifier">Resizer</span>                                             <a name="boost.numeric.odeint.rosenbrock4.resizer_type"></a><span class="identifier">resizer_type</span><span class="special">;</span>
  47   <span class="keyword">typedef</span> <span class="identifier">Coefficients</span>                                        <a name="boost.numeric.odeint.rosenbrock4.rosenbrock_coefficients"></a><span class="identifier">rosenbrock_coefficients</span><span class="special">;</span>
  48   <span class="keyword">typedef</span> <span class="identifier">stepper_tag</span>                                         <a name="boost.numeric.odeint.rosenbrock4.stepper_category"></a><span class="identifier">stepper_category</span><span class="special">;</span>
  49   <span class="keyword">typedef</span> <span class="keyword">unsigned</span> <span class="keyword">short</span>                                      <a name="boost.numeric.odeint.rosenbrock4.order_type"></a><span class="identifier">order_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">state_type</span> <span class="special">&gt;</span>                         <a name="boost.numeric.odeint.rosenbrock4.wrapped_state_type"></a><span class="identifier">wrapped_state_type</span><span class="special">;</span>
  51   <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.rosenbrock4.wrapped_deriv_type"></a><span class="identifier">wrapped_deriv_type</span><span class="special">;</span>
  52   <span class="keyword">typedef</span> <span class="identifier">state_wrapper</span><span class="special">&lt;</span> <span class="identifier">matrix_type</span> <span class="special">&gt;</span>                        <a name="boost.numeric.odeint.rosenbrock4.wrapped_matrix_type"></a><span class="identifier">wrapped_matrix_type</span><span class="special">;</span>
  53   <span class="keyword">typedef</span> <span class="identifier">state_wrapper</span><span class="special">&lt;</span> <span class="identifier">pmatrix_type</span> <span class="special">&gt;</span>                       <a name="boost.numeric.odeint.rosenbrock4.wrapped_pmatrix_type"></a><span class="identifier">wrapped_pmatrix_type</span><span class="special">;</span>
  54   <span class="keyword">typedef</span> <span class="identifier">rosenbrock4</span><span class="special">&lt;</span> <span class="identifier">Value</span><span class="special">,</span> <span class="identifier">Coefficients</span><span class="special">,</span> <span class="identifier">Resizer</span> <span class="special">&gt;</span>         <a name="boost.numeric.odeint.rosenbrock4.stepper_type"></a><span class="identifier">stepper_type</span><span class="special">;</span>
  55
  56   <span class="comment">// <a class="link" href="rosenbrock4.html#boost.numeric.odeint.rosenbrock4construct-copy-destruct">construct/copy/destruct</a></span>
  57   <a class="link" href="rosenbrock4.html#idm45853738987568-bb"><span class="identifier">rosenbrock4</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span><span class="special">;</span>
  58
  59   <span class="comment">// <a class="link" href="rosenbrock4.html#idm45853739018160-bb">public member functions</a></span>
  60   <span class="identifier">order_type</span> <a class="link" href="rosenbrock4.html#idm45853739017600-bb"><span class="identifier">order</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  61   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> System<span class="special">&gt;</span>
  62     <span class="keyword">void</span> <a class="link" href="rosenbrock4.html#idm45853739016480-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">state_type</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>
  63                  <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="special">;</span>
  64   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> System<span class="special">&gt;</span>
  65     <span class="keyword">void</span> <a class="link" href="rosenbrock4.html#idm45853739010656-bb"><span class="identifier">do_step</span></a><span class="special">(</span><span class="identifier">System</span><span class="special">,</span> <span class="identifier">state_type</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="identifier">state_type</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> System<span class="special">&gt;</span>
  67     <span class="keyword">void</span> <a class="link" href="rosenbrock4.html#idm45853739005520-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">state_type</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>
  68                  <span class="identifier">time_type</span><span class="special">)</span><span class="special">;</span>
  69   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> System<span class="special">&gt;</span>
  70     <span class="keyword">void</span> <a class="link" href="rosenbrock4.html#idm45853739000384-bb"><span class="identifier">do_step</span></a><span class="special">(</span><span class="identifier">System</span><span class="special">,</span> <span class="identifier">state_type</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>
  71   <span class="keyword">void</span> <a class="link" href="rosenbrock4.html#idm45853738995936-bb"><span class="identifier">prepare_dense_output</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  72   <span class="keyword">void</span> <a class="link" href="rosenbrock4.html#idm45853738995088-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">state_type</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">state_type</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">time_type</span><span class="special">,</span>
  73                   <span class="keyword">const</span> <span class="identifier">state_type</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">time_type</span><span class="special">)</span><span class="special">;</span>
  74   <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.html#idm45853738990112-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>
  75
  76   <span class="comment">// <a class="link" href="rosenbrock4.html#idm45853738986592-bb">protected member functions</a></span>
  77   <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.html#idm45853738986016-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>
  78   <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.html#idm45853738983632-bb"><span class="identifier">resize_x_err</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>
  79
  80   <span class="comment">// public data members</span>
  81   <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">order_type</span> <span class="identifier">stepper_order</span><span class="special">;</span>
  82   <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">order_type</span> <span class="identifier">error_order</span><span class="special">;</span>
  83 <span class="special">}</span><span class="special">;</span></pre></div>
  84 <div class="refsect1">
  85 <a name="idm45221357507968"></a><h2>Description</h2>
  86 <div class="refsect2">
  87 <a name="idm45221357507552"></a><h3>
  88 <a name="boost.numeric.odeint.rosenbrock4construct-copy-destruct"></a><code class="computeroutput">rosenbrock4</code>
  89         public
  90        construct/copy/destruct</h3>
  91 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idm45853738987568-bb"></a><span class="identifier">rosenbrock4</span><span class="special">(</span><span class="keyword">void</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div>
  92 </div>
  93 <div class="refsect2">
  94 <a name="idm45221357501056"></a><h3>
  95 <a name="idm45853739018160-bb"></a><code class="computeroutput">rosenbrock4</code> public member functions</h3>
  96 <div class="orderedlist"><ol class="orderedlist" type="1">
  97 <li class="listitem"><pre class="literallayout"><span class="identifier">order_type</span> <a name="idm45853739017600-bb"></a><span class="identifier">order</span><span class="special">(</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="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> System<span class="special">&gt;</span>
  99   <span class="keyword">void</span> <a name="idm45853739016480-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">state_type</span> <span class="special">&amp;</span> x<span class="special">,</span> <span class="identifier">time_type</span> t<span class="special">,</span>
 100                <span class="identifier">state_type</span> <span class="special">&amp;</span> xout<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> xerr<span class="special">)</span><span class="special">;</span></pre></li>
 101 <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>
 102   <span class="keyword">void</span> <a name="idm45853739010656-bb"></a><span class="identifier">do_step</span><span class="special">(</span><span class="identifier">System</span> system<span class="special">,</span> <span class="identifier">state_type</span> <span class="special">&amp;</span> x<span class="special">,</span> <span class="identifier">time_type</span> t<span class="special">,</span> <span class="identifier">time_type</span> dt<span class="special">,</span>
 103                <span class="identifier">state_type</span> <span class="special">&amp;</span> xerr<span class="special">)</span><span class="special">;</span></pre></li>
 104 <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>
 105   <span class="keyword">void</span> <a name="idm45853739005520-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">state_type</span> <span class="special">&amp;</span> x<span class="special">,</span> <span class="identifier">time_type</span> t<span class="special">,</span>
 106                <span class="identifier">state_type</span> <span class="special">&amp;</span> xout<span class="special">,</span> <span class="identifier">time_type</span> dt<span class="special">)</span><span class="special">;</span></pre></li>
 107 <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>
 108   <span class="keyword">void</span> <a name="idm45853739000384-bb"></a><span class="identifier">do_step</span><span class="special">(</span><span class="identifier">System</span> system<span class="special">,</span> <span class="identifier">state_type</span> <span class="special">&amp;</span> x<span class="special">,</span> <span class="identifier">time_type</span> t<span class="special">,</span> <span class="identifier">time_type</span> dt<span class="special">)</span><span class="special">;</span></pre></li>
 109 <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm45853738995936-bb"></a><span class="identifier">prepare_dense_output</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
 110 <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm45853738995088-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">state_type</span> <span class="special">&amp;</span> x<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">state_type</span> <span class="special">&amp;</span> x_old<span class="special">,</span>
 111                 <span class="identifier">time_type</span> t_old<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">state_type</span> <span class="special">&amp;</span> x_new<span class="special">,</span> <span class="identifier">time_type</span> t_new<span class="special">)</span><span class="special">;</span></pre></li>
 112 <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="idm45853738990112-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>
 113 </ol></div>
 114 </div>
 115 <div class="refsect2">
 116 <a name="idm45221357406512"></a><h3>
 117 <a name="idm45853738986592-bb"></a><code class="computeroutput">rosenbrock4</code> protected member functions</h3>
 118 <div class="orderedlist"><ol class="orderedlist" type="1">
 119 <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="idm45853738986016-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>
 120 <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="idm45853738983632-bb"></a><span class="identifier">resize_x_err</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>
 121 </ol></div>
 122 </div>
 123 </div>
 124 </div>
 125 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 126 <td align="left"></td>
 127 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2015 Karsten Ahnert and Mario Mulansky<p>
 128         Distributed under the Boost Software License, Version 1.0. (See accompanying
 129         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>)
 130       </p>
 131 </div></td>
 132 </tr></table>
 133 <hr>
 134 <div class="spirit-nav">
 135 <a accesskey="p" href="default__idm45853739079648.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/numeric/odeint/stepper/rosenbrock4_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_controller_hpp.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
 136 </div>
 137 </body>
 138 </html>