1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Class max_step_checker</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 1. Boost.Numeric.Odeint"> 8<link rel="up" href="../../../header/boost/numeric/odeint/integrate/max_step_checker_hpp.html" title="Header <boost/numeric/odeint/integrate/max_step_checker.hpp>"> 9<link rel="prev" href="failed_step_checker.html" title="Class failed_step_checker"> 10<link rel="next" href="../../../header/boost/numeric/odeint/iterator/adaptive_iterator_hpp.html" title="Header <boost/numeric/odeint/iterator/adaptive_iterator.hpp>"> 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="failed_step_checker.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/numeric/odeint/integrate/max_step_checker_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/iterator/adaptive_iterator_hpp.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="refentry"> 26<a name="boost.numeric.odeint.max_step_checker"></a><div class="titlepage"></div> 27<div class="refnamediv"> 28<h2><span class="refentrytitle">Class max_step_checker</span></h2> 29<p>boost::numeric::odeint::max_step_checker — A class for performing overflow checks on the step count in integrate functions. </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: <<a class="link" href="../../../header/boost/numeric/odeint/integrate/max_step_checker_hpp.html" title="Header <boost/numeric/odeint/integrate/max_step_checker.hpp>">boost/numeric/odeint/integrate/max_step_checker.hpp</a>> 33 34</span> 35<span class="keyword">class</span> <a class="link" href="max_step_checker.html" title="Class max_step_checker">max_step_checker</a> <span class="special">{</span> 36<span class="keyword">public</span><span class="special">:</span> 37 <span class="comment">// <a class="link" href="max_step_checker.html#boost.numeric.odeint.max_step_checkerconstruct-copy-destruct">construct/copy/destruct</a></span> 38 <a class="link" href="max_step_checker.html#idm45875528036080-bb"><span class="identifier">max_step_checker</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">int</span> <span class="special">=</span> <span class="number">500</span><span class="special">)</span><span class="special">;</span> 39 40 <span class="comment">// <a class="link" href="max_step_checker.html#idm45875528040576-bb">public member functions</a></span> 41 <span class="keyword">void</span> <a class="link" href="max_step_checker.html#idm45875528040016-bb"><span class="identifier">reset</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 42 <span class="keyword">void</span> <a class="link" href="max_step_checker.html#idm45875528038112-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span><span class="special">;</span> 43<span class="special">}</span><span class="special">;</span></pre></div> 44<div class="refsect1"> 45<a name="idm45600382917008"></a><h2>Description</h2> 46<p>Provide an instance of this class to integrate functions if you want to throw a runtime error if too many steps are performed without progress during the integrate routine. </p> 47<div class="refsect2"> 48<a name="idm45600382916144"></a><h3> 49<a name="boost.numeric.odeint.max_step_checkerconstruct-copy-destruct"></a><code class="computeroutput">max_step_checker</code> 50 public 51 construct/copy/destruct</h3> 52<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> 53<pre class="literallayout"><a name="idm45875528036080-bb"></a><span class="identifier">max_step_checker</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">int</span> max_steps <span class="special">=</span> <span class="number">500</span><span class="special">)</span><span class="special">;</span></pre>Construct the <code class="computeroutput"><a class="link" href="max_step_checker.html" title="Class max_step_checker">max_step_checker</a></code>. max_steps is the maximal number of iterations allowed before runtime_error is thrown. </li></ol></div> 54</div> 55<div class="refsect2"> 56<a name="idm45600382906064"></a><h3> 57<a name="idm45875528040576-bb"></a><code class="computeroutput">max_step_checker</code> public member functions</h3> 58<div class="orderedlist"><ol class="orderedlist" type="1"> 59<li class="listitem"> 60<pre class="literallayout"><span class="keyword">void</span> <a name="idm45875528040016-bb"></a><span class="identifier">reset</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Resets the <code class="computeroutput"><a class="link" href="max_step_checker.html" title="Class max_step_checker">max_step_checker</a></code> by setting the internal counter to 0. </li> 61<li class="listitem"> 62<pre class="literallayout"><span class="keyword">void</span> <a name="idm45875528038112-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="keyword">void</span><span class="special">)</span><span class="special">;</span></pre>Increases the counter and performs the iteration check. </li> 63</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 © 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="failed_step_checker.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/numeric/odeint/integrate/max_step_checker_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/iterator/adaptive_iterator_hpp.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 78</div> 79</body> 80</html> 81
