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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template checked_stepper&lt;ControlledStepper, Checker, controlled_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__idm45853762715376.html" title="Class template checked_stepper&lt;DenseOutStepper, Checker, dense_output_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__idm45853762715376.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.numeric.odeint.checked__idm45853743974576"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class template checked_stepper&lt;ControlledStepper, Checker, controlled_stepper_tag&gt;</span></h2>
  29 <p>boost::numeric::odeint::checked_stepper&lt;ControlledStepper, Checker, controlled_stepper_tag&gt; &#8212; Adapter to combine controlled 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> ControlledStepper<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__idm45853743974576.html" title="Class template checked_stepper&lt;ControlledStepper, Checker, controlled_stepper_tag&gt;">checked_stepper</a><span class="special">&lt;</span><span class="identifier">ControlledStepper</span><span class="special">,</span> <span class="identifier">Checker</span><span class="special">,</span> <span class="identifier">controlled_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">ControlledStepper</span>        <a name="boost.numeric.odeint.checked__idm45853743974576.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__idm45853743974576.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__idm45853743974576.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__idm45853743974576.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__idm45853743974576.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__idm45853743974576.time_type"></a><span class="identifier">time_type</span><span class="special">;</span>
  44
  45   <span class="comment">// <a class="link" href="checked__idm45853743974576.html#boost.numeric.odeint.checked__idm45853743974576construct-copy-destruct">construct/copy/destruct</a></span>
  46   <a class="link" href="checked__idm45853743974576.html#idm45853762717296-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__idm45853743974576.html#idm45853743966528-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="identifier">controlled_step_result</span>
  51     <a class="link" href="checked__idm45853743974576.html#idm45853743965968-bb"><span class="identifier">try_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="identifier">time_type</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">time_type</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  52 <span class="special">}</span><span class="special">;</span></pre></div>
  53 <div class="refsect1">
  54 <a name="idm45221370456592"></a><h2>Description</h2>
  55 <div class="refsect2">
  56 <a name="idm45221370456176"></a><h3>
  57 <a name="boost.numeric.odeint.checked__idm45853743974576construct-copy-destruct"></a><code class="computeroutput">checked_stepper</code>
  58         public
  59        construct/copy/destruct</h3>
  60 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  61 <pre class="literallayout"><a name="idm45853762717296-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>
  62 </div>
  63 <div class="refsect2">
  64 <a name="idm45221370446560"></a><h3>
  65 <a name="idm45853743966528-bb"></a><code class="computeroutput">checked_stepper</code> public member functions</h3>
  66 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  67 <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>
  68   <span class="identifier">controlled_step_result</span>
  69   <a name="idm45853743965968-bb"></a><span class="identifier">try_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="identifier">time_type</span> <span class="special">&amp;</span> t<span class="special">,</span> <span class="identifier">time_type</span> <span class="special">&amp;</span> dt<span class="special">)</span><span class="special">;</span></pre>forward of the do_step method </li></ol></div>
  70 </div>
  71 </div>
  72 </div>
  73 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  74 <td align="left"></td>
  75 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2015 Karsten Ahnert and Mario Mulansky<p>
  76         Distributed under the Boost Software License, Version 1.0. (See accompanying
  77         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>)
  78       </p>
  79 </div></td>
  80 </tr></table>
  81 <hr>
  82 <div class="spirit-nav">
  83 <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__idm45853762715376.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
  84 </div>
  85 </body>
  86 </html>