Imported Upstream version 1.72.0
[platform/upstream/boost.git] / libs / test / doc / html / boost / math / fpc / close_at_tolerance.html
index b50e9e8..f30d708 100644 (file)
@@ -7,7 +7,7 @@
 <link rel="home" href="../../../index.html" title="Boost.Test">
 <link rel="up" href="../../../header/boost/test/tools/floating_point_comparison_hpp.html" title="Header &lt;boost/test/tools/floating_point_comparison.hpp&gt;">
 <link rel="prev" href="../../../header/boost/test/tools/floating_point_comparison_hpp.html" title="Header &lt;boost/test/tools/floating_point_comparison.hpp&gt;">
-<link rel="next" href="is_abstr_idm45665012994960.html" title="Class template is_abstract_class_or_function">
+<link rel="next" href="is_abstr_idm46279113146800.html" title="Class template is_abstract_class_or_function">
 </head>
 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 <table cellpadding="2" width="100%"><tr>
@@ -20,7 +20,7 @@
 </tr></table>
 <hr>
 <div class="spirit-nav">
-<a accesskey="p" href="../../../header/boost/test/tools/floating_point_comparison_hpp.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/test/tools/floating_point_comparison_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="is_abstr_idm45665012994960.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
+<a accesskey="p" href="../../../header/boost/test/tools/floating_point_comparison_hpp.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/test/tools/floating_point_comparison_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="is_abstr_idm46279113146800.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 </div>
 <div class="refentry">
 <a name="boost.math.fpc.close_at_tolerance"></a><div class="titlepage"></div>
 
   <span class="comment">// <a class="link" href="close_at_tolerance.html#boost.math.fpc.close_at_toleranceconstruct-copy-destruct">construct/copy/destruct</a></span>
   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ToleranceType<span class="special">&gt;</span> 
-    <span class="keyword">explicit</span> <a class="link" href="close_at_tolerance.html#idm45665012998032-bb"><span class="identifier">close_at_tolerance</span></a><span class="special">(</span><span class="identifier">ToleranceType</span><span class="special">,</span> <span class="identifier">fpc</span><span class="special">::</span><span class="identifier">strength</span> <span class="special">=</span> <span class="identifier">FPC_STRONG</span><span class="special">)</span><span class="special">;</span>
+    <span class="keyword">explicit</span> <a class="link" href="close_at_tolerance.html#idm46279113149872-bb"><span class="identifier">close_at_tolerance</span></a><span class="special">(</span><span class="identifier">ToleranceType</span><span class="special">,</span> <span class="identifier">fpc</span><span class="special">::</span><span class="identifier">strength</span> <span class="special">=</span> <span class="identifier">FPC_STRONG</span><span class="special">)</span><span class="special">;</span>
 
-  <span class="comment">// <a class="link" href="close_at_tolerance.html#idm45665013010368-bb">public member functions</a></span>
-  <span class="identifier">FPT</span> <a class="link" href="close_at_tolerance.html#idm45665013009808-bb"><span class="identifier">fraction_tolerance</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
-  <span class="identifier">fpc</span><span class="special">::</span><span class="identifier">strength</span> <a class="link" href="close_at_tolerance.html#idm45665013008400-bb"><span class="identifier">strength</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
-  <span class="identifier">FPT</span> <a class="link" href="close_at_tolerance.html#idm45665013006976-bb"><span class="identifier">tested_rel_diff</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
-  <span class="keyword">bool</span> <a class="link" href="close_at_tolerance.html#idm45665013005552-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">FPT</span><span class="special">,</span> <span class="identifier">FPT</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+  <span class="comment">// <a class="link" href="close_at_tolerance.html#idm46279113162208-bb">public member functions</a></span>
+  <span class="identifier">FPT</span> <a class="link" href="close_at_tolerance.html#idm46279113161648-bb"><span class="identifier">fraction_tolerance</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+  <span class="identifier">fpc</span><span class="special">::</span><span class="identifier">strength</span> <a class="link" href="close_at_tolerance.html#idm46279113160240-bb"><span class="identifier">strength</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+  <span class="identifier">FPT</span> <a class="link" href="close_at_tolerance.html#idm46279113158816-bb"><span class="identifier">tested_rel_diff</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+  <span class="keyword">bool</span> <a class="link" href="close_at_tolerance.html#idm46279113157392-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">FPT</span><span class="special">,</span> <span class="identifier">FPT</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
 <span class="special">}</span><span class="special">;</span></pre></div>
 <div class="refsect1">
-<a name="idm45734497158320"></a><h2>Description</h2>
+<a name="idm45313886946880"></a><h2>Description</h2>
 <p>This predicate is used to compare floating point numbers. In addition the comparison produces maximum related difference, which can be used to generate detailed error message The methods for comparing floating points are detailed in the documentation. The method is chosen by the boost::math::fpc::strength given at construction.</p>
 <p>This predicate is not suitable for comparing to 0 or to infinity. </p>
 <div class="refsect2">
-<a name="idm45734497157040"></a><h3>
+<a name="idm45313886945280"></a><h3>
 <a name="boost.math.fpc.close_at_toleranceconstruct-copy-destruct"></a><code class="computeroutput">close_at_tolerance</code> 
         public
        construct/copy/destruct</h3>
 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ToleranceType<span class="special">&gt;</span> 
-  <span class="keyword">explicit</span> <a name="idm45665012998032-bb"></a><span class="identifier">close_at_tolerance</span><span class="special">(</span><span class="identifier">ToleranceType</span> tolerance<span class="special">,</span> 
+  <span class="keyword">explicit</span> <a name="idm46279113149872-bb"></a><span class="identifier">close_at_tolerance</span><span class="special">(</span><span class="identifier">ToleranceType</span> tolerance<span class="special">,</span> 
                               <span class="identifier">fpc</span><span class="special">::</span><span class="identifier">strength</span> fpc_strength <span class="special">=</span> <span class="identifier">FPC_STRONG</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div>
 </div>
 <div class="refsect2">
-<a name="idm45734497143360"></a><h3>
-<a name="idm45665013010368-bb"></a><code class="computeroutput">close_at_tolerance</code> public member functions</h3>
+<a name="idm45313886931776"></a><h3>
+<a name="idm46279113162208-bb"></a><code class="computeroutput">close_at_tolerance</code> public member functions</h3>
 <div class="orderedlist"><ol class="orderedlist" type="1">
 <li class="listitem">
-<pre class="literallayout"><span class="identifier">FPT</span> <a name="idm45665013009808-bb"></a><span class="identifier">fraction_tolerance</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the tolerance. </li>
+<pre class="literallayout"><span class="identifier">FPT</span> <a name="idm46279113161648-bb"></a><span class="identifier">fraction_tolerance</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the tolerance. </li>
 <li class="listitem">
-<pre class="literallayout"><span class="identifier">fpc</span><span class="special">::</span><span class="identifier">strength</span> <a name="idm45665013008400-bb"></a><span class="identifier">strength</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the comparison method. </li>
+<pre class="literallayout"><span class="identifier">fpc</span><span class="special">::</span><span class="identifier">strength</span> <a name="idm46279113160240-bb"></a><span class="identifier">strength</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the comparison method. </li>
 <li class="listitem">
-<pre class="literallayout"><span class="identifier">FPT</span> <a name="idm45665013006976-bb"></a><span class="identifier">tested_rel_diff</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the failing fraction. </li>
+<pre class="literallayout"><span class="identifier">FPT</span> <a name="idm46279113158816-bb"></a><span class="identifier">tested_rel_diff</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the failing fraction. </li>
 <li class="listitem">
-<pre class="literallayout"><span class="keyword">bool</span> <a name="idm45665013005552-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">FPT</span> left<span class="special">,</span> <span class="identifier">FPT</span> right<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
+<pre class="literallayout"><span class="keyword">bool</span> <a name="idm46279113157392-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">FPT</span> left<span class="special">,</span> <span class="identifier">FPT</span> right<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 <p>Compares two floating point numbers a and b such that their "left" relative difference |a-b|/a and/or "right" relative difference |a-b|/b does not exceed specified relative (fraction) tolerance.</p>
 <p>
 What is reported by <code class="computeroutput">tested_rel_diff</code> in case of failure depends on the comparison method:</p>
@@ -113,7 +113,8 @@ What is reported by <code class="computeroutput">tested_rel_diff</code> in case
 </div>
 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 <td align="left"></td>
-<td align="right"><div class="copyright-footer">Copyright &#169; 2001-2018 Boost.Test contributors<p>
+<td align="right"><div class="copyright-footer">Copyright &#169; 2001-2019 Boost.Test
+      contributors<p>
         Distributed under the Boost Software License, Version 1.0. (See accompanying
         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>)
       </p>
@@ -121,7 +122,7 @@ What is reported by <code class="computeroutput">tested_rel_diff</code> in case
 </tr></table>
 <hr>
 <div class="spirit-nav">
-<a accesskey="p" href="../../../header/boost/test/tools/floating_point_comparison_hpp.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/test/tools/floating_point_comparison_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="is_abstr_idm45665012994960.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
+<a accesskey="p" href="../../../header/boost/test/tools/floating_point_comparison_hpp.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/test/tools/floating_point_comparison_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="is_abstr_idm46279113146800.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 </div>
 </body>
 </html>