File: index.html

package info (click to toggle)
boost 1.34.1-14
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 116,412 kB
  • ctags: 259,566
  • sloc: cpp: 642,395; xml: 56,450; python: 17,612; ansic: 14,520; sh: 2,265; yacc: 858; perl: 481; makefile: 478; lex: 94; sql: 74; csh: 6
file content (138 lines) | stat: -rw-r--r-- 5,243 bytes parent folder | download 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0.1 Transitional//EN">

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Boost.MultiIndex Documentation - Reference</title>
<link rel="stylesheet" href="../style.css" type="text/css">
<link rel="start" href="../index.html">
<link rel="prev" href="../tutorial/techniques.html">
<link rel="up" href="../index.html">
<link rel="next" href="multi_index_container.html">
</head>

<body>
<h1><img src="../../../../boost.png" alt="boost.png (6897 bytes)" align=
"middle" width="277" height="86">Boost.MultiIndex Reference</h1>

<div class="prev_link"><a href="../tutorial/techniques.html"><img src="../prev.gif" alt="techniques" border="0"><br>
Tecnhiques
</a></div>
<div class="up_link"><a href="../index.html"><img src="../up.gif" alt="index" border="0"><br>
Index
</a></div>
<div class="next_link"><a href="multi_index_container.html"><img src="../next.gif" alt="multi_index_container reference" border="0"><br>
<code>multi_index_container</code> reference
</a></div><br clear="all" style="clear: all;">

<hr>

<h2>Contents</h2>

<ul>
  <li><a href="#header_dependencies">Header dependencies</a></li>
  <li><a href="multi_index_container.html">Class template <code>multi_index_container</code></a></li>
  <li><a href="indices.html">Index reference</a></li>
  <li><a href="ord_indices.html">Ordered indices</a></li>
  <li><a href="hash_indices.html">Hashed indices</a></li>
  <li><a href="seq_indices.html">Sequenced indices</a></li>
  <li><a href="rnd_indices.html">Random access indices</a></li>
  <li><a href="key_extraction.html">Key Extraction</a></li>
</ul>

<h2><a name="header_dependencies">Header dependencies</a></h2>

<p>
The following dependencies among headers of Boost.MultiIndex hold:
<ul>
  <li><a href="multi_index_container.html#synopsis"><code>"boost/multi_index_container.hpp"</code></a>
    includes
    <ul>
      <li><a href="indices.html#indexed_by_synopsis">
	    <code>"boost/multi_index/indexed_by.hpp"</code></a>.</li>
    </ul>
  </li>
  <li><a href="ord_indices.html#synopsis">
    <code>"boost/multi_index/ordered_index.hpp"</code></a> includes
    <ul>
      <li><a href="indices.html#tag_synopsis">
        <code>"boost/multi_index/tag.hpp"</code></a>.</li>
    </ul>
  </li>
  <li><a href="hash_indices.html#synopsis">
    <code>"boost/multi_index/hashed_index.hpp"</code></a> includes
    <ul>
      <li><a href="indices.html#tag_synopsis">
        <code>"boost/multi_index/tag.hpp"</code></a>.</li>
    </ul>
  </li>
  <li><a href="seq_indices.html#synopsis">
    <code>"boost/multi_index/sequenced_index.hpp"</code></a> includes
    <ul>
      <li><a href="indices.html#tag_synopsis">
        <code>"boost/multi_index/tag.hpp"</code></a>.</li>
    </ul>
  </li>
  <li><a href="rnd_indices.html#synopsis">
    <code>"boost/multi_index/random_access_index.hpp"</code></a> includes
    <ul>
      <li><a href="indices.html#tag_synopsis">
        <code>"boost/multi_index/tag.hpp"</code></a>.</li>
    </ul>
  </li>
  <li><a href="key_extraction.html#synopsis"><code>"boost/multi_index/key_extractors.hpp"</code></a>
    includes
    <ul>
      <li><a href="key_extraction.html#identity_synopsis">
	    <code>"boost/multi_index/identity.hpp"</code></a>,</li>
      <li><a href="key_extraction.html#member_synopsis">
        <code>"boost/multi_index/member.hpp"</code></a>,</li>
	  <li><a href="key_extraction.html#mem_fun_synopsis">
        <code>"boost/multi_index/mem_fun.hpp"</code></a> and</li>
	  <li><a href="key_extraction.html#composite_key_synopsis">
        <code>"boost/multi_index/composite_key.hpp"</code></a>.</li>
    </ul>
  </li>
</ul>
So, a program using Boost.MultiIndex must include
<a href="multi_index_container.html#synopsis">
<code>"boost/multi_index_container.hpp"</code></a>,
the headers defining the index types to be used and possibly one or more key
extraction headers for key-based indices. Note that all the key extractors
provided by Boost.MultiIndex are automatically included with
<a href="key_extraction.html#synopsis">
<code>"boost/multi_index/key_extractors.hpp"</code></a>.
</p>

<p>
In order to use the serialization capabilities of Boost.MultiIndex,
the appropriate Boost.Serialization library module must be linked. Other
than that, Boost.MultiIndex is a header-only library, requiring no additional
object modules.
</p>

<hr>

<div class="prev_link"><a href="../tutorial/techniques.html"><img src="../prev.gif" alt="techniques" border="0"><br>
Tecnhiques
</a></div>
<div class="up_link"><a href="../index.html"><img src="../up.gif" alt="index" border="0"><br>
Index
</a></div>
<div class="next_link"><a href="multi_index_container.html"><img src="../next.gif" alt="multi_index_container reference" border="0"><br>
<code>multi_index_container</code> reference
</a></div><br clear="all" style="clear: all;">

<br>

<p>Revised February 6th 2005</p>

<p>&copy; Copyright 2003-2006 Joaqu&iacute;n M L&oacute;pez Mu&ntilde;oz.
Distributed under the Boost Software 
License, Version 1.0. (See accompanying file <a href="../../../../LICENSE_1_0.txt">
LICENSE_1_0.txt</a> or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">
http://www.boost.org/LICENSE_1_0.txt</a>)
</p>

</body>
</html>