doc/html/allocator_traits.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Struct template allocator_traits</title>
   5 <link rel="stylesheet" href="../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   8 <link rel="up" href="boost_container_header_reference.html#header.boost.container.allocator_traits_hpp" title="Header &lt;boost/container/allocator_traits.hpp&gt;">
   9 <link rel="prev" href="boost_container_header_reference.html" title="Boost.Container Header Reference">
  10 <link rel="next" href="allocator_traits/portable_rebind_alloc.html" title="Struct template portable_rebind_alloc">
  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="boost_container_header_reference.html"><img src="../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="boost_container_header_reference.html#header.boost.container.allocator_traits_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="allocator_traits/portable_rebind_alloc.html"><img src="../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="allocator_traits"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Struct template allocator_traits</span></h2>
  29 <p>allocator_traits</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="boost_container_header_reference.html#header.boost.container.allocator_traits_hpp" title="Header &lt;boost/container/allocator_traits.hpp&gt;">boost/container/allocator_traits.hpp</a>&gt;
  33
  34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Alloc<span class="special">&gt;</span>
  35 <span class="keyword">struct</span> <a class="link" href="allocator_traits.html" title="Struct template allocator_traits">allocator_traits</a> <span class="special">{</span>
  36   <span class="comment">// <a class="link" href="allocator_traits.html#allocator_traitstypes">types</a></span>
  37   <span class="keyword">typedef</span> <span class="identifier">Alloc</span>             <a name="allocator_traits.allocator_type"></a><span class="identifier">allocator_type</span><span class="special">;</span>
  38   <span class="keyword">typedef</span> <span class="identifier">Alloc</span><span class="special">::</span><span class="identifier">value_type</span> <a name="allocator_traits.value_type"></a><span class="identifier">value_type</span><span class="special">;</span>
  39   <span class="keyword">typedef</span> <span class="identifier">unspecified</span>       <a class="link" href="allocator_traits.html#allocator_traits.pointer"><span class="identifier">pointer</span></a><span class="special">;</span>
  40   <span class="keyword">typedef</span> <span class="identifier">unspecified</span>       <a class="link" href="allocator_traits.html#allocator_traits.const_pointer"><span class="identifier">const_pointer</span></a><span class="special">;</span>
  41   <span class="keyword">typedef</span> <span class="identifier">unspecified</span>       <a class="link" href="allocator_traits.html#allocator_traits.reference"><span class="identifier">reference</span></a><span class="special">;</span>
  42   <span class="keyword">typedef</span> <span class="identifier">unspecified</span>       <a class="link" href="allocator_traits.html#allocator_traits.const_reference"><span class="identifier">const_reference</span></a><span class="special">;</span>
  43   <span class="keyword">typedef</span> <span class="identifier">unspecified</span>       <a class="link" href="allocator_traits.html#allocator_traits.void_pointer"><span class="identifier">void_pointer</span></a><span class="special">;</span>
  44   <span class="keyword">typedef</span> <span class="identifier">unspecified</span>       <a class="link" href="allocator_traits.html#allocator_traits.const_void_pointer"><span class="identifier">const_void_pointer</span></a><span class="special">;</span>
  45   <span class="keyword">typedef</span> <span class="identifier">unspecified</span>       <a class="link" href="allocator_traits.html#allocator_traits.difference_type"><span class="identifier">difference_type</span></a><span class="special">;</span>
  46   <span class="keyword">typedef</span> <span class="identifier">unspecified</span>       <a class="link" href="allocator_traits.html#allocator_traits.size_type"><span class="identifier">size_type</span></a><span class="special">;</span>
  47   <span class="keyword">typedef</span> <span class="identifier">unspecified</span>       <a class="link" href="allocator_traits.html#allocator_traits.propagate_on_cont_id425173"><span class="identifier">propagate_on_container_copy_assignment</span></a><span class="special">;</span>
  48   <span class="keyword">typedef</span> <span class="identifier">unspecified</span>       <a class="link" href="allocator_traits.html#allocator_traits.propagate_on_cont_id425185"><span class="identifier">propagate_on_container_move_assignment</span></a><span class="special">;</span>
  49   <span class="keyword">typedef</span> <span class="identifier">unspecified</span>       <a class="link" href="allocator_traits.html#allocator_traits.propagate_on_cont_id425197"><span class="identifier">propagate_on_container_swap</span></a><span class="special">;</span>
  50
  51   <span class="comment">// member classes/structs/unions</span>
  52   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span>
  53   <span class="keyword">struct</span> <a class="link" href="allocator_traits/portable_rebind_alloc.html" title="Struct template portable_rebind_alloc">portable_rebind_alloc</a> <span class="special">{</span>
  54     <span class="comment">// types</span>
  55     <span class="keyword">typedef</span> <span class="identifier">unspecified_type</span> <a class="link" href="allocator_traits/portable_rebind_alloc.html#allocator_traits.portable_rebind_alloc.type"><span class="identifier">type</span></a><span class="special">;</span>
  56   <span class="special">}</span><span class="special">;</span>
  57
  58   <span class="comment">// <a class="link" href="allocator_traits.html#id425208-bb">public static functions</a></span>
  59   <span class="keyword">static</span> <span class="identifier">pointer</span> <a class="link" href="allocator_traits.html#id425211-bb"><span class="identifier">allocate</span></a><span class="special">(</span><span class="identifier">Alloc</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span>
  60   <span class="keyword">static</span> <span class="keyword">void</span> <a class="link" href="allocator_traits.html#id425235-bb"><span class="identifier">deallocate</span></a><span class="special">(</span><span class="identifier">Alloc</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">pointer</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span>
  61   <span class="keyword">static</span> <span class="identifier">pointer</span> <a class="link" href="allocator_traits.html#id468071-bb"><span class="identifier">allocate</span></a><span class="special">(</span><span class="identifier">Alloc</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">const_void_pointer</span><span class="special">)</span><span class="special">;</span>
  62   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> <span class="keyword">static</span> <span class="keyword">void</span> <a class="link" href="allocator_traits.html#id480529-bb"><span class="identifier">destroy</span></a><span class="special">(</span><span class="identifier">Alloc</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">T</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span>
  63   <span class="keyword">static</span> <span class="identifier">size_type</span> <a class="link" href="allocator_traits.html#id423326-bb"><span class="identifier">max_size</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Alloc</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  64   <span class="keyword">static</span> <span class="identifier">Alloc</span> <a class="link" href="allocator_traits.html#id423347-bb"><span class="identifier">select_on_container_copy_construction</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Alloc</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  65   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">class</span><span class="special">...</span> Args<span class="special">&gt;</span>
  66     <span class="keyword">static</span> <span class="keyword">void</span> <a class="link" href="allocator_traits.html#id423368-bb"><span class="identifier">construct</span></a><span class="special">(</span><span class="identifier">Alloc</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">T</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">Args</span> <span class="special">&amp;&amp;</span><span class="special">...</span><span class="special">)</span><span class="special">;</span>
  67 <span class="special">}</span><span class="special">;</span></pre></div>
  68 <div class="refsect1">
  69 <a name="id1137943"></a><h2>Description</h2>
  70 <p>The class template <a class="link" href="allocator_traits.html" title="Struct template allocator_traits">allocator_traits</a> supplies a uniform interface to all allocator types. This class is a C++03-compatible implementation of std::allocator_traits </p>
  71 <div class="refsect2">
  72 <a name="id1137958"></a><h3>
  73 <a name="allocator_traitstypes"></a><code class="computeroutput">allocator_traits</code>
  74         public
  75        types</h3>
  76 <div class="orderedlist"><ol class="orderedlist" type="1">
  77 <li class="listitem">
  78 <p>
  79 <span class="keyword">typedef</span> <span class="identifier">unspecified</span> <a name="allocator_traits.pointer"></a><span class="identifier">pointer</span><span class="special">;</span></p>
  80 <p>Alloc::pointer if such a type exists; otherwise, value_type* </p>
  81 </li>
  82 <li class="listitem">
  83 <p>
  84 <span class="keyword">typedef</span> <span class="identifier">unspecified</span> <a name="allocator_traits.const_pointer"></a><span class="identifier">const_pointer</span><span class="special">;</span></p>
  85 <p>Alloc::const_pointer if such a type exists ; otherwise, pointer_traits&lt;pointer&gt;::rebind&lt;const </p>
  86 </li>
  87 <li class="listitem">
  88 <p>
  89 <span class="keyword">typedef</span> <span class="identifier">unspecified</span> <a name="allocator_traits.reference"></a><span class="identifier">reference</span><span class="special">;</span></p>
  90 <p>Non-standard extension Alloc::reference if such a type exists; otherwise, value_type&amp; </p>
  91 </li>
  92 <li class="listitem">
  93 <p>
  94 <span class="keyword">typedef</span> <span class="identifier">unspecified</span> <a name="allocator_traits.const_reference"></a><span class="identifier">const_reference</span><span class="special">;</span></p>
  95 <p>Non-standard extension Alloc::const_reference if such a type exists ; otherwise, const value_type&amp; </p>
  96 </li>
  97 <li class="listitem">
  98 <p>
  99 <span class="keyword">typedef</span> <span class="identifier">unspecified</span> <a name="allocator_traits.void_pointer"></a><span class="identifier">void_pointer</span><span class="special">;</span></p>
 100 <p>Alloc::void_pointer if such a type exists ; otherwise, pointer_traits&lt;pointer&gt;::rebind&lt;void&gt;. </p>
 101 </li>
 102 <li class="listitem">
 103 <p>
 104 <span class="keyword">typedef</span> <span class="identifier">unspecified</span> <a name="allocator_traits.const_void_pointer"></a><span class="identifier">const_void_pointer</span><span class="special">;</span></p>
 105 <p>Alloc::const_void_pointer if such a type exists ; otherwis e, pointer_traits&lt;pointer&gt;::rebind&lt;const </p>
 106 </li>
 107 <li class="listitem">
 108 <p>
 109 <span class="keyword">typedef</span> <span class="identifier">unspecified</span> <a name="allocator_traits.difference_type"></a><span class="identifier">difference_type</span><span class="special">;</span></p>
 110 <p>Alloc::difference_type if such a type exists ; otherwise, pointer_traits&lt;pointer&gt;::difference_type. </p>
 111 </li>
 112 <li class="listitem">
 113 <p>
 114 <span class="keyword">typedef</span> <span class="identifier">unspecified</span> <a name="allocator_traits.size_type"></a><span class="identifier">size_type</span><span class="special">;</span></p>
 115 <p>Alloc::size_type if such a type exists ; otherwise, make_unsigned&lt;difference_type&gt;::type </p>
 116 </li>
 117 <li class="listitem">
 118 <p>
 119 <span class="keyword">typedef</span> <span class="identifier">unspecified</span> <a name="allocator_traits.propagate_on_cont_id425173"></a><span class="identifier">propagate_on_container_copy_assignment</span><span class="special">;</span></p>
 120 <p>Alloc::propagate_on_container_copy_assignment if such a type exists, otherwise an integral_constant type with internal constant static member `value` == false. </p>
 121 </li>
 122 <li class="listitem">
 123 <p>
 124 <span class="keyword">typedef</span> <span class="identifier">unspecified</span> <a name="allocator_traits.propagate_on_cont_id425185"></a><span class="identifier">propagate_on_container_move_assignment</span><span class="special">;</span></p>
 125 <p>Alloc::propagate_on_container_move_assignment if such a type exists, otherwise an integral_constant type with internal constant static member `value` == false. </p>
 126 </li>
 127 <li class="listitem">
 128 <p>
 129 <span class="keyword">typedef</span> <span class="identifier">unspecified</span> <a name="allocator_traits.propagate_on_cont_id425197"></a><span class="identifier">propagate_on_container_swap</span><span class="special">;</span></p>
 130 <p>Alloc::propagate_on_container_swap if such a type exists, otherwise an integral_constant type with internal constant static member `value` == false. </p>
 131 </li>
 132 </ol></div>
 133 </div>
 134 <div class="refsect2">
 135 <a name="id1138342"></a><h3>
 136 <a name="id425208-bb"></a><code class="computeroutput">allocator_traits</code> public static functions</h3>
 137 <div class="orderedlist"><ol class="orderedlist" type="1">
 138 <li class="listitem">
 139 <pre class="literallayout"><span class="keyword">static</span> <span class="identifier">pointer</span> <a name="id425211-bb"></a><span class="identifier">allocate</span><span class="special">(</span><span class="identifier">Alloc</span> <span class="special">&amp;</span> a<span class="special">,</span> <span class="identifier">size_type</span> n<span class="special">)</span><span class="special">;</span></pre>
 140 <p><span class="bold"><strong>Returns</strong></span>: `a.allocate(n)` </p>
 141 </li>
 142 <li class="listitem">
 143 <pre class="literallayout"><span class="keyword">static</span> <span class="keyword">void</span> <a name="id425235-bb"></a><span class="identifier">deallocate</span><span class="special">(</span><span class="identifier">Alloc</span> <span class="special">&amp;</span> a<span class="special">,</span> <span class="identifier">pointer</span> p<span class="special">,</span> <span class="identifier">size_type</span> n<span class="special">)</span><span class="special">;</span></pre>
 144 <p><span class="bold"><strong>Returns</strong></span>: `a.deallocate(p, n)`</p>
 145 <p><span class="bold"><strong>Throws</strong></span>: Nothing </p>
 146 </li>
 147 <li class="listitem">
 148 <pre class="literallayout"><span class="keyword">static</span> <span class="identifier">pointer</span> <a name="id468071-bb"></a><span class="identifier">allocate</span><span class="special">(</span><span class="identifier">Alloc</span> <span class="special">&amp;</span> a<span class="special">,</span> <span class="identifier">size_type</span> n<span class="special">,</span> <span class="identifier">const_void_pointer</span> p<span class="special">)</span><span class="special">;</span></pre>
 149 <p><span class="bold"><strong>Effects</strong></span>: calls `a.allocate(n, p)` if that call is well-formed; otherwise, invokes `a.allocate(n)` </p>
 150 </li>
 151 <li class="listitem">
 152 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> <span class="keyword">static</span> <span class="keyword">void</span> <a name="id480529-bb"></a><span class="identifier">destroy</span><span class="special">(</span><span class="identifier">Alloc</span> <span class="special">&amp;</span> a<span class="special">,</span> <span class="identifier">T</span> <span class="special">*</span> p<span class="special">)</span><span class="special">;</span></pre>
 153 <p><span class="bold"><strong>Effects</strong></span>: calls `a.destroy(p)` if that call is well-formed; otherwise, invokes `p-&gt;~T()`. </p>
 154 </li>
 155 <li class="listitem">
 156 <pre class="literallayout"><span class="keyword">static</span> <span class="identifier">size_type</span> <a name="id423326-bb"></a><span class="identifier">max_size</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Alloc</span> <span class="special">&amp;</span> a<span class="special">)</span><span class="special">;</span></pre>
 157 <p><span class="bold"><strong>Returns</strong></span>: `a.max_size()` if that expression is well-formed; otherwise, `numeric_limits&lt;size_type&gt;::max()`. </p>
 158 </li>
 159 <li class="listitem">
 160 <pre class="literallayout"><span class="keyword">static</span> <span class="identifier">Alloc</span> <a name="id423347-bb"></a><span class="identifier">select_on_container_copy_construction</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Alloc</span> <span class="special">&amp;</span> a<span class="special">)</span><span class="special">;</span></pre>
 161 <p><span class="bold"><strong>Returns</strong></span>: `a.select_on_container_copy_construction()` if that expression is well-formed; otherwise, a. </p>
 162 </li>
 163 <li class="listitem">
 164 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">class</span><span class="special">...</span> Args<span class="special">&gt;</span>
 165   <span class="keyword">static</span> <span class="keyword">void</span> <a name="id423368-bb"></a><span class="identifier">construct</span><span class="special">(</span><span class="identifier">Alloc</span> <span class="special">&amp;</span> a<span class="special">,</span> <span class="identifier">T</span> <span class="special">*</span> p<span class="special">,</span> <span class="identifier">Args</span> <span class="special">&amp;&amp;</span><span class="special">...</span> args<span class="special">)</span><span class="special">;</span></pre>
 166 <p><span class="bold"><strong>Effects</strong></span>: calls `a.construct(p, std::forward&lt;Args&gt;(args)...)` if that call is well-formed; otherwise, invokes `::new (static_cast&lt;void*&gt;(p)) T(std::forward&lt;Args&gt;(args)...)` </p>
 167 </li>
 168 </ol></div>
 169 </div>
 170 </div>
 171 </div>
 172 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 173 <td align="left"></td>
 174 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2012 Ion
 175       Gaztanaga<p>
 176         Distributed under the Boost Software License, Version 1.0. (See accompanying
 177         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>)
 178       </p>
 179 </div></td>
 180 </tr></table>
 181 <hr>
 182 <div class="spirit-nav">
 183 <a accesskey="p" href="boost_container_header_reference.html"><img src="../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="boost_container_header_reference.html#header.boost.container.allocator_traits_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="allocator_traits/portable_rebind_alloc.html"><img src="../../doc/src/images/next.png" alt="Next"></a>
 184 </div>
 185 </body>
 186 </html>