← Back to branch summary

~ubuntu-branches/debian/sid/boost1.49/sid

« back to all changes in this revision

Viewing changes to doc/html/boost/recursive_wrapper.html

  • Committer: Package Import Robot
  • Author(s): Steve M. Robbins
  • Date: 2012-02-26 00:31:44 UTC
  • Revision ID: package-import@ubuntu.com-20120226003144-eaytp12cbf6ubpms
Tags: upstream-1.49.0
Import upstream version 1.49.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/boost/recursive_wrapper.html
 
1
<html>
 
2
<head>
 
3
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
 
4
<title>Class template recursive_wrapper</title>
 
5
<link rel="stylesheet" href="../../../doc/src/boostbook.css" type="text/css">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
 
7
<link rel="home" href="../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
 
8
<link rel="up" href="../variant/reference.html#header.boost.variant.recursive_wrapper_hpp" title="Header &lt;boost/variant/recursive_wrapper.hpp&gt;">
 
9
<link rel="prev" href="make_recursive_variant__id1790944.html" title="Class template make_recursive_variant_over">
 
10
<link rel="next" href="is_recursive_wrapper.html" title="Class template is_recursive_wrapper">
 
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="make_recursive_variant__id1790944.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>
 
24
</div>
 
25
<div class="refentry">
 
26
<a name="boost.recursive_wrapper"></a><div class="titlepage"></div>
 
27
<div class="refnamediv">
 
28
<h2><span class="refentrytitle">Class template recursive_wrapper</span></h2>
 
29
<p>boost::recursive_wrapper &#8212; Solves circular dependencies, enabling recursive types.</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="../variant/reference.html#header.boost.variant.recursive_wrapper_hpp" title="Header &lt;boost/variant/recursive_wrapper.hpp&gt;">boost/variant/recursive_wrapper.hpp</a>&gt;
 
33
 
 
34
</span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> 
 
35
<span class="keyword">class</span> <a class="link" href="recursive_wrapper.html" title="Class template recursive_wrapper">recursive_wrapper</a> <span class="special">{</span>
 
36
<span class="keyword">public</span><span class="special">:</span>
 
37
  <span class="comment">// types</span>
 
38
  <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>
 
39
 
 
40
  <span class="comment">// <a class="link" href="recursive_wrapper.html#boost.recursive_wrapperconstruct-copy-destruct">construct/copy/destruct</a></span>
 
41
  <a class="link" href="recursive_wrapper.html#id1789209-bb"><span class="identifier">recursive_wrapper</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
 
42
  <a class="link" href="recursive_wrapper.html#id1767037-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">&amp;</span><span class="special">)</span><span class="special">;</span>
 
43
  <a class="link" href="recursive_wrapper.html#id1767079-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">&amp;</span><span class="special">)</span><span class="special">;</span>
 
44
  <a class="link" href="recursive_wrapper.html#id1789190-bb"><span class="special">~</span><span class="identifier">recursive_wrapper</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
 
45
 
 
46
  <span class="comment">// <a class="link" href="recursive_wrapper.html#id1674611-bb">modifiers</a></span>
 
47
  <span class="keyword">void</span> <a class="link" href="recursive_wrapper.html#id1674615-bb"><span class="identifier">swap</span></a><span class="special">(</span><span class="identifier">recursive_wrapper</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
 
48
  <span class="identifier">recursive_wrapper</span> <span class="special">&amp;</span> <a class="link" href="recursive_wrapper.html#id1801081-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">&amp;</span><span class="special">)</span><span class="special">;</span>
 
49
  <span class="identifier">recursive_wrapper</span> <span class="special">&amp;</span> <a class="link" href="recursive_wrapper.html#id1801137-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">&amp;</span><span class="special">)</span><span class="special">;</span>
 
50
 
 
51
  <span class="comment">// <a class="link" href="recursive_wrapper.html#id1780772-bb">queries</a></span>
 
52
  <span class="identifier">T</span> <span class="special">&amp;</span> <a class="link" href="recursive_wrapper.html#id1670801-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
 
53
  <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&amp;</span> <a class="link" href="recursive_wrapper.html#id1670807-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
 
54
  <span class="identifier">T</span> <span class="special">*</span> <a class="link" href="recursive_wrapper.html#id1670833-bb"><span class="identifier">get_pointer</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
 
55
  <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">*</span> <a class="link" href="recursive_wrapper.html#id1670840-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>
 
56
<span class="special">}</span><span class="special">;</span></pre></div>
 
57
<div class="refsect1">
 
58
<a name="id3706128"></a><h2>Description</h2>
 
59
<p>The <code class="computeroutput">recursive_wrapper</code> class template has an
 
60
          interface similar to a simple value container, but its content is
 
61
          allocated dynamically. This allows <code class="computeroutput">recursive_wrapper</code> to
 
62
          hold types <code class="computeroutput">T</code> whose member data leads to a circular
 
63
          dependency (e.g., a data member of <code class="computeroutput">T</code> has a data member
 
64
          of type <code class="computeroutput">T</code>).</p>
 
65
<p>The application of <code class="computeroutput">recursive_wrapper</code> is easiest
 
66
          understood in context. See
 
67
          <a class="xref" href="../variant/tutorial.html#variant.tutorial.recursive.recursive-wrapper" title="Recursive types with recursive_wrapper">the section called &#8220;Recursive types with <code class="computeroutput">recursive_wrapper</code>&#8221;</a> for a
 
68
          demonstration of a common use of the class template.</p>
 
69
<p><span class="bold"><strong>Notes</strong></span>:</p>
 
70
<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">Any type specified as the template argument to
 
71
            <code class="computeroutput">recursive_wrapper</code> must be capable of construction via
 
72
            <code class="computeroutput">operator new</code>. Thus, for instance, references are not
 
73
            supported.</li></ul></div>
 
74
<div class="refsect2">
 
75
<a name="id3706216"></a><h3>
 
76
<a name="boost.recursive_wrapperconstruct-copy-destruct"></a><code class="computeroutput">recursive_wrapper</code> 
 
77
        public
 
78
       construct/copy/destruct</h3>
 
79
<div class="orderedlist"><ol class="orderedlist" type="1">
 
80
<li class="listitem">
 
81
<pre class="literallayout"><a name="id1789209-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
 
82
            <code class="computeroutput">T</code>.</p>
 
83
<div class="variablelist"><table border="0">
 
84
<col align="left" valign="top">
 
85
<tbody>
 
86
<tr>
 
87
<td><p><span class="term">Requires:</span></p></td>
 
88
<td>
 
89
<code class="computeroutput">T</code> must fulfill the requirements of the
 
90
            <span class="emphasis"><em>DefaultConstructible</em></span> [20.1.4]
 
91
            concept.</td>
 
92
</tr>
 
93
<tr>
 
94
<td><p><span class="term">Throws:</span></p></td>
 
95
<td>May fail with any exceptions arising from the default
 
96
            constructor of <code class="computeroutput">T</code> or, in the event of
 
97
            insufficient memory, with <code class="computeroutput">std::bad_alloc</code>.</td>
 
98
</tr>
 
99
</tbody>
 
100
</table></div>
 
101
</li>
 
102
<li class="listitem">
 
103
<pre class="literallayout"><a name="id1767037-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">&amp;</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
 
104
            <code class="computeroutput">*this</code>.</p>
 
105
<div class="variablelist"><table border="0">
 
106
<col align="left" valign="top">
 
107
<tbody><tr>
 
108
<td><p><span class="term">Throws:</span></p></td>
 
109
<td>May fail with any exceptions arising from the
 
110
            copy constructor of <code class="computeroutput">T</code> or, in the event of
 
111
            insufficient memory, with <code class="computeroutput">std::bad_alloc</code>.</td>
 
112
</tr></tbody>
 
113
</table></div>
 
114
</li>
 
115
<li class="listitem">
 
116
<pre class="literallayout"><a name="id1767079-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">&amp;</span> operand<span class="special">)</span><span class="special">;</span></pre>Value constructor.<p class="simpara">Copies <code class="computeroutput">operand</code> into
 
117
            <code class="computeroutput">*this</code>.</p>
 
118
<div class="variablelist"><table border="0">
 
119
<col align="left" valign="top">
 
120
<tbody><tr>
 
121
<td><p><span class="term">Throws:</span></p></td>
 
122
<td>May fail with any exceptions arising from the
 
123
            copy constructor of <code class="computeroutput">T</code> or, in the event of
 
124
            insufficient memory, with <code class="computeroutput">std::bad_alloc</code>.</td>
 
125
</tr></tbody>
 
126
</table></div>
 
127
</li>
 
128
<li class="listitem">
 
129
<pre class="literallayout"><a name="id1789190-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>
 
130
<div class="variablelist"><table border="0">
 
131
<col align="left" valign="top">
 
132
<tbody><tr>
 
133
<td><p><span class="term">Throws:</span></p></td>
 
134
<td>Will not throw.</td>
 
135
</tr></tbody>
 
136
</table></div>
 
137
</li>
 
138
</ol></div>
 
139
</div>
 
140
<div class="refsect2">
 
141
<a name="id3706553"></a><h3>
 
142
<a name="id1674611-bb"></a><code class="computeroutput">recursive_wrapper</code> modifiers</h3>
 
143
<div class="orderedlist"><ol class="orderedlist" type="1">
 
144
<li class="listitem">
 
145
<pre class="literallayout"><span class="keyword">void</span> <a name="id1674615-bb"></a><span class="identifier">swap</span><span class="special">(</span><span class="identifier">recursive_wrapper</span> <span class="special">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre>
 
146
<p class="simpara">Exchanges contents of <code class="computeroutput">*this</code> and
 
147
              <code class="computeroutput">other</code>.</p>
 
148
<div class="variablelist"><table border="0">
 
149
<col align="left" valign="top">
 
150
<tbody><tr>
 
151
<td><p><span class="term">Throws:</span></p></td>
 
152
<td>Will not throw.</td>
 
153
</tr></tbody>
 
154
</table></div>
 
155
</li>
 
156
<li class="listitem">
 
157
<pre class="literallayout"><span class="identifier">recursive_wrapper</span> <span class="special">&amp;</span> <a name="id1801081-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">&amp;</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
 
158
              <code class="computeroutput">*this</code>.</p>
 
159
<div class="variablelist"><table border="0">
 
160
<col align="left" valign="top">
 
161
<tbody>
 
162
<tr>
 
163
<td><p><span class="term">Requires:</span></p></td>
 
164
<td>
 
165
<code class="computeroutput">T</code> must fulfill the requirements of
 
166
            the <a class="link" href="../Assignable.html" title="Concept Assignable">Assignable</a>
 
167
            concept.</td>
 
168
</tr>
 
169
<tr>
 
170
<td><p><span class="term">Throws:</span></p></td>
 
171
<td>May fail with any exceptions arising from the assignment
 
172
              operator of <code class="computeroutput">T</code>.</td>
 
173
</tr>
 
174
</tbody>
 
175
</table></div>
 
176
</li>
 
177
<li class="listitem">
 
178
<pre class="literallayout"><span class="identifier">recursive_wrapper</span> <span class="special">&amp;</span> <a name="id1801137-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">&amp;</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
 
179
              <code class="computeroutput">*this</code>.</p>
 
180
<div class="variablelist"><table border="0">
 
181
<col align="left" valign="top">
 
182
<tbody>
 
183
<tr>
 
184
<td><p><span class="term">Requires:</span></p></td>
 
185
<td>
 
186
<code class="computeroutput">T</code> must fulfill the requirements of the
 
187
              <a class="link" href="../Assignable.html" title="Concept Assignable">Assignable</a>
 
188
              concept.</td>
 
189
</tr>
 
190
<tr>
 
191
<td><p><span class="term">Throws:</span></p></td>
 
192
<td>May fail with any exceptions arising from the assignment
 
193
              operator of <code class="computeroutput">T</code>.</td>
 
194
</tr>
 
195
</tbody>
 
196
</table></div>
 
197
</li>
 
198
</ol></div>
 
199
</div>
 
200
<div class="refsect2">
 
201
<a name="id3706873"></a><h3>
 
202
<a name="id1780772-bb"></a><code class="computeroutput">recursive_wrapper</code> queries</h3>
 
203
<div class="orderedlist"><ol class="orderedlist" type="1">
 
204
<li class="listitem">
 
205
<pre class="literallayout"><a name="id1780776-bb"></a><span class="identifier">T</span> <span class="special">&amp;</span> <a name="id1670801-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="special">)</span><span class="special">;</span>
 
206
<span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&amp;</span> <a name="id1670807-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>
 
207
<p class="simpara">Returns a reference to the content of
 
208
              <code class="computeroutput">*this</code>.</p>
 
209
<div class="variablelist"><table border="0">
 
210
<col align="left" valign="top">
 
211
<tbody><tr>
 
212
<td><p><span class="term">Throws:</span></p></td>
 
213
<td>Will not throw.</td>
 
214
</tr></tbody>
 
215
</table></div>
 
216
</li>
 
217
<li class="listitem">
 
218
<pre class="literallayout"><a name="id1670829-bb"></a><span class="identifier">T</span> <span class="special">*</span> <a name="id1670833-bb"></a><span class="identifier">get_pointer</span><span class="special">(</span><span class="special">)</span><span class="special">;</span>
 
219
<span class="keyword">const</span> <span class="identifier">T</span> <span class="special">*</span> <a name="id1670840-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>
 
220
<p class="simpara">Returns a pointer to the content of
 
221
              <code class="computeroutput">*this</code>.</p>
 
222
<div class="variablelist"><table border="0">
 
223
<col align="left" valign="top">
 
224
<tbody><tr>
 
225
<td><p><span class="term">Throws:</span></p></td>
 
226
<td>Will not throw.</td>
 
227
</tr></tbody>
 
228
</table></div>
 
229
</li>
 
230
</ol></div>
 
231
</div>
 
232
</div>
 
233
</div>
 
234
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 
235
<td align="left"></td>
 
236
<td align="right"><div class="copyright-footer">Copyright &#169; 2002, 2003 Eric Friedman, Itay Maman<p>Distributed under the Boost Software License, Version 1.0.
 
237
    (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at 
 
238
    <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
 
239
    </p>
 
240
</div></td>
 
241
</tr></table>
 
242
<hr>
 
243
<div class="spirit-nav">
 
244
<a accesskey="p" href="make_recursive_variant__id1790944.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>
 
245
</div>
 
246
</body>
 
247
</html>