| <?xml version="1.0" encoding="utf-8" ?> |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
| <meta name="generator" content="Docutils 0.3.10: http://docutils.sourceforge.net/" /> |
| <title>Boost Pointer Container Library</title> |
| <style type="text/css"> |
| |
| /* |
| :Author: David Goodger |
| :Contact: goodger@users.sourceforge.net |
| :Date: $Date: 2008-07-16 17:03:47 -0400 (Wed, 16 Jul 2008) $ |
| :Revision: $Revision: 47494 $ |
| :Copyright: This stylesheet has been placed in the public domain. |
| |
| Default cascading style sheet for the HTML output of Docutils. |
| |
| See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to |
| customize this style sheet. |
| */ |
| |
| /* "! important" is used here to override other ``margin-top`` and |
| ``margin-bottom`` styles that are later in the stylesheet or |
| more specific. See http://www.w3.org/TR/CSS1#the-cascade */ |
| .first { |
| margin-top: 0 ! important } |
| |
| .last, .with-subtitle { |
| margin-bottom: 0 ! important } |
| |
| .hidden { |
| display: none } |
| |
| a.toc-backref { |
| text-decoration: none ; |
| color: black } |
| |
| blockquote.epigraph { |
| margin: 2em 5em ; } |
| |
| dl.docutils dd { |
| margin-bottom: 0.5em } |
| |
| /* Uncomment (and remove this text!) to get bold-faced definition list terms |
| dl.docutils dt { |
| font-weight: bold } |
| */ |
| |
| div.abstract { |
| margin: 2em 5em } |
| |
| div.abstract p.topic-title { |
| font-weight: bold ; |
| text-align: center } |
| |
| div.admonition, div.attention, div.caution, div.danger, div.error, |
| div.hint, div.important, div.note, div.tip, div.warning { |
| margin: 2em ; |
| border: medium outset ; |
| padding: 1em } |
| |
| div.admonition p.admonition-title, div.hint p.admonition-title, |
| div.important p.admonition-title, div.note p.admonition-title, |
| div.tip p.admonition-title { |
| font-weight: bold ; |
| font-family: sans-serif } |
| |
| div.attention p.admonition-title, div.caution p.admonition-title, |
| div.danger p.admonition-title, div.error p.admonition-title, |
| div.warning p.admonition-title { |
| color: red ; |
| font-weight: bold ; |
| font-family: sans-serif } |
| |
| /* Uncomment (and remove this text!) to get reduced vertical space in |
| compound paragraphs. |
| div.compound .compound-first, div.compound .compound-middle { |
| margin-bottom: 0.5em } |
| |
| div.compound .compound-last, div.compound .compound-middle { |
| margin-top: 0.5em } |
| */ |
| |
| div.dedication { |
| margin: 2em 5em ; |
| text-align: center ; |
| font-style: italic } |
| |
| div.dedication p.topic-title { |
| font-weight: bold ; |
| font-style: normal } |
| |
| div.figure { |
| margin-left: 2em } |
| |
| div.footer, div.header { |
| clear: both; |
| font-size: smaller } |
| |
| div.line-block { |
| display: block ; |
| margin-top: 1em ; |
| margin-bottom: 1em } |
| |
| div.line-block div.line-block { |
| margin-top: 0 ; |
| margin-bottom: 0 ; |
| margin-left: 1.5em } |
| |
| div.sidebar { |
| margin-left: 1em ; |
| border: medium outset ; |
| padding: 1em ; |
| background-color: #ffffee ; |
| width: 40% ; |
| float: right ; |
| clear: right } |
| |
| div.sidebar p.rubric { |
| font-family: sans-serif ; |
| font-size: medium } |
| |
| div.system-messages { |
| margin: 5em } |
| |
| div.system-messages h1 { |
| color: red } |
| |
| div.system-message { |
| border: medium outset ; |
| padding: 1em } |
| |
| div.system-message p.system-message-title { |
| color: red ; |
| font-weight: bold } |
| |
| div.topic { |
| margin: 2em } |
| |
| h1.section-subtitle, h2.section-subtitle, h3.section-subtitle, |
| h4.section-subtitle, h5.section-subtitle, h6.section-subtitle { |
| margin-top: 0.4em } |
| |
| h1.title { |
| text-align: center } |
| |
| h2.subtitle { |
| text-align: center } |
| |
| hr.docutils { |
| width: 75% } |
| |
| img.align-left { |
| clear: left } |
| |
| img.align-right { |
| clear: right } |
| |
| img.borderless { |
| border: 0 } |
| |
| ol.simple, ul.simple { |
| margin-bottom: 1em } |
| |
| ol.arabic { |
| list-style: decimal } |
| |
| ol.loweralpha { |
| list-style: lower-alpha } |
| |
| ol.upperalpha { |
| list-style: upper-alpha } |
| |
| ol.lowerroman { |
| list-style: lower-roman } |
| |
| ol.upperroman { |
| list-style: upper-roman } |
| |
| p.attribution { |
| text-align: right ; |
| margin-left: 50% } |
| |
| p.caption { |
| font-style: italic } |
| |
| p.credits { |
| font-style: italic ; |
| font-size: smaller } |
| |
| p.label { |
| white-space: nowrap } |
| |
| p.rubric { |
| font-weight: bold ; |
| font-size: larger ; |
| color: maroon ; |
| text-align: center } |
| |
| p.sidebar-title { |
| font-family: sans-serif ; |
| font-weight: bold ; |
| font-size: larger } |
| |
| p.sidebar-subtitle { |
| font-family: sans-serif ; |
| font-weight: bold } |
| |
| p.topic-title { |
| font-weight: bold } |
| |
| pre.address { |
| margin-bottom: 0 ; |
| margin-top: 0 ; |
| font-family: serif ; |
| font-size: 100% } |
| |
| pre.line-block { |
| font-family: serif ; |
| font-size: 100% } |
| |
| pre.literal-block, pre.doctest-block { |
| margin-left: 2em ; |
| margin-right: 2em ; |
| background-color: #eeeeee } |
| |
| span.classifier { |
| font-family: sans-serif ; |
| font-style: oblique } |
| |
| span.classifier-delimiter { |
| font-family: sans-serif ; |
| font-weight: bold } |
| |
| span.interpreted { |
| font-family: sans-serif } |
| |
| span.option { |
| white-space: nowrap } |
| |
| span.pre { |
| white-space: pre } |
| |
| span.problematic { |
| color: red } |
| |
| span.section-subtitle { |
| /* font-size relative to parent (h1..h6 element) */ |
| font-size: 80% } |
| |
| table.citation { |
| border-left: solid thin gray } |
| |
| table.docinfo { |
| margin: 2em 4em } |
| |
| table.docutils { |
| margin-top: 0.5em ; |
| margin-bottom: 0.5em } |
| |
| table.footnote { |
| border-left: solid thin black } |
| |
| table.docutils td, table.docutils th, |
| table.docinfo td, table.docinfo th { |
| padding-left: 0.5em ; |
| padding-right: 0.5em ; |
| vertical-align: top } |
| |
| table.docutils th.field-name, table.docinfo th.docinfo-name { |
| font-weight: bold ; |
| text-align: left ; |
| white-space: nowrap ; |
| padding-left: 0 } |
| |
| h1 tt.docutils, h2 tt.docutils, h3 tt.docutils, |
| h4 tt.docutils, h5 tt.docutils, h6 tt.docutils { |
| font-size: 100% } |
| |
| tt.docutils { |
| background-color: #eeeeee } |
| |
| ul.auto-toc { |
| list-style-type: none } |
| |
| </style> |
| </head> |
| <body> |
| <div class="document" id="boost-pointer-container-library"> |
| <h1 class="title"><img alt="Boost" src="boost.png" /> Pointer Container Library</h1> |
| <div class="section"> |
| <h1><a id="class-ptr-sequence-adapter" name="class-ptr-sequence-adapter">Class <tt class="docutils literal"><span class="pre">ptr_sequence_adapter</span></tt></a></h1> |
| <p>This section describes all the common operations for all the pointer |
| sequences:</p> |
| <ul class="simple"> |
| <li><a class="reference" href="ptr_vector.html">ptr_vector</a></li> |
| <li><a class="reference" href="ptr_list.html">ptr_list</a></li> |
| <li><a class="reference" href="ptr_deque.html">ptr_deque</a></li> |
| </ul> |
| <p>The <tt class="docutils literal"><span class="pre">ptr_sequence_adapter</span></tt> is also a concrete class that you can use to create custom pointer |
| containers from.</p> |
| <p><strong>Hierarchy:</strong></p> |
| <ul class="simple"> |
| <li><a class="reference" href="reversible_ptr_container.html">reversible_ptr_container</a><ul> |
| <li><tt class="docutils literal"><span class="pre">ptr_sequence_adapter</span></tt><ul> |
| <li><a class="reference" href="ptr_vector.html">ptr_vector</a></li> |
| <li><a class="reference" href="ptr_list.html">ptr_list</a></li> |
| <li><a class="reference" href="ptr_deque.html">ptr_deque</a></li> |
| <li><a class="reference" href="ptr_array.html">ptr_array</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <p><strong>Navigate:</strong></p> |
| <ul class="simple"> |
| <li><a class="reference" href="ptr_container.html">home</a></li> |
| <li><a class="reference" href="reference.html">reference</a></li> |
| </ul> |
| <p><strong>Synopsis:</strong></p> |
| <pre class="literal-block"> |
| namespace boost |
| { |
| |
| template |
| < |
| class T, |
| class VoidPtrSeq, |
| class CloneAllocator = heap_clone_allocator |
| > |
| class ptr_sequence_adapter |
| { |
| public: // <a class="reference" href="#construct-copy-destroy">construct/copy/destroy</a> |
| template< class InputIterator > |
| assign( InputIterator first, InputIterator last ); |
| template< class InputRange > |
| assign( const InputRange& e ); |
| |
| public: // <a class="reference" href="#element-access">element access</a> |
| T& front(); |
| const T& front() const; |
| T& back(); |
| const T& back() const; |
| |
| public: // <a class="reference" href="#modifiers">modifiers</a> |
| void push_back( T* x ); |
| template< class U > |
| void push_back( std::auto_ptr<U> x ); |
| auto_type pop_back(); |
| iterator insert( iterator position, T* x ); |
| template< class U > |
| iterator insert( iterator position, std::auto_ptr<U> x ); |
| template< class InputIterator > |
| void insert( iterator position, InputIterator first, InputIterator last ); |
| template< class InputRange > |
| void insert( iterator position, const InputRange& r ); |
| iterator erase( iterator position ); |
| iterator erase( iterator first, iterator last ); |
| template< class Range > |
| iterator erase( const Range& r ); |
| void resize( size_type size ); |
| void resize( size_type size, T* to_clone ); |
| |
| public: // <a class="reference" href="#pointer-container-requirements">pointer container requirements</a> |
| template< class PtrSequence > |
| void transfer( iterator before, typename PtrSequence::iterator object, |
| PtrSequence& from ); |
| template< class PtrSequence > |
| void transfer( iterator before, typename PtrSequence::iterator first, typename PtrSequence::iterator last, |
| PtrSequence& from ); |
| void template< class PtrSequence, class Range > |
| void transfer( iterator before, const Range& r, PtrSequence& from ); |
| template< class PtrSequence > |
| void transfer( iterator before, PtrSequence& from ); |
| |
| public: // <a class="reference" href="#algorithms">algorithms</a> |
| |
| void sort(); |
| void sort( iterator first, iterator last ); |
| template< class Compare > |
| void sort( Compare comp ); |
| template< class Compare > |
| void sort( iterator begin, iterator end, Compare comp ); |
| |
| void unique(); |
| void unique( iterator first, iterator last ); |
| template< class Compare > |
| void unique( Compare comp ); |
| template< class Compare > |
| void unique( iterator begin, iterator end, Compare comp ); |
| |
| template< class Pred > |
| void erase_if( Pred pred ); |
| template< class Pred > |
| void erase_if( iterator begin, iterator end, Pred pred ); |
| |
| void merge( ptr_sequence_adapter& r ); |
| template< class Compare > |
| void merge( ptr_sequence_adapter& r, Compare comp ); |
| void merge( iterator first, iterator last, ptr_sequence_adapter& from ); |
| template< class Compare > |
| void merge( iterator first, iterator last, ptr_sequence_adapter& from, Compare comp ); |
| |
| public: // <a class="reference" href="ptr_list.html">ptr_list interface</a> |
| |
| public: // <a class="reference" href="ptr_vector.html">ptr_vector interface</a> |
| |
| public: // <a class="reference" href="ptr_deque.html">ptr_deque interface</a> |
| |
| }; // class 'ptr_sequence_adapter' |
| |
| } // namespace 'boost' |
| </pre> |
| </div> |
| <div class="section"> |
| <h1><a id="semantics" name="semantics">Semantics</a></h1> |
| <div class="section"> |
| <h2><a id="semantics-construct-copy-destroy" name="semantics-construct-copy-destroy"><span id="construct-copy-destroy"></span>Semantics: construct/copy/destroy</a></h2> |
| <ul> |
| <li><p class="first"><tt class="docutils literal"><span class="pre">template<</span> <span class="pre">class</span> <span class="pre">InputIterator</span> <span class="pre">></span> |
| <span class="pre">void</span> <span class="pre">assign(</span> <span class="pre">InputIterator</span> <span class="pre">first,</span> <span class="pre">InputIterator</span> <span class="pre">last</span> <span class="pre">);</span></tt></p> |
| <blockquote> |
| <ul class="simple"> |
| <li>Requirements: <tt class="docutils literal"><span class="pre">(first,last]</span></tt> is a valid range</li> |
| <li>Effects: <tt class="docutils literal"><span class="pre">clear();</span> <span class="pre">insert(</span> <span class="pre">first,</span> <span class="pre">last</span> <span class="pre">);</span></tt></li> |
| <li>Postconditions: <tt class="docutils literal"><span class="pre">size()</span> <span class="pre">==</span> <span class="pre">std::distance(</span> <span class="pre">first,</span> <span class="pre">last</span> <span class="pre">);</span></tt></li> |
| <li>Exception safety: strong guarantee</li> |
| </ul> |
| </blockquote> |
| </li> |
| <li><p class="first"><tt class="docutils literal"><span class="pre">template<</span> <span class="pre">class</span> <span class="pre">InputRange</span> <span class="pre">></span> |
| <span class="pre">void</span> <span class="pre">assign(</span> <span class="pre">const</span> <span class="pre">InputRange&</span> <span class="pre">r</span> <span class="pre">);</span></tt></p> |
| <blockquote> |
| <ul class="simple"> |
| <li>Effects: <tt class="docutils literal"><span class="pre">assign(</span> <span class="pre">boost::begin(r),</span> <span class="pre">boost::end(r)</span> <span class="pre">);</span></tt></li> |
| </ul> |
| </blockquote> |
| </li> |
| </ul> |
| <!-- - ``assign( size_type n, const T& u )`` |
| |
| - Effects: ``clear(); insert( begin(), n, u );`` |
| |
| - Postconditions: ``size() == n`` |
| |
| - Exception safety: Strong guarantee --> |
| <!-- void resize( size_type sz, const T& x ); |
| Effects: |
| |
| if ( sz > size() ) |
| insert( end(), sz-size(), x ); |
| else if ( sz < size() ) |
| erase( begin()+sz, end() ); |
| else |
| ; //do nothing |
| |
| Postconditions: size() == sz |
| |
| Exception safety: Strong guarantee --> |
| </div> |
| <div class="section"> |
| <h2><a id="semantics-element-access" name="semantics-element-access"><span id="element-access"></span>Semantics: element access</a></h2> |
| <ul> |
| <li><p class="first"><tt class="docutils literal"><span class="pre">T&</span> <span class="pre">front();</span></tt></p> |
| <blockquote> |
| <ul class="simple"> |
| <li>Requirements: <tt class="docutils literal"><span class="pre">not</span> <span class="pre">empty();</span></tt></li> |
| <li>Effects: <tt class="docutils literal"><span class="pre">return</span> <span class="pre">*begin();</span></tt></li> |
| </ul> |
| </blockquote> |
| </li> |
| <li><p class="first"><tt class="docutils literal"><span class="pre">const</span> <span class="pre">T&</span> <span class="pre">front()</span> <span class="pre">const;</span></tt></p> |
| <blockquote> |
| <ul class="simple"> |
| <li>Requirements: <tt class="docutils literal"><span class="pre">not</span> <span class="pre">empty();</span></tt></li> |
| <li>Effects: <tt class="docutils literal"><span class="pre">return</span> <span class="pre">*begin();</span></tt></li> |
| </ul> |
| </blockquote> |
| </li> |
| <li><p class="first"><tt class="docutils literal"><span class="pre">T&</span> <span class="pre">back();</span></tt></p> |
| <blockquote> |
| <ul class="simple"> |
| <li>Requirements: <tt class="docutils literal"><span class="pre">not</span> <span class="pre">empty();</span></tt></li> |
| <li>Effects: <tt class="docutils literal"><span class="pre">return</span> <span class="pre">*--end();</span></tt></li> |
| </ul> |
| </blockquote> |
| </li> |
| <li><p class="first"><tt class="docutils literal"><span class="pre">const</span> <span class="pre">T&</span> <span class="pre">back()</span> <span class="pre">const;</span></tt></p> |
| <blockquote> |
| <ul class="simple"> |
| <li>Requirements: <tt class="docutils literal"><span class="pre">not</span> <span class="pre">empty();</span></tt></li> |
| <li>Effects: <tt class="docutils literal"><span class="pre">return</span> <span class="pre">*--end();</span></tt></li> |
| </ul> |
| </blockquote> |
| </li> |
| </ul> |
| </div> |
| <div class="section"> |
| <h2><a id="semantics-modifiers" name="semantics-modifiers"><span id="modifiers"></span>Semantics: modifiers</a></h2> |
| <ul> |
| <li><p class="first"><tt class="docutils literal"><span class="pre">void</span> <span class="pre">push_back(</span> <span class="pre">T*</span> <span class="pre">x</span> <span class="pre">);</span></tt></p> |
| <blockquote> |
| <ul class="simple"> |
| <li>Requirements: <tt class="docutils literal"><span class="pre">x</span> <span class="pre">!=</span> <span class="pre">0</span></tt></li> |
| <li>Effects: Inserts the pointer into container and takes ownership of it</li> |
| <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> |
| <li>Exception safety: Strong guarantee</li> |
| </ul> |
| </blockquote> |
| </li> |
| <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_back(</span> <span class="pre">std::auto_ptr<U></span> <span class="pre">x</span> <span class="pre">);</span></tt></p> |
| <blockquote> |
| <ul class="simple"> |
| <li>Effects: <tt class="docutils literal"><span class="pre">push_back(</span> <span class="pre">x.release()</span> <span class="pre">);</span></tt></li> |
| </ul> |
| </blockquote> |
| </li> |
| </ul> |
| <!-- - ``void push_back( const T& x );`` |
| |
| - Effects: ``push_back( CloneAllocator::clone( x ) );`` |
| |
| - Exception safety: Strong guarantee --> |
| <ul> |
| <li><p class="first"><tt class="docutils literal"><span class="pre">auto_type</span> <span class="pre">pop_back();</span></tt></p> |
| <blockquote> |
| <ul class="simple"> |
| <li>Requirements:<tt class="docutils literal"><span class="pre">not</span> <span class="pre">empty()</span></tt></li> |
| <li>Effects: Removes the last element in the container</li> |
| <li>Postconditions: <tt class="docutils literal"><span class="pre">size()</span></tt> is one less</li> |
| <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> |
| <li>Exception safety: Strong guarantee</li> |
| </ul> |
| </blockquote> |
| </li> |
| <li><p class="first"><tt class="docutils literal"><span class="pre">iterator</span> <span class="pre">insert(</span> <span class="pre">iterator</span> <span class="pre">position,</span> <span class="pre">T*</span> <span class="pre">x</span> <span class="pre">);</span></tt></p> |
| <blockquote> |
| <ul class="simple"> |
| <li>Requirements: <tt class="docutils literal"><span class="pre">position</span></tt> is a valid iterator from the container and |
| <tt class="docutils literal"><span class="pre">x</span> <span class="pre">!=</span> <span class="pre">0</span></tt></li> |
| <li>Effects: Inserts <tt class="docutils literal"><span class="pre">x</span></tt> before <tt class="docutils literal"><span class="pre">position</span></tt> and returns an iterator pointing to it</li> |
| <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> |
| <li>Exception safety: Strong guarantee</li> |
| </ul> |
| </blockquote> |
| </li> |
| <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">iterator</span> <span class="pre">insert(</span> <span class="pre">iterator</span> <span class="pre">position,</span> <span class="pre">std::auto_ptr<U></span> <span class="pre">x</span> <span class="pre">);</span></tt></p> |
| <blockquote> |
| <ul class="simple"> |
| <li>Effects: <tt class="docutils literal"><span class="pre">return</span> <span class="pre">insert(</span> <span class="pre">position,</span> <span class="pre">x.release()</span> <span class="pre">);</span></tt></li> |
| </ul> |
| </blockquote> |
| </li> |
| </ul> |
| <!-- - ``iterator insert( iterator position, const T& x );`` |
| |
| - Requirements: ``position`` is a valid iterator from the container |
| |
| - Effects: ``return insert( position, CloneAllocator::clone( x ) );`` |
| |
| - Exception safety: Strong guarantee |
| |
| - ``void insert( iterator position, size_type n, const T& x );`` |
| |
| - Requirements: ``position`` is a valid iterator from the container |
| |
| - Effects: Inserts ``n`` clones of ``x`` before position into the container |
| |
| - Exception safety: Strong guarantee --> |
| <ul> |
| <li><p class="first"><tt class="docutils literal"><span class="pre">template<</span> <span class="pre">class</span> <span class="pre">InputIterator</span> <span class="pre">></span> |
| <span class="pre">void</span> <span class="pre">insert(</span> <span class="pre">iterator</span> <span class="pre">position,</span> <span class="pre">InputIterator</span> <span class="pre">first,</span> <span class="pre">InputIterator</span> <span class="pre">last</span> <span class="pre">);</span></tt></p> |
| <blockquote> |
| <ul class="simple"> |
| <li>Requirements: <tt class="docutils literal"><span class="pre">position</span></tt> is a valid iterator from the container</li> |
| <li>Effects: Inserts a cloned range before <tt class="docutils literal"><span class="pre">position</span></tt></li> |
| <li>Exception safety: Strong guarantee</li> |
| </ul> |
| </blockquote> |
| </li> |
| <li><p class="first"><tt class="docutils literal"><span class="pre">template<</span> <span class="pre">class</span> <span class="pre">InputRange</span> <span class="pre">></span> |
| <span class="pre">void</span> <span class="pre">insert(</span> <span class="pre">iterator</span> <span class="pre">position,</span> <span class="pre">const</span> <span class="pre">InputRange&</span> <span class="pre">r</span> <span class="pre">);</span></tt></p> |
| <blockquote> |
| <ul class="simple"> |
| <li>Effects: <tt class="docutils literal"><span class="pre">insert(</span> <span class="pre">position,</span> <span class="pre">boost::begin(r),</span> <span class="pre">boost::end(r)</span> <span class="pre">);</span></tt></li> |
| </ul> |
| </blockquote> |
| </li> |
| <li><p class="first"><tt class="docutils literal"><span class="pre">iterator</span> <span class="pre">erase(</span> <span class="pre">iterator</span> <span class="pre">position</span> <span class="pre">);</span></tt></p> |
| <blockquote> |
| <ul class="simple"> |
| <li>Requirements: <tt class="docutils literal"><span class="pre">position</span></tt> is a valid iterator from the container</li> |
| <li>Effects: Removes the element defined by <tt class="docutils literal"><span class="pre">position</span></tt> and returns an iterator to the following element</li> |
| <li>Throws: Nothing</li> |
| </ul> |
| </blockquote> |
| </li> |
| <li><p class="first"><tt class="docutils literal"><span class="pre">iterator</span> <span class="pre">erase(</span> <span class="pre">iterator</span> <span class="pre">first,</span> <span class="pre">iterator</span> <span class="pre">last</span> <span class="pre">);</span></tt></p> |
| <blockquote> |
| <ul class="simple"> |
| <li>Requirements: <tt class="docutils literal"><span class="pre">[first,last)</span></tt> is a valid range</li> |
| <li>Effects: Removes the range of element defined by <tt class="docutils literal"><span class="pre">[first,last)</span></tt> and returns an iterator to the following element</li> |
| <li>Throws: Nothing</li> |
| </ul> |
| </blockquote> |
| </li> |
| <li><p class="first"><tt class="docutils literal"><span class="pre">template<</span> <span class="pre">class</span> <span class="pre">Range</span> <span class="pre">></span> |
| <span class="pre">void</span> <span class="pre">erase(</span> <span class="pre">const</span> <span class="pre">Range&</span> <span class="pre">r</span> <span class="pre">);</span></tt></p> |
| <blockquote> |
| <ul class="simple"> |
| <li>Effects: <tt class="docutils literal"><span class="pre">erase(</span> <span class="pre">boost::begin(r),</span> <span class="pre">boost::end(r)</span> <span class="pre">);</span></tt></li> |
| </ul> |
| </blockquote> |
| </li> |
| <li><p class="first"><tt class="docutils literal"><span class="pre">void</span> <span class="pre">resize(</span> <span class="pre">size_type</span> <span class="pre">size</span> <span class="pre">);</span></tt></p> |
| <blockquote> |
| <ul class="simple"> |
| <li>Effects: Resizes the container. If elements are erased, it happens from the back. If elements are inserted, it happens at the back.</li> |
| <li>Requirements: <tt class="docutils literal"><span class="pre">T</span></tt> is default constructible</li> |
| <li>Postcondition: <tt class="docutils literal"><span class="pre">size()</span> <span class="pre">==</span> <span class="pre">size;</span></tt></li> |
| <li>Exception safety: Basic guarantee under expansion; nothrow guarantee otherwise</li> |
| </ul> |
| </blockquote> |
| </li> |
| <li><p class="first"><tt class="docutils literal"><span class="pre">void</span> <span class="pre">resize(</span> <span class="pre">size_type</span> <span class="pre">size,</span> <span class="pre">T*</span> <span class="pre">to_clone</span> <span class="pre">);</span></tt></p> |
| <blockquote> |
| <ul class="simple"> |
| <li>Effects: Resizes the container. If elements are erased, it happens from the back. If elements are inserted, clones of <tt class="docutils literal"><span class="pre">*to_clone</span></tt> are inserted at the back.</li> |
| <li>Postcondition: <tt class="docutils literal"><span class="pre">size()</span> <span class="pre">==</span> <span class="pre">size;</span></tt></li> |
| <li>Exception safety: Basic guarantee under expansion; nothrow guarantee otherwise</li> |
| <li>Remarks: <tt class="docutils literal"><span class="pre">to_clone</span> <span class="pre">==</span> <span class="pre">0</span></tt> is valid if the container supports nulls. The container does not take ownership of <tt class="docutils literal"><span class="pre">to_clone</span></tt>.</li> |
| </ul> |
| </blockquote> |
| </li> |
| </ul> |
| </div> |
| <div class="section"> |
| <h2><a id="semantics-pointer-container-requirements" name="semantics-pointer-container-requirements"><span id="pointer-container-requirements"></span>Semantics: pointer container requirements</a></h2> |
| <p>You can use <tt class="docutils literal"><span class="pre">transfer()</span></tt> to move elements between two containers of the same type. Furthermore, |
| you can also move elements from a container of type <tt class="docutils literal"><span class="pre">T</span></tt> to a container of type <tt class="docutils literal"><span class="pre">U</span></tt> as long as |
| <tt class="docutils literal"><span class="pre">T::value_type</span></tt> is convertible to <tt class="docutils literal"><span class="pre">U::value_type</span></tt>. An example would be transferring from <tt class="docutils literal"><span class="pre">boost::ptr_vector<Derived></span></tt> |
| to <tt class="docutils literal"><span class="pre">boost::ptr_deque<Base></span></tt>.</p> |
| <p>(<strong>Remark:</strong> <em>When moving elements between two different containers, it is your responsibility to make sure the allocators are compatible.</em> |
| <em>The special latitude of being able to transfer between two different containers is only available for Sequences and not for Associative Containers.</em>)</p> |
| <!-- --> |
| <ul> |
| <li><p class="first"><tt class="docutils literal"><span class="pre">template<</span> <span class="pre">class</span> <span class="pre">PtrSequence</span> <span class="pre">></span> <span class="pre">void</span> <span class="pre">transfer(</span> <span class="pre">iterator</span> <span class="pre">before,</span> <span class="pre">typename</span> <span class="pre">PtrSequence::iterator</span> <span class="pre">object,</span> <span class="pre">PtrSequence&</span> <span class="pre">from</span> <span class="pre">);</span></tt></p> |
| <blockquote> |
| <ul class="simple"> |
| <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>. |
| Insertion takes place before <tt class="docutils literal"><span class="pre">before</span></tt>.</li> |
| <li>Postconditions: If <tt class="docutils literal"><span class="pre">from.empty()</span></tt>, nothing happens. Otherwise |
| <tt class="docutils literal"><span class="pre">size()</span></tt> is one more, <tt class="docutils literal"><span class="pre">from.size()</span></tt> is one less.</li> |
| <li>Exception safety: Strong guarantee</li> |
| </ul> |
| </blockquote> |
| </li> |
| <li><p class="first"><tt class="docutils literal"><span class="pre">template<</span> <span class="pre">class</span> <span class="pre">PtrSequence</span> <span class="pre">></span> <span class="pre">void</span> <span class="pre">transfer(</span> <span class="pre">iterator</span> <span class="pre">before,</span> <span class="pre">typename</span> <span class="pre">PtrSequence::iterator</span> <span class="pre">first,</span> <span class="pre">typename</span> <span class="pre">PtrSequence::iterator</span> <span class="pre">last,</span> <span class="pre">PtrSequence&</span> <span class="pre">from</span> <span class="pre">);</span></tt></p> |
| <blockquote> |
| <ul class="simple"> |
| <li>Requirements: <tt class="docutils literal"><span class="pre">from.size()</span> <span class="pre">>=</span> <span class="pre">std::distance(first,last)</span></tt></li> |
| <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>. |
| Insertion takes place before <tt class="docutils literal"><span class="pre">before</span></tt>.</li> |
| <li>Postconditions: If <tt class="docutils literal"><span class="pre">from.empty()</span></tt>, nothing happens. Otherwise, |
| let <tt class="docutils literal"><span class="pre">N</span> <span class="pre">==</span> <span class="pre">std::distance(first,last);</span></tt> then <tt class="docutils literal"><span class="pre">size()</span></tt> is <tt class="docutils literal"><span class="pre">N</span></tt> more, <tt class="docutils literal"><span class="pre">from.size()</span></tt> is <tt class="docutils literal"><span class="pre">N</span></tt> less.</li> |
| <li>Exception safety: Strong guarantee</li> |
| <li>Complexity: Linear or better</li> |
| </ul> |
| </blockquote> |
| </li> |
| <li><p class="first"><tt class="docutils literal"><span class="pre">void</span> <span class="pre">template<</span> <span class="pre">class</span> <span class="pre">PtrSequence,</span> <span class="pre">class</span> <span class="pre">Range</span> <span class="pre">></span> <span class="pre">void</span> <span class="pre">transfer(</span> <span class="pre">iterator</span> <span class="pre">before,</span> <span class="pre">const</span> <span class="pre">Range&</span> <span class="pre">r,</span> <span class="pre">PtrSequence&</span> <span class="pre">from</span> <span class="pre">);</span></tt></p> |
| <blockquote> |
| <ul class="simple"> |
| <li>Effects: <tt class="docutils literal"><span class="pre">transfer(before,</span> <span class="pre">boost::begin(r),</span> <span class="pre">boost::end(r),</span> <span class="pre">from);</span></tt></li> |
| </ul> |
| </blockquote> |
| </li> |
| <li><p class="first"><tt class="docutils literal"><span class="pre">template<</span> <span class="pre">class</span> <span class="pre">PtrSequence></span> <span class="pre">void</span> <span class="pre">transfer(</span> <span class="pre">iterator</span> <span class="pre">before,</span> <span class="pre">PtrSequence&</span> <span class="pre">from</span> <span class="pre">);</span></tt></p> |
| <blockquote> |
| <ul class="simple"> |
| <li>Effects: <tt class="docutils literal"><span class="pre">transfer(before,</span> <span class="pre">from,</span> <span class="pre">from);</span></tt></li> |
| </ul> |
| </blockquote> |
| </li> |
| </ul> |
| </div> |
| <div class="section"> |
| <h2><a id="semantics-algorithms" name="semantics-algorithms"><span id="algorithms"></span>Semantics: algorithms</a></h2> |
| <p>The general requirement for these algorithms is that the container <em>does not |
| contain any nulls</em>.</p> |
| <ul> |
| <li><p class="first"><tt class="docutils literal"><span class="pre">void</span> <span class="pre">sort();</span></tt></p> |
| </li> |
| <li><p class="first"><tt class="docutils literal"><span class="pre">void</span> <span class="pre">sort(</span> <span class="pre">iterator</span> <span class="pre">first,</span> <span class="pre">iterator</span> <span class="pre">last</span> <span class="pre">);</span></tt></p> |
| </li> |
| <li><p class="first"><tt class="docutils literal"><span class="pre">template<</span> <span class="pre">class</span> <span class="pre">Compare</span> <span class="pre">></span> <span class="pre">void</span> <span class="pre">sort(</span> <span class="pre">Compare</span> <span class="pre">comp</span> <span class="pre">);</span></tt></p> |
| </li> |
| <li><p class="first"><tt class="docutils literal"><span class="pre">template<</span> <span class="pre">class</span> <span class="pre">Compare</span> <span class="pre">></span> <span class="pre">void</span> <span class="pre">sort(</span> <span class="pre">iterator</span> <span class="pre">begin,</span> <span class="pre">iterator</span> <span class="pre">end,</span> <span class="pre">Compare</span> <span class="pre">comp</span> <span class="pre">);</span></tt></p> |
| <blockquote> |
| <ul class="simple"> |
| <li>Requirements: (versions without <tt class="docutils literal"><span class="pre">Compare</span></tt>) <tt class="docutils literal"><span class="pre">bool</span> <span class="pre">operator<(</span> <span class="pre">const</span> <span class="pre">T&,</span> <span class="pre">const</span> <span class="pre">T&</span> <span class="pre">)</span></tt> is defined</li> |
| <li>Requirements: (<tt class="docutils literal"><span class="pre">Compare</span></tt> versions) <tt class="docutils literal"><span class="pre">Compare</span></tt> must take <tt class="docutils literal"><span class="pre">const</span> <span class="pre">T&</span></tt> arguments</li> |
| <li>Effects: sorts the entire container or the specified range</li> |
| <li>Exception safety: nothrow guarantee (the behavior is undefined if the comparison operator throws)</li> |
| <li>Remarks: The versions of <tt class="docutils literal"><span class="pre">sort()</span></tt> that take two iterators are not available for <tt class="docutils literal"><span class="pre">ptr_list</span></tt></li> |
| </ul> |
| </blockquote> |
| </li> |
| <li><p class="first"><tt class="docutils literal"><span class="pre">void</span> <span class="pre">unique();</span></tt></p> |
| </li> |
| <li><p class="first"><tt class="docutils literal"><span class="pre">void</span> <span class="pre">unique(</span> <span class="pre">iterator</span> <span class="pre">first,</span> <span class="pre">iterator</span> <span class="pre">last</span> <span class="pre">);</span></tt></p> |
| </li> |
| <li><p class="first"><tt class="docutils literal"><span class="pre">template<</span> <span class="pre">class</span> <span class="pre">Compare</span> <span class="pre">></span> <span class="pre">void</span> <span class="pre">unique(</span> <span class="pre">Compare</span> <span class="pre">comp</span> <span class="pre">);</span></tt></p> |
| </li> |
| <li><p class="first"><tt class="docutils literal"><span class="pre">template<</span> <span class="pre">class</span> <span class="pre">Compare</span> <span class="pre">></span> <span class="pre">void</span> <span class="pre">unique(</span> <span class="pre">iterator</span> <span class="pre">begin,</span> <span class="pre">iterator</span> <span class="pre">end,</span> <span class="pre">Compare</span> <span class="pre">comp</span> <span class="pre">);</span></tt></p> |
| <blockquote> |
| <ul class="simple"> |
| <li>Requirements: (versions without <tt class="docutils literal"><span class="pre">Compare</span></tt>) <tt class="docutils literal"><span class="pre">bool</span> <span class="pre">operator==(</span> <span class="pre">const</span> <span class="pre">T&,</span> <span class="pre">const</span> <span class="pre">T&</span> <span class="pre">)</span></tt> is defined</li> |
| <li>Requirements: (<tt class="docutils literal"><span class="pre">Compare</span></tt> versions) <tt class="docutils literal"><span class="pre">Compare</span></tt> must take <tt class="docutils literal"><span class="pre">const</span> <span class="pre">T&</span></tt> arguments</li> |
| <li>Effects: removes adjacent and equal objects from the entire container or the specified range</li> |
| <li>Exception safety: nothrow guarantee (the behavior is undefined if the comparison operator throws)</li> |
| </ul> |
| </blockquote> |
| </li> |
| <li><p class="first"><tt class="docutils literal"><span class="pre">template<</span> <span class="pre">class</span> <span class="pre">Pred</span> <span class="pre">></span> <span class="pre">void</span> <span class="pre">erase_if(</span> <span class="pre">Pred</span> <span class="pre">pred</span> <span class="pre">);</span></tt></p> |
| </li> |
| <li><p class="first"><tt class="docutils literal"><span class="pre">template<</span> <span class="pre">class</span> <span class="pre">Pred</span> <span class="pre">></span> <span class="pre">void</span> <span class="pre">erase_if(</span> <span class="pre">iterator</span> <span class="pre">begin,</span> <span class="pre">iterator</span> <span class="pre">end,</span> <span class="pre">Pred</span> <span class="pre">pred</span> <span class="pre">);</span></tt></p> |
| <blockquote> |
| <ul class="simple"> |
| <li>Requirements: <tt class="docutils literal"><span class="pre">Pred</span></tt> must take an <tt class="docutils literal"><span class="pre">const</span> <span class="pre">T&</span></tt> argument</li> |
| <li>Effects: removes all elements <tt class="docutils literal"><span class="pre">t</span></tt> for which <tt class="docutils literal"><span class="pre">pred(t)</span></tt> returns <tt class="docutils literal"><span class="pre">true</span></tt> from the entire container or the specified range</li> |
| <li>Exception safety: nothrow guarantee (the behavior is undefined if the comparison operator throws)</li> |
| </ul> |
| </blockquote> |
| </li> |
| <li><p class="first"><tt class="docutils literal"><span class="pre">void</span> <span class="pre">merge(</span> <span class="pre">ptr_sequence_adapter&</span> <span class="pre">r</span> <span class="pre">);</span></tt></p> |
| </li> |
| <li><p class="first"><tt class="docutils literal"><span class="pre">template<</span> <span class="pre">class</span> <span class="pre">Compare</span> <span class="pre">></span> <span class="pre">void</span> <span class="pre">merge(</span> <span class="pre">ptr_sequence_adapter&</span> <span class="pre">r,</span> <span class="pre">Compare</span> <span class="pre">comp</span> <span class="pre">);</span></tt></p> |
| </li> |
| <li><p class="first"><tt class="docutils literal"><span class="pre">void</span> <span class="pre">merge(</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_sequence_adapter&</span> <span class="pre">from</span> <span class="pre">);</span></tt></p> |
| </li> |
| <li><p class="first"><tt class="docutils literal"><span class="pre">template<</span> <span class="pre">class</span> <span class="pre">Compare</span> <span class="pre">></span> <span class="pre">void</span> <span class="pre">merge(</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_sequence_adapter&</span> <span class="pre">from,</span> <span class="pre">Compare</span> <span class="pre">comp</span> <span class="pre">);</span></tt></p> |
| <blockquote> |
| <ul class="simple"> |
| <li>Requirements: (<tt class="docutils literal"><span class="pre">Compare</span></tt> versions) <tt class="docutils literal"><span class="pre">Compare</span></tt> must take <tt class="docutils literal"><span class="pre">const</span> <span class="pre">T&</span></tt> arguments</li> |
| <li>Requirements: both sequences are sorted wrt. the same predicate</li> |
| <li>Effects: transfers the entire container or the specified sequence to the container while |
| ensuring the new sequence is also sorted</li> |
| <li>Postconditions: (Container versions) <tt class="docutils literal"><span class="pre">r.empty()</span></tt></li> |
| <li>Exception safety: nothrow guarantee (the behavior is undefined if the comparison operator throws)</li> |
| </ul> |
| </blockquote> |
| </li> |
| </ul> |
| <hr><table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name" /> |
| <col class="field-body" /> |
| <tbody valign="top"> |
| <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> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| </div> |
| </body> |
| </html> |