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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template default_order_adjuster</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/controlled_adams_bashforth_moulton_hpp.html" title="Header &lt;boost/numeric/odeint/stepper/controlled_adams_bashforth_moulton.hpp&gt;">
   9 <link rel="prev" href="controll_idm45853739930512.html" title="Class template controlled_adams_bashforth_moulton">
  10 <link rel="next" href="../../../header/boost/numeric/odeint/stepper/controlled_runge_kutta_hpp.html" title="Header &lt;boost/numeric/odeint/stepper/controlled_runge_kutta.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="controll_idm45853739930512.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/numeric/odeint/stepper/controlled_adams_bashforth_moulton_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/controlled_runge_kutta_hpp.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.numeric.odeint.default_order_adjuster"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class template default_order_adjuster</span></h2>
  29 <p>boost::numeric::odeint::default_order_adjuster</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/controlled_adams_bashforth_moulton_hpp.html" title="Header &lt;boost/numeric/odeint/stepper/controlled_adams_bashforth_moulton.hpp&gt;">boost/numeric/odeint/stepper/controlled_adams_bashforth_moulton.hpp</a>&gt;
  33
  34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="identifier">size_t</span> MaxOrder<span class="special">,</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>
  35          <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">&gt;</span>
  36 <span class="keyword">class</span> <a class="link" href="default_order_adjuster.html" title="Class template default_order_adjuster">default_order_adjuster</a> <span class="special">{</span>
  37 <span class="keyword">public</span><span class="special">:</span>
  38   <span class="comment">// types</span>
  39   <span class="keyword">typedef</span> <span class="identifier">State</span>                       <a name="boost.numeric.odeint.default_order_adjuster.state_type"></a><span class="identifier">state_type</span><span class="special">;</span>
  40   <span class="keyword">typedef</span> <span class="identifier">Value</span>                       <a name="boost.numeric.odeint.default_order_adjuster.value_type"></a><span class="identifier">value_type</span><span class="special">;</span>
  41   <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.default_order_adjuster.wrapped_state_type"></a><span class="identifier">wrapped_state_type</span><span class="special">;</span>
  42   <span class="keyword">typedef</span> <span class="identifier">Algebra</span>                     <a name="boost.numeric.odeint.default_order_adjuster.algebra_type"></a><span class="identifier">algebra_type</span><span class="special">;</span>
  43
  44   <span class="comment">// <a class="link" href="default_order_adjuster.html#boost.numeric.odeint.default_order_adjusterconstruct-copy-destruct">construct/copy/destruct</a></span>
  45   <a class="link" href="default_order_adjuster.html#idm45853739864320-bb"><span class="identifier">default_order_adjuster</span></a><span class="special">(</span><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>
  46
  47   <span class="comment">// <a class="link" href="default_order_adjuster.html#idm45853739867968-bb">public member functions</a></span>
  48   <span class="identifier">size_t</span> <a class="link" href="default_order_adjuster.html#idm45853739867408-bb"><span class="identifier">adjust_order</span></a><span class="special">(</span><span class="identifier">size_t</span><span class="special">,</span> <span class="identifier">size_t</span><span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">array</span><span class="special">&lt;</span> <span class="identifier">wrapped_state_type</span><span class="special">,</span> <span class="number">4</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  49 <span class="special">}</span><span class="special">;</span></pre></div>
  50 <div class="refsect1">
  51 <a name="idm45221362471632"></a><h2>Description</h2>
  52 <div class="refsect2">
  53 <a name="idm45221362471216"></a><h3>
  54 <a name="boost.numeric.odeint.default_order_adjusterconstruct-copy-destruct"></a><code class="computeroutput">default_order_adjuster</code>
  55         public
  56        construct/copy/destruct</h3>
  57 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idm45853739864320-bb"></a><span class="identifier">default_order_adjuster</span><span class="special">(</span><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>
  58 </div>
  59 <div class="refsect2">
  60 <a name="idm45221362460944"></a><h3>
  61 <a name="idm45853739867968-bb"></a><code class="computeroutput">default_order_adjuster</code> public member functions</h3>
  62 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="identifier">size_t</span> <a name="idm45853739867408-bb"></a><span class="identifier">adjust_order</span><span class="special">(</span><span class="identifier">size_t</span> order<span class="special">,</span> <span class="identifier">size_t</span> init<span class="special">,</span>
  63                     <span class="identifier">boost</span><span class="special">::</span><span class="identifier">array</span><span class="special">&lt;</span> <span class="identifier">wrapped_state_type</span><span class="special">,</span> <span class="number">4</span> <span class="special">&gt;</span> <span class="special">&amp;</span> xerr<span class="special">)</span><span class="special">;</span></pre></li></ol></div>
  64 </div>
  65 </div>
  66 </div>
  67 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  68 <td align="left"></td>
  69 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2015 Karsten Ahnert and Mario Mulansky<p>
  70         Distributed under the Boost Software License, Version 1.0. (See accompanying
  71         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>)
  72       </p>
  73 </div></td>
  74 </tr></table>
  75 <hr>
  76 <div class="spirit-nav">
  77 <a accesskey="p" href="controll_idm45853739930512.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/numeric/odeint/stepper/controlled_adams_bashforth_moulton_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/controlled_runge_kutta_hpp.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
  78 </div>
  79 </body>
  80 </html>