libs/bimap/doc/html/boost_bimap/reference/bimap_reference.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Bimap Reference</title>
   5 <link rel="stylesheet" href="../../boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="../../index.html" title="Chapter&#160;1.&#160;Boost.Bimap">
   8 <link rel="up" href="../reference.html" title="Reference">
   9 <link rel="prev" href="../reference.html" title="Reference">
  10 <link rel="next" href="set_of_reference.html" title="set_of Reference">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="../reference.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="set_of_reference.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h3 class="title">
  27 <a name="boost_bimap.reference.bimap_reference"></a><a class="link" href="bimap_reference.html" title="Bimap Reference">Bimap Reference</a>
  28 </h3></div></div></div>
  29 <div class="toc"><dl>
  30 <dt><span class="section"><a href="bimap_reference.html#boost_bimap.reference.bimap_reference.view_concepts">View
  31         concepts</a></span></dt>
  32 <dt><span class="section"><a href="bimap_reference.html#boost_bimap.reference.bimap_reference.complexity_signature"> Complexity
  33         signature</a></span></dt>
  34 <dt><span class="section"><a href="bimap_reference.html#boost_bimap.reference.bimap_reference.set_type_specification">Set
  35         type specification</a></span></dt>
  36 <dt><span class="section"><a href="bimap_reference.html#boost_bimap.reference.bimap_reference.tags">Tags</a></span></dt>
  37 <dt><span class="section"><a href="bimap_reference.html#boost_bimap.reference.bimap_reference.header__boost_bimap_bimap_hpp__synopsis">Header
  38         "boost/bimap/bimap.hpp" synopsis</a></span></dt>
  39 <dt><span class="section"><a href="bimap_reference.html#boost_bimap.reference.bimap_reference.class_template_bimap">Class
  40         template bimap</a></span></dt>
  41 <dd><dl>
  42 <dt><span class="section"><a href="bimap_reference.html#boost_bimap.reference.bimap_reference.class_template_bimap.complexity">Complexity</a></span></dt>
  43 <dt><span class="section"><a href="bimap_reference.html#boost_bimap.reference.bimap_reference.class_template_bimap.instantiation_types">Instantiation
  44           types</a></span></dt>
  45 <dt><span class="section"><a href="bimap_reference.html#boost_bimap.reference.bimap_reference.class_template_bimap.nested_types">Nested
  46           types</a></span></dt>
  47 <dt><span class="section"><a href="bimap_reference.html#boost_bimap.reference.bimap_reference.class_template_bimap.constructors__copy_and_assignment">Constructors,
  48           copy and assignment</a></span></dt>
  49 <dt><span class="section"><a href="bimap_reference.html#boost_bimap.reference.bimap_reference.class_template_bimap.projection_operations"> Projection
  50           operations</a></span></dt>
  51 <dt><span class="section"><a href="bimap_reference.html#boost_bimap.reference.bimap_reference.class_template_bimap.support_for_user_defined_names"> Support
  52           for user defined names</a></span></dt>
  53 <dt><span class="section"><a href="bimap_reference.html#boost_bimap.reference.bimap_reference.class_template_bimap.serialization">Serialization</a></span></dt>
  54 </dl></dd>
  55 </dl></div>
  56 <div class="section">
  57 <div class="titlepage"><div><div><h4 class="title">
  58 <a name="boost_bimap.reference.bimap_reference.view_concepts"></a><a class="link" href="bimap_reference.html#boost_bimap.reference.bimap_reference.view_concepts" title="View concepts">View
  59         concepts</a>
  60 </h4></div></div></div>
  61 <p>
  62           <code class="computeroutput"><span class="identifier">bimap</span></code> instantiations comprise
  63           two side views and an view of the relation specified at compile time. Each
  64           view allows read-write access to the elements contained in a definite manner,
  65           mathing an STL container signature.
  66         </p>
  67 <p>
  68           Views are not isolated objects and so cannot be constructed on their own;
  69           rather they are an integral part of a <code class="computeroutput"><span class="identifier">bimap</span></code>.
  70           The name of the view class implementation proper is never directly exposed
  71           to the user, who has access only to the associated view type specifier.
  72         </p>
  73 <p>
  74           Insertion and deletion of elements are always performed through the appropriate
  75           interface of any of the three views of the <code class="computeroutput"><span class="identifier">bimap</span></code>;
  76           these operations do, however, have an impact on all other views as well:
  77           for instance, insertion through a given view may fail because there exists
  78           another view that forbids the operation in order to preserve its invariant
  79           (such as uniqueness of elements). The global operations performed jointly
  80           in the any view can be reduced to six primitives:
  81         </p>
  82 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
  83 <li class="listitem">
  84               copying
  85             </li>
  86 <li class="listitem">
  87               insertion of an element
  88             </li>
  89 <li class="listitem">
  90               hinted insertion, where a pre-existing element is suggested in order
  91               to improve the efficiency of the operation
  92             </li>
  93 <li class="listitem">
  94               deletion of an element
  95             </li>
  96 <li class="listitem">
  97               replacement of the value of an element, which may trigger the rearrangement
  98               of this element in one or more views, or may forbid the replacement
  99             </li>
 100 <li class="listitem">
 101               modification of an element, and its subsequent rearrangement/banning
 102               by the various views
 103             </li>
 104 </ul></div>
 105 <p>
 106           The last two primitives deserve some further explanation: in order to guarantee
 107           the invariants associated to each view (e.g. some definite ordering) elements
 108           of a <code class="computeroutput"><span class="identifier">bimap</span></code> are not mutable.
 109           To overcome this restriction, the views expose member functions for updating
 110           and modifying, which allows for the mutation of elements in a controlled
 111           fashion.
 112         </p>
 113 </div>
 114 <div class="section">
 115 <div class="titlepage"><div><div><h4 class="title">
 116 <a name="boost_bimap.reference.bimap_reference.complexity_signature"></a><a name="complexity_signature_explanation"></a> <a class="link" href="bimap_reference.html#boost_bimap.reference.bimap_reference.complexity_signature" title="Complexity signature">Complexity
 117         signature</a>
 118 </h4></div></div></div>
 119 <p>
 120           Some member functions of a view interface are implemented by global primitives
 121           from the above list. The complexity of these operations thus depends on
 122           all views of a given <code class="computeroutput"><span class="identifier">bimap</span></code>,
 123           not just the currently used view.
 124         </p>
 125 <p>
 126           In order to establish complexity estimates, a view is characterised by
 127           its complexity signature, consisting of the following associated functions
 128           on the number of elements:
 129         </p>
 130 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
 131 <li class="listitem">
 132               <code class="computeroutput"><span class="identifier">c</span><span class="special">(</span><span class="identifier">n</span><span class="special">)</span></code>:
 133               copying
 134             </li>
 135 <li class="listitem">
 136               <code class="computeroutput"><span class="identifier">i</span><span class="special">(</span><span class="identifier">n</span><span class="special">)</span></code>:
 137               insertion
 138             </li>
 139 <li class="listitem">
 140               <code class="computeroutput"><span class="identifier">h</span><span class="special">(</span><span class="identifier">n</span><span class="special">)</span></code>:
 141               hinted insertion
 142             </li>
 143 <li class="listitem">
 144               <code class="computeroutput"><span class="identifier">d</span><span class="special">(</span><span class="identifier">n</span><span class="special">)</span></code>:
 145               deletion
 146             </li>
 147 <li class="listitem">
 148               <code class="computeroutput"><span class="identifier">r</span><span class="special">(</span><span class="identifier">n</span><span class="special">)</span></code>:
 149               replacement
 150             </li>
 151 <li class="listitem">
 152               <code class="computeroutput"><span class="identifier">m</span><span class="special">(</span><span class="identifier">n</span><span class="special">)</span></code>:
 153               modifying
 154             </li>
 155 </ul></div>
 156 <p>
 157           If the collection type of the relation is <code class="computeroutput"><span class="identifier">left_based</span></code>
 158           or <code class="computeroutput"><span class="identifier">right_based</span></code>, and we
 159           use an <code class="computeroutput"><span class="identifier">l</span></code> subscript to denote
 160           the left view and an <code class="computeroutput"><span class="identifier">r</span></code>
 161           for the right view, then the insertion of an element in such a container
 162           is of complexity <code class="computeroutput"><span class="identifier">O</span><span class="special">(</span><span class="identifier">i_l</span><span class="special">(</span><span class="identifier">n</span><span class="special">)+</span><span class="identifier">i_r</span><span class="special">(</span><span class="identifier">n</span><span class="special">))</span></code>,
 163           where n is the number of elements. If the collection type of relation is
 164           not side-based, then there is an additional term to add that is contributed
 165           by the collection type of relation view. Using <code class="computeroutput"><span class="identifier">a</span></code>
 166           to denote the above view, the complexity of insertion will now be <code class="computeroutput"><span class="identifier">O</span><span class="special">(</span><span class="identifier">i_l</span><span class="special">(</span><span class="identifier">n</span><span class="special">)+</span><span class="identifier">i_r</span><span class="special">(</span><span class="identifier">n</span><span class="special">)+</span><span class="identifier">i_a</span><span class="special">(</span><span class="identifier">n</span><span class="special">))</span></code>.
 167           To abbreviate the notation, we adopt the following definitions:
 168         </p>
 169 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
 170 <li class="listitem">
 171               <code class="computeroutput"><span class="identifier">C</span><span class="special">(</span><span class="identifier">n</span><span class="special">)</span> <span class="special">=</span> <span class="identifier">c_l</span><span class="special">(</span><span class="identifier">n</span><span class="special">)</span> <span class="special">+</span> <span class="identifier">c_r</span><span class="special">(</span><span class="identifier">n</span><span class="special">)</span> <span class="special">[</span> <span class="special">+</span> <span class="identifier">c_a</span><span class="special">(</span><span class="identifier">n</span><span class="special">)</span> <span class="special">]</span></code>
 172             </li>
 173 <li class="listitem">
 174               <code class="computeroutput"><span class="identifier">I</span><span class="special">(</span><span class="identifier">n</span><span class="special">)</span> <span class="special">=</span> <span class="identifier">i_l</span><span class="special">(</span><span class="identifier">n</span><span class="special">)</span> <span class="special">+</span> <span class="identifier">i_r</span><span class="special">(</span><span class="identifier">n</span><span class="special">)</span> <span class="special">[</span> <span class="special">+</span> <span class="identifier">i_a</span><span class="special">(</span><span class="identifier">n</span><span class="special">)</span> <span class="special">]</span></code>
 175             </li>
 176 <li class="listitem">
 177               <code class="computeroutput"><span class="identifier">H</span><span class="special">(</span><span class="identifier">n</span><span class="special">)</span> <span class="special">=</span> <span class="identifier">h_l</span><span class="special">(</span><span class="identifier">n</span><span class="special">)</span> <span class="special">+</span> <span class="identifier">h_r</span><span class="special">(</span><span class="identifier">n</span><span class="special">)</span> <span class="special">[</span> <span class="special">+</span> <span class="identifier">h_a</span><span class="special">(</span><span class="identifier">n</span><span class="special">)</span> <span class="special">]</span></code>
 178             </li>
 179 <li class="listitem">
 180               <code class="computeroutput"><span class="identifier">D</span><span class="special">(</span><span class="identifier">n</span><span class="special">)</span> <span class="special">=</span> <span class="identifier">d_l</span><span class="special">(</span><span class="identifier">n</span><span class="special">)</span> <span class="special">+</span> <span class="identifier">d_r</span><span class="special">(</span><span class="identifier">n</span><span class="special">)</span> <span class="special">[</span> <span class="special">+</span> <span class="identifier">d_a</span><span class="special">(</span><span class="identifier">n</span><span class="special">)</span> <span class="special">]</span></code>
 181             </li>
 182 <li class="listitem">
 183               <code class="computeroutput"><span class="identifier">R</span><span class="special">(</span><span class="identifier">n</span><span class="special">)</span> <span class="special">=</span> <span class="identifier">r_l</span><span class="special">(</span><span class="identifier">n</span><span class="special">)</span> <span class="special">+</span> <span class="identifier">r_r</span><span class="special">(</span><span class="identifier">n</span><span class="special">)</span> <span class="special">[</span> <span class="special">+</span> <span class="identifier">r_a</span><span class="special">(</span><span class="identifier">n</span><span class="special">)</span> <span class="special">]</span></code>
 184             </li>
 185 <li class="listitem">
 186               <code class="computeroutput"><span class="identifier">M</span><span class="special">(</span><span class="identifier">n</span><span class="special">)</span> <span class="special">=</span> <span class="identifier">m_l</span><span class="special">(</span><span class="identifier">n</span><span class="special">)</span> <span class="special">+</span> <span class="identifier">m_r</span><span class="special">(</span><span class="identifier">n</span><span class="special">)</span> <span class="special">[</span> <span class="special">+</span> <span class="identifier">m_a</span><span class="special">(</span><span class="identifier">n</span><span class="special">)</span> <span class="special">]</span></code>
 187             </li>
 188 </ul></div>
 189 </div>
 190 <div class="section">
 191 <div class="titlepage"><div><div><h4 class="title">
 192 <a name="boost_bimap.reference.bimap_reference.set_type_specification"></a><a class="link" href="bimap_reference.html#boost_bimap.reference.bimap_reference.set_type_specification" title="Set type specification">Set
 193         type specification</a>
 194 </h4></div></div></div>
 195 <p>
 196           Set type specifiers are passed as instantiation arguments to <code class="computeroutput"><span class="identifier">bimap</span></code> and provide the information needed
 197           to incorporate the corresponding views. Currently, Boost.Bimap provides
 198           the collection type specifiers. The <span class="emphasis"><em>side collection type</em></span>
 199           specifiers define the constraints of the two map views of the bimap. The
 200           <span class="emphasis"><em>collection type of relation</em></span> specifier defines the
 201           main set view constraints. If <code class="computeroutput"><span class="identifier">left_based</span></code>
 202           (the default parameter) or <code class="computeroutput"><span class="identifier">right_based</span></code>
 203           is used, then the collection type of relation will be based on the left
 204           or right collection type correspondingly.
 205         </p>
 206 <div class="informaltable"><table class="table">
 207 <colgroup>
 208 <col>
 209 <col>
 210 <col>
 211 </colgroup>
 212 <thead><tr>
 213 <th>
 214                   <p>
 215                     Side collection type
 216                   </p>
 217                 </th>
 218 <th>
 219                   <p>
 220                     Collection type of relation
 221                   </p>
 222                 </th>
 223 <th>
 224                   <p>
 225                     Include
 226                   </p>
 227                 </th>
 228 </tr></thead>
 229 <tbody>
 230 <tr>
 231 <td>
 232                   <p>
 233                     <code class="computeroutput"><span class="identifier">set_of</span></code>
 234                   </p>
 235                 </td>
 236 <td>
 237                   <p>
 238                     <code class="computeroutput"><span class="identifier">set_of_relation</span></code>
 239                   </p>
 240                 </td>
 241 <td>
 242                   <p>
 243                     <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">bimap</span><span class="special">/</span><span class="identifier">set_of</span><span class="special">.</span><span class="identifier">hpp</span></code>
 244                   </p>
 245                 </td>
 246 </tr>
 247 <tr>
 248 <td>
 249                   <p>
 250                     <code class="computeroutput"><span class="identifier">multiset_of</span></code>
 251                   </p>
 252                 </td>
 253 <td>
 254                   <p>
 255                     <code class="computeroutput"><span class="identifier">multiset_of_relation</span></code>
 256                   </p>
 257                 </td>
 258 <td>
 259                   <p>
 260                     <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">bimap</span><span class="special">/</span><span class="identifier">multiset_of</span><span class="special">.</span><span class="identifier">hpp</span></code>
 261                   </p>
 262                 </td>
 263 </tr>
 264 <tr>
 265 <td>
 266                   <p>
 267                     <code class="computeroutput"><span class="identifier">unordered_set_of</span></code>
 268                   </p>
 269                 </td>
 270 <td>
 271                   <p>
 272                     <code class="computeroutput"><span class="identifier">unordered_set_of_relation</span></code>
 273                   </p>
 274                 </td>
 275 <td>
 276                   <p>
 277                     <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">bimap</span><span class="special">/</span><span class="identifier">unordered_set_of</span><span class="special">.</span><span class="identifier">hpp</span></code>
 278                   </p>
 279                 </td>
 280 </tr>
 281 <tr>
 282 <td>
 283                   <p>
 284                     <code class="computeroutput"><span class="identifier">unordered_multiset_of</span></code>
 285                   </p>
 286                 </td>
 287 <td>
 288                   <p>
 289                     <code class="computeroutput"><span class="identifier">unordered_multiset_of_relation</span></code>
 290                   </p>
 291                 </td>
 292 <td>
 293                   <p>
 294                     <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">bimap</span><span class="special">/</span><span class="identifier">unordered_multiset_of</span><span class="special">.</span><span class="identifier">hpp</span></code>
 295                   </p>
 296                 </td>
 297 </tr>
 298 <tr>
 299 <td>
 300                   <p>
 301                     <code class="computeroutput"><span class="identifier">list_of</span></code>
 302                   </p>
 303                 </td>
 304 <td>
 305                   <p>
 306                     <code class="computeroutput"><span class="identifier">list_of_relation</span></code>
 307                   </p>
 308                 </td>
 309 <td>
 310                   <p>
 311                     <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">bimap</span><span class="special">/</span><span class="identifier">list_of</span><span class="special">.</span><span class="identifier">hpp</span></code>
 312                   </p>
 313                 </td>
 314 </tr>
 315 <tr>
 316 <td>
 317                   <p>
 318                     <code class="computeroutput"><span class="identifier">vector_of</span></code>
 319                   </p>
 320                 </td>
 321 <td>
 322                   <p>
 323                     <code class="computeroutput"><span class="identifier">vector_of_relation</span></code>
 324                   </p>
 325                 </td>
 326 <td>
 327                   <p>
 328                     <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">bimap</span><span class="special">/</span><span class="identifier">vector_of</span><span class="special">.</span><span class="identifier">hpp</span></code>
 329                   </p>
 330                 </td>
 331 </tr>
 332 <tr>
 333 <td>
 334                   <p>
 335                     <code class="computeroutput"><span class="identifier">unconstrained_set_of</span></code>
 336                   </p>
 337                 </td>
 338 <td>
 339                   <p>
 340                     <code class="computeroutput"><span class="identifier">unconstrained_set_of_relation</span></code>
 341                   </p>
 342                 </td>
 343 <td>
 344                   <p>
 345                     <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">bimap</span><span class="special">/</span><span class="identifier">unconstrained_set_of</span><span class="special">.</span><span class="identifier">hpp</span></code>
 346                   </p>
 347                 </td>
 348 </tr>
 349 <tr>
 350 <td>
 351                 </td>
 352 <td>
 353                   <p>
 354                     <code class="computeroutput"><span class="identifier">left_based</span></code>
 355                   </p>
 356                 </td>
 357 <td>
 358                   <p>
 359                     <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">bimap</span><span class="special">/</span><span class="identifier">bimap</span><span class="special">.</span><span class="identifier">hpp</span></code>
 360                   </p>
 361                 </td>
 362 </tr>
 363 <tr>
 364 <td>
 365                 </td>
 366 <td>
 367                   <p>
 368                     <code class="computeroutput"><span class="identifier">right_based</span></code>
 369                   </p>
 370                 </td>
 371 <td>
 372                   <p>
 373                     <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">bimap</span><span class="special">/</span><span class="identifier">bimap</span><span class="special">.</span><span class="identifier">hpp</span></code>
 374                   </p>
 375                 </td>
 376 </tr>
 377 </tbody>
 378 </table></div>
 379 </div>
 380 <div class="section">
 381 <div class="titlepage"><div><div><h4 class="title">
 382 <a name="boost_bimap.reference.bimap_reference.tags"></a><a class="link" href="bimap_reference.html#boost_bimap.reference.bimap_reference.tags" title="Tags">Tags</a>
 383 </h4></div></div></div>
 384 <p>
 385           Tags are just conventional types used as mnemonics for the types stored
 386           in a <code class="computeroutput"><span class="identifier">bimap</span></code>. Boost.Bimap
 387           uses the tagged idiom to let the user specify this tags.
 388         </p>
 389 </div>
 390 <div class="section">
 391 <div class="titlepage"><div><div><h4 class="title">
 392 <a name="boost_bimap.reference.bimap_reference.header__boost_bimap_bimap_hpp__synopsis"></a><a class="link" href="bimap_reference.html#boost_bimap.reference.bimap_reference.header__boost_bimap_bimap_hpp__synopsis" title='Header "boost/bimap/bimap.hpp" synopsis'>Header
 393         "boost/bimap/bimap.hpp" synopsis</a>
 394 </h4></div></div></div>
 395 <pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span>
 396 <span class="keyword">namespace</span> <span class="identifier">bimaps</span> <span class="special">{</span>
 397
 398 <span class="keyword">template</span><span class="special">&lt;</span> <span class="keyword">class</span> <span class="identifier">Type</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Tag</span> <span class="special">&gt;</span>
 399 <span class="keyword">struct</span> <span class="identifier">tagged</span><span class="special">;</span>
 400
 401 <span class="comment">// bimap template class
 402 </span>
 403 <span class="keyword">template</span>
 404 <span class="special">&lt;</span>
 405     <span class="keyword">class</span> <span class="identifier">LeftCollectionType</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">RightCollectionType</span><span class="special">,</span>
 406
 407     <span class="keyword">class</span> <span class="identifier">AdditionalParameter_1</span> <span class="special">=</span> <span class="identifier">detail</span><span class="special">::</span><span class="identifier">not_specified</span><span class="special">,</span>
 408     <span class="keyword">class</span> <span class="identifier">AdditionalParameter_2</span> <span class="special">=</span> <span class="identifier">detail</span><span class="special">::</span><span class="identifier">not_specified</span>
 409 <span class="special">&gt;</span>
 410 <span class="keyword">class</span> <span class="identifier">bimap</span> <span class="emphasis"><em>- implementation defined { : public SetView } -</em></span>
 411 <span class="special">{</span>
 412     <span class="keyword">public</span><span class="special">:</span>
 413
 414     <span class="comment">// Metadata
 415 </span>
 416     <span class="keyword">typedef</span> <span class="emphasis"><em>-unspecified-</em></span> <span class="identifier">left_tag</span><span class="special">;</span>
 417     <span class="keyword">typedef</span> <span class="emphasis"><em>-unspecified-</em></span> <span class="identifier">left_map</span><span class="special">;</span>
 418
 419     <span class="keyword">typedef</span> <span class="emphasis"><em>-unspecified-</em></span> <span class="identifier">right_tag</span><span class="special">;</span>
 420     <span class="keyword">typedef</span> <span class="emphasis"><em>-unspecified-</em></span> <span class="identifier">right_map</span><span class="special">;</span>
 421
 422     <span class="comment">// Shortcuts
 423 </span>    <span class="comment">// typedef -side-_map::-type- -side-_-type-;
 424 </span>
 425     <span class="keyword">typedef</span> <span class="emphasis"><em>-unspecified-</em></span> <span class="identifier">info_type</span><span class="special">;</span>
 426
 427     <span class="comment">// Map views
 428 </span>
 429      <span class="identifier">left_map</span>  <span class="identifier">left</span><span class="special">;</span>
 430     <span class="identifier">right_map</span> <span class="identifier">right</span><span class="special">;</span>
 431
 432     <span class="comment">// Constructors
 433 </span>
 434     <span class="identifier">bimap</span><span class="special">();</span>
 435
 436     <span class="keyword">template</span><span class="special">&lt;</span> <span class="keyword">class</span> <span class="identifier">InputIterator</span> <span class="special">&gt;</span>
 437     <span class="identifier">bimap</span><span class="special">(</span><span class="identifier">InputIterator</span> <span class="identifier">first</span><span class="special">,</span><span class="identifier">InputIterator</span> <span class="identifier">last</span><span class="special">);</span>
 438
 439     <span class="identifier">bimap</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">bimap</span> <span class="special">&amp;);</span>
 440
 441     <span class="identifier">bimap</span><span class="special">&amp;</span> <span class="keyword">operator</span><span class="special">=(</span><span class="keyword">const</span> <span class="identifier">bimap</span><span class="special">&amp;</span> <span class="identifier">b</span><span class="special">);</span>
 442
 443     <span class="comment">// Projection of iterators
 444 </span>
 445     <span class="keyword">template</span><span class="special">&lt;</span> <span class="keyword">class</span> <span class="identifier">IteratorType</span> <span class="special">&gt;</span>
 446     <span class="identifier">left_iterator</span> <span class="identifier">project_left</span><span class="special">(</span><span class="identifier">IteratorType</span> <span class="identifier">iter</span><span class="special">);</span>
 447
 448     <span class="keyword">template</span><span class="special">&lt;</span> <span class="keyword">class</span> <span class="identifier">IteratorType</span> <span class="special">&gt;</span>
 449     <span class="identifier">left_const_iterator</span> <span class="identifier">project_left</span><span class="special">(</span><span class="identifier">IteratorType</span> <span class="identifier">iter</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
 450
 451     <span class="keyword">template</span><span class="special">&lt;</span> <span class="keyword">class</span> <span class="identifier">IteratorType</span> <span class="special">&gt;</span>
 452     <span class="identifier">right_iterator</span> <span class="identifier">project_right</span><span class="special">(</span><span class="identifier">IteratorType</span> <span class="identifier">iter</span><span class="special">);</span>
 453
 454     <span class="keyword">template</span><span class="special">&lt;</span> <span class="keyword">class</span> <span class="identifier">IteratorType</span> <span class="special">&gt;</span>
 455     <span class="identifier">right_const_iterator</span> <span class="identifier">project_right</span><span class="special">(</span><span class="identifier">IteratorType</span> <span class="identifier">iter</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
 456
 457     <span class="keyword">template</span><span class="special">&lt;</span> <span class="keyword">class</span> <span class="identifier">IteratorType</span> <span class="special">&gt;</span>
 458     <span class="identifier">iterator</span> <span class="identifier">project_up</span><span class="special">(</span><span class="identifier">IteratorType</span> <span class="identifier">iter</span><span class="special">);</span>
 459
 460     <span class="keyword">template</span><span class="special">&lt;</span> <span class="keyword">class</span> <span class="identifier">IteratorType</span> <span class="special">&gt;</span>
 461     <span class="identifier">const_iterator</span> <span class="identifier">project_up</span><span class="special">(</span><span class="identifier">IteratorType</span> <span class="identifier">iter</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
 462
 463     <span class="comment">// Support for tags
 464 </span>
 465     <span class="keyword">template</span><span class="special">&lt;</span> <span class="keyword">class</span> <span class="identifier">Tag</span> <span class="special">&gt;</span>
 466     <span class="keyword">struct</span> <span class="identifier">map_by</span><span class="special">;</span>
 467
 468     <span class="keyword">template</span><span class="special">&lt;</span> <span class="keyword">class</span> <span class="identifier">Tag</span> <span class="special">&gt;</span>
 469     <span class="identifier">map_by</span><span class="special">&lt;</span><span class="identifier">Tag</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="identifier">by</span><span class="special">();</span>
 470
 471     <span class="keyword">template</span><span class="special">&lt;</span> <span class="keyword">class</span> <span class="identifier">Tag</span> <span class="special">&gt;</span>
 472     <span class="keyword">const</span> <span class="identifier">map_by</span><span class="special">&lt;</span><span class="identifier">Tag</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="special">&amp;</span> <span class="identifier">by</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span>
 473
 474     <span class="keyword">template</span><span class="special">&lt;</span> <span class="keyword">class</span> <span class="identifier">Tag</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">IteratorType</span> <span class="special">&gt;</span>
 475     <span class="identifier">map_by</span><span class="special">&lt;</span><span class="identifier">Tag</span><span class="special">&gt;::</span><span class="identifier">iterator</span> <span class="identifier">project</span><span class="special">(</span><span class="identifier">IteratorType</span> <span class="identifier">iter</span><span class="special">);</span>
 476
 477     <span class="keyword">template</span><span class="special">&lt;</span> <span class="keyword">class</span> <span class="identifier">Tag</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">IteratorType</span> <span class="special">&gt;</span>
 478     <span class="identifier">map_by</span><span class="special">&lt;</span><span class="identifier">Tag</span><span class="special">&gt;::</span><span class="identifier">const_iterator</span> <span class="identifier">project</span><span class="special">(</span><span class="identifier">IteratorType</span> <span class="identifier">iter</span><span class="special">)</span> <span class="keyword">const</span>
 479
 480 <span class="special">};</span>
 481
 482
 483 <span class="special">}</span> <span class="comment">// namespace bimap
 484 </span><span class="special">}</span> <span class="comment">// namespace boost
 485 </span></pre>
 486 </div>
 487 <div class="section">
 488 <div class="titlepage"><div><div><h4 class="title">
 489 <a name="boost_bimap.reference.bimap_reference.class_template_bimap"></a><a class="link" href="bimap_reference.html#boost_bimap.reference.bimap_reference.class_template_bimap" title="Class template bimap">Class
 490         template bimap</a>
 491 </h4></div></div></div>
 492 <div class="toc"><dl>
 493 <dt><span class="section"><a href="bimap_reference.html#boost_bimap.reference.bimap_reference.class_template_bimap.complexity">Complexity</a></span></dt>
 494 <dt><span class="section"><a href="bimap_reference.html#boost_bimap.reference.bimap_reference.class_template_bimap.instantiation_types">Instantiation
 495           types</a></span></dt>
 496 <dt><span class="section"><a href="bimap_reference.html#boost_bimap.reference.bimap_reference.class_template_bimap.nested_types">Nested
 497           types</a></span></dt>
 498 <dt><span class="section"><a href="bimap_reference.html#boost_bimap.reference.bimap_reference.class_template_bimap.constructors__copy_and_assignment">Constructors,
 499           copy and assignment</a></span></dt>
 500 <dt><span class="section"><a href="bimap_reference.html#boost_bimap.reference.bimap_reference.class_template_bimap.projection_operations"> Projection
 501           operations</a></span></dt>
 502 <dt><span class="section"><a href="bimap_reference.html#boost_bimap.reference.bimap_reference.class_template_bimap.support_for_user_defined_names"> Support
 503           for user defined names</a></span></dt>
 504 <dt><span class="section"><a href="bimap_reference.html#boost_bimap.reference.bimap_reference.class_template_bimap.serialization">Serialization</a></span></dt>
 505 </dl></div>
 506 <p>
 507           This is the main component of Boost.Bimap.
 508         </p>
 509 <div class="section">
 510 <div class="titlepage"><div><div><h5 class="title">
 511 <a name="boost_bimap.reference.bimap_reference.class_template_bimap.complexity"></a><a class="link" href="bimap_reference.html#boost_bimap.reference.bimap_reference.class_template_bimap.complexity" title="Complexity">Complexity</a>
 512 </h5></div></div></div>
 513 <p>
 514             In the descriptions of the operations of <code class="computeroutput"><span class="identifier">bimap</span></code>,
 515             we adopt the scheme outlined in the complexity signature section.
 516           </p>
 517 </div>
 518 <div class="section">
 519 <div class="titlepage"><div><div><h5 class="title">
 520 <a name="boost_bimap.reference.bimap_reference.class_template_bimap.instantiation_types"></a><a class="link" href="bimap_reference.html#boost_bimap.reference.bimap_reference.class_template_bimap.instantiation_types" title="Instantiation types">Instantiation
 521           types</a>
 522 </h5></div></div></div>
 523 <p>
 524             <code class="computeroutput"><span class="identifier">bimap</span></code> is instantiated
 525             with the following types:
 526           </p>
 527 <div class="orderedlist"><ol class="orderedlist" type="1">
 528 <li class="listitem">
 529                 LeftCollectionType and RightCollectionType are collection type specifications
 530                 optionally tagged, or any type optionally tagged, in which case that
 531                 side acts as a set.
 532               </li>
 533 <li class="listitem">
 534 <p class="simpara">
 535                 AdditionalParameter_{1/2} can be any ordered subset of:
 536               </p>
 537 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
 538 <li class="listitem">
 539                     CollectionTypeOfRelation specification
 540                   </li>
 541 <li class="listitem">
 542                     Allocator
 543                   </li>
 544 </ul></div>
 545 </li>
 546 </ol></div>
 547 </div>
 548 <div class="section">
 549 <div class="titlepage"><div><div><h5 class="title">
 550 <a name="boost_bimap.reference.bimap_reference.class_template_bimap.nested_types"></a><a class="link" href="bimap_reference.html#boost_bimap.reference.bimap_reference.class_template_bimap.nested_types" title="Nested types">Nested
 551           types</a>
 552 </h5></div></div></div>
 553 <pre class="programlisting"><span class="identifier">left_tag</span><span class="special">,</span> <span class="identifier">right_tag</span>
 554 </pre>
 555 <div class="blockquote"><blockquote class="blockquote"><p>
 556               Tags for each side of the bimap. If the user has not specified any
 557               tag the tags default to <code class="computeroutput"><span class="identifier">member_at</span><span class="special">::</span><span class="identifier">left</span></code>
 558               and <code class="computeroutput"><span class="identifier">member_at</span><span class="special">::</span><span class="identifier">right</span></code>.
 559             </p></blockquote></div>
 560 <pre class="programlisting"><span class="identifier">left_key_type</span><span class="special">,</span> <span class="identifier">right_key_type</span>
 561 </pre>
 562 <div class="blockquote"><blockquote class="blockquote"><p>
 563               Key type of each side. In a <code class="computeroutput"><span class="identifier">bimap</span><span class="special">&lt;</span><span class="identifier">A</span><span class="special">,</span><span class="identifier">B</span><span class="special">&gt;</span> </code> <code class="computeroutput"><span class="identifier">left_key_type</span></code>
 564               is <code class="computeroutput"><span class="identifier">A</span></code> and <code class="computeroutput"><span class="identifier">right_key_type</span></code> is <code class="computeroutput"><span class="identifier">B</span></code>.
 565               If there are tags, it is better to use: <code class="computeroutput"><span class="identifier">Bimap</span><span class="special">::</span><span class="identifier">map_by</span><span class="special">&lt;</span><span class="identifier">Tag</span><span class="special">&gt;::</span><span class="identifier">key_type</span></code>.
 566             </p></blockquote></div>
 567 <pre class="programlisting"><span class="identifier">left_data_type</span><span class="special">,</span> <span class="identifier">right_data_type</span>
 568 </pre>
 569 <div class="blockquote"><blockquote class="blockquote"><p>
 570               Data type of each side. In a bimap&lt;A,B&gt; left_key_type is B and
 571               right_key_type is A. If there are tags, it is better to use: <code class="computeroutput"><span class="identifier">Bimap</span><span class="special">::</span><span class="identifier">map_by</span><span class="special">&lt;</span><span class="identifier">Tag</span><span class="special">&gt;::</span><span class="identifier">data_type</span></code>.
 572             </p></blockquote></div>
 573 <pre class="programlisting"><span class="identifier">left_value_type</span><span class="special">,</span> <span class="identifier">right_value_type</span>
 574 </pre>
 575 <div class="blockquote"><blockquote class="blockquote"><p>
 576               Value type used for the views. If there are tags, it is better to use:
 577               <code class="computeroutput"><span class="identifier">Bimap</span><span class="special">::</span><span class="identifier">map_by</span><span class="special">&lt;</span><span class="identifier">Tag</span><span class="special">&gt;::</span><span class="identifier">value_type</span></code>.
 578             </p></blockquote></div>
 579 <pre class="programlisting"><span class="identifier">left_iterator</span><span class="special">,</span> <span class="identifier">right_iterator</span>
 580 <span class="identifier">left_const_iterator</span><span class="special">,</span> <span class="identifier">right_const_iterator</span>
 581 </pre>
 582 <div class="blockquote"><blockquote class="blockquote"><p>
 583               Iterators of the views. If there are tags, it is better to use: <code class="computeroutput"><span class="identifier">Bimap</span><span class="special">::</span><span class="identifier">map_by</span><span class="special">&lt;</span><span class="identifier">Tag</span><span class="special">&gt;::</span><span class="identifier">iterator</span></code> and <code class="computeroutput"><span class="identifier">Bimap</span><span class="special">::</span><span class="identifier">map_by</span><span class="special">&lt;</span><span class="identifier">Tag</span><span class="special">&gt;::</span><span class="identifier">const_iterator</span></code>
 584             </p></blockquote></div>
 585 <pre class="programlisting"><span class="identifier">left_map</span><span class="special">,</span> <span class="identifier">right_map</span>
 586 </pre>
 587 <div class="blockquote"><blockquote class="blockquote"><p>
 588               Map view type of each side. If there are tags, it is better to use:
 589               <code class="computeroutput"><span class="identifier">Bimap</span><span class="special">::</span><span class="identifier">map_by</span><span class="special">&lt;</span><span class="identifier">Tag</span><span class="special">&gt;::</span><span class="identifier">type</span></code>.
 590             </p></blockquote></div>
 591 </div>
 592 <div class="section">
 593 <div class="titlepage"><div><div><h5 class="title">
 594 <a name="boost_bimap.reference.bimap_reference.class_template_bimap.constructors__copy_and_assignment"></a><a class="link" href="bimap_reference.html#boost_bimap.reference.bimap_reference.class_template_bimap.constructors__copy_and_assignment" title="Constructors, copy and assignment">Constructors,
 595           copy and assignment</a>
 596 </h5></div></div></div>
 597 <pre class="programlisting"><span class="identifier">bimap</span><span class="special">();</span>
 598 </pre>
 599 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
 600 <li class="listitem">
 601                 <span class="bold"><strong>Effects:</strong></span> Constructs an empty <code class="computeroutput"><span class="identifier">bimap</span></code>.
 602               </li>
 603 <li class="listitem">
 604                 <span class="bold"><strong>Complexity:</strong></span> Constant.
 605               </li>
 606 </ul></div>
 607 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">InputIterator</span><span class="special">&gt;</span>
 608 <span class="identifier">bimap</span><span class="special">(</span><span class="identifier">InputIterator</span> <span class="identifier">first</span><span class="special">,</span><span class="identifier">InputIterator</span> <span class="identifier">last</span><span class="special">);</span>
 609 </pre>
 610 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
 611 <li class="listitem">
 612                 <span class="bold"><strong>Requires: </strong></span> <code class="computeroutput"><span class="identifier">InputIterator</span></code>
 613                 is a model of Input Iterator over elements of type <code class="computeroutput"><span class="identifier">relation</span></code> or a type convertible
 614                 to <code class="computeroutput"><span class="identifier">relation</span></code>. last
 615                 is reachable from <code class="computeroutput"><span class="identifier">first</span></code>.
 616               </li>
 617 <li class="listitem">
 618                 <span class="bold"><strong>Effects:</strong></span> Constructs an empty <code class="computeroutput"><span class="identifier">bimap</span></code> and fills it with the elements
 619                 in the range <code class="computeroutput"><span class="special">[</span><span class="identifier">first</span><span class="special">,</span><span class="identifier">last</span><span class="special">)</span></code>. Insertion of each element may or
 620                 may not succeed depending on acceptance by the collection types of
 621                 the <code class="computeroutput"><span class="identifier">bimap</span></code>.
 622               </li>
 623 <li class="listitem">
 624                 <a class="link" href="bimap_reference.html#complexity_signature_explanation"><span class="bold"><strong>Complexity:</strong></span></a>
 625                 O(m*H(m)), where m is the number of elements in <code class="computeroutput"><span class="special">[</span><span class="identifier">first</span><span class="special">,</span><span class="identifier">last</span><span class="special">)</span></code>.
 626               </li>
 627 </ul></div>
 628 <pre class="programlisting"><span class="identifier">bimap</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">bimap</span> <span class="special">&amp;</span> <span class="identifier">x</span><span class="special">);</span>
 629 </pre>
 630 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
 631 <li class="listitem">
 632                 <span class="bold"><strong>Effects:</strong></span> Constructs a copy of x,
 633                 copying its elements as well as its internal objects (key extractors,
 634                 comparison objects, allocator.)
 635               </li>
 636 <li class="listitem">
 637                 <span class="bold"><strong>Postconditions:</strong></span> <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span> <span class="special">==</span>
 638                 <span class="identifier">x</span></code>. The order of the views
 639                 of the <code class="computeroutput"><span class="identifier">bimap</span></code> is preserved
 640                 as well.
 641               </li>
 642 <li class="listitem">
 643                 <span class="bold"><strong>Complexity:</strong></span> O(x.size()*log(x.size())
 644                 + C(x.size()))
 645               </li>
 646 </ul></div>
 647 <pre class="programlisting"><span class="special">~</span><span class="identifier">bimap</span><span class="special">()</span>
 648 </pre>
 649 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
 650 <li class="listitem">
 651                 <span class="bold"><strong>Effects:</strong></span> Destroys the <code class="computeroutput"><span class="identifier">bimap</span></code> and all the elements contained.
 652                 The order in which the elements are destroyed is not specified.
 653               </li>
 654 <li class="listitem">
 655                 <span class="bold"><strong>Complexity:</strong></span> O(n).
 656               </li>
 657 </ul></div>
 658 <pre class="programlisting"><span class="identifier">bimap</span><span class="special">&amp;</span> <span class="keyword">operator</span><span class="special">=(</span><span class="keyword">const</span> <span class="identifier">bimap</span><span class="special">&amp;</span> <span class="identifier">x</span><span class="special">);</span>
 659 </pre>
 660 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
 661 <li class="listitem">
 662                 <span class="bold"><strong>Effects:</strong></span> Replaces the elements and
 663                 internal objects of the <code class="computeroutput"><span class="identifier">bimap</span></code>
 664                 with copies from x.
 665               </li>
 666 <li class="listitem">
 667                 <span class="bold"><strong>Postconditions:</strong></span> <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span><span class="special">==</span><span class="identifier">x</span></code>. The order on the views of the
 668                 <code class="computeroutput"><span class="identifier">bimap</span></code> is preserved
 669                 as well.
 670               </li>
 671 <li class="listitem">
 672                 <span class="bold"><strong>Returns: </strong></span> <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code>.
 673               </li>
 674 <li class="listitem">
 675                 <span class="bold"><strong>Complexity:</strong></span> O(n + x.size()*log(x.size())
 676                 + C(x.size())).
 677               </li>
 678 <li class="listitem">
 679                 <span class="bold"><strong>Exception safety:</strong></span> Strong, provided
 680                 the copy and assignment operations of the types of <code class="computeroutput"><span class="identifier">ctor_args_list</span></code> do not throw.
 681               </li>
 682 </ul></div>
 683 </div>
 684 <div class="section">
 685 <div class="titlepage"><div><div><h5 class="title">
 686 <a name="boost_bimap.reference.bimap_reference.class_template_bimap.projection_operations"></a><a name="reference_projection_operations"></a> <a class="link" href="bimap_reference.html#boost_bimap.reference.bimap_reference.class_template_bimap.projection_operations" title="Projection operations">Projection
 687           operations</a>
 688 </h5></div></div></div>
 689 <p>
 690             Given a <code class="computeroutput"><span class="identifier">bimap</span></code> with views
 691             v1 and v2, we say than an v1-iterator it1 and an v2-iterator it2 are
 692             equivalent if:
 693           </p>
 694 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
 695 <li class="listitem">
 696                 <code class="computeroutput"><span class="identifier">it1</span> <span class="special">==</span>
 697                 <span class="identifier">i1</span><span class="special">.</span><span class="identifier">end</span><span class="special">()</span></code>
 698                 AND <code class="computeroutput"><span class="identifier">it2</span> <span class="special">==</span>
 699                 <span class="identifier">i2</span><span class="special">.</span><span class="identifier">end</span><span class="special">()</span></code>,
 700               </li>
 701 <li class="listitem">
 702                 OR <code class="computeroutput"><span class="identifier">it1</span></code> and <code class="computeroutput"><span class="identifier">it2</span></code> point to the same element.
 703               </li>
 704 </ul></div>
 705 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span> <span class="keyword">class</span> <span class="identifier">IteratorType</span> <span class="special">&gt;</span>
 706 <span class="identifier">left_iterator</span> <span class="identifier">project_left</span><span class="special">(</span><span class="identifier">IteratorType</span> <span class="identifier">iter</span><span class="special">);</span>
 707
 708 <span class="keyword">template</span><span class="special">&lt;</span> <span class="keyword">class</span> <span class="identifier">IteratorType</span> <span class="special">&gt;</span>
 709 <span class="identifier">left_const_iterator</span> <span class="identifier">project_left</span><span class="special">(</span><span class="identifier">IteratorType</span> <span class="identifier">iter</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
 710 </pre>
 711 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
 712 <li class="listitem">
 713                 <span class="bold"><strong>Requires:</strong></span> <code class="computeroutput"><span class="identifier">IteratorType</span></code>
 714                 is a bimap view iterator. it is a valid iterator of some view of
 715                 <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code>
 716                 (i.e. does not refer to some other <code class="computeroutput"><span class="identifier">bimap</span></code>.)
 717               </li>
 718 <li class="listitem">
 719                 <span class="bold"><strong>Effects:</strong></span> Returns a left map view
 720                 iterator equivalent to <code class="computeroutput"><span class="identifier">it</span></code>.
 721               </li>
 722 <li class="listitem">
 723                 <span class="bold"><strong>Complexity:</strong></span> Constant.
 724               </li>
 725 <li class="listitem">
 726                 <span class="bold"><strong>Exception safety:</strong></span> nothrow.
 727               </li>
 728 </ul></div>
 729 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span> <span class="keyword">class</span> <span class="identifier">IteratorType</span> <span class="special">&gt;</span>
 730 <span class="identifier">right_iterator</span> <span class="identifier">project_right</span><span class="special">(</span><span class="identifier">IteratorType</span> <span class="identifier">iter</span><span class="special">);</span>
 731
 732 <span class="keyword">template</span><span class="special">&lt;</span> <span class="keyword">class</span> <span class="identifier">IteratorType</span> <span class="special">&gt;</span>
 733 <span class="identifier">right_const_iterator</span> <span class="identifier">project_right</span><span class="special">(</span><span class="identifier">IteratorType</span> <span class="identifier">iter</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
 734 </pre>
 735 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
 736 <li class="listitem">
 737                 <span class="bold"><strong>Requires:</strong></span> <code class="computeroutput"><span class="identifier">IteratorType</span></code>
 738                 is a bimap view iterator. it is a valid iterator of some view of
 739                 <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code>
 740                 (i.e. does not refer to some other <code class="computeroutput"><span class="identifier">bimap</span></code>.)
 741               </li>
 742 <li class="listitem">
 743                 <span class="bold"><strong>Effects:</strong></span> Returns a right map view
 744                 iterator equivalent to <code class="computeroutput"><span class="identifier">it</span></code>.
 745               </li>
 746 <li class="listitem">
 747                 <span class="bold"><strong>Complexity:</strong></span> Constant.
 748               </li>
 749 <li class="listitem">
 750                 <span class="bold"><strong>Exception safety:</strong></span> nothrow.
 751               </li>
 752 </ul></div>
 753 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span> <span class="keyword">class</span> <span class="identifier">IteratorType</span> <span class="special">&gt;</span>
 754 <span class="identifier">iterator</span> <span class="identifier">project_up</span><span class="special">(</span><span class="identifier">IteratorType</span> <span class="identifier">iter</span><span class="special">);</span>
 755
 756 <span class="keyword">template</span><span class="special">&lt;</span> <span class="keyword">class</span> <span class="identifier">IteratorType</span> <span class="special">&gt;</span>
 757 <span class="identifier">const_iterator</span> <span class="identifier">project_up</span><span class="special">(</span><span class="identifier">IteratorType</span> <span class="identifier">iter</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
 758 </pre>
 759 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
 760 <li class="listitem">
 761                 <span class="bold"><strong>Requires:</strong></span> <code class="computeroutput"><span class="identifier">IteratorType</span></code>
 762                 is a bimap view iterator. it is a valid iterator of some view of
 763                 <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code>
 764                 (i.e. does not refer to some other <code class="computeroutput"><span class="identifier">bimap</span></code>.)
 765               </li>
 766 <li class="listitem">
 767                 <span class="bold"><strong>Effects:</strong></span> Returns a collection of
 768                 relations view iterator equivalent to <code class="computeroutput"><span class="identifier">it</span></code>.
 769               </li>
 770 <li class="listitem">
 771                 <span class="bold"><strong>Complexity:</strong></span> Constant.
 772               </li>
 773 <li class="listitem">
 774                 <span class="bold"><strong>Exception safety:</strong></span> nothrow.
 775               </li>
 776 </ul></div>
 777 </div>
 778 <div class="section">
 779 <div class="titlepage"><div><div><h5 class="title">
 780 <a name="boost_bimap.reference.bimap_reference.class_template_bimap.support_for_user_defined_names"></a><a name="reference_support_for_used_defined_names"></a> <a class="link" href="bimap_reference.html#boost_bimap.reference.bimap_reference.class_template_bimap.support_for_user_defined_names" title="Support for user defined names">Support
 781           for user defined names</a>
 782 </h5></div></div></div>
 783 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span> <span class="keyword">class</span> <span class="identifier">Tag</span> <span class="special">&gt;</span>
 784 <span class="keyword">struct</span> <span class="identifier">map_by</span><span class="special">;</span>
 785 </pre>
 786 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
 787 <li class="listitem">
 788                 <code class="computeroutput"><span class="identifier">map_by</span><span class="special">&lt;</span><span class="identifier">Tag</span><span class="special">&gt;::</span><span class="identifier">type</span></code> yields the type of the map
 789                 view tagged with <code class="computeroutput"><span class="identifier">Tag</span></code>.
 790                 <code class="computeroutput"><span class="identifier">map_by</span><span class="special">&lt;</span><span class="identifier">Tag</span><span class="special">&gt;::</span></code><span class="emphasis"><em>-type
 791                 name-</em></span> is the same as <code class="computeroutput"><span class="identifier">map_by</span><span class="special">&lt;</span><span class="identifier">Tag</span><span class="special">&gt;::</span><span class="identifier">type</span><span class="special">::</span></code><span class="emphasis"><em>-type name-</em></span>.
 792               </li>
 793 <li class="listitem">
 794                 <span class="bold"><strong>Requires: </strong></span> <code class="computeroutput"><span class="identifier">Tag</span></code>
 795                 is a valid user defined name of the bimap.
 796               </li>
 797 </ul></div>
 798 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span> <span class="keyword">class</span> <span class="identifier">Tag</span> <span class="special">&gt;</span>
 799 <span class="identifier">map_by</span><span class="special">&lt;</span><span class="identifier">Tag</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="identifier">by</span><span class="special">();</span>
 800
 801 <span class="keyword">template</span><span class="special">&lt;</span> <span class="keyword">class</span> <span class="identifier">Tag</span> <span class="special">&gt;</span>
 802 <span class="keyword">const</span> <span class="identifier">map_by</span><span class="special">&lt;</span><span class="identifier">Tag</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="special">&amp;</span> <span class="identifier">by</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span>
 803 </pre>
 804 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
 805 <li class="listitem">
 806                 <span class="bold"><strong>Requires: </strong></span> <code class="computeroutput"><span class="identifier">Tag</span></code>
 807                 is a valid user defined name of the bimap.
 808               </li>
 809 <li class="listitem">
 810                 <span class="bold"><strong>Effects:</strong></span> Returns a reference to
 811                 the map view tagged with <code class="computeroutput"><span class="identifier">Tag</span></code>
 812                 held by <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code>.
 813               </li>
 814 <li class="listitem">
 815                 <span class="bold"><strong>Complexity:</strong></span> Constant.
 816               </li>
 817 <li class="listitem">
 818                 <span class="bold"><strong>Exception safety:</strong></span> nothrow.
 819               </li>
 820 </ul></div>
 821 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span> <span class="keyword">class</span> <span class="identifier">Tag</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">IteratorType</span> <span class="special">&gt;</span>
 822 <span class="identifier">map_by</span><span class="special">&lt;</span><span class="identifier">Tag</span><span class="special">&gt;::</span><span class="identifier">iterator</span> <span class="identifier">project</span><span class="special">(</span><span class="identifier">IteratorType</span> <span class="identifier">iter</span><span class="special">);</span>
 823
 824 <span class="keyword">template</span><span class="special">&lt;</span> <span class="keyword">class</span> <span class="identifier">Tag</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">IteratorType</span> <span class="special">&gt;</span>
 825 <span class="identifier">map_by</span><span class="special">&lt;</span><span class="identifier">Tag</span><span class="special">&gt;::</span><span class="identifier">const_iterator</span> <span class="identifier">project</span><span class="special">(</span><span class="identifier">IteratorType</span> <span class="identifier">iter</span><span class="special">)</span> <span class="keyword">const</span>
 826 </pre>
 827 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
 828 <li class="listitem">
 829                 <span class="bold"><strong>Requires: </strong></span> <code class="computeroutput"><span class="identifier">Tag</span></code>
 830                 is a valid user defined name of the bimap. <code class="computeroutput"><span class="identifier">IteratorType</span></code>
 831                 is a bimap view iterator. it is a valid iterator of some view of
 832                 <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code>
 833                 (i.e. does not refer to some other <code class="computeroutput"><span class="identifier">bimap</span></code>.)
 834               </li>
 835 <li class="listitem">
 836                 <span class="bold"><strong>Effects:</strong></span> Returns a reference to
 837                 the map view tagged with <code class="computeroutput"><span class="identifier">Tag</span></code>
 838                 held by <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code>.
 839               </li>
 840 <li class="listitem">
 841                 <span class="bold"><strong>Complexity:</strong></span> Constant.
 842               </li>
 843 <li class="listitem">
 844                 <span class="bold"><strong>Exception safety:</strong></span> nothrow.
 845               </li>
 846 </ul></div>
 847 </div>
 848 <div class="section">
 849 <div class="titlepage"><div><div><h5 class="title">
 850 <a name="boost_bimap.reference.bimap_reference.class_template_bimap.serialization"></a><a class="link" href="bimap_reference.html#boost_bimap.reference.bimap_reference.class_template_bimap.serialization" title="Serialization">Serialization</a>
 851 </h5></div></div></div>
 852 <p>
 853             A <code class="computeroutput"><span class="identifier">bimap</span></code> can be archived
 854             and retrieved by means of <a href="http://www.boost.org/libs/serialization/doc/index.html" target="_top"><span class="bold"><strong>Boost.Serialization</strong></span></a>. Boost.Bimap does
 855             not expose a public serialisation interface, as this is provided by Boost.Serialization
 856             itself. Both regular and XML archives are supported.
 857           </p>
 858 <p>
 859             Each of the set specifications comprising a given <code class="computeroutput"><span class="identifier">bimap</span></code>
 860             contributes its own preconditions as well as guarantees on the retrieved
 861             containers. In describing these, the following concepts are used. A type
 862             <code class="computeroutput"><span class="identifier">T</span></code> is <span class="emphasis"><em>serializable</em></span>
 863             (resp. XML-serializable) if any object of type <code class="computeroutput"><span class="identifier">T</span></code>
 864             can be saved to an output archive (XML archive) and later retrieved from
 865             an input archive (XML archive) associated to the same storage. If <code class="computeroutput"><span class="identifier">x</span></code>' of type <code class="computeroutput"><span class="identifier">T</span></code>
 866             is loaded from the serialization information saved from another object
 867             x, we say that x' is a <span class="emphasis"><em>restored copy</em></span> of x. Given
 868             a <a href="http://www.sgi.com/tech/stl/BinaryPredicate.html" target="_top">Binary
 869             Predicate</a> <code class="computeroutput"><span class="identifier">Pred</span></code>
 870             over <code class="computeroutput"><span class="special">(</span><span class="identifier">T</span><span class="special">,</span> <span class="identifier">T</span><span class="special">)</span></code>, and objects <code class="computeroutput"><span class="identifier">p</span></code>
 871             and <code class="computeroutput"><span class="identifier">q</span></code> of type <code class="computeroutput"><span class="identifier">Pred</span></code>, we say that <code class="computeroutput"><span class="identifier">q</span></code>
 872             is <span class="emphasis"><em>serialization-compatible</em></span> with <code class="computeroutput"><span class="identifier">p</span></code>
 873             if
 874           </p>
 875 <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
 876                 <code class="computeroutput"><span class="identifier">p</span><span class="special">(</span><span class="identifier">x</span><span class="special">,</span><span class="identifier">y</span><span class="special">)</span> <span class="special">==</span> <span class="identifier">q</span><span class="special">(</span><span class="identifier">x</span></code>'<code class="computeroutput"><span class="special">,</span><span class="identifier">y</span></code>'<code class="computeroutput"><span class="special">)</span></code>
 877               </li></ul></div>
 878 <p>
 879             for every <code class="computeroutput"><span class="identifier">x</span></code> and <code class="computeroutput"><span class="identifier">y</span></code> of type <code class="computeroutput"><span class="identifier">T</span></code>
 880             and <code class="computeroutput"><span class="identifier">x</span></code>' and <code class="computeroutput"><span class="identifier">y</span></code>' being restored copies of <code class="computeroutput"><span class="identifier">x</span></code> and <code class="computeroutput"><span class="identifier">y</span></code>,
 881             respectively.
 882           </p>
 883 <div class="sidebar">
 884 <div class="titlepage"></div>
 885 <p>
 886             <span class="bold"><strong>Operation:</strong></span> saving of a <code class="computeroutput"><span class="identifier">bimap</span> <span class="identifier">b</span></code>
 887             to an output archive (XML archive) ar.
 888           </p>
 889 </div>
 890 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
 891 <li class="listitem">
 892                 <span class="bold"><strong>Requires:</strong></span> Value is serializable
 893                 (XML-serializable). Additionally, each of the views of b can impose
 894                 other requirements.
 895               </li>
 896 <li class="listitem">
 897                 <span class="bold"><strong>Exception safety:</strong></span> Strong with respect
 898                 to <code class="computeroutput"><span class="identifier">b</span></code>. If an exception
 899                 is thrown, ar may be left in an inconsistent state.
 900               </li>
 901 </ul></div>
 902 <div class="sidebar">
 903 <div class="titlepage"></div>
 904 <p>
 905             <span class="bold"><strong>Operation:</strong></span> loading of a <code class="computeroutput"><span class="identifier">bimap</span></code> m' from an input archive (XML
 906             archive) ar.
 907           </p>
 908 </div>
 909 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
 910 <li class="listitem">
 911                 <span class="bold"><strong>Requires:</strong></span> Value is serializable
 912                 (XML-serializable). Additionally, each of the views of <code class="computeroutput"><span class="identifier">b</span></code>' can impose other requirements.
 913               </li>
 914 <li class="listitem">
 915                 <span class="bold"><strong>Exception safety:</strong></span> Basic. If an exception
 916                 is thrown, ar may be left in an inconsistent state.
 917               </li>
 918 </ul></div>
 919 </div>
 920 </div>
 921 </div>
 922 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 923 <td align="left"></td>
 924 <td align="right"><div class="copyright-footer">Copyright &#169; 2006 -2007 Matias Capeletto<p>
 925         Distributed under the Boost Software License, Version 1.0. (See accompanying
 926         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
 927       </p>
 928 </div></td>
 929 </tr></table>
 930 <hr>
 931 <div class="spirit-nav">
 932 <a accesskey="p" href="../reference.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="set_of_reference.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 933 </div>
 934 </body>
 935 </html>