]> git.proxmox.com Git - ceph.git/blame - ceph/src/boost/libs/ptr_container/doc/ptr_set_adapter.html
projects / ceph.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
bump version to 12.2.2-pve1
[ceph.git] / ceph / src / boost / libs / ptr_container / doc / ptr_set_adapter.html
CommitLineData
7c673cae
FG		 1<?xml version="1.0" encoding="utf-8" ?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6<meta name="generator" content="Docutils 0.3.10: http://docutils.sourceforge.net/" />
7<title>Boost Pointer Container Library</title>
8<style type="text/css">
9
10/*
11:Author: David Goodger
12:Contact: goodger@users.sourceforge.net
13:Date: $Date$
14:Revision: $Revision$
15:Copyright: This stylesheet has been placed in the public domain.
16
17Default cascading style sheet for the HTML output of Docutils.
18
19See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
20customize this style sheet.
21*/
22
23/* "! important" is used here to override other ``margin-top`` and
24 ``margin-bottom`` styles that are later in the stylesheet or
25 more specific. See http://www.w3.org/TR/CSS1#the-cascade */
26.first {
27 margin-top: 0 ! important }
28
29.last, .with-subtitle {
30 margin-bottom: 0 ! important }
31
32.hidden {
33 display: none }
34
35a.toc-backref {
36 text-decoration: none ;
37 color: black }
38
39blockquote.epigraph {
40 margin: 2em 5em ; }
41
42dl.docutils dd {
43 margin-bottom: 0.5em }
44
45/* Uncomment (and remove this text!) to get bold-faced definition list terms
46dl.docutils dt {
47 font-weight: bold }
48*/
49
50div.abstract {
51 margin: 2em 5em }
52
53div.abstract p.topic-title {
54 font-weight: bold ;
55 text-align: center }
56
57div.admonition, div.attention, div.caution, div.danger, div.error,
58div.hint, div.important, div.note, div.tip, div.warning {
59 margin: 2em ;
60 border: medium outset ;
61 padding: 1em }
62
63div.admonition p.admonition-title, div.hint p.admonition-title,
64div.important p.admonition-title, div.note p.admonition-title,
65div.tip p.admonition-title {
66 font-weight: bold ;
67 font-family: sans-serif }
68
69div.attention p.admonition-title, div.caution p.admonition-title,
70div.danger p.admonition-title, div.error p.admonition-title,
71div.warning p.admonition-title {
72 color: red ;
73 font-weight: bold ;
74 font-family: sans-serif }
75
76/* Uncomment (and remove this text!) to get reduced vertical space in
77 compound paragraphs.
78div.compound .compound-first, div.compound .compound-middle {
79 margin-bottom: 0.5em }
80
81div.compound .compound-last, div.compound .compound-middle {
82 margin-top: 0.5em }
83*/
84
85div.dedication {
86 margin: 2em 5em ;
87 text-align: center ;
88 font-style: italic }
89
90div.dedication p.topic-title {
91 font-weight: bold ;
92 font-style: normal }
93
94div.figure {
95 margin-left: 2em }
96
97div.footer, div.header {
98 clear: both;
99 font-size: smaller }
100
101div.line-block {
102 display: block ;
103 margin-top: 1em ;
104 margin-bottom: 1em }
105
106div.line-block div.line-block {
107 margin-top: 0 ;
108 margin-bottom: 0 ;
109 margin-left: 1.5em }
110
111div.sidebar {
112 margin-left: 1em ;
113 border: medium outset ;
114 padding: 1em ;
115 background-color: #ffffee ;
116 width: 40% ;
117 float: right ;
118 clear: right }
119
120div.sidebar p.rubric {
121 font-family: sans-serif ;
122 font-size: medium }
123
124div.system-messages {
125 margin: 5em }
126
127div.system-messages h1 {
128 color: red }
129
130div.system-message {
131 border: medium outset ;
132 padding: 1em }
133
134div.system-message p.system-message-title {
135 color: red ;
136 font-weight: bold }
137
138div.topic {
139 margin: 2em }
140
141h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
142h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
143 margin-top: 0.4em }
144
145h1.title {
146 text-align: center }
147
148h2.subtitle {
149 text-align: center }
150
151hr.docutils {
152 width: 75% }
153
154img.align-left {
155 clear: left }
156
157img.align-right {
158 clear: right }
159
160img.borderless {
161 border: 0 }
162
163ol.simple, ul.simple {
164 margin-bottom: 1em }
165
166ol.arabic {
167 list-style: decimal }
168
169ol.loweralpha {
170 list-style: lower-alpha }
171
172ol.upperalpha {
173 list-style: upper-alpha }
174
175ol.lowerroman {
176 list-style: lower-roman }
177
178ol.upperroman {
179 list-style: upper-roman }
180
181p.attribution {
182 text-align: right ;
183 margin-left: 50% }
184
185p.caption {
186 font-style: italic }
187
188p.credits {
189 font-style: italic ;
190 font-size: smaller }
191
192p.label {
193 white-space: nowrap }
194
195p.rubric {
196 font-weight: bold ;
197 font-size: larger ;
198 color: maroon ;
199 text-align: center }
200
201p.sidebar-title {
202 font-family: sans-serif ;
203 font-weight: bold ;
204 font-size: larger }
205
206p.sidebar-subtitle {
207 font-family: sans-serif ;
208 font-weight: bold }
209
210p.topic-title {
211 font-weight: bold }
212
213pre.address {
214 margin-bottom: 0 ;
215 margin-top: 0 ;
216 font-family: serif ;
217 font-size: 100% }
218
219pre.line-block {
220 font-family: serif ;
221 font-size: 100% }
222
223pre.literal-block, pre.doctest-block {
224 margin-left: 2em ;
225 margin-right: 2em ;
226 background-color: #eeeeee }
227
228span.classifier {
229 font-family: sans-serif ;
230 font-style: oblique }
231
232span.classifier-delimiter {
233 font-family: sans-serif ;
234 font-weight: bold }
235
236span.interpreted {
237 font-family: sans-serif }
238
239span.option {
240 white-space: nowrap }
241
242span.pre {
243 white-space: pre }
244
245span.problematic {
246 color: red }
247
248span.section-subtitle {
249 /* font-size relative to parent (h1..h6 element) */
250 font-size: 80% }
251
252table.citation {
253 border-left: solid thin gray }
254
255table.docinfo {
256 margin: 2em 4em }
257
258table.docutils {
259 margin-top: 0.5em ;
260 margin-bottom: 0.5em }
261
262table.footnote {
263 border-left: solid thin black }
264
265table.docutils td, table.docutils th,
266table.docinfo td, table.docinfo th {
267 padding-left: 0.5em ;
268 padding-right: 0.5em ;
269 vertical-align: top }
270
271table.docutils th.field-name, table.docinfo th.docinfo-name {
272 font-weight: bold ;
273 text-align: left ;
274 white-space: nowrap ;
275 padding-left: 0 }
276
277h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
278h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
279 font-size: 100% }
280
281tt.docutils {
282 background-color: #eeeeee }
283
284ul.auto-toc {
285 list-style-type: none }
286
287</style>
288</head>
289<body>
290<div class="document" id="boost-pointer-container-library">
291<h1 class="title"><img alt="Boost" src="boost.png" /> Pointer Container Library</h1>
292<div class="section">
293<h1><a id="class-ptr-set-adapter" name="class-ptr-set-adapter">Class <tt class="docutils literal"><span class="pre">ptr_set_adapter</span></tt></a></h1>
294<p>This class is used to build custom pointer containers with
295an underlying set-like container. The interface of the class is an extension
296of the interface from <tt class="docutils literal"><span class="pre">associative_ptr_container</span></tt>.</p>
297<p><strong>Hierarchy:</strong></p>
298<ul class="simple">
299<li><a class="reference" href="reversible_ptr_container.html">reversible_ptr_container</a><ul>
300<li><a class="reference" href="associative_ptr_container.html">associative_ptr_container</a><ul>
301<li><tt class="docutils literal"><span class="pre">ptr_set_adapter</span></tt></li>
302<li><a class="reference" href="ptr_multiset_adapter.html">ptr_multiset_adapter</a></li>
303<li><a class="reference" href="ptr_map_adapter.html">ptr_map_adapter</a></li>
304<li><a class="reference" href="ptr_multimap_adapter.html">ptr_multi_map_adapter</a><ul>
305<li><a class="reference" href="ptr_set.html">ptr_set</a></li>
306<li><a class="reference" href="ptr_multiset.html">ptr_multi_set</a></li>
307<li><a class="reference" href="ptr_map.html">ptr_map</a></li>
308<li><a class="reference" href="ptr_multimap.html">ptr_multimap</a></li>
309</ul>
310</li>
311</ul>
312</li>
313</ul>
314</li>
315</ul>
316<p><strong>Navigate:</strong></p>
317<ul class="simple">
318<li><a class="reference" href="ptr_container.html">home</a></li>
319<li><a class="reference" href="reference.html">reference</a></li>
320</ul>
321<p><strong>Synopsis:</strong></p>
322<pre class="literal-block">
323namespace boost
324{
325 template
326 &lt;
327 class Key,
328 class VoidPtrSet,
329 class CloneAllocator = heap_clone_allocator
330 &gt;
331 class ptr_set_adapter
332 {
333
334 public: // <a class="reference" href="#modifiers">modifiers</a>
335 std::pair&lt;iterator,bool&gt; insert( Key* x );
336 template&lt; class Key2 &gt;
337 std::pair&lt;iterator,bool&gt; insert( std::auto_ptr&lt;Key2&gt; x );
338
339 public: // <a class="reference" href="#pointer-container-requirements">pointer container requirements</a>
340 bool transfer( iterator object, ptr_set_adapter&amp; from );
341 size_type transfer( iterator first, iterator last, ptr_set_adapter&amp; from );
342 template&lt; class Range &gt;
343 size_type transfer( const Range&amp; r, ptr_set_adapter&amp; from );
344 size_type transfer( ptr_set_adapter&amp; from );
345
346 }; // class 'ptr_set_adapter'
347
348} // namespace 'boost'
349</pre>
350</div>
351<div class="section">
352<h1><a id="semantics" name="semantics">Semantics</a></h1>
353<div class="section">
354<h2><a id="semantics-modifiers" name="semantics-modifiers"><span id="modifiers"></span>Semantics: modifiers</a></h2>
355<ul>
356<li><p class="first"><tt class="docutils literal"><span class="pre">std::pair&lt;iterator,bool&gt;</span> <span class="pre">insert(</span> <span class="pre">key_type*</span> <span class="pre">x</span> <span class="pre">);</span></tt></p>
357<blockquote>
358<ul class="simple">
359<li>Requirements: <tt class="docutils literal"><span class="pre">x</span> <span class="pre">!=</span> <span class="pre">0</span></tt></li>
360<li>Effects: Takes ownership of <tt class="docutils literal"><span class="pre">x</span></tt> and insert it if there is no equivalent of it already. The <tt class="docutils literal"><span class="pre">bool</span></tt> part of the return value indicates insertion and the iterator points to the element with key <tt class="docutils literal"><span class="pre">x</span></tt>.</li>
361<li>Throws: bad_pointer if <tt class="docutils literal"><span class="pre">x</span> <span class="pre">==</span> <span class="pre">0</span></tt></li>
362<li>Exception safety: Strong guarantee</li>
363</ul>
364</blockquote>
365</li>
366<li><p class="first"><tt class="docutils literal"><span class="pre">template&lt;</span> <span class="pre">class</span> <span class="pre">Key2</span> <span class="pre">&gt;</span> <span class="pre">std::pair&lt;iterator,bool&gt;</span>&nbsp; <span class="pre">insert(</span> <span class="pre">std::auto_ptr&lt;Key2&gt;</span> <span class="pre">x</span> <span class="pre">);</span></tt></p>
367<blockquote>
368<ul class="simple">
369<li>Effects: <tt class="docutils literal"><span class="pre">return</span> <span class="pre">insert(</span> <span class="pre">x.release()</span> <span class="pre">);</span></tt></li>
370</ul>
371</blockquote>
372</li>
373</ul>
374<!-- - ``std::pair<iterator,bool> insert( const key_type& x );``
375
376- Effects: ``return insert( allocate_clone( x ) );``
377
378- Exception safety: Strong guarantee -->
379</div>
380<div class="section">
381<h2><a id="semantics-pointer-container-requirements" name="semantics-pointer-container-requirements"><span id="pointer-container-requirements"></span>Semantics: pointer container requirements</a></h2>
382<ul>
383<li><p class="first"><tt class="docutils literal"><span class="pre">bool</span> <span class="pre">transfer(</span> <span class="pre">iterator</span> <span class="pre">object,</span> <span class="pre">ptr_set_adapter&amp;</span> <span class="pre">from</span> <span class="pre">);</span></tt></p>
384<blockquote>
385<ul class="simple">
386<li>Requirements: <tt class="docutils literal"><span class="pre">not</span> <span class="pre">from.empty()</span></tt></li>
387<li>Effects: Inserts the object defined by <tt class="docutils literal"><span class="pre">object</span></tt> into the container and remove it from <tt class="docutils literal"><span class="pre">from</span></tt>
388iff no equivalent object exists.</li>
389<li>Returns: whether the object was transfered</li>
390<li>Exception safety: Strong guarantee</li>
391</ul>
392</blockquote>
393</li>
394<li><p class="first"><tt class="docutils literal"><span class="pre">void</span> <span class="pre">transfer(</span> <span class="pre">iterator</span> <span class="pre">first,</span> <span class="pre">iterator</span> <span class="pre">last,</span> <span class="pre">ptr__set_adapter&amp;</span> <span class="pre">from</span> <span class="pre">);</span></tt></p>
395<blockquote>
396<ul class="simple">
397<li>Requirements: <tt class="docutils literal"><span class="pre">not</span> <span class="pre">from.empty()</span></tt></li>
398<li>Effects: Inserts the objects defined by the range <tt class="docutils literal"><span class="pre">[first,last)</span></tt> into the container and remove it from <tt class="docutils literal"><span class="pre">from</span></tt>.
399An object is only transferred if no equivalent object exists.</li>
400<li>Returns: the number of transfered objects</li>
401<li>Exception safety: Basic guarantee</li>
402</ul>
403</blockquote>
404</li>
405<li><p class="first"><tt class="docutils literal"><span class="pre">template&lt;</span> <span class="pre">class</span> <span class="pre">Range</span> <span class="pre">&gt;</span> <span class="pre">void</span> <span class="pre">transfer(</span> <span class="pre">const</span> <span class="pre">Range&amp;</span> <span class="pre">r,</span> <span class="pre">ptr_set_adapter&amp;</span> <span class="pre">from</span> <span class="pre">);</span></tt></p>
406<blockquote>
407<ul class="simple">
408<li>Effects: <tt class="docutils literal"><span class="pre">return</span> <span class="pre">transfer(</span> <span class="pre">boost::begin(r),</span> <span class="pre">boost::end(r),</span> <span class="pre">from</span> <span class="pre">);</span></tt></li>
409</ul>
410</blockquote>
411</li>
412<li><p class="first"><tt class="docutils literal"><span class="pre">size_type</span> <span class="pre">transfer(</span> <span class="pre">ptr_set_adapter&amp;</span> <span class="pre">from</span> <span class="pre">);</span></tt></p>
413<blockquote>
414<ul class="simple">
415<li>Effects: <tt class="docutils literal"><span class="pre">return</span> <span class="pre">transfer(</span> <span class="pre">from.begin(),</span> <span class="pre">from.end(),</span> <span class="pre">from</span> <span class="pre">);</span></tt>.</li>
416</ul>
417</blockquote>
418</li>
419</ul>
420<hr><table class="docutils field-list" frame="void" rules="none">
421<col class="field-name" />
422<col class="field-body" />
423<tbody valign="top">
424<tr class="field"><th class="field-name">Copyright:</th><td class="field-body">Thorsten Ottosen 2004-2006. Use, modification and distribution is subject to the Boost Software License, Version 1.0 (see <a class="reference" href="http://www.boost.org/LICENSE_1_0.txt">LICENSE_1_0.txt</a>).</td>
425</tr>
426</tbody>
427</table>
428</div>
429</div>
430</div>
431</body>
432</html>
Ceph