1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Macro BOOST_CONTRACT_ASSERT_AUDIT</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 1. Boost.Contract 1.0.0"> 8<link rel="up" href="reference.html#header.boost.contract.assert_hpp" title="Header <boost/contract/assert.hpp>"> 9<link rel="prev" href="BOOST_CONTRACT_ASSERT.html" title="Macro BOOST_CONTRACT_ASSERT"> 10<link rel="next" href="BOOST_CO_idm46268613312320.html" title="Macro BOOST_CONTRACT_ASSERT_AXIOM"> 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_ASSERT.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_CO_idm46268613312320.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="refentry"> 26<a name="BOOST_CO_idm46268586630176"></a><div class="titlepage"></div> 27<div class="refnamediv"> 28<h2><span class="refentrytitle">Macro BOOST_CONTRACT_ASSERT_AUDIT</span></h2> 29<p>BOOST_CONTRACT_ASSERT_AUDIT — Preferred way to assert contract conditions that are computationally expensive, 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: <<a class="link" href="reference.html#header.boost.contract.assert_hpp" title="Header <boost/contract/assert.hpp>">boost/contract/assert.hpp</a>> 33 34</span>BOOST_CONTRACT_ASSERT_AUDIT(cond)</pre></div> 35<div class="refsect1"> 36<a name="idm45988681265568"></a><h2>Description</h2> 37<p>The asserted 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<pre class="programlisting"><span class="preprocessor">#ifdef</span> <span class="identifier">BOOST_CONTRACT_AUDITS</span> 39 <span class="preprocessor">#define</span> <span class="identifier">BOOST_CONTRACT_ASSERT_AUDIT</span><span class="special">(</span><span class="identifier">cond</span><span class="special">)</span> \ 40 <span class="identifier">BOOST_CONTRACT_ASSERT</span><span class="special">(</span><span class="identifier">cond</span><span class="special">)</span> 41<span class="preprocessor">#else</span> 42 <span class="preprocessor">#define</span> <span class="identifier">BOOST_CONTRACT_ASSERT_AUDIT</span><span class="special">(</span><span class="identifier">cond</span><span class="special">)</span> \ 43 <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> 44<span class="preprocessor">#endif</span> 45</pre> 46<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_idm46268586630176.html" title="Macro BOOST_CONTRACT_ASSERT_AUDIT">BOOST_CONTRACT_ASSERT_AUDIT</a></code>, and <code class="computeroutput"><a class="link" href="BOOST_CO_idm46268613312320.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> 47<p><span class="bold"><strong>See Also:</strong></span></p> 48<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> 49<p> 50</p> 51<p> 52 53</p> 54<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">Parameters:</span></p></td> 61<td><div class="variablelist"><table border="0" class="variablelist compact"> 62<colgroup> 63<col align="left" valign="top"> 64<col> 65</colgroup> 66<tbody><tr> 67<td><p><span class="term"><code class="computeroutput">cond</code></span></p></td> 68<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_AUDIT((cond))</code> will always work.) </p></td> 69</tr></tbody> 70</table></div></td> 71</tr></tbody> 72</table></div> 73</div> 74</div> 75<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 76<td align="left"></td> 77<td align="right"><div class="copyright-footer">Copyright © 2008-2019 Lorenzo Caminiti<p> 78 Distributed under the Boost Software License, Version 1.0 (see accompanying 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 </p> 81</div></td> 82</tr></table> 83<hr> 84<div class="spirit-nav"> 85<a accesskey="p" href="BOOST_CONTRACT_ASSERT.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_CO_idm46268613312320.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 86</div> 87</body> 88</html> 89
