libs/test/doc/html/boost/math/fpc/close_at_tolerance.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template close_at_tolerance</title>
   5 <link rel="stylesheet" href="../../../boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../../../index.html" title="Boost.Test">
   8 <link rel="up" href="../../../header/boost/test/tools/floating_point_comparison_hpp.html" title="Header &lt;boost/test/tools/floating_point_comparison.hpp&gt;">
   9 <link rel="prev" href="../../../header/boost/test/tools/floating_point_comparison_hpp.html" title="Header &lt;boost/test/tools/floating_point_comparison.hpp&gt;">
  10 <link rel="next" href="is_abstr_idm46279113146800.html" title="Class template is_abstract_class_or_function">
  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="../../../../../../../boost.png"></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="../../../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>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.math.fpc.close_at_tolerance"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class template close_at_tolerance</span></h2>
  29 <p>boost::math::fpc::close_at_tolerance &#8212; Predicate for comparing floating point numbers. </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/test/tools/floating_point_comparison_hpp.html" title="Header &lt;boost/test/tools/floating_point_comparison.hpp&gt;">boost/test/tools/floating_point_comparison.hpp</a>&gt;
  33
  34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> FPT<span class="special">&gt;</span>
  35 <span class="keyword">class</span> <a class="link" href="close_at_tolerance.html" title="Class template close_at_tolerance">close_at_tolerance</a> <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="keyword">bool</span> <a name="boost.math.fpc.close_at_tolerance.result_type"></a><span class="identifier">result_type</span><span class="special">;</span>
  39
  40   <span class="comment">// <a class="link" href="close_at_tolerance.html#boost.math.fpc.close_at_toleranceconstruct-copy-destruct">construct/copy/destruct</a></span>
  41   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ToleranceType<span class="special">&gt;</span>
  42     <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>
  43
  44   <span class="comment">// <a class="link" href="close_at_tolerance.html#idm46279113162208-bb">public member functions</a></span>
  45   <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>
  46   <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>
  47   <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>
  48   <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>
  49 <span class="special">}</span><span class="special">;</span></pre></div>
  50 <div class="refsect1">
  51 <a name="idm45313886946880"></a><h2>Description</h2>
  52 <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>
  53 <p>This predicate is not suitable for comparing to 0 or to infinity. </p>
  54 <div class="refsect2">
  55 <a name="idm45313886945280"></a><h3>
  56 <a name="boost.math.fpc.close_at_toleranceconstruct-copy-destruct"></a><code class="computeroutput">close_at_tolerance</code>
  57         public
  58        construct/copy/destruct</h3>
  59 <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>
  60   <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>
  61                               <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>
  62 </div>
  63 <div class="refsect2">
  64 <a name="idm45313886931776"></a><h3>
  65 <a name="idm46279113162208-bb"></a><code class="computeroutput">close_at_tolerance</code> public member functions</h3>
  66 <div class="orderedlist"><ol class="orderedlist" type="1">
  67 <li class="listitem">
  68 <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>
  69 <li class="listitem">
  70 <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>
  71 <li class="listitem">
  72 <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>
  73 <li class="listitem">
  74 <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>
  75 <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>
  76 <p>
  77 What is reported by <code class="computeroutput">tested_rel_diff</code> in case of failure depends on the comparison method:</p>
  78 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  79 <li class="listitem"><p>for <code class="computeroutput">FPC_STRONG:</code> the max of the two fractions</p></li>
  80 <li class="listitem"><p>for <code class="computeroutput">FPC_WEAK:</code> the min of the two fractions The rationale behind is to report the tolerance to set in order to make a test pass. </p></li>
  81 </ul></div>
  82 <p>
  83 </p>
  84 <div class="variablelist"><table border="0" class="variablelist compact">
  85 <colgroup>
  86 <col align="left" valign="top">
  87 <col>
  88 </colgroup>
  89 <tbody><tr>
  90 <td><p><span class="term">Parameters:</span></p></td>
  91 <td><div class="variablelist"><table border="0" class="variablelist compact">
  92 <colgroup>
  93 <col align="left" valign="top">
  94 <col>
  95 </colgroup>
  96 <tbody>
  97 <tr>
  98 <td><p><span class="term"><code class="computeroutput">left</code></span></p></td>
  99 <td><p>first floating point number to be compared </p></td>
 100 </tr>
 101 <tr>
 102 <td><p><span class="term"><code class="computeroutput">right</code></span></p></td>
 103 <td><p>second floating point number to be compared</p></td>
 104 </tr>
 105 </tbody>
 106 </table></div></td>
 107 </tr></tbody>
 108 </table></div>
 109 </li>
 110 </ol></div>
 111 </div>
 112 </div>
 113 </div>
 114 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 115 <td align="left"></td>
 116 <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2019 Boost.Test
 117       contributors<p>
 118         Distributed under the Boost Software License, Version 1.0. (See accompanying
 119         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>)
 120       </p>
 121 </div></td>
 122 </tr></table>
 123 <hr>
 124 <div class="spirit-nav">
 125 <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>
 126 </div>
 127 </body>
 128 </html>