BOOST_CO_idm45395027441616.html 6.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
  4. <title>Macro BOOST_CONTRACT_ASSERT_AXIOM</title>
  5. <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
  6. <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
  7. <link rel="home" href="index.html" title="Chapter&#160;1.&#160;Boost.Contract 1.0.0">
  8. <link rel="up" href="reference.html#header.boost.contract.assert_hpp" title="Header &lt;boost/contract/assert.hpp&gt;">
  9. <link rel="prev" href="BOOST_CO_idm45395000817520.html" title="Macro BOOST_CONTRACT_ASSERT_AUDIT">
  10. <link rel="next" href="BOOST_CONTRACT_BASE_TYPES.html" title="Macro BOOST_CONTRACT_BASE_TYPES">
  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="BOOST_CO_idm45395000817520.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="reference.html#header.boost.contract.assert_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_BASE_TYPES.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24. </div>
  25. <div class="refentry">
  26. <a name="BOOST_CO_idm45395027441616"></a><div class="titlepage"></div>
  27. <div class="refnamediv">
  28. <h2><span class="refentrytitle">Macro BOOST_CONTRACT_ASSERT_AXIOM</span></h2>
  29. <p>BOOST_CONTRACT_ASSERT_AXIOM &#8212; Preferred way to document in the code contract conditions that are computationally prohibitive, at least compared to the computational cost of executing the function body. </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="reference.html#header.boost.contract.assert_hpp" title="Header &lt;boost/contract/assert.hpp&gt;">boost/contract/assert.hpp</a>&gt;
  33. </span>BOOST_CONTRACT_ASSERT_AXIOM(cond)</pre></div>
  34. <div class="refsect1">
  35. <a name="idm45707998439264"></a><h2>Description</h2>
  36. <p>The asserted condition will always be compiled and validated syntactically, but it will never be checked at run-time. This macro is defined by code equivalent to:</p>
  37. <pre class="programlisting"><span class="preprocessor">#define</span> <span class="identifier">BOOST_CONTRACT_ASSERT_AXIOM</span><span class="special">(</span><span class="identifier">cond</span><span class="special">)</span> \
  38. <span class="identifier">BOOST_CONTRACT_ASSERT</span><span class="special">(</span><span class="keyword">true</span> <span class="special">||</span> <span class="identifier">cond</span><span class="special">)</span>
  39. </pre>
  40. <p> <code class="computeroutput"><a class="link" href="BOOST_CONTRACT_ASSERT.html" title="Macro BOOST_CONTRACT_ASSERT">BOOST_CONTRACT_ASSERT</a></code>, <code class="computeroutput"><a class="link" href="BOOST_CO_idm45395000817520.html" title="Macro BOOST_CONTRACT_ASSERT_AUDIT">BOOST_CONTRACT_ASSERT_AUDIT</a></code>, and <code class="computeroutput"><a class="link" href="BOOST_CO_idm45395027441616.html" title="Macro BOOST_CONTRACT_ASSERT_AXIOM">BOOST_CONTRACT_ASSERT_AXIOM</a></code> are the three assertion levels predefined by this library. If there is a need, programmers are free to implement their own assertion levels defining macros similar to the one above.</p>
  41. <p><span class="bold"><strong>See Also:</strong></span></p>
  42. <p> <a class="link" href="boost_contract/extras.html#boost_contract.extras.assertion_levels" title="Assertion Levels"> Assertion Levels</a>, <a class="link" href="boost_contract/extras.html#boost_contract.extras.no_macros__and_no_variadic_macros_" title="No Macros (and No Variadic Macros)"> No Macros</a></p>
  43. <p>
  44. </p>
  45. <p>
  46. </p>
  47. <div class="variablelist"><table border="0" class="variablelist compact">
  48. <colgroup>
  49. <col align="left" valign="top">
  50. <col>
  51. </colgroup>
  52. <tbody><tr>
  53. <td><p><span class="term">Parameters:</span></p></td>
  54. <td><div class="variablelist"><table border="0" class="variablelist compact">
  55. <colgroup>
  56. <col align="left" valign="top">
  57. <col>
  58. </colgroup>
  59. <tbody><tr>
  60. <td><p><span class="term"><code class="computeroutput">cond</code></span></p></td>
  61. <td><p>Boolean contract condition to check. (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_ASSERT_AXIOM((cond))</code> will always work.) </p></td>
  62. </tr></tbody>
  63. </table></div></td>
  64. </tr></tbody>
  65. </table></div>
  66. </div>
  67. </div>
  68. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  69. <td align="left"></td>
  70. <td align="right"><div class="copyright-footer">Copyright &#169; 2008-2019 Lorenzo Caminiti<p>
  71. Distributed under the Boost Software License, Version 1.0 (see accompanying
  72. 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>)
  73. </p>
  74. </div></td>
  75. </tr></table>
  76. <hr>
  77. <div class="spirit-nav">
  78. <a accesskey="p" href="BOOST_CO_idm45395000817520.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="reference.html#header.boost.contract.assert_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_BASE_TYPES.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  79. </div>
  80. </body>
  81. </html>