index.html 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899
  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 - Index</title>
  6. <link rel="stylesheet" href="style.css" type="text/css">
  7. <link rel="start" href="index.html">
  8. <link rel="next" href="tutorial/index.html">
  9. </head>
  10. <body>
  11. <h1><img src="../../../boost.png" alt="boost.png (6897 bytes)" align=
  12. "middle" width="277" height="86">Boost Multi-index Containers Library</h1>
  13. <div class="prev_link">&nbsp;</div>
  14. <div class="up_link">&nbsp;</div>
  15. <div class="next_link"><a href="tutorial/index.html"><img src="next.gif" alt="tutorial" border="0"><br>
  16. Tutorial
  17. </a></div><br clear="all" style="clear: all;">
  18. <hr>
  19. <p>
  20. The Boost Multi-index Containers Library provides a class template named
  21. <code>multi_index_container</code> which enables the construction of containers
  22. maintaining one or more <i>indices</i> with different sorting and access semantics.
  23. Indices provide interfaces similar to those of STL containers, making using them
  24. familiar. The concept of multi-indexing over the same collection of elements is
  25. borrowed from relational database terminology and allows for the specification of
  26. complex data structures in the spirit of multiply indexed relational tables where
  27. simple sets and maps are not enough. A wide selection of indices is provided,
  28. modeled after analogous STL containers like <code>std::set</code>,
  29. <code>std::list</code> and <code>std::unordered_set</code>.
  30. </p>
  31. <p>
  32. Boost.MultiIndex features additional functionalities, like subobject searching,
  33. range querying, in-place updating of elements and calculation of ranks,
  34. which make it a convenient replacement
  35. for <code>std::set</code> and <code>set::multiset</code> even when no multi-indexing
  36. capabilities are needed.
  37. </p>
  38. <p>
  39. The versatile nature of Boost.MultiIndex allows for the specification of
  40. a wide spectrum of different data structures. The following are possible
  41. examples of use developed in the documentation:
  42. <ul>
  43. <li><a href="tutorial/basics.html#multiple_sort">Sets with several iteration orders
  44. and search criteria</a>.</li>
  45. <li><a href="tutorial/basics.html#list_fast_lookup">Lists with fast lookup</a>
  46. and/or without duplicates.</li>
  47. <li><a href="examples.html#example4">Bidirectional maps</a>, i.e. maps
  48. searchable either for key or value.</li>
  49. <li><a href="examples.html#example9">MRU (most recently used) lists</a>,
  50. structures keeping the <i>n</i> last referenced items, beginning with
  51. the newest ones.</li>
  52. <li><a href="tutorial/techniques.html#emulate_std_containers">Emulations of
  53. standard containers</a> taking advantage of the extra functionalities
  54. provided by Boost.MultiIndex.</li>
  55. </ul>
  56. </p>
  57. <h2>Contents</h2>
  58. <ul>
  59. <li><a href="tutorial/index.html">Tutorial</a></li>
  60. <li><a href="reference/index.html">Reference</a></li>
  61. <li><a href="compiler_specifics.html">Compiler specifics</a></li>
  62. <li><a href="performance.html">Performance</a></li>
  63. <li><a href="examples.html">Examples</a></li>
  64. <li><a href="tests.html">Tests</a></li>
  65. <li><a href="future_work.html">Future work</a></li>
  66. <li><a href="release_notes.html">Release notes</a></li>
  67. <li><a href="acknowledgements.html">Acknowledgements</a></li>
  68. </ul>
  69. <hr>
  70. <div class="prev_link">&nbsp;</div>
  71. <div class="up_link">&nbsp;</div>
  72. <div class="next_link"><a href="tutorial/index.html"><img src="next.gif" alt="tutorial" border="0"><br>
  73. Tutorial
  74. </a></div><br clear="all" style="clear: all;">
  75. <br>
  76. <p>Revised April 19th 2015</p>
  77. <p>&copy; Copyright 2003-2015 Joaqu&iacute;n M L&oacute;pez Mu&ntilde;oz.
  78. Distributed under the Boost Software
  79. License, Version 1.0. (See accompanying file <a href="../../../LICENSE_1_0.txt">
  80. LICENSE_1_0.txt</a> or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">
  81. http://www.boost.org/LICENSE_1_0.txt</a>)
  82. </p>
  83. </body>
  84. </html>