Home Explore Help
Register Sign In
devn00b
/
EQ2EMu
9
3
Fork 0
Files Issues 76 Pull Requests 0 Wiki
Tree: 103859462d
Branches Tags
EQ2EMu
/
EQ2
/
source
/
depends
/
boost_1_72_0
/
libs
/
contract
/
doc
/
html
/
BOOST_CONTRACT_CHECK_AUDIT.html

BOOST_CONTRACT_CHECK_AUDIT.html 6.7 KB
History Raw

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788 
  1. <html>
    2. 

  2. <head>
    3. 

  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
    4. 

  4. <title>Macro BOOST_CONTRACT_CHECK_AUDIT</title>
    5. 

  5. <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
    6. 

  6. <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
    7. 

  7. <link rel="home" href="index.html" title="Chapter&#160;1.&#160;Boost.Contract 1.0.0">
    8. 

  8. <link rel="up" href="reference.html#header.boost.contract.core.check_macro_hpp" title="Header &lt;boost/contract/core/check_macro.hpp&gt;">
    9. 

  9. <link rel="prev" href="BOOST_CONTRACT_CHECK.html" title="Macro BOOST_CONTRACT_CHECK">
    10. 

  10. <link rel="next" href="BOOST_CONTRACT_CHECK_AXIOM.html" title="Macro BOOST_CONTRACT_CHECK_AXIOM">
    11. 

  11. </head>
    12. 

  12. <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
    13. 

  13. <table cellpadding="2" width="100%"><tr>
    14. 

  14. <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
    15. 

  15. <td align="center"><a href="../../../../index.html">Home</a></td>
    16. 

  16. <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
    17. 

  17. <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
    18. 

  18. <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
    19. 

  19. <td align="center"><a href="../../../../more/index.htm">More</a></td>
    20. 

  20. </tr></table>
    21. 

  21. <hr>
    22. 

  22. <div class="spirit-nav">
    23. 

  23. <a accesskey="p" href="BOOST_CONTRACT_CHECK.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="reference.html#header.boost.contract.core.check_macro_hpp"><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="BOOST_CONTRACT_CHECK_AXIOM.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
    24. 

  24. </div>
    25. 

  25. <div class="refentry">
    26. 

  26. <a name="BOOST_CONTRACT_CHECK_AUDIT"></a><div class="titlepage"></div>
    27. 

  27. <div class="refnamediv">
    28. 

  28. <h2><span class="refentrytitle">Macro BOOST_CONTRACT_CHECK_AUDIT</span></h2>
    29. 

  29. <p>BOOST_CONTRACT_CHECK_AUDIT &#8212; Preferred way to assert implementation check conditions that are computationally expensive, at least compared to the computational cost of executing the function body. </p>
    30. 

  30. </div>
    31. 

  31. <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
    32. 

  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="reference.html#header.boost.contract.core.check_macro_hpp" title="Header &lt;boost/contract/core/check_macro.hpp&gt;">boost/contract/core/check_macro.hpp</a>&gt;
    33. 

  33. 

  34. </span>BOOST_CONTRACT_CHECK_AUDIT(cond)</pre></div>
    35. 

  35. <div class="refsect1">
    36. 

  36. <a name="idm45707997087984"></a><h2>Description</h2>
    37. 

  37. <p>The specified condition will always be compiled and validated syntactically, but it will not be checked at run-time unless  <code class="computeroutput"><a class="link" href="BOOST_CONTRACT_AUDITS.html" title="Macro BOOST_CONTRACT_AUDITS">BOOST_CONTRACT_AUDITS</a></code> is defined (undefined by default). This macro is defined by code equivalent to:</p>
    38. 

  38. <pre class="programlisting"><span class="preprocessor">#ifdef</span> <span class="identifier">BOOST_CONTRACT_AUDITS</span>
    39. 

  39.     <span class="preprocessor">#define</span> <span class="identifier">BOOST_CONTRACT_CHECK_AUDIT</span><span class="special">(</span><span class="identifier">cond</span><span class="special">)</span> \
    40. 

  40.         <span class="identifier">BOOST_CONTRACT_CHECK</span><span class="special">(</span><span class="identifier">cond</span><span class="special">)</span>
    41. 

  41. <span class="preprocessor">#else</span>
    42. 

  42.     <span class="preprocessor">#define</span> <span class="identifier">BOOST_CONTRACT_CHECK_AUDIT</span><span class="special">(</span><span class="identifier">cond</span><span class="special">)</span> \
    43. 

  43.         <span class="identifier">BOOST_CONTRACT_CHECK</span><span class="special">(</span><span class="keyword">true</span> <span class="special">||</span> <span class="identifier">cond</span><span class="special">)</span>
    44. 

  44. <span class="preprocessor">#endif</span>
    45. 

  45. </pre>
    46. 

  46. <p> <code class="computeroutput"><a class="link" href="BOOST_CONTRACT_CHECK.html" title="Macro BOOST_CONTRACT_CHECK">BOOST_CONTRACT_CHECK</a></code>, <code class="computeroutput"><a class="link" href="BOOST_CONTRACT_CHECK_AUDIT.html" title="Macro BOOST_CONTRACT_CHECK_AUDIT">BOOST_CONTRACT_CHECK_AUDIT</a></code>, and  <code class="computeroutput"><a class="link" href="BOOST_CONTRACT_CHECK_AXIOM.html" title="Macro BOOST_CONTRACT_CHECK_AXIOM">BOOST_CONTRACT_CHECK_AXIOM</a></code> are the three assertion levels predefined by this library for implementation checks. If there is a need, programmers are free to implement their own assertion levels defining macros similar to the one above.</p>
    47. 

  47. <p><span class="bold"><strong>See Also:</strong></span></p>
    48. 

  48. <p> <a class="link" href="boost_contract/extras.html#boost_contract.extras.assertion_levels" title="Assertion Levels"> Assertion Levels</a></p>
    49. 

  49. <p>
    50. 

  50. </p>
    51. 

  51. <p>
    52. 

  52. 

  53. </p>
    54. 

  54. <div class="variablelist"><table border="0" class="variablelist compact">
    55. 

  55. <colgroup>
    56. 

  56. <col align="left" valign="top">
    57. 

  57. <col>
    58. 

  58. </colgroup>
    59. 

  59. <tbody><tr>
    60. 

  60. <td><p><span class="term">Parameters:</span></p></td>
    61. 

  61. <td><div class="variablelist"><table border="0" class="variablelist compact">
    62. 

  62. <colgroup>
    63. 

  63. <col align="left" valign="top">
    64. 

  64. <col>
    65. 

  65. </colgroup>
    66. 

  66. <tbody><tr>
    67. 

  67. <td><p><span class="term"><code class="computeroutput">cond</code></span></p></td>
    68. 

  68. <td><p>Boolean condition to check within implementation code (function body, etc.). (This is not a variadic macro parameter so any comma it might contain must be protected by round parenthesis and <code class="computeroutput">BOOST_CONTRACT_CHECK_AUDIT((cond))</code> will always work.) </p></td>
    69. 

  69. </tr></tbody>
    70. 

  70. </table></div></td>
    71. 

  71. </tr></tbody>
    72. 

  72. </table></div>
    73. 

  73. </div>
    74. 

  74. </div>
    75. 

  75. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
    76. 

  76. <td align="left"></td>
    77. 

  77. <td align="right"><div class="copyright-footer">Copyright &#169; 2008-2019 Lorenzo Caminiti<p>
    78. 

  78.         Distributed under the Boost Software License, Version 1.0 (see accompanying
    79. 

  79.         file LICENSE_1_0.txt or a copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
    80. 

  80.       </p>
    81. 

  81. </div></td>
    82. 

  82. </tr></table>
    83. 

  83. <hr>
    84. 

  84. <div class="spirit-nav">
    85. 

  85. <a accesskey="p" href="BOOST_CONTRACT_CHECK.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="reference.html#header.boost.contract.core.check_macro_hpp"><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="BOOST_CONTRACT_CHECK_AXIOM.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
    86. 

  86. </div>
    87. 

  87. </body>
    88. 

  88. </html>
    89.