Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_34_1/libs/multi_index/doc/reference/index.html @ 29

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

updated boost from 1_33_1 to 1_34_1
File size: 5.1 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<link rel="start" href="../index.html">
9<link rel="prev" href="../tutorial/techniques.html">
10<link rel="up" href="../index.html">
11<link rel="next" href="multi_index_container.html">
12</head>
13
14<body>
15<h1><img src="../../../../boost.png" alt="boost.png (6897 bytes)" align=
16"middle" width="277" height="86">Boost.MultiIndex Reference</h1>
17
18<div class="prev_link"><a href="../tutorial/techniques.html"><img src="../prev.gif" alt="techniques" border="0"><br>
19Tecnhiques
20</a></div>
21<div class="up_link"><a href="../index.html"><img src="../up.gif" alt="index" border="0"><br>
22Index
23</a></div>
24<div class="next_link"><a href="multi_index_container.html"><img src="../next.gif" alt="multi_index_container reference" border="0"><br>
25<code>multi_index_container</code> reference
26</a></div><br clear="all" style="clear: all;">
27
28<hr>
29
30<h2>Contents</h2>
31
32<ul>
33  <li><a href="#header_dependencies">Header dependencies</a></li>
34  <li><a href="multi_index_container.html">Class template <code>multi_index_container</code></a></li>
35  <li><a href="indices.html">Index reference</a></li>
36  <li><a href="ord_indices.html">Ordered indices</a></li>
37  <li><a href="hash_indices.html">Hashed indices</a></li>
38  <li><a href="seq_indices.html">Sequenced indices</a></li>
39  <li><a href="rnd_indices.html">Random access indices</a></li>
40  <li><a href="key_extraction.html">Key Extraction</a></li>
41</ul>
42
43<h2><a name="header_dependencies">Header dependencies</a></h2>
44
45<p>
46The following dependencies among headers of Boost.MultiIndex hold:
47<ul>
48  <li><a href="multi_index_container.html#synopsis"><code>"boost/multi_index_container.hpp"</code></a>
49    includes
50    <ul>
51      <li><a href="indices.html#indexed_by_synopsis">
52            <code>"boost/multi_index/indexed_by.hpp"</code></a>.</li>
53    </ul>
54  </li>
55  <li><a href="ord_indices.html#synopsis">
56    <code>"boost/multi_index/ordered_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> and</li>
92          <li><a href="key_extraction.html#composite_key_synopsis">
93        <code>"boost/multi_index/composite_key.hpp"</code></a>.</li>
94    </ul>
95  </li>
96</ul>
97So, a program using Boost.MultiIndex must include
98<a href="multi_index_container.html#synopsis">
99<code>"boost/multi_index_container.hpp"</code></a>,
100the headers defining the index types to be used and possibly one or more key
101extraction headers for key-based indices. Note that all the key extractors
102provided by Boost.MultiIndex are automatically included with
103<a href="key_extraction.html#synopsis">
104<code>"boost/multi_index/key_extractors.hpp"</code></a>.
105</p>
106
107<p>
108In order to use the serialization capabilities of Boost.MultiIndex,
109the appropriate Boost.Serialization library module must be linked. Other
110than that, Boost.MultiIndex is a header-only library, requiring no additional
111object modules.
112</p>
113
114<hr>
115
116<div class="prev_link"><a href="../tutorial/techniques.html"><img src="../prev.gif" alt="techniques" border="0"><br>
117Tecnhiques
118</a></div>
119<div class="up_link"><a href="../index.html"><img src="../up.gif" alt="index" border="0"><br>
120Index
121</a></div>
122<div class="next_link"><a href="multi_index_container.html"><img src="../next.gif" alt="multi_index_container reference" border="0"><br>
123<code>multi_index_container</code> reference
124</a></div><br clear="all" style="clear: all;">
125
126<br>
127
128<p>Revised February 6th 2005</p>
129
130<p>&copy; Copyright 2003-2006 Joaqu&iacute;n M L&oacute;pez Mu&ntilde;oz.
131Distributed under the Boost Software
132License, Version 1.0. (See accompanying file <a href="../../../../LICENSE_1_0.txt">
133LICENSE_1_0.txt</a> or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">
134http://www.boost.org/LICENSE_1_0.txt</a>)
135</p>
136
137</body>
138</html>
Note: See TracBrowser for help on using the repository browser.