Imported Upstream version 1.72.0
[platform/upstream/boost.git] / doc / html / boost / container / pmr / polymorphic_allocator.html
index 94a4406..71add6a 100644 (file)
   <span class="keyword">typedef</span> <span class="identifier">T</span> <a name="boost.container.pmr.polymorphic_allocator.value_type"></a><span class="identifier">value_type</span><span class="special">;</span>
 
   <span class="comment">// <a class="link" href="polymorphic_allocator.html#boost.container.pmr.polymorphic_allocatorconstruct-copy-destruct">construct/copy/destruct</a></span>
-  <a class="link" href="polymorphic_allocator.html#idm45836568286784-bb"><span class="identifier">polymorphic_allocator</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
-  <a class="link" href="polymorphic_allocator.html#idm45836568284800-bb"><span class="identifier">polymorphic_allocator</span></a><span class="special">(</span><a class="link" href="memory_resource.html" title="Class memory_resource">memory_resource</a> <span class="special">*</span><span class="special">)</span><span class="special">;</span>
-  <a class="link" href="polymorphic_allocator.html#idm45836568279872-bb"><span class="identifier">polymorphic_allocator</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
+  <a class="link" href="polymorphic_allocator.html#idm45666069933680-bb"><span class="identifier">polymorphic_allocator</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
+  <a class="link" href="polymorphic_allocator.html#idm45666069931696-bb"><span class="identifier">polymorphic_allocator</span></a><span class="special">(</span><a class="link" href="memory_resource.html" title="Class memory_resource">memory_resource</a> <span class="special">*</span><span class="special">)</span><span class="special">;</span>
+  <a class="link" href="polymorphic_allocator.html#idm45666069926768-bb"><span class="identifier">polymorphic_allocator</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> U<span class="special">&gt;</span> 
-    <a class="link" href="polymorphic_allocator.html#idm45836568277456-bb"><span class="identifier">polymorphic_allocator</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a><span class="special">&lt;</span> <span class="identifier">U</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
-  <a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a> <span class="special">&amp;</span> <a class="link" href="polymorphic_allocator.html#idm45836568273920-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
+    <a class="link" href="polymorphic_allocator.html#idm45666069924352-bb"><span class="identifier">polymorphic_allocator</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a><span class="special">&lt;</span> <span class="identifier">U</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
+  <a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a> <span class="special">&amp;</span> <a class="link" href="polymorphic_allocator.html#idm45666069920816-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
 
-  <span class="comment">// <a class="link" href="polymorphic_allocator.html#idm45836568313104-bb">public member functions</a></span>
-  <span class="identifier">T</span> <span class="special">*</span> <a class="link" href="polymorphic_allocator.html#idm45836568312544-bb"><span class="identifier">allocate</span></a><span class="special">(</span><span class="identifier">size_t</span><span class="special">)</span><span class="special">;</span>
-  <span class="keyword">void</span> <a class="link" href="polymorphic_allocator.html#idm45836568309536-bb"><span class="identifier">deallocate</span></a><span class="special">(</span><span class="identifier">T</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">size_t</span><span class="special">)</span><span class="special">;</span>
-  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> U<span class="special">,</span> <span class="keyword">class</span> <span class="special">...</span> Args<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="polymorphic_allocator.html#idm45836568304064-bb"><span class="identifier">construct</span></a><span class="special">(</span><span class="identifier">U</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>
-  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> U<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="polymorphic_allocator.html#idm45836568295376-bb"><span class="identifier">destroy</span></a><span class="special">(</span><span class="identifier">U</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span>
-  <a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a> <a class="link" href="polymorphic_allocator.html#idm45836568292016-bb"><span class="identifier">select_on_container_copy_construction</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
-  <a class="link" href="memory_resource.html" title="Class memory_resource">memory_resource</a> <span class="special">*</span> <a class="link" href="polymorphic_allocator.html#idm45836568289328-bb"><span class="identifier">resource</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+  <span class="comment">// <a class="link" href="polymorphic_allocator.html#idm45666069960000-bb">public member functions</a></span>
+  <span class="identifier">T</span> <span class="special">*</span> <a class="link" href="polymorphic_allocator.html#idm45666069959440-bb"><span class="identifier">allocate</span></a><span class="special">(</span><span class="identifier">size_t</span><span class="special">)</span><span class="special">;</span>
+  <span class="keyword">void</span> <a class="link" href="polymorphic_allocator.html#idm45666069956432-bb"><span class="identifier">deallocate</span></a><span class="special">(</span><span class="identifier">T</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">size_t</span><span class="special">)</span><span class="special">;</span>
+  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> U<span class="special">,</span> <span class="keyword">class</span> <span class="special">...</span> Args<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="polymorphic_allocator.html#idm45666069950960-bb"><span class="identifier">construct</span></a><span class="special">(</span><span class="identifier">U</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>
+  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> U<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="polymorphic_allocator.html#idm45666069942272-bb"><span class="identifier">destroy</span></a><span class="special">(</span><span class="identifier">U</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span>
+  <a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a> <a class="link" href="polymorphic_allocator.html#idm45666069938912-bb"><span class="identifier">select_on_container_copy_construction</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+  <a class="link" href="memory_resource.html" title="Class memory_resource">memory_resource</a> <span class="special">*</span> <a class="link" href="polymorphic_allocator.html#idm45666069936224-bb"><span class="identifier">resource</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</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.23.3.4"></a><h2>Description</h2>
        construct/copy/destruct</h3>
 <div class="orderedlist"><ol class="orderedlist" type="1">
 <li class="listitem">
-<pre class="literallayout"><a name="idm45836568286784-bb"></a><span class="identifier">polymorphic_allocator</span><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
+<pre class="literallayout"><a name="idm45666069933680-bb"></a><span class="identifier">polymorphic_allocator</span><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
 <p><span class="bold"><strong>Effects</strong></span>: Sets m_resource to <code class="computeroutput">get_default_resource()</code>. </p>
 </li>
 <li class="listitem">
-<pre class="literallayout"><a name="idm45836568284800-bb"></a><span class="identifier">polymorphic_allocator</span><span class="special">(</span><a class="link" href="memory_resource.html" title="Class memory_resource">memory_resource</a> <span class="special">*</span> r<span class="special">)</span><span class="special">;</span></pre>
+<pre class="literallayout"><a name="idm45666069931696-bb"></a><span class="identifier">polymorphic_allocator</span><span class="special">(</span><a class="link" href="memory_resource.html" title="Class memory_resource">memory_resource</a> <span class="special">*</span> r<span class="special">)</span><span class="special">;</span></pre>
 <p><span class="bold"><strong>Requires</strong></span>: r is non-null.</p>
 <p><span class="bold"><strong>Effects</strong></span>: Sets m_resource to r.</p>
 <p><span class="bold"><strong>Throws</strong></span>: Nothing</p>
 <p><span class="bold"><strong>Notes</strong></span>: This constructor provides an implicit conversion from memory_resource*. Non-standard extension: if r is null m_resource is set to get_default_resource(). </p>
 </li>
 <li class="listitem">
-<pre class="literallayout"><a name="idm45836568279872-bb"></a><span class="identifier">polymorphic_allocator</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a> <span class="special">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre>
+<pre class="literallayout"><a name="idm45666069926768-bb"></a><span class="identifier">polymorphic_allocator</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a> <span class="special">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre>
 <p><span class="bold"><strong>Effects</strong></span>: Sets m_resource to other.resource(). </p>
 </li>
 <li class="listitem">
 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> U<span class="special">&gt;</span> 
-  <a name="idm45836568277456-bb"></a><span class="identifier">polymorphic_allocator</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a><span class="special">&lt;</span> <span class="identifier">U</span> <span class="special">&gt;</span> <span class="special">&amp;</span> other<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
+  <a name="idm45666069924352-bb"></a><span class="identifier">polymorphic_allocator</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a><span class="special">&lt;</span> <span class="identifier">U</span> <span class="special">&gt;</span> <span class="special">&amp;</span> other<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
 <p><span class="bold"><strong>Effects</strong></span>: Sets m_resource to other.resource(). </p>
 </li>
 <li class="listitem">
-<pre class="literallayout"><a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a> <span class="special">&amp;</span> <a name="idm45836568273920-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a> <span class="special">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre>
+<pre class="literallayout"><a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a> <span class="special">&amp;</span> <a name="idm45666069920816-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a> <span class="special">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre>
 <p><span class="bold"><strong>Effects</strong></span>: Sets m_resource to other.resource(). </p>
 </li>
 </ol></div>
 </div>
 <div class="refsect2">
 <a name="id-1.3.10.14.23.3.4.4"></a><h3>
-<a name="idm45836568313104-bb"></a><code class="computeroutput">polymorphic_allocator</code> public member functions</h3>
+<a name="idm45666069960000-bb"></a><code class="computeroutput">polymorphic_allocator</code> public member functions</h3>
 <div class="orderedlist"><ol class="orderedlist" type="1">
 <li class="listitem">
-<pre class="literallayout"><span class="identifier">T</span> <span class="special">*</span> <a name="idm45836568312544-bb"></a><span class="identifier">allocate</span><span class="special">(</span><span class="identifier">size_t</span> n<span class="special">)</span><span class="special">;</span></pre>
+<pre class="literallayout"><span class="identifier">T</span> <span class="special">*</span> <a name="idm45666069959440-bb"></a><span class="identifier">allocate</span><span class="special">(</span><span class="identifier">size_t</span> n<span class="special">)</span><span class="special">;</span></pre>
 <p><span class="bold"><strong>Returns</strong></span>: Equivalent to <code class="computeroutput">static_cast&lt;T*&gt;(m_resource-&gt;allocate(n * sizeof(T), alignof(T)))</code>. </p>
 </li>
 <li class="listitem">
-<pre class="literallayout"><span class="keyword">void</span> <a name="idm45836568309536-bb"></a><span class="identifier">deallocate</span><span class="special">(</span><span class="identifier">T</span> <span class="special">*</span> p<span class="special">,</span> <span class="identifier">size_t</span> n<span class="special">)</span><span class="special">;</span></pre>
+<pre class="literallayout"><span class="keyword">void</span> <a name="idm45666069956432-bb"></a><span class="identifier">deallocate</span><span class="special">(</span><span class="identifier">T</span> <span class="special">*</span> p<span class="special">,</span> <span class="identifier">size_t</span> n<span class="special">)</span><span class="special">;</span></pre>
 <p><span class="bold"><strong>Requires</strong></span>: p was allocated from a memory resource, x, equal to *m_resource, using <code class="computeroutput">x.allocate(n * sizeof(T), alignof(T))</code>.</p>
 <p><span class="bold"><strong>Effects</strong></span>: Equivalent to m_resource-&gt;deallocate(p, n * sizeof(T), alignof(T)).</p>
 <p><span class="bold"><strong>Throws</strong></span>: Nothing. </p>
 </li>
 <li class="listitem">
-<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> U<span class="special">,</span> <span class="keyword">class</span> <span class="special">...</span> Args<span class="special">&gt;</span> <span class="keyword">void</span> <a name="idm45836568304064-bb"></a><span class="identifier">construct</span><span class="special">(</span><span class="identifier">U</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>
+<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> U<span class="special">,</span> <span class="keyword">class</span> <span class="special">...</span> Args<span class="special">&gt;</span> <span class="keyword">void</span> <a name="idm45666069950960-bb"></a><span class="identifier">construct</span><span class="special">(</span><span class="identifier">U</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>
 <p><span class="bold"><strong>Requires</strong></span>: Uses-allocator construction of T with allocator <code class="computeroutput">*this</code> and constructor arguments <code class="computeroutput">std::forward&lt;Args&gt;(args)...</code> is well-formed. [Note: uses-allocator construction is always well formed for types that do not use allocators. - end note]</p>
 <p><span class="bold"><strong>Effects</strong></span>: Construct a T object at p by uses-allocator construction with allocator <code class="computeroutput">*this</code> and constructor arguments <code class="computeroutput">std::forward&lt;Args&gt;(args)...</code>.</p>
 <p><span class="bold"><strong>Throws</strong></span>: Nothing unless the constructor for T throws. </p>
 </li>
 <li class="listitem">
-<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> U<span class="special">&gt;</span> <span class="keyword">void</span> <a name="idm45836568295376-bb"></a><span class="identifier">destroy</span><span class="special">(</span><span class="identifier">U</span> <span class="special">*</span> p<span class="special">)</span><span class="special">;</span></pre>
+<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> U<span class="special">&gt;</span> <span class="keyword">void</span> <a name="idm45666069942272-bb"></a><span class="identifier">destroy</span><span class="special">(</span><span class="identifier">U</span> <span class="special">*</span> p<span class="special">)</span><span class="special">;</span></pre>
 <p><span class="bold"><strong>Effects</strong></span>: p-&gt;~U(). </p>
 </li>
 <li class="listitem">
-<pre class="literallayout"><a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a> <a name="idm45836568292016-bb"></a><span class="identifier">select_on_container_copy_construction</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
+<pre class="literallayout"><a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a> <a name="idm45666069938912-bb"></a><span class="identifier">select_on_container_copy_construction</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 <p><span class="bold"><strong>Returns</strong></span>: Equivalent to <code class="computeroutput">polymorphic_allocator()</code>. </p>
 </li>
 <li class="listitem">
-<pre class="literallayout"><a class="link" href="memory_resource.html" title="Class memory_resource">memory_resource</a> <span class="special">*</span> <a name="idm45836568289328-bb"></a><span class="identifier">resource</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
+<pre class="literallayout"><a class="link" href="memory_resource.html" title="Class memory_resource">memory_resource</a> <span class="special">*</span> <a name="idm45666069936224-bb"></a><span class="identifier">resource</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 <p><span class="bold"><strong>Returns</strong></span>: m_resource. </p>
 </li>
 </ol></div>