summaryrefslogtreecommitdiff
path: root/doc/html/boost/interprocess/flat_map_index.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/html/boost/interprocess/flat_map_index.html')
-rwxr-xr-xdoc/html/boost/interprocess/flat_map_index.html82
1 files changed, 82 insertions, 0 deletions
diff --git a/doc/html/boost/interprocess/flat_map_index.html b/doc/html/boost/interprocess/flat_map_index.html
new file mode 100755
index 0000000000..9e5c9951e3
--- /dev/null
+++ b/doc/html/boost/interprocess/flat_map_index.html
@@ -0,0 +1,82 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Class template flat_map_index</title>
+<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
+<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
+<link rel="up" href="../../boost_interprocess_reference.html#header.boost.interprocess.indexes.flat_map_index_hpp" title="Header &lt;boost/interprocess/indexes/flat_map_index.hpp&gt;">
+<link rel="prev" href="flat_map_index_aux.html" title="Struct template flat_map_index_aux">
+<link rel="next" href="iset_index.html" title="Class template iset_index">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
+<td align="center"><a href="../../../../index.html">Home</a></td>
+<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
+<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
+<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
+<td align="center"><a href="../../../../more/index.htm">More</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="flat_map_index_aux.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_interprocess_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>
+</div>
+<div class="refentry">
+<a name="boost.interprocess.flat_map_index"></a><div class="titlepage"></div>
+<div class="refnamediv">
+<h2><span class="refentrytitle">Class template flat_map_index</span></h2>
+<p>boost::interprocess::flat_map_index</p>
+</div>
+<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
+<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../boost_interprocess_reference.html#header.boost.interprocess.indexes.flat_map_index_hpp" title="Header &lt;boost/interprocess/indexes/flat_map_index.hpp&gt;">boost/interprocess/indexes/flat_map_index.hpp</a>&gt;
+
+</span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> MapConfig<span class="special">&gt;</span>
+<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">boost</span><span class="special">::</span><span class="identifier">container</span><span class="special">::</span><span class="identifier">flat_map</span><span class="special">&lt;</span> <span class="identifier">MapConfig</span> <span class="special">&gt;</span> <span class="special">{</span>
+<span class="keyword">public</span><span class="special">:</span>
+ <span class="comment">// <a class="link" href="flat_map_index.html#boost.interprocess.flat_map_indexconstruct-copy-destruct">construct/copy/destruct</a></span>
+ <a class="link" href="flat_map_index.html#id984450-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>
+
+ <span class="comment">// <a class="link" href="flat_map_index.html#id984419-bb">public member functions</a></span>
+ <span class="keyword">void</span> <a class="link" href="flat_map_index.html#id984422-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>
+ <span class="keyword">void</span> <a class="link" href="flat_map_index.html#id984440-bb"><span class="identifier">shrink_to_fit</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
+<span class="special">}</span><span class="special">;</span></pre></div>
+<div class="refsect1">
+<a name="id1775530"></a><h2>Description</h2>
+<p>Index type based in flat_map. Just derives from flat_map and defines the interface needed by managed memory segments. </p>
+<div class="refsect2">
+<a name="id1775537"></a><h3>
+<a name="boost.interprocess.flat_map_indexconstruct-copy-destruct"></a><code class="computeroutput">flat_map_index</code>
+ public
+ construct/copy/destruct</h3>
+<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
+<pre class="literallayout"><a name="id984450-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>
+<p>Constructor. Takes a pointer to the segment manager. Can throw </p>
+</li></ol></div>
+</div>
+<div class="refsect2">
+<a name="id1775602"></a><h3>
+<a name="id984419-bb"></a><code class="computeroutput">flat_map_index</code> public member functions</h3>
+<div class="orderedlist"><ol class="orderedlist" type="1">
+<li class="listitem">
+<pre class="literallayout"><span class="keyword">void</span> <a name="id984422-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>
+<li class="listitem">
+<pre class="literallayout"><span class="keyword">void</span> <a name="id984440-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>
+</ol></div>
+</div>
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright &#169; 2005-2011 Ion Gaztanaga<p>
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ 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>)
+ </p>
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="flat_map_index_aux.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_interprocess_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>
+</div>
+</body>
+</html>