doc/html/boost/interprocess/iunordered_set_index.html

   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=US-ASCII">
   5 <title>Class template iunordered_set_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.iunordered_set_index_hpp" title="Header &lt;boost/interprocess/indexes/iunordered_set_index.hpp&gt;">
  10 <link rel="prev" href="iset_index.html" title="Class template iset_index">
  11 <link rel="next" href="map_index.html" title="Class template map_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="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>
  25 </div>
  26 <div class="refentry">
  27 <a name="boost.interprocess.iunordered_set_index"></a><div class="titlepage"></div>
  28 <div class="refnamediv">
  29 <h2><span class="refentrytitle">Class template iunordered_set_index</span></h2>
  30 <p>boost::interprocess::iunordered_set_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: &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;
  34
  35 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> MapConfig<span class="special">&gt;</span>
  36 <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;,
  37                              <span class="keyword">public</span> iunordered_set_index_aux::index_t&lt; MapConfig &gt;
  38 <span class="special">{</span>
  39 <span class="keyword">public</span><span class="special">:</span>
  40   <span class="comment">// types</span>
  41   <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>
  42   <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>
  43   <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>
  44   <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>
  45   <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>
  46   <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>
  47   <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>
  48   <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>
  49
  50   <span class="comment">// <a class="link" href="iunordered_set_index.html#boost.interprocess.iunordered_set_indexconstruct-copy-destruct">construct/copy/destruct</a></span>
  51   <a class="link" href="iunordered_set_index.html#idp43630864-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>
  52   <a class="link" href="iunordered_set_index.html#idp43632592-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>
  53
  54   <span class="comment">// <a class="link" href="iunordered_set_index.html#idp43618976-bb">public member functions</a></span>
  55   <span class="keyword">void</span> <a class="link" href="iunordered_set_index.html#idp43619536-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>
  56   <span class="keyword">void</span> <a class="link" href="iunordered_set_index.html#idp43621552-bb"><span class="identifier">shrink_to_fit</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  57   <span class="identifier">iterator</span> <a class="link" href="iunordered_set_index.html#idp43622848-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>
  58   <span class="identifier">const_iterator</span> <a class="link" href="iunordered_set_index.html#idp43624400-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>
  59   <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>
  60   <a class="link" href="iunordered_set_index.html#idp43626224-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>
  61   <span class="identifier">iterator</span> <a class="link" href="iunordered_set_index.html#idp43628480-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>
  62 <span class="special">}</span><span class="special">;</span></pre></div>
  63 <div class="refsect1">
  64 <a name="idp279541360"></a><h2>Description</h2>
  65 <p>Index type based in boost::intrusive::set. Just derives from boost::intrusive::set and defines the interface needed by managed memory segments </p>
  66 <div class="refsect2">
  67 <a name="idp279542192"></a><h3>
  68 <a name="boost.interprocess.iunordered_set_indexconstruct-copy-destruct"></a><code class="computeroutput">iunordered_set_index</code>
  69         public
  70        construct/copy/destruct</h3>
  71 <div class="orderedlist"><ol class="orderedlist" type="1">
  72 <li class="listitem">
  73 <pre class="literallayout"><a name="idp43630864-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>
  74 <p>Constructor. Takes a pointer to the segment manager. Can throw </p>
  75 </li>
  76 <li class="listitem"><pre class="literallayout"><a name="idp43632592-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>
  77 </ol></div>
  78 </div>
  79 <div class="refsect2">
  80 <a name="idp279554080"></a><h3>
  81 <a name="idp43618976-bb"></a><code class="computeroutput">iunordered_set_index</code> public member functions</h3>
  82 <div class="orderedlist"><ol class="orderedlist" type="1">
  83 <li class="listitem">
  84 <pre class="literallayout"><span class="keyword">void</span> <a name="idp43619536-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>
  85 <p>This reserves memory to optimize the insertion of n elements in the index </p>
  86 </li>
  87 <li class="listitem">
  88 <pre class="literallayout"><span class="keyword">void</span> <a name="idp43621552-bb"></a><span class="identifier">shrink_to_fit</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
  89 <p>This tries to free unused memory previously allocated. </p>
  90 </li>
  91 <li class="listitem"><pre class="literallayout"><span class="identifier">iterator</span> <a name="idp43622848-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>
  92 <li class="listitem"><pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idp43624400-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>
  93 <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>
  94 <a name="idp43626224-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>
  95              <span class="identifier">insert_commit_data</span> <span class="special">&amp;</span> commit_data<span class="special">)</span><span class="special">;</span></pre></li>
  96 <li class="listitem"><pre class="literallayout"><span class="identifier">iterator</span> <a name="idp43628480-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>
  97 </ol></div>
  98 </div>
  99 </div>
 100 </div>
 101 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 102 <td align="left"></td>
 103 <td align="right"><div class="copyright-footer">Copyright &#169; 2005-2015 Ion Gaztanaga<p>
 104         Distributed under the Boost Software License, Version 1.0. (See accompanying
 105         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>)
 106       </p>
 107 </div></td>
 108 </tr></table>
 109 <hr>
 110 <div class="spirit-nav">
 111 <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>
 112 </div>
 113 </body>
 114 </html>