<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class template iunordered_set_index</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<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.iunordered_set_index_hpp" title="Header <boost/interprocess/indexes/iunordered_set_index.hpp>">
<link rel="prev" href="iset_index.html" title="Class template iset_index">
<link rel="next" href="map_index.html" title="Class template map_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="iset_index.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_interprocess_reference.html#header.boost.interprocess.indexes.iunordered_set_index_hpp"><img src="../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="map_index.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="refentry" title="Class template iunordered_set_index">
<a name="boost.interprocess.iunordered_set_index"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template iunordered_set_index</span></h2>
<p>boost::interprocess::iunordered_set_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="emphasis"><em>// In header: <<a class="link" href="../../boost_interprocess_reference.html#header.boost.interprocess.indexes.iunordered_set_index_hpp" title="Header <boost/interprocess/indexes/iunordered_set_index.hpp>">boost/interprocess/indexes/iunordered_set_index.hpp</a>>
</em></span><span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> MapConfig>
<span class="bold"><strong>class</strong></span> <a class="link" href="iunordered_set_index.html" title="Class template iunordered_set_index">iunordered_set_index</a> {
<span class="bold"><strong>public</strong></span>:
<span class="emphasis"><em>// types</em></span>
<span class="bold"><strong>typedef</strong></span> index_type::iterator <a name="boost.interprocess.iunordered_set_index.iterator"></a>iterator;
<span class="bold"><strong>typedef</strong></span> index_type::const_iterator <a name="boost.interprocess.iunordered_set_index.const_iterator"></a>const_iterator;
<span class="bold"><strong>typedef</strong></span> index_type::insert_commit_data <a name="boost.interprocess.iunordered_set_index.insert_commit_data"></a>insert_commit_data;
<span class="bold"><strong>typedef</strong></span> index_type::value_type <a name="boost.interprocess.iunordered_set_index.value_type"></a>value_type;
<span class="bold"><strong>typedef</strong></span> index_type::bucket_ptr <a name="boost.interprocess.iunordered_set_index.bucket_ptr"></a>bucket_ptr;
<span class="bold"><strong>typedef</strong></span> index_type::bucket_type <a name="boost.interprocess.iunordered_set_index.bucket_type"></a>bucket_type;
<span class="bold"><strong>typedef</strong></span> index_type::bucket_traits <a name="boost.interprocess.iunordered_set_index.bucket_traits"></a>bucket_traits;
<span class="bold"><strong>typedef</strong></span> index_type::size_type <a name="boost.interprocess.iunordered_set_index.size_type"></a>size_type;
<span class="emphasis"><em>// <a class="link" href="iunordered_set_index.html#boost.interprocess.iunordered_set_indexconstruct-copy-destruct">construct/copy/destruct</a></em></span>
<a class="link" href="iunordered_set_index.html#id810598-bb">iunordered_set_index</a>(<a class="link" href="segment_manager_base.html" title="Class template segment_manager_base">segment_manager_base</a> *);
<a class="link" href="iunordered_set_index.html#id810612-bb">~iunordered_set_index</a>();
<span class="emphasis"><em>// <a class="link" href="iunordered_set_index.html#id810498-bb">public member functions</a></em></span>
<span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="iunordered_set_index.html#id810502-bb">reserve</a>(std::size_t) ;
<span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="iunordered_set_index.html#id810520-bb">shrink_to_fit</a>() ;
<span class="type">iterator</span> <a class="link" href="iunordered_set_index.html#id810532-bb">find</a>(<span class="bold"><strong>const</strong></span> intrusive_compare_key_type &) ;
<span class="type">const_iterator</span> <a class="link" href="iunordered_set_index.html#id810545-bb">find</a>(<span class="bold"><strong>const</strong></span> intrusive_compare_key_type &) <span class="bold"><strong>const</strong></span>;
<span class="type">std::pair< iterator, <span class="bold"><strong>bool</strong></span> ></span>
<a class="link" href="iunordered_set_index.html#id810559-bb">insert_check</a>(<span class="bold"><strong>const</strong></span> intrusive_compare_key_type &, insert_commit_data &) ;
<span class="type">iterator</span> <a class="link" href="iunordered_set_index.html#id810579-bb">insert_commit</a>(value_type &, insert_commit_data &) ;
};</pre></div>
<div class="refsect1" title="Description">
<a name="id1021954"></a><h2>Description</h2>
<p>Index type based in boost::intrusive::set. Just derives from boost::intrusive::set and defines the interface needed by managed memory segments </p>
<div class="refsect2" title="iunordered_set_index public construct/copy/destruct">
<a name="id1021962"></a><h3>
<a name="boost.interprocess.iunordered_set_indexconstruct-copy-destruct"></a><code class="computeroutput">iunordered_set_index</code>
public
construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><a name="id810598-bb"></a>iunordered_set_index(<a class="link" href="segment_manager_base.html" title="Class template segment_manager_base">segment_manager_base</a> * mngr);</pre>
<p>Constructor. Takes a pointer to the segment manager. Can throw </p>
</li>
<li class="listitem"><pre class="literallayout"><a name="id810612-bb"></a>~iunordered_set_index();</pre></li>
</ol></div>
</div>
<div class="refsect2" title="iunordered_set_index public member functions">
<a name="id1022020"></a><h3>
<a name="id810498-bb"></a><code class="computeroutput">iunordered_set_index</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id810502-bb"></a>reserve(std::size_t new_n) ;</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="type"><span class="bold"><strong>void</strong></span></span> <a name="id810520-bb"></a>shrink_to_fit() ;</pre>
<p>This tries to free unused memory previously allocated. </p>
</li>
<li class="listitem"><pre class="literallayout"><span class="type">iterator</span> <a name="id810532-bb"></a>find(<span class="bold"><strong>const</strong></span> intrusive_compare_key_type & key) ;</pre></li>
<li class="listitem"><pre class="literallayout"><span class="type">const_iterator</span> <a name="id810545-bb"></a>find(<span class="bold"><strong>const</strong></span> intrusive_compare_key_type & key) <span class="bold"><strong>const</strong></span>;</pre></li>
<li class="listitem"><pre class="literallayout"><span class="type">std::pair< iterator, <span class="bold"><strong>bool</strong></span> ></span>
<a name="id810559-bb"></a>insert_check(<span class="bold"><strong>const</strong></span> intrusive_compare_key_type & key,
insert_commit_data & commit_data) ;</pre></li>
<li class="listitem"><pre class="literallayout"><span class="type">iterator</span> <a name="id810579-bb"></a>insert_commit(value_type & val, insert_commit_data & commit_data) ;</pre></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 - 2008 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="iset_index.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_interprocess_reference.html#header.boost.interprocess.indexes.iunordered_set_index_hpp"><img src="../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="map_index.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>
