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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template small_with_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="percent_tolerance_t.html" title="Struct template percent_tolerance_t">
  10 <link rel="next" href="tolerance_based.html" title="Struct template tolerance_based">
  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="percent_tolerance_t.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="tolerance_based.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.math.fpc.small_with_tolerance"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class template small_with_tolerance</span></h2>
  29 <p>boost::math::fpc::small_with_tolerance &#8212; Predicate for comparing floating point numbers against 0. </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="small_with_tolerance.html" title="Class template small_with_tolerance">small_with_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.small_with_tolerance.result_type"></a><span class="identifier">result_type</span><span class="special">;</span>
  39
  40   <span class="comment">// <a class="link" href="small_with_tolerance.html#boost.math.fpc.small_with_toleranceconstruct-copy-destruct">construct/copy/destruct</a></span>
  41   <span class="keyword">explicit</span> <a class="link" href="small_with_tolerance.html#idm46279113128128-bb"><span class="identifier">small_with_tolerance</span></a><span class="special">(</span><span class="identifier">FPT</span><span class="special">)</span><span class="special">;</span>
  42
  43   <span class="comment">// <a class="link" href="small_with_tolerance.html#idm46279113130656-bb">public member functions</a></span>
  44   <span class="keyword">bool</span> <a class="link" href="small_with_tolerance.html#idm46279113130096-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="keyword">const</span><span class="special">;</span>
  45 <span class="special">}</span><span class="special">;</span></pre></div>
  46 <div class="refsect1">
  47 <a name="idm45313886789616"></a><h2>Description</h2>
  48 <p>Serves the same purpose as <a class="link" href="close_at_tolerance.html" title="Class template close_at_tolerance">boost::math::fpc::close_at_tolerance</a>, but used when one of the operand is null. </p>
  49 <div class="refsect2">
  50 <a name="idm45313886787984"></a><h3>
  51 <a name="boost.math.fpc.small_with_toleranceconstruct-copy-destruct"></a><code class="computeroutput">small_with_tolerance</code>
  52         public
  53        construct/copy/destruct</h3>
  54 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="keyword">explicit</span> <a name="idm46279113128128-bb"></a><span class="identifier">small_with_tolerance</span><span class="special">(</span><span class="identifier">FPT</span> tolerance<span class="special">)</span><span class="special">;</span></pre></li></ol></div>
  55 </div>
  56 <div class="refsect2">
  57 <a name="idm45313886780704"></a><h3>
  58 <a name="idm46279113130656-bb"></a><code class="computeroutput">small_with_tolerance</code> public member functions</h3>
  59 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="idm46279113130096-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">FPT</span> fpv<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li></ol></div>
  60 </div>
  61 </div>
  62 </div>
  63 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  64 <td align="left"></td>
  65 <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2019 Boost.Test
  66       contributors<p>
  67         Distributed under the Boost Software License, Version 1.0. (See accompanying
  68         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>)
  69       </p>
  70 </div></td>
  71 </tr></table>
  72 <hr>
  73 <div class="spirit-nav">
  74 <a accesskey="p" href="percent_tolerance_t.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="tolerance_based.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  75 </div>
  76 </body>
  77 </html>