doc/html/boost/interprocess/rbtree_best_fit.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 rbtree_best_fit</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.mem_algo.rbtree_best_fit_hpp" title="Header &lt;boost/interprocess/mem_algo/rbtree_best_fit.hpp&gt;">
  10 <link rel="prev" href="mapped_region/advice_types.html" title="Type advice_types">
  11 <link rel="next" href="simple_seq_fit.html" title="Class template simple_seq_fit">
  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="mapped_region/advice_types.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.mem_algo.rbtree_best_fit_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="simple_seq_fit.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  25 </div>
  26 <div class="refentry">
  27 <a name="boost.interprocess.rbtree_best_fit"></a><div class="titlepage"></div>
  28 <div class="refnamediv">
  29 <h2><span class="refentrytitle">Class template rbtree_best_fit</span></h2>
  30 <p>boost::interprocess::rbtree_best_fit</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.mem_algo.rbtree_best_fit_hpp" title="Header &lt;boost/interprocess/mem_algo/rbtree_best_fit.hpp&gt;">boost/interprocess/mem_algo/rbtree_best_fit.hpp</a>&gt;
  34
  35 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> MutexFamily<span class="special">,</span> <span class="keyword">typename</span> VoidPointer<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> MemAlignment<span class="special">&gt;</span>
  36 <span class="keyword">class</span> <a class="link" href="rbtree_best_fit.html" title="Class template rbtree_best_fit">rbtree_best_fit</a> <span class="special">{</span>
  37 <span class="keyword">public</span><span class="special">:</span>
  38   <span class="comment">// types</span>
  39   <span class="keyword">typedef</span> <span class="identifier">MutexFamily</span>                                                   <a name="boost.interprocess.rbtree_best_fit.mutex_family"></a><span class="identifier">mutex_family</span><span class="special">;</span>           <span class="comment">// Shared mutex family used for the rest of the Interprocess framework. </span>
  40   <span class="keyword">typedef</span> <span class="identifier">VoidPointer</span>                                                   <a name="boost.interprocess.rbtree_best_fit.void_pointer"></a><span class="identifier">void_pointer</span><span class="special">;</span>           <span class="comment">// Pointer type to be used with the rest of the Interprocess framework. </span>
  41   <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span>                                                   <a name="boost.interprocess.rbtree_best_fit.multiallocation_chain"></a><span class="identifier">multiallocation_chain</span><span class="special">;</span>
  42   <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">intrusive</span><span class="special">::</span><span class="identifier">pointer_traits</span><span class="special">&lt;</span> <span class="identifier">char_ptr</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">difference_type</span> <a name="boost.interprocess.rbtree_best_fit.difference_type"></a><span class="identifier">difference_type</span><span class="special">;</span>
  43   <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">container</span><span class="special">::</span><span class="identifier">dtl</span><span class="special">::</span><span class="identifier">make_unsigned</span><span class="special">&lt;</span> <span class="identifier">difference_type</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> <a name="boost.interprocess.rbtree_best_fit.size_type"></a><span class="identifier">size_type</span><span class="special">;</span>
  44
  45   <span class="comment">// <a class="link" href="rbtree_best_fit.html#boost.interprocess.rbtree_best_fitconstruct-copy-destruct">construct/copy/destruct</a></span>
  46   <a class="link" href="rbtree_best_fit.html#idm45336641657680-bb"><span class="identifier">rbtree_best_fit</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span>
  47   <a class="link" href="rbtree_best_fit.html#idm45336641655408-bb"><span class="special">~</span><span class="identifier">rbtree_best_fit</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  48
  49   <span class="comment">// <a class="link" href="rbtree_best_fit.html#idm45336641685968-bb">public member functions</a></span>
  50   <span class="keyword">void</span> <span class="special">*</span> <a class="link" href="rbtree_best_fit.html#idm45336641685408-bb"><span class="identifier">allocate</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span>
  51   <span class="keyword">void</span> <a class="link" href="rbtree_best_fit.html#idm45336641683536-bb"><span class="identifier">deallocate</span></a><span class="special">(</span><span class="keyword">void</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span>
  52   <span class="identifier">size_type</span> <a class="link" href="rbtree_best_fit.html#idm45336641681680-bb"><span class="identifier">get_size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  53   <span class="identifier">size_type</span> <a class="link" href="rbtree_best_fit.html#idm45336641680240-bb"><span class="identifier">get_free_memory</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  54   <span class="keyword">void</span> <a class="link" href="rbtree_best_fit.html#idm45336641678800-bb"><span class="identifier">zero_free_memory</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  55   <span class="keyword">void</span> <a class="link" href="rbtree_best_fit.html#idm45336641677440-bb"><span class="identifier">grow</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="rbtree_best_fit.html#idm45336641675456-bb"><span class="identifier">shrink_to_fit</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  57   <span class="keyword">bool</span> <a class="link" href="rbtree_best_fit.html#idm45336641674288-bb"><span class="identifier">all_memory_deallocated</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  58   <span class="keyword">bool</span> <a class="link" href="rbtree_best_fit.html#idm45336641673104-bb"><span class="identifier">check_sanity</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  59   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span>
  60     <span class="identifier">T</span> <span class="special">*</span> <a class="link" href="rbtree_best_fit.html#idm45336641671792-bb"><span class="identifier">allocation_command</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">interprocess</span><span class="special">::</span><span class="identifier">allocation_type</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">,</span>
  61                            <span class="identifier">size_type</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">T</span> <span class="special">*</span><span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  62   <span class="keyword">void</span> <span class="special">*</span> <a class="link" href="rbtree_best_fit.html#idm45336641667312-bb"><span class="identifier">raw_allocation_command</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">interprocess</span><span class="special">::</span><span class="identifier">allocation_type</span><span class="special">,</span>
  63                                 <span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">size_type</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">void</span> <span class="special">*</span><span class="special">&amp;</span><span class="special">,</span>
  64                                 <span class="identifier">size_type</span> <span class="special">=</span> <span class="number">1</span><span class="special">)</span><span class="special">;</span>
  65   <span class="identifier">size_type</span> <a class="link" href="rbtree_best_fit.html#idm45336641662704-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  66   <span class="keyword">void</span> <span class="special">*</span> <a class="link" href="rbtree_best_fit.html#idm45336641660560-bb"><span class="identifier">allocate_aligned</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span>
  67
  68   <span class="comment">// <a class="link" href="rbtree_best_fit.html#idm45336641654832-bb">public static functions</a></span>
  69   <span class="keyword">static</span> <span class="identifier">size_type</span> <a class="link" href="rbtree_best_fit.html#idm45336641654272-bb"><span class="identifier">get_min_size</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span>
  70
  71   <span class="comment">// public data members</span>
  72   <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">size_type</span> <span class="identifier">PayloadPerAllocation</span><span class="special">;</span>
  73 <span class="special">}</span><span class="special">;</span></pre></div>
  74 <div class="refsect1">
  75 <a name="id-1.3.19.17.3.42.4.4"></a><h2>Description</h2>
  76 <p>This class implements an algorithm that stores the free nodes in a red-black tree to have logarithmic search/insert times. </p>
  77 <div class="refsect2">
  78 <a name="id-1.3.19.17.3.42.4.4.3"></a><h3>
  79 <a name="boost.interprocess.rbtree_best_fitconstruct-copy-destruct"></a><code class="computeroutput">rbtree_best_fit</code>
  80         public
  81        construct/copy/destruct</h3>
  82 <div class="orderedlist"><ol class="orderedlist" type="1">
  83 <li class="listitem">
  84 <pre class="literallayout"><a name="idm45336641657680-bb"></a><span class="identifier">rbtree_best_fit</span><span class="special">(</span><span class="identifier">size_type</span> size<span class="special">,</span> <span class="identifier">size_type</span> extra_hdr_bytes<span class="special">)</span><span class="special">;</span></pre>
  85 <p>Constructor. "size" is the total size of the managed memory segment, "extra_hdr_bytes" indicates the extra bytes beginning in the sizeof(rbtree_best_fit) offset that the allocator should not use at all. </p>
  86 </li>
  87 <li class="listitem">
  88 <pre class="literallayout"><a name="idm45336641655408-bb"></a><span class="special">~</span><span class="identifier">rbtree_best_fit</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Destructor. </li>
  89 </ol></div>
  90 </div>
  91 <div class="refsect2">
  92 <a name="id-1.3.19.17.3.42.4.4.4"></a><h3>
  93 <a name="idm45336641685968-bb"></a><code class="computeroutput">rbtree_best_fit</code> public member functions</h3>
  94 <div class="orderedlist"><ol class="orderedlist" type="1">
  95 <li class="listitem">
  96 <pre class="literallayout"><span class="keyword">void</span> <span class="special">*</span> <a name="idm45336641685408-bb"></a><span class="identifier">allocate</span><span class="special">(</span><span class="identifier">size_type</span> nbytes<span class="special">)</span><span class="special">;</span></pre>Allocates bytes, returns 0 if there is not more memory. </li>
  97 <li class="listitem">
  98 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45336641683536-bb"></a><span class="identifier">deallocate</span><span class="special">(</span><span class="keyword">void</span> <span class="special">*</span> addr<span class="special">)</span><span class="special">;</span></pre>Deallocates previously allocated bytes. </li>
  99 <li class="listitem">
 100 <pre class="literallayout"><span class="identifier">size_type</span> <a name="idm45336641681680-bb"></a><span class="identifier">get_size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the size of the memory segment. </li>
 101 <li class="listitem">
 102 <pre class="literallayout"><span class="identifier">size_type</span> <a name="idm45336641680240-bb"></a><span class="identifier">get_free_memory</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the number of free bytes of the segment. </li>
 103 <li class="listitem">
 104 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45336641678800-bb"></a><span class="identifier">zero_free_memory</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 105 <p>Initializes to zero all the memory that's not in use. This function is normally used for security reasons. </p>
 106 </li>
 107 <li class="listitem">
 108 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45336641677440-bb"></a><span class="identifier">grow</span><span class="special">(</span><span class="identifier">size_type</span> extra_size<span class="special">)</span><span class="special">;</span></pre>
 109 <p>Increases managed memory in extra_size bytes more </p>
 110 </li>
 111 <li class="listitem">
 112 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45336641675456-bb"></a><span class="identifier">shrink_to_fit</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Decreases managed memory as much as possible. </li>
 113 <li class="listitem">
 114 <pre class="literallayout"><span class="keyword">bool</span> <a name="idm45336641674288-bb"></a><span class="identifier">all_memory_deallocated</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Returns true if all allocated memory has been deallocated. </li>
 115 <li class="listitem">
 116 <pre class="literallayout"><span class="keyword">bool</span> <a name="idm45336641673104-bb"></a><span class="identifier">check_sanity</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 117 <p>Makes an internal sanity check and returns true if success </p>
 118 </li>
 119 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span>
 120   <span class="identifier">T</span> <span class="special">*</span> <a name="idm45336641671792-bb"></a><span class="identifier">allocation_command</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">interprocess</span><span class="special">::</span><span class="identifier">allocation_type</span> command<span class="special">,</span>
 121                          <span class="identifier">size_type</span> limit_size<span class="special">,</span>
 122                          <span class="identifier">size_type</span> <span class="special">&amp;</span> prefer_in_recvd_out_size<span class="special">,</span> <span class="identifier">T</span> <span class="special">*</span><span class="special">&amp;</span> reuse<span class="special">)</span><span class="special">;</span></pre></li>
 123 <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <span class="special">*</span> <a name="idm45336641667312-bb"></a><span class="identifier">raw_allocation_command</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">interprocess</span><span class="special">::</span><span class="identifier">allocation_type</span> command<span class="special">,</span>
 124                               <span class="identifier">size_type</span> limit_object<span class="special">,</span>
 125                               <span class="identifier">size_type</span> <span class="special">&amp;</span> prefer_in_recvd_out_size<span class="special">,</span>
 126                               <span class="keyword">void</span> <span class="special">*</span><span class="special">&amp;</span> reuse_ptr<span class="special">,</span> <span class="identifier">size_type</span> sizeof_object <span class="special">=</span> <span class="number">1</span><span class="special">)</span><span class="special">;</span></pre></li>
 127 <li class="listitem">
 128 <pre class="literallayout"><span class="identifier">size_type</span> <a name="idm45336641662704-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> ptr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the size of the buffer previously allocated pointed by ptr. </li>
 129 <li class="listitem">
 130 <pre class="literallayout"><span class="keyword">void</span> <span class="special">*</span> <a name="idm45336641660560-bb"></a><span class="identifier">allocate_aligned</span><span class="special">(</span><span class="identifier">size_type</span> nbytes<span class="special">,</span> <span class="identifier">size_type</span> alignment<span class="special">)</span><span class="special">;</span></pre>
 131 <p>Allocates aligned bytes, returns 0 if there is not more memory. Alignment must be power of 2 </p>
 132 </li>
 133 </ol></div>
 134 </div>
 135 <div class="refsect2">
 136 <a name="id-1.3.19.17.3.42.4.4.5"></a><h3>
 137 <a name="idm45336641654832-bb"></a><code class="computeroutput">rbtree_best_fit</code> public static functions</h3>
 138 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
 139 <pre class="literallayout"><span class="keyword">static</span> <span class="identifier">size_type</span> <a name="idm45336641654272-bb"></a><span class="identifier">get_min_size</span><span class="special">(</span><span class="identifier">size_type</span> extra_hdr_bytes<span class="special">)</span><span class="special">;</span></pre>Obtains the minimum size needed by the algorithm. </li></ol></div>
 140 </div>
 141 </div>
 142 </div>
 143 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 144 <td align="left"></td>
 145 <td align="right"><div class="copyright-footer">Copyright &#169; 2005-2015 Ion Gaztanaga<p>
 146         Distributed under the Boost Software License, Version 1.0. (See accompanying
 147         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>)
 148       </p>
 149 </div></td>
 150 </tr></table>
 151 <hr>
 152 <div class="spirit-nav">
 153 <a accesskey="p" href="mapped_region/advice_types.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.mem_algo.rbtree_best_fit_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="simple_seq_fit.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 154 </div>
 155 </body>
 156 </html>