Imported Upstream version 1.72.0
[platform/upstream/boost.git] / doc / html / boost / container / pmr / pool_options.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5 <title>Struct pool_options</title>
6 <link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
7 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
8 <link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
9 <link rel="up" href="../../../boost_container_header_reference.html#header.boost.container.pmr.pool_options_hpp" title="Header &lt;boost/container/pmr/pool_options.hpp&gt;">
10 <link rel="prev" href="operator__.html" title="Function template operator!=">
11 <link rel="next" href="resource_adaptor_imp.html" title="Class template resource_adaptor_imp">
12 </head>
13 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
14 <table cellpadding="2" width="100%"><tr>
15 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
16 <td align="center"><a href="../../../../../index.html">Home</a></td>
17 <td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td>
18 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
19 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
20 <td align="center"><a href="../../../../../more/index.htm">More</a></td>
21 </tr></table>
22 <hr>
23 <div class="spirit-nav">
24 <a accesskey="p" href="operator__.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.pool_options_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="resource_adaptor_imp.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
25 </div>
26 <div class="refentry">
27 <a name="boost.container.pmr.pool_options"></a><div class="titlepage"></div>
28 <div class="refnamediv">
29 <h2><span class="refentrytitle">Struct pool_options</span></h2>
30 <p>boost::container::pmr::pool_options</p>
31 </div>
32 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
33 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../../boost_container_header_reference.html#header.boost.container.pmr.pool_options_hpp" title="Header &lt;boost/container/pmr/pool_options.hpp&gt;">boost/container/pmr/pool_options.hpp</a>&gt;
34
35 </span>
36 <span class="keyword">struct</span> <a class="link" href="pool_options.html" title="Struct pool_options">pool_options</a> <span class="special">{</span>
37   <span class="comment">// <a class="link" href="pool_options.html#boost.container.pmr.pool_optionsconstruct-copy-destruct">construct/copy/destruct</a></span>
38   <a class="link" href="pool_options.html#idm45666069895296-bb"><span class="identifier">pool_options</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
39
40   <span class="comment">// public data members</span>
41   <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">max_blocks_per_chunk</span><span class="special">;</span>
42   <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">largest_required_pool_block</span><span class="special">;</span>
43 <span class="special">}</span><span class="special">;</span></pre></div>
44 <div class="refsect1">
45 <a name="id-1.3.10.14.24.3.4"></a><h2>Description</h2>
46 <p>The members of <a class="link" href="pool_options.html" title="Struct pool_options">pool_options</a> comprise a set of constructor options for pool resources. The effect of each option on the pool resource behavior is described below:</p>
47 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
48 <li class="listitem"><p><code class="computeroutput">std::size_t max_blocks_per_chunk</code>: The maximum number of blocks that will be allocated at once from the upstream memory resource to replenish a pool. If the value of <code class="computeroutput">max_blocks_per_chunk</code> is zero or is greater than an implementation-defined limit, that limit is used instead. The implementation may choose to use a smaller value than is specified in this field and may use different values for different pools.</p></li>
49 <li class="listitem"><p><code class="computeroutput">std::size_t largest_required_pool_block</code>: The largest allocation size that is required to be fulfilled using the pooling mechanism. Attempts to allocate a single block larger than this threshold will be allocated directly from the upstream memory resource. If largest_required_pool_block is zero or is greater than an implementation-defined limit, that limit is used instead. The implementation may choose a pass-through threshold larger than specified in this field. </p></li>
50 </ul></div>
51 <p>
52 </p>
53 <div class="refsect2">
54 <a name="id-1.3.10.14.24.3.4.4"></a><h3>
55 <a name="boost.container.pmr.pool_optionsconstruct-copy-destruct"></a><code class="computeroutput">pool_options</code> 
56         public
57        construct/copy/destruct</h3>
58 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idm45666069895296-bb"></a><span class="identifier">pool_options</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div>
59 </div>
60 </div>
61 </div>
62 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
63 <td align="left"></td>
64 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2018 Ion Gaztanaga<p>
65         Distributed under the Boost Software License, Version 1.0. (See accompanying
66         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
67       </p>
68 </div></td>
69 </tr></table>
70 <hr>
71 <div class="spirit-nav">
72 <a accesskey="p" href="operator__.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.pool_options_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="resource_adaptor_imp.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
73 </div>
74 </body>
75 </html>