Imported Upstream version 1.72.0
[platform/upstream/boost.git] / libs / contract / doc / html / boost / contract / old_ptr.html
index d1f4c5a..9b62937 100644 (file)
   <span class="keyword">typedef</span> <span class="identifier">T</span> <a name="boost.contract.old_ptr.element_type"></a><span class="identifier">element_type</span><span class="special">;</span>  <span class="comment">// Pointed old value type. </span>
 
   <span class="comment">// <a class="link" href="old_ptr.html#boost.contract.old_ptrconstruct-copy-destruct">construct/copy/destruct</a></span>
-  <a class="link" href="old_ptr.html#idm45123869905696-bb"><span class="identifier">old_ptr</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
+  <a class="link" href="old_ptr.html#idm45394999038400-bb"><span class="identifier">old_ptr</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
 
-  <span class="comment">// <a class="link" href="old_ptr.html#idm45123869920736-bb">public member functions</a></span>
-  <span class="identifier">T</span> <span class="keyword">const</span>  <span class="special">&amp;</span> <a class="link" href="old_ptr.html#idm45123869920176-bb"><span class="keyword">operator</span> <span class="special">*</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
-  <span class="identifier">T</span> <span class="keyword">const</span>  <span class="special">*</span><span class="keyword">const</span> <a class="link" href="old_ptr.html#idm45123869914592-bb"><span class="keyword">operator</span><span class="special">-&gt;</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
-  <span class="keyword">explicit</span> <a class="link" href="old_ptr.html#idm45123869908992-bb"><span class="keyword">operator</span> <span class="keyword">bool</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+  <span class="comment">// <a class="link" href="old_ptr.html#idm45394999053440-bb">public member functions</a></span>
+  <span class="identifier">T</span> <span class="keyword">const</span>  <span class="special">&amp;</span> <a class="link" href="old_ptr.html#idm45394999052880-bb"><span class="keyword">operator</span> <span class="special">*</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+  <span class="identifier">T</span> <span class="keyword">const</span>  <span class="special">*</span> <a class="link" href="old_ptr.html#idm45394999047296-bb"><span class="keyword">operator</span><span class="special">-&gt;</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+  <span class="keyword">explicit</span> <a class="link" href="old_ptr.html#idm45394999041712-bb"><span class="keyword">operator</span> <span class="keyword">bool</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
 <span class="special">}</span><span class="special">;</span></pre></div>
 <div class="refsect1">
-<a name="idm45751728143216"></a><h2>Description</h2>
-<p>This is set to point to an actual old value copy using either  <code class="computeroutput"><a class="link" href="../../BOOST_CONTRACT_OLDOF.html" title="Macro BOOST_CONTRACT_OLDOF">BOOST_CONTRACT_OLDOF</a></code> or <code class="computeroutput"><a class="link" href="make_old_idm45123869837456.html" title="Function make_old">boost::contract::make_old</a></code> (that is why this class does not have public non-default constructors):</p>
+<a name="idm45707994646640"></a><h2>Description</h2>
+<p>This pointer can be set to point an actual old value copy using either  <code class="computeroutput"><a class="link" href="../../BOOST_CONTRACT_OLDOF.html" title="Macro BOOST_CONTRACT_OLDOF">BOOST_CONTRACT_OLDOF</a></code> or <code class="computeroutput"><a class="link" href="make_old_idm45394998968720.html" title="Function make_old">boost::contract::make_old</a></code> (that is why this class does not have public non-default constructors):</p>
 <pre class="programlisting"><span class="keyword">class</span> <span class="identifier">u</span> <span class="special">{</span>
 <span class="keyword">public</span><span class="special">:</span>
     <span class="keyword">virtual</span> <span class="keyword">void</span> <span class="identifier">f</span><span class="special">(</span><span class="special">...</span><span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">contract</span><span class="special">::</span><span class="identifier">virtual_</span><span class="special">*</span> <span class="identifier">v</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span> <span class="special">{</span>
-        <span class="identifier">boost</span><span class="special">::</span><span class="identifier">contract</span><span class="special">::</span><span class="identifier">old_ptr</span><span class="special">&lt;</span><span class="identifier">old_type</span><span class="special">&gt;</span> <span class="identifier">old_var</span> <span class="special">=</span>
+        <span class="identifier">boost</span><span class="special">::</span><span class="identifier">contract</span><span class="special">::</span><span class="identifier">old_ptr</span><span class="special">&lt;</span><span class="identifier">old_type</span><span class="special">&gt;</span> <span class="identifier">old_var</span> <span class="special">=</span> <span class="comment">// For copyable `old_type`.</span>
                 <span class="identifier">BOOST_CONTRACT_OLDOF</span><span class="special">(</span><span class="identifier">v</span><span class="special">,</span> <span class="identifier">old_expr</span><span class="special">)</span><span class="special">;</span>
         <span class="special">...</span>
     <span class="special">}</span>
 
 </p>
 <div class="refsect2">
-<a name="idm45751728110752"></a><h3>Template Parameters</h3>
+<a name="idm45707994613520"></a><h3>Template Parameters</h3>
 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
 <pre class="literallayout"><span class="keyword">typename</span> T</pre>
-<p>Type of the pointed old value. This type must be copyable (i.e., <code class="computeroutput">boost::contract::is_old_value_copyable&lt;T&gt;::value</code> is <code class="computeroutput">true</code>), otherwise this pointer will always be null and this library will generate a compile-time error when the pointer is dereferenced. </p>
+<p>Type of the pointed old value. This type must be copyable (i.e., <code class="computeroutput">boost::contract::is_old_value_copyable&lt;T&gt;::value</code> must be <code class="computeroutput">true</code>), otherwise this pointer will always be null and this library will generate a compile-time error when the pointer is dereferenced. </p>
 </li></ol></div>
 </div>
 <div class="refsect2">
-<a name="idm45751728105968"></a><h3>
+<a name="idm45707994608736"></a><h3>
 <a name="boost.contract.old_ptrconstruct-copy-destruct"></a><code class="computeroutput">old_ptr</code> 
         public
        construct/copy/destruct</h3>
 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
-<pre class="literallayout"><a name="idm45123869905696-bb"></a><span class="identifier">old_ptr</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Construct this old value pointer as null. </li></ol></div>
+<pre class="literallayout"><a name="idm45394999038400-bb"></a><span class="identifier">old_ptr</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Construct this old value pointer as null. </li></ol></div>
 </div>
 <div class="refsect2">
-<a name="idm45751728099968"></a><h3>
-<a name="idm45123869920736-bb"></a><code class="computeroutput">old_ptr</code> public member functions</h3>
+<a name="idm45707994602672"></a><h3>
+<a name="idm45394999053440-bb"></a><code class="computeroutput">old_ptr</code> public member functions</h3>
 <div class="orderedlist"><ol class="orderedlist" type="1">
 <li class="listitem">
-<pre class="literallayout"><span class="identifier">T</span> <span class="keyword">const</span>  <span class="special">&amp;</span> <a name="idm45123869920176-bb"></a><span class="keyword">operator</span> <span class="special">*</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Dereference this old value pointer. <p>This will generate a run-time error if this pointer is null and a compile-time error if the pointed type <code class="computeroutput">T</code> is not copyable (i.e., if <code class="computeroutput">boost::contract::is_old_value_copyable&lt;T&gt;::value</code> is <code class="computeroutput">false</code>).</p>
+<pre class="literallayout"><span class="identifier">T</span> <span class="keyword">const</span>  <span class="special">&amp;</span> <a name="idm45394999052880-bb"></a><span class="keyword">operator</span> <span class="special">*</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Dereference this old value pointer. <p>This will generate a run-time error if this pointer is null and a compile-time error if the pointed type <code class="computeroutput">T</code> is not copyable (i.e., if <code class="computeroutput">boost::contract::is_old_value_copyable&lt;T&gt;::value</code> is <code class="computeroutput">false</code>).</p>
 <p>
 </p>
 <div class="variablelist"><table border="0" class="variablelist compact">
 </table></div>
 </li>
 <li class="listitem">
-<pre class="literallayout"><span class="identifier">T</span> <span class="keyword">const</span>  <span class="special">*</span><span class="keyword">const</span> <a name="idm45123869914592-bb"></a><span class="keyword">operator</span><span class="special">-&gt;</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Structure-dereference this old value pointer. <p>This will generate a compile-time error if the pointed type <code class="computeroutput">T</code> is not copyable (i.e., if <code class="computeroutput">boost::contract::is_old_value_copyable&lt;T&gt;::value</code> is <code class="computeroutput">false</code>).</p>
+<pre class="literallayout"><span class="identifier">T</span> <span class="keyword">const</span>  <span class="special">*</span> <a name="idm45394999047296-bb"></a><span class="keyword">operator</span><span class="special">-&gt;</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Structure-dereference this old value pointer. <p>This will generate a compile-time error if the pointed type <code class="computeroutput">T</code> is not copyable (i.e., if <code class="computeroutput">boost::contract::is_old_value_copyable&lt;T&gt;::value</code> is <code class="computeroutput">false</code>).</p>
 <p>
 </p>
 <div class="variablelist"><table border="0" class="variablelist compact">
 </colgroup>
 <tbody><tr>
 <td><p><span class="term">Returns:</span></p></td>
-<td><p>A pointer to the old value (null if this old value pointer is null). Contract assertions should not change the state of the program so this member function is <code class="computeroutput">const</code> and it returns the old value as a constant pointer to a constant object (see  <a class="link" href="../../boost_contract/contract_programming_overview.html#boost_contract.contract_programming_overview.constant_correctness" title="Constant-Correctness">
+<td><p>A pointer to the old value (null if this old value pointer is null). Contract assertions should not change the state of the program so this member function is <code class="computeroutput">const</code> and it returns the old value as a pointer to a constant object (see  <a class="link" href="../../boost_contract/contract_programming_overview.html#boost_contract.contract_programming_overview.constant_correctness" title="Constant-Correctness">
         Constant Correctness</a>). </p></td>
 </tr></tbody>
 </table></div>
 </li>
 <li class="listitem">
-<pre class="literallayout"><span class="keyword">explicit</span> <a name="idm45123869908992-bb"></a><span class="keyword">operator</span> <span class="keyword">bool</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Check if this old value pointer is null or not. <p>(This is implemented using safe-bool emulation on compilers that do not support C++11 explicit type conversion operators.)</p>
+<pre class="literallayout"><span class="keyword">explicit</span> <a name="idm45394999041712-bb"></a><span class="keyword">operator</span> <span class="keyword">bool</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Query if this old value pointer is null or not (safe-bool operator). <p>(This is implemented using safe-bool emulation on compilers that do not support C++11 explicit type conversion operators.)</p>
 <p>
 </p>
 <div class="variablelist"><table border="0" class="variablelist compact">
 </div>
 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 <td align="left"></td>
-<td align="right"><div class="copyright-footer">Copyright &#169; 2008-2018 Lorenzo Caminiti<p>
+<td align="right"><div class="copyright-footer">Copyright &#169; 2008-2019 Lorenzo Caminiti<p>
         Distributed under the Boost Software License, Version 1.0 (see accompanying
         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>)
       </p>