Imported Upstream version 1.72.0
[platform/upstream/boost.git] / libs / contract / doc / html / boost / contract / check.html
1 <html>
2 <head>
3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>Class check</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.check_hpp" title="Header &lt;boost/contract/check.hpp&gt;">
9 <link rel="prev" href="condition_if.html" title="Function template condition_if">
10 <link rel="next" href="constructor.html" title="Function template constructor">
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="condition_if.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html#header.boost.contract.check_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="constructor.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
24 </div>
25 <div class="refentry">
26 <a name="boost.contract.check"></a><div class="titlepage"></div>
27 <div class="refnamediv">
28 <h2><span class="refentrytitle">Class check</span></h2>
29 <p>boost::contract::check &#8212; RAII object that checks the contracts. </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.check_hpp" title="Header &lt;boost/contract/check.hpp&gt;">boost/contract/check.hpp</a>&gt;
33
34 </span>
35 <span class="keyword">class</span> <a class="link" href="check.html" title="Class check">check</a> <span class="special">{</span>
36 <span class="keyword">public</span><span class="special">:</span>
37   <span class="comment">// <a class="link" href="check.html#boost.contract.checkconstruct-copy-destruct">construct/copy/destruct</a></span>
38   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> F<span class="special">&gt;</span> <a class="link" href="check.html#idm45394999887520-bb"><span class="identifier">check</span></a><span class="special">(</span><span class="identifier">F</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
39   <a class="link" href="check.html#idm45394999880144-bb"><span class="identifier">check</span></a><span class="special">(</span><a class="link" href="check.html" title="Class check">check</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
40   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> VirtualResult<span class="special">&gt;</span> 
41     <a class="link" href="check.html#idm45394999877248-bb"><span class="identifier">check</span></a><span class="special">(</span><a class="link" href="specify__idm45394999179040.html" title="Class template specify_precondition_old_postcondition_except">specify_precondition_old_postcondition_except</a><span class="special">&lt;</span> <span class="identifier">VirtualResult</span> <span class="special">&gt;</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
42   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> VirtualResult<span class="special">&gt;</span> 
43     <a class="link" href="check.html#idm45394999867968-bb"><span class="identifier">check</span></a><span class="special">(</span><a class="link" href="specify__idm45394999245856.html" title="Class template specify_old_postcondition_except">specify_old_postcondition_except</a><span class="special">&lt;</span> <span class="identifier">VirtualResult</span> <span class="special">&gt;</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
44   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> VirtualResult<span class="special">&gt;</span> 
45     <a class="link" href="check.html#idm45394999856928-bb"><span class="identifier">check</span></a><span class="special">(</span><a class="link" href="specify__idm45394999207792.html" title="Class template specify_postcondition_except">specify_postcondition_except</a><span class="special">&lt;</span> <span class="identifier">VirtualResult</span> <span class="special">&gt;</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
46   <a class="link" href="check.html#idm45394999845840-bb"><span class="identifier">check</span></a><span class="special">(</span><a class="link" href="specify_except.html" title="Class specify_except">specify_except</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
47   <a class="link" href="check.html#idm45394999836656-bb"><span class="identifier">check</span></a><span class="special">(</span><a class="link" href="specify_nothing.html" title="Class specify_nothing">specify_nothing</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
48   <a class="link" href="check.html#idm45394999827456-bb"><span class="special">~</span><span class="identifier">check</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
49 <span class="special">}</span><span class="special">;</span></pre></div>
50 <div class="refsect1">
51 <a name="idm45707997461088"></a><h2>Description</h2>
52 <p>In general, when this object is constructed it checks class invariants at entry, preconditions, and makes old value copies at body. When it is destructed, it checks class invariants at exist, postconditions, and exception guarantees. This object enforces the following (see  <a class="link" href="../../boost_contract/contract_programming_overview.html" title="Contract Programming Overview"> Contract Programming Overview</a>):</p>
53 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
54 <li class="listitem"><p>Postconditions are checked only if the body does not throw an exception. </p></li>
55 <li class="listitem"><p>Exceptions guarantees are checked only if the body throws an exception. </p></li>
56 <li class="listitem"><p>Constructor entry never checks class invariants. </p></li>
57 <li class="listitem"><p>Destructor exit checks class invariants only if the body throws an exception (even if destructors should usually not be programmed to throw exceptions in C++ and they are implicitly declared <code class="computeroutput">noexcept</code> since C++11). </p></li>
58 <li class="listitem"><p>Static invariants are always checked at entry and exit (and regardless of the body throwing exceptions or not).</p></li>
59 </ul></div>
60 <p>
61 When used this way, this object is constructed and initialized to the return value of one of the contract functions <code class="computeroutput"><a class="link" href="function.html" title="Function function">boost::contract::function</a></code>,  <code class="computeroutput"><a class="link" href="constructor.html" title="Function template constructor">boost::contract::constructor</a></code>, <code class="computeroutput"><a class="link" href="destructor.html" title="Function template destructor">boost::contract::destructor</a></code>, or <code class="computeroutput"><a class="link" href="public_f_idm45394998885120.html" title="Function template public_function">boost::contract::public_function</a></code>. In addition to that, this object can be constructed from a nullary functor when it is used to program implementation checks.</p>
62 <p><span class="bold"><strong>See Also:</strong></span></p>
63 <p> <a class="link" href="../../boost_contract/tutorial.html" title="Tutorial"> Tutorial</a>,  <a class="link" href="../../boost_contract/advanced.html#boost_contract.advanced.implementation_checks" title="Implementation Checks"> Implementation Checks</a> </p>
64 <p>
65 </p>
66 <p>
67 </p>
68 <div class="refsect2">
69 <a name="idm45707997445984"></a><h3>
70 <a name="boost.contract.checkconstruct-copy-destruct"></a><code class="computeroutput">check</code> 
71         public
72        construct/copy/destruct</h3>
73 <div class="orderedlist"><ol class="orderedlist" type="1">
74 <li class="listitem">
75 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> F<span class="special">&gt;</span> <a name="idm45394999887520-bb"></a><span class="identifier">check</span><span class="special">(</span><span class="identifier">F</span> <span class="keyword">const</span> <span class="special">&amp;</span> f<span class="special">)</span><span class="special">;</span></pre>Construct this object for implementation checks. <p>This can be used to program checks within implementation code (body, etc.). This constructor is not declared <code class="computeroutput">explicit</code> so initializations can use assignment syntax <code class="computeroutput">=</code>.</p>
76 <p><span class="bold"><strong>Throws:</strong></span> This can throw in case programmers specify contract failure handlers that throw exceptions instead of terminating the program (see  <a class="link" href="../../boost_contract/advanced.html#boost_contract.advanced.throw_on_failures__and__noexcept__" title="Throw on Failures (and noexcept)">
77             Throw on Failure</a>).</p>
78 <p>
79 </p>
80 <div class="variablelist"><table border="0" class="variablelist compact">
81 <colgroup>
82 <col align="left" valign="top">
83 <col>
84 </colgroup>
85 <tbody><tr>
86 <td><p><span class="term">Parameters:</span></p></td>
87 <td><div class="variablelist"><table border="0" class="variablelist compact">
88 <colgroup>
89 <col align="left" valign="top">
90 <col>
91 </colgroup>
92 <tbody><tr>
93 <td><p><span class="term"><code class="computeroutput">f</code></span></p></td>
94 <td><p>Nullary functor that asserts implementation checks. <code class="computeroutput">f()</code> will be called as soon as this object is constructed at the point it is declared within the implementation code (see  <a class="link" href="../../boost_contract/advanced.html#boost_contract.advanced.implementation_checks" title="Implementation Checks">
95             Implementation Checks</a>). </p></td>
96 </tr></tbody>
97 </table></div></td>
98 </tr></tbody>
99 </table></div>
100 </li>
101 <li class="listitem">
102 <pre class="literallayout"><a name="idm45394999880144-bb"></a><span class="identifier">check</span><span class="special">(</span><a class="link" href="check.html" title="Class check">check</a> <span class="keyword">const</span> <span class="special">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre>Construct this object copying it from the specified one. <p>This object will check the contract, the copied-from object will not (i.e., contract check ownership is transferred from the copied object to the new object being created by this constructor).</p>
103 <p>
104 </p>
105 <div class="variablelist"><table border="0" class="variablelist compact">
106 <colgroup>
107 <col align="left" valign="top">
108 <col>
109 </colgroup>
110 <tbody><tr>
111 <td><p><span class="term">Parameters:</span></p></td>
112 <td><div class="variablelist"><table border="0" class="variablelist compact">
113 <colgroup>
114 <col align="left" valign="top">
115 <col>
116 </colgroup>
117 <tbody><tr>
118 <td><p><span class="term"><code class="computeroutput">other</code></span></p></td>
119 <td><p>Copied-from object. </p></td>
120 </tr></tbody>
121 </table></div></td>
122 </tr></tbody>
123 </table></div>
124 </li>
125 <li class="listitem">
126 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> VirtualResult<span class="special">&gt;</span> 
127   <a name="idm45394999877248-bb"></a><span class="identifier">check</span><span class="special">(</span><a class="link" href="specify__idm45394999179040.html" title="Class template specify_precondition_old_postcondition_except">specify_precondition_old_postcondition_except</a><span class="special">&lt;</span> <span class="identifier">VirtualResult</span> <span class="special">&gt;</span> <span class="keyword">const</span> <span class="special">&amp;</span> contract<span class="special">)</span><span class="special">;</span></pre>Construct this object to check the specified contract. <p>This checks class invariants at entry (if those were specified for the given contract). This constructor is not declared <code class="computeroutput">explicit</code> so initializations can use assignment syntax <code class="computeroutput">=</code>.</p>
128 <p><span class="bold"><strong>Throws:</strong></span> This can throw in case programmers specify contract failure handlers that throw exceptions instead of terminating the program (see  <a class="link" href="../../boost_contract/advanced.html#boost_contract.advanced.throw_on_failures__and__noexcept__" title="Throw on Failures (and noexcept)">
129             Throw on Failure</a>).</p>
130 <p>
131
132 </p>
133 <div class="variablelist"><table border="0" class="variablelist compact">
134 <colgroup>
135 <col align="left" valign="top">
136 <col>
137 </colgroup>
138 <tbody>
139 <tr>
140 <td><p><span class="term">Parameters:</span></p></td>
141 <td><div class="variablelist"><table border="0" class="variablelist compact">
142 <colgroup>
143 <col align="left" valign="top">
144 <col>
145 </colgroup>
146 <tbody><tr>
147 <td><p><span class="term"><code class="computeroutput">contract</code></span></p></td>
148 <td><p>Contract to be checked (usually the return value of  <code class="computeroutput"><code class="computeroutput"><a class="link" href="function.html" title="Function function">boost::contract::function</a></code></code> or  <code class="computeroutput"><code class="computeroutput"><a class="link" href="public_f_idm45394998885120.html" title="Function template public_function">boost::contract::public_function</a></code></code>).</p></td>
149 </tr></tbody>
150 </table></div></td>
151 </tr>
152 <tr>
153 <td><p><span class="term">Template Parameters:</span></p></td>
154 <td><div class="variablelist"><table border="0" class="variablelist compact">
155 <colgroup>
156 <col align="left" valign="top">
157 <col>
158 </colgroup>
159 <tbody><tr>
160 <td><p><span class="term"><code class="computeroutput">VirtualResult</code></span></p></td>
161 <td><p>Return type of the enclosing function declaring the contract if that is either a virtual or an overriding public function, otherwise this is always <code class="computeroutput">void</code>. (Usually this template parameter is automatically deduced by C++ and it does not need to be explicitly specified by programmers.) </p></td>
162 </tr></tbody>
163 </table></div></td>
164 </tr>
165 </tbody>
166 </table></div>
167 </li>
168 <li class="listitem">
169 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> VirtualResult<span class="special">&gt;</span> 
170   <a name="idm45394999867968-bb"></a><span class="identifier">check</span><span class="special">(</span><a class="link" href="specify__idm45394999245856.html" title="Class template specify_old_postcondition_except">specify_old_postcondition_except</a><span class="special">&lt;</span> <span class="identifier">VirtualResult</span> <span class="special">&gt;</span> <span class="keyword">const</span> <span class="special">&amp;</span> contract<span class="special">)</span><span class="special">;</span></pre>Construct this object to check the specified contract. <p>This checks class invariants at entry and preconditions (if any of those were specified for the given contract). This constructor is not declared <code class="computeroutput">explicit</code> so initializations can use assignment syntax <code class="computeroutput">=</code>.</p>
171 <p><span class="bold"><strong>Throws:</strong></span> This can throw in case programmers specify contract failure handlers that throw exceptions instead of terminating the program (see  <a class="link" href="../../boost_contract/advanced.html#boost_contract.advanced.throw_on_failures__and__noexcept__" title="Throw on Failures (and noexcept)">
172             Throw on Failure</a>).</p>
173 <p>
174
175 </p>
176 <div class="variablelist"><table border="0" class="variablelist compact">
177 <colgroup>
178 <col align="left" valign="top">
179 <col>
180 </colgroup>
181 <tbody>
182 <tr>
183 <td><p><span class="term">Parameters:</span></p></td>
184 <td><div class="variablelist"><table border="0" class="variablelist compact">
185 <colgroup>
186 <col align="left" valign="top">
187 <col>
188 </colgroup>
189 <tbody><tr>
190 <td><p><span class="term"><code class="computeroutput">contract</code></span></p></td>
191 <td><p>Contract to be checked (usually the return value of  <code class="computeroutput"><code class="computeroutput"><a class="link" href="function.html" title="Function function">boost::contract::function</a></code></code>,  <code class="computeroutput"><code class="computeroutput"><a class="link" href="constructor.html" title="Function template constructor">boost::contract::constructor</a></code></code>,  <code class="computeroutput"><code class="computeroutput"><a class="link" href="destructor.html" title="Function template destructor">boost::contract::destructor</a></code></code>, or  <code class="computeroutput"><code class="computeroutput"><a class="link" href="public_f_idm45394998885120.html" title="Function template public_function">boost::contract::public_function</a></code></code>).</p></td>
192 </tr></tbody>
193 </table></div></td>
194 </tr>
195 <tr>
196 <td><p><span class="term">Template Parameters:</span></p></td>
197 <td><div class="variablelist"><table border="0" class="variablelist compact">
198 <colgroup>
199 <col align="left" valign="top">
200 <col>
201 </colgroup>
202 <tbody><tr>
203 <td><p><span class="term"><code class="computeroutput">VirtualResult</code></span></p></td>
204 <td><p>Return type of the enclosing function declaring the contract if that is either a virtual or an overriding public function, otherwise this is always <code class="computeroutput">void</code>. (Usually this template parameter is automatically deduced by C++ and it does not need to be explicitly specified by programmers.) </p></td>
205 </tr></tbody>
206 </table></div></td>
207 </tr>
208 </tbody>
209 </table></div>
210 </li>
211 <li class="listitem">
212 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> VirtualResult<span class="special">&gt;</span> 
213   <a name="idm45394999856928-bb"></a><span class="identifier">check</span><span class="special">(</span><a class="link" href="specify__idm45394999207792.html" title="Class template specify_postcondition_except">specify_postcondition_except</a><span class="special">&lt;</span> <span class="identifier">VirtualResult</span> <span class="special">&gt;</span> <span class="keyword">const</span> <span class="special">&amp;</span> contract<span class="special">)</span><span class="special">;</span></pre>Construct this object to check the specified contract. <p>This checks class invariants at entry and preconditions then it makes old value copies at body (if any of those were specified for the given contract). This constructor is not declared <code class="computeroutput">explicit</code> so initializations can use assignment syntax <code class="computeroutput">=</code>.</p>
214 <p><span class="bold"><strong>Throws:</strong></span> This can throw in case programmers specify contract failure handlers that throw exceptions instead of terminating te program (see  <a class="link" href="../../boost_contract/advanced.html#boost_contract.advanced.throw_on_failures__and__noexcept__" title="Throw on Failures (and noexcept)">
215             Throw on Failure</a>).</p>
216 <p>
217
218 </p>
219 <div class="variablelist"><table border="0" class="variablelist compact">
220 <colgroup>
221 <col align="left" valign="top">
222 <col>
223 </colgroup>
224 <tbody>
225 <tr>
226 <td><p><span class="term">Parameters:</span></p></td>
227 <td><div class="variablelist"><table border="0" class="variablelist compact">
228 <colgroup>
229 <col align="left" valign="top">
230 <col>
231 </colgroup>
232 <tbody><tr>
233 <td><p><span class="term"><code class="computeroutput">contract</code></span></p></td>
234 <td><p>Contract to be checked (usually the return value of  <code class="computeroutput"><code class="computeroutput"><a class="link" href="function.html" title="Function function">boost::contract::function</a></code></code>,  <code class="computeroutput"><code class="computeroutput"><a class="link" href="constructor.html" title="Function template constructor">boost::contract::constructor</a></code></code>,  <code class="computeroutput"><code class="computeroutput"><a class="link" href="destructor.html" title="Function template destructor">boost::contract::destructor</a></code></code>, or  <code class="computeroutput"><code class="computeroutput"><a class="link" href="public_f_idm45394998885120.html" title="Function template public_function">boost::contract::public_function</a></code></code>).</p></td>
235 </tr></tbody>
236 </table></div></td>
237 </tr>
238 <tr>
239 <td><p><span class="term">Template Parameters:</span></p></td>
240 <td><div class="variablelist"><table border="0" class="variablelist compact">
241 <colgroup>
242 <col align="left" valign="top">
243 <col>
244 </colgroup>
245 <tbody><tr>
246 <td><p><span class="term"><code class="computeroutput">VirtualResult</code></span></p></td>
247 <td><p>Return type of the enclosing function declaring the contract if that is either a virtual or an overriding public function, otherwise this is always <code class="computeroutput">void</code>. (Usually this template parameter is automatically deduced by C++ and it does not need to be explicitly specified by programmers.) </p></td>
248 </tr></tbody>
249 </table></div></td>
250 </tr>
251 </tbody>
252 </table></div>
253 </li>
254 <li class="listitem">
255 <pre class="literallayout"><a name="idm45394999845840-bb"></a><span class="identifier">check</span><span class="special">(</span><a class="link" href="specify_except.html" title="Class specify_except">specify_except</a> <span class="keyword">const</span> <span class="special">&amp;</span> contract<span class="special">)</span><span class="special">;</span></pre>Construct this object to check the specified contract. <p>This checks class invariants at entry and preconditions then it makes old value copies at body, plus the destructor of this object will also check postconditions in this case (if any of those were specified for the given contract). This constructor is not declared <code class="computeroutput">explicit</code> so initializations can use assignment syntax <code class="computeroutput">=</code>.</p>
256 <p><span class="bold"><strong>Throws:</strong></span> This can throw in case programmers specify contract failure handlers that throw exceptions instead of terminating the program (see  <a class="link" href="../../boost_contract/advanced.html#boost_contract.advanced.throw_on_failures__and__noexcept__" title="Throw on Failures (and noexcept)">
257             Throw on Failure</a>).</p>
258 <p>
259
260 </p>
261 <div class="variablelist"><table border="0" class="variablelist compact">
262 <colgroup>
263 <col align="left" valign="top">
264 <col>
265 </colgroup>
266 <tbody><tr>
267 <td><p><span class="term">Parameters:</span></p></td>
268 <td><div class="variablelist"><table border="0" class="variablelist compact">
269 <colgroup>
270 <col align="left" valign="top">
271 <col>
272 </colgroup>
273 <tbody><tr>
274 <td><p><span class="term"><code class="computeroutput">contract</code></span></p></td>
275 <td><p>Contract to be checked (usually the return value of  <code class="computeroutput"><code class="computeroutput"><a class="link" href="function.html" title="Function function">boost::contract::function</a></code></code>,  <code class="computeroutput"><code class="computeroutput"><a class="link" href="constructor.html" title="Function template constructor">boost::contract::constructor</a></code></code>,  <code class="computeroutput"><code class="computeroutput"><a class="link" href="destructor.html" title="Function template destructor">boost::contract::destructor</a></code></code>, or  <code class="computeroutput"><code class="computeroutput"><a class="link" href="public_f_idm45394998885120.html" title="Function template public_function">boost::contract::public_function</a></code></code>).</p></td>
276 </tr></tbody>
277 </table></div></td>
278 </tr></tbody>
279 </table></div>
280 </li>
281 <li class="listitem">
282 <pre class="literallayout"><a name="idm45394999836656-bb"></a><span class="identifier">check</span><span class="special">(</span><a class="link" href="specify_nothing.html" title="Class specify_nothing">specify_nothing</a> <span class="keyword">const</span> <span class="special">&amp;</span> contract<span class="special">)</span><span class="special">;</span></pre>Construct this object to check the specified contract. <p>This checks class invariants at entry and preconditions then it makes old value copies at body, plus the destructor of this object will also check postconditions and exception guarantees in this case (if any of those were specified for the given contract). This constructor is not declared <code class="computeroutput">explicit</code> so initializations can use assignment syntax <code class="computeroutput">=</code>.</p>
283 <p><span class="bold"><strong>Throws:</strong></span> This can throw in case programmers specify contract failure handlers that throw exceptions instead of terminating the program (see  <a class="link" href="../../boost_contract/advanced.html#boost_contract.advanced.throw_on_failures__and__noexcept__" title="Throw on Failures (and noexcept)">
284             Throw on Failure</a>).</p>
285 <p>
286
287 </p>
288 <div class="variablelist"><table border="0" class="variablelist compact">
289 <colgroup>
290 <col align="left" valign="top">
291 <col>
292 </colgroup>
293 <tbody><tr>
294 <td><p><span class="term">Parameters:</span></p></td>
295 <td><div class="variablelist"><table border="0" class="variablelist compact">
296 <colgroup>
297 <col align="left" valign="top">
298 <col>
299 </colgroup>
300 <tbody><tr>
301 <td><p><span class="term"><code class="computeroutput">contract</code></span></p></td>
302 <td><p>Contract to be checked (usually the return value of  <code class="computeroutput"><code class="computeroutput"><a class="link" href="function.html" title="Function function">boost::contract::function</a></code></code>,  <code class="computeroutput"><code class="computeroutput"><a class="link" href="constructor.html" title="Function template constructor">boost::contract::constructor</a></code></code>,  <code class="computeroutput"><code class="computeroutput"><a class="link" href="destructor.html" title="Function template destructor">boost::contract::destructor</a></code></code>, or  <code class="computeroutput"><code class="computeroutput"><a class="link" href="public_f_idm45394998885120.html" title="Function template public_function">boost::contract::public_function</a></code></code>).</p></td>
303 </tr></tbody>
304 </table></div></td>
305 </tr></tbody>
306 </table></div>
307 </li>
308 <li class="listitem">
309 <pre class="literallayout"><a name="idm45394999827456-bb"></a><span class="special">~</span><span class="identifier">check</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Destruct this object. <p>This checks class invariants at exit and either postconditions when the enclosing function body did not throw an exception, or exception guarantees when the function body threw an exception (if class invariants, postconditions, and exception guarantees respectively were specified for the enclosing class and the contract parameter given when constructing this object).</p>
310 <p><span class="bold"><strong>Throws:</strong></span> This can throw in case programmers specify contract failure handlers that throw exceptions instead of terminating the program (see  <a class="link" href="../../boost_contract/advanced.html#boost_contract.advanced.throw_on_failures__and__noexcept__" title="Throw on Failures (and noexcept)">
311             Throw on Failure</a>). (This is declared <code class="computeroutput">noexcept(false)</code> since C++11.) </p>
312 </li>
313 </ol></div>
314 </div>
315 </div>
316 </div>
317 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
318 <td align="left"></td>
319 <td align="right"><div class="copyright-footer">Copyright &#169; 2008-2019 Lorenzo Caminiti<p>
320         Distributed under the Boost Software License, Version 1.0 (see accompanying
321         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>)
322       </p>
323 </div></td>
324 </tr></table>
325 <hr>
326 <div class="spirit-nav">
327 <a accesskey="p" href="condition_if.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html#header.boost.contract.check_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="constructor.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
328 </div>
329 </body>
330 </html>