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">
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">
11 :Author: David Goodger
12 :Contact: goodger@users.sourceforge.net
15 :Copyright: This stylesheet has been placed in the public domain.
17 Default cascading style sheet for the HTML output of Docutils.
19 See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
20 customize this style sheet.
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 */
27 margin-top:
0 ! important }
29 .last, .with-subtitle {
30 margin-bottom:
0 ! important }
36 text-decoration: none ;
43 margin-bottom:
0.5em }
45 /* Uncomment (and remove this text!) to get bold-faced definition list terms
53 div.abstract p.topic-title {
57 div.admonition, div.attention, div.caution, div.danger, div.error,
58 div.hint, div.important, div.note, div.tip, div.warning {
60 border: medium outset ;
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 {
67 font-family: sans-serif }
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 {
74 font-family: sans-serif }
76 /* Uncomment (and remove this text!) to get reduced vertical space in
78 div.compound .compound-first, div.compound .compound-middle {
79 margin-bottom:
0.5em }
81 div.compound .compound-last, div.compound .compound-middle {
90 div.dedication p.topic-title {
97 div.footer, div.header {
106 div.line-block div.line-block {
113 border: medium outset ;
115 background-color: #ffffee ;
120 div.sidebar p.rubric {
121 font-family: sans-serif ;
124 div.system-messages {
127 div.system-messages h1 {
131 border: medium outset ;
134 div.system-message p.system-message-title {
141 h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
142 h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
163 ol.simple, ul.simple {
167 list-style: decimal }
170 list-style: lower-alpha }
173 list-style: upper-alpha }
176 list-style: lower-roman }
179 list-style: upper-roman }
193 white-space: nowrap }
202 font-family: sans-serif ;
207 font-family: sans-serif ;
223 pre.literal-block, pre.doctest-block {
226 background-color: #eeeeee }
229 font-family: sans-serif ;
230 font-style: oblique }
232 span.classifier-delimiter {
233 font-family: sans-serif ;
237 font-family: sans-serif }
240 white-space: nowrap }
248 span.section-subtitle {
249 /* font-size relative to parent (h1..h6 element) */
253 border-left: solid thin gray }
260 margin-bottom:
0.5em }
263 border-left: solid thin black }
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 }
271 table.docutils th.field-name, table.docinfo th.docinfo-name {
274 white-space: nowrap ;
277 h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
278 h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
282 background-color: #eeeeee }
285 list-style-type: none }
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-deque" name=
"class-ptr-deque">Class
<tt class=
"docutils literal"><span class=
"pre">ptr_deque
</span></tt></a></h1>
294 <p>A
<tt class=
"docutils literal"><span class=
"pre">ptr_deque
<T
></span></tt> is a pointer container that uses an underlying
<tt class=
"docutils literal"><span class=
"pre">std:deque
<void*
></span></tt>
295 to store the pointers.
</p>
296 <p><strong>Hierarchy:
</strong></p>
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><a class=
"reference" href=
"ptr_vector.html">ptr_vector
</a></li>
301 <li><a class=
"reference" href=
"ptr_list.html">ptr_list
</a></li>
302 <li><tt class=
"docutils literal"><span class=
"pre">ptr_deque
</span></tt></li>
303 <li><a class=
"reference" href=
"ptr_array.html">ptr_array
</a></li>
309 <p><strong>Navigate:
</strong></p>
311 <li><a class=
"reference" href=
"ptr_container.html">home
</a></li>
312 <li><a class=
"reference" href=
"reference.html">reference
</a></li>
314 <p><strong>Synopsis:
</strong></p>
315 <pre class=
"literal-block">
322 class CloneAllocator = heap_clone_allocator
323 class Allocator = std::allocator
<void*
>
325 class ptr_deque : public ptr_sequence_adapter
328 std::deque
<void*,Allocator
>,
333 public: //
<a class=
"reference" href=
"#element-access">element access
</a>
334 T
& operator[]( size_type n );
335 const T
& operator[]( size_type n ) const;
336 T
& at( size_type n );
337 const T
& at( size_type n ) const;
339 public: //
<a class=
"reference" href=
"#modifiers">modifiers
</a>
340 void push_front( T* x );
341 template
< class U
>
342 void push_front( std::auto_ptr
<U
> x );
343 auto_type pop_front();
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;
353 } // namespace 'boost'
356 <div class=
"section">
357 <h1><a id=
"semantics" name=
"semantics">Semantics
</a></h1>
358 <div class=
"section">
359 <h2><a id=
"semantics-modifiers" name=
"semantics-modifiers"><span id=
"modifiers"></span>Semantics: modifiers
</a></h2>
361 <li><p class=
"first"><tt class=
"docutils literal"><span class=
"pre">void
</span> <span class=
"pre">push_front(
</span> <span class=
"pre">T*
</span> <span class=
"pre">x
</span> <span class=
"pre">);
</span></tt></p>
364 <li>Requirements:
<tt class=
"docutils literal"><span class=
"pre">x
</span> <span class=
"pre">!=
</span> <span class=
"pre">0</span></tt></li>
365 <li>Effects: Inserts the pointer into container and takes ownership of it
</li>
366 <li>Throws:
<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>
367 <li>Exception safety: Strong guarantee
</li>
371 <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">void
</span> <span class=
"pre">push_front(
</span> <span class=
"pre">std::auto_ptr
<U
></span> <span class=
"pre">x
</span> <span class=
"pre">);
</span></tt></p>
374 <li>Effects:
<tt class=
"docutils literal"><span class=
"pre">push_front(
</span> <span class=
"pre">x.release()
</span> <span class=
"pre">);
</span></tt></li>
379 <!-- - ``void push_front( const T& x );``
381 - Effects: push_front( allocate_clone( x ) );
383 - Exception safety: Strong guarantee -->
385 <li><p class=
"first"><tt class=
"docutils literal"><span class=
"pre">auto_type
</span> <span class=
"pre">pop_front():
</span></tt></p>
388 <li>Requirements:
<tt class=
"docutils literal"><span class=
"pre">not
</span> <span class=
"pre">empty()
</span></tt></li>
389 <li>Effects: Removes the first element in the container
</li>
390 <li>Postconditions:
<tt class=
"docutils literal"><span class=
"pre">size()
</span></tt> is one less
</li>
391 <li>Throws:
<tt class=
"docutils literal"><span class=
"pre">bad_ptr_container_operation
</span></tt> if
<tt class=
"docutils literal"><span class=
"pre">empty()
</span> <span class=
"pre">==
</span> <span class=
"pre">true
</span></tt></li>
392 <li>Exception safety: Strong guarantee
</li>
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>
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>
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>
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>
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>
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>
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">>=size()
</span></tt></li>
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>
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>
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>
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>
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>
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>
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>
455 <hr><table class=
"docutils field-list" frame=
"void" rules=
"none">
456 <col class=
"field-name" />
457 <col class=
"field-body" />
459 <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>