decorator_tolerance.html 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
  4. <title>tolerance (decorator)</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="../testing_tool_ref.html" title="Reference API for writing tests">
  9. <link rel="prev" href="decorator_timeout.html" title="timeout (decorator)">
  10. <link rel="next" href="assertion_boost_level.html" title="BOOST_&lt;level&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="../../../../../../../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="decorator_timeout.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../testing_tool_ref.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="assertion_boost_level.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24. </div>
  25. <div class="section">
  26. <div class="titlepage"><div><div><h4 class="title">
  27. <a name="boost_test.utf_reference.testing_tool_ref.decorator_tolerance"></a><a class="link" href="decorator_tolerance.html" title="tolerance (decorator)">tolerance
  28. (decorator)</a>
  29. </h4></div></div></div>
  30. <pre class="programlisting"><span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">FPT</span><span class="special">&gt;</span>
  31. <span class="identifier">tolerance</span><span class="special">(</span><span class="identifier">FPT</span> <span class="identifier">eps</span><span class="special">);</span>
  32. <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">FPT</span><span class="special">&gt;</span>
  33. <span class="identifier">tolerance</span><span class="special">(</span><span class="identifier">test_tools</span><span class="special">::</span><span class="identifier">fpc</span><span class="special">::</span><span class="identifier">percent_tolerance_t</span><span class="special">&lt;</span><span class="identifier">FPT</span><span class="special">&gt;</span> <span class="identifier">eps</span><span class="special">)</span>
  34. </pre>
  35. <p>
  36. Decorator <code class="computeroutput"><span class="identifier">tolerance</span></code> specifies
  37. the default comparison tolerance for floating point type <code class="computeroutput"><span class="identifier">FTP</span></code> in the decorated test unit. The default
  38. tolerance only applies to a particular type, so it makes sense to provide
  39. more than one <code class="computeroutput"><span class="identifier">tolerance</span></code>
  40. decorator if we are comparing different floating point types. The variant
  41. with <code class="computeroutput"><span class="identifier">percent_tolerance</span></code>
  42. uses value
  43. </p>
  44. <pre class="programlisting"><span class="identifier">eps</span> <span class="special">/</span> <span class="number">100</span></pre>
  45. <p>
  46. as tolerance.
  47. </p>
  48. <div class="note"><table border="0" summary="Note">
  49. <tr>
  50. <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../doc/src/images/note.png"></td>
  51. <th align="left">Note</th>
  52. </tr>
  53. <tr><td align="left" valign="top"><p>
  54. For more details see the <a class="link" href="../../testing_tools/extended_comparison/floating_point.html" title="Floating point comparison">floating
  55. points comparison</a> section.
  56. </p></td></tr>
  57. </table></div>
  58. <h6>
  59. <a name="boost_test.utf_reference.testing_tool_ref.decorator_tolerance.h0"></a>
  60. <span class="phrase"><a name="boost_test.utf_reference.testing_tool_ref.decorator_tolerance.example_descr"></a></span><a class="link" href="decorator_tolerance.html#boost_test.utf_reference.testing_tool_ref.decorator_tolerance.example_descr">Example:
  61. decorator tolerance</a>
  62. </h6>
  63. <div class="informaltable"><table class="table">
  64. <colgroup><col></colgroup>
  65. <thead><tr><th>
  66. <p>
  67. Code
  68. </p>
  69. </th></tr></thead>
  70. <tbody><tr><td>
  71. <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="preprocessor">#define</span> <span class="identifier">BOOST_TEST_MODULE</span> <span class="identifier">decorator_13</span>
  72. <span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">test</span><span class="special">/</span><span class="identifier">included</span><span class="special">/</span><span class="identifier">unit_test</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
  73. <span class="keyword">namespace</span> <span class="identifier">utf</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">unit_test</span><span class="special">;</span>
  74. <span class="keyword">namespace</span> <span class="identifier">fpc</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">test_tools</span><span class="special">::</span><span class="identifier">fpc</span><span class="special">;</span>
  75. <span class="identifier">BOOST_AUTO_TEST_CASE</span><span class="special">(</span><span class="identifier">test1</span><span class="special">,</span> <span class="special">*</span> <span class="identifier">utf</span><span class="special">::</span><span class="identifier">tolerance</span><span class="special">(</span><span class="number">0.0005</span><span class="special">))</span>
  76. <span class="special">{</span>
  77. <span class="identifier">BOOST_TEST</span><span class="special">(</span> <span class="number">0.001</span> <span class="special">==</span> <span class="number">0.000</span> <span class="special">);</span>
  78. <span class="identifier">BOOST_TEST</span><span class="special">(</span> <span class="number">1.100</span> <span class="special">==</span> <span class="number">1.101</span> <span class="special">);</span>
  79. <span class="special">}</span>
  80. <span class="identifier">BOOST_AUTO_TEST_CASE</span><span class="special">(</span><span class="identifier">test2</span><span class="special">,</span> <span class="special">*</span> <span class="identifier">utf</span><span class="special">::</span><span class="identifier">tolerance</span><span class="special">(</span><span class="number">0.005</span><span class="special">))</span>
  81. <span class="special">{</span>
  82. <span class="identifier">BOOST_TEST</span><span class="special">(</span> <span class="number">0.001</span> <span class="special">==</span> <span class="number">0.000</span> <span class="special">);</span>
  83. <span class="identifier">BOOST_TEST</span><span class="special">(</span> <span class="number">1.100</span> <span class="special">==</span> <span class="number">1.101</span> <span class="special">);</span>
  84. <span class="special">}</span>
  85. <span class="identifier">BOOST_AUTO_TEST_CASE</span><span class="special">(</span><span class="identifier">test3</span><span class="special">,</span> <span class="special">*</span> <span class="identifier">utf</span><span class="special">::</span><span class="identifier">tolerance</span><span class="special">(</span><span class="number">0.05F</span><span class="special">))</span>
  86. <span class="special">{</span>
  87. <span class="identifier">BOOST_TEST</span><span class="special">(</span> <span class="number">0.001</span> <span class="special">==</span> <span class="number">0.000</span> <span class="special">);</span>
  88. <span class="identifier">BOOST_TEST</span><span class="special">(</span> <span class="number">1.100</span> <span class="special">==</span> <span class="number">1.101</span> <span class="special">);</span>
  89. <span class="special">}</span>
  90. <span class="identifier">BOOST_AUTO_TEST_CASE</span><span class="special">(</span><span class="identifier">test4</span><span class="special">,</span>
  91. <span class="special">*</span> <span class="identifier">utf</span><span class="special">::</span><span class="identifier">tolerance</span><span class="special">(</span><span class="identifier">fpc</span><span class="special">::</span><span class="identifier">percent_tolerance</span><span class="special">(</span><span class="number">0.05</span><span class="special">)))</span>
  92. <span class="special">{</span>
  93. <span class="identifier">BOOST_TEST</span><span class="special">(</span> <span class="number">0.001</span> <span class="special">==</span> <span class="number">0.000</span> <span class="special">);</span>
  94. <span class="identifier">BOOST_TEST</span><span class="special">(</span> <span class="number">1.100</span> <span class="special">==</span> <span class="number">1.101</span> <span class="special">);</span>
  95. <span class="special">}</span>
  96. <span class="identifier">BOOST_AUTO_TEST_CASE</span><span class="special">(</span><span class="identifier">test5</span><span class="special">,</span>
  97. <span class="special">*</span> <span class="identifier">utf</span><span class="special">::</span><span class="identifier">tolerance</span><span class="special">(</span><span class="identifier">fpc</span><span class="special">::</span><span class="identifier">percent_tolerance</span><span class="special">(</span><span class="number">0.5</span><span class="special">)))</span>
  98. <span class="special">{</span>
  99. <span class="identifier">BOOST_TEST</span><span class="special">(</span> <span class="number">0.001</span> <span class="special">==</span> <span class="number">0.000</span> <span class="special">);</span>
  100. <span class="identifier">BOOST_TEST</span><span class="special">(</span> <span class="number">1.100</span> <span class="special">==</span> <span class="number">1.101</span> <span class="special">);</span>
  101. <span class="special">}</span>
  102. </pre>
  103. </td></tr></tbody>
  104. </table></div>
  105. <div class="informaltable"><table class="table">
  106. <colgroup><col></colgroup>
  107. <thead><tr><th>
  108. <p>
  109. Output
  110. </p>
  111. </th></tr></thead>
  112. <tbody><tr><td>
  113. <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="special">&gt;</span> <span class="identifier">decorator_13</span>
  114. <span class="identifier">Running</span> <span class="number">5</span> <span class="identifier">test</span> <span class="identifier">cases</span><span class="special">...</span>
  115. <span class="identifier">test</span><span class="special">.</span><span class="identifier">cpp</span><span class="special">(</span><span class="number">9</span><span class="special">):</span> <span class="identifier">error</span><span class="special">:</span> <span class="identifier">in</span> <span class="string">"test1"</span><span class="special">:</span> <span class="identifier">check</span> <span class="number">0.001</span> <span class="special">==</span> <span class="number">0.000</span> <span class="identifier">has</span> <span class="identifier">failed</span> <span class="special">[</span><span class="number">0.001</span> <span class="special">!=</span> <span class="number">0</span><span class="special">].</span> <span class="identifier">Absolute</span> <span class="identifier">value</span> <span class="identifier">exceeds</span> <span class="identifier">tolerance</span> <span class="special">[|</span><span class="number">0.001</span><span class="special">|</span> <span class="special">&gt;</span> <span class="number">0.0005</span><span class="special">]</span>
  116. <span class="identifier">test</span><span class="special">.</span><span class="identifier">cpp</span><span class="special">(</span><span class="number">10</span><span class="special">):</span> <span class="identifier">error</span><span class="special">:</span> <span class="identifier">in</span> <span class="string">"test1"</span><span class="special">:</span> <span class="identifier">check</span> <span class="number">1.100</span> <span class="special">==</span> <span class="number">1.101</span> <span class="identifier">has</span> <span class="identifier">failed</span> <span class="special">[</span><span class="number">1.1000000000000001</span> <span class="special">!=</span> <span class="number">1.101</span><span class="special">].</span> <span class="identifier">Relative</span> <span class="identifier">difference</span> <span class="identifier">exceeds</span> <span class="identifier">tolerance</span> <span class="special">[</span><span class="number">0.000908265</span> <span class="special">&gt;</span> <span class="number">0.0005</span><span class="special">]</span>
  117. <span class="identifier">test</span><span class="special">.</span><span class="identifier">cpp</span><span class="special">(</span><span class="number">21</span><span class="special">):</span> <span class="identifier">error</span><span class="special">:</span> <span class="identifier">in</span> <span class="string">"test3"</span><span class="special">:</span> <span class="identifier">check</span> <span class="number">0.001</span> <span class="special">==</span> <span class="number">0.000</span> <span class="identifier">has</span> <span class="identifier">failed</span> <span class="special">[</span><span class="number">0.001</span> <span class="special">!=</span> <span class="number">0</span><span class="special">].</span> <span class="identifier">Absolute</span> <span class="identifier">value</span> <span class="identifier">exceeds</span> <span class="identifier">tolerance</span> <span class="special">[|</span><span class="number">0.001</span><span class="special">|</span> <span class="special">&gt;</span> <span class="number">0</span><span class="special">]</span>
  118. <span class="identifier">test</span><span class="special">.</span><span class="identifier">cpp</span><span class="special">(</span><span class="number">22</span><span class="special">):</span> <span class="identifier">error</span><span class="special">:</span> <span class="identifier">in</span> <span class="string">"test3"</span><span class="special">:</span> <span class="identifier">check</span> <span class="number">1.100</span> <span class="special">==</span> <span class="number">1.101</span> <span class="identifier">has</span> <span class="identifier">failed</span> <span class="special">[</span><span class="number">1.1000000000000001</span> <span class="special">!=</span> <span class="number">1.101</span><span class="special">]</span>
  119. <span class="identifier">test</span><span class="special">.</span><span class="identifier">cpp</span><span class="special">(</span><span class="number">28</span><span class="special">):</span> <span class="identifier">error</span><span class="special">:</span> <span class="identifier">in</span> <span class="string">"test4"</span><span class="special">:</span> <span class="identifier">check</span> <span class="number">0.001</span> <span class="special">==</span> <span class="number">0.000</span> <span class="identifier">has</span> <span class="identifier">failed</span> <span class="special">[</span><span class="number">0.001</span> <span class="special">!=</span> <span class="number">0</span><span class="special">].</span> <span class="identifier">Absolute</span> <span class="identifier">value</span> <span class="identifier">exceeds</span> <span class="identifier">tolerance</span> <span class="special">[|</span><span class="number">0.001</span><span class="special">|</span> <span class="special">&gt;</span> <span class="number">0.0005</span><span class="special">]</span>
  120. <span class="identifier">test</span><span class="special">.</span><span class="identifier">cpp</span><span class="special">(</span><span class="number">29</span><span class="special">):</span> <span class="identifier">error</span><span class="special">:</span> <span class="identifier">in</span> <span class="string">"test4"</span><span class="special">:</span> <span class="identifier">check</span> <span class="number">1.100</span> <span class="special">==</span> <span class="number">1.101</span> <span class="identifier">has</span> <span class="identifier">failed</span> <span class="special">[</span><span class="number">1.1000000000000001</span> <span class="special">!=</span> <span class="number">1.101</span><span class="special">].</span> <span class="identifier">Relative</span> <span class="identifier">difference</span> <span class="identifier">exceeds</span> <span class="identifier">tolerance</span> <span class="special">[</span><span class="number">0.000908265</span> <span class="special">&gt;</span> <span class="number">0.0005</span><span class="special">]</span>
  121. <span class="special">***</span> <span class="number">6</span> <span class="identifier">failures</span> <span class="identifier">are</span> <span class="identifier">detected</span> <span class="identifier">in</span> <span class="identifier">the</span> <span class="identifier">test</span> <span class="identifier">module</span> <span class="string">"decorator_13"</span>
  122. </pre>
  123. </td></tr></tbody>
  124. </table></div>
  125. <p>
  126. In the above example, in <code class="computeroutput"><span class="identifier">test1</span></code>,
  127. checks on <code class="computeroutput"><span class="keyword">double</span></code>s fail because
  128. they differ by more what tolerance for <code class="computeroutput"><span class="keyword">double</span></code>s
  129. specifies. In <code class="computeroutput"><span class="identifier">test2</span></code> the
  130. tolerance for <code class="computeroutput"><span class="keyword">double</span></code>s is greater
  131. and therefore the checks succeed. In <code class="computeroutput"><span class="identifier">test3</span></code>,
  132. we specify only tolerance for type <code class="computeroutput"><span class="keyword">float</span></code>,
  133. and since the checks use type <code class="computeroutput"><span class="keyword">double</span></code>
  134. the specified tolerance does not apply. Tolerance in <code class="computeroutput"><span class="identifier">test4</span></code>
  135. is equivalent to that in <code class="computeroutput"><span class="identifier">test1</span></code>,
  136. therefore its checks also fail. Tolerance in <code class="computeroutput"><span class="identifier">test5</span></code>
  137. is equivalent to that in <code class="computeroutput"><span class="identifier">test2</span></code>,
  138. therefore its checks also succeed.
  139. </p>
  140. </div>
  141. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  142. <td align="left"></td>
  143. <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2019 Boost.Test
  144. contributors<p>
  145. Distributed under the Boost Software License, Version 1.0. (See accompanying
  146. 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>)
  147. </p>
  148. </div></td>
  149. </tr></table>
  150. <hr>
  151. <div class="spirit-nav">
  152. <a accesskey="p" href="decorator_timeout.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../testing_tool_ref.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="assertion_boost_level.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  153. </div>
  154. </body>
  155. </html>