Imported Upstream version 1.72.0
[platform/upstream/boost.git] / doc / html / boost / container / private_adaptive_pool.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 private_adaptive_pool</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="../../boost_container_header_reference.html#header.boost.container.adaptive_pool_hpp" title="Header &lt;boost/container/adaptive_pool.hpp&gt;">
10 <link rel="prev" href="adaptive_pool/rebind.html" title="Struct template rebind">
11 <link rel="next" href="private_adaptive_pool/rebind.html" title="Struct template rebind">
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="adaptive_pool/rebind.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_container_header_reference.html#header.boost.container.adaptive_pool_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="private_adaptive_pool/rebind.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
25 </div>
26 <div class="refentry">
27 <a name="boost.container.private_adaptive_pool"></a><div class="titlepage"></div>
28 <div class="refnamediv">
29 <h2><span class="refentrytitle">Class template private_adaptive_pool</span></h2>
30 <p>boost::container::private_adaptive_pool</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="../../boost_container_header_reference.html#header.boost.container.adaptive_pool_hpp" title="Header &lt;boost/container/adaptive_pool.hpp&gt;">boost/container/adaptive_pool.hpp</a>&gt;
34
35 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> NodesPerBlock <span class="special">=</span> <span class="identifier">ADP_nodes_per_block</span><span class="special">,</span> 
36          <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> MaxFreeBlocks <span class="special">=</span> <span class="identifier">ADP_max_free_blocks</span><span class="special">,</span> 
37          <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> OverheadPercent <span class="special">=</span> <span class="identifier">ADP_overhead_percent</span><span class="special">,</span> 
38          <span class="keyword">unsigned</span> Version <span class="special">=</span> <span class="number">2</span><span class="special">&gt;</span> 
39 <span class="keyword">class</span> <a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</a> <span class="special">{</span>
40 <span class="keyword">public</span><span class="special">:</span>
41   <span class="comment">// <a class="link" href="private_adaptive_pool.html#boost.container.private_adaptive_pooltypes">types</a></span>
42   <span class="keyword">typedef</span> <span class="keyword">unsigned</span> <span class="keyword">int</span>                                                                                <a class="link" href="private_adaptive_pool.html#boost.container.private_adaptive_pool.allocation_type"><span class="identifier">allocation_type</span></a><span class="special">;</span>
43   <span class="keyword">typedef</span> <a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</a><span class="special">&lt;</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">NodesPerBlock</span><span class="special">,</span> <span class="identifier">MaxFreeBlocks</span><span class="special">,</span> <span class="identifier">OverheadPercent</span> <span class="special">&gt;</span>                   <a name="boost.container.private_adaptive_pool.self_t"></a><span class="identifier">self_t</span><span class="special">;</span>         
44   <span class="keyword">typedef</span> <span class="identifier">dtl</span><span class="special">::</span><span class="identifier">private_adaptive_node_pool</span><span class="special">&lt;</span> <span class="keyword">sizeof</span><span class="special">(</span><span class="identifier">T</span><span class="special">)</span><span class="special">,</span> <span class="identifier">NodesPerBlock</span><span class="special">,</span> <span class="identifier">MaxFreeBlocks</span><span class="special">,</span> <span class="identifier">OverheadPercent</span> <span class="special">&gt;</span> <a name="boost.container.private_adaptive_pool.pool_t"></a><span class="identifier">pool_t</span><span class="special">;</span>         
45   <span class="keyword">typedef</span> <span class="identifier">T</span>                                                                                           <a name="boost.container.private_adaptive_pool.value_type"></a><span class="identifier">value_type</span><span class="special">;</span>     
46   <span class="keyword">typedef</span> <span class="identifier">T</span> <span class="special">*</span>                                                                                         <a name="boost.container.private_adaptive_pool.pointer"></a><span class="identifier">pointer</span><span class="special">;</span>        
47   <span class="keyword">typedef</span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">*</span>                                                                                   <a name="boost.container.private_adaptive_pool.const_pointer"></a><span class="identifier">const_pointer</span><span class="special">;</span>  
48   <span class="keyword">typedef</span> <span class="special">::</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">unvoid_ref</span><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span>                                              <a name="boost.container.private_adaptive_pool.reference"></a><span class="identifier">reference</span><span class="special">;</span>      
49   <span class="keyword">typedef</span> <span class="special">::</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">unvoid_ref</span><span class="special">&lt;</span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span>                                        <a name="boost.container.private_adaptive_pool.const_reference"></a><span class="identifier">const_reference</span><span class="special">;</span>
50   <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span>                                                                                 <a name="boost.container.private_adaptive_pool.size_type"></a><span class="identifier">size_type</span><span class="special">;</span>      
51   <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ptrdiff_t</span>                                                                              <a name="boost.container.private_adaptive_pool.difference_type"></a><span class="identifier">difference_type</span><span class="special">;</span>
52   <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">version_type</span><span class="special">&lt;</span> <a class="link" href="private_adaptive_pool.html#boost.container.private_adaptive_pool.self_t">self_t</a><span class="special">,</span> <span class="identifier">Version</span> <span class="special">&gt;</span>                                      <a name="boost.container.private_adaptive_pool.version"></a><span class="identifier">version</span><span class="special">;</span>        
53
54   <span class="comment">// member classes/structs/unions</span>
55   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T2<span class="special">&gt;</span> 
56   <span class="keyword">struct</span> <a class="link" href="private_adaptive_pool/rebind.html" title="Struct template rebind">rebind</a> <span class="special">{</span>
57     <span class="comment">// types</span>
58     <span class="keyword">typedef</span> <a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</a><span class="special">&lt;</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">NodesPerBlock</span><span class="special">,</span> <span class="identifier">MaxFreeBlocks</span><span class="special">,</span> <span class="identifier">OverheadPercent</span> <span class="special">&gt;</span> <a class="link" href="private_adaptive_pool/rebind.html#boost.container.private_adaptive_pool.rebind.other"><span class="identifier">other</span></a><span class="special">;</span>
59   <span class="special">}</span><span class="special">;</span>
60
61   <span class="comment">// <a class="link" href="private_adaptive_pool.html#boost.container.private_adaptive_poolconstruct-copy-destruct">construct/copy/destruct</a></span>
62   <a class="link" href="private_adaptive_pool.html#idm45666075146272-bb"><span class="identifier">private_adaptive_pool</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
63   <a class="link" href="private_adaptive_pool.html#idm45666075145424-bb"><span class="identifier">private_adaptive_pool</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
64   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T2<span class="special">&gt;</span> 
65     <a class="link" href="private_adaptive_pool.html#idm45666075142688-bb"><span class="identifier">private_adaptive_pool</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</a><span class="special">&lt;</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">NodesPerBlock</span><span class="special">,</span> <span class="identifier">MaxFreeBlocks</span><span class="special">,</span> <span class="identifier">OverheadPercent</span> <span class="identifier">BOOST_CONTAINER_DOCIGN</span><span class="special">(</span><span class="identifier">BOOST_MOVE_I</span> <span class="identifier">Version</span><span class="special">)</span><span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
66   <a class="link" href="private_adaptive_pool.html#idm45666075139024-bb"><span class="special">~</span><span class="identifier">private_adaptive_pool</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
67
68   <span class="comment">// <a class="link" href="private_adaptive_pool.html#idm45666075180272-bb">public member functions</a></span>
69    <a class="link" href="private_adaptive_pool.html#idm45666075179712-bb"><span class="identifier">BOOST_CONTAINER_DOCIGN</span></a><span class="special">(</span><span class="identifier">BOOST_STATIC_ASSERT</span><span class="special">(</span><span class="special">(</span><span class="identifier">Version</span><span class="special">&lt;=</span><span class="number">2</span><span class="special">)</span><span class="special">)</span><span class="special">)</span><span class="special">;</span>
70   <span class="identifier">size_type</span> <a class="link" href="private_adaptive_pool.html#idm45666075178320-bb"><span class="identifier">max_size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
71   <span class="identifier">pointer</span> <a class="link" href="private_adaptive_pool.html#idm45666075176736-bb"><span class="identifier">allocate</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span>
72   <span class="keyword">void</span> <a class="link" href="private_adaptive_pool.html#idm45666075173728-bb"><span class="identifier">deallocate</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
73   <span class="identifier">pointer</span> <a class="link" href="private_adaptive_pool.html#idm45666075170784-bb"><span class="identifier">allocation_command</span></a><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">&amp;</span><span class="special">,</span> 
74                              <span class="identifier">pointer</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
75   <span class="identifier">size_type</span> <a class="link" href="private_adaptive_pool.html#idm45666075167168-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="identifier">pointer</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
76   <span class="identifier">pointer</span> <a class="link" href="private_adaptive_pool.html#idm45666075164864-bb"><span class="identifier">allocate_one</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
77   <span class="keyword">void</span> <a class="link" href="private_adaptive_pool.html#idm45666075163456-bb"><span class="identifier">allocate_individual</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">,</span> <span class="identifier">multiallocation_chain</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
78   <span class="keyword">void</span> <a class="link" href="private_adaptive_pool.html#idm45666075160736-bb"><span class="identifier">deallocate_one</span></a><span class="special">(</span><span class="identifier">pointer</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
79   <span class="keyword">void</span> <a class="link" href="private_adaptive_pool.html#idm45666075158336-bb"><span class="identifier">deallocate_individual</span></a><span class="special">(</span><span class="identifier">multiallocation_chain</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
80   <span class="keyword">void</span> <a class="link" href="private_adaptive_pool.html#idm45666075156528-bb"><span class="identifier">allocate_many</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">,</span> <span class="identifier">multiallocation_chain</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
81   <span class="keyword">void</span> <a class="link" href="private_adaptive_pool.html#idm45666075153120-bb"><span class="identifier">allocate_many</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">size_type</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">multiallocation_chain</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
82   <span class="keyword">void</span> <a class="link" href="private_adaptive_pool.html#idm45666075149680-bb"><span class="identifier">deallocate_many</span></a><span class="special">(</span><span class="identifier">multiallocation_chain</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
83   <span class="keyword">void</span> <a class="link" href="private_adaptive_pool.html#idm45666075147872-bb"><span class="identifier">deallocate_free_blocks</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
84
85   <span class="comment">// <a class="link" href="private_adaptive_pool.html#idm45666075138448-bb">friend functions</a></span>
86   <span class="keyword">friend</span> <span class="keyword">void</span> <a class="link" href="private_adaptive_pool.html#idm45666075137888-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</a> <span class="special">&amp;</span><span class="special">,</span> <a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
87   <span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="private_adaptive_pool.html#idm45666075134304-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</a> <span class="special">&amp;</span><span class="special">,</span> 
88                          <span class="keyword">const</span> <a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
89   <span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="private_adaptive_pool.html#idm45666075130400-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</a> <span class="special">&amp;</span><span class="special">,</span> 
90                          <span class="keyword">const</span> <a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
91
92   <span class="comment">// <a class="link" href="private_adaptive_pool.html#idm45666075126528-bb">private member functions</a></span>
93   <span class="identifier">pointer</span> <a class="link" href="private_adaptive_pool.html#idm45666075125952-bb"><span class="identifier">priv_allocation_command</span></a><span class="special">(</span><span class="identifier">allocation_type</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">,</span> <span class="identifier">size_type</span> <span class="special">&amp;</span><span class="special">,</span> 
94                                   <span class="identifier">pointer</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
95
96   <span class="comment">// public data members</span>
97   <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">nodes_per_block</span><span class="special">;</span>
98   <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">max_free_blocks</span><span class="special">;</span>
99   <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">overhead_percent</span><span class="special">;</span>
100   <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">real_nodes_per_block</span><span class="special">;</span>
101   <span class="identifier">pool_t</span> <span class="identifier">m_pool</span><span class="special">;</span>
102 <span class="special">}</span><span class="special">;</span></pre></div>
103 <div class="refsect1">
104 <a name="id-1.3.10.14.2.4.4"></a><h2>Description</h2>
105 <div class="refsect2">
106 <a name="id-1.3.10.14.2.4.4.2"></a><h3>
107 <a name="boost.container.private_adaptive_pooltypes"></a><code class="computeroutput">private_adaptive_pool</code> 
108         public
109        types</h3>
110 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
111 <p>
112 <span class="keyword">typedef</span> <span class="keyword">unsigned</span> <span class="keyword">int</span> <a name="boost.container.private_adaptive_pool.allocation_type"></a><span class="identifier">allocation_type</span><span class="special">;</span></p>
113 <p>If Version is 1, the allocator is a STL conforming allocator. If Version is 2, the allocator offers advanced expand in place and burst allocation capabilities. </p>
114 </li></ol></div>
115 </div>
116 <div class="refsect2">
117 <a name="id-1.3.10.14.2.4.4.3"></a><h3>
118 <a name="boost.container.private_adaptive_poolconstruct-copy-destruct"></a><code class="computeroutput">private_adaptive_pool</code> 
119         public
120        construct/copy/destruct</h3>
121 <div class="orderedlist"><ol class="orderedlist" type="1">
122 <li class="listitem">
123 <pre class="literallayout"><a name="idm45666075146272-bb"></a><span class="identifier">private_adaptive_pool</span><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>Default constructor. </li>
124 <li class="listitem">
125 <pre class="literallayout"><a name="idm45666075145424-bb"></a><span class="identifier">private_adaptive_pool</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>Copy constructor from other <code class="computeroutput"><a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</a></code>. </li>
126 <li class="listitem">
127 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T2<span class="special">&gt;</span> 
128   <a name="idm45666075142688-bb"></a><span class="identifier">private_adaptive_pool</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</a><span class="special">&lt;</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">NodesPerBlock</span><span class="special">,</span> <span class="identifier">MaxFreeBlocks</span><span class="special">,</span> <span class="identifier">OverheadPercent</span> <span class="identifier">BOOST_CONTAINER_DOCIGN</span><span class="special">(</span><span class="identifier">BOOST_MOVE_I</span> <span class="identifier">Version</span><span class="special">)</span><span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>Copy constructor from related <code class="computeroutput"><a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</a></code>. </li>
129 <li class="listitem">
130 <pre class="literallayout"><a name="idm45666075139024-bb"></a><span class="special">~</span><span class="identifier">private_adaptive_pool</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Destructor. </li>
131 </ol></div>
132 </div>
133 <div class="refsect2">
134 <a name="id-1.3.10.14.2.4.4.4"></a><h3>
135 <a name="idm45666075180272-bb"></a><code class="computeroutput">private_adaptive_pool</code> public member functions</h3>
136 <div class="orderedlist"><ol class="orderedlist" type="1">
137 <li class="listitem"><pre class="literallayout"> <a name="idm45666075179712-bb"></a><span class="identifier">BOOST_CONTAINER_DOCIGN</span><span class="special">(</span><span class="identifier">BOOST_STATIC_ASSERT</span><span class="special">(</span><span class="special">(</span><span class="identifier">Version</span><span class="special">&lt;=</span><span class="number">2</span><span class="special">)</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre></li>
138 <li class="listitem">
139 <pre class="literallayout"><span class="identifier">size_type</span> <a name="idm45666075178320-bb"></a><span class="identifier">max_size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
140 <p>Returns the number of elements that could be allocated. Never throws </p>
141 </li>
142 <li class="listitem">
143 <pre class="literallayout"><span class="identifier">pointer</span> <a name="idm45666075176736-bb"></a><span class="identifier">allocate</span><span class="special">(</span><span class="identifier">size_type</span> count<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre>
144 <p>Allocate memory for an array of count elements. Throws std::bad_alloc if there is no enough memory </p>
145 </li>
146 <li class="listitem">
147 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45666075173728-bb"></a><span class="identifier">deallocate</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&amp;</span> ptr<span class="special">,</span> <span class="identifier">size_type</span> count<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
148 <p>Deallocate allocated memory. Never throws </p>
149 </li>
150 <li class="listitem"><pre class="literallayout"><span class="identifier">pointer</span> <a name="idm45666075170784-bb"></a><span class="identifier">allocation_command</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> 
151                            <span class="identifier">size_type</span> <span class="special">&amp;</span> prefer_in_recvd_out_size<span class="special">,</span> 
152                            <span class="identifier">pointer</span> <span class="special">&amp;</span> reuse<span class="special">)</span><span class="special">;</span></pre></li>
153 <li class="listitem">
154 <pre class="literallayout"><span class="identifier">size_type</span> <a name="idm45666075167168-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="identifier">pointer</span> p<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
155 <p>Returns maximum the number of objects the previously allocated memory pointed by p can hold. </p>
156 </li>
157 <li class="listitem">
158 <pre class="literallayout"><span class="identifier">pointer</span> <a name="idm45666075164864-bb"></a><span class="identifier">allocate_one</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
159 <p>Allocates just one object. Memory allocated with this function must be deallocated only with deallocate_one(). Throws bad_alloc if there is no enough memory </p>
160 </li>
161 <li class="listitem">
162 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45666075163456-bb"></a><span class="identifier">allocate_individual</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> num_elements<span class="special">,</span> 
163                          <span class="identifier">multiallocation_chain</span> <span class="special">&amp;</span> chain<span class="special">)</span><span class="special">;</span></pre>
164 <p>Allocates many elements of size == 1. Elements must be individually deallocated with deallocate_one() </p>
165 </li>
166 <li class="listitem">
167 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45666075160736-bb"></a><span class="identifier">deallocate_one</span><span class="special">(</span><span class="identifier">pointer</span> p<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
168 <p>Deallocates memory previously allocated with allocate_one(). You should never use deallocate_one to deallocate memory allocated with other functions different from allocate_one(). Never throws </p>
169 </li>
170 <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm45666075158336-bb"></a><span class="identifier">deallocate_individual</span><span class="special">(</span><span class="identifier">multiallocation_chain</span> <span class="special">&amp;</span> chain<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
171 <li class="listitem">
172 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45666075156528-bb"></a><span class="identifier">allocate_many</span><span class="special">(</span><span class="identifier">size_type</span> elem_size<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> n_elements<span class="special">,</span> 
173                    <span class="identifier">multiallocation_chain</span> <span class="special">&amp;</span> chain<span class="special">)</span><span class="special">;</span></pre>
174 <p>Allocates many elements of size elem_size. Elements must be individually deallocated with deallocate() </p>
175 </li>
176 <li class="listitem">
177 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45666075153120-bb"></a><span class="identifier">allocate_many</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">size_type</span> <span class="special">*</span> elem_sizes<span class="special">,</span> <span class="identifier">size_type</span> n_elements<span class="special">,</span> 
178                    <span class="identifier">multiallocation_chain</span> <span class="special">&amp;</span> chain<span class="special">)</span><span class="special">;</span></pre>
179 <p>Allocates n_elements elements, each one of size elem_sizes[i] Elements must be individually deallocated with deallocate() </p>
180 </li>
181 <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm45666075149680-bb"></a><span class="identifier">deallocate_many</span><span class="special">(</span><span class="identifier">multiallocation_chain</span> <span class="special">&amp;</span> chain<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li>
182 <li class="listitem">
183 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45666075147872-bb"></a><span class="identifier">deallocate_free_blocks</span><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>Deallocates all free blocks of the pool. </li>
184 </ol></div>
185 </div>
186 <div class="refsect2">
187 <a name="id-1.3.10.14.2.4.4.5"></a><h3>
188 <a name="idm45666075138448-bb"></a><code class="computeroutput">private_adaptive_pool</code> friend functions</h3>
189 <div class="orderedlist"><ol class="orderedlist" type="1">
190 <li class="listitem">
191 <pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">void</span> <a name="idm45666075137888-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</a> <span class="special">&amp;</span><span class="special">,</span> <a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
192 <p>Swaps allocators. Does not throw. If each allocator is placed in a different memory segment, the result is undefined. </p>
193 </li>
194 <li class="listitem">
195 <pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="idm45666075134304-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</a> <span class="special">&amp;</span><span class="special">,</span> 
196                        <span class="keyword">const</span> <a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
197 <p>An allocator always compares to true, as memory allocated with one instance can be deallocated by another instance </p>
198 </li>
199 <li class="listitem">
200 <pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="idm45666075130400-bb"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</a> <span class="special">&amp;</span><span class="special">,</span> 
201                        <span class="keyword">const</span> <a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
202 <p>An allocator always compares to false, as memory allocated with one instance can be deallocated by another instance </p>
203 </li>
204 </ol></div>
205 </div>
206 <div class="refsect2">
207 <a name="id-1.3.10.14.2.4.4.6"></a><h3>
208 <a name="idm45666075126528-bb"></a><code class="computeroutput">private_adaptive_pool</code> private member functions</h3>
209 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="identifier">pointer</span> <a name="idm45666075125952-bb"></a><span class="identifier">priv_allocation_command</span><span class="special">(</span><span class="identifier">allocation_type</span> command<span class="special">,</span> 
210                                 <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> limit_size<span class="special">,</span> 
211                                 <span class="identifier">size_type</span> <span class="special">&amp;</span> prefer_in_recvd_out_size<span class="special">,</span> 
212                                 <span class="identifier">pointer</span> <span class="special">&amp;</span> reuse_ptr<span class="special">)</span><span class="special">;</span></pre></li></ol></div>
213 </div>
214 </div>
215 </div>
216 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
217 <td align="left"></td>
218 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2018 Ion Gaztanaga<p>
219         Distributed under the Boost Software License, Version 1.0. (See accompanying
220         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>)
221       </p>
222 </div></td>
223 </tr></table>
224 <hr>
225 <div class="spirit-nav">
226 <a accesskey="p" href="adaptive_pool/rebind.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_container_header_reference.html#header.boost.container.adaptive_pool_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="private_adaptive_pool/rebind.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
227 </div>
228 </body>
229 </html>