diff options
Diffstat (limited to 'doc/html/boost/container/pmr/memory_resource.html')
-rw-r--r-- | doc/html/boost/container/pmr/memory_resource.html | 58 |
1 files changed, 29 insertions, 29 deletions
diff --git a/doc/html/boost/container/pmr/memory_resource.html b/doc/html/boost/container/pmr/memory_resource.html index d75e44269a..e62d75316b 100644 --- a/doc/html/boost/container/pmr/memory_resource.html +++ b/doc/html/boost/container/pmr/memory_resource.html @@ -36,90 +36,90 @@ <span class="keyword">class</span> <a class="link" href="memory_resource.html" title="Class memory_resource">memory_resource</a> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="memory_resource.html#boost.container.pmr.memory_resourceconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="memory_resource.html#idp50726160-bb"><span class="special">~</span><span class="identifier">memory_resource</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="memory_resource.html#idp31901104-bb"><span class="special">~</span><span class="identifier">memory_resource</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="memory_resource.html#idp50713152-bb">public member functions</a></span> - <span class="keyword">void</span> <span class="special">*</span> <a class="link" href="memory_resource.html#idp50713712-bb"><span class="identifier">allocate</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="special">=</span> <span class="identifier">max_align</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="memory_resource.html#idp50717664-bb"><span class="identifier">deallocate</span></a><span class="special">(</span><span class="keyword">void</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="special">=</span> <span class="identifier">max_align</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="memory_resource.html#idp50722304-bb"><span class="identifier">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="memory_resource.html#idp31888096-bb">public member functions</a></span> + <span class="keyword">void</span> <span class="special">*</span> <a class="link" href="memory_resource.html#idp31888656-bb"><span class="identifier">allocate</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="special">=</span> <span class="identifier">max_align</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="memory_resource.html#idp31892608-bb"><span class="identifier">deallocate</span></a><span class="special">(</span><span class="keyword">void</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="special">=</span> <span class="identifier">max_align</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="memory_resource.html#idp31897248-bb"><span class="identifier">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="memory_resource.html#idp50728160-bb">friend functions</a></span> - <span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="memory_resource.html#idp50728720-bb"><span class="keyword">operator</span><span class="special">==</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> <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">noexcept</span><span class="special">;</span> - <span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="memory_resource.html#idp50733552-bb"><span class="keyword">operator</span><span class="special">!=</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> <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">noexcept</span><span class="special">;</span> + <span class="comment">// <a class="link" href="memory_resource.html#idp31903104-bb">friend functions</a></span> + <span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="memory_resource.html#idp31903664-bb"><span class="keyword">operator</span><span class="special">==</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> <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">noexcept</span><span class="special">;</span> + <span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="memory_resource.html#idp31908496-bb"><span class="keyword">operator</span><span class="special">!=</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> <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">noexcept</span><span class="special">;</span> - <span class="comment">// <a class="link" href="memory_resource.html#idp50738080-bb">protected member functions</a></span> - <span class="keyword">virtual</span> <span class="keyword">void</span> <span class="special">*</span> <a class="link" href="memory_resource.html#idp50738656-bb"><span class="identifier">do_allocate</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">)</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="memory_resource.html#idp50744480-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">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">)</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="memory_resource.html#idp50751248-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="special">=</span> <span class="number">0</span><span class="special">;</span> + <span class="comment">// <a class="link" href="memory_resource.html#idp31913024-bb">protected member functions</a></span> + <span class="keyword">virtual</span> <span class="keyword">void</span> <span class="special">*</span> <a class="link" href="memory_resource.html#idp31913600-bb"><span class="identifier">do_allocate</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">)</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> + <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="memory_resource.html#idp31919424-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">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">)</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> + <span class="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="memory_resource.html#idp31926192-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="special">=</span> <span class="number">0</span><span class="special">;</span> <span class="comment">// public data members</span> <span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">max_align</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp191995632"></a><h2>Description</h2> +<a name="idp167284000"></a><h2>Description</h2> <p>The <a class="link" href="memory_resource.html" title="Class memory_resource">memory_resource</a> class is an abstract interface to an unbounded set of classes encapsulating memory resources. </p> <div class="refsect2"> -<a name="idp191997280"></a><h3> +<a name="idp167285648"></a><h3> <a name="boost.container.pmr.memory_resourceconstruct-copy-destruct"></a><code class="computeroutput">memory_resource</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><a name="idp50726160-bb"></a><span class="special">~</span><span class="identifier">memory_resource</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp31901104-bb"></a><span class="special">~</span><span class="identifier">memory_resource</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p><span class="bold"><strong>Effects</strong></span>: Destroys this <code class="computeroutput"><a class="link" href="memory_resource.html" title="Class memory_resource">memory_resource</a></code>. </p> </li></ol></div> </div> <div class="refsect2"> -<a name="idp192005792"></a><h3> -<a name="idp50713152-bb"></a><code class="computeroutput">memory_resource</code> public member functions</h3> +<a name="idp167294304"></a><h3> +<a name="idp31888096-bb"></a><code class="computeroutput">memory_resource</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <span class="special">*</span> <a name="idp50713712-bb"></a><span class="identifier">allocate</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> bytes<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> alignment <span class="special">=</span> <span class="identifier">max_align</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <span class="special">*</span> <a name="idp31888656-bb"></a><span class="identifier">allocate</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> bytes<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> alignment <span class="special">=</span> <span class="identifier">max_align</span><span class="special">)</span><span class="special">;</span></pre> <p><span class="bold"><strong>Effects</strong></span>: Equivalent to <code class="computeroutput">return do_allocate(bytes, alignment);</code> </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp50717664-bb"></a><span class="identifier">deallocate</span><span class="special">(</span><span class="keyword">void</span> <span class="special">*</span> p<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> bytes<span class="special">,</span> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp31892608-bb"></a><span class="identifier">deallocate</span><span class="special">(</span><span class="keyword">void</span> <span class="special">*</span> p<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> bytes<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> alignment <span class="special">=</span> <span class="identifier">max_align</span><span class="special">)</span><span class="special">;</span></pre> <p><span class="bold"><strong>Effects</strong></span>: Equivalent to <code class="computeroutput">return do_deallocate(bytes, alignment);</code> </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp50722304-bb"></a><span class="identifier">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">bool</span> <a name="idp31897248-bb"></a><span class="identifier">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><span class="bold"><strong>Effects</strong></span>: Equivalent to <code class="computeroutput">return return do_is_equal(other);</code> </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp192042640"></a><h3> -<a name="idp50728160-bb"></a><code class="computeroutput">memory_resource</code> friend functions</h3> +<a name="idp167331152"></a><h3> +<a name="idp31903104-bb"></a><code class="computeroutput">memory_resource</code> friend functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="idp50728720-bb"></a><span class="keyword">operator</span><span class="special">==</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> 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> b<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="idp31903664-bb"></a><span class="keyword">operator</span><span class="special">==</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> 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> 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">&a == &b || a.is_equal(b)</code>. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="idp50733552-bb"></a><span class="keyword">operator</span><span class="special">!=</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> 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> b<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="idp31908496-bb"></a><span class="keyword">operator</span><span class="special">!=</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> 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> b<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> <p><span class="bold"><strong>Returns</strong></span>: !(a == b). </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp192069824"></a><h3> -<a name="idp50738080-bb"></a><code class="computeroutput">memory_resource</code> protected member functions</h3> +<a name="idp167358400"></a><h3> +<a name="idp31913024-bb"></a><code class="computeroutput">memory_resource</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="idp50738656-bb"></a><span class="identifier">do_allocate</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> bytes<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> alignment<span class="special">)</span> <span class="special">=</span> <span class="number">0</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="idp31913600-bb"></a><span class="identifier">do_allocate</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> bytes<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> alignment<span class="special">)</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre> <p><span class="bold"><strong>Requires</strong></span>: Alignment shall be a power of two.</p> <p><span class="bold"><strong>Returns</strong></span>: A derived class shall implement this function to return a pointer to allocated storage with a size of at least bytes. The returned storage is aligned to the specified alignment, if such alignment is supported; otherwise it is aligned to max_align.</p> <p><span class="bold"><strong>Throws</strong></span>: A derived class implementation shall throw an appropriate exception if it is unable to allocate memory with the requested size and alignment. </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> -<a name="idp50744480-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">std</span><span class="special">::</span><span class="identifier">size_t</span> bytes<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> alignment<span class="special">)</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre> +<a name="idp31919424-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">std</span><span class="special">::</span><span class="identifier">size_t</span> bytes<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> alignment<span class="special">)</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre> <p><span class="bold"><strong>Requires</strong></span>: p shall have been returned from a prior call to <code class="computeroutput">allocate(bytes, alignment)</code> on a memory resource equal to *this, and the storage at p shall not yet have been deallocated.</p> <p><span class="bold"><strong>Effects</strong></span>: A derived class shall implement this function to dispose of allocated storage.</p> <p><span class="bold"><strong>Throws</strong></span>: Nothing. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">bool</span> <a name="idp50751248-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="special">=</span> <span class="number">0</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">bool</span> <a name="idp31926192-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="special">=</span> <span class="number">0</span><span class="special">;</span></pre> <p><span class="bold"><strong>Returns</strong></span>: A derived class shall implement this function to return true if memory allocated from this can be deallocated from other and vice-versa; otherwise it shall return false. <span class="emphasis"><em>[Note: The most-derived type of other might not match the type of this. For a derived class, D, a typical implementation of this function will compute <code class="computeroutput">dynamic_cast<const D*>(&other)</code> and go no further (i.e., return false) if it returns nullptr. - end note]</em></span>. </p> </li> </ol></div> |