1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<html> 3<head> 4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 5<title>Class template flat_map_index</title> 6<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> 7<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 8<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> 9<link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.indexes.flat_map_index_hpp" title="Header <boost/interprocess/indexes/flat_map_index.hpp>"> 10<link rel="prev" href="file_mapping.html" title="Class file_mapping"> 11<link rel="next" href="iset_index.html" title="Class template iset_index"> 12</head> 13<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 14<table cellpadding="2" width="100%"><tr> 15<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> 16<td align="center"><a href="../../../../index.html">Home</a></td> 17<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> 18<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 19<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 20<td align="center"><a href="../../../../more/index.htm">More</a></td> 21</tr></table> 22<hr> 23<div class="spirit-nav"> 24<a accesskey="p" href="file_mapping.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.indexes.flat_map_index_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="iset_index.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 25</div> 26<div class="refentry"> 27<a name="boost.interprocess.flat_map_index"></a><div class="titlepage"></div> 28<div class="refnamediv"> 29<h2><span class="refentrytitle">Class template flat_map_index</span></h2> 30<p>boost::interprocess::flat_map_index</p> 31</div> 32<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> 33<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../interprocess/indexes_reference.html#header.boost.interprocess.indexes.flat_map_index_hpp" title="Header <boost/interprocess/indexes/flat_map_index.hpp>">boost/interprocess/indexes/flat_map_index.hpp</a>> 34 35</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> MapConfig<span class="special">></span> 36<span class="keyword">class</span> <a class="link" href="flat_map_index.html" title="Class template flat_map_index">flat_map_index</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">flat_map_index_aux</span><span class="special">::</span><span class="identifier">index_t</span><span class="special"><</span> <span class="identifier">MapConfig</span> <span class="special">></span> <span class="special">{</span> 37<span class="keyword">public</span><span class="special">:</span> 38 <span class="comment">// <a class="link" href="flat_map_index.html#boost.interprocess.flat_map_indexconstruct-copy-destruct">construct/copy/destruct</a></span> 39 <a class="link" href="flat_map_index.html#idm45304012014464-bb"><span class="identifier">flat_map_index</span></a><span class="special">(</span><a class="link" href="segment_manager_base.html" title="Class template segment_manager_base">segment_manager_base</a> <span class="special">*</span><span class="special">)</span><span class="special">;</span> 40 41 <span class="comment">// <a class="link" href="flat_map_index.html#idm45304012018256-bb">public member functions</a></span> 42 <span class="keyword">void</span> <a class="link" href="flat_map_index.html#idm45304012017696-bb"><span class="identifier">reserve</span></a><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">segment_manager_base</span><span class="special">::</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> 43 <span class="keyword">void</span> <a class="link" href="flat_map_index.html#idm45304012015776-bb"><span class="identifier">shrink_to_fit</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 44<span class="special">}</span><span class="special">;</span></pre></div> 45<div class="refsect1"> 46<a name="id-1.3.19.17.3.27.4.4"></a><h2>Description</h2> 47<p>Index type based in flat_map. Just derives from flat_map and defines the interface needed by managed memory segments. </p> 48<div class="refsect2"> 49<a name="id-1.3.19.17.3.27.4.4.3"></a><h3> 50<a name="boost.interprocess.flat_map_indexconstruct-copy-destruct"></a><code class="computeroutput">flat_map_index</code> 51 public 52 construct/copy/destruct</h3> 53<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> 54<pre class="literallayout"><a name="idm45304012014464-bb"></a><span class="identifier">flat_map_index</span><span class="special">(</span><a class="link" href="segment_manager_base.html" title="Class template segment_manager_base">segment_manager_base</a> <span class="special">*</span> segment_mngr<span class="special">)</span><span class="special">;</span></pre>Constructor. Takes a pointer to the segment manager. Can throw. </li></ol></div> 55</div> 56<div class="refsect2"> 57<a name="id-1.3.19.17.3.27.4.4.4"></a><h3> 58<a name="idm45304012018256-bb"></a><code class="computeroutput">flat_map_index</code> public member functions</h3> 59<div class="orderedlist"><ol class="orderedlist" type="1"> 60<li class="listitem"> 61<pre class="literallayout"><span class="keyword">void</span> <a name="idm45304012017696-bb"></a><span class="identifier">reserve</span><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">segment_manager_base</span><span class="special">::</span><span class="identifier">size_type</span> n<span class="special">)</span><span class="special">;</span></pre>This reserves memory to optimize the insertion of n elements in the index. </li> 62<li class="listitem"> 63<pre class="literallayout"><span class="keyword">void</span> <a name="idm45304012015776-bb"></a><span class="identifier">shrink_to_fit</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>This frees all unnecessary memory. </li> 64</ol></div> 65</div> 66</div> 67</div> 68<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 69<td align="left"></td> 70<td align="right"><div class="copyright-footer">Copyright © 2005-2015 Ion Gaztanaga<p> 71 Distributed under the Boost Software License, Version 1.0. (See accompanying 72 file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) 73 </p> 74</div></td> 75</tr></table> 76<hr> 77<div class="spirit-nav"> 78<a accesskey="p" href="file_mapping.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.indexes.flat_map_index_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="iset_index.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 79</div> 80</body> 81</html> 82
