diff options
Diffstat (limited to 'doc/html/boost/container/allocator_traits.html')
| -rw-r--r-- | doc/html/boost/container/allocator_traits.html | 58 |
1 files changed, 29 insertions, 29 deletions
diff --git a/doc/html/boost/container/allocator_traits.html b/doc/html/boost/container/allocator_traits.html index 188a9953d1..d4d43541a0 100644 --- a/doc/html/boost/container/allocator_traits.html +++ b/doc/html/boost/container/allocator_traits.html @@ -45,9 +45,9 @@ <span class="keyword">typedef</span> <span class="identifier">see_documentation</span> <a class="link" href="allocator_traits.html#boost.container.allocator_traits.const_void_pointer"><span class="identifier">const_void_pointer</span></a><span class="special">;</span> <span class="keyword">typedef</span> <span class="identifier">see_documentation</span> <a class="link" href="allocator_traits.html#boost.container.allocator_traits.difference_type"><span class="identifier">difference_type</span></a><span class="special">;</span> <span class="keyword">typedef</span> <span class="identifier">see_documentation</span> <a class="link" href="allocator_traits.html#boost.container.allocator_traits.size_type"><span class="identifier">size_type</span></a><span class="special">;</span> - <span class="keyword">typedef</span> <span class="identifier">see_documentation</span> <a class="link" href="allocator_traits.html#boost.container.allocator_traits.propagate_on_c_idp42225872"><span class="identifier">propagate_on_container_copy_assignment</span></a><span class="special">;</span> - <span class="keyword">typedef</span> <span class="identifier">see_documentation</span> <a class="link" href="allocator_traits.html#boost.container.allocator_traits.propagate_on_c_idp42227728"><span class="identifier">propagate_on_container_move_assignment</span></a><span class="special">;</span> - <span class="keyword">typedef</span> <span class="identifier">see_documentation</span> <a class="link" href="allocator_traits.html#boost.container.allocator_traits.propagate_on_c_idp42229584"><span class="identifier">propagate_on_container_swap</span></a><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">see_documentation</span> <a class="link" href="allocator_traits.html#boost.container.allocator_traits.propagate_on_c_idp46800192"><span class="identifier">propagate_on_container_copy_assignment</span></a><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">see_documentation</span> <a class="link" href="allocator_traits.html#boost.container.allocator_traits.propagate_on_c_idp46802048"><span class="identifier">propagate_on_container_move_assignment</span></a><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">see_documentation</span> <a class="link" href="allocator_traits.html#boost.container.allocator_traits.propagate_on_c_idp46803904"><span class="identifier">propagate_on_container_swap</span></a><span class="special">;</span> <span class="keyword">typedef</span> <span class="identifier">see_documentation</span> <a class="link" href="allocator_traits.html#boost.container.allocator_traits.is_always_equal"><span class="identifier">is_always_equal</span></a><span class="special">;</span> <span class="keyword">typedef</span> <span class="identifier">see_documentation</span> <a class="link" href="allocator_traits.html#boost.container.allocator_traits.is_partially_propagable"><span class="identifier">is_partially_propagable</span></a><span class="special">;</span> <span class="keyword">typedef</span> <span class="identifier">see_documentation</span> <a class="link" href="allocator_traits.html#boost.container.allocator_traits.rebind_alloc"><span class="identifier">rebind_alloc</span></a><span class="special">;</span> @@ -60,23 +60,23 @@ <span class="keyword">typedef</span> <span class="identifier">see_documentation</span> <a class="link" href="allocator_traits/portable_rebind_alloc.html#boost.container.allocator_traits.portable_rebind_alloc.type"><span class="identifier">type</span></a><span class="special">;</span> <span class="special">}</span><span class="special">;</span> - <span class="comment">// <a class="link" href="allocator_traits.html#idp42242448-bb">public static functions</a></span> - <span class="keyword">static</span> <span class="identifier">pointer</span> <a class="link" href="allocator_traits.html#idp42243008-bb"><span class="identifier">allocate</span></a><span class="special">(</span><span class="identifier">Allocator</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">static</span> <span class="keyword">void</span> <a class="link" href="allocator_traits.html#idp42246928-bb"><span class="identifier">deallocate</span></a><span class="special">(</span><span class="identifier">Allocator</span> <span class="special">&</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> - <span class="keyword">static</span> <span class="identifier">pointer</span> <a class="link" href="allocator_traits.html#idp42252224-bb"><span class="identifier">allocate</span></a><span class="special">(</span><span class="identifier">Allocator</span> <span class="special">&</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> - <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">static</span> <span class="keyword">void</span> <a class="link" href="allocator_traits.html#idp42257312-bb"><span class="identifier">destroy</span></a><span class="special">(</span><span class="identifier">Allocator</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">T</span> <span class="special">*</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> - <span class="keyword">static</span> <span class="identifier">size_type</span> <a class="link" href="allocator_traits.html#idp42262832-bb"><span class="identifier">max_size</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Allocator</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> - <span class="keyword">static</span> <span class="identifier">Allocator</span> <a class="link" href="allocator_traits.html#idp42266832-bb"><span class="identifier">select_on_container_copy_construction</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Allocator</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="allocator_traits.html#idp46816768-bb">public static functions</a></span> + <span class="keyword">static</span> <span class="identifier">pointer</span> <a class="link" href="allocator_traits.html#idp46817328-bb"><span class="identifier">allocate</span></a><span class="special">(</span><span class="identifier">Allocator</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">static</span> <span class="keyword">void</span> <a class="link" href="allocator_traits.html#idp46821248-bb"><span class="identifier">deallocate</span></a><span class="special">(</span><span class="identifier">Allocator</span> <span class="special">&</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> + <span class="keyword">static</span> <span class="identifier">pointer</span> <a class="link" href="allocator_traits.html#idp46826544-bb"><span class="identifier">allocate</span></a><span class="special">(</span><span class="identifier">Allocator</span> <span class="special">&</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> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">static</span> <span class="keyword">void</span> <a class="link" href="allocator_traits.html#idp46831632-bb"><span class="identifier">destroy</span></a><span class="special">(</span><span class="identifier">Allocator</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">T</span> <span class="special">*</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <span class="keyword">static</span> <span class="identifier">size_type</span> <a class="link" href="allocator_traits.html#idp46837152-bb"><span class="identifier">max_size</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Allocator</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <span class="keyword">static</span> <span class="identifier">Allocator</span> <a class="link" href="allocator_traits.html#idp46841152-bb"><span class="identifier">select_on_container_copy_construction</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Allocator</span> <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="keyword">class</span><span class="special">...</span> Args<span class="special">></span> - <span class="keyword">static</span> <span class="keyword">void</span> <a class="link" href="allocator_traits.html#idp42270144-bb"><span class="identifier">construct</span></a><span class="special">(</span><span class="identifier">Allocator</span> <span class="special">&</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">&&</span><span class="special">...</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="allocator_traits.html#idp42277008-bb"><span class="identifier">storage_is_unpropagable</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Allocator</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">pointer</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> - <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="allocator_traits.html#idp42281696-bb"><span class="identifier">equal</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Allocator</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Allocator</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <span class="keyword">static</span> <span class="keyword">void</span> <a class="link" href="allocator_traits.html#idp46844464-bb"><span class="identifier">construct</span></a><span class="special">(</span><span class="identifier">Allocator</span> <span class="special">&</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">&&</span><span class="special">...</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="allocator_traits.html#idp46851328-bb"><span class="identifier">storage_is_unpropagable</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Allocator</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">pointer</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="allocator_traits.html#idp46856016-bb"><span class="identifier">equal</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Allocator</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Allocator</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp272002512"></a><h2>Description</h2> +<a name="idp175726848"></a><h2>Description</h2> <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> <div class="refsect2"> -<a name="idp272004240"></a><h3> +<a name="idp175728576"></a><h3> <a name="boost.container.allocator_traitstypes"></a><code class="computeroutput">allocator_traits</code> public types</h3> @@ -123,17 +123,17 @@ </li> <li class="listitem"> <p> -<span class="keyword">typedef</span> <span class="identifier">see_documentation</span> <a name="boost.container.allocator_traits.propagate_on_c_idp42225872"></a><span class="identifier">propagate_on_container_copy_assignment</span><span class="special">;</span></p> +<span class="keyword">typedef</span> <span class="identifier">see_documentation</span> <a name="boost.container.allocator_traits.propagate_on_c_idp46800192"></a><span class="identifier">propagate_on_container_copy_assignment</span><span class="special">;</span></p> <p>Allocator::propagate_on_container_copy_assignment if such a type exists, otherwise a type with an internal constant static boolean member <code class="computeroutput">value</code> == false. </p> </li> <li class="listitem"> <p> -<span class="keyword">typedef</span> <span class="identifier">see_documentation</span> <a name="boost.container.allocator_traits.propagate_on_c_idp42227728"></a><span class="identifier">propagate_on_container_move_assignment</span><span class="special">;</span></p> +<span class="keyword">typedef</span> <span class="identifier">see_documentation</span> <a name="boost.container.allocator_traits.propagate_on_c_idp46802048"></a><span class="identifier">propagate_on_container_move_assignment</span><span class="special">;</span></p> <p>Allocator::propagate_on_container_move_assignment if such a type exists, otherwise a type with an internal constant static boolean member <code class="computeroutput">value</code> == false. </p> </li> <li class="listitem"> <p> -<span class="keyword">typedef</span> <span class="identifier">see_documentation</span> <a name="boost.container.allocator_traits.propagate_on_c_idp42229584"></a><span class="identifier">propagate_on_container_swap</span><span class="special">;</span></p> +<span class="keyword">typedef</span> <span class="identifier">see_documentation</span> <a name="boost.container.allocator_traits.propagate_on_c_idp46803904"></a><span class="identifier">propagate_on_container_swap</span><span class="special">;</span></p> <p>Allocator::propagate_on_container_swap if such a type exists, otherwise a type with an internal constant static boolean member <code class="computeroutput">value</code> == false. </p> </li> <li class="listitem"> @@ -160,45 +160,45 @@ </ol></div> </div> <div class="refsect2"> -<a name="idp272078544"></a><h3> -<a name="idp42242448-bb"></a><code class="computeroutput">allocator_traits</code> public static functions</h3> +<a name="idp175803216"></a><h3> +<a name="idp46816768-bb"></a><code class="computeroutput">allocator_traits</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">pointer</span> <a name="idp42243008-bb"></a><span class="identifier">allocate</span><span class="special">(</span><span class="identifier">Allocator</span> <span class="special">&</span> a<span class="special">,</span> <span class="identifier">size_type</span> n<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">pointer</span> <a name="idp46817328-bb"></a><span class="identifier">allocate</span><span class="special">(</span><span class="identifier">Allocator</span> <span class="special">&</span> a<span class="special">,</span> <span class="identifier">size_type</span> n<span class="special">)</span><span class="special">;</span></pre> <p><span class="bold"><strong>Returns</strong></span>: <code class="computeroutput">a.allocate(n)</code> </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">void</span> <a name="idp42246928-bb"></a><span class="identifier">deallocate</span><span class="special">(</span><span class="identifier">Allocator</span> <span class="special">&</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> +<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">void</span> <a name="idp46821248-bb"></a><span class="identifier">deallocate</span><span class="special">(</span><span class="identifier">Allocator</span> <span class="special">&</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> <p><span class="bold"><strong>Returns</strong></span>: <code class="computeroutput">a.deallocate(p, n)</code></p> <p><span class="bold"><strong>Throws</strong></span>: Nothing </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">pointer</span> <a name="idp42252224-bb"></a><span class="identifier">allocate</span><span class="special">(</span><span class="identifier">Allocator</span> <span class="special">&</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> +<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">pointer</span> <a name="idp46826544-bb"></a><span class="identifier">allocate</span><span class="special">(</span><span class="identifier">Allocator</span> <span class="special">&</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> <p><span class="bold"><strong>Effects</strong></span>: calls <code class="computeroutput">a.allocate(n, p)</code> if that call is well-formed; otherwise, invokes <code class="computeroutput">a.allocate(n)</code> </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="keyword">static</span> <span class="keyword">void</span> <a name="idp42257312-bb"></a><span class="identifier">destroy</span><span class="special">(</span><span class="identifier">Allocator</span> <span class="special">&</span> a<span class="special">,</span> <span class="identifier">T</span> <span class="special">*</span> p<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">static</span> <span class="keyword">void</span> <a name="idp46831632-bb"></a><span class="identifier">destroy</span><span class="special">(</span><span class="identifier">Allocator</span> <span class="special">&</span> a<span class="special">,</span> <span class="identifier">T</span> <span class="special">*</span> p<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> <p><span class="bold"><strong>Effects</strong></span>: calls <code class="computeroutput">a.destroy(p)</code> if that call is well-formed; otherwise, invokes <code class="computeroutput">p->~T()</code>. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">size_type</span> <a name="idp42262832-bb"></a><span class="identifier">max_size</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Allocator</span> <span class="special">&</span> a<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">size_type</span> <a name="idp46837152-bb"></a><span class="identifier">max_size</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Allocator</span> <span class="special">&</span> a<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> <p><span class="bold"><strong>Returns</strong></span>: <code class="computeroutput">a.max_size()</code> if that expression is well-formed; otherwise, <code class="computeroutput">numeric_limits<size_type>::max()</code>. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">Allocator</span> <a name="idp42266832-bb"></a><span class="identifier">select_on_container_copy_construction</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Allocator</span> <span class="special">&</span> a<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">Allocator</span> <a name="idp46841152-bb"></a><span class="identifier">select_on_container_copy_construction</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Allocator</span> <span class="special">&</span> a<span class="special">)</span><span class="special">;</span></pre> <p><span class="bold"><strong>Returns</strong></span>: <code class="computeroutput">a.select_on_container_copy_construction()</code> if that expression is well-formed; otherwise, a. </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="keyword">class</span><span class="special">...</span> Args<span class="special">></span> - <span class="keyword">static</span> <span class="keyword">void</span> <a name="idp42270144-bb"></a><span class="identifier">construct</span><span class="special">(</span><span class="identifier">Allocator</span> <span class="special">&</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">&&</span><span class="special">...</span> args<span class="special">)</span><span class="special">;</span></pre> + <span class="keyword">static</span> <span class="keyword">void</span> <a name="idp46844464-bb"></a><span class="identifier">construct</span><span class="special">(</span><span class="identifier">Allocator</span> <span class="special">&</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">&&</span><span class="special">...</span> args<span class="special">)</span><span class="special">;</span></pre> <p><span class="bold"><strong>Effects</strong></span>: calls <code class="computeroutput">a.construct(p, std::forward<Args>(args)...)</code> if that call is well-formed; otherwise, invokes <code class="computeroutput">::new (static_cast<void*>(p)) T(std::forward<Args>(args)...)</code> </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idp42277008-bb"></a><span class="identifier">storage_is_unpropagable</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Allocator</span> <span class="special">&</span> a<span class="special">,</span> <span class="identifier">pointer</span> p<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idp46851328-bb"></a><span class="identifier">storage_is_unpropagable</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Allocator</span> <span class="special">&</span> a<span class="special">,</span> <span class="identifier">pointer</span> p<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> <p><span class="bold"><strong>Returns</strong></span>: <code class="computeroutput">a.storage_is_unpropagable(p)</code> if is_partially_propagable::value is true; otherwise, <code class="computeroutput">false</code>. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idp42281696-bb"></a><span class="identifier">equal</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Allocator</span> <span class="special">&</span> a<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Allocator</span> <span class="special">&</span> b<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idp46856016-bb"></a><span class="identifier">equal</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Allocator</span> <span class="special">&</span> a<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Allocator</span> <span class="special">&</span> b<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> <p><span class="bold"><strong>Returns</strong></span>: <code class="computeroutput">true</code> if <code class="computeroutput">is_always_equal::value == true</code>, otherwise, <code class="computeroutput">a == b</code>. </p> </li> </ol></div> |