| <?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: 2006-11-22 17:01:03 -0500 (Wed, 22 Nov 2006) $ |
| :Revision: $Revision: 36152 $ |
| :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-multimap-adapter" name="class-ptr-multimap-adapter">Class <tt class="docutils literal"><span class="pre">ptr_multimap_adapter</span></tt></a></h1> |
| <p>This class is used to build custom pointer containers with |
| an underlying multimap-like container. The interface of the class is an extension |
| of the interface from <tt class="docutils literal"><span class="pre">associative_ptr_container</span></tt>.</p> |
| <p><strong>Hierarchy:</strong></p> |
| <ul class="simple"> |
| <li><a class="reference" href="reversible_ptr_container.html">reversible_ptr_container</a><ul> |
| <li><a class="reference" href="associative_ptr_container.html">associative_ptr_container</a><ul> |
| <li><a class="reference" href="ptr_set_adapter.html">ptr_set_adapter</a></li> |
| <li><a class="reference" href="ptr_multiset_adapter.html">ptr_multiset_adapter</a></li> |
| <li><a class="reference" href="ptr_map_adapter.html">ptr_map_adapter</a></li> |
| <li><tt class="docutils literal"><span class="pre">ptr_multi_map_adapter</span></tt><ul> |
| <li><a class="reference" href="ptr_set.html">ptr_set</a></li> |
| <li><a class="reference" href="ptr_multiset.html">ptr_multi_set</a></li> |
| <li><a class="reference" href="ptr_map.html">ptr_map</a></li> |
| <li><a class="reference" href="ptr_multimap.html">ptr_multimap</a></li> |
| </ul> |
| </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 |
| < |
| T, |
| class VoidPtrMultiMap, |
| class CloneAllocator = heap_clone_allocator |
| > |
| class ptr_multimap_adapter |
| { |
| public: // <a class="reference" href="#typedefs">typedefs</a> |
| typedef VoidPtrMap::key_type key_type; |
| typedef T* mapped_type; |
| typedef T& mapped_reference; |
| typedef const T& const_mapped_reference; |
| typedef ... value_type; |
| typedef ... reference; |
| typedef ... const_reference; |
| typedef ... pointer; |
| typedef ... const_pointer; |
| |
| public: // <a class="reference" href="#modifiers">modifiers</a> |
| iterator insert( key_type& k, T* x ); |
| template< class U > |
| iterator insert( const key_type&, std::auto_ptr<U> x ); |
| |
| public: // <a class="reference" href="#pointer-container-requirements">pointer container requirements</a> |
| void transfer( iterator object, ptr_multimap_adapter& from ); |
| size_type transfer( iterator first, iterator last, ptr_multimap_adapter& from ); |
| template< class Range > |
| size_type transfer( const Range& r, ptr_multimap_adapter& from ); |
| void transfer( ptr_multimap_adapter& from ); |
| |
| }; // class 'ptr_multimap_adapter' |
| |
| } // namespace 'boost' |
| </pre> |
| </div> |
| <div class="section"> |
| <h1><a id="semantics" name="semantics">Semantics</a></h1> |
| <p>. <span class="target" id="typedefs">typedefs</span>:</p> |
| <div class="section"> |
| <h2><a id="semantics-typedefs" name="semantics-typedefs">Semantics: typedefs</a></h2> |
| <p>The following types are implementation defined:</p> |
| <pre class="literal-block"> |
| typedef ... value_type; |
| typedef ... reference; |
| typedef ... const_reference; |
| typedef ... pointer; |
| typedef ... const_pointer; |
| </pre> |
| <p>However, the structure of the type mimics <tt class="docutils literal"><span class="pre">std::pair</span></tt> s.t. one |
| can use <tt class="docutils literal"><span class="pre">first</span></tt> and <tt class="docutils literal"><span class="pre">second</span></tt> members. The reference-types |
| are not real references and the pointer-types are not real pointers. |
| However, one may still write</p> |
| <pre class="literal-block"> |
| map_type::value_type a_value = *m.begin(); |
| a_value.second->foo(); |
| map_type::reference a_reference = *m.begin(); |
| a_reference.second->foo(); |
| map_type::const_reference a_creference = *const_begin(m); |
| map_type::pointer a_pointer = &*m.begin(); |
| a_pointer->second->foo(); |
| map_type::const_pointer a_cpointer = &*const_begin(m); |
| </pre> |
| <p>The difference compared to <tt class="docutils literal"><span class="pre">std::map<Key,T*></span></tt> is that constness |
| is propagated to the pointer (that is, to <tt class="docutils literal"><span class="pre">second</span></tt>) in <tt class="docutils literal"><span class="pre">const_itertor</span></tt>.</p> |
| </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">iterator</span> <span class="pre">insert(</span> <span class="pre">key_type&</span> <span class="pre">k,</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: Takes ownership of <tt class="docutils literal"><span class="pre">x</span></tt> and returns an iterator pointing to it.</li> |
| <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> |
| <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">const</span> <span class="pre">key_type&</span> <span class="pre">k,</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>Equivalent to (but without the <tt class="docutils literal"><span class="pre">const_cast</span></tt>): <tt class="docutils literal"><span class="pre">return</span> <span class="pre">insert(</span> <span class="pre">const_cast<key_type&>(k),</span> <span class="pre">x.release()</span> <span class="pre">);</span></tt></li> |
| </ul> |
| </blockquote> |
| </li> |
| </ul> |
| <!-- - ``iterator insert( key_type& k, const_reference x );`` |
| |
| - Effects: ``return insert( allocate_clone( x ) );`` |
| |
| - Exception safety: Strong guarantee --> |
| <span class="target" id="lookup"></span><!-- Semantics: lookup |
| ^^^^^^^^^^^^^^^^^ |
| |
| - ``reference operator[]( const Key& key );`` |
| - ``const_reference operator[]( const Key& key ) const;`` |
| |
| - Requirements: the key exists |
| |
| - Effects: returns the object with key ``key`` |
| |
| - Throws: ``bad_ptr_container_operation`` if the key does not exist --> |
| </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> |
| <ul> |
| <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">object,</span> <span class="pre">ptr_multimap_adapter&</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">not</span> <span class="pre">from.empty()</span></tt></li> |
| <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>.</li> |
| <li>Postconditions: <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">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_multimap_adapter&</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">not</span> <span class="pre">from.empty()</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>.</li> |
| <li>Postconditions: 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: Basic 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">Range</span> <span class="pre">></span> <span class="pre">void</span> <span class="pre">transfer(</span> <span class="pre">const</span> <span class="pre">Range&</span> <span class="pre">r,</span> <span class="pre">ptr_multimap_adapter&</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(</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> |
| </ul> |
| </blockquote> |
| </li> |
| <li><p class="first"><tt class="docutils literal"><span class="pre">void</span> <span class="pre">transfer(</span> <span class="pre">ptr_multimap_adapter&</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(</span> <span class="pre">from.begin(),</span> <span class="pre">from.end(),</span> <span class="pre">from</span> <span class="pre">);</span></tt>.</li> |
| <li>Postconditions: <tt class="docutils literal"><span class="pre">from.empty();</span></tt></li> |
| <li>Exception safety: Basic guarantee</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> |
