1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Reference</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="index.html" title="Chapter 1. Boost.Contract 1.0.0"> 9<link rel="prev" href="boost_contract/examples.html" title="Examples"> 10<link rel="next" href="BOOST_CONTRACT_ASSERT.html" title="Macro BOOST_CONTRACT_ASSERT"> 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/examples.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="index.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="BOOST_CONTRACT_ASSERT.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h2 class="title" style="clear: both"> 27<a name="reference"></a>Reference</h2></div></div></div> 28<div class="toc"><dl class="toc"> 29<dt><span class="section"><a href="reference.html#header.boost.contract_hpp">Header <boost/contract.hpp></a></span></dt> 30<dt><span class="section"><a href="reference.html#header.boost.contract.assert_hpp">Header <boost/contract/assert.hpp></a></span></dt> 31<dt><span class="section"><a href="reference.html#header.boost.contract.base_types_hpp">Header <boost/contract/base_types.hpp></a></span></dt> 32<dt><span class="section"><a href="reference.html#header.boost.contract.call_if_hpp">Header <boost/contract/call_if.hpp></a></span></dt> 33<dt><span class="section"><a href="reference.html#header.boost.contract.check_hpp">Header <boost/contract/check.hpp></a></span></dt> 34<dt><span class="section"><a href="reference.html#header.boost.contract.constructor_hpp">Header <boost/contract/constructor.hpp></a></span></dt> 35<dt><span class="section"><a href="reference.html#header.boost.contract.core.access_hpp">Header <boost/contract/core/access.hpp></a></span></dt> 36<dt><span class="section"><a href="reference.html#header.boost.contract.core.check_macro_hpp">Header <boost/contract/core/check_macro.hpp></a></span></dt> 37<dt><span class="section"><a href="reference.html#header.boost.contract.core.config_hpp">Header <boost/contract/core/config.hpp></a></span></dt> 38<dt><span class="section"><a href="reference.html#header.boost.contract.core.constructor_precondition_hpp">Header <boost/contract/core/constructor_precondition.hpp></a></span></dt> 39<dt><span class="section"><a href="reference.html#header.boost.contract.core.exception_hpp">Header <boost/contract/core/exception.hpp></a></span></dt> 40<dt><span class="section"><a href="reference.html#header.boost.contract.core.specify_hpp">Header <boost/contract/core/specify.hpp></a></span></dt> 41<dt><span class="section"><a href="reference.html#header.boost.contract.core.virtual_hpp">Header <boost/contract/core/virtual.hpp></a></span></dt> 42<dt><span class="section"><a href="reference.html#header.boost.contract.destructor_hpp">Header <boost/contract/destructor.hpp></a></span></dt> 43<dt><span class="section"><a href="reference.html#header.boost.contract.function_hpp">Header <boost/contract/function.hpp></a></span></dt> 44<dt><span class="section"><a href="reference.html#header.boost.contract.old_hpp">Header <boost/contract/old.hpp></a></span></dt> 45<dt><span class="section"><a href="reference.html#header.boost.contract.override_hpp">Header <boost/contract/override.hpp></a></span></dt> 46<dt><span class="section"><a href="reference.html#header.boost.contract.public_function_hpp">Header <boost/contract/public_function.hpp></a></span></dt> 47<dt><span class="section"><a href="reference.html#header.boost.contract_macro_hpp">Header <boost/contract_macro.hpp></a></span></dt> 48</dl></div> 49<div class="section"> 50<div class="titlepage"><div><div><h3 class="title"> 51<a name="header.boost.contract_hpp"></a>Header <<a href="../../../../boost/contract.hpp" target="_top">boost/contract.hpp</a>></h3></div></div></div> 52<p>Include all header files required by this library at once (for convenience). </p> 53<p>All header files <code class="computeroutput">boost/contract/*.hpp</code> are independent from one another and can be included one-by-one to reduce the amount of code to compile from this library in user code (but this was measured to not make an appreciable difference in compile-time so <code class="computeroutput">boost/contract.hpp</code> can be included directly in most cases). Instead the headers <code class="computeroutput">boost/contract/core/*.hpp</code> are not independent from other library headers and they are automatically included by the <code class="computeroutput">boost/contract/*.hpp</code> headers (so the <code class="computeroutput">boost/contract/core/*.hpp</code> headers are usually not directly included by programmers).</p> 54<p>All files under the <code class="computeroutput">boost/contract/detail/</code> directory, names within the <code class="computeroutput">boost::contract::detail</code> namespace, names prefixed by <code class="computeroutput">boost_contract_detail</code>... and <code class="computeroutput">BOOST_CONTRACT_DETAIL</code>... (in any namesapce, including user's code) are reserved for internal use of this library and should never be used directly by programmers.</p> 55<p><span class="bold"><strong>See Also:</strong></span></p> 56<p> <a class="link" href="boost_contract/getting_started.html" title="Getting Started"> Getting Started</a> </p> 57<p> 58</p> 59<p> 60</p> 61</div> 62<div class="section"> 63<div class="titlepage"><div><div><h3 class="title"> 64<a name="header.boost.contract.assert_hpp"></a>Header <<a href="../../../../boost/contract/assert.hpp" target="_top">boost/contract/assert.hpp</a>></h3></div></div></div> 65<p>Assert contract conditions. </p> 66<pre class="synopsis"> 67 68<a class="link" href="BOOST_CONTRACT_ASSERT.html" title="Macro BOOST_CONTRACT_ASSERT">BOOST_CONTRACT_ASSERT</a>(cond) 69<a class="link" href="BOOST_CO_idm46268586630176.html" title="Macro BOOST_CONTRACT_ASSERT_AUDIT">BOOST_CONTRACT_ASSERT_AUDIT</a>(cond) 70<a class="link" href="BOOST_CO_idm46268613312320.html" title="Macro BOOST_CONTRACT_ASSERT_AXIOM">BOOST_CONTRACT_ASSERT_AXIOM</a>(cond)</pre> 71</div> 72<div class="section"> 73<div class="titlepage"><div><div><h3 class="title"> 74<a name="header.boost.contract.base_types_hpp"></a>Header <<a href="../../../../boost/contract/base_types.hpp" target="_top">boost/contract/base_types.hpp</a>></h3></div></div></div> 75<p>Specify inheritance form base classes (for subcontracting). </p> 76<pre class="synopsis"> 77 78<a class="link" href="BOOST_CONTRACT_BASE_TYPES.html" title="Macro BOOST_CONTRACT_BASE_TYPES">BOOST_CONTRACT_BASE_TYPES</a>(...)</pre> 79</div> 80<div class="section"> 81<div class="titlepage"><div><div><h3 class="title"> 82<a name="header.boost.contract.call_if_hpp"></a>Header <<a href="../../../../boost/contract/call_if.hpp" target="_top">boost/contract/call_if.hpp</a>></h3></div></div></div> 83<p>Statically disable compilation and execution of functor calls. </p> 84<div class="note"><table border="0" summary="Note"> 85<tr> 86<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td> 87<th align="left">Note</th> 88</tr> 89<tr><td align="left" valign="top"><p>These facilities allow to emulate C++17 <code class="computeroutput">if constexpr</code> statements when used together with functor templates (and C++14 generic lambdas). Therefore, they are not useful on C++17 compilers where <code class="computeroutput"> if constexpr</code> can be directly used instead. </p></td></tr> 90</table></div> 91<p> 92</p> 93<pre class="synopsis"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span> 94 <span class="keyword">namespace</span> <span class="identifier">contract</span> <span class="special">{</span> 95 <span class="keyword">template</span><span class="special"><</span><span class="keyword">bool</span> Pred<span class="special">,</span> <span class="keyword">typename</span> Then<span class="special">,</span> <span class="keyword">typename</span> ThenResult <span class="special">=</span> <span class="identifier">internal_type</span><span class="special">></span> 96 <span class="keyword">struct</span> <a class="link" href="boost/contract/call_if_statement.html" title="Struct template call_if_statement">call_if_statement</a><span class="special">;</span> 97 98 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Then<span class="special">></span> 99 <span class="keyword">struct</span> <a class="link" href="boost/contract/call_if__idm46268585910912.html" title="Struct template call_if_statement<false, Then, internal_type>">call_if_statement</a><span class="special"><</span><span class="keyword">false</span><span class="special">,</span> <span class="identifier">Then</span><span class="special">,</span> <span class="identifier">internal_type</span><span class="special">></span><span class="special">;</span> 100 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Then<span class="special">></span> <span class="keyword">struct</span> <a class="link" href="boost/contract/call_if__idm46268585871440.html" title="Struct template call_if_statement<true, Then, internal_type>">call_if_statement</a><span class="special"><</span><span class="keyword">true</span><span class="special">,</span> <span class="identifier">Then</span><span class="special">,</span> <span class="identifier">internal_type</span><span class="special">></span><span class="special">;</span> 101 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Then<span class="special">,</span> <span class="keyword">typename</span> ThenResult<span class="special">></span> 102 <span class="keyword">struct</span> <a class="link" href="boost/contract/call_if__idm46268585855312.html" title="Struct template call_if_statement<true, Then, ThenResult>">call_if_statement</a><span class="special"><</span><span class="keyword">true</span><span class="special">,</span> <span class="identifier">Then</span><span class="special">,</span> <span class="identifier">ThenResult</span><span class="special">></span><span class="special">;</span> 103 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Then<span class="special">></span> <span class="keyword">struct</span> <a class="link" href="boost/contract/call_if__idm46268585815184.html" title="Struct template call_if_statement<true, Then, void>">call_if_statement</a><span class="special"><</span><span class="keyword">true</span><span class="special">,</span> <span class="identifier">Then</span><span class="special">,</span> <span class="keyword">void</span><span class="special">></span><span class="special">;</span> 104 <span class="keyword">template</span><span class="special"><</span><span class="keyword">bool</span> Pred<span class="special">,</span> <span class="keyword">typename</span> Then<span class="special">></span> 105 <a class="link" href="boost/contract/call_if_statement.html" title="Struct template call_if_statement">call_if_statement</a><span class="special"><</span> <span class="identifier">Pred</span><span class="special">,</span> <span class="identifier">Then</span> <span class="special">></span> <a class="link" href="boost/contract/call_if_c.html" title="Function template call_if_c"><span class="identifier">call_if_c</span></a><span class="special">(</span><span class="identifier">Then</span><span class="special">)</span><span class="special">;</span> 106 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Pred<span class="special">,</span> <span class="keyword">typename</span> Then<span class="special">></span> 107 <a class="link" href="boost/contract/call_if_statement.html" title="Struct template call_if_statement">call_if_statement</a><span class="special"><</span> <span class="identifier">Pred</span><span class="special">::</span><span class="identifier">value</span><span class="special">,</span> <span class="identifier">Then</span> <span class="special">></span> <a class="link" href="boost/contract/call_if.html" title="Function template call_if"><span class="identifier">call_if</span></a><span class="special">(</span><span class="identifier">Then</span><span class="special">)</span><span class="special">;</span> 108 <span class="keyword">template</span><span class="special"><</span><span class="keyword">bool</span> Pred<span class="special">,</span> <span class="keyword">typename</span> Then<span class="special">></span> <span class="keyword">bool</span> <a class="link" href="boost/contract/condition_if_c.html" title="Function template condition_if_c"><span class="identifier">condition_if_c</span></a><span class="special">(</span><span class="identifier">Then</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">true</span><span class="special">)</span><span class="special">;</span> 109 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Pred<span class="special">,</span> <span class="keyword">typename</span> Then<span class="special">></span> 110 <span class="keyword">bool</span> <a class="link" href="boost/contract/condition_if.html" title="Function template condition_if"><span class="identifier">condition_if</span></a><span class="special">(</span><span class="identifier">Then</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">true</span><span class="special">)</span><span class="special">;</span> 111 <span class="special">}</span> 112<span class="special">}</span></pre> 113</div> 114<div class="section"> 115<div class="titlepage"><div><div><h3 class="title"> 116<a name="header.boost.contract.check_hpp"></a>Header <<a href="../../../../boost/contract/check.hpp" target="_top">boost/contract/check.hpp</a>></h3></div></div></div> 117<p>RAII object that checks contracts. </p> 118<pre class="synopsis"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span> 119 <span class="keyword">namespace</span> <span class="identifier">contract</span> <span class="special">{</span> 120 <span class="keyword">class</span> <a class="link" href="boost/contract/check.html" title="Class check">check</a><span class="special">;</span> 121 <span class="special">}</span> 122<span class="special">}</span></pre> 123</div> 124<div class="section"> 125<div class="titlepage"><div><div><h3 class="title"> 126<a name="header.boost.contract.constructor_hpp"></a>Header <<a href="../../../../boost/contract/constructor.hpp" target="_top">boost/contract/constructor.hpp</a>></h3></div></div></div> 127<p>Program contracts for constructors. </p> 128<pre class="synopsis"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span> 129 <span class="keyword">namespace</span> <span class="identifier">contract</span> <span class="special">{</span> 130 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Class<span class="special">></span> 131 <a class="link" href="boost/contract/specify__idm46268585058320.html" title="Class template specify_old_postcondition_except">specify_old_postcondition_except</a> <a class="link" href="boost/contract/constructor.html" title="Function template constructor"><span class="identifier">constructor</span></a><span class="special">(</span><span class="identifier">Class</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> 132 <span class="special">}</span> 133<span class="special">}</span></pre> 134</div> 135<div class="section"> 136<div class="titlepage"><div><div><h3 class="title"> 137<a name="header.boost.contract.core.access_hpp"></a>Header <<a href="../../../../boost/contract/core/access.hpp" target="_top">boost/contract/core/access.hpp</a>></h3></div></div></div> 138<p>Allow to declare invariants, base types, etc all as private members. </p> 139<pre class="synopsis"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span> 140 <span class="keyword">namespace</span> <span class="identifier">contract</span> <span class="special">{</span> 141 <span class="keyword">class</span> <a class="link" href="boost/contract/access.html" title="Class access">access</a><span class="special">;</span> 142 <span class="special">}</span> 143<span class="special">}</span></pre> 144</div> 145<div class="section"> 146<div class="titlepage"><div><div><h3 class="title"> 147<a name="header.boost.contract.core.check_macro_hpp"></a>Header <<a href="../../../../boost/contract/core/check_macro.hpp" target="_top">boost/contract/core/check_macro.hpp</a>></h3></div></div></div> 148<p>Macros for implementation checks. </p> 149<pre class="synopsis"> 150 151<a class="link" href="BOOST_CONTRACT_CHECK.html" title="Macro BOOST_CONTRACT_CHECK">BOOST_CONTRACT_CHECK</a>(cond) 152<a class="link" href="BOOST_CONTRACT_CHECK_AUDIT.html" title="Macro BOOST_CONTRACT_CHECK_AUDIT">BOOST_CONTRACT_CHECK_AUDIT</a>(cond) 153<a class="link" href="BOOST_CONTRACT_CHECK_AXIOM.html" title="Macro BOOST_CONTRACT_CHECK_AXIOM">BOOST_CONTRACT_CHECK_AXIOM</a>(cond)</pre> 154</div> 155<div class="section"> 156<div class="titlepage"><div><div><h3 class="title"> 157<a name="header.boost.contract.core.config_hpp"></a>Header <<a href="../../../../boost/contract/core/config.hpp" target="_top">boost/contract/core/config.hpp</a>></h3></div></div></div> 158<p>Configure this library compile-time and run-time behaviours. </p> 159<pre class="synopsis"> 160 161<a class="link" href="BOOST_CONTRACT_DYN_LINK.html" title="Macro BOOST_CONTRACT_DYN_LINK">BOOST_CONTRACT_DYN_LINK</a> 162<a class="link" href="BOOST_CONTRACT_STATIC_LINK.html" title="Macro BOOST_CONTRACT_STATIC_LINK">BOOST_CONTRACT_STATIC_LINK</a> 163<a class="link" href="BOOST_CONTRACT_HEADER_ONLY.html" title="Macro BOOST_CONTRACT_HEADER_ONLY">BOOST_CONTRACT_HEADER_ONLY</a> 164<a class="link" href="BOOST_CO_idm46268585556352.html" title="Macro BOOST_CONTRACT_DISABLE_THREADS">BOOST_CONTRACT_DISABLE_THREADS</a> 165<a class="link" href="BOOST_CONTRACT_MAX_ARGS.html" title="Macro BOOST_CONTRACT_MAX_ARGS">BOOST_CONTRACT_MAX_ARGS</a> 166<a class="link" href="BOOST_CO_idm46268585544864.html" title="Macro BOOST_CONTRACT_BASES_TYPEDEF">BOOST_CONTRACT_BASES_TYPEDEF</a> 167<a class="link" href="BOOST_CO_idm46268585536960.html" title="Macro BOOST_CONTRACT_INVARIANT_FUNC">BOOST_CONTRACT_INVARIANT_FUNC</a> 168<a class="link" href="BOOST_CO_idm46268585527232.html" title="Macro BOOST_CONTRACT_STATIC_INVARIANT_FUNC">BOOST_CONTRACT_STATIC_INVARIANT_FUNC</a> 169<a class="link" href="BOOST_CONTRACT_PERMISSIVE.html" title="Macro BOOST_CONTRACT_PERMISSIVE">BOOST_CONTRACT_PERMISSIVE</a> 170<a class="link" href="BOOST_CO_idm46268585506528.html" title="Macro BOOST_CONTRACT_ON_MISSING_CHECK_DECL">BOOST_CONTRACT_ON_MISSING_CHECK_DECL</a> 171<a class="link" href="BOOST_CO_idm46268585497648.html" title="Macro BOOST_CONTRACT_PRECONDITIONS_DISABLE_NO_ASSERTION">BOOST_CONTRACT_PRECONDITIONS_DISABLE_NO_ASSERTION</a> 172<a class="link" href="BOOST_CO_idm46268585491840.html" title="Macro BOOST_CONTRACT_ALL_DISABLE_NO_ASSERTION">BOOST_CONTRACT_ALL_DISABLE_NO_ASSERTION</a> 173<a class="link" href="BOOST_CONTRACT_AUDITS.html" title="Macro BOOST_CONTRACT_AUDITS">BOOST_CONTRACT_AUDITS</a> 174<a class="link" href="BOOST_CONTRACT_NO_CHECKS.html" title="Macro BOOST_CONTRACT_NO_CHECKS">BOOST_CONTRACT_NO_CHECKS</a> 175<a class="link" href="BOOST_CO_idm46268585474880.html" title="Macro BOOST_CONTRACT_NO_PRECONDITIONS">BOOST_CONTRACT_NO_PRECONDITIONS</a> 176<a class="link" href="BOOST_CO_idm46268585468496.html" title="Macro BOOST_CONTRACT_NO_POSTCONDITIONS">BOOST_CONTRACT_NO_POSTCONDITIONS</a> 177<a class="link" href="BOOST_CONTRACT_NO_EXCEPTS.html" title="Macro BOOST_CONTRACT_NO_EXCEPTS">BOOST_CONTRACT_NO_EXCEPTS</a> 178<a class="link" href="BOOST_CO_idm46268585449728.html" title="Macro BOOST_CONTRACT_NO_ENTRY_INVARIANTS">BOOST_CONTRACT_NO_ENTRY_INVARIANTS</a> 179<a class="link" href="BOOST_CO_idm46268585442112.html" title="Macro BOOST_CONTRACT_NO_EXIT_INVARIANTS">BOOST_CONTRACT_NO_EXIT_INVARIANTS</a> 180<a class="link" href="BOOST_CO_idm46268585434496.html" title="Macro BOOST_CONTRACT_NO_INVARIANTS">BOOST_CONTRACT_NO_INVARIANTS</a> 181<a class="link" href="BOOST_CONTRACT_NO_OLDS.html" title="Macro BOOST_CONTRACT_NO_OLDS">BOOST_CONTRACT_NO_OLDS</a> 182<a class="link" href="BOOST_CO_idm46268585417872.html" title="Macro BOOST_CONTRACT_NO_CONSTRUCTORS">BOOST_CONTRACT_NO_CONSTRUCTORS</a> 183<a class="link" href="BOOST_CO_idm46268585407008.html" title="Macro BOOST_CONTRACT_NO_DESTRUCTORS">BOOST_CONTRACT_NO_DESTRUCTORS</a> 184<a class="link" href="BOOST_CO_idm46268585398736.html" title="Macro BOOST_CONTRACT_NO_PUBLIC_FUNCTIONS">BOOST_CONTRACT_NO_PUBLIC_FUNCTIONS</a> 185<a class="link" href="BOOST_CO_idm46268585389536.html" title="Macro BOOST_CONTRACT_NO_FUNCTIONS">BOOST_CONTRACT_NO_FUNCTIONS</a> 186<a class="link" href="BOOST_CO_idm46268585379200.html" title="Macro BOOST_CONTRACT_NO_CONDITIONS">BOOST_CONTRACT_NO_CONDITIONS</a> 187<a class="link" href="BOOST_CONTRACT_NO_ALL.html" title="Macro BOOST_CONTRACT_NO_ALL">BOOST_CONTRACT_NO_ALL</a></pre> 188</div> 189<div class="section"> 190<div class="titlepage"><div><div><h3 class="title"> 191<a name="header.boost.contract.core.constructor_precondition_hpp"></a>Header <<a href="../../../../boost/contract/core/constructor_precondition.hpp" target="_top">boost/contract/core/constructor_precondition.hpp</a>></h3></div></div></div> 192<p>Program preconditions for constructors. </p> 193<pre class="synopsis"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span> 194 <span class="keyword">namespace</span> <span class="identifier">contract</span> <span class="special">{</span> 195 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Class<span class="special">></span> <span class="keyword">class</span> <a class="link" href="boost/contract/constructor_precondition.html" title="Class template constructor_precondition">constructor_precondition</a><span class="special">;</span> 196 <span class="special">}</span> 197<span class="special">}</span></pre> 198</div> 199<div class="section"> 200<div class="titlepage"><div><div><h3 class="title"> 201<a name="header.boost.contract.core.exception_hpp"></a>Header <<a href="../../../../boost/contract/core/exception.hpp" target="_top">boost/contract/core/exception.hpp</a>></h3></div></div></div> 202<p>Handle contract assertion failures. </p> 203<pre class="synopsis"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span> 204 <span class="keyword">namespace</span> <span class="identifier">contract</span> <span class="special">{</span> 205 <span class="keyword">class</span> <a class="link" href="boost/contract/assertion_failure.html" title="Class assertion_failure">assertion_failure</a><span class="special">;</span> 206 <span class="keyword">class</span> <a class="link" href="boost/contract/bad_virtual_result_cast.html" title="Class bad_virtual_result_cast">bad_virtual_result_cast</a><span class="special">;</span> 207 <span class="keyword">class</span> <a class="link" href="boost/contract/exception.html" title="Class exception">exception</a><span class="special">;</span> 208 209 <span class="keyword">enum</span> <a class="link" href="boost/contract/from.html" title="Type from">from</a><span class="special">;</span> 210 <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">function</span><span class="special"><</span> <span class="keyword">void</span><span class="special">(</span><span class="identifier">from</span><span class="special">)</span><span class="special">></span> <a class="link" href="boost/contract/from_failure_handler.html" title="Type definition from_failure_handler"><span class="identifier">from_failure_handler</span></a><span class="special">;</span> 211 <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">function</span><span class="special"><</span> <span class="keyword">void</span><span class="special">(</span><span class="special">)</span><span class="special">></span> <a class="link" href="boost/contract/failure_handler.html" title="Type definition failure_handler"><span class="identifier">failure_handler</span></a><span class="special">;</span> 212 <span class="identifier">failure_handler</span> <span class="keyword">const</span> <span class="special">&</span> <a class="link" href="boost/contract/set_check_failure.html" title="Function set_check_failure"><span class="identifier">set_check_failure</span></a><span class="special">(</span><span class="identifier">failure_handler</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 213 <span class="identifier">failure_handler</span> <a class="link" href="boost/contract/get_check_failure.html" title="Function get_check_failure"><span class="identifier">get_check_failure</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 214 <span class="keyword">void</span> <a class="link" href="boost/contract/check_failure.html" title="Function check_failure"><span class="identifier">check_failure</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 215 <span class="identifier">from_failure_handler</span> <span class="keyword">const</span> <span class="special">&</span> 216 <a class="link" href="boost/contract/set_precondition_failure.html" title="Function set_precondition_failure"><span class="identifier">set_precondition_failure</span></a><span class="special">(</span><span class="identifier">from_failure_handler</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 217 <span class="identifier">from_failure_handler</span> <a class="link" href="boost/contract/get_precondition_failure.html" title="Function get_precondition_failure"><span class="identifier">get_precondition_failure</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 218 <span class="keyword">void</span> <a class="link" href="boost/contract/precondition_failure.html" title="Function precondition_failure"><span class="identifier">precondition_failure</span></a><span class="special">(</span><span class="identifier">from</span><span class="special">)</span><span class="special">;</span> 219 <span class="identifier">from_failure_handler</span> <span class="keyword">const</span> <span class="special">&</span> 220 <a class="link" href="boost/contract/set_postcondition_failure.html" title="Function set_postcondition_failure"><span class="identifier">set_postcondition_failure</span></a><span class="special">(</span><span class="identifier">from_failure_handler</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 221 <span class="identifier">from_failure_handler</span> <a class="link" href="boost/contract/get_postcondition_failure.html" title="Function get_postcondition_failure"><span class="identifier">get_postcondition_failure</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 222 <span class="keyword">void</span> <a class="link" href="boost/contract/postcondition_failure.html" title="Function postcondition_failure"><span class="identifier">postcondition_failure</span></a><span class="special">(</span><span class="identifier">from</span><span class="special">)</span><span class="special">;</span> 223 <span class="identifier">from_failure_handler</span> <span class="keyword">const</span> <span class="special">&</span> 224 <a class="link" href="boost/contract/set_except_failure.html" title="Function set_except_failure"><span class="identifier">set_except_failure</span></a><span class="special">(</span><span class="identifier">from_failure_handler</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 225 <span class="identifier">from_failure_handler</span> <a class="link" href="boost/contract/get_except_failure.html" title="Function get_except_failure"><span class="identifier">get_except_failure</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 226 <span class="keyword">void</span> <a class="link" href="boost/contract/except_failure.html" title="Function except_failure"><span class="identifier">except_failure</span></a><span class="special">(</span><span class="identifier">from</span><span class="special">)</span><span class="special">;</span> 227 <span class="identifier">from_failure_handler</span> <span class="keyword">const</span> <span class="special">&</span> 228 <a class="link" href="boost/contract/set_old_failure.html" title="Function set_old_failure"><span class="identifier">set_old_failure</span></a><span class="special">(</span><span class="identifier">from_failure_handler</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 229 <span class="identifier">from_failure_handler</span> <a class="link" href="boost/contract/get_old_failure.html" title="Function get_old_failure"><span class="identifier">get_old_failure</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 230 <span class="keyword">void</span> <a class="link" href="boost/contract/old_failure.html" title="Function old_failure"><span class="identifier">old_failure</span></a><span class="special">(</span><span class="identifier">from</span><span class="special">)</span><span class="special">;</span> 231 <span class="identifier">from_failure_handler</span> <span class="keyword">const</span> <span class="special">&</span> 232 <a class="link" href="boost/contract/set_entr_idm46268585146336.html" title="Function set_entry_invariant_failure"><span class="identifier">set_entry_invariant_failure</span></a><span class="special">(</span><span class="identifier">from_failure_handler</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 233 <span class="identifier">from_failure_handler</span> <a class="link" href="boost/contract/get_entr_idm46268585136848.html" title="Function get_entry_invariant_failure"><span class="identifier">get_entry_invariant_failure</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 234 <span class="keyword">void</span> <a class="link" href="boost/contract/entry_invariant_failure.html" title="Function entry_invariant_failure"><span class="identifier">entry_invariant_failure</span></a><span class="special">(</span><span class="identifier">from</span><span class="special">)</span><span class="special">;</span> 235 <span class="identifier">from_failure_handler</span> <span class="keyword">const</span> <span class="special">&</span> 236 <a class="link" href="boost/contract/set_exit_invariant_failure.html" title="Function set_exit_invariant_failure"><span class="identifier">set_exit_invariant_failure</span></a><span class="special">(</span><span class="identifier">from_failure_handler</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 237 <span class="identifier">from_failure_handler</span> <a class="link" href="boost/contract/get_exit_invariant_failure.html" title="Function get_exit_invariant_failure"><span class="identifier">get_exit_invariant_failure</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 238 <span class="keyword">void</span> <a class="link" href="boost/contract/exit_invariant_failure.html" title="Function exit_invariant_failure"><span class="identifier">exit_invariant_failure</span></a><span class="special">(</span><span class="identifier">from</span><span class="special">)</span><span class="special">;</span> 239 <span class="identifier">from_failure_handler</span> <span class="keyword">const</span> <span class="special">&</span> 240 <a class="link" href="boost/contract/set_invariant_failure.html" title="Function set_invariant_failure"><span class="identifier">set_invariant_failure</span></a><span class="special">(</span><span class="identifier">from_failure_handler</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 241 <span class="special">}</span> 242<span class="special">}</span></pre> 243</div> 244<div class="section"> 245<div class="titlepage"><div><div><h3 class="title"> 246<a name="header.boost.contract.core.specify_hpp"></a>Header <<a href="../../../../boost/contract/core/specify.hpp" target="_top">boost/contract/core/specify.hpp</a>></h3></div></div></div> 247<p>Specify preconditions, old values copied at body, postconditions, and exception guarantees. </p> 248<p>Preconditions, old values copied at body, postconditions, and exception guarantees are all optionals but, when they are specified, they need to be specified in that order. </p> 249<pre class="synopsis"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span> 250 <span class="keyword">namespace</span> <span class="identifier">contract</span> <span class="special">{</span> 251 <span class="keyword">class</span> <a class="link" href="boost/contract/specify_except.html" title="Class specify_except">specify_except</a><span class="special">;</span> 252 <span class="keyword">class</span> <a class="link" href="boost/contract/specify_nothing.html" title="Class specify_nothing">specify_nothing</a><span class="special">;</span> 253 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> VirtualResult <span class="special">=</span> <span class="keyword">void</span><span class="special">></span> 254 <span class="keyword">class</span> <a class="link" href="boost/contract/specify__idm46268585058320.html" title="Class template specify_old_postcondition_except">specify_old_postcondition_except</a><span class="special">;</span> 255 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> VirtualResult <span class="special">=</span> <span class="keyword">void</span><span class="special">></span> <span class="keyword">class</span> <a class="link" href="boost/contract/specify__idm46268585020256.html" title="Class template specify_postcondition_except">specify_postcondition_except</a><span class="special">;</span> 256 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> VirtualResult <span class="special">=</span> <span class="keyword">void</span><span class="special">></span> 257 <span class="keyword">class</span> <a class="link" href="boost/contract/specify__idm46268584991504.html" title="Class template specify_precondition_old_postcondition_except">specify_precondition_old_postcondition_except</a><span class="special">;</span> 258 <span class="special">}</span> 259<span class="special">}</span></pre> 260</div> 261<div class="section"> 262<div class="titlepage"><div><div><h3 class="title"> 263<a name="header.boost.contract.core.virtual_hpp"></a>Header <<a href="../../../../boost/contract/core/virtual.hpp" target="_top">boost/contract/core/virtual.hpp</a>></h3></div></div></div> 264<p>Handle virtual public functions with contracts (for subcontracting). </p> 265<pre class="synopsis"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span> 266 <span class="keyword">namespace</span> <span class="identifier">contract</span> <span class="special">{</span> 267 <span class="keyword">class</span> <a class="link" href="boost/contract/virtual_.html" title="Class virtual_">virtual_</a><span class="special">;</span> 268 <span class="special">}</span> 269<span class="special">}</span></pre> 270</div> 271<div class="section"> 272<div class="titlepage"><div><div><h3 class="title"> 273<a name="header.boost.contract.destructor_hpp"></a>Header <<a href="../../../../boost/contract/destructor.hpp" target="_top">boost/contract/destructor.hpp</a>></h3></div></div></div> 274<p>Program contracts for destructors. </p> 275<pre class="synopsis"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span> 276 <span class="keyword">namespace</span> <span class="identifier">contract</span> <span class="special">{</span> 277 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Class<span class="special">></span> 278 <a class="link" href="boost/contract/specify__idm46268585058320.html" title="Class template specify_old_postcondition_except">specify_old_postcondition_except</a> <a class="link" href="boost/contract/destructor.html" title="Function template destructor"><span class="identifier">destructor</span></a><span class="special">(</span><span class="identifier">Class</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> 279 <span class="special">}</span> 280<span class="special">}</span></pre> 281</div> 282<div class="section"> 283<div class="titlepage"><div><div><h3 class="title"> 284<a name="header.boost.contract.function_hpp"></a>Header <<a href="../../../../boost/contract/function.hpp" target="_top">boost/contract/function.hpp</a>></h3></div></div></div> 285<p>Program contracts for (non-public) functions. </p> 286<pre class="synopsis"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span> 287 <span class="keyword">namespace</span> <span class="identifier">contract</span> <span class="special">{</span> 288 <a class="link" href="boost/contract/specify__idm46268584991504.html" title="Class template specify_precondition_old_postcondition_except">specify_precondition_old_postcondition_except</a> <a class="link" href="boost/contract/function.html" title="Function function"><span class="identifier">function</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 289 <span class="special">}</span> 290<span class="special">}</span></pre> 291</div> 292<div class="section"> 293<div class="titlepage"><div><div><h3 class="title"> 294<a name="header.boost.contract.old_hpp"></a>Header <<a href="../../../../boost/contract/old.hpp" target="_top">boost/contract/old.hpp</a>></h3></div></div></div> 295<p>Handle old values. </p> 296<pre class="synopsis"> 297 298<a class="link" href="BOOST_CONTRACT_OLDOF.html" title="Macro BOOST_CONTRACT_OLDOF">BOOST_CONTRACT_OLDOF</a>(...)</pre> 299<pre class="synopsis"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span> 300 <span class="keyword">namespace</span> <span class="identifier">contract</span> <span class="special">{</span> 301 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">struct</span> <a class="link" href="boost/contract/is_old_value_copyable.html" title="Struct template is_old_value_copyable">is_old_value_copyable</a><span class="special">;</span> 302 303 <span class="keyword">class</span> <a class="link" href="boost/contract/old_pointer.html" title="Class old_pointer">old_pointer</a><span class="special">;</span> 304 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">class</span> <a class="link" href="boost/contract/old_ptr.html" title="Class template old_ptr">old_ptr</a><span class="special">;</span> 305 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">class</span> <a class="link" href="boost/contract/old_ptr_if_copyable.html" title="Class template old_ptr_if_copyable">old_ptr_if_copyable</a><span class="special">;</span> 306 <span class="keyword">class</span> <a class="link" href="boost/contract/old_value.html" title="Class old_value">old_value</a><span class="special">;</span> 307 308 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">struct</span> <a class="link" href="boost/contract/old_value_copy.html" title="Struct template old_value_copy">old_value_copy</a><span class="special">;</span> 309 <a class="link" href="boost/contract/old_value.html" title="Class old_value">old_value</a> <a class="link" href="boost/contract/null_old.html" title="Function null_old"><span class="identifier">null_old</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 310 <a class="link" href="boost/contract/old_pointer.html" title="Class old_pointer">old_pointer</a> <a class="link" href="boost/contract/make_old_idm46268584781184.html" title="Function make_old"><span class="identifier">make_old</span></a><span class="special">(</span><a class="link" href="boost/contract/old_value.html" title="Class old_value">old_value</a> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 311 <a class="link" href="boost/contract/old_pointer.html" title="Class old_pointer">old_pointer</a> <a class="link" href="boost/contract/make_old_idm46268584770704.html" title="Function make_old"><span class="identifier">make_old</span></a><span class="special">(</span><a class="link" href="boost/contract/virtual_.html" title="Class virtual_">virtual_</a> <span class="special">*</span><span class="special">,</span> <a class="link" href="boost/contract/old_value.html" title="Class old_value">old_value</a> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 312 <span class="keyword">bool</span> <a class="link" href="boost/contract/copy_old_idm46268584757136.html" title="Function copy_old"><span class="identifier">copy_old</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 313 <span class="keyword">bool</span> <a class="link" href="boost/contract/copy_old_idm46268584750992.html" title="Function copy_old"><span class="identifier">copy_old</span></a><span class="special">(</span><a class="link" href="boost/contract/virtual_.html" title="Class virtual_">virtual_</a> <span class="special">*</span><span class="special">)</span><span class="special">;</span> 314 <span class="special">}</span> 315<span class="special">}</span></pre> 316</div> 317<div class="section"> 318<div class="titlepage"><div><div><h3 class="title"> 319<a name="header.boost.contract.override_hpp"></a>Header <<a href="../../../../boost/contract/override.hpp" target="_top">boost/contract/override.hpp</a>></h3></div></div></div> 320<p>Handle public function overrides (for subcontracting). </p> 321<pre class="synopsis"> 322 323<a class="link" href="BOOST_CO_idm46268584725152.html" title="Macro BOOST_CONTRACT_NAMED_OVERRIDE">BOOST_CONTRACT_NAMED_OVERRIDE</a>(type_name, func_name) 324<a class="link" href="BOOST_CONTRACT_OVERRIDE.html" title="Macro BOOST_CONTRACT_OVERRIDE">BOOST_CONTRACT_OVERRIDE</a>(func_name) 325<a class="link" href="BOOST_CONTRACT_OVERRIDES.html" title="Macro BOOST_CONTRACT_OVERRIDES">BOOST_CONTRACT_OVERRIDES</a>(...)</pre> 326</div> 327<div class="section"> 328<div class="titlepage"><div><div><h3 class="title"> 329<a name="header.boost.contract.public_function_hpp"></a>Header <<a href="../../../../boost/contract/public_function.hpp" target="_top">boost/contract/public_function.hpp</a>></h3></div></div></div> 330<p>Program contracts for public functions (including subcontracting). </p> 331<p>The different overloads handle public functions that are static, virtual void, virtual non-void, overriding void, and overriding non-void. </p> 332<pre class="synopsis"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span> 333 <span class="keyword">namespace</span> <span class="identifier">contract</span> <span class="special">{</span> 334 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Class<span class="special">></span> 335 <a class="link" href="boost/contract/specify__idm46268584991504.html" title="Class template specify_precondition_old_postcondition_except">specify_precondition_old_postcondition_except</a> <a class="link" href="boost/contract/public_f_idm46268584697584.html" title="Function template public_function"><span class="identifier">public_function</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 336 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Class<span class="special">></span> 337 <a class="link" href="boost/contract/specify__idm46268584991504.html" title="Class template specify_precondition_old_postcondition_except">specify_precondition_old_postcondition_except</a> <a class="link" href="boost/contract/public_f_idm46268584686688.html" title="Function template public_function"><span class="identifier">public_function</span></a><span class="special">(</span><span class="identifier">Class</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> 338 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Class<span class="special">></span> 339 <a class="link" href="boost/contract/specify__idm46268584991504.html" title="Class template specify_precondition_old_postcondition_except">specify_precondition_old_postcondition_except</a> 340 <a class="link" href="boost/contract/public_f_idm46268584672400.html" title="Function template public_function"><span class="identifier">public_function</span></a><span class="special">(</span><a class="link" href="boost/contract/virtual_.html" title="Class virtual_">virtual_</a> <span class="special">*</span><span class="special">,</span> <span class="identifier">Class</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> 341 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> VirtualResult<span class="special">,</span> <span class="keyword">typename</span> Class<span class="special">></span> 342 <a class="link" href="boost/contract/specify__idm46268584991504.html" title="Class template specify_precondition_old_postcondition_except">specify_precondition_old_postcondition_except</a><span class="special"><</span> <span class="identifier">VirtualResult</span> <span class="special">></span> 343 <a class="link" href="boost/contract/public_f_idm46268584653760.html" title="Function template public_function"><span class="identifier">public_function</span></a><span class="special">(</span><a class="link" href="boost/contract/virtual_.html" title="Class virtual_">virtual_</a> <span class="special">*</span><span class="special">,</span> <span class="identifier">VirtualResult</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">Class</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> 344 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Override<span class="special">,</span> <span class="keyword">typename</span> F<span class="special">,</span> <span class="keyword">typename</span> Class<span class="special">,</span> <span class="keyword">typename</span><span class="special">...</span> Args<span class="special">></span> 345 <a class="link" href="boost/contract/specify__idm46268584991504.html" title="Class template specify_precondition_old_postcondition_except">specify_precondition_old_postcondition_except</a> 346 <a class="link" href="boost/contract/public_f_idm46268584629952.html" title="Function template public_function"><span class="identifier">public_function</span></a><span class="special">(</span><a class="link" href="boost/contract/virtual_.html" title="Class virtual_">virtual_</a> <span class="special">*</span><span class="special">,</span> <span class="identifier">F</span><span class="special">,</span> <span class="identifier">Class</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">Args</span> <span class="special">&</span><span class="special">...</span><span class="special">)</span><span class="special">;</span> 347 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Override<span class="special">,</span> <span class="keyword">typename</span> VirtualResult<span class="special">,</span> <span class="keyword">typename</span> F<span class="special">,</span> 348 <span class="keyword">typename</span> Class<span class="special">,</span> <span class="keyword">typename</span><span class="special">...</span> Args<span class="special">></span> 349 <a class="link" href="boost/contract/specify__idm46268584991504.html" title="Class template specify_precondition_old_postcondition_except">specify_precondition_old_postcondition_except</a><span class="special"><</span> <span class="identifier">VirtualResult</span> <span class="special">></span> 350 <a class="link" href="boost/contract/public_f_idm46268584599824.html" title="Function template public_function"><span class="identifier">public_function</span></a><span class="special">(</span><a class="link" href="boost/contract/virtual_.html" title="Class virtual_">virtual_</a> <span class="special">*</span><span class="special">,</span> <span class="identifier">VirtualResult</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">F</span><span class="special">,</span> <span class="identifier">Class</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">Args</span> <span class="special">&</span><span class="special">...</span><span class="special">)</span><span class="special">;</span> 351 <span class="special">}</span> 352<span class="special">}</span></pre> 353</div> 354<div class="section"> 355<div class="titlepage"><div><div><h3 class="title"> 356<a name="header.boost.contract_macro_hpp"></a>Header <<a href="../../../../boost/contract_macro.hpp" target="_top">boost/contract_macro.hpp</a>></h3></div></div></div> 357<p>Allow to disable contracts to completely remove their compile-time and run-time overhead. </p> 358<p>This header automatically includes all header files <code class="computeroutput">boost/contract/*.hpp</code> necessary to use its macros.</p> 359<p>Almost all the macros defined in this header file are variadic macros. On compilers that do not support variadic macros, programmers can manually code <code class="computeroutput">#ifndef BOOST_CONTRACT_NO_...</code> statements instead (see <a class="link" href="boost_contract/extras.html#boost_contract.extras.disable_contract_compilation__macro_interface_" title="Disable Contract Compilation (Macro Interface)"> 360Disable Contract Compilation</a>). </p> 361<pre class="synopsis"> 362 363<a class="link" href="BOOST_CO_idm46268584560672.html" title="Macro BOOST_CONTRACT_PRECONDITION">BOOST_CONTRACT_PRECONDITION</a>(...) 364<a class="link" href="BOOST_CO_idm46268584548992.html" title="Macro BOOST_CONTRACT_POSTCONDITION">BOOST_CONTRACT_POSTCONDITION</a>(...) 365<a class="link" href="BOOST_CONTRACT_EXCEPT.html" title="Macro BOOST_CONTRACT_EXCEPT">BOOST_CONTRACT_EXCEPT</a>(...) 366<a class="link" href="BOOST_CONTRACT_OLD.html" title="Macro BOOST_CONTRACT_OLD">BOOST_CONTRACT_OLD</a>(...) 367<a class="link" href="BOOST_CONTRACT_OLD_PTR.html" title="Macro BOOST_CONTRACT_OLD_PTR">BOOST_CONTRACT_OLD_PTR</a>(...) 368<a class="link" href="BOOST_CO_idm46268584486544.html" title="Macro BOOST_CONTRACT_OLD_PTR_IF_COPYABLE">BOOST_CONTRACT_OLD_PTR_IF_COPYABLE</a>(...) 369<a class="link" href="BOOST_CONTRACT_INVARIANT.html" title="Macro BOOST_CONTRACT_INVARIANT">BOOST_CONTRACT_INVARIANT</a>(...) 370<a class="link" href="BOOST_CO_idm46268584447792.html" title="Macro BOOST_CONTRACT_INVARIANT_VOLATILE">BOOST_CONTRACT_INVARIANT_VOLATILE</a>(...) 371<a class="link" href="BOOST_CO_idm46268584433936.html" title="Macro BOOST_CONTRACT_STATIC_INVARIANT">BOOST_CONTRACT_STATIC_INVARIANT</a>(...) 372<a class="link" href="BOOST_CONTRACT_CONSTRUCTOR.html" title="Macro BOOST_CONTRACT_CONSTRUCTOR">BOOST_CONTRACT_CONSTRUCTOR</a>(...) 373<a class="link" href="BOOST_CO_idm46268584400144.html" title="Macro BOOST_CONTRACT_CONSTRUCTOR_PRECONDITION">BOOST_CONTRACT_CONSTRUCTOR_PRECONDITION</a>(...) 374<a class="link" href="BOOST_CONTRACT_DESTRUCTOR.html" title="Macro BOOST_CONTRACT_DESTRUCTOR">BOOST_CONTRACT_DESTRUCTOR</a>(...) 375<a class="link" href="BOOST_CONTRACT_FUNCTION.html" title="Macro BOOST_CONTRACT_FUNCTION">BOOST_CONTRACT_FUNCTION</a>() 376<a class="link" href="BOOST_CO_idm46268584347456.html" title="Macro BOOST_CONTRACT_STATIC_PUBLIC_FUNCTION">BOOST_CONTRACT_STATIC_PUBLIC_FUNCTION</a>(...) 377<a class="link" href="BOOST_CO_idm46268584330448.html" title="Macro BOOST_CONTRACT_PUBLIC_FUNCTION">BOOST_CONTRACT_PUBLIC_FUNCTION</a>(...) 378<a class="link" href="BOOST_CO_idm46268584298528.html" title="Macro BOOST_CONTRACT_PUBLIC_FUNCTION_OVERRIDE">BOOST_CONTRACT_PUBLIC_FUNCTION_OVERRIDE</a>(...)</pre> 379</div> 380</div> 381<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 382<td align="left"></td> 383<td align="right"><div class="copyright-footer">Copyright © 2008-2019 Lorenzo Caminiti<p> 384 Distributed under the Boost Software License, Version 1.0 (see accompanying 385 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>) 386 </p> 387</div></td> 388</tr></table> 389<hr> 390<div class="spirit-nav"> 391<a accesskey="p" href="boost_contract/examples.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="index.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="BOOST_CONTRACT_ASSERT.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 392</div> 393</body> 394</html> 395
