index.html 5.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0.1 Transitional//EN">
  2. <html>
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
  5. <title>Boost.MultiIndex Documentation - Reference</title>
  6. <link rel="stylesheet" href="../style.css" type="text/css">
  7. <link rel="start" href="../index.html">
  8. <link rel="prev" href="../tutorial/techniques.html">
  9. <link rel="up" href="../index.html">
  10. <link rel="next" href="multi_index_container.html">
  11. </head>
  12. <body>
  13. <h1><img src="../../../../boost.png" alt="boost.png (6897 bytes)" align=
  14. "middle" width="277" height="86">Boost.MultiIndex Reference</h1>
  15. <div class="prev_link"><a href="../tutorial/techniques.html"><img src="../prev.gif" alt="techniques" border="0"><br>
  16. Techniques
  17. </a></div>
  18. <div class="up_link"><a href="../index.html"><img src="../up.gif" alt="index" border="0"><br>
  19. Index
  20. </a></div>
  21. <div class="next_link"><a href="multi_index_container.html"><img src="../next.gif" alt="multi_index_container reference" border="0"><br>
  22. <code>multi_index_container</code> reference
  23. </a></div><br clear="all" style="clear: all;">
  24. <hr>
  25. <h2>Contents</h2>
  26. <ul>
  27. <li><a href="#header_dependencies">Header dependencies</a></li>
  28. <li><a href="multi_index_container.html">Class template <code>multi_index_container</code></a></li>
  29. <li><a href="indices.html">Index reference</a></li>
  30. <li><a href="ord_indices.html">Ordered indices</a></li>
  31. <li><a href="rnk_indices.html">Ranked indices</a></li>
  32. <li><a href="hash_indices.html">Hashed indices</a></li>
  33. <li><a href="seq_indices.html">Sequenced indices</a></li>
  34. <li><a href="rnd_indices.html">Random access indices</a></li>
  35. <li><a href="key_extraction.html">Key Extraction</a></li>
  36. </ul>
  37. <h2><a name="header_dependencies">Header dependencies</a></h2>
  38. <p>
  39. The following dependencies among headers of Boost.MultiIndex hold:
  40. <ul>
  41. <li><a href="multi_index_container.html#synopsis"><code>"boost/multi_index_container.hpp"</code></a>
  42. includes
  43. <ul>
  44. <li><a href="indices.html#indexed_by_synopsis">
  45. <code>"boost/multi_index/indexed_by.hpp"</code></a>.</li>
  46. </ul>
  47. </li>
  48. <li><a href="ord_indices.html#synopsis">
  49. <code>"boost/multi_index/ordered_index.hpp"</code></a> includes
  50. <ul>
  51. <li><a href="indices.html#tag_synopsis">
  52. <code>"boost/multi_index/tag.hpp"</code></a>.</li>
  53. </ul>
  54. </li>
  55. <li><a href="rnk_indices.html#synopsis">
  56. <code>"boost/multi_index/ranked_index.hpp"</code></a> includes
  57. <ul>
  58. <li><a href="indices.html#tag_synopsis">
  59. <code>"boost/multi_index/tag.hpp"</code></a>.</li>
  60. </ul>
  61. </li>
  62. <li><a href="hash_indices.html#synopsis">
  63. <code>"boost/multi_index/hashed_index.hpp"</code></a> includes
  64. <ul>
  65. <li><a href="indices.html#tag_synopsis">
  66. <code>"boost/multi_index/tag.hpp"</code></a>.</li>
  67. </ul>
  68. </li>
  69. <li><a href="seq_indices.html#synopsis">
  70. <code>"boost/multi_index/sequenced_index.hpp"</code></a> includes
  71. <ul>
  72. <li><a href="indices.html#tag_synopsis">
  73. <code>"boost/multi_index/tag.hpp"</code></a>.</li>
  74. </ul>
  75. </li>
  76. <li><a href="rnd_indices.html#synopsis">
  77. <code>"boost/multi_index/random_access_index.hpp"</code></a> includes
  78. <ul>
  79. <li><a href="indices.html#tag_synopsis">
  80. <code>"boost/multi_index/tag.hpp"</code></a>.</li>
  81. </ul>
  82. </li>
  83. <li><a href="key_extraction.html#synopsis"><code>"boost/multi_index/key_extractors.hpp"</code></a>
  84. includes
  85. <ul>
  86. <li><a href="key_extraction.html#identity_synopsis">
  87. <code>"boost/multi_index/identity.hpp"</code></a>,</li>
  88. <li><a href="key_extraction.html#member_synopsis">
  89. <code>"boost/multi_index/member.hpp"</code></a>,</li>
  90. <li><a href="key_extraction.html#mem_fun_synopsis">
  91. <code>"boost/multi_index/mem_fun.hpp"</code></a>,</li>
  92. <li><a href="key_extraction.html#global_fun_synopsis">
  93. <code>"boost/multi_index/global_fun.hpp"</code></a> and</li>
  94. <li><a href="key_extraction.html#composite_key_synopsis">
  95. <code>"boost/multi_index/composite_key.hpp"</code></a>.</li>
  96. </ul>
  97. </li>
  98. </ul>
  99. So, a program using Boost.MultiIndex must include
  100. <a href="multi_index_container.html#synopsis">
  101. <code>"boost/multi_index_container.hpp"</code></a>,
  102. the headers defining the index types to be used and possibly one or more key
  103. extraction headers for key-based indices. Note that all the key extractors
  104. provided by Boost.MultiIndex are automatically included with
  105. <a href="key_extraction.html#synopsis">
  106. <code>"boost/multi_index/key_extractors.hpp"</code></a>.
  107. </p>
  108. <p>
  109. In order to use the serialization capabilities of Boost.MultiIndex,
  110. the appropriate Boost.Serialization library module must be linked. Other
  111. than that, Boost.MultiIndex is a header-only library, requiring no additional
  112. object modules.
  113. </p>
  114. <hr>
  115. <div class="prev_link"><a href="../tutorial/techniques.html"><img src="../prev.gif" alt="techniques" border="0"><br>
  116. Techniques
  117. </a></div>
  118. <div class="up_link"><a href="../index.html"><img src="../up.gif" alt="index" border="0"><br>
  119. Index
  120. </a></div>
  121. <div class="next_link"><a href="multi_index_container.html"><img src="../next.gif" alt="multi_index_container reference" border="0"><br>
  122. <code>multi_index_container</code> reference
  123. </a></div><br clear="all" style="clear: all;">
  124. <br>
  125. <p>Revised November 24th 2015</p>
  126. <p>&copy; Copyright 2003-2015 Joaqu&iacute;n M L&oacute;pez Mu&ntilde;oz.
  127. Distributed under the Boost Software
  128. License, Version 1.0. (See accompanying file <a href="../../../../LICENSE_1_0.txt">
  129. LICENSE_1_0.txt</a> or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">
  130. http://www.boost.org/LICENSE_1_0.txt</a>)
  131. </p>
  132. </body>
  133. </html>