diff options
Diffstat (limited to 'doc/html/boost/interprocess/rbtree_best_fit.html')
| -rw-r--r-- | doc/html/boost/interprocess/rbtree_best_fit.html | 80 |
1 files changed, 40 insertions, 40 deletions
diff --git a/doc/html/boost/interprocess/rbtree_best_fit.html b/doc/html/boost/interprocess/rbtree_best_fit.html index aa359f6417..ea09b33da6 100644 --- a/doc/html/boost/interprocess/rbtree_best_fit.html +++ b/doc/html/boost/interprocess/rbtree_best_fit.html @@ -43,100 +43,100 @@ <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="boost.interprocess.rbtree_best_fit.size_type"></a><span class="identifier">size_type</span><span class="special">;</span> <span class="comment">// <a class="link" href="rbtree_best_fit.html#boost.interprocess.rbtree_best_fitconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="rbtree_best_fit.html#idp62954576-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> - <a class="link" href="rbtree_best_fit.html#idp62956848-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> + <a class="link" href="rbtree_best_fit.html#idp55839168-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> + <a class="link" href="rbtree_best_fit.html#idp55841440-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> - <span class="comment">// <a class="link" href="rbtree_best_fit.html#idp62926288-bb">public member functions</a></span> - <span class="keyword">void</span> <span class="special">*</span> <a class="link" href="rbtree_best_fit.html#idp62926848-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> - <span class="keyword">void</span> <a class="link" href="rbtree_best_fit.html#idp62928720-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> - <span class="identifier">size_type</span> <a class="link" href="rbtree_best_fit.html#idp62930576-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> - <span class="identifier">size_type</span> <a class="link" href="rbtree_best_fit.html#idp62932016-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> - <span class="keyword">void</span> <a class="link" href="rbtree_best_fit.html#idp62933456-bb"><span class="identifier">zero_free_memory</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="rbtree_best_fit.html#idp62934816-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> - <span class="keyword">void</span> <a class="link" href="rbtree_best_fit.html#idp62936800-bb"><span class="identifier">shrink_to_fit</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="rbtree_best_fit.html#idp62937968-bb"><span class="identifier">all_memory_deallocated</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="rbtree_best_fit.html#idp62939152-bb"><span class="identifier">check_sanity</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="rbtree_best_fit.html#idp55810880-bb">public member functions</a></span> + <span class="keyword">void</span> <span class="special">*</span> <a class="link" href="rbtree_best_fit.html#idp55811440-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> + <span class="keyword">void</span> <a class="link" href="rbtree_best_fit.html#idp55813312-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> + <span class="identifier">size_type</span> <a class="link" href="rbtree_best_fit.html#idp55815168-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> + <span class="identifier">size_type</span> <a class="link" href="rbtree_best_fit.html#idp55816608-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> + <span class="keyword">void</span> <a class="link" href="rbtree_best_fit.html#idp55818048-bb"><span class="identifier">zero_free_memory</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="rbtree_best_fit.html#idp55819408-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> + <span class="keyword">void</span> <a class="link" href="rbtree_best_fit.html#idp55821392-bb"><span class="identifier">shrink_to_fit</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="rbtree_best_fit.html#idp55822560-bb"><span class="identifier">all_memory_deallocated</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="rbtree_best_fit.html#idp55823744-bb"><span class="identifier">check_sanity</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> - <span class="identifier">T</span> <span class="special">*</span> <a class="link" href="rbtree_best_fit.html#idp62940464-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> + <span class="identifier">T</span> <span class="special">*</span> <a class="link" href="rbtree_best_fit.html#idp55825056-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> <span class="identifier">size_type</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">T</span> <span class="special">*</span><span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <span class="special">*</span> <a class="link" href="rbtree_best_fit.html#idp62944944-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> + <span class="keyword">void</span> <span class="special">*</span> <a class="link" href="rbtree_best_fit.html#idp55829536-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> <span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">size_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">void</span> <span class="special">*</span><span class="special">&</span><span class="special">,</span> <span class="identifier">size_type</span> <span class="special">=</span> <span class="number">1</span><span class="special">)</span><span class="special">;</span> - <span class="identifier">size_type</span> <a class="link" href="rbtree_best_fit.html#idp62949552-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> - <span class="keyword">void</span> <span class="special">*</span> <a class="link" href="rbtree_best_fit.html#idp62951696-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> + <span class="identifier">size_type</span> <a class="link" href="rbtree_best_fit.html#idp55834144-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> + <span class="keyword">void</span> <span class="special">*</span> <a class="link" href="rbtree_best_fit.html#idp55836288-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> - <span class="comment">// <a class="link" href="rbtree_best_fit.html#idp62957424-bb">public static functions</a></span> - <span class="keyword">static</span> <span class="identifier">size_type</span> <a class="link" href="rbtree_best_fit.html#idp62957984-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> + <span class="comment">// <a class="link" href="rbtree_best_fit.html#idp55842016-bb">public static functions</a></span> + <span class="keyword">static</span> <span class="identifier">size_type</span> <a class="link" href="rbtree_best_fit.html#idp55842576-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> <span class="comment">// public data members</span> <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> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp258123008"></a><h2>Description</h2> +<a name="idp276972928"></a><h2>Description</h2> <p>This class implements an algorithm that stores the free nodes in a red-black tree to have logarithmic search/insert times. </p> <div class="refsect2"> -<a name="idp258123824"></a><h3> +<a name="idp276973744"></a><h3> <a name="boost.interprocess.rbtree_best_fitconstruct-copy-destruct"></a><code class="computeroutput">rbtree_best_fit</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp62954576-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> +<pre class="literallayout"><a name="idp55839168-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> <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> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62956848-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> +<pre class="literallayout"><a name="idp55841440-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> </ol></div> </div> <div class="refsect2"> -<a name="idp258136640"></a><h3> -<a name="idp62926288-bb"></a><code class="computeroutput">rbtree_best_fit</code> public member functions</h3> +<a name="idp276986560"></a><h3> +<a name="idp55810880-bb"></a><code class="computeroutput">rbtree_best_fit</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <span class="special">*</span> <a name="idp62926848-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> +<pre class="literallayout"><span class="keyword">void</span> <span class="special">*</span> <a name="idp55811440-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> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp62928720-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> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp55813312-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> <li class="listitem"> -<pre class="literallayout"><span class="identifier">size_type</span> <a name="idp62930576-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> +<pre class="literallayout"><span class="identifier">size_type</span> <a name="idp55815168-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> <li class="listitem"> -<pre class="literallayout"><span class="identifier">size_type</span> <a name="idp62932016-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> +<pre class="literallayout"><span class="identifier">size_type</span> <a name="idp55816608-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> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp62933456-bb"></a><span class="identifier">zero_free_memory</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp55818048-bb"></a><span class="identifier">zero_free_memory</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Initializes to zero all the memory that's not in use. This function is normally used for security reasons. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp62934816-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> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp55819408-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> <p>Increases managed memory in extra_size bytes more </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp62936800-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> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp55821392-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> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp62937968-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> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp55822560-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> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp62939152-bb"></a><span class="identifier">check_sanity</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp55823744-bb"></a><span class="identifier">check_sanity</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Makes an internal sanity check and returns true if success </p> </li> <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> - <span class="identifier">T</span> <span class="special">*</span> <a name="idp62940464-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> + <span class="identifier">T</span> <span class="special">*</span> <a name="idp55825056-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> <span class="identifier">size_type</span> limit_size<span class="special">,</span> <span class="identifier">size_type</span> <span class="special">&</span> prefer_in_recvd_out_size<span class="special">,</span> <span class="identifier">T</span> <span class="special">*</span><span class="special">&</span> reuse<span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <span class="special">*</span> <a name="idp62944944-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> +<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <span class="special">*</span> <a name="idp55829536-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> <span class="identifier">size_type</span> limit_object<span class="special">,</span> <span class="identifier">size_type</span> <span class="special">&</span> prefer_in_recvd_out_size<span class="special">,</span> <span class="keyword">void</span> <span class="special">*</span><span class="special">&</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> <li class="listitem"> -<pre class="literallayout"><span class="identifier">size_type</span> <a name="idp62949552-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> +<pre class="literallayout"><span class="identifier">size_type</span> <a name="idp55834144-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> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <span class="special">*</span> <a name="idp62951696-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> +<pre class="literallayout"><span class="keyword">void</span> <span class="special">*</span> <a name="idp55836288-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> <p>Allocates aligned bytes, returns 0 if there is not more memory. Alignment must be power of 2 </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp258231776"></a><h3> -<a name="idp62957424-bb"></a><code class="computeroutput">rbtree_best_fit</code> public static functions</h3> +<a name="idp277081888"></a><h3> +<a name="idp55842016-bb"></a><code class="computeroutput">rbtree_best_fit</code> public static functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">size_type</span> <a name="idp62957984-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> +<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">size_type</span> <a name="idp55842576-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> </div> </div> </div> |