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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template checked_stepper&lt;Stepper, Checker, stepper_tag&gt;</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/integrate/check_adapter_hpp.html" title="Header &lt;boost/numeric/odeint/integrate/check_adapter.hpp&gt;">
   9 <link rel="prev" href="checked_stepper.html" title="Class template checked_stepper">
  10 <link rel="next" href="checked_steppe_idp11055232.html" title="Class template checked_stepper&lt;ControlledStepper, Checker, controlled_stepper_tag&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="checked_stepper.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/numeric/odeint/integrate/check_adapter_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="checked_steppe_idp11055232.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.numeric.odeint.checked_steppe_idp29795024"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class template checked_stepper&lt;Stepper, Checker, stepper_tag&gt;</span></h2>
  29 <p>boost::numeric::odeint::checked_stepper&lt;Stepper, Checker, stepper_tag&gt; &#8212; Adapter to combine basic stepper and checker. </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/integrate/check_adapter_hpp.html" title="Header &lt;boost/numeric/odeint/integrate/check_adapter.hpp&gt;">boost/numeric/odeint/integrate/check_adapter.hpp</a>&gt;
  33
  34 </span><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> Checker<span class="special">&gt;</span>
  35 <span class="keyword">class</span> <a class="link" href="checked_steppe_idp29795024.html" title="Class template checked_stepper&lt;Stepper, Checker, stepper_tag&gt;">checked_stepper</a><span class="special">&lt;</span><span class="identifier">Stepper</span><span class="special">,</span> <span class="identifier">Checker</span><span class="special">,</span> <span class="identifier">stepper_tag</span><span class="special">&gt;</span> <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">Stepper</span>                  <a name="boost.numeric.odeint.checked_steppe_idp29795024.stepper_type"></a><span class="identifier">stepper_type</span><span class="special">;</span>
  39   <span class="keyword">typedef</span> <span class="identifier">Checker</span>                  <a name="boost.numeric.odeint.checked_steppe_idp29795024.checker_type"></a><span class="identifier">checker_type</span><span class="special">;</span>
  40   <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.checked_steppe_idp29795024.state_type"></a><span class="identifier">state_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.checked_steppe_idp29795024.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">deriv_type</span> <a name="boost.numeric.odeint.checked_steppe_idp29795024.deriv_type"></a><span class="identifier">deriv_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">time_type</span>  <a name="boost.numeric.odeint.checked_steppe_idp29795024.time_type"></a><span class="identifier">time_type</span><span class="special">;</span>
  44
  45   <span class="comment">// <a class="link" href="checked_steppe_idp29795024.html#boost.numeric.odeint.checked_steppe_idp29795024construct-copy-destruct">construct/copy/destruct</a></span>
  46   <a class="link" href="checked_steppe_idp29795024.html#idp11053264-bb"><span class="identifier">checked_stepper</span></a><span class="special">(</span><span class="identifier">stepper_type</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">checker_type</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  47
  48   <span class="comment">// <a class="link" href="checked_steppe_idp29795024.html#idp29803120-bb">public member functions</a></span>
  49   <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> StateInOut<span class="special">&gt;</span>
  50     <span class="keyword">void</span> <a class="link" href="checked_steppe_idp29795024.html#idp29803680-bb"><span class="identifier">do_step</span></a><span class="special">(</span><span class="identifier">System</span><span class="special">,</span> <span class="identifier">StateInOut</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">time_type</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">time_type</span><span class="special">)</span><span class="special">;</span>
  51 <span class="special">}</span><span class="special">;</span></pre></div>
  52 <div class="refsect1">
  53 <a name="idp112145376"></a><h2>Description</h2>
  54 <div class="refsect2">
  55 <a name="idp112145792"></a><h3>
  56 <a name="boost.numeric.odeint.checked_steppe_idp29795024construct-copy-destruct"></a><code class="computeroutput">checked_stepper</code>
  57         public
  58        construct/copy/destruct</h3>
  59 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  60 <pre class="literallayout"><a name="idp11053264-bb"></a><span class="identifier">checked_stepper</span><span class="special">(</span><span class="identifier">stepper_type</span> <span class="special">&amp;</span> stepper<span class="special">,</span> <span class="identifier">checker_type</span> <span class="special">&amp;</span> checker<span class="special">)</span><span class="special">;</span></pre>Construct the checked_stepper. </li></ol></div>
  61 </div>
  62 <div class="refsect2">
  63 <a name="idp112155248"></a><h3>
  64 <a name="idp29803120-bb"></a><code class="computeroutput">checked_stepper</code> public member functions</h3>
  65 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  66 <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> StateInOut<span class="special">&gt;</span>
  67   <span class="keyword">void</span> <a name="idp29803680-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">StateInOut</span> <span class="special">&amp;</span> state<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">time_type</span> t<span class="special">,</span>
  68                <span class="keyword">const</span> <span class="identifier">time_type</span> dt<span class="special">)</span><span class="special">;</span></pre>forward of the do_step method </li></ol></div>
  69 </div>
  70 </div>
  71 </div>
  72 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  73 <td align="left"></td>
  74 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2015 Karsten Ahnert and Mario Mulansky<p>
  75         Distributed under the Boost Software License, Version 1.0. (See accompanying
  76         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>)
  77       </p>
  78 </div></td>
  79 </tr></table>
  80 <hr>
  81 <div class="spirit-nav">
  82 <a accesskey="p" href="checked_stepper.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/numeric/odeint/integrate/check_adapter_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="checked_steppe_idp11055232.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
  83 </div>
  84 </body>
  85 </html>