libs/pool/doc/html/boost/pool_allocator.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template pool_allocator</title>
   5 <link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../index.html" title="Boost.Pool">
   8 <link rel="up" href="../header/boost/pool/poolfwd_hpp.html" title="Header &lt;boost/pool/poolfwd.hpp&gt;">
   9 <link rel="prev" href="pool.html" title="Class template pool">
  10 <link rel="next" href="../header/boost/pool/simple_segregated_storage_hpp.html" title="Header &lt;boost/pool/simple_segregated_storage.hpp&gt;">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="pool.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../header/boost/pool/poolfwd_hpp.html"><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="../header/boost/pool/simple_segregated_storage_hpp.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.pool_allocator"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class template pool_allocator</span></h2>
  29 <p>boost::pool_allocator &#8212; A C++ Standard Library conforming allocator, based on an underlying pool. </p>
  30 </div>
  31 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  32 <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="../header/boost/pool/poolfwd_hpp.html" title="Header &lt;boost/pool/poolfwd.hpp&gt;">boost/pool/poolfwd.hpp</a>&gt;
  33
  34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> UserAllocator<span class="special">,</span> <span class="keyword">typename</span> Mutex<span class="special">,</span>
  35          <span class="keyword">unsigned</span> NextSize<span class="special">,</span> <span class="keyword">unsigned</span> MaxSize<span class="special">&gt;</span>
  36 <span class="keyword">class</span> <a class="link" href="pool_allocator.html" title="Class template pool_allocator">pool_allocator</a> <span class="special">{</span>
  37 <span class="keyword">public</span><span class="special">:</span>
  38   <span class="comment">// <a class="link" href="pool_allocator.html#boost.pool_allocatorconstruct-copy-destruct">construct/copy/destruct</a></span>
  39   <a class="link" href="pool_allocator.html#idm45952505677888-bb"><span class="identifier">pool_allocator</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  40   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> U<span class="special">&gt;</span>
  41     <a class="link" href="pool_allocator.html#idm45952505675104-bb"><span class="identifier">pool_allocator</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="pool_allocator.html" title="Class template pool_allocator">pool_allocator</a><span class="special">&lt;</span> <span class="identifier">U</span><span class="special">,</span> <span class="identifier">UserAllocator</span><span class="special">,</span> <span class="identifier">Mutex</span><span class="special">,</span> <span class="identifier">NextSize</span><span class="special">,</span> <span class="identifier">MaxSize</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  42
  43   <span class="comment">// <a class="link" href="pool_allocator.html#idm45952505682512-bb">public member functions</a></span>
  44   <span class="keyword">bool</span> <a class="link" href="pool_allocator.html#idm45952505682016-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="pool_allocator.html" title="Class template pool_allocator">pool_allocator</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  45   <span class="keyword">bool</span> <a class="link" href="pool_allocator.html#idm45952505680016-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="pool_allocator.html" title="Class template pool_allocator">pool_allocator</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  46
  47   <span class="comment">// <a class="link" href="pool_allocator.html#idm45952505670688-bb">public static functions</a></span>
  48   <span class="keyword">static</span> <span class="identifier">pointer</span> <a class="link" href="pool_allocator.html#idm45952505670192-bb"><span class="identifier">address</span></a><span class="special">(</span><span class="identifier">reference</span><span class="special">)</span><span class="special">;</span>
  49   <span class="keyword">static</span> <span class="identifier">const_pointer</span> <a class="link" href="pool_allocator.html#idm45952505668576-bb"><span class="identifier">address</span></a><span class="special">(</span><span class="identifier">const_reference</span><span class="special">)</span><span class="special">;</span>
  50   <span class="keyword">static</span> <span class="identifier">size_type</span> <a class="link" href="pool_allocator.html#idm45952505666960-bb"><span class="identifier">max_size</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  51   <span class="keyword">static</span> <span class="keyword">void</span> <a class="link" href="pool_allocator.html#idm45952505665968-bb"><span class="identifier">construct</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">value_type</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  52   <span class="keyword">static</span> <span class="keyword">void</span> <a class="link" href="pool_allocator.html#idm45952505663728-bb"><span class="identifier">destroy</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span><span class="special">)</span><span class="special">;</span>
  53   <span class="keyword">static</span> <span class="identifier">pointer</span> <a class="link" href="pool_allocator.html#idm45952505662112-bb"><span class="identifier">allocate</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>
  54   <span class="keyword">static</span> <span class="identifier">pointer</span> <a class="link" href="pool_allocator.html#idm45952505660496-bb"><span class="identifier">allocate</span></a><span class="special">(</span><span class="keyword">const</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="keyword">const</span><span class="special">)</span><span class="special">;</span>
  55   <span class="keyword">static</span> <span class="keyword">void</span> <a class="link" href="pool_allocator.html#idm45952505657232-bb"><span class="identifier">deallocate</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span>
  56 <span class="special">}</span><span class="special">;</span></pre></div>
  57 <div class="refsect1">
  58 <a name="idm46381012881504"></a><h2>Description</h2>
  59 <p>Template parameters for <a class="link" href="pool_allocator.html" title="Class template pool_allocator">pool_allocator</a> are defined as follows:</p>
  60 <p><span class="bold"><strong>T</strong></span> Type of object to allocate/deallocate.</p>
  61 <p><span class="bold"><strong>UserAllocator</strong></span>. Defines the method that the underlying Pool will use to allocate memory from the system. See <a href="../boost_pool/pool/pooling.html#boost_pool.pool.pooling.user_allocator" target="_top">User Allocators</a> for details.</p>
  62 <p><span class="bold"><strong>Mutex</strong></span> Allows the user to determine the type of synchronization to be used on the underlying <a class="link" href="singleton_pool.html" title="Class template singleton_pool">singleton_pool</a>.</p>
  63 <p><span class="bold"><strong>NextSize</strong></span> The value of this parameter is passed to the underlying <a class="link" href="singleton_pool.html" title="Class template singleton_pool">singleton_pool</a> when it is created.</p>
  64 <p><span class="bold"><strong>MaxSize</strong></span> Limit on the maximum size used.</p>
  65 <div class="note"><table border="0" summary="Note">
  66 <tr>
  67 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td>
  68 <th align="left">Note</th>
  69 </tr>
  70 <tr><td align="left" valign="top"><p>The underlying <a class="link" href="singleton_pool.html" title="Class template singleton_pool">singleton_pool</a> used by the this allocator constructs a pool instance that <span class="bold"><strong>is never freed</strong></span>. This means that memory allocated by the allocator can be still used after main() has completed, but may mean that some memory checking programs will complain about leaks. </p></td></tr>
  71 </table></div>
  72 <p>
  73 </p>
  74 <div class="refsect2">
  75 <a name="idm46381012870544"></a><h3>
  76 <a name="boost.pool_allocatorconstruct-copy-destruct"></a><code class="computeroutput">pool_allocator</code>
  77         public
  78        construct/copy/destruct</h3>
  79 <div class="orderedlist"><ol class="orderedlist" type="1">
  80 <li class="listitem">
  81 <pre class="literallayout"><a name="idm45952505677888-bb"></a><span class="identifier">pool_allocator</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
  82 <p>Results in default construction of the underlying <code class="computeroutput"><a class="link" href="singleton_pool.html" title="Class template singleton_pool">singleton_pool</a></code> IFF an instance of this allocator is constructed during global initialization ( required to ensure construction of <code class="computeroutput"><a class="link" href="singleton_pool.html" title="Class template singleton_pool">singleton_pool</a></code> IFF an instance of this allocator is constructed during global initialization. See ticket #2359 for a complete explanation at <a href="http://svn.boost.org/trac/boost/ticket/2359" target="_top">http://svn.boost.org/trac/boost/ticket/2359</a>) .</p>
  83 </li>
  84 <li class="listitem">
  85 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> U<span class="special">&gt;</span>
  86   <a name="idm45952505675104-bb"></a><span class="identifier">pool_allocator</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="pool_allocator.html" title="Class template pool_allocator">pool_allocator</a><span class="special">&lt;</span> <span class="identifier">U</span><span class="special">,</span> <span class="identifier">UserAllocator</span><span class="special">,</span> <span class="identifier">Mutex</span><span class="special">,</span> <span class="identifier">NextSize</span><span class="special">,</span> <span class="identifier">MaxSize</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span></pre>
  87 <p>Results in the default construction of the underlying <code class="computeroutput"><a class="link" href="singleton_pool.html" title="Class template singleton_pool">singleton_pool</a></code>, this is required to ensure construction of <code class="computeroutput"><a class="link" href="singleton_pool.html" title="Class template singleton_pool">singleton_pool</a></code> IFF an instance of this allocator is constructed during global initialization. See ticket #2359 for a complete explanation at <a href="http://svn.boost.org/trac/boost/ticket/2359" target="_top">http://svn.boost.org/trac/boost/ticket/2359</a> .</p>
  88 </li>
  89 </ol></div>
  90 </div>
  91 <div class="refsect2">
  92 <a name="idm46381012842320"></a><h3>
  93 <a name="idm45952505682512-bb"></a><code class="computeroutput">pool_allocator</code> public member functions</h3>
  94 <div class="orderedlist"><ol class="orderedlist" type="1">
  95 <li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="idm45952505682016-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="pool_allocator.html" title="Class template pool_allocator">pool_allocator</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  96 <li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="idm45952505680016-bb"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="pool_allocator.html" title="Class template pool_allocator">pool_allocator</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  97 </ol></div>
  98 </div>
  99 <div class="refsect2">
 100 <a name="idm46381012825056"></a><h3>
 101 <a name="idm45952505670688-bb"></a><code class="computeroutput">pool_allocator</code> public static functions</h3>
 102 <div class="orderedlist"><ol class="orderedlist" type="1">
 103 <li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="identifier">pointer</span> <a name="idm45952505670192-bb"></a><span class="identifier">address</span><span class="special">(</span><span class="identifier">reference</span> r<span class="special">)</span><span class="special">;</span></pre></li>
 104 <li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="identifier">const_pointer</span> <a name="idm45952505668576-bb"></a><span class="identifier">address</span><span class="special">(</span><span class="identifier">const_reference</span> s<span class="special">)</span><span class="special">;</span></pre></li>
 105 <li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="identifier">size_type</span> <a name="idm45952505666960-bb"></a><span class="identifier">max_size</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
 106 <li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="keyword">void</span> <a name="idm45952505665968-bb"></a><span class="identifier">construct</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> ptr<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">value_type</span> <span class="special">&amp;</span> t<span class="special">)</span><span class="special">;</span></pre></li>
 107 <li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="keyword">void</span> <a name="idm45952505663728-bb"></a><span class="identifier">destroy</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> ptr<span class="special">)</span><span class="special">;</span></pre></li>
 108 <li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="identifier">pointer</span> <a name="idm45952505662112-bb"></a><span class="identifier">allocate</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">size_type</span> n<span class="special">)</span><span class="special">;</span></pre></li>
 109 <li class="listitem">
 110 <pre class="literallayout"><span class="keyword">static</span> <span class="identifier">pointer</span> <a name="idm45952505660496-bb"></a><span class="identifier">allocate</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">size_type</span> n<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> <span class="keyword">const</span><span class="special">)</span><span class="special">;</span></pre>
 111 <p>allocate n bytes</p>
 112 <p>
 113 </p>
 114 <div class="variablelist"><table border="0" class="variablelist compact">
 115 <colgroup>
 116 <col align="left" valign="top">
 117 <col>
 118 </colgroup>
 119 <tbody><tr>
 120 <td><p><span class="term">Parameters:</span></p></td>
 121 <td><div class="variablelist"><table border="0" class="variablelist compact">
 122 <colgroup>
 123 <col align="left" valign="top">
 124 <col>
 125 </colgroup>
 126 <tbody><tr>
 127 <td><p><span class="term"><code class="computeroutput">n</code></span></p></td>
 128 <td><p>bytes to allocate. </p></td>
 129 </tr></tbody>
 130 </table></div></td>
 131 </tr></tbody>
 132 </table></div>
 133 </li>
 134 <li class="listitem">
 135 <pre class="literallayout"><span class="keyword">static</span> <span class="keyword">void</span> <a name="idm45952505657232-bb"></a><span class="identifier">deallocate</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> ptr<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">size_type</span> n<span class="special">)</span><span class="special">;</span></pre>
 136 <p>Deallocate n bytes from ptr
 137 </p>
 138 <div class="variablelist"><table border="0" class="variablelist compact">
 139 <colgroup>
 140 <col align="left" valign="top">
 141 <col>
 142 </colgroup>
 143 <tbody><tr>
 144 <td><p><span class="term">Parameters:</span></p></td>
 145 <td><div class="variablelist"><table border="0" class="variablelist compact">
 146 <colgroup>
 147 <col align="left" valign="top">
 148 <col>
 149 </colgroup>
 150 <tbody>
 151 <tr>
 152 <td><p><span class="term"><code class="computeroutput">n</code></span></p></td>
 153 <td><p>number of bytes to deallocate. </p></td>
 154 </tr>
 155 <tr>
 156 <td><p><span class="term"><code class="computeroutput">ptr</code></span></p></td>
 157 <td><p>location to deallocate from. </p></td>
 158 </tr>
 159 </tbody>
 160 </table></div></td>
 161 </tr></tbody>
 162 </table></div>
 163 </li>
 164 </ol></div>
 165 </div>
 166 </div>
 167 </div>
 168 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 169 <td align="left"></td>
 170 <td align="right"><div class="copyright-footer">Copyright &#169; 2000-2006 Stephen Cleary<br>Copyright &#169; 2011 Paul A. Bristow<p>
 171         Distributed under the Boost Software License, Version 1.0. (See accompanying
 172         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>)
 173       </p>
 174 </div></td>
 175 </tr></table>
 176 <hr>
 177 <div class="spirit-nav">
 178 <a accesskey="p" href="pool.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../header/boost/pool/poolfwd_hpp.html"><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="../header/boost/pool/simple_segregated_storage_hpp.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
 179 </div>
 180 </body>
 181 </html>