diff options
Diffstat (limited to 'doc/html/boost/container/allocator_traits.html')
-rw-r--r-- | doc/html/boost/container/allocator_traits.html | 52 |
1 files changed, 26 insertions, 26 deletions
diff --git a/doc/html/boost/container/allocator_traits.html b/doc/html/boost/container/allocator_traits.html index e044363386..a395d75581 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.propagat_idm46123647001296"><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.propagat_idm46123646999440"><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.propagat_idm46123646997584"><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.propagat_idm45836573382048"><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.propagat_idm45836573380192"><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.propagat_idm45836573378336"><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,17 +60,17 @@ <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#idm46123646984720-bb">public static functions</a></span> - <span class="keyword">static</span> <span class="identifier">pointer</span> <a class="link" href="allocator_traits.html#idm46123646984160-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#idm46123646980240-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#idm46123646974944-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#idm46123646969856-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#idm46123646964336-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#idm46123646960336-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#idm45836573365472-bb">public static functions</a></span> + <span class="keyword">static</span> <span class="identifier">pointer</span> <a class="link" href="allocator_traits.html#idm45836573364912-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#idm45836573360992-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#idm45836573355696-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#idm45836573350608-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#idm45836573345088-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#idm45836573341088-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#idm46123646957024-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#idm46123646949888-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#idm46123646945200-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#idm45836573337776-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#idm45836573330640-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#idm45836573325952-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="id-1.3.10.14.4.3.4"></a><h2>Description</h2> @@ -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.propagat_idm46123647001296"></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.propagat_idm45836573382048"></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.propagat_idm46123646999440"></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.propagat_idm45836573380192"></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.propagat_idm46123646997584"></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.propagat_idm45836573378336"></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"> @@ -161,44 +161,44 @@ </div> <div class="refsect2"> <a name="id-1.3.10.14.4.3.4.4"></a><h3> -<a name="idm46123646984720-bb"></a><code class="computeroutput">allocator_traits</code> public static functions</h3> +<a name="idm45836573365472-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="idm46123646984160-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="idm45836573364912-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="idm46123646980240-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="idm45836573360992-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="idm46123646974944-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="idm45836573355696-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="idm46123646969856-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="idm45836573350608-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="idm46123646964336-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="idm45836573345088-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="idm46123646960336-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="idm45836573341088-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="idm46123646957024-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="idm45836573337776-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"><code class="computeroutput">placement new</code> (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="idm46123646949888-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="idm45836573330640-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="idm46123646945200-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="idm45836573325952-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> |