diff options
Diffstat (limited to 'doc/html/boost/container/pmr/monotonic_buffer_resource.html')
| -rw-r--r-- | doc/html/boost/container/pmr/monotonic_buffer_resource.html | 126 |
1 files changed, 65 insertions, 61 deletions
diff --git a/doc/html/boost/container/pmr/monotonic_buffer_resource.html b/doc/html/boost/container/pmr/monotonic_buffer_resource.html index 49b33f2390..5e052795cd 100644 --- a/doc/html/boost/container/pmr/monotonic_buffer_resource.html +++ b/doc/html/boost/container/pmr/monotonic_buffer_resource.html @@ -4,7 +4,7 @@ <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> <title>Class monotonic_buffer_resource</title> <link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> <link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../../boost_container_header_reference.html#header.boost.container.pmr.monotonic_buffer_resource_hpp" title="Header <boost/container/pmr/monotonic_buffer_resource.hpp>"> <link rel="prev" href="memory_resource.html" title="Class memory_resource"> @@ -38,134 +38,138 @@ <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="monotonic_buffer_resource.html#boost.container.pmr.monotonic_buffer_resourceconstruct-copy-destruct">construct/copy/destruct</a></span> - <span class="keyword">explicit</span> <a class="link" href="monotonic_buffer_resource.html#idm46583871597024-bb"><span class="identifier">monotonic_buffer_resource</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="number">0</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> - <span class="keyword">explicit</span> <a class="link" href="monotonic_buffer_resource.html#idm46583871590000-bb"><span class="identifier">monotonic_buffer_resource</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> <a class="link" href="memory_resource.html" title="Class memory_resource">memory_resource</a> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> - <a class="link" href="monotonic_buffer_resource.html#idm46583871581232-bb"><span class="identifier">monotonic_buffer_resource</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> <a class="link" href="memory_resource.html" title="Class memory_resource">memory_resource</a> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> - <a class="link" href="monotonic_buffer_resource.html#idm46583871571472-bb"><span class="identifier">monotonic_buffer_resource</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="monotonic_buffer_resource.html" title="Class monotonic_buffer_resource">monotonic_buffer_resource</a> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span> - <a class="link" href="monotonic_buffer_resource.html" title="Class monotonic_buffer_resource">monotonic_buffer_resource</a> - <a class="link" href="monotonic_buffer_resource.html#idm46583871569760-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="monotonic_buffer_resource.html" title="Class monotonic_buffer_resource">monotonic_buffer_resource</a> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span> - <a class="link" href="monotonic_buffer_resource.html#idm46583871567616-bb"><span class="special">~</span><span class="identifier">monotonic_buffer_resource</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">explicit</span> <a class="link" href="monotonic_buffer_resource.html#idp18540880-bb"><span class="identifier">monotonic_buffer_resource</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="number">0</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <span class="keyword">explicit</span> <a class="link" href="monotonic_buffer_resource.html#idp18545072-bb"><span class="identifier">monotonic_buffer_resource</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> <a class="link" href="memory_resource.html" title="Class memory_resource">memory_resource</a> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <a class="link" href="monotonic_buffer_resource.html#idp18549984-bb"><span class="identifier">monotonic_buffer_resource</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> <a class="link" href="memory_resource.html" title="Class memory_resource">memory_resource</a> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <a class="link" href="monotonic_buffer_resource.html#idp18555472-bb"><span class="identifier">monotonic_buffer_resource</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="monotonic_buffer_resource.html" title="Class monotonic_buffer_resource">monotonic_buffer_resource</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="monotonic_buffer_resource.html" title="Class monotonic_buffer_resource">monotonic_buffer_resource</a> <a class="link" href="monotonic_buffer_resource.html#idp18556912-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="monotonic_buffer_resource.html" title="Class monotonic_buffer_resource">monotonic_buffer_resource</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="monotonic_buffer_resource.html#idp18558784-bb"><span class="special">~</span><span class="identifier">monotonic_buffer_resource</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="monotonic_buffer_resource.html#idm46583871617776-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="monotonic_buffer_resource.html#idm46583871617216-bb"><span class="identifier">release</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</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="monotonic_buffer_resource.html#idm46583871614064-bb"><span class="identifier">upstream_resource</span></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="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="monotonic_buffer_resource.html#idm46583871611664-bb"><span class="identifier">remaining_storage</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="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> - <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="monotonic_buffer_resource.html#idm46583871607216-bb"><span class="identifier">remaining_storage</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="number">1u</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> - <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> <a class="link" href="monotonic_buffer_resource.html#idm46583871603232-bb"><span class="identifier">current_buffer</span></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="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="monotonic_buffer_resource.html#idm46583871600224-bb"><span class="identifier">next_buffer_size</span></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="monotonic_buffer_resource.html#idp18520960-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="monotonic_buffer_resource.html#idp18521520-bb"><span class="identifier">release</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</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="monotonic_buffer_resource.html#idp18523840-bb"><span class="identifier">upstream_resource</span></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="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="monotonic_buffer_resource.html#idp18526240-bb"><span class="identifier">remaining_storage</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="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="monotonic_buffer_resource.html#idp18530688-bb"><span class="identifier">remaining_storage</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="number">1u</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> + <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> <a class="link" href="monotonic_buffer_resource.html#idp18534672-bb"><span class="identifier">current_buffer</span></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="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="monotonic_buffer_resource.html#idp18537680-bb"><span class="identifier">next_buffer_size</span></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="monotonic_buffer_resource.html#idm46583871565904-bb">protected member functions</a></span> - <span class="keyword">virtual</span> <span class="keyword">void</span> <span class="special">*</span> <a class="link" href="monotonic_buffer_resource.html#idm46583871565328-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="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="monotonic_buffer_resource.html#idm46583871553904-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="keyword">noexcept</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="monotonic_buffer_resource.html#idm46583871547712-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="monotonic_buffer_resource.html#idp18560064-bb">protected member functions</a></span> + <span class="keyword">virtual</span> <span class="keyword">void</span> <span class="special">*</span> <a class="link" href="monotonic_buffer_resource.html#idp18560640-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="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="monotonic_buffer_resource.html#idp18566560-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="keyword">noexcept</span><span class="special">;</span> + <span class="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="monotonic_buffer_resource.html#idp18572752-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="monotonic_buffer_resource.html#boost.container.pmr.monotonic_buffer_resourcepublic-data-members">public data members</a></span> <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="monotonic_buffer_resource.html#boost.container.pmr.monotonic_buffer_resource.initial_next_buffer_size"><span class="identifier">initial_next_buffer_size</span></a><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idm45555399111712"></a><h2>Description</h2> +<a name="idp85711696"></a><h2>Description</h2> <p>A <a class="link" href="monotonic_buffer_resource.html" title="Class monotonic_buffer_resource">monotonic_buffer_resource</a> is a special-purpose memory resource intended for very fast memory allocations in situations where memory is used to build up a few objects and then is released all at once when the memory resource object is destroyed. It has the following qualities:</p> -<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> -<li class="listitem"><p>A call to deallocate has no effect, thus the amount of memory consumed increases monotonically until the resource is destroyed.</p></li> -<li class="listitem"><p>The program can supply an initial buffer, which the allocator uses to satisfy memory requests.</p></li> -<li class="listitem"><p>When the initial buffer (if any) is exhausted, it obtains additional buffers from an upstream memory resource supplied at construction. Each additional buffer is larger than the previous one, following a geometric progression.</p></li> -<li class="listitem"><p>It is intended for access from one thread of control at a time. Specifically, calls to allocate and deallocate do not synchronize with one another.</p></li> -<li class="listitem"><p>It owns the allocated memory and frees it on destruction, even if deallocate has not been called for some of the allocated blocks. </p></li> -</ul></div> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>A call to deallocate has no effect, thus the amount of memory consumed increases monotonically until the resource is destroyed.</p></li></ul></div> +<p> +</p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>The program can supply an initial buffer, which the allocator uses to satisfy memory requests.</p></li></ul></div> +<p> +</p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>When the initial buffer (if any) is exhausted, it obtains additional buffers from an upstream memory resource supplied at construction. Each additional buffer is larger than the previous one, following a geometric progression.</p></li></ul></div> +<p> +</p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>It is intended for access from one thread of control at a time. Specifically, calls to allocate and deallocate do not synchronize with one another.</p></li></ul></div> +<p> +</p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>It owns the allocated memory and frees it on destruction, even if deallocate has not been called for some of the allocated blocks. </p></li></ul></div> <p> </p> <div class="refsect2"> -<a name="idm45555399106592"></a><h3> +<a name="idp85718864"></a><h3> <a name="boost.container.pmr.monotonic_buffer_resourceconstruct-copy-destruct"></a><code class="computeroutput">monotonic_buffer_resource</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">explicit</span> <a name="idm46583871597024-bb"></a><span class="identifier">monotonic_buffer_resource</span><span class="special">(</span><a class="link" href="memory_resource.html" title="Class memory_resource">memory_resource</a> <span class="special">*</span> upstream <span class="special">=</span> <span class="number">0</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> -<p><span class="bold"><strong>Requires</strong></span>: <code class="computeroutput">upstream</code> shall be the address of a valid memory resource or <code class="computeroutput">nullptr</code></p> -<p><span class="bold"><strong>Effects</strong></span>: If <code class="computeroutput">upstream</code> is not nullptr, sets the internal resource to <code class="computeroutput">upstream</code>, to get_default_resource() otherwise. Sets the internal <code class="computeroutput">current_buffer</code> to <code class="computeroutput">nullptr</code> and the internal <code class="computeroutput">next_buffer_size</code> to an implementation-defined size. </p> +<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp18540880-bb"></a><span class="identifier">monotonic_buffer_resource</span><span class="special">(</span><a class="link" href="memory_resource.html" title="Class memory_resource">memory_resource</a> <span class="special">*</span> upstream <span class="special">=</span> <span class="number">0</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<p><span class="bold"><strong>Requires</strong></span>: `upstream` shall be the address of a valid memory resource or `nullptr`</p> +<p><span class="bold"><strong>Effects</strong></span>: If `upstream` is not nullptr, sets the internal resource to `upstream`, to get_default_resource() otherwise. Sets the internal `current_buffer` to `nullptr` and the internal `next_buffer_size` to an implementation-defined size. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">explicit</span> <a name="idm46583871590000-bb"></a><span class="identifier">monotonic_buffer_resource</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> initial_size<span class="special">,</span> +<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp18545072-bb"></a><span class="identifier">monotonic_buffer_resource</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> initial_size<span class="special">,</span> <a class="link" href="memory_resource.html" title="Class memory_resource">memory_resource</a> <span class="special">*</span> upstream <span class="special">=</span> <span class="number">0</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> -<p><span class="bold"><strong>Requires</strong></span>: <code class="computeroutput">upstream</code> shall be the address of a valid memory resource or <code class="computeroutput">nullptr</code> and <code class="computeroutput">initial_size</code> shall be greater than zero.</p> -<p><span class="bold"><strong>Effects</strong></span>: If <code class="computeroutput">upstream</code> is not nullptr, sets the internal resource to <code class="computeroutput">upstream</code>, to get_default_resource() otherwise. Sets the internal <code class="computeroutput">current_buffer</code> to <code class="computeroutput">nullptr</code> and <code class="computeroutput">next_buffer_size</code> to at least <code class="computeroutput">initial_size</code>. </p> +<p><span class="bold"><strong>Requires</strong></span>: `upstream` shall be the address of a valid memory resource or `nullptr` and `initial_size` shall be greater than zero.</p> +<p><span class="bold"><strong>Effects</strong></span>: If `upstream` is not nullptr, sets the internal resource to `upstream`, to get_default_resource() otherwise. Sets the internal `current_buffer` to `nullptr` and `next_buffer_size` to at least `initial_size`. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idm46583871581232-bb"></a><span class="identifier">monotonic_buffer_resource</span><span class="special">(</span><span class="keyword">void</span> <span class="special">*</span> buffer<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> buffer_size<span class="special">,</span> +<pre class="literallayout"><a name="idp18549984-bb"></a><span class="identifier">monotonic_buffer_resource</span><span class="special">(</span><span class="keyword">void</span> <span class="special">*</span> buffer<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> buffer_size<span class="special">,</span> <a class="link" href="memory_resource.html" title="Class memory_resource">memory_resource</a> <span class="special">*</span> upstream <span class="special">=</span> <span class="number">0</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> -<p><span class="bold"><strong>Requires</strong></span>: <code class="computeroutput">upstream</code> shall be the address of a valid memory resource or <code class="computeroutput">nullptr</code>, <code class="computeroutput">buffer_size</code> shall be no larger than the number of bytes in buffer.</p> -<p><span class="bold"><strong>Effects</strong></span>: If <code class="computeroutput">upstream</code> is not nullptr, sets the internal resource to <code class="computeroutput">upstream</code>, to get_default_resource() otherwise. Sets the internal <code class="computeroutput">current_buffer</code> to <code class="computeroutput">buffer</code>, and <code class="computeroutput">next_buffer_size</code> to <code class="computeroutput">buffer_size</code> (but not less than an implementation-defined size), then increases <code class="computeroutput">next_buffer_size</code> by an implementation-defined growth factor (which need not be integral). </p> +<p><span class="bold"><strong>Requires</strong></span>: `upstream` shall be the address of a valid memory resource or `nullptr`, `buffer_size` shall be no larger than the number of bytes in buffer.</p> +<p><span class="bold"><strong>Effects</strong></span>: If `upstream` is not nullptr, sets the internal resource to `upstream`, to get_default_resource() otherwise. Sets the internal `current_buffer` to `buffer`, and `next_buffer_size` to `buffer_size` (but not less than an implementation-defined size), then increases `next_buffer_size` by an implementation-defined growth factor (which need not be integral). </p> </li> -<li class="listitem"><pre class="literallayout"><a name="idm46583871571472-bb"></a><span class="identifier">monotonic_buffer_resource</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="monotonic_buffer_resource.html" title="Class monotonic_buffer_resource">monotonic_buffer_resource</a> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a class="link" href="monotonic_buffer_resource.html" title="Class monotonic_buffer_resource">monotonic_buffer_resource</a> -<a name="idm46583871569760-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="monotonic_buffer_resource.html" title="Class monotonic_buffer_resource">monotonic_buffer_resource</a> <span class="special">&</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp18555472-bb"></a><span class="identifier">monotonic_buffer_resource</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="monotonic_buffer_resource.html" title="Class monotonic_buffer_resource">monotonic_buffer_resource</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a class="link" href="monotonic_buffer_resource.html" title="Class monotonic_buffer_resource">monotonic_buffer_resource</a> <a name="idp18556912-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="monotonic_buffer_resource.html" title="Class monotonic_buffer_resource">monotonic_buffer_resource</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre></li> <li class="listitem"> -<pre class="literallayout"><a name="idm46583871567616-bb"></a><span class="special">~</span><span class="identifier">monotonic_buffer_resource</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> -<p><span class="bold"><strong>Effects</strong></span>: Calls <code class="computeroutput">this->release()</code>. </p> +<pre class="literallayout"><a name="idp18558784-bb"></a><span class="special">~</span><span class="identifier">monotonic_buffer_resource</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<p><span class="bold"><strong>Effects</strong></span>: Calls `this->release()`. </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idm45555399029648"></a><h3> -<a name="idm46583871617776-bb"></a><code class="computeroutput">monotonic_buffer_resource</code> public member functions</h3> +<a name="idp85774576"></a><h3> +<a name="idp18520960-bb"></a><code class="computeroutput">monotonic_buffer_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> <a name="idm46583871617216-bb"></a><span class="identifier">release</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>: <code class="computeroutput">upstream_resource()->deallocate()</code> as necessary to release all allocated memory. [Note: memory is released back to <code class="computeroutput">upstream_resource()</code> even if some blocks that were allocated from this have not been deallocated from this. - end note] </p> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp18521520-bb"></a><span class="identifier">release</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>: `upstream_resource()->deallocate()` as necessary to release all allocated memory. [Note: memory is released back to `upstream_resource()` even if some blocks that were allocated from this have not been deallocated from this. - end note] </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="idm46583871614064-bb"></a><span class="identifier">upstream_resource</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</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="idp18523840-bb"></a><span class="identifier">upstream_resource</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> <p><span class="bold"><strong>Returns</strong></span>: The value of the internal resource. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a name="idm46583871611664-bb"></a><span class="identifier">remaining_storage</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> alignment<span class="special">,</span> +<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a name="idp18526240-bb"></a><span class="identifier">remaining_storage</span><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">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="special">&</span> wasted_due_to_alignment<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> <p><span class="bold"><strong>Returns</strong></span>: The number of bytes of storage available for the specified alignment and the number of bytes wasted due to the requested alignment.</p> <p><span class="bold"><strong>Note</strong></span>: Non-standard extension. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a name="idm46583871607216-bb"></a><span class="identifier">remaining_storage</span><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="number">1u</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a name="idp18530688-bb"></a><span class="identifier">remaining_storage</span><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="number">1u</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> <p><span class="bold"><strong>Returns</strong></span>: The number of bytes of storage available for the specified alignment.</p> <p><span class="bold"><strong>Note</strong></span>: Non-standard extension. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> <a name="idm46583871603232-bb"></a><span class="identifier">current_buffer</span><span class="special">(</span><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">const</span> <span class="keyword">void</span> <span class="special">*</span> <a name="idp18534672-bb"></a><span class="identifier">current_buffer</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> <p><span class="bold"><strong>Returns</strong></span>: The number of bytes of storage available for the specified alignment.</p> <p><span class="bold"><strong>Note</strong></span>: Non-standard extension. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a name="idm46583871600224-bb"></a><span class="identifier">next_buffer_size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a name="idp18537680-bb"></a><span class="identifier">next_buffer_size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> <p><span class="bold"><strong>Returns</strong></span>: The number of bytes that will be requested for the next buffer once the current one is exhausted.</p> <p><span class="bold"><strong>Note</strong></span>: Non-standard extension. </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idm45555398970304"></a><h3> -<a name="idm46583871565904-bb"></a><code class="computeroutput">monotonic_buffer_resource</code> protected member functions</h3> +<a name="idp85832784"></a><h3> +<a name="idp18560064-bb"></a><code class="computeroutput">monotonic_buffer_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="idm46583871565328-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></pre> -<p><span class="bold"><strong>Returns</strong></span>: A pointer to allocated storage with a size of at least <code class="computeroutput">bytes</code>. The size and alignment of the allocated memory shall meet the requirements for a class derived from <code class="computeroutput"><code class="computeroutput"><a class="link" href="memory_resource.html" title="Class memory_resource">memory_resource</a></code></code>.</p> -<p><span class="bold"><strong>Effects</strong></span>: If the unused space in the internal <code class="computeroutput">current_buffer</code> can fit a block with the specified bytes and alignment, then allocate the return block from the internal <code class="computeroutput">current_buffer</code>; otherwise sets the internal <code class="computeroutput">current_buffer</code> to <code class="computeroutput">upstream_resource()->allocate(n, m)</code>, where <code class="computeroutput">n</code> is not less than <code class="computeroutput">max(bytes, next_buffer_size)</code> and <code class="computeroutput">m</code> is not less than alignment, and increase <code class="computeroutput">next_buffer_size</code> by an implementation-defined growth factor (which need not be integral), then allocate the return block from the newly-allocated internal <code class="computeroutput">current_buffer</code>.</p> -<p><span class="bold"><strong>Throws</strong></span>: Nothing unless <code class="computeroutput">upstream_resource()->allocate()</code> throws. </p> +<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <span class="special">*</span> <a name="idp18560640-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></pre> +<p><span class="bold"><strong>Returns</strong></span>: A pointer to allocated storage with a size of at least `bytes`. The size and alignment of the allocated memory shall meet the requirements for a class derived from `memory_resource`.</p> +<p><span class="bold"><strong>Effects</strong></span>: If the unused space in the internal `current_buffer` can fit a block with the specified bytes and alignment, then allocate the return block from the internal `current_buffer`; otherwise sets the internal `current_buffer` to `upstream_resource()->allocate(n, m)`, where `n` is not less than `max(bytes, next_buffer_size)` and `m` is not less than alignment, and increase `next_buffer_size` by an implementation-defined growth factor (which need not be integral), then allocate the return block from the newly-allocated internal `current_buffer`.</p> +<p><span class="bold"><strong>Throws</strong></span>: Nothing unless `upstream_resource()->allocate()` throws. </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> -<a name="idm46583871553904-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="keyword">noexcept</span><span class="special">;</span></pre> +<a name="idp18566560-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="keyword">noexcept</span><span class="special">;</span></pre> <p><span class="bold"><strong>Effects</strong></span>: None</p> <p><span class="bold"><strong>Throws</strong></span>: Nothing</p> <p><span class="bold"><strong>Remarks</strong></span>: Memory used by this resource increases monotonically until its destruction. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">bool</span> <a name="idm46583871547712-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><span class="bold"><strong>Returns</strong></span>: <code class="computeroutput">this == dynamic_cast<const monotonic_buffer_resource*>(&other)</code>. </p> +<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">bool</span> <a name="idp18572752-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><span class="bold"><strong>Returns</strong></span>: `this == dynamic_cast<const monotonic_buffer_resource*>(&other)`. </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idm45555398920880"></a><h3> +<a name="idp85873424"></a><h3> <a name="boost.container.pmr.monotonic_buffer_resourcepublic-data-members"></a><code class="computeroutput">monotonic_buffer_resource</code> public public data members</h3> |