Imported Upstream version 1.72.0
[platform/upstream/boost.git] / libs / contract / doc / html / boost / contract / old_ptr_if_copyable.html
index 657fd3e..a94c1a3 100644 (file)
   <span class="keyword">typedef</span> <span class="identifier">T</span> <a name="boost.contract.old_ptr_if_copyable.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_if_copyable.html#boost.contract.old_ptr_if_copyableconstruct-copy-destruct">construct/copy/destruct</a></span>
-  <a class="link" href="old_ptr_if_copyable.html#idm45123869880480-bb"><span class="identifier">old_ptr_if_copyable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
-  <a class="link" href="old_ptr_if_copyable.html#idm45123869879872-bb"><span class="identifier">old_ptr_if_copyable</span></a><span class="special">(</span><a class="link" href="old_ptr.html" title="Class template old_ptr">old_ptr</a><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
+  <a class="link" href="old_ptr_if_copyable.html#idm45394999013184-bb"><span class="identifier">old_ptr_if_copyable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
+  <a class="link" href="old_ptr_if_copyable.html#idm45394999012576-bb"><span class="identifier">old_ptr_if_copyable</span></a><span class="special">(</span><a class="link" href="old_ptr.html" title="Class template old_ptr">old_ptr</a><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
 
-  <span class="comment">// <a class="link" href="old_ptr_if_copyable.html#idm45123869895568-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_if_copyable.html#idm45123869895008-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_if_copyable.html#idm45123869889408-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_if_copyable.html#idm45123869883792-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_if_copyable.html#idm45394999028256-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_if_copyable.html#idm45394999027696-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_if_copyable.html#idm45394999022096-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_if_copyable.html#idm45394999016496-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="idm45751728016592"></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>:</p>
+<a name="idm45707994520144"></a><h2>Description</h2>
+<p>This pointer can be 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_idm45394998968720.html" title="Function make_old">boost::contract::make_old</a></code>:</p>
 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">T</span><span class="special">&gt;</span> <span class="comment">// Type `T` might or not be copyable.</span>
 <span class="keyword">class</span> <span class="identifier">u</span> <span class="special">{</span>
 <span class="keyword">public</span><span class="special">:</span>
 
 </p>
 <div class="refsect2">
-<a name="idm45751727976128"></a><h3>Template Parameters</h3>
+<a name="idm45707994479808"></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. If this type is not copyable (i.e., <code class="computeroutput">boost::contract::is_old_value_copyable&lt;T&gt;::value</code> is <code class="computeroutput">false</code>), this pointer will always be null (but this library will not generate a compile-time error when this pointer is dereferenced). </p>
 </li></ol></div>
 </div>
 <div class="refsect2">
-<a name="idm45751727971424"></a><h3>
+<a name="idm45707994475104"></a><h3>
 <a name="boost.contract.old_ptr_if_copyableconstruct-copy-destruct"></a><code class="computeroutput">old_ptr_if_copyable</code> 
         public
        construct/copy/destruct</h3>
 <div class="orderedlist"><ol class="orderedlist" type="1">
 <li class="listitem">
-<pre class="literallayout"><a name="idm45123869880480-bb"></a><span class="identifier">old_ptr_if_copyable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Construct this old value pointer as null. </li>
+<pre class="literallayout"><a name="idm45394999013184-bb"></a><span class="identifier">old_ptr_if_copyable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Construct this old value pointer as null. </li>
 <li class="listitem">
-<pre class="literallayout"><a name="idm45123869879872-bb"></a><span class="identifier">old_ptr_if_copyable</span><span class="special">(</span><a class="link" href="old_ptr.html" title="Class template old_ptr">old_ptr</a><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span> <span class="keyword">const</span> <span class="special">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre>Construct this old value pointer from an old value pointer that requires the old value type to be copyable. <p>This constructor is implicitly called by this library when assigning an object of this type using <code class="computeroutput"><code class="computeroutput"><a class="link" href="../../BOOST_CONTRACT_OLDOF.html" title="Macro BOOST_CONTRACT_OLDOF">BOOST_CONTRACT_OLDOF</a></code></code> (this constructor is usually not explicitly called by user code).</p>
+<pre class="literallayout"><a name="idm45394999012576-bb"></a><span class="identifier">old_ptr_if_copyable</span><span class="special">(</span><a class="link" href="old_ptr.html" title="Class template old_ptr">old_ptr</a><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span> <span class="keyword">const</span> <span class="special">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre>Construct this old value pointer from an old value pointer that requires the old value type to be copyable. <p>Ownership of the pointed value object is transferred to this pointer. This constructor is implicitly called by this library when assigning an object of this type using <code class="computeroutput"><code class="computeroutput"><a class="link" href="../../BOOST_CONTRACT_OLDOF.html" title="Macro BOOST_CONTRACT_OLDOF">BOOST_CONTRACT_OLDOF</a></code></code> (this constructor is usually not explicitly called by user code).</p>
 <p>
 </p>
 <div class="variablelist"><table border="0" class="variablelist compact">
 </ol></div>
 </div>
 <div class="refsect2">
-<a name="idm45751727952096"></a><h3>
-<a name="idm45123869895568-bb"></a><code class="computeroutput">old_ptr_if_copyable</code> public member functions</h3>
+<a name="idm45707994455568"></a><h3>
+<a name="idm45394999028256-bb"></a><code class="computeroutput">old_ptr_if_copyable</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="idm45123869895008-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, but no compile-time error is generated 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="idm45394999027696-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, but no compile-time error is generated 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="idm45123869889408-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 return null but will not 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="idm45394999022096-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 return null but will not 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="idm45123869883792-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 (safe-bool operator). <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="idm45394999016496-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>