doc/html/boost/interprocess/iunordered_set_index.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class template iunordered_set_index</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
<link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.indexes.iunordered_set_index_hpp" title="Header &lt;boost/interprocess/indexes/iunordered_set_index.hpp&gt;">
<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/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.indexes.iunordered_set_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="map_index.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<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="comment">// In header: &lt;<a class="link" href="../../interprocess/indexes_reference.html#header.boost.interprocess.indexes.iunordered_set_index_hpp" title="Header &lt;boost/interprocess/indexes/iunordered_set_index.hpp&gt;">boost/interprocess/indexes/iunordered_set_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="iunordered_set_index.html" title="Class template iunordered_set_index">iunordered_set_index</a> <span class="special">:</span> <span class="keyword">private</span> iunordered_set_index_aux::allocator_holder&lt; MapConfig &gt;,
                             <span class="keyword">public</span> iunordered_set_index_aux::index_t&lt; MapConfig &gt;
<span class="special">{</span>
<span class="keyword">public</span><span class="special">:</span>
  <span class="comment">// types</span>
  <span class="keyword">typedef</span> <span class="identifier">index_type</span><span class="special">::</span><span class="identifier">iterator</span>           <a name="boost.interprocess.iunordered_set_index.iterator"></a><span class="identifier">iterator</span><span class="special">;</span>          
  <span class="keyword">typedef</span> <span class="identifier">index_type</span><span class="special">::</span><span class="identifier">const_iterator</span>     <a name="boost.interprocess.iunordered_set_index.const_iterator"></a><span class="identifier">const_iterator</span><span class="special">;</span>    
  <span class="keyword">typedef</span> <span class="identifier">index_type</span><span class="special">::</span><span class="identifier">insert_commit_data</span> <a name="boost.interprocess.iunordered_set_index.insert_commit_data"></a><span class="identifier">insert_commit_data</span><span class="special">;</span>
  <span class="keyword">typedef</span> <span class="identifier">index_type</span><span class="special">::</span><span class="identifier">value_type</span>         <a name="boost.interprocess.iunordered_set_index.value_type"></a><span class="identifier">value_type</span><span class="special">;</span>        
  <span class="keyword">typedef</span> <span class="identifier">index_type</span><span class="special">::</span><span class="identifier">bucket_ptr</span>         <a name="boost.interprocess.iunordered_set_index.bucket_ptr"></a><span class="identifier">bucket_ptr</span><span class="special">;</span>        
  <span class="keyword">typedef</span> <span class="identifier">index_type</span><span class="special">::</span><span class="identifier">bucket_type</span>        <a name="boost.interprocess.iunordered_set_index.bucket_type"></a><span class="identifier">bucket_type</span><span class="special">;</span>       
  <span class="keyword">typedef</span> <span class="identifier">index_type</span><span class="special">::</span><span class="identifier">bucket_traits</span>      <a name="boost.interprocess.iunordered_set_index.bucket_traits"></a><span class="identifier">bucket_traits</span><span class="special">;</span>     
  <span class="keyword">typedef</span> <span class="identifier">index_type</span><span class="special">::</span><span class="identifier">size_type</span>          <a name="boost.interprocess.iunordered_set_index.size_type"></a><span class="identifier">size_type</span><span class="special">;</span>         

  <span class="comment">// <a class="link" href="iunordered_set_index.html#boost.interprocess.iunordered_set_indexconstruct-copy-destruct">construct/copy/destruct</a></span>
  <a class="link" href="iunordered_set_index.html#idm46037323531008-bb"><span class="identifier">iunordered_set_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>
  <a class="link" href="iunordered_set_index.html#idm46037323529280-bb"><span class="special">~</span><span class="identifier">iunordered_set_index</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>

  <span class="comment">// <a class="link" href="iunordered_set_index.html#idm46037323542896-bb">public member functions</a></span>
  <span class="keyword">void</span> <a class="link" href="iunordered_set_index.html#idm46037323542336-bb"><span class="identifier">reserve</span></a><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="iunordered_set_index.html#idm46037323540320-bb"><span class="identifier">shrink_to_fit</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  <span class="identifier">iterator</span> <a class="link" href="iunordered_set_index.html#idm46037323539024-bb"><span class="identifier">find</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">intrusive_compare_key_type</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  <span class="identifier">const_iterator</span> <a class="link" href="iunordered_set_index.html#idm46037323537472-bb"><span class="identifier">find</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">intrusive_compare_key_type</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special">&lt;</span> <span class="identifier">iterator</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">&gt;</span> 
  <a class="link" href="iunordered_set_index.html#idm46037323535648-bb"><span class="identifier">insert_check</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">intrusive_compare_key_type</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">insert_commit_data</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  <span class="identifier">iterator</span> <a class="link" href="iunordered_set_index.html#idm46037323533392-bb"><span class="identifier">insert_commit</span></a><span class="special">(</span><span class="identifier">value_type</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">insert_commit_data</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="idm45928018611008"></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">
<a name="idm45928018610176"></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="idm46037323531008-bb"></a><span class="identifier">iunordered_set_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> mngr<span class="special">)</span><span class="special">;</span></pre>
<p>Constructor. Takes a pointer to the segment manager. Can throw </p>
</li>
<li class="listitem"><pre class="literallayout"><a name="idm46037323529280-bb"></a><span class="special">~</span><span class="identifier">iunordered_set_index</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
</ol></div>
</div>
<div class="refsect2">
<a name="idm45928018598352"></a><h3>
<a name="idm46037323542896-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="keyword">void</span> <a name="idm46037323542336-bb"></a><span class="identifier">reserve</span><span class="special">(</span><span class="identifier">size_type</span> new_n<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="idm46037323540320-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 unused memory previously allocated. </p>
</li>
<li class="listitem"><pre class="literallayout"><span class="identifier">iterator</span> <a name="idm46037323539024-bb"></a><span class="identifier">find</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">intrusive_compare_key_type</span> <span class="special">&amp;</span> key<span class="special">)</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idm46037323537472-bb"></a><span class="identifier">find</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">intrusive_compare_key_type</span> <span class="special">&amp;</span> key<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special">&lt;</span> <span class="identifier">iterator</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">&gt;</span> 
<a name="idm46037323535648-bb"></a><span class="identifier">insert_check</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">intrusive_compare_key_type</span> <span class="special">&amp;</span> key<span class="special">,</span> 
             <span class="identifier">insert_commit_data</span> <span class="special">&amp;</span> commit_data<span class="special">)</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><span class="identifier">iterator</span> <a name="idm46037323533392-bb"></a><span class="identifier">insert_commit</span><span class="special">(</span><span class="identifier">value_type</span> <span class="special">&amp;</span> val<span class="special">,</span> <span class="identifier">insert_commit_data</span> <span class="special">&amp;</span> commit_data<span class="special">)</span><span class="special">;</span></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 &#169; 2005-2015 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/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.indexes.iunordered_set_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="map_index.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>