reference.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
  4. <title>Reference</title>
  5. <link rel="stylesheet" href="../boostbook.css" type="text/css">
  6. <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
  7. <link rel="home" href="../index.html" title="Chapter&#160;1.&#160;Boost.Bimap">
  8. <link rel="up" href="../index.html" title="Chapter&#160;1.&#160;Boost.Bimap">
  9. <link rel="prev" href="bimap_and_boost/dependencies.html" title="Dependencies">
  10. <link rel="next" href="reference/bimap_reference.html" title="Bimap 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="bimap_and_boost/dependencies.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="reference/bimap_reference.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
  24. </div>
  25. <div class="section">
  26. <div class="titlepage"><div><div><h2 class="title" style="clear: both">
  27. <a name="boost_bimap.reference"></a><a class="link" href="reference.html" title="Reference">Reference</a>
  28. </h2></div></div></div>
  29. <div class="toc"><dl class="toc">
  30. <dt><span class="section"><a href="reference.html#boost_bimap.reference.headers">Headers</a></span></dt>
  31. <dt><span class="section"><a href="reference/bimap_reference.html">Bimap Reference</a></span></dt>
  32. <dd><dl>
  33. <dt><span class="section"><a href="reference/bimap_reference.html#boost_bimap.reference.bimap_reference.view_concepts">View
  34. concepts</a></span></dt>
  35. <dt><span class="section"><a href="reference/bimap_reference.html#boost_bimap.reference.bimap_reference.complexity_signature">Complexity
  36. signature</a></span></dt>
  37. <dt><span class="section"><a href="reference/bimap_reference.html#boost_bimap.reference.bimap_reference.set_type_specification">Set
  38. type specification</a></span></dt>
  39. <dt><span class="section"><a href="reference/bimap_reference.html#boost_bimap.reference.bimap_reference.tags">Tags</a></span></dt>
  40. <dt><span class="section"><a href="reference/bimap_reference.html#boost_bimap.reference.bimap_reference.header__boost_bimap_bimap_hpp__synopsis">Header
  41. "boost/bimap/bimap.hpp" synopsis</a></span></dt>
  42. <dt><span class="section"><a href="reference/bimap_reference.html#boost_bimap.reference.bimap_reference.class_template_bimap">Class
  43. template bimap</a></span></dt>
  44. </dl></dd>
  45. <dt><span class="section"><a href="reference/set_of_reference.html">set_of Reference</a></span></dt>
  46. <dd><dl>
  47. <dt><span class="section"><a href="reference/set_of_reference.html#boost_bimap.reference.set_of_reference.header__boost_bimap_set_of_hpp__synopsis">Header
  48. "boost/bimap/set_of.hpp" synopsis</a></span></dt>
  49. <dt><span class="section"><a href="reference/set_of_reference.html#boost_bimap.reference.set_of_reference.header__boost_bimap_multiset_of_hpp__synopsis">Header
  50. "boost/bimap/multiset_of.hpp" synopsis</a></span></dt>
  51. <dt><span class="section"><a href="reference/set_of_reference.html#boost_bimap.reference.set_of_reference.collection_type_specifiers_set_of_and_multiset_of">Collection
  52. type specifiers set_of and multiset_of</a></span></dt>
  53. <dt><span class="section"><a href="reference/set_of_reference.html#boost_bimap.reference.set_of_reference.__multi__set_of_views">[multi]set_of
  54. Views</a></span></dt>
  55. </dl></dd>
  56. <dt><span class="section"><a href="reference/unordered_set_of_reference.html">unordered_set_of
  57. Reference</a></span></dt>
  58. <dd><dl>
  59. <dt><span class="section"><a href="reference/unordered_set_of_reference.html#boost_bimap.reference.unordered_set_of_reference.header__boost_bimap_unordered_set_of_hpp__synopsis">Header
  60. "boost/bimap/unordered_set_of.hpp" synopsis</a></span></dt>
  61. <dt><span class="section"><a href="reference/unordered_set_of_reference.html#boost_bimap.reference.unordered_set_of_reference.header__boost_bimap_unordered_multiset_of_hpp__synopsis">Header
  62. "boost/bimap/unordered_multiset_of.hpp" synopsis</a></span></dt>
  63. <dt><span class="section"><a href="reference/unordered_set_of_reference.html#boost_bimap.reference.unordered_set_of_reference.collection_type_specifiers_unordered_set_of_and_unordered_multiset_of">Collection
  64. type specifiers unordered_set_of and unordered_multiset_of</a></span></dt>
  65. <dt><span class="section"><a href="reference/unordered_set_of_reference.html#boost_bimap.reference.unordered_set_of_reference.unordered___multi__set_of_views">unordered_[multi]set_of
  66. Views</a></span></dt>
  67. </dl></dd>
  68. <dt><span class="section"><a href="reference/list_of_reference.html">list_of Reference</a></span></dt>
  69. <dd><dl>
  70. <dt><span class="section"><a href="reference/list_of_reference.html#boost_bimap.reference.list_of_reference.header__boost_bimap_list_of_hpp__synopsis">Header
  71. "boost/bimap/list_of.hpp" synopsis</a></span></dt>
  72. <dt><span class="section"><a href="reference/list_of_reference.html#boost_bimap.reference.list_of_reference.list_of_views">list_of
  73. Views</a></span></dt>
  74. </dl></dd>
  75. <dt><span class="section"><a href="reference/vector_of_reference.html">vector_of
  76. Reference</a></span></dt>
  77. <dd><dl>
  78. <dt><span class="section"><a href="reference/vector_of_reference.html#boost_bimap.reference.vector_of_reference.header__boost_bimap_vector_of_hpp__synopsis">Header
  79. "boost/bimap/vector_of.hpp" synopsis</a></span></dt>
  80. <dt><span class="section"><a href="reference/vector_of_reference.html#boost_bimap.reference.vector_of_reference.vector_of_views">vector_of
  81. views</a></span></dt>
  82. </dl></dd>
  83. <dt><span class="section"><a href="reference/unconstrained_set_of_reference.html">unconstrained_set_of
  84. Reference</a></span></dt>
  85. <dd><dl>
  86. <dt><span class="section"><a href="reference/unconstrained_set_of_reference.html#boost_bimap.reference.unconstrained_set_of_reference.header__boost_bimap_unconstrained_set_of_hpp__synopsis">Header
  87. "boost/bimap/unconstrained_set_of.hpp" synopsis</a></span></dt>
  88. <dt><span class="section"><a href="reference/unconstrained_set_of_reference.html#boost_bimap.reference.unconstrained_set_of_reference.unconstrained_set_of_views">unconstrained_set_of
  89. Views</a></span></dt>
  90. </dl></dd>
  91. </dl></div>
  92. <div class="section">
  93. <div class="titlepage"><div><div><h3 class="title">
  94. <a name="boost_bimap.reference.headers"></a><a class="link" href="reference.html#boost_bimap.reference.headers" title="Headers">Headers</a>
  95. </h3></div></div></div>
  96. <p>
  97. The following are the interface headers of Boost.Bimap:
  98. </p>
  99. <p>
  100. <span class="bold"><strong>Convenience</strong></span>
  101. </p>
  102. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
  103. "boost/bimap.hpp" <span class="emphasis"><em>(includes "boost/bimap/bimap.hpp"
  104. and imports the bimap class to boost namespace)</em></span>
  105. </li></ul></div>
  106. <p>
  107. <span class="bold"><strong>Container</strong></span>
  108. </p>
  109. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
  110. "boost/bimap/bimap.hpp" <span class="emphasis"><em>(includes "boost/bimap/set_of.hpp"
  111. and "boost/bimap/unconstrained_set_of.hpp")</em></span>
  112. </li></ul></div>
  113. <p>
  114. <span class="bold"><strong>Set Types</strong></span>
  115. </p>
  116. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  117. <li class="listitem">
  118. "boost/bimap/set_of.hpp"
  119. </li>
  120. <li class="listitem">
  121. "boost/bimap/multiset_of.hpp"
  122. </li>
  123. <li class="listitem">
  124. "boost/bimap/unordered_set_of.hpp"
  125. </li>
  126. <li class="listitem">
  127. "boost/bimap/unordered_multiset_of.hpp"
  128. </li>
  129. <li class="listitem">
  130. "boost/bimap/list_of.hpp"
  131. </li>
  132. <li class="listitem">
  133. "boost/bimap/vector_of.hpp"
  134. </li>
  135. <li class="listitem">
  136. "boost/bimap/unconstrained_set_of.hpp"
  137. </li>
  138. </ul></div>
  139. <p>
  140. <span class="bold"><strong>Boost Integration</strong></span>
  141. </p>
  142. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  143. <li class="listitem">
  144. "boost/bimap/support/lambda.hpp"
  145. </li>
  146. <li class="listitem">
  147. "boost/bimap/property_map/set_support.hpp"
  148. </li>
  149. <li class="listitem">
  150. "boost/bimap/property_map/unordered_set_support.hpp"
  151. </li>
  152. </ul></div>
  153. <p>
  154. A program using Boost.Bimap must therefore include "boost/bimap/bimap.hpp"
  155. and the headers defining the collection types to be used.
  156. </p>
  157. <p>
  158. Additional headers allow the integration of Boost.Bimap with other boost
  159. libraries, like Boost.Lambda and Boost.Property_map.
  160. </p>
  161. <p>
  162. In order to use the serialization capabilities of Boost.Bimap, the appropriate
  163. Boost.Serialization library module must be linked. Other than that, Boost.Bimap
  164. is a header-only library, requiring no additional object modules.
  165. </p>
  166. </div>
  167. </div>
  168. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  169. <td align="left"></td>
  170. <td align="right"><div class="copyright-footer">Copyright &#169; 2006-2012 Matias Capeletto<p>
  171. Distributed under the Boost Software License, Version 1.0. (See accompanying
  172. 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>)
  173. </p>
  174. </div></td>
  175. </tr></table>
  176. <hr>
  177. <div class="spirit-nav">
  178. <a accesskey="p" href="bimap_and_boost/dependencies.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="reference/bimap_reference.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
  179. </div>
  180. </body>
  181. </html>