diff options
Diffstat (limited to 'doc/html/boost/interprocess/map_index.html')
| -rwxr-xr-x | doc/html/boost/interprocess/map_index.html | 86 |
1 files changed, 86 insertions, 0 deletions
diff --git a/doc/html/boost/interprocess/map_index.html b/doc/html/boost/interprocess/map_index.html new file mode 100755 index 0000000000..3bbeeec9c4 --- /dev/null +++ b/doc/html/boost/interprocess/map_index.html @@ -0,0 +1,86 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Class template 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.map_index_hpp" title="Header <boost/interprocess/indexes/map_index.hpp>"> +<link rel="prev" href="iunordered_set_index.html" title="Class template iunordered_set_index"> +<link rel="next" href="null_index.html" title="Class template null_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="iunordered_set_index.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_interprocess_reference.html#header.boost.interprocess.indexes.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="null_index.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.interprocess.map_index"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Class template map_index</span></h2> +<p>boost::interprocess::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: <<a class="link" href="../../boost_interprocess_reference.html#header.boost.interprocess.indexes.map_index_hpp" title="Header <boost/interprocess/indexes/map_index.hpp>">boost/interprocess/indexes/map_index.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> MapConfig<span class="special">></span> +<span class="keyword">class</span> <a class="link" href="map_index.html" title="Class template map_index">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">map</span><span class="special"><</span> <span class="identifier">MapConfig</span> <span class="special">></span> <span class="special">{</span> +<span class="keyword">public</span><span class="special">:</span> + <span class="comment">// <a class="link" href="map_index.html#boost.interprocess.map_indexconstruct-copy-destruct">construct/copy/destruct</a></span> + <a class="link" href="map_index.html#id984871-bb"><span class="identifier">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="map_index.html#id984837-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="map_index.html#id984840-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="map_index.html#id984859-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="id1778601"></a><h2>Description</h2> +<p>Index type based in boost::interprocess::map. Just derives from boost::interprocess::map and defines the interface needed by managed memory segments </p> +<div class="refsect2"> +<a name="id1778609"></a><h3> +<a name="boost.interprocess.map_indexconstruct-copy-destruct"></a><code class="computeroutput">map_index</code> + public + construct/copy/destruct</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> +<pre class="literallayout"><a name="id984871-bb"></a><span class="identifier">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="id1778674"></a><h3> +<a name="id984837-bb"></a><code class="computeroutput">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="id984840-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><span class="special">)</span><span class="special">;</span></pre> +<p>This reserves memory to optimize the insertion of n elements in the index </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="id984859-bb"></a><span class="identifier">shrink_to_fit</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<p>This tries to free previously allocate unused memory. </p> +</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 © 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="iunordered_set_index.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_interprocess_reference.html#header.boost.interprocess.indexes.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="null_index.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> |