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> 19Techniques 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="rnk_indices.html">Ranked indices</a></li> 38 <li><a href="hash_indices.html">Hashed indices</a></li> 39 <li><a href="seq_indices.html">Sequenced indices</a></li> 40 <li><a href="rnd_indices.html">Random access indices</a></li> 41 <li><a href="key_extraction.html">Key Extraction</a></li> 42</ul> 43 44<h2><a name="header_dependencies">Header dependencies</a></h2> 45 46<p> 47The following dependencies among headers of Boost.MultiIndex hold: 48<ul> 49 <li><a href="multi_index_container.html#synopsis"><code>"boost/multi_index_container.hpp"</code></a> 50 includes 51 <ul> 52 <li><a href="indices.html#indexed_by_synopsis"> 53 <code>"boost/multi_index/indexed_by.hpp"</code></a>.</li> 54 </ul> 55 </li> 56 <li><a href="ord_indices.html#synopsis"> 57 <code>"boost/multi_index/ordered_index.hpp"</code></a> includes 58 <ul> 59 <li><a href="indices.html#tag_synopsis"> 60 <code>"boost/multi_index/tag.hpp"</code></a>.</li> 61 </ul> 62 </li> 63 <li><a href="rnk_indices.html#synopsis"> 64 <code>"boost/multi_index/ranked_index.hpp"</code></a> includes 65 <ul> 66 <li><a href="indices.html#tag_synopsis"> 67 <code>"boost/multi_index/tag.hpp"</code></a>.</li> 68 </ul> 69 </li> 70 <li><a href="hash_indices.html#synopsis"> 71 <code>"boost/multi_index/hashed_index.hpp"</code></a> includes 72 <ul> 73 <li><a href="indices.html#tag_synopsis"> 74 <code>"boost/multi_index/tag.hpp"</code></a>.</li> 75 </ul> 76 </li> 77 <li><a href="seq_indices.html#synopsis"> 78 <code>"boost/multi_index/sequenced_index.hpp"</code></a> includes 79 <ul> 80 <li><a href="indices.html#tag_synopsis"> 81 <code>"boost/multi_index/tag.hpp"</code></a>.</li> 82 </ul> 83 </li> 84 <li><a href="rnd_indices.html#synopsis"> 85 <code>"boost/multi_index/random_access_index.hpp"</code></a> includes 86 <ul> 87 <li><a href="indices.html#tag_synopsis"> 88 <code>"boost/multi_index/tag.hpp"</code></a>.</li> 89 </ul> 90 </li> 91 <li><a href="key_extraction.html#synopsis"><code>"boost/multi_index/key_extractors.hpp"</code></a> 92 includes 93 <ul> 94 <li><a href="key_extraction.html#identity_synopsis"> 95 <code>"boost/multi_index/identity.hpp"</code></a>,</li> 96 <li><a href="key_extraction.html#member_synopsis"> 97 <code>"boost/multi_index/member.hpp"</code></a>,</li> 98 <li><a href="key_extraction.html#mem_fun_synopsis"> 99 <code>"boost/multi_index/mem_fun.hpp"</code></a>,</li> 100 <li><a href="key_extraction.html#global_fun_synopsis"> 101 <code>"boost/multi_index/global_fun.hpp"</code></a> and</li> 102 <li><a href="key_extraction.html#composite_key_synopsis"> 103 <code>"boost/multi_index/composite_key.hpp"</code></a>.</li> 104 </ul> 105 </li> 106</ul> 107So, a program using Boost.MultiIndex must include 108<a href="multi_index_container.html#synopsis"> 109<code>"boost/multi_index_container.hpp"</code></a>, 110the headers defining the index types to be used and possibly one or more key 111extraction headers for key-based indices. Note that all the key extractors 112provided by Boost.MultiIndex are automatically included with 113<a href="key_extraction.html#synopsis"> 114<code>"boost/multi_index/key_extractors.hpp"</code></a>. 115</p> 116 117<p> 118In order to use the serialization capabilities of Boost.MultiIndex, 119the appropriate Boost.Serialization library module must be linked. Other 120than that, Boost.MultiIndex is a header-only library, requiring no additional 121object modules. 122</p> 123 124<hr> 125 126<div class="prev_link"><a href="../tutorial/techniques.html"><img src="../prev.gif" alt="techniques" border="0"><br> 127Techniques 128</a></div> 129<div class="up_link"><a href="../index.html"><img src="../up.gif" alt="index" border="0"><br> 130Index 131</a></div> 132<div class="next_link"><a href="multi_index_container.html"><img src="../next.gif" alt="multi_index_container reference" border="0"><br> 133<code>multi_index_container</code> reference 134</a></div><br clear="all" style="clear: all;"> 135 136<br> 137 138<p>Revised November 24th 2015</p> 139 140<p>© Copyright 2003-2015 Joaquín M López Muñoz. 141Distributed under the Boost Software 142License, Version 1.0. (See accompanying file <a href="../../../../LICENSE_1_0.txt"> 143LICENSE_1_0.txt</a> or copy at <a href="http://www.boost.org/LICENSE_1_0.txt"> 144http://www.boost.org/LICENSE_1_0.txt</a>) 145</p> 146 147</body> 148</html> 149
