diff options
Diffstat (limited to 'doc/html/boost/container/pmr/resource_adaptor_imp.html')
| -rw-r--r-- | doc/html/boost/container/pmr/resource_adaptor_imp.html | 64 |
1 files changed, 32 insertions, 32 deletions
diff --git a/doc/html/boost/container/pmr/resource_adaptor_imp.html b/doc/html/boost/container/pmr/resource_adaptor_imp.html index 11a987fdac..6a4ddd5144 100644 --- a/doc/html/boost/container/pmr/resource_adaptor_imp.html +++ b/doc/html/boost/container/pmr/resource_adaptor_imp.html @@ -39,25 +39,25 @@ <span class="keyword">typedef</span> <span class="identifier">Allocator</span> <a name="boost.container.pmr.resource_adaptor_imp.allocator_type"></a><span class="identifier">allocator_type</span><span class="special">;</span> <span class="comment">// <a class="link" href="resource_adaptor_imp.html#boost.container.pmr.resource_adaptor_impconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="resource_adaptor_imp.html#idp32111312-bb"><span class="identifier">resource_adaptor_imp</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="resource_adaptor_imp.html#idp32112592-bb"><span class="identifier">resource_adaptor_imp</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="resource_adaptor_imp.html" title="Class template resource_adaptor_imp">resource_adaptor_imp</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="resource_adaptor_imp.html#idp32115008-bb"><span class="identifier">resource_adaptor_imp</span></a><span class="special">(</span><a class="link" href="resource_adaptor_imp.html" title="Class template resource_adaptor_imp">resource_adaptor_imp</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">explicit</span> <a class="link" href="resource_adaptor_imp.html#idp32117264-bb"><span class="identifier">resource_adaptor_imp</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">explicit</span> <a class="link" href="resource_adaptor_imp.html#idp32119504-bb"><span class="identifier">resource_adaptor_imp</span></a><span class="special">(</span><span class="identifier">Allocator</span> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="resource_adaptor_imp.html" title="Class template resource_adaptor_imp">resource_adaptor_imp</a> <span class="special">&</span> <a class="link" href="resource_adaptor_imp.html#idp32121744-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="resource_adaptor_imp.html" title="Class template resource_adaptor_imp">resource_adaptor_imp</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="resource_adaptor_imp.html" title="Class template resource_adaptor_imp">resource_adaptor_imp</a> <span class="special">&</span> <a class="link" href="resource_adaptor_imp.html#idp32124736-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="resource_adaptor_imp.html" title="Class template resource_adaptor_imp">resource_adaptor_imp</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="resource_adaptor_imp.html#idp42109856-bb"><span class="identifier">resource_adaptor_imp</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="resource_adaptor_imp.html#idp42111136-bb"><span class="identifier">resource_adaptor_imp</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="resource_adaptor_imp.html" title="Class template resource_adaptor_imp">resource_adaptor_imp</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="resource_adaptor_imp.html#idp42113552-bb"><span class="identifier">resource_adaptor_imp</span></a><span class="special">(</span><a class="link" href="resource_adaptor_imp.html" title="Class template resource_adaptor_imp">resource_adaptor_imp</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">explicit</span> <a class="link" href="resource_adaptor_imp.html#idp42115808-bb"><span class="identifier">resource_adaptor_imp</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">explicit</span> <a class="link" href="resource_adaptor_imp.html#idp42118048-bb"><span class="identifier">resource_adaptor_imp</span></a><span class="special">(</span><span class="identifier">Allocator</span> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="resource_adaptor_imp.html" title="Class template resource_adaptor_imp">resource_adaptor_imp</a> <span class="special">&</span> <a class="link" href="resource_adaptor_imp.html#idp42120288-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="resource_adaptor_imp.html" title="Class template resource_adaptor_imp">resource_adaptor_imp</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="resource_adaptor_imp.html" title="Class template resource_adaptor_imp">resource_adaptor_imp</a> <span class="special">&</span> <a class="link" href="resource_adaptor_imp.html#idp42123280-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="resource_adaptor_imp.html" title="Class template resource_adaptor_imp">resource_adaptor_imp</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="resource_adaptor_imp.html#idp32106928-bb">public member functions</a></span> - <span class="identifier">allocator_type</span> <span class="special">&</span> <a class="link" href="resource_adaptor_imp.html#idp32107488-bb"><span class="identifier">get_allocator</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">const</span> <span class="identifier">allocator_type</span> <span class="special">&</span> <a class="link" href="resource_adaptor_imp.html#idp32109184-bb"><span class="identifier">get_allocator</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="resource_adaptor_imp.html#idp42105472-bb">public member functions</a></span> + <span class="identifier">allocator_type</span> <span class="special">&</span> <a class="link" href="resource_adaptor_imp.html#idp42106032-bb"><span class="identifier">get_allocator</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">const</span> <span class="identifier">allocator_type</span> <span class="special">&</span> <a class="link" href="resource_adaptor_imp.html#idp42107728-bb"><span class="identifier">get_allocator</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="resource_adaptor_imp.html#idp32127568-bb">protected member functions</a></span> - <span class="keyword">virtual</span> <span class="keyword">void</span> <span class="special">*</span> <a class="link" href="resource_adaptor_imp.html#idp32128144-bb"><span class="identifier">do_allocate</span></a><span class="special">(</span><span class="identifier">size_t</span><span class="special">,</span> <span class="identifier">size_t</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="resource_adaptor_imp.html#idp32132496-bb"><span class="identifier">do_deallocate</span></a><span class="special">(</span><span class="keyword">void</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">size_t</span><span class="special">,</span> <span class="identifier">size_t</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="resource_adaptor_imp.html#idp32137632-bb"><span class="identifier">do_is_equal</span></a><span class="special">(</span><span class="keyword">const</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="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> + <span class="comment">// <a class="link" href="resource_adaptor_imp.html#idp42126112-bb">protected member functions</a></span> + <span class="keyword">virtual</span> <span class="keyword">void</span> <span class="special">*</span> <a class="link" href="resource_adaptor_imp.html#idp42126688-bb"><span class="identifier">do_allocate</span></a><span class="special">(</span><span class="identifier">size_t</span><span class="special">,</span> <span class="identifier">size_t</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="resource_adaptor_imp.html#idp42131040-bb"><span class="identifier">do_deallocate</span></a><span class="special">(</span><span class="keyword">void</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">size_t</span><span class="special">,</span> <span class="identifier">size_t</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="resource_adaptor_imp.html#idp42136176-bb"><span class="identifier">do_is_equal</span></a><span class="special">(</span><span class="keyword">const</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="keyword">const</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="idp168206944"></a><h2>Description</h2> +<a name="idp187032304"></a><h2>Description</h2> <p>An instance of resource_adaptor<Allocator> is an adaptor that wraps a <a class="link" href="memory_resource.html" title="Class memory_resource">memory_resource</a> interface around Allocator. In order that resource_adaptor<X<T>> and resource_adaptor<X<U>> are the same type for any allocator template X and types T and U, resource_adaptor<Allocator> is rendered as an alias to this class template such that Allocator is rebound to a char value type in every specialization of the class template. The requirements on this class template are defined below. In addition to the Allocator requirements, the parameter to resource_adaptor shall meet the following additional requirements:</p> <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> <li class="listitem"><p><code class="computeroutput">typename <a class="link" href="../allocator_traits.html" title="Struct template allocator_traits">allocator_traits</a><Allocator>:: pointer</code> shall be identical to <code class="computeroutput">typename <a class="link" href="../allocator_traits.html" title="Struct template allocator_traits">allocator_traits</a><Allocator>:: value_type*</code>.</p></li> @@ -68,68 +68,68 @@ <p> </p> <div class="refsect2"> -<a name="idp168222752"></a><h3> +<a name="idp187048224"></a><h3> <a name="boost.container.pmr.resource_adaptor_impconstruct-copy-destruct"></a><code class="computeroutput">resource_adaptor_imp</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp32111312-bb"></a><span class="identifier">resource_adaptor_imp</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp42109856-bb"></a><span class="identifier">resource_adaptor_imp</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p><span class="bold"><strong>Effects</strong></span>: Default constructs m_alloc. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp32112592-bb"></a><span class="identifier">resource_adaptor_imp</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="resource_adaptor_imp.html" title="Class template resource_adaptor_imp">resource_adaptor_imp</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp42111136-bb"></a><span class="identifier">resource_adaptor_imp</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="resource_adaptor_imp.html" title="Class template resource_adaptor_imp">resource_adaptor_imp</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> <p><span class="bold"><strong>Effects</strong></span>: Copy constructs m_alloc. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp32115008-bb"></a><span class="identifier">resource_adaptor_imp</span><span class="special">(</span><a class="link" href="resource_adaptor_imp.html" title="Class template resource_adaptor_imp">resource_adaptor_imp</a> <span class="special">&&</span> other<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp42113552-bb"></a><span class="identifier">resource_adaptor_imp</span><span class="special">(</span><a class="link" href="resource_adaptor_imp.html" title="Class template resource_adaptor_imp">resource_adaptor_imp</a> <span class="special">&&</span> other<span class="special">)</span><span class="special">;</span></pre> <p><span class="bold"><strong>Effects</strong></span>: Move constructs m_alloc. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp32117264-bb"></a><span class="identifier">resource_adaptor_imp</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Allocator</span> <span class="special">&</span> a2<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp42115808-bb"></a><span class="identifier">resource_adaptor_imp</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Allocator</span> <span class="special">&</span> a2<span class="special">)</span><span class="special">;</span></pre> <p><span class="bold"><strong>Effects</strong></span>: Initializes m_alloc with a2. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp32119504-bb"></a><span class="identifier">resource_adaptor_imp</span><span class="special">(</span><span class="identifier">Allocator</span> <span class="special">&&</span> a2<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp42118048-bb"></a><span class="identifier">resource_adaptor_imp</span><span class="special">(</span><span class="identifier">Allocator</span> <span class="special">&&</span> a2<span class="special">)</span><span class="special">;</span></pre> <p><span class="bold"><strong>Effects</strong></span>: Initializes m_alloc with a2. </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="resource_adaptor_imp.html" title="Class template resource_adaptor_imp">resource_adaptor_imp</a> <span class="special">&</span> <a name="idp32121744-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="resource_adaptor_imp.html" title="Class template resource_adaptor_imp">resource_adaptor_imp</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="resource_adaptor_imp.html" title="Class template resource_adaptor_imp">resource_adaptor_imp</a> <span class="special">&</span> <a name="idp42120288-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="resource_adaptor_imp.html" title="Class template resource_adaptor_imp">resource_adaptor_imp</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> <p><span class="bold"><strong>Effects</strong></span>: Copy assigns m_alloc. </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="resource_adaptor_imp.html" title="Class template resource_adaptor_imp">resource_adaptor_imp</a> <span class="special">&</span> <a name="idp32124736-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="resource_adaptor_imp.html" title="Class template resource_adaptor_imp">resource_adaptor_imp</a> <span class="special">&&</span> other<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="resource_adaptor_imp.html" title="Class template resource_adaptor_imp">resource_adaptor_imp</a> <span class="special">&</span> <a name="idp42123280-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="resource_adaptor_imp.html" title="Class template resource_adaptor_imp">resource_adaptor_imp</a> <span class="special">&&</span> other<span class="special">)</span><span class="special">;</span></pre> <p><span class="bold"><strong>Effects</strong></span>: Move assigns m_alloc. </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp168273280"></a><h3> -<a name="idp32106928-bb"></a><code class="computeroutput">resource_adaptor_imp</code> public member functions</h3> +<a name="idp187098496"></a><h3> +<a name="idp42105472-bb"></a><code class="computeroutput">resource_adaptor_imp</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="identifier">allocator_type</span> <span class="special">&</span> <a name="idp32107488-bb"></a><span class="identifier">get_allocator</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">allocator_type</span> <span class="special">&</span> <a name="idp42106032-bb"></a><span class="identifier">get_allocator</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <span class="bold"><strong>Effects</strong></span>: Returns m_alloc. </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">allocator_type</span> <span class="special">&</span> <a name="idp32109184-bb"></a><span class="identifier">get_allocator</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">allocator_type</span> <span class="special">&</span> <a name="idp42107728-bb"></a><span class="identifier">get_allocator</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <span class="bold"><strong>Effects</strong></span>: Returns m_alloc. </li> </ol></div> </div> <div class="refsect2"> -<a name="idp168288208"></a><h3> -<a name="idp32127568-bb"></a><code class="computeroutput">resource_adaptor_imp</code> protected member functions</h3> +<a name="idp187113488"></a><h3> +<a name="idp42126112-bb"></a><code class="computeroutput">resource_adaptor_imp</code> protected member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <span class="special">*</span> <a name="idp32128144-bb"></a><span class="identifier">do_allocate</span><span class="special">(</span><span class="identifier">size_t</span> bytes<span class="special">,</span> <span class="identifier">size_t</span> alignment<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <span class="special">*</span> <a name="idp42126688-bb"></a><span class="identifier">do_allocate</span><span class="special">(</span><span class="identifier">size_t</span> bytes<span class="special">,</span> <span class="identifier">size_t</span> alignment<span class="special">)</span><span class="special">;</span></pre> <p><span class="bold"><strong>Returns</strong></span>: Allocated memory obtained by calling m_alloc.allocate. The size and alignment of the allocated memory shall meet the requirements for a class derived from <code class="computeroutput"><a class="link" href="memory_resource.html" title="Class memory_resource">memory_resource</a></code>. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idp32132496-bb"></a><span class="identifier">do_deallocate</span><span class="special">(</span><span class="keyword">void</span> <span class="special">*</span> p<span class="special">,</span> <span class="identifier">size_t</span> bytes<span class="special">,</span> <span class="identifier">size_t</span> alignment<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idp42131040-bb"></a><span class="identifier">do_deallocate</span><span class="special">(</span><span class="keyword">void</span> <span class="special">*</span> p<span class="special">,</span> <span class="identifier">size_t</span> bytes<span class="special">,</span> <span class="identifier">size_t</span> alignment<span class="special">)</span><span class="special">;</span></pre> <p><span class="bold"><strong>Requires</strong></span>: p was previously allocated using A.allocate, where A == m_alloc, and not subsequently deallocated.</p> <p><span class="bold"><strong>Effects</strong></span>: Returns memory to the allocator using m_alloc.deallocate(). </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">bool</span> <a name="idp32137632-bb"></a><span class="identifier">do_is_equal</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="memory_resource.html" title="Class memory_resource">memory_resource</a> <span class="special">&</span> other<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">bool</span> <a name="idp42136176-bb"></a><span class="identifier">do_is_equal</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="memory_resource.html" title="Class memory_resource">memory_resource</a> <span class="special">&</span> other<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> <p>Let p be dynamic_cast<const resource_adaptor_imp*>(&other).</p> <p><span class="bold"><strong>Returns</strong></span>: false if p is null, otherwise the value of m_alloc == p->m_alloc. </p> </li> |