Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_33_1/libs/multi_index/doc/reference/index.html @ 12

Last change on this file since 12 was 12, checked in by landauf, 17 years ago

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