]>
Commit | Line | Data |
---|---|---|
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 | ||
17 | Default cascading style sheet for the HTML output of Docutils. | |
18 | ||
19 | See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to | |
20 | customize 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 | ||
35 | a.toc-backref { | |
36 | text-decoration: none ; | |
37 | color: black } | |
38 | ||
39 | blockquote.epigraph { | |
40 | margin: 2em 5em ; } | |
41 | ||
42 | dl.docutils dd { | |
43 | margin-bottom: 0.5em } | |
44 | ||
45 | /* Uncomment (and remove this text!) to get bold-faced definition list terms | |
46 | dl.docutils dt { | |
47 | font-weight: bold } | |
48 | */ | |
49 | ||
50 | div.abstract { | |
51 | margin: 2em 5em } | |
52 | ||
53 | div.abstract p.topic-title { | |
54 | font-weight: bold ; | |
55 | text-align: center } | |
56 | ||
57 | div.admonition, div.attention, div.caution, div.danger, div.error, | |
58 | div.hint, div.important, div.note, div.tip, div.warning { | |
59 | margin: 2em ; | |
60 | border: medium outset ; | |
61 | padding: 1em } | |
62 | ||
63 | div.admonition p.admonition-title, div.hint p.admonition-title, | |
64 | div.important p.admonition-title, div.note p.admonition-title, | |
65 | div.tip p.admonition-title { | |
66 | font-weight: bold ; | |
67 | font-family: sans-serif } | |
68 | ||
69 | div.attention p.admonition-title, div.caution p.admonition-title, | |
70 | div.danger p.admonition-title, div.error p.admonition-title, | |
71 | div.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. | |
78 | div.compound .compound-first, div.compound .compound-middle { | |
79 | margin-bottom: 0.5em } | |
80 | ||
81 | div.compound .compound-last, div.compound .compound-middle { | |
82 | margin-top: 0.5em } | |
83 | */ | |
84 | ||
85 | div.dedication { | |
86 | margin: 2em 5em ; | |
87 | text-align: center ; | |
88 | font-style: italic } | |
89 | ||
90 | div.dedication p.topic-title { | |
91 | font-weight: bold ; | |
92 | font-style: normal } | |
93 | ||
94 | div.figure { | |
95 | margin-left: 2em } | |
96 | ||
97 | div.footer, div.header { | |
98 | clear: both; | |
99 | font-size: smaller } | |
100 | ||
101 | div.line-block { | |
102 | display: block ; | |
103 | margin-top: 1em ; | |
104 | margin-bottom: 1em } | |
105 | ||
106 | div.line-block div.line-block { | |
107 | margin-top: 0 ; | |
108 | margin-bottom: 0 ; | |
109 | margin-left: 1.5em } | |
110 | ||
111 | div.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 | ||
120 | div.sidebar p.rubric { | |
121 | font-family: sans-serif ; | |
122 | font-size: medium } | |
123 | ||
124 | div.system-messages { | |
125 | margin: 5em } | |
126 | ||
127 | div.system-messages h1 { | |
128 | color: red } | |
129 | ||
130 | div.system-message { | |
131 | border: medium outset ; | |
132 | padding: 1em } | |
133 | ||
134 | div.system-message p.system-message-title { | |
135 | color: red ; | |
136 | font-weight: bold } | |
137 | ||
138 | div.topic { | |
139 | margin: 2em } | |
140 | ||
141 | h1.section-subtitle, h2.section-subtitle, h3.section-subtitle, | |
142 | h4.section-subtitle, h5.section-subtitle, h6.section-subtitle { | |
143 | margin-top: 0.4em } | |
144 | ||
145 | h1.title { | |
146 | text-align: center } | |
147 | ||
148 | h2.subtitle { | |
149 | text-align: center } | |
150 | ||
151 | hr.docutils { | |
152 | width: 75% } | |
153 | ||
154 | img.align-left { | |
155 | clear: left } | |
156 | ||
157 | img.align-right { | |
158 | clear: right } | |
159 | ||
160 | img.borderless { | |
161 | border: 0 } | |
162 | ||
163 | ol.simple, ul.simple { | |
164 | margin-bottom: 1em } | |
165 | ||
166 | ol.arabic { | |
167 | list-style: decimal } | |
168 | ||
169 | ol.loweralpha { | |
170 | list-style: lower-alpha } | |
171 | ||
172 | ol.upperalpha { | |
173 | list-style: upper-alpha } | |
174 | ||
175 | ol.lowerroman { | |
176 | list-style: lower-roman } | |
177 | ||
178 | ol.upperroman { | |
179 | list-style: upper-roman } | |
180 | ||
181 | p.attribution { | |
182 | text-align: right ; | |
183 | margin-left: 50% } | |
184 | ||
185 | p.caption { | |
186 | font-style: italic } | |
187 | ||
188 | p.credits { | |
189 | font-style: italic ; | |
190 | font-size: smaller } | |
191 | ||
192 | p.label { | |
193 | white-space: nowrap } | |
194 | ||
195 | p.rubric { | |
196 | font-weight: bold ; | |
197 | font-size: larger ; | |
198 | color: maroon ; | |
199 | text-align: center } | |
200 | ||
201 | p.sidebar-title { | |
202 | font-family: sans-serif ; | |
203 | font-weight: bold ; | |
204 | font-size: larger } | |
205 | ||
206 | p.sidebar-subtitle { | |
207 | font-family: sans-serif ; | |
208 | font-weight: bold } | |
209 | ||
210 | p.topic-title { | |
211 | font-weight: bold } | |
212 | ||
213 | pre.address { | |
214 | margin-bottom: 0 ; | |
215 | margin-top: 0 ; | |
216 | font-family: serif ; | |
217 | font-size: 100% } | |
218 | ||
219 | pre.line-block { | |
220 | font-family: serif ; | |
221 | font-size: 100% } | |
222 | ||
223 | pre.literal-block, pre.doctest-block { | |
224 | margin-left: 2em ; | |
225 | margin-right: 2em ; | |
226 | background-color: #eeeeee } | |
227 | ||
228 | span.classifier { | |
229 | font-family: sans-serif ; | |
230 | font-style: oblique } | |
231 | ||
232 | span.classifier-delimiter { | |
233 | font-family: sans-serif ; | |
234 | font-weight: bold } | |
235 | ||
236 | span.interpreted { | |
237 | font-family: sans-serif } | |
238 | ||
239 | span.option { | |
240 | white-space: nowrap } | |
241 | ||
242 | span.pre { | |
243 | white-space: pre } | |
244 | ||
245 | span.problematic { | |
246 | color: red } | |
247 | ||
248 | span.section-subtitle { | |
249 | /* font-size relative to parent (h1..h6 element) */ | |
250 | font-size: 80% } | |
251 | ||
252 | table.citation { | |
253 | border-left: solid thin gray } | |
254 | ||
255 | table.docinfo { | |
256 | margin: 2em 4em } | |
257 | ||
258 | table.docutils { | |
259 | margin-top: 0.5em ; | |
260 | margin-bottom: 0.5em } | |
261 | ||
262 | table.footnote { | |
263 | border-left: solid thin black } | |
264 | ||
265 | table.docutils td, table.docutils th, | |
266 | table.docinfo td, table.docinfo th { | |
267 | padding-left: 0.5em ; | |
268 | padding-right: 0.5em ; | |
269 | vertical-align: top } | |
270 | ||
271 | table.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 | ||
277 | h1 tt.docutils, h2 tt.docutils, h3 tt.docutils, | |
278 | h4 tt.docutils, h5 tt.docutils, h6 tt.docutils { | |
279 | font-size: 100% } | |
280 | ||
281 | tt.docutils { | |
282 | background-color: #eeeeee } | |
283 | ||
284 | ul.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-vector" name="class-ptr-vector">Class <tt class="docutils literal"><span class="pre">ptr_vector</span></tt></a></h1> | |
294 | <p>A <tt class="docutils literal"><span class="pre">ptr_vector<T></span></tt> is a pointer container that uses an underlying <tt class="docutils literal"><span class="pre">std::vector<void*></span></tt> | |
295 | to store the pointers.</p> | |
296 | <p><strong>Hierarchy:</strong></p> | |
297 | <ul class="simple"> | |
298 | <li><a class="reference" href="reversible_ptr_container.html">reversible_ptr_container</a><ul> | |
299 | <li><a class="reference" href="ptr_sequence_adapter.html">ptr_sequence_adapter</a><ul> | |
300 | <li><tt class="docutils literal"><span class="pre">ptr_vector</span></tt></li> | |
301 | <li><a class="reference" href="ptr_list.html">ptr_list</a></li> | |
302 | <li><a class="reference" href="ptr_deque.html">ptr_deque</a></li> | |
303 | <li><a class="reference" href="ptr_array.html">ptr_array</a></li> | |
304 | </ul> | |
305 | </li> | |
306 | </ul> | |
307 | </li> | |
308 | </ul> | |
309 | <p><strong>Navigate:</strong></p> | |
310 | <ul class="simple"> | |
311 | <li><a class="reference" href="ptr_container.html">home</a></li> | |
312 | <li><a class="reference" href="reference.html">reference</a></li> | |
313 | </ul> | |
314 | <p><strong>Synopsis:</strong></p> | |
315 | <pre class="literal-block"> | |
316 | namespace boost | |
317 | { | |
318 | ||
319 | template | |
320 | < | |
321 | class T, | |
322 | class CloneAllocator = heap_clone_allocator, | |
323 | class Allocator = std::allocator<void*> | |
324 | > | |
325 | class ptr_vector : public ptr_sequence_adapter | |
326 | < | |
327 | T, | |
328 | std::vector<void*,Allocator>, | |
329 | CloneAllocator | |
330 | > | |
331 | { | |
332 | public: // <a class="reference" href="#construction">construction</a> | |
333 | explicit ptr_vector( size_type to_reserve ); | |
334 | ||
335 | public: // <a class="reference" href="#capacity">capacity</a> | |
336 | size_type capacity() const; | |
337 | void reserve( size_type n ); | |
338 | ||
339 | public: // <a class="reference" href="#element-access">element access</a> | |
340 | T& operator[]( size_type n ); | |
341 | const T& operator[]( size_type n ) const; | |
342 | T& at( size_type n ); | |
343 | const T& at( size_type n ) const; | |
344 | ||
345 | public: // <a class="reference" href="#pointer-container-requirements">pointer container requirements</a> | |
346 | auto_type replace( size_type idx, T* x ); | |
347 | template< class U > | |
348 | auto_type replace( size_type idx, std::auto_ptr<U> x ); | |
349 | bool is_null( size_type idx ) const; | |
350 | ||
351 | public: // <a class="reference" href="#c-array-support">C-array support</a> | |
352 | void transfer( iterator before, T** from, size_type size, bool delete_from = true ); | |
353 | T** c_array(); | |
354 | ||
355 | }; | |
356 | ||
357 | } // namespace 'boost' | |
358 | </pre> | |
359 | </div> | |
360 | <div class="section"> | |
361 | <h1><a id="semantics" name="semantics">Semantics</a></h1> | |
362 | <div class="section"> | |
363 | <h2><a id="semantics-construction" name="semantics-construction"><span id="construction"></span>Semantics: construction</a></h2> | |
364 | <ul> | |
365 | <li><p class="first"><tt class="docutils literal"><span class="pre">explicit</span> <span class="pre">ptr_vector(</span> <span class="pre">size_type</span> <span class="pre">to_reserve</span> <span class="pre">);</span></tt></p> | |
366 | <blockquote> | |
367 | <ul class="simple"> | |
368 | <li>constructs an empty vector with a buffer | |
369 | of size least <tt class="docutils literal"><span class="pre">to_reserve</span></tt></li> | |
370 | </ul> | |
371 | </blockquote> | |
372 | </li> | |
373 | </ul> | |
374 | </div> | |
375 | <div class="section"> | |
376 | <h2><a id="semantics-capacity" name="semantics-capacity"><span id="capacity"></span>Semantics: capacity</a></h2> | |
377 | <ul> | |
378 | <li><p class="first"><tt class="docutils literal"><span class="pre">size_type</span> <span class="pre">capacity()</span> <span class="pre">const;</span></tt></p> | |
379 | <blockquote> | |
380 | <ul class="simple"> | |
381 | <li>Effects: Returns the size of the allocated buffer</li> | |
382 | <li>Throws: Nothing</li> | |
383 | </ul> | |
384 | </blockquote> | |
385 | </li> | |
386 | <li><p class="first"><tt class="docutils literal"><span class="pre">void</span> <span class="pre">reserve(</span> <span class="pre">size_type</span> <span class="pre">n</span> <span class="pre">);</span></tt></p> | |
387 | <blockquote> | |
388 | <ul class="simple"> | |
389 | <li>Requirements: <tt class="docutils literal"><span class="pre">n</span> <span class="pre"><=</span> <span class="pre">max_size()</span></tt></li> | |
390 | <li>Effects: Expands the allocated buffer</li> | |
391 | <li>Postcondition: <tt class="docutils literal"><span class="pre">capacity()</span> <span class="pre">>=</span> <span class="pre">n</span></tt></li> | |
392 | <li>Throws: <tt class="docutils literal"><span class="pre">std::length_error()</span></tt> if <tt class="docutils literal"><span class="pre">n</span> <span class="pre">></span> <span class="pre">max_size()</span></tt></li> | |
393 | </ul> | |
394 | </blockquote> | |
395 | </li> | |
396 | </ul> | |
397 | </div> | |
398 | <div class="section"> | |
399 | <h2><a id="semantics-element-access" name="semantics-element-access"><span id="element-access"></span>Semantics: element access</a></h2> | |
400 | <ul> | |
401 | <li><p class="first"><tt class="docutils literal"><span class="pre">T&</span> <span class="pre">operator[](</span> <span class="pre">size_type</span> <span class="pre">n</span> <span class="pre">);</span></tt></p> | |
402 | </li> | |
403 | <li><p class="first"><tt class="docutils literal"><span class="pre">const</span> <span class="pre">T&</span> <span class="pre">operator[](</span> <span class="pre">size_type</span> <span class="pre">n</span> <span class="pre">)</span> <span class="pre">const;</span></tt></p> | |
404 | <blockquote> | |
405 | <ul class="simple"> | |
406 | <li>Requirements: <tt class="docutils literal"><span class="pre">n</span> <span class="pre"><</span> <span class="pre">size()</span></tt></li> | |
407 | <li>Effects: Returns a reference to the <tt class="docutils literal"><span class="pre">n</span></tt>'th element</li> | |
408 | <li>Throws: Nothing</li> | |
409 | </ul> | |
410 | </blockquote> | |
411 | </li> | |
412 | <li><p class="first"><tt class="docutils literal"><span class="pre">T&</span> <span class="pre">at(</span> <span class="pre">size_type</span> <span class="pre">n</span> <span class="pre">);</span></tt></p> | |
413 | </li> | |
414 | <li><p class="first"><tt class="docutils literal"><span class="pre">const</span> <span class="pre">T&</span> <span class="pre">at(</span> <span class="pre">size_type</span> <span class="pre">n</span> <span class="pre">)</span> <span class="pre">const;</span></tt></p> | |
415 | <blockquote> | |
416 | <ul class="simple"> | |
417 | <li>Requirements: <tt class="docutils literal"><span class="pre">n</span> <span class="pre"><</span> <span class="pre">size()</span></tt></li> | |
418 | <li>Effects: Returns a reference to the <tt class="docutils literal"><span class="pre">n</span></tt>'th element</li> | |
419 | <li>Throws: <tt class="docutils literal"><span class="pre">bad_index</span></tt> if <tt class="docutils literal"><span class="pre">n</span> <span class="pre">>=</span> <span class="pre">size()</span></tt></li> | |
420 | </ul> | |
421 | </blockquote> | |
422 | </li> | |
423 | </ul> | |
424 | </div> | |
425 | <div class="section"> | |
426 | <h2><a id="semantics-pointer-container-requirements" name="semantics-pointer-container-requirements"><span id="pointer-container-requirements"></span>Semantics: pointer container requirements</a></h2> | |
427 | <ul> | |
428 | <li><p class="first"><tt class="docutils literal"><span class="pre">auto_type</span> <span class="pre">replace(</span> <span class="pre">size_type</span> <span class="pre">idx,</span> <span class="pre">T*</span> <span class="pre">x</span> <span class="pre">);</span></tt></p> | |
429 | <blockquote> | |
430 | <ul class="simple"> | |
431 | <li>Requirements: `` x != 0 and idx < size()``</li> | |
432 | <li>Effects: returns the object indexed by <tt class="docutils literal"><span class="pre">idx</span></tt> and replaces it with <tt class="docutils literal"><span class="pre">x</span></tt>.</li> | |
433 | <li>Throws: <tt class="docutils literal"><span class="pre">bad_index</span></tt> if <tt class="docutils literal"><span class="pre">idx</span> <span class="pre">>=</span> <span class="pre">size()</span></tt> and <tt class="docutils literal"><span class="pre">bad_pointer</span></tt> if <tt class="docutils literal"><span class="pre">x</span> <span class="pre">==</span> <span class="pre">0</span></tt>.</li> | |
434 | <li>Exception safety: Strong guarantee</li> | |
435 | </ul> | |
436 | </blockquote> | |
437 | </li> | |
438 | <li><p class="first"><tt class="docutils literal"><span class="pre">template<</span> <span class="pre">class</span> <span class="pre">U</span> <span class="pre">></span> <span class="pre">auto_type</span> <span class="pre">replace(</span> <span class="pre">size_type</span> <span class="pre">idx,</span> <span class="pre">std::auto_ptr<U></span> <span class="pre">x</span> <span class="pre">);</span></tt></p> | |
439 | <blockquote> | |
440 | <ul class="simple"> | |
441 | <li>Effects: <tt class="docutils literal"><span class="pre">return</span> <span class="pre">replace(</span> <span class="pre">idx,</span> <span class="pre">x.release()</span> <span class="pre">);</span></tt></li> | |
442 | </ul> | |
443 | </blockquote> | |
444 | </li> | |
445 | <li><p class="first"><tt class="docutils literal"><span class="pre">bool</span> <span class="pre">is_null(</span> <span class="pre">size_type</span> <span class="pre">idx</span> <span class="pre">)</span> <span class="pre">const;</span></tt></p> | |
446 | <blockquote> | |
447 | <ul class="simple"> | |
448 | <li>Requirements: <tt class="docutils literal"><span class="pre">idx</span> <span class="pre"><</span> <span class="pre">size()</span></tt></li> | |
449 | <li>Effects: returns whether the pointer at index <tt class="docutils literal"><span class="pre">idx</span></tt> is null</li> | |
450 | <li>Exception safety: Nothrow guarantee</li> | |
451 | </ul> | |
452 | </blockquote> | |
453 | </li> | |
454 | </ul> | |
455 | </div> | |
456 | <div class="section"> | |
457 | <h2><a id="semantics-c-array-support" name="semantics-c-array-support"><span id="c-array-support"></span>Semantics: C-array support</a></h2> | |
458 | <ul> | |
459 | <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">before,</span> <span class="pre">T**</span> <span class="pre">from,</span> <span class="pre">size_type</span> <span class="pre">size,</span> <span class="pre">bool</span> <span class="pre">delete_from</span> <span class="pre">=</span> <span class="pre">true</span> <span class="pre">);</span></tt></p> | |
460 | <blockquote> | |
461 | <ul class="simple"> | |
462 | <li>Requirements: <tt class="docutils literal"><span class="pre">from</span> <span class="pre">!=</span> <span class="pre">0</span></tt></li> | |
463 | <li>Effects: Takes ownership of the dynamic array <tt class="docutils literal"><span class="pre">from</span></tt></li> | |
464 | <li>Exception safety: Strong guarantee if <tt class="docutils literal"><span class="pre">delete_from</span> <span class="pre">==</span> <span class="pre">true</span></tt>; if <tt class="docutils literal"><span class="pre">delete_from</span> <span class="pre">==</span> <span class="pre">false</span></tt>, | |
465 | and an exception is thrown, the container fails to take ownership.</li> | |
466 | <li>Remarks: Eventually calls <tt class="docutils literal"><span class="pre">delete[]</span> <span class="pre">from</span></tt> if <tt class="docutils literal"><span class="pre">delete_from</span> <span class="pre">==</span> <span class="pre">true</span></tt>.</li> | |
467 | </ul> | |
468 | </blockquote> | |
469 | </li> | |
470 | <li><p class="first"><tt class="docutils literal"><span class="pre">T**</span> <span class="pre">c_array();</span></tt></p> | |
471 | <blockquote> | |
472 | <ul class="simple"> | |
473 | <li>Returns: <tt class="docutils literal"><span class="pre">0</span></tt> if the container is empty; otherwise a pointer to the first element of the stored array</li> | |
474 | <li>Throws: Nothing</li> | |
475 | </ul> | |
476 | </blockquote> | |
477 | </li> | |
478 | </ul> | |
479 | <hr><table class="docutils field-list" frame="void" rules="none"> | |
480 | <col class="field-name" /> | |
481 | <col class="field-body" /> | |
482 | <tbody valign="top"> | |
483 | <tr class="field"><th class="field-name">Copyright:</th><td class="field-body">Thorsten Ottosen 2004-2007. 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> | |
484 | </tr> | |
485 | </tbody> | |
486 | </table> | |
487 | </div> | |
488 | </div> | |
489 | </div> | |
490 | </body> | |
491 | </html> |