diff options
Diffstat (limited to 'doc/html/boost/container/pmr/pool_options.html')
| -rw-r--r-- | doc/html/boost/container/pmr/pool_options.html | 75 |
1 files changed, 75 insertions, 0 deletions
diff --git a/doc/html/boost/container/pmr/pool_options.html b/doc/html/boost/container/pmr/pool_options.html new file mode 100644 index 0000000000..0c9c58e689 --- /dev/null +++ b/doc/html/boost/container/pmr/pool_options.html @@ -0,0 +1,75 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Struct pool_options</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.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.pool_options_hpp" title="Header <boost/container/pmr/pool_options.hpp>"> +<link rel="prev" href="operator_idm46583871486800.html" title="Function template operator!="> +<link rel="next" href="resource_adaptor_imp.html" title="Class template resource_adaptor_imp"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="operator_idm46583871486800.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> +</div> +<div class="refentry"> +<a name="boost.container.pmr.pool_options"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Struct pool_options</span></h2> +<p>boost::container::pmr::pool_options</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../../boost_container_header_reference.html#header.boost.container.pmr.pool_options_hpp" title="Header <boost/container/pmr/pool_options.hpp>">boost/container/pmr/pool_options.hpp</a>> + +</span> +<span class="keyword">struct</span> <a class="link" href="pool_options.html" title="Struct pool_options">pool_options</a> <span class="special">{</span> + <span class="comment">// <a class="link" href="pool_options.html#boost.container.pmr.pool_optionsconstruct-copy-destruct">construct/copy/destruct</a></span> + <a class="link" href="pool_options.html#idm46583871470624-bb"><span class="identifier">pool_options</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + + <span class="comment">// public data members</span> + <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> + <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> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idm45555398590864"></a><h2>Description</h2> +<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> +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> +<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> +<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> +</ul></div> +<p> +</p> +<div class="refsect2"> +<a name="idm45555398585232"></a><h3> +<a name="boost.container.pmr.pool_optionsconstruct-copy-destruct"></a><code class="computeroutput">pool_options</code> + public + construct/copy/destruct</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idm46583871470624-bb"></a><span class="identifier">pool_options</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div> +</div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2009-2015 Ion Gaztanaga<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + 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>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="operator_idm46583871486800.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> +</div> +</body> +</html> |