libs/contract/doc/html/BOOST_CONTRACT_CHECK_AXIOM.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Macro BOOST_CONTRACT_CHECK_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.core.check_macro_hpp" title="Header &lt;boost/contract/core/check_macro.hpp&gt;">
   9 <link rel="prev" href="BOOST_CONTRACT_CHECK_AUDIT.html" title="Macro BOOST_CONTRACT_CHECK_AUDIT">
  10 <link rel="next" href="BOOST_CONTRACT_DYN_LINK.html" title="Macro BOOST_CONTRACT_DYN_LINK">
  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_CONTRACT_CHECK_AUDIT.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_DYN_LINK.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="BOOST_CONTRACT_CHECK_AXIOM"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Macro BOOST_CONTRACT_CHECK_AXIOM</span></h2>
  29 <p>BOOST_CONTRACT_CHECK_AXIOM &#8212; Preferred way to document in the code implementation check 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.core.check_macro_hpp" title="Header &lt;boost/contract/core/check_macro.hpp&gt;">boost/contract/core/check_macro.hpp</a>&gt;
  33
  34 </span>BOOST_CONTRACT_CHECK_AXIOM(cond)</pre></div>
  35 <div class="refsect1">
  36 <a name="idm45707997055824"></a><h2>Description</h2>
  37 <p>The specified 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>
  38 <pre class="programlisting"><span class="preprocessor">#define</span> <span class="identifier">BOOST_CONTRACT_CHECK_AXIOM</span><span class="special">(</span><span class="identifier">cond</span><span class="special">)</span> \
  39     <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>
  40 </pre>
  41 <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>
  42 <p><span class="bold"><strong>See Also:</strong></span></p>
  43 <p> <a class="link" href="boost_contract/extras.html#boost_contract.extras.assertion_levels" title="Assertion Levels"> Assertion Levels</a></p>
  44 <p>
  45 </p>
  46 <p>
  47
  48 </p>
  49 <div class="variablelist"><table border="0" class="variablelist compact">
  50 <colgroup>
  51 <col align="left" valign="top">
  52 <col>
  53 </colgroup>
  54 <tbody><tr>
  55 <td><p><span class="term">Parameters:</span></p></td>
  56 <td><div class="variablelist"><table border="0" class="variablelist compact">
  57 <colgroup>
  58 <col align="left" valign="top">
  59 <col>
  60 </colgroup>
  61 <tbody><tr>
  62 <td><p><span class="term"><code class="computeroutput">cond</code></span></p></td>
  63 <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_AXIOM((cond))</code> will always work.) </p></td>
  64 </tr></tbody>
  65 </table></div></td>
  66 </tr></tbody>
  67 </table></div>
  68 </div>
  69 </div>
  70 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  71 <td align="left"></td>
  72 <td align="right"><div class="copyright-footer">Copyright &#169; 2008-2019 Lorenzo Caminiti<p>
  73         Distributed under the Boost Software License, Version 1.0 (see accompanying
  74         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>)
  75       </p>
  76 </div></td>
  77 </tr></table>
  78 <hr>
  79 <div class="spirit-nav">
  80 <a accesskey="p" href="BOOST_CONTRACT_CHECK_AUDIT.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_DYN_LINK.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  81 </div>
  82 </body>
  83 </html>