diff options
Diffstat (limited to 'doc/html/boost/recursive_wrapper.html')
| -rw-r--r-- | doc/html/boost/recursive_wrapper.html | 115 |
1 files changed, 71 insertions, 44 deletions
diff --git a/doc/html/boost/recursive_wrapper.html b/doc/html/boost/recursive_wrapper.html index 3567442bfb..3a0c103127 100644 --- a/doc/html/boost/recursive_wrapper.html +++ b/doc/html/boost/recursive_wrapper.html @@ -4,10 +4,10 @@ <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> <title>Class template recursive_wrapper</title> <link rel="stylesheet" href="../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../variant/reference.html#header.boost.variant.recursive_wrapper_hpp" title="Header <boost/variant/recursive_wrapper.hpp>"> -<link rel="prev" href="make_recursiv_idp329497920.html" title="Class template make_recursive_variant_over"> +<link rel="prev" href="make_rec_idm46563152322368.html" title="Class template make_recursive_variant_over"> <link rel="next" href="is_recursive_wrapper.html" title="Class template is_recursive_wrapper"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="make_recursiv_idp329497920.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../variant/reference.html#header.boost.variant.recursive_wrapper_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="is_recursive_wrapper.html"><img src="../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="make_rec_idm46563152322368.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../variant/reference.html#header.boost.variant.recursive_wrapper_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="is_recursive_wrapper.html"><img src="../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.recursive_wrapper"></a><div class="titlepage"></div> @@ -39,24 +39,24 @@ <span class="keyword">typedef</span> <span class="identifier">T</span> <a name="boost.recursive_wrapper.type"></a><span class="identifier">type</span><span class="special">;</span> <span class="comment">// <a class="link" href="recursive_wrapper.html#boost.recursive_wrapperconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="recursive_wrapper.html#idp313370192-bb"><span class="identifier">recursive_wrapper</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="recursive_wrapper.html#idp328866800-bb"><span class="identifier">recursive_wrapper</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">recursive_wrapper</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="recursive_wrapper.html#idp328811792-bb"><span class="identifier">recursive_wrapper</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="recursive_wrapper.html#idp370299488-bb"><span class="special">~</span><span class="identifier">recursive_wrapper</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="recursive_wrapper.html#idm46563152293200-bb"><span class="identifier">recursive_wrapper</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="recursive_wrapper.html#idm46563152286896-bb"><span class="identifier">recursive_wrapper</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">recursive_wrapper</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="recursive_wrapper.html#idm46563152281120-bb"><span class="identifier">recursive_wrapper</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="recursive_wrapper.html#idm46563152295888-bb"><span class="special">~</span><span class="identifier">recursive_wrapper</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="recursive_wrapper.html#idp322172528-bb">modifiers</a></span> - <span class="keyword">void</span> <a class="link" href="recursive_wrapper.html#idp322173088-bb"><span class="identifier">swap</span></a><span class="special">(</span><span class="identifier">recursive_wrapper</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="identifier">recursive_wrapper</span> <span class="special">&</span> <a class="link" href="recursive_wrapper.html#idp314386800-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">recursive_wrapper</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="identifier">recursive_wrapper</span> <span class="special">&</span> <a class="link" href="recursive_wrapper.html#idp368618080-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="recursive_wrapper.html#idm46563152275360-bb">modifiers</a></span> + <span class="keyword">void</span> <a class="link" href="recursive_wrapper.html#idm46563152274800-bb"><span class="identifier">swap</span></a><span class="special">(</span><span class="identifier">recursive_wrapper</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">recursive_wrapper</span> <span class="special">&</span> <a class="link" href="recursive_wrapper.html#idm46563152270224-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">recursive_wrapper</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">recursive_wrapper</span> <span class="special">&</span> <a class="link" href="recursive_wrapper.html#idm46563152262528-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="recursive_wrapper.html#idp327416336-bb">queries</a></span> - <span class="identifier">T</span> <span class="special">&</span> <a class="link" href="recursive_wrapper.html#idp369779008-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> <a class="link" href="recursive_wrapper.html#idp314294448-bb"><span class="identifier">get</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="special">*</span> <a class="link" href="recursive_wrapper.html#idp319756528-bb"><span class="identifier">get_pointer</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">*</span> <a class="link" href="recursive_wrapper.html#idp319757424-bb"><span class="identifier">get_pointer</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="recursive_wrapper.html#idm46563152254688-bb">queries</a></span> + <span class="identifier">T</span> <span class="special">&</span> <a class="link" href="recursive_wrapper.html#idm46563152253568-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> <a class="link" href="recursive_wrapper.html#idm46563152252672-bb"><span class="identifier">get</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="special">*</span> <a class="link" href="recursive_wrapper.html#idm46563152248960-bb"><span class="identifier">get_pointer</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">*</span> <a class="link" href="recursive_wrapper.html#idm46563152248064-bb"><span class="identifier">get_pointer</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="idp494762128"></a><h2>Description</h2> +<a name="idm45927694263216"></a><h2>Description</h2> <p>The <code class="computeroutput">recursive_wrapper</code> class template has an interface similar to a simple value container, but its content is allocated dynamically. This allows <code class="computeroutput">recursive_wrapper</code> to @@ -68,21 +68,24 @@ <a class="xref" href="../variant/tutorial.html#variant.tutorial.recursive.recursive-wrapper" title="Recursive types with recursive_wrapper">the section called “Recursive types with <code class="computeroutput">recursive_wrapper</code>”</a> for a demonstration of a common use of the class template.</p> <p><span class="bold"><strong>Notes</strong></span>:</p> -<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">Any type specified as the template argument to +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">Any type specified as the template argument to <code class="computeroutput">recursive_wrapper</code> must be capable of construction via <code class="computeroutput">operator new</code>. Thus, for instance, references are not supported.</li></ul></div> <div class="refsect2"> -<a name="idp494772064"></a><h3> +<a name="idm45927694253280"></a><h3> <a name="boost.recursive_wrapperconstruct-copy-destruct"></a><code class="computeroutput">recursive_wrapper</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp313370192-bb"></a><span class="identifier">recursive_wrapper</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Default constructor.<p class="simpara">Initializes <code class="computeroutput">*this</code> by default construction of +<pre class="literallayout"><a name="idm46563152293200-bb"></a><span class="identifier">recursive_wrapper</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Default constructor.<p class="simpara">Initializes <code class="computeroutput">*this</code> by default construction of <code class="computeroutput">T</code>.</p> -<div class="variablelist"><table border="0"> +<div class="variablelist"><table border="0" class="variablelist compact"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <tbody> <tr> <td><p><span class="term">Requires:</span></p></td> @@ -101,10 +104,13 @@ </table></div> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp328866800-bb"></a><span class="identifier">recursive_wrapper</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">recursive_wrapper</span> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre>Copy constructor.<p class="simpara">Copies the content of <code class="computeroutput">other</code> into +<pre class="literallayout"><a name="idm46563152286896-bb"></a><span class="identifier">recursive_wrapper</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">recursive_wrapper</span> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre>Copy constructor.<p class="simpara">Copies the content of <code class="computeroutput">other</code> into <code class="computeroutput">*this</code>.</p> -<div class="variablelist"><table border="0"> +<div class="variablelist"><table border="0" class="variablelist compact"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <tbody><tr> <td><p><span class="term">Throws:</span></p></td> <td>May fail with any exceptions arising from the @@ -114,10 +120,13 @@ </table></div> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp328811792-bb"></a><span class="identifier">recursive_wrapper</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> operand<span class="special">)</span><span class="special">;</span></pre>Value constructor.<p class="simpara">Copies <code class="computeroutput">operand</code> into +<pre class="literallayout"><a name="idm46563152281120-bb"></a><span class="identifier">recursive_wrapper</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> operand<span class="special">)</span><span class="special">;</span></pre>Value constructor.<p class="simpara">Copies <code class="computeroutput">operand</code> into <code class="computeroutput">*this</code>.</p> -<div class="variablelist"><table border="0"> +<div class="variablelist"><table border="0" class="variablelist compact"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <tbody><tr> <td><p><span class="term">Throws:</span></p></td> <td>May fail with any exceptions arising from the @@ -127,9 +136,12 @@ </table></div> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp370299488-bb"></a><span class="special">~</span><span class="identifier">recursive_wrapper</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Destructor.<p class="simpara">Deletes the content of <code class="computeroutput">*this</code>.</p> -<div class="variablelist"><table border="0"> +<pre class="literallayout"><a name="idm46563152295888-bb"></a><span class="special">~</span><span class="identifier">recursive_wrapper</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Destructor.<p class="simpara">Deletes the content of <code class="computeroutput">*this</code>.</p> +<div class="variablelist"><table border="0" class="variablelist compact"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <tbody><tr> <td><p><span class="term">Throws:</span></p></td> <td>Will not throw.</td> @@ -139,15 +151,18 @@ </ol></div> </div> <div class="refsect2"> -<a name="idp494812096"></a><h3> -<a name="idp322172528-bb"></a><code class="computeroutput">recursive_wrapper</code> modifiers</h3> +<a name="idm45927694213120"></a><h3> +<a name="idm46563152275360-bb"></a><code class="computeroutput">recursive_wrapper</code> modifiers</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp322173088-bb"></a><span class="identifier">swap</span><span class="special">(</span><span class="identifier">recursive_wrapper</span> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idm46563152274800-bb"></a><span class="identifier">swap</span><span class="special">(</span><span class="identifier">recursive_wrapper</span> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> <p class="simpara">Exchanges contents of <code class="computeroutput">*this</code> and <code class="computeroutput">other</code>.</p> -<div class="variablelist"><table border="0"> +<div class="variablelist"><table border="0" class="variablelist compact"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <tbody><tr> <td><p><span class="term">Throws:</span></p></td> <td>Will not throw.</td> @@ -155,10 +170,13 @@ </table></div> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">recursive_wrapper</span> <span class="special">&</span> <a name="idp314386800-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">recursive_wrapper</span> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre>Copy assignment operator.<p class="simpara">Assigns the content of <code class="computeroutput">rhs</code> to the content of +<pre class="literallayout"><span class="identifier">recursive_wrapper</span> <span class="special">&</span> <a name="idm46563152270224-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">recursive_wrapper</span> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre>Copy assignment operator.<p class="simpara">Assigns the content of <code class="computeroutput">rhs</code> to the content of <code class="computeroutput">*this</code>.</p> -<div class="variablelist"><table border="0"> +<div class="variablelist"><table border="0" class="variablelist compact"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <tbody> <tr> <td><p><span class="term">Requires:</span></p></td> @@ -176,10 +194,13 @@ </table></div> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">recursive_wrapper</span> <span class="special">&</span> <a name="idp368618080-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre>Value assignment operator.<p class="simpara">Assigns <code class="computeroutput">rhs</code> into the content of +<pre class="literallayout"><span class="identifier">recursive_wrapper</span> <span class="special">&</span> <a name="idm46563152262528-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre>Value assignment operator.<p class="simpara">Assigns <code class="computeroutput">rhs</code> into the content of <code class="computeroutput">*this</code>.</p> -<div class="variablelist"><table border="0"> +<div class="variablelist"><table border="0" class="variablelist compact"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <tbody> <tr> <td><p><span class="term">Requires:</span></p></td> @@ -199,16 +220,19 @@ </ol></div> </div> <div class="refsect2"> -<a name="idp494848944"></a><h3> -<a name="idp327416336-bb"></a><code class="computeroutput">recursive_wrapper</code> queries</h3> +<a name="idm45927694176272"></a><h3> +<a name="idm46563152254688-bb"></a><code class="computeroutput">recursive_wrapper</code> queries</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp369778448-bb"></a><span class="identifier">T</span> <span class="special">&</span> <a name="idp369779008-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="special">)</span><span class="special">;</span> -<span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> <a name="idp314294448-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idm46563152254128-bb"></a><span class="identifier">T</span> <span class="special">&</span> <a name="idm46563152253568-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="special">)</span><span class="special">;</span> +<span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> <a name="idm46563152252672-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p class="simpara">Returns a reference to the content of <code class="computeroutput">*this</code>.</p> -<div class="variablelist"><table border="0"> +<div class="variablelist"><table border="0" class="variablelist compact"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <tbody><tr> <td><p><span class="term">Throws:</span></p></td> <td>Will not throw.</td> @@ -216,12 +240,15 @@ </table></div> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp319755968-bb"></a><span class="identifier">T</span> <span class="special">*</span> <a name="idp319756528-bb"></a><span class="identifier">get_pointer</span><span class="special">(</span><span class="special">)</span><span class="special">;</span> -<span class="keyword">const</span> <span class="identifier">T</span> <span class="special">*</span> <a name="idp319757424-bb"></a><span class="identifier">get_pointer</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idm46563152249520-bb"></a><span class="identifier">T</span> <span class="special">*</span> <a name="idm46563152248960-bb"></a><span class="identifier">get_pointer</span><span class="special">(</span><span class="special">)</span><span class="special">;</span> +<span class="keyword">const</span> <span class="identifier">T</span> <span class="special">*</span> <a name="idm46563152248064-bb"></a><span class="identifier">get_pointer</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p class="simpara">Returns a pointer to the content of <code class="computeroutput">*this</code>.</p> -<div class="variablelist"><table border="0"> +<div class="variablelist"><table border="0" class="variablelist compact"> +<colgroup> <col align="left" valign="top"> +<col> +</colgroup> <tbody><tr> <td><p><span class="term">Throws:</span></p></td> <td>Will not throw.</td> @@ -242,7 +269,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="make_recursiv_idp329497920.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../variant/reference.html#header.boost.variant.recursive_wrapper_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="is_recursive_wrapper.html"><img src="../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="make_rec_idm46563152322368.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../variant/reference.html#header.boost.variant.recursive_wrapper_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="is_recursive_wrapper.html"><img src="../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> |