diff options
Diffstat (limited to 'doc/html/boost/container/pmr')
29 files changed, 2302 insertions, 0 deletions
diff --git a/doc/html/boost/container/pmr/basic_string_of.html b/doc/html/boost/container/pmr/basic_string_of.html new file mode 100644 index 0000000000..97e103c438 --- /dev/null +++ b/doc/html/boost/container/pmr/basic_string_of.html @@ -0,0 +1,54 @@ +<!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 template basic_string_of</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.string_hpp" title="Header <boost/container/pmr/string.hpp>"> +<link rel="prev" href="../wstring.html" title="Type definition wstring"> +<link rel="next" href="../throw_bad_alloc.html" title="Function throw_bad_alloc"> +</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="../wstring.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.string_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="../throw_bad_alloc.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.container.pmr.basic_string_of"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Struct template basic_string_of</span></h2> +<p>boost::container::pmr::basic_string_of</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.string_hpp" title="Header <boost/container/pmr/string.hpp>">boost/container/pmr/string.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">char_traits</span><span class="special"><</span><span class="identifier">CharT</span><span class="special">></span> <span class="special">></span> +<span class="keyword">struct</span> <a class="link" href="basic_string_of.html" title="Struct template basic_string_of">basic_string_of</a> <span class="special">{</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <a class="link" href="../basic_string.html" title="Class template basic_string">boost::container::basic_string</a><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span><span class="special">,</span> <a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a><span class="special"><</span> <span class="identifier">CharT</span> <span class="special">></span> <span class="special">></span> <a name="boost.container.pmr.basic_string_of.type"></a><span class="identifier">type</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></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="../wstring.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.string_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="../throw_bad_alloc.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/container/pmr/deque_of.html b/doc/html/boost/container/pmr/deque_of.html new file mode 100644 index 0000000000..fdf204bb63 --- /dev/null +++ b/doc/html/boost/container/pmr/deque_of.html @@ -0,0 +1,54 @@ +<!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 template deque_of</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.deque_hpp" title="Header <boost/container/pmr/deque.hpp>"> +<link rel="prev" href="../deque.html" title="Class template deque"> +<link rel="next" href="../flat_map.html" title="Class template flat_map"> +</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="../deque.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.deque_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="../flat_map.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.container.pmr.deque_of"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Struct template deque_of</span></h2> +<p>boost::container::pmr::deque_of</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.deque_hpp" title="Header <boost/container/pmr/deque.hpp>">boost/container/pmr/deque.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> +<span class="keyword">struct</span> <a class="link" href="deque_of.html" title="Struct template deque_of">deque_of</a> <span class="special">{</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <a class="link" href="../deque.html" title="Class template deque">boost::container::deque</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">></span> <a name="boost.container.pmr.deque_of.type"></a><span class="identifier">type</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></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="../deque.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.deque_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="../flat_map.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/container/pmr/flat_map_of.html b/doc/html/boost/container/pmr/flat_map_of.html new file mode 100644 index 0000000000..ab8eaab620 --- /dev/null +++ b/doc/html/boost/container/pmr/flat_map_of.html @@ -0,0 +1,55 @@ +<!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 template flat_map_of</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.flat_map_hpp" title="Header <boost/container/pmr/flat_map.hpp>"> +<link rel="prev" href="../flat_multimap.html" title="Class template flat_multimap"> +<link rel="next" href="flat_multimap_of.html" title="Struct template flat_multimap_of"> +</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="../flat_multimap.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.flat_map_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="flat_multimap_of.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.container.pmr.flat_map_of"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Struct template flat_map_of</span></h2> +<p>boost::container::pmr::flat_map_of</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.flat_map_hpp" title="Header <boost/container/pmr/flat_map.hpp>">boost/container/pmr/flat_map.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Key<span class="special">,</span> <span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> Compare <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">less</span><span class="special"><</span><span class="identifier">Key</span><span class="special">></span><span class="special">,</span> + <span class="keyword">typename</span> Options <span class="special">=</span> <span class="identifier">tree_assoc_defaults</span><span class="special">></span> +<span class="keyword">struct</span> <a class="link" href="flat_map_of.html" title="Struct template flat_map_of">flat_map_of</a> <span class="special">{</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <a class="link" href="../flat_map.html" title="Class template flat_map">boost::container::flat_map</a><span class="special"><</span> <span class="identifier">Key</span><span class="special">,</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">Compare</span><span class="special">,</span> <a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a><span class="special"><</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span> <span class="identifier">Key</span><span class="special">,</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">></span> <span class="special">></span> <a name="boost.container.pmr.flat_map_of.type"></a><span class="identifier">type</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></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="../flat_multimap.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.flat_map_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="flat_multimap_of.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/container/pmr/flat_multimap_of.html b/doc/html/boost/container/pmr/flat_multimap_of.html new file mode 100644 index 0000000000..fbf6e67109 --- /dev/null +++ b/doc/html/boost/container/pmr/flat_multimap_of.html @@ -0,0 +1,55 @@ +<!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 template flat_multimap_of</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.flat_map_hpp" title="Header <boost/container/pmr/flat_map.hpp>"> +<link rel="prev" href="flat_map_of.html" title="Struct template flat_map_of"> +<link rel="next" href="../flat_multiset.html" title="Class template flat_multiset"> +</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="flat_map_of.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.flat_map_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="../flat_multiset.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.container.pmr.flat_multimap_of"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Struct template flat_multimap_of</span></h2> +<p>boost::container::pmr::flat_multimap_of</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.flat_map_hpp" title="Header <boost/container/pmr/flat_map.hpp>">boost/container/pmr/flat_map.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Key<span class="special">,</span> <span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> Compare <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">less</span><span class="special"><</span><span class="identifier">Key</span><span class="special">></span><span class="special">,</span> + <span class="keyword">typename</span> Options <span class="special">=</span> <span class="identifier">tree_assoc_defaults</span><span class="special">></span> +<span class="keyword">struct</span> <a class="link" href="flat_multimap_of.html" title="Struct template flat_multimap_of">flat_multimap_of</a> <span class="special">{</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <a class="link" href="../flat_multimap.html" title="Class template flat_multimap">boost::container::flat_multimap</a><span class="special"><</span> <span class="identifier">Key</span><span class="special">,</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">Compare</span><span class="special">,</span> <a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a><span class="special"><</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span> <span class="identifier">Key</span><span class="special">,</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">></span> <span class="special">></span> <a name="boost.container.pmr.flat_multimap_of.type"></a><span class="identifier">type</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></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="flat_map_of.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.flat_map_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="../flat_multiset.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/container/pmr/flat_multiset_of.html b/doc/html/boost/container/pmr/flat_multiset_of.html new file mode 100644 index 0000000000..e66a8b58b4 --- /dev/null +++ b/doc/html/boost/container/pmr/flat_multiset_of.html @@ -0,0 +1,55 @@ +<!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 template flat_multiset_of</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.flat_set_hpp" title="Header <boost/container/pmr/flat_set.hpp>"> +<link rel="prev" href="../flat_set.html" title="Class template flat_set"> +<link rel="next" href="flat_set_of.html" title="Struct template flat_set_of"> +</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="../flat_set.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.flat_set_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="flat_set_of.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.container.pmr.flat_multiset_of"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Struct template flat_multiset_of</span></h2> +<p>boost::container::pmr::flat_multiset_of</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.flat_set_hpp" title="Header <boost/container/pmr/flat_set.hpp>">boost/container/pmr/flat_set.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Key<span class="special">,</span> <span class="keyword">typename</span> Compare <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">less</span><span class="special"><</span><span class="identifier">Key</span><span class="special">></span><span class="special">,</span> + <span class="keyword">typename</span> Options <span class="special">=</span> <span class="identifier">tree_assoc_defaults</span><span class="special">></span> +<span class="keyword">struct</span> <a class="link" href="flat_multiset_of.html" title="Struct template flat_multiset_of">flat_multiset_of</a> <span class="special">{</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <a class="link" href="../flat_multiset.html" title="Class template flat_multiset">boost::container::flat_multiset</a><span class="special"><</span> <span class="identifier">Key</span><span class="special">,</span> <span class="identifier">Compare</span><span class="special">,</span> <a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a><span class="special"><</span> <span class="identifier">Key</span> <span class="special">></span> <span class="special">></span> <a name="boost.container.pmr.flat_multiset_of.type"></a><span class="identifier">type</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></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="../flat_set.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.flat_set_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="flat_set_of.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/container/pmr/flat_set_of.html b/doc/html/boost/container/pmr/flat_set_of.html new file mode 100644 index 0000000000..561123e5ec --- /dev/null +++ b/doc/html/boost/container/pmr/flat_set_of.html @@ -0,0 +1,55 @@ +<!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 template flat_set_of</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.flat_set_hpp" title="Header <boost/container/pmr/flat_set.hpp>"> +<link rel="prev" href="flat_multiset_of.html" title="Struct template flat_multiset_of"> +<link rel="next" href="../list.html" title="Class template list"> +</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="flat_multiset_of.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.flat_set_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="../list.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.container.pmr.flat_set_of"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Struct template flat_set_of</span></h2> +<p>boost::container::pmr::flat_set_of</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.flat_set_hpp" title="Header <boost/container/pmr/flat_set.hpp>">boost/container/pmr/flat_set.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Key<span class="special">,</span> <span class="keyword">typename</span> Compare <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">less</span><span class="special"><</span><span class="identifier">Key</span><span class="special">></span><span class="special">,</span> + <span class="keyword">typename</span> Options <span class="special">=</span> <span class="identifier">tree_assoc_defaults</span><span class="special">></span> +<span class="keyword">struct</span> <a class="link" href="flat_set_of.html" title="Struct template flat_set_of">flat_set_of</a> <span class="special">{</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <a class="link" href="../flat_set.html" title="Class template flat_set">boost::container::flat_set</a><span class="special"><</span> <span class="identifier">Key</span><span class="special">,</span> <span class="identifier">Compare</span><span class="special">,</span> <a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a><span class="special"><</span> <span class="identifier">Key</span> <span class="special">></span> <span class="special">></span> <a name="boost.container.pmr.flat_set_of.type"></a><span class="identifier">type</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></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="flat_multiset_of.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.flat_set_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="../list.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/container/pmr/get_default_resource.html b/doc/html/boost/container/pmr/get_default_resource.html new file mode 100644 index 0000000000..7f12a2b806 --- /dev/null +++ b/doc/html/boost/container/pmr/get_default_resource.html @@ -0,0 +1,55 @@ +<!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>Function get_default_resource</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.global_resource_hpp" title="Header <boost/container/pmr/global_resource.hpp>"> +<link rel="prev" href="set_default_resource.html" title="Function set_default_resource"> +<link rel="next" href="memory_resource.html" title="Class memory_resource"> +</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="set_default_resource.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.global_resource_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="memory_resource.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.container.pmr.get_default_resource"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Function get_default_resource</span></h2> +<p>boost::container::pmr::get_default_resource</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.global_resource_hpp" title="Header <boost/container/pmr/global_resource.hpp>">boost/container/pmr/global_resource.hpp</a>> + +</span> +<a class="link" href="memory_resource.html" title="Class memory_resource">memory_resource</a> <span class="special">*</span> <span class="identifier">get_default_resource</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idm45555399496176"></a><h2>Description</h2> +<p><span class="bold"><strong>Returns</strong></span>: The current value of the default memory resource pointer. </p> +</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="set_default_resource.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.global_resource_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="memory_resource.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/container/pmr/list_of.html b/doc/html/boost/container/pmr/list_of.html new file mode 100644 index 0000000000..cccd8c3b53 --- /dev/null +++ b/doc/html/boost/container/pmr/list_of.html @@ -0,0 +1,54 @@ +<!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 template list_of</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.list_hpp" title="Header <boost/container/pmr/list.hpp>"> +<link rel="prev" href="../list.html" title="Class template list"> +<link rel="next" href="../map.html" title="Class template map"> +</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="../list.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.list_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="../map.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.container.pmr.list_of"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Struct template list_of</span></h2> +<p>boost::container::pmr::list_of</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.list_hpp" title="Header <boost/container/pmr/list.hpp>">boost/container/pmr/list.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> +<span class="keyword">struct</span> <a class="link" href="list_of.html" title="Struct template list_of">list_of</a> <span class="special">{</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <a class="link" href="../list.html" title="Class template list">boost::container::list</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">></span> <a name="boost.container.pmr.list_of.type"></a><span class="identifier">type</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></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="../list.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.list_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="../map.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/container/pmr/map_of.html b/doc/html/boost/container/pmr/map_of.html new file mode 100644 index 0000000000..e8a5dc4353 --- /dev/null +++ b/doc/html/boost/container/pmr/map_of.html @@ -0,0 +1,55 @@ +<!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 template map_of</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.map_hpp" title="Header <boost/container/pmr/map.hpp>"> +<link rel="prev" href="../multimap.html" title="Class template multimap"> +<link rel="next" href="multimap_of.html" title="Struct template multimap_of"> +</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="../multimap.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.map_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="multimap_of.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.container.pmr.map_of"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Struct template map_of</span></h2> +<p>boost::container::pmr::map_of</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.map_hpp" title="Header <boost/container/pmr/map.hpp>">boost/container/pmr/map.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Key<span class="special">,</span> <span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> Compare <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">less</span><span class="special"><</span><span class="identifier">Key</span><span class="special">></span><span class="special">,</span> + <span class="keyword">typename</span> Options <span class="special">=</span> <span class="identifier">tree_assoc_defaults</span><span class="special">></span> +<span class="keyword">struct</span> <a class="link" href="map_of.html" title="Struct template map_of">map_of</a> <span class="special">{</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <a class="link" href="../map.html" title="Class template map">boost::container::map</a><span class="special"><</span> <span class="identifier">Key</span><span class="special">,</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">Compare</span><span class="special">,</span> <a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a><span class="special"><</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span> <span class="keyword">const</span> <span class="identifier">Key</span><span class="special">,</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">></span><span class="special">,</span> <span class="identifier">Options</span> <span class="special">></span> <a name="boost.container.pmr.map_of.type"></a><span class="identifier">type</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></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="../multimap.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.map_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="multimap_of.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/container/pmr/memory_resource.html b/doc/html/boost/container/pmr/memory_resource.html new file mode 100644 index 0000000000..d3ff08cb7c --- /dev/null +++ b/doc/html/boost/container/pmr/memory_resource.html @@ -0,0 +1,142 @@ +<!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>Class memory_resource</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.memory_resource_hpp" title="Header <boost/container/pmr/memory_resource.hpp>"> +<link rel="prev" href="get_default_resource.html" title="Function get_default_resource"> +<link rel="next" href="monotonic_buffer_resource.html" title="Class monotonic_buffer_resource"> +</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="get_default_resource.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.memory_resource_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="monotonic_buffer_resource.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.container.pmr.memory_resource"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Class memory_resource</span></h2> +<p>boost::container::pmr::memory_resource</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.memory_resource_hpp" title="Header <boost/container/pmr/memory_resource.hpp>">boost/container/pmr/memory_resource.hpp</a>> + +</span> +<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#idm46583871659104-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#idm46583871672112-bb">public member functions</a></span> + <span class="keyword">void</span> <span class="special">*</span> <a class="link" href="memory_resource.html#idm46583871671552-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#idm46583871667600-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#idm46583871662960-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#idm46583871657104-bb">friend functions</a></span> + <span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="memory_resource.html#idm46583871656544-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#idm46583871651712-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#idm46583871647184-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#idm46583871646608-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#idm46583871640784-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#idm46583871634016-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="idm45555399381328"></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="idm45555399379680"></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="idm46583871659104-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="idm45555399371104"></a><h3> +<a name="idm46583871672112-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="idm46583871671552-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="idm46583871667600-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="idm46583871662960-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="idm45555399334448"></a><h3> +<a name="idm46583871657104-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="idm46583871656544-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="idm46583871651712-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="idm45555399307328"></a><h3> +<a name="idm46583871647184-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="idm46583871646608-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="idm46583871640784-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="idm46583871634016-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> +</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="get_default_resource.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.memory_resource_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="monotonic_buffer_resource.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/container/pmr/monotonic_buffer_resource.html b/doc/html/boost/container/pmr/monotonic_buffer_resource.html new file mode 100644 index 0000000000..49b33f2390 --- /dev/null +++ b/doc/html/boost/container/pmr/monotonic_buffer_resource.html @@ -0,0 +1,193 @@ +<!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>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"> +<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"> +<link rel="next" href="polymorphic_allocator.html" title="Class template polymorphic_allocator"> +</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="memory_resource.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.monotonic_buffer_resource_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="polymorphic_allocator.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.container.pmr.monotonic_buffer_resource"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Class monotonic_buffer_resource</span></h2> +<p>boost::container::pmr::monotonic_buffer_resource</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.monotonic_buffer_resource_hpp" title="Header <boost/container/pmr/monotonic_buffer_resource.hpp>">boost/container/pmr/monotonic_buffer_resource.hpp</a>> + +</span> +<span class="keyword">class</span> <a class="link" href="monotonic_buffer_resource.html" title="Class monotonic_buffer_resource">monotonic_buffer_resource</a> <span class="special">:</span> + <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">container</span><span class="special">::</span><span class="identifier">pmr</span><span class="special">::</span><span class="identifier">memory_resource</span> +<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="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#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#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> +<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> +<p> +</p> +<div class="refsect2"> +<a name="idm45555399106592"></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> +</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> + <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> +</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> + <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> +</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="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> +</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> +<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> +</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> +<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> + <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> +<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> +<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> +<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> +<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> +</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> +<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> +</li> +</ol></div> +</div> +<div class="refsect2"> +<a name="idm45555398920880"></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> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> +<pre class="literallayout"><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 name="boost.container.pmr.monotonic_buffer_resource.initial_next_buffer_size"></a><span class="identifier">initial_next_buffer_size</span><span class="special">;</span></pre> +<p>The number of bytes that will be requested by the default in the first call to the upstream allocator</p> +<p><span class="bold"><strong>Note</strong></span>: Non-standard extension. </p> +</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="memory_resource.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.monotonic_buffer_resource_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="polymorphic_allocator.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/container/pmr/multimap_of.html b/doc/html/boost/container/pmr/multimap_of.html new file mode 100644 index 0000000000..f2eb01f461 --- /dev/null +++ b/doc/html/boost/container/pmr/multimap_of.html @@ -0,0 +1,55 @@ +<!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 template multimap_of</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.map_hpp" title="Header <boost/container/pmr/map.hpp>"> +<link rel="prev" href="map_of.html" title="Struct template map_of"> +<link rel="next" href="../new_allocator.html" title="Class template new_allocator"> +</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="map_of.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.map_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="../new_allocator.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.container.pmr.multimap_of"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Struct template multimap_of</span></h2> +<p>boost::container::pmr::multimap_of</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.map_hpp" title="Header <boost/container/pmr/map.hpp>">boost/container/pmr/map.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Key<span class="special">,</span> <span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> Compare <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">less</span><span class="special"><</span><span class="identifier">Key</span><span class="special">></span><span class="special">,</span> + <span class="keyword">typename</span> Options <span class="special">=</span> <span class="identifier">tree_assoc_defaults</span><span class="special">></span> +<span class="keyword">struct</span> <a class="link" href="multimap_of.html" title="Struct template multimap_of">multimap_of</a> <span class="special">{</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <a class="link" href="../multimap.html" title="Class template multimap">boost::container::multimap</a><span class="special"><</span> <span class="identifier">Key</span><span class="special">,</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">Compare</span><span class="special">,</span> <a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a><span class="special"><</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span> <span class="keyword">const</span> <span class="identifier">Key</span><span class="special">,</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">></span><span class="special">,</span> <span class="identifier">Options</span> <span class="special">></span> <a name="boost.container.pmr.multimap_of.type"></a><span class="identifier">type</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></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="map_of.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.map_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="../new_allocator.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/container/pmr/multiset_of.html b/doc/html/boost/container/pmr/multiset_of.html new file mode 100644 index 0000000000..200d223c90 --- /dev/null +++ b/doc/html/boost/container/pmr/multiset_of.html @@ -0,0 +1,55 @@ +<!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 template multiset_of</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.set_hpp" title="Header <boost/container/pmr/set.hpp>"> +<link rel="prev" href="../set.html" title="Class template set"> +<link rel="next" href="set_of.html" title="Struct template set_of"> +</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="../set.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.set_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="set_of.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.container.pmr.multiset_of"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Struct template multiset_of</span></h2> +<p>boost::container::pmr::multiset_of</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.set_hpp" title="Header <boost/container/pmr/set.hpp>">boost/container/pmr/set.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Key<span class="special">,</span> <span class="keyword">typename</span> Compare <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">less</span><span class="special"><</span><span class="identifier">Key</span><span class="special">></span><span class="special">,</span> + <span class="keyword">typename</span> Options <span class="special">=</span> <span class="identifier">tree_assoc_defaults</span><span class="special">></span> +<span class="keyword">struct</span> <a class="link" href="multiset_of.html" title="Struct template multiset_of">multiset_of</a> <span class="special">{</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <a class="link" href="../multiset.html" title="Class template multiset">boost::container::multiset</a><span class="special"><</span> <span class="identifier">Key</span><span class="special">,</span> <span class="identifier">Compare</span><span class="special">,</span> <a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a><span class="special"><</span> <span class="identifier">Key</span> <span class="special">></span><span class="special">,</span> <span class="identifier">Options</span> <span class="special">></span> <a name="boost.container.pmr.multiset_of.type"></a><span class="identifier">type</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></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="../set.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.set_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="set_of.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/container/pmr/new_delete_resource.html b/doc/html/boost/container/pmr/new_delete_resource.html new file mode 100644 index 0000000000..8da7af9dce --- /dev/null +++ b/doc/html/boost/container/pmr/new_delete_resource.html @@ -0,0 +1,55 @@ +<!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>Function new_delete_resource</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.global_resource_hpp" title="Header <boost/container/pmr/global_resource.hpp>"> +<link rel="prev" href="../tree_type.html" title="Struct template tree_type"> +<link rel="next" href="null_memory_resource.html" title="Function null_memory_resource"> +</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="../tree_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.global_resource_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="null_memory_resource.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.container.pmr.new_delete_resource"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Function new_delete_resource</span></h2> +<p>boost::container::pmr::new_delete_resource</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.global_resource_hpp" title="Header <boost/container/pmr/global_resource.hpp>">boost/container/pmr/global_resource.hpp</a>> + +</span> +<a class="link" href="memory_resource.html" title="Class memory_resource">memory_resource</a> <span class="special">*</span> <span class="identifier">new_delete_resource</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idm45555399532064"></a><h2>Description</h2> +<p><span class="bold"><strong>Returns</strong></span>: A pointer to a static-duration object of a type derived from <code class="computeroutput"><a class="link" href="memory_resource.html" title="Class memory_resource">memory_resource</a></code> that can serve as a resource for allocating memory using global <code class="computeroutput">operator new</code> and global <code class="computeroutput">operator delete</code>. The same value is returned every time this function is called. For return value p and memory resource r, p->is_equal(r) returns &r == p. </p> +</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="../tree_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.global_resource_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="null_memory_resource.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/container/pmr/null_memory_resource.html b/doc/html/boost/container/pmr/null_memory_resource.html new file mode 100644 index 0000000000..efff404c80 --- /dev/null +++ b/doc/html/boost/container/pmr/null_memory_resource.html @@ -0,0 +1,55 @@ +<!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>Function null_memory_resource</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.global_resource_hpp" title="Header <boost/container/pmr/global_resource.hpp>"> +<link rel="prev" href="new_delete_resource.html" title="Function new_delete_resource"> +<link rel="next" href="set_default_resource.html" title="Function set_default_resource"> +</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="new_delete_resource.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.global_resource_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="set_default_resource.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.container.pmr.null_memory_resource"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Function null_memory_resource</span></h2> +<p>boost::container::pmr::null_memory_resource</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.global_resource_hpp" title="Header <boost/container/pmr/global_resource.hpp>">boost/container/pmr/global_resource.hpp</a>> + +</span> +<a class="link" href="memory_resource.html" title="Class memory_resource">memory_resource</a> <span class="special">*</span> <span class="identifier">null_memory_resource</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idm45555399520192"></a><h2>Description</h2> +<p><span class="bold"><strong>Returns</strong></span>: A pointer to a static-duration object of a type derived from <code class="computeroutput"><a class="link" href="memory_resource.html" title="Class memory_resource">memory_resource</a></code> for which allocate() always throws bad_alloc and for which deallocate() has no effect. The same value is returned every time this function is called. For return value p and memory resource r, p->is_equal(r) returns &r == p. </p> +</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="new_delete_resource.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.global_resource_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="set_default_resource.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/container/pmr/operator_idm46583871486800.html b/doc/html/boost/container/pmr/operator_idm46583871486800.html new file mode 100644 index 0000000000..be07d13054 --- /dev/null +++ b/doc/html/boost/container/pmr/operator_idm46583871486800.html @@ -0,0 +1,57 @@ +<!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>Function template operator!=</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.polymorphic_allocator_hpp" title="Header <boost/container/pmr/polymorphic_allocator.hpp>"> +<link rel="prev" href="operator_idm46583871492768.html" title="Function template operator=="> +<link rel="next" href="pool_options.html" title="Struct pool_options"> +</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_idm46583871492768.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.polymorphic_allocator_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="pool_options.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.container.pmr.operator_idm46583871486800"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Function template operator!=</span></h2> +<p>boost::container::pmr::operator!=</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.polymorphic_allocator_hpp" title="Header <boost/container/pmr/polymorphic_allocator.hpp>">boost/container/pmr/polymorphic_allocator.hpp</a>> + +</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T1<span class="special">,</span> <span class="keyword">typename</span> T2<span class="special">></span> + <span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a><span class="special"><</span> <span class="identifier">T1</span> <span class="special">></span> <span class="special">&</span> a<span class="special">,</span> + <span class="keyword">const</span> <a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a><span class="special"><</span> <span class="identifier">T2</span> <span class="special">></span> <span class="special">&</span> b<span class="special">)</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idm45555398623600"></a><h2>Description</h2> +<p><span class="bold"><strong>Returns</strong></span>: <code class="computeroutput">! (a == b)</code>. </p> +</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_idm46583871492768.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.polymorphic_allocator_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="pool_options.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/container/pmr/operator_idm46583871492768.html b/doc/html/boost/container/pmr/operator_idm46583871492768.html new file mode 100644 index 0000000000..f09539c036 --- /dev/null +++ b/doc/html/boost/container/pmr/operator_idm46583871492768.html @@ -0,0 +1,57 @@ +<!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>Function template operator==</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.polymorphic_allocator_hpp" title="Header <boost/container/pmr/polymorphic_allocator.hpp>"> +<link rel="prev" href="polymorphic_allocator.html" title="Class template polymorphic_allocator"> +<link rel="next" href="operator_idm46583871486800.html" title="Function template operator!="> +</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="polymorphic_allocator.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.polymorphic_allocator_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="operator_idm46583871486800.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.container.pmr.operator_idm46583871492768"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Function template operator==</span></h2> +<p>boost::container::pmr::operator==</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.polymorphic_allocator_hpp" title="Header <boost/container/pmr/polymorphic_allocator.hpp>">boost/container/pmr/polymorphic_allocator.hpp</a>> + +</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T1<span class="special">,</span> <span class="keyword">typename</span> T2<span class="special">></span> + <span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a><span class="special"><</span> <span class="identifier">T1</span> <span class="special">></span> <span class="special">&</span> a<span class="special">,</span> + <span class="keyword">const</span> <a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a><span class="special"><</span> <span class="identifier">T2</span> <span class="special">></span> <span class="special">&</span> b<span class="special">)</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idm45555398645648"></a><h2>Description</h2> +<p><span class="bold"><strong>Returns</strong></span>: <code class="computeroutput">*a.resource() == *b.resource()</code>. </p> +</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="polymorphic_allocator.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.polymorphic_allocator_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="operator_idm46583871486800.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/container/pmr/polymorphic_allocator.html b/doc/html/boost/container/pmr/polymorphic_allocator.html new file mode 100644 index 0000000000..fed6d9f264 --- /dev/null +++ b/doc/html/boost/container/pmr/polymorphic_allocator.html @@ -0,0 +1,141 @@ +<!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>Class template polymorphic_allocator</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.polymorphic_allocator_hpp" title="Header <boost/container/pmr/polymorphic_allocator.hpp>"> +<link rel="prev" href="monotonic_buffer_resource.html" title="Class monotonic_buffer_resource"> +<link rel="next" href="operator_idm46583871492768.html" title="Function template operator=="> +</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="monotonic_buffer_resource.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.polymorphic_allocator_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="operator_idm46583871492768.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.container.pmr.polymorphic_allocator"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Class template polymorphic_allocator</span></h2> +<p>boost::container::pmr::polymorphic_allocator</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.polymorphic_allocator_hpp" title="Header <boost/container/pmr/polymorphic_allocator.hpp>">boost/container/pmr/polymorphic_allocator.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> +<span class="keyword">class</span> <a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a> <span class="special">{</span> +<span class="keyword">public</span><span class="special">:</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <span class="identifier">T</span> <a name="boost.container.pmr.polymorphic_allocator.value_type"></a><span class="identifier">value_type</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="polymorphic_allocator.html#boost.container.pmr.polymorphic_allocatorconstruct-copy-destruct">construct/copy/destruct</a></span> + <a class="link" href="polymorphic_allocator.html#idm46583871508784-bb"><span class="identifier">polymorphic_allocator</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <a class="link" href="polymorphic_allocator.html#idm46583871506800-bb"><span class="identifier">polymorphic_allocator</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="special">;</span> + <a class="link" href="polymorphic_allocator.html#idm46583871501872-bb"><span class="identifier">polymorphic_allocator</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> U<span class="special">></span> + <a class="link" href="polymorphic_allocator.html#idm46583871499456-bb"><span class="identifier">polymorphic_allocator</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a><span class="special"><</span> <span class="identifier">U</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a> <span class="special">&</span> <a class="link" href="polymorphic_allocator.html#idm46583871495920-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="polymorphic_allocator.html#idm46583871535104-bb">public member functions</a></span> + <span class="identifier">T</span> <span class="special">*</span> <a class="link" href="polymorphic_allocator.html#idm46583871534544-bb"><span class="identifier">allocate</span></a><span class="special">(</span><span class="identifier">size_t</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="polymorphic_allocator.html#idm46583871531536-bb"><span class="identifier">deallocate</span></a><span class="special">(</span><span class="identifier">T</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">size_t</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> U<span class="special">,</span> <span class="keyword">class</span><span class="special">...</span> Args<span class="special">></span> <span class="keyword">void</span> <a class="link" href="polymorphic_allocator.html#idm46583871526064-bb"><span class="identifier">construct</span></a><span class="special">(</span><span class="identifier">U</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">Args</span> <span class="special">&&</span><span class="special">...</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> U<span class="special">></span> <span class="keyword">void</span> <a class="link" href="polymorphic_allocator.html#idm46583871517376-bb"><span class="identifier">destroy</span></a><span class="special">(</span><span class="identifier">U</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a> <a class="link" href="polymorphic_allocator.html#idm46583871514016-bb"><span class="identifier">select_on_container_copy_construction</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</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="polymorphic_allocator.html#idm46583871511328-bb"><span class="identifier">resource</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idm45555398775360"></a><h2>Description</h2> +<p>A specialization of class template <code class="computeroutput"><a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a></code> conforms to the Allocator requirements. Constructed with different memory resources, different instances of the same specialization of <code class="computeroutput"><a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a></code> can exhibit entirely different allocation behavior. This runtime polymorphism allows objects that use <a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a> to behave as if they used different allocator types at run time even though they use the same static allocator type. </p> +<div class="refsect2"> +<a name="idm45555398770784"></a><h3> +<a name="boost.container.pmr.polymorphic_allocatorconstruct-copy-destruct"></a><code class="computeroutput">polymorphic_allocator</code> + public + construct/copy/destruct</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><a name="idm46583871508784-bb"></a><span class="identifier">polymorphic_allocator</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>: Sets m_resource to <code class="computeroutput">get_default_resource()</code>. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><a name="idm46583871506800-bb"></a><span class="identifier">polymorphic_allocator</span><span class="special">(</span><a class="link" href="memory_resource.html" title="Class memory_resource">memory_resource</a> <span class="special">*</span> r<span class="special">)</span><span class="special">;</span></pre> +<p><span class="bold"><strong>Requires</strong></span>: r is non-null.</p> +<p><span class="bold"><strong>Effects</strong></span>: Sets m_resource to r.</p> +<p><span class="bold"><strong>Throws</strong></span>: Nothing</p> +<p><span class="bold"><strong>Notes</strong></span>: This constructor provides an implicit conversion from memory_resource*. Non-standard extension: if r is null m_resource is set to get_default_resource(). </p> +</li> +<li class="listitem"> +<pre class="literallayout"><a name="idm46583871501872-bb"></a><span class="identifier">polymorphic_allocator</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> +<p><span class="bold"><strong>Effects</strong></span>: Sets m_resource to other.resource(). </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> U<span class="special">></span> + <a name="idm46583871499456-bb"></a><span class="identifier">polymorphic_allocator</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a><span class="special"><</span> <span class="identifier">U</span> <span class="special">></span> <span class="special">&</span> other<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<p><span class="bold"><strong>Effects</strong></span>: Sets m_resource to other.resource(). </p> +</li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a> <span class="special">&</span> <a name="idm46583871495920-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> +<p><span class="bold"><strong>Effects</strong></span>: Sets m_resource to other.resource(). </p> +</li> +</ol></div> +</div> +<div class="refsect2"> +<a name="idm45555398726448"></a><h3> +<a name="idm46583871535104-bb"></a><code class="computeroutput">polymorphic_allocator</code> public member functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">T</span> <span class="special">*</span> <a name="idm46583871534544-bb"></a><span class="identifier">allocate</span><span class="special">(</span><span class="identifier">size_t</span> n<span class="special">)</span><span class="special">;</span></pre> +<p><span class="bold"><strong>Returns</strong></span>: Equivalent to <code class="computeroutput">static_cast<T*>(m_resource->allocate(n * sizeof(T), alignof(T)))</code>. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="idm46583871531536-bb"></a><span class="identifier">deallocate</span><span class="special">(</span><span class="identifier">T</span> <span class="special">*</span> p<span class="special">,</span> <span class="identifier">size_t</span> n<span class="special">)</span><span class="special">;</span></pre> +<p><span class="bold"><strong>Requires</strong></span>: p was allocated from a memory resource, x, equal to *m_resource, using <code class="computeroutput">x.allocate(n * sizeof(T), alignof(T))</code>.</p> +<p><span class="bold"><strong>Effects</strong></span>: Equivalent to m_resource->deallocate(p, n * sizeof(T), alignof(T)).</p> +<p><span class="bold"><strong>Throws</strong></span>: Nothing. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> U<span class="special">,</span> <span class="keyword">class</span><span class="special">...</span> Args<span class="special">></span> <span class="keyword">void</span> <a name="idm46583871526064-bb"></a><span class="identifier">construct</span><span class="special">(</span><span class="identifier">U</span> <span class="special">*</span> p<span class="special">,</span> <span class="identifier">Args</span> <span class="special">&&</span><span class="special">...</span> args<span class="special">)</span><span class="special">;</span></pre> +<p><span class="bold"><strong>Requires</strong></span>: Uses-allocator construction of T with allocator <code class="computeroutput">this->resource()</code> and constructor arguments <code class="computeroutput">std::forward<Args>(args)...</code> is well-formed. [Note: uses-allocator construction is always well formed for types that do not use allocators. - end note]</p> +<p><span class="bold"><strong>Effects</strong></span>: Construct a T object at p by uses-allocator construction with allocator <code class="computeroutput">this->resource()</code> and constructor arguments <code class="computeroutput">std::forward<Args>(args)...</code>.</p> +<p><span class="bold"><strong>Throws</strong></span>: Nothing unless the constructor for T throws. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> U<span class="special">></span> <span class="keyword">void</span> <a name="idm46583871517376-bb"></a><span class="identifier">destroy</span><span class="special">(</span><span class="identifier">U</span> <span class="special">*</span> p<span class="special">)</span><span class="special">;</span></pre> +<p><span class="bold"><strong>Effects</strong></span>: p->~U(). </p> +</li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a> <a name="idm46583871514016-bb"></a><span class="identifier">select_on_container_copy_construction</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p><span class="bold"><strong>Returns</strong></span>: Equivalent to <code class="computeroutput">polymorphic_allocator()</code>. </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="idm46583871511328-bb"></a><span class="identifier">resource</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p><span class="bold"><strong>Returns</strong></span>: m_resource. </p> +</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="monotonic_buffer_resource.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.polymorphic_allocator_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="operator_idm46583871492768.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> 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> diff --git a/doc/html/boost/container/pmr/resource_adaptor.html b/doc/html/boost/container/pmr/resource_adaptor.html new file mode 100644 index 0000000000..43ddb64ec1 --- /dev/null +++ b/doc/html/boost/container/pmr/resource_adaptor.html @@ -0,0 +1,55 @@ +<!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>Type definition resource_adaptor</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.resource_adaptor_hpp" title="Header <boost/container/pmr/resource_adaptor.hpp>"> +<link rel="prev" href="resource_adaptor_imp.html" title="Class template resource_adaptor_imp"> +<link rel="next" href="synchronized_pool_resource.html" title="Class synchronized_pool_resource"> +</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="resource_adaptor_imp.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.resource_adaptor_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="synchronized_pool_resource.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.container.pmr.resource_adaptor"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Type definition resource_adaptor</span></h2> +<p>resource_adaptor</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.resource_adaptor_hpp" title="Header <boost/container/pmr/resource_adaptor.hpp>">boost/container/pmr/resource_adaptor.hpp</a>> + +</span> +<span class="keyword">typedef</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="keyword">typename</span> <a class="link" href="../allocator_traits.html" title="Struct template allocator_traits">allocator_traits</a><span class="special"><</span> <span class="identifier">Allocator</span> <span class="special">></span><span class="special">::</span><span class="keyword">template</span> <span class="identifier">rebind_alloc</span><span class="special"><</span> <span class="keyword">char</span> <span class="special">></span> <span class="special">></span> <span class="identifier">resource_adaptor</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idm45555398329696"></a><h2>Description</h2> +<p><code class="computeroutput">resource_adaptor<Allocator></code> is rendered as an alias to <a class="link" href="resource_adaptor_imp.html" title="Class template resource_adaptor_imp">resource_adaptor_imp</a> class template such that Allocator is rebound to a char value type. </p> +</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="resource_adaptor_imp.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.resource_adaptor_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="synchronized_pool_resource.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/container/pmr/resource_adaptor_imp.html b/doc/html/boost/container/pmr/resource_adaptor_imp.html new file mode 100644 index 0000000000..6e988d553a --- /dev/null +++ b/doc/html/boost/container/pmr/resource_adaptor_imp.html @@ -0,0 +1,153 @@ +<!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>Class template resource_adaptor_imp</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.resource_adaptor_hpp" title="Header <boost/container/pmr/resource_adaptor.hpp>"> +<link rel="prev" href="pool_options.html" title="Struct pool_options"> +<link rel="next" href="resource_adaptor.html" title="Type definition resource_adaptor"> +</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="pool_options.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.resource_adaptor_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.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.container.pmr.resource_adaptor_imp"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Class template resource_adaptor_imp</span></h2> +<p>boost::container::pmr::resource_adaptor_imp</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.resource_adaptor_hpp" title="Header <boost/container/pmr/resource_adaptor.hpp>">boost/container/pmr/resource_adaptor.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Allocator<span class="special">></span> +<span class="keyword">class</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="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">container</span><span class="special">::</span><span class="identifier">pmr</span><span class="special">::</span><span class="identifier">memory_resource</span> <span class="special">{</span> +<span class="keyword">public</span><span class="special">:</span> + <span class="comment">// types</span> + <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#idm46583871448800-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#idm46583871447520-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#idm46583871445104-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#idm46583871442848-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#idm46583871440608-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#idm46583871438368-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#idm46583871435376-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#idm46583871453184-bb">public member functions</a></span> + <span class="identifier">allocator_type</span> <span class="special">&</span> <a class="link" href="resource_adaptor_imp.html#idm46583871452624-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#idm46583871450928-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#idm46583871432544-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#idm46583871431968-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#idm46583871427616-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#idm46583871422480-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="idm45555398459024"></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> +<li class="listitem"><p><code class="computeroutput">typename <a class="link" href="../allocator_traits.html" title="Struct template allocator_traits">allocator_traits</a><Allocator>:: const_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 const*</code>.</p></li> +<li class="listitem"><p><code class="computeroutput">typename <a class="link" href="../allocator_traits.html" title="Struct template allocator_traits">allocator_traits</a><Allocator>:: void_pointer</code> shall be identical to <code class="computeroutput">void*</code>.</p></li> +<li class="listitem"><p><code class="computeroutput">typename <a class="link" href="../allocator_traits.html" title="Struct template allocator_traits">allocator_traits</a><Allocator>:: const_void_pointer</code> shall be identical to <code class="computeroutput">void const*</code>. </p></li> +</ul></div> +<p> +</p> +<div class="refsect2"> +<a name="idm45555398443152"></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="idm46583871448800-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="idm46583871447520-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="idm46583871445104-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="idm46583871442848-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="idm46583871440608-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="idm46583871438368-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="idm46583871435376-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="idm45555398392832"></a><h3> +<a name="idm46583871453184-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="idm46583871452624-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="idm46583871450928-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="idm45555398377904"></a><h3> +<a name="idm46583871432544-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="idm46583871431968-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="idm46583871427616-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="idm46583871422480-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> +</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="pool_options.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.resource_adaptor_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.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/container/pmr/set_default_resource.html b/doc/html/boost/container/pmr/set_default_resource.html new file mode 100644 index 0000000000..e5807d1566 --- /dev/null +++ b/doc/html/boost/container/pmr/set_default_resource.html @@ -0,0 +1,58 @@ +<!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>Function set_default_resource</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.global_resource_hpp" title="Header <boost/container/pmr/global_resource.hpp>"> +<link rel="prev" href="null_memory_resource.html" title="Function null_memory_resource"> +<link rel="next" href="get_default_resource.html" title="Function get_default_resource"> +</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="null_memory_resource.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.global_resource_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="get_default_resource.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.container.pmr.set_default_resource"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Function set_default_resource</span></h2> +<p>boost::container::pmr::set_default_resource</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.global_resource_hpp" title="Header <boost/container/pmr/global_resource.hpp>">boost/container/pmr/global_resource.hpp</a>> + +</span> +<a class="link" href="memory_resource.html" title="Class memory_resource">memory_resource</a> <span class="special">*</span> <span class="identifier">set_default_resource</span><span class="special">(</span><a class="link" href="memory_resource.html" title="Class memory_resource">memory_resource</a> <span class="special">*</span> r<span class="special">)</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idm45555399508080"></a><h2>Description</h2> +<p><span class="bold"><strong>Effects</strong></span>: If r is non-null, sets the value of the default memory resource pointer to r, otherwise sets the default memory resource pointer to new_delete_resource().</p> +<p><span class="bold"><strong>Postconditions</strong></span>: get_default_resource() == r.</p> +<p><span class="bold"><strong>Returns</strong></span>: The previous value of the default memory resource pointer.</p> +<p><span class="bold"><strong>Remarks</strong></span>: Calling the set_default_resource and get_default_resource functions shall not incur a data race. A call to the set_default_resource function shall synchronize with subsequent calls to the set_default_resource and get_default_resource functions. </p> +</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="null_memory_resource.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.global_resource_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="get_default_resource.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/container/pmr/set_of.html b/doc/html/boost/container/pmr/set_of.html new file mode 100644 index 0000000000..b66ce8f969 --- /dev/null +++ b/doc/html/boost/container/pmr/set_of.html @@ -0,0 +1,55 @@ +<!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 template set_of</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.set_hpp" title="Header <boost/container/pmr/set.hpp>"> +<link rel="prev" href="multiset_of.html" title="Struct template multiset_of"> +<link rel="next" href="../slist.html" title="Class template slist"> +</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="multiset_of.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.set_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="../slist.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.container.pmr.set_of"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Struct template set_of</span></h2> +<p>boost::container::pmr::set_of</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.set_hpp" title="Header <boost/container/pmr/set.hpp>">boost/container/pmr/set.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Key<span class="special">,</span> <span class="keyword">typename</span> Compare <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">less</span><span class="special"><</span><span class="identifier">Key</span><span class="special">></span><span class="special">,</span> + <span class="keyword">typename</span> Options <span class="special">=</span> <span class="identifier">tree_assoc_defaults</span><span class="special">></span> +<span class="keyword">struct</span> <a class="link" href="set_of.html" title="Struct template set_of">set_of</a> <span class="special">{</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <a class="link" href="../set.html" title="Class template set">boost::container::set</a><span class="special"><</span> <span class="identifier">Key</span><span class="special">,</span> <span class="identifier">Compare</span><span class="special">,</span> <a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a><span class="special"><</span> <span class="identifier">Key</span> <span class="special">></span><span class="special">,</span> <span class="identifier">Options</span> <span class="special">></span> <a name="boost.container.pmr.set_of.type"></a><span class="identifier">type</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></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="multiset_of.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.set_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="../slist.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/container/pmr/slist_of.html b/doc/html/boost/container/pmr/slist_of.html new file mode 100644 index 0000000000..4d82d1c531 --- /dev/null +++ b/doc/html/boost/container/pmr/slist_of.html @@ -0,0 +1,54 @@ +<!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 template slist_of</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.slist_hpp" title="Header <boost/container/pmr/slist.hpp>"> +<link rel="prev" href="../../../std/insert_i_idm46583869902464.html" title="Class template insert_iterator<boost::container::slist< T, Allocator >>"> +<link rel="next" href="../small_vector.html" title="Class template small_vector"> +</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="../../../std/insert_i_idm46583869902464.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.slist_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="../small_vector.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.container.pmr.slist_of"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Struct template slist_of</span></h2> +<p>boost::container::pmr::slist_of</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.slist_hpp" title="Header <boost/container/pmr/slist.hpp>">boost/container/pmr/slist.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> +<span class="keyword">struct</span> <a class="link" href="slist_of.html" title="Struct template slist_of">slist_of</a> <span class="special">{</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <a class="link" href="../slist.html" title="Class template slist">boost::container::slist</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">></span> <a name="boost.container.pmr.slist_of.type"></a><span class="identifier">type</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></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="../../../std/insert_i_idm46583869902464.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.slist_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="../small_vector.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/container/pmr/small_vector_of.html b/doc/html/boost/container/pmr/small_vector_of.html new file mode 100644 index 0000000000..4b2d11889d --- /dev/null +++ b/doc/html/boost/container/pmr/small_vector_of.html @@ -0,0 +1,54 @@ +<!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 template small_vector_of</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.small_vector_hpp" title="Header <boost/container/pmr/small_vector.hpp>"> +<link rel="prev" href="../small_vector_base.html" title="Class template small_vector_base"> +<link rel="next" href="../stable_vector.html" title="Class template stable_vector"> +</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="../small_vector_base.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.small_vector_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="../stable_vector.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.container.pmr.small_vector_of"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Struct template small_vector_of</span></h2> +<p>boost::container::pmr::small_vector_of</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.small_vector_hpp" title="Header <boost/container/pmr/small_vector.hpp>">boost/container/pmr/small_vector.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N<span class="special">></span> +<span class="keyword">struct</span> <a class="link" href="small_vector_of.html" title="Struct template small_vector_of">small_vector_of</a> <span class="special">{</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <a class="link" href="../small_vector.html" title="Class template small_vector">boost::container::small_vector</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">N</span><span class="special">,</span> <a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">></span> <a name="boost.container.pmr.small_vector_of.type"></a><span class="identifier">type</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></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="../small_vector_base.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.small_vector_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="../stable_vector.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/container/pmr/stable_vector_of.html b/doc/html/boost/container/pmr/stable_vector_of.html new file mode 100644 index 0000000000..2f836af042 --- /dev/null +++ b/doc/html/boost/container/pmr/stable_vector_of.html @@ -0,0 +1,54 @@ +<!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 template stable_vector_of</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.stable_vector_hpp" title="Header <boost/container/pmr/stable_vector.hpp>"> +<link rel="prev" href="../stable_vector.html" title="Class template stable_vector"> +<link rel="next" href="../static_vector.html" title="Class template static_vector"> +</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="../stable_vector.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.stable_vector_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="../static_vector.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.container.pmr.stable_vector_of"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Struct template stable_vector_of</span></h2> +<p>boost::container::pmr::stable_vector_of</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.stable_vector_hpp" title="Header <boost/container/pmr/stable_vector.hpp>">boost/container/pmr/stable_vector.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> +<span class="keyword">struct</span> <a class="link" href="stable_vector_of.html" title="Struct template stable_vector_of">stable_vector_of</a> <span class="special">{</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <a class="link" href="../stable_vector.html" title="Class template stable_vector">boost::container::stable_vector</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">></span> <a name="boost.container.pmr.stable_vector_of.type"></a><span class="identifier">type</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></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="../stable_vector.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.stable_vector_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="../static_vector.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/container/pmr/synchronized_pool_resource.html b/doc/html/boost/container/pmr/synchronized_pool_resource.html new file mode 100644 index 0000000000..0414923e0e --- /dev/null +++ b/doc/html/boost/container/pmr/synchronized_pool_resource.html @@ -0,0 +1,194 @@ +<!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>Class synchronized_pool_resource</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.synchronized_pool_resource_hpp" title="Header <boost/container/pmr/synchronized_pool_resource.hpp>"> +<link rel="prev" href="resource_adaptor.html" title="Type definition resource_adaptor"> +<link rel="next" href="unsynchr_idm46583871327984.html" title="Class unsynchronized_pool_resource"> +</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="resource_adaptor.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.synchronized_pool_resource_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="unsynchr_idm46583871327984.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.container.pmr.synchronized_pool_resource"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Class synchronized_pool_resource</span></h2> +<p>boost::container::pmr::synchronized_pool_resource</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.synchronized_pool_resource_hpp" title="Header <boost/container/pmr/synchronized_pool_resource.hpp>">boost/container/pmr/synchronized_pool_resource.hpp</a>> + +</span> +<span class="keyword">class</span> <a class="link" href="synchronized_pool_resource.html" title="Class synchronized_pool_resource">synchronized_pool_resource</a> <span class="special">:</span> + <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">container</span><span class="special">::</span><span class="identifier">pmr</span><span class="special">::</span><span class="identifier">memory_resource</span> +<span class="special">{</span> +<span class="keyword">public</span><span class="special">:</span> + <span class="comment">// <a class="link" href="synchronized_pool_resource.html#boost.container.pmr.synchronized_pool_resourceconstruct-copy-destruct">construct/copy/destruct</a></span> + <a class="link" href="synchronized_pool_resource.html#idm46583871371440-bb"><span class="identifier">synchronized_pool_resource</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="pool_options.html" title="Struct pool_options">pool_options</a> <span class="special">&</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="keyword">noexcept</span><span class="special">;</span> + <a class="link" href="synchronized_pool_resource.html#idm46583871364976-bb"><span class="identifier">synchronized_pool_resource</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <span class="keyword">explicit</span> <a class="link" href="synchronized_pool_resource.html#idm46583871362352-bb"><span class="identifier">synchronized_pool_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="keyword">noexcept</span><span class="special">;</span> + <span class="keyword">explicit</span> <a class="link" href="synchronized_pool_resource.html#idm46583871359088-bb"><span class="identifier">synchronized_pool_resource</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="pool_options.html" title="Struct pool_options">pool_options</a> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <a class="link" href="synchronized_pool_resource.html#idm46583871355648-bb"><span class="identifier">synchronized_pool_resource</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="synchronized_pool_resource.html" title="Class synchronized_pool_resource">synchronized_pool_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="synchronized_pool_resource.html" title="Class synchronized_pool_resource">synchronized_pool_resource</a> + <a class="link" href="synchronized_pool_resource.html#idm46583871353936-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="synchronized_pool_resource.html" title="Class synchronized_pool_resource">synchronized_pool_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="synchronized_pool_resource.html#idm46583871351792-bb"><span class="special">~</span><span class="identifier">synchronized_pool_resource</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="synchronized_pool_resource.html#idm46583871404416-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="synchronized_pool_resource.html#idm46583871403856-bb"><span class="identifier">release</span></a><span class="special">(</span><span class="special">)</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="synchronized_pool_resource.html#idm46583871400992-bb"><span class="identifier">upstream_resource</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <a class="link" href="pool_options.html" title="Struct pool_options">pool_options</a> <a class="link" href="synchronized_pool_resource.html#idm46583871398544-bb"><span class="identifier">options</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="synchronized_pool_resource.html#idm46583871396048-bb"><span class="identifier">pool_count</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="synchronized_pool_resource.html#idm46583871393040-bb"><span class="identifier">pool_index</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="keyword">const</span><span class="special">;</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="synchronized_pool_resource.html#idm46583871387520-bb"><span class="identifier">pool_next_blocks_per_chunk</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="keyword">const</span><span class="special">;</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="synchronized_pool_resource.html#idm46583871382192-bb"><span class="identifier">pool_block</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="keyword">const</span><span class="special">;</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="synchronized_pool_resource.html#idm46583871376928-bb"><span class="identifier">pool_cached_blocks</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="keyword">const</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="synchronized_pool_resource.html#idm46583871350080-bb">protected member functions</a></span> + <span class="keyword">virtual</span> <span class="keyword">void</span> <span class="special">*</span> <a class="link" href="synchronized_pool_resource.html#idm46583871349504-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="synchronized_pool_resource.html#idm46583871340832-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="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="synchronized_pool_resource.html#idm46583871335248-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="idm45555398182256"></a><h2>Description</h2> +<p>A <a class="link" href="synchronized_pool_resource.html" title="Class synchronized_pool_resource">synchronized_pool_resource</a> is a general-purpose memory resources having the following qualities:</p> +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> +<li class="listitem"><p>Each resource owns the allocated memory, and frees it on destruction, even if deallocate has not been called for some of the allocated blocks.</p></li> +<li class="listitem"><p>A pool resource consists of a collection of pools, serving requests for different block sizes. Each individual pool manages a collection of chunks that are in turn divided into blocks of uniform size, returned via calls to do_allocate. Each call to do_allocate(size, alignment) is dispatched to the pool serving the smallest blocks accommodating at least size bytes.</p></li> +<li class="listitem"><p>When a particular pool is exhausted, allocating a block from that pool results in the allocation of an additional chunk of memory from the upstream allocator (supplied at construction), thus replenishing the pool. With each successive replenishment, the chunk size obtained increases geometrically. [ Note: By allocating memory in chunks, the pooling strategy increases the chance that consecutive allocations will be close together in memory. - end note ]</p></li> +<li class="listitem"><p>Allocation requests that exceed the largest block size of any pool are fulfilled directly from the upstream allocator.</p></li> +<li class="listitem"><p>A <a class="link" href="pool_options.html" title="Struct pool_options">pool_options</a> struct may be passed to the pool resource constructors to tune the largest block size and the maximum chunk size.</p></li> +</ul></div> +<p> +</p> +<p>A <a class="link" href="synchronized_pool_resource.html" title="Class synchronized_pool_resource">synchronized_pool_resource</a> may be accessed from multiple threads without external synchronization and may have thread-specific pools to reduce synchronization costs. </p> +<div class="refsect2"> +<a name="idm45555398174768"></a><h3> +<a name="boost.container.pmr.synchronized_pool_resourceconstruct-copy-destruct"></a><code class="computeroutput">synchronized_pool_resource</code> + public + construct/copy/destruct</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><a name="idm46583871371440-bb"></a><span class="identifier">synchronized_pool_resource</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="pool_options.html" title="Struct pool_options">pool_options</a> <span class="special">&</span> opts<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="keyword">noexcept</span><span class="special">;</span></pre> +<p><span class="bold"><strong>Requires</strong></span>: <code class="computeroutput">upstream</code> is the address of a valid memory resource.</p> +<p><span class="bold"><strong>Effects</strong></span>: Constructs a pool resource object that will obtain memory from upstream whenever the pool resource is unable to satisfy a memory request from its own internal data structures. The resulting object will hold a copy of upstream, but will not own the resource to which upstream points. [ Note: The intention is that calls to upstream->allocate() will be substantially fewer than calls to this->allocate() in most cases. - end note The behavior of the pooling mechanism is tuned according to the value of the opts argument.</p> +<p><span class="bold"><strong>Throws</strong></span>: Nothing unless upstream->allocate() throws. It is unspecified if or under what conditions this constructor calls upstream->allocate(). </p> +</li> +<li class="listitem"> +<pre class="literallayout"><a name="idm46583871364976-bb"></a><span class="identifier">synchronized_pool_resource</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>: Same as <code class="computeroutput"><code class="computeroutput"><a class="link" href="unsynchr_idm46583871327984.html" title="Class unsynchronized_pool_resource">unsynchronized_pool_resource</a></code>(pool_options(), get_default_resource())</code>. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">explicit</span> <a name="idm46583871362352-bb"></a><span class="identifier">synchronized_pool_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="keyword">noexcept</span><span class="special">;</span></pre> +<p><span class="bold"><strong>Effects</strong></span>: Same as <code class="computeroutput">unsynchronized_pool_resource(pool_options(), upstream)</code>. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">explicit</span> <a name="idm46583871359088-bb"></a><span class="identifier">synchronized_pool_resource</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="pool_options.html" title="Struct pool_options">pool_options</a> <span class="special">&</span> opts<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<p><span class="bold"><strong>Effects</strong></span>: Same as <code class="computeroutput">unsynchronized_pool_resource(opts, get_default_resource())</code>. </p> +</li> +<li class="listitem"><pre class="literallayout"><a name="idm46583871355648-bb"></a><span class="identifier">synchronized_pool_resource</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="synchronized_pool_resource.html" title="Class synchronized_pool_resource">synchronized_pool_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="synchronized_pool_resource.html" title="Class synchronized_pool_resource">synchronized_pool_resource</a> +<a name="idm46583871353936-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="synchronized_pool_resource.html" title="Class synchronized_pool_resource">synchronized_pool_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="idm46583871351792-bb"></a><span class="special">~</span><span class="identifier">synchronized_pool_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> +</li> +</ol></div> +</div> +<div class="refsect2"> +<a name="idm45555398114128"></a><h3> +<a name="idm46583871404416-bb"></a><code class="computeroutput">synchronized_pool_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="idm46583871403856-bb"></a><span class="identifier">release</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<p><span class="bold"><strong>Effects</strong></span>: Calls Calls <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 deallocate has not been called for some of the allocated blocks. - 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="idm46583871400992-bb"></a><span class="identifier">upstream_resource</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p><span class="bold"><strong>Returns</strong></span>: The value of the upstream argument provided to the constructor of this object. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="pool_options.html" title="Struct pool_options">pool_options</a> <a name="idm46583871398544-bb"></a><span class="identifier">options</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p><span class="bold"><strong>Returns</strong></span>: The options that control the pooling behavior of this resource. The values in the returned struct may differ from those supplied to the pool resource constructor in that values of zero will be replaced with implementation-defined defaults and sizes may be rounded to unspecified granularity. </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="idm46583871396048-bb"></a><span class="identifier">pool_count</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p><span class="bold"><strong>Returns</strong></span>: The number of pools that will be used in the pool resource.</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="idm46583871393040-bb"></a><span class="identifier">pool_index</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="keyword">const</span><span class="special">;</span></pre> +<p><span class="bold"><strong>Returns</strong></span>: The index of the pool that will be used to serve the allocation of <code class="computeroutput">bytes</code>. Returns <code class="computeroutput">pool_count()</code> if <code class="computeroutput">bytes</code> is bigger than <code class="computeroutput">options().largest_required_pool_block</code> (no pool will be used to serve this).</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="idm46583871387520-bb"></a><span class="identifier">pool_next_blocks_per_chunk</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> pool_idx<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p><span class="bold"><strong>Requires</strong></span>: <code class="computeroutput">pool_idx < pool_index()</code></p> +<p><span class="bold"><strong>Returns</strong></span>: The number blocks that will be allocated in the next chunk from the pool specified by <code class="computeroutput">pool_idx</code>.</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="idm46583871382192-bb"></a><span class="identifier">pool_block</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> pool_idx<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p><span class="bold"><strong>Requires</strong></span>: <code class="computeroutput">pool_idx < pool_index()</code></p> +<p><span class="bold"><strong>Returns</strong></span>: The number of bytes of the block that the specified <code class="computeroutput">pool_idx</code> pool manages.</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="idm46583871376928-bb"></a><span class="identifier">pool_cached_blocks</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> pool_idx<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p><span class="bold"><strong>Requires</strong></span>: <code class="computeroutput">pool_idx < pool_index()</code></p> +<p><span class="bold"><strong>Returns</strong></span>: The number of blocks that the specified <code class="computeroutput">pool_idx</code> pool has cached and will be served without calling the upstream_allocator.</p> +<p><span class="bold"><strong>Note</strong></span>: Non-standard extension. </p> +</li> +</ol></div> +</div> +<div class="refsect2"> +<a name="idm45555398036768"></a><h3> +<a name="idm46583871350080-bb"></a><code class="computeroutput">synchronized_pool_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="idm46583871349504-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 pool selected for a block of size bytes is unable to satisfy the memory request from its own internal data structures, it will call <code class="computeroutput">upstream_resource()->allocate()</code> to obtain more memory. If <code class="computeroutput">bytes</code> is larger than that which the largest pool can handle, then memory will be allocated using <code class="computeroutput">upstream_resource()->allocate()</code>.</p> +<p><span class="bold"><strong>Throws</strong></span>: Nothing unless <code class="computeroutput">upstream_resource()->allocate()</code> throws. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm46583871340832-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></pre> +<p><span class="bold"><strong>Effects</strong></span>: Return the memory at p to the pool. It is unspecified if or under what circumstances this operation will result in a call to <code class="computeroutput">upstream_resource()->deallocate()</code>.</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="idm46583871335248-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 unsynchronized_pool_resource*>(&other)</code>. </p> +</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="resource_adaptor.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.synchronized_pool_resource_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="unsynchr_idm46583871327984.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/container/pmr/unsynchr_idm46583871327984.html b/doc/html/boost/container/pmr/unsynchr_idm46583871327984.html new file mode 100644 index 0000000000..d78097b946 --- /dev/null +++ b/doc/html/boost/container/pmr/unsynchr_idm46583871327984.html @@ -0,0 +1,194 @@ +<!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>Class unsynchronized_pool_resource</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.unsynchronized_pool_resource_hpp" title="Header <boost/container/pmr/unsynchronized_pool_resource.hpp>"> +<link rel="prev" href="synchronized_pool_resource.html" title="Class synchronized_pool_resource"> +<link rel="next" href="../scoped_allocator_adaptor.html" title="Class template scoped_allocator_adaptor"> +</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="synchronized_pool_resource.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.unsynchronized_pool_resource_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="../scoped_allocator_adaptor.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.container.pmr.unsynchr_idm46583871327984"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Class unsynchronized_pool_resource</span></h2> +<p>boost::container::pmr::unsynchronized_pool_resource</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.unsynchronized_pool_resource_hpp" title="Header <boost/container/pmr/unsynchronized_pool_resource.hpp>">boost/container/pmr/unsynchronized_pool_resource.hpp</a>> + +</span> +<span class="keyword">class</span> <a class="link" href="unsynchr_idm46583871327984.html" title="Class unsynchronized_pool_resource">unsynchronized_pool_resource</a> <span class="special">:</span> + <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">container</span><span class="special">::</span><span class="identifier">pmr</span><span class="special">::</span><span class="identifier">memory_resource</span> +<span class="special">{</span> +<span class="keyword">public</span><span class="special">:</span> + <span class="comment">// <a class="link" href="unsynchr_idm46583871327984.html#boost.container.pmr.unsynchr_idm46583871327984construct-copy-destruct">construct/copy/destruct</a></span> + <a class="link" href="unsynchr_idm46583871327984.html#idm46583871287088-bb"><span class="identifier">unsynchronized_pool_resource</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="pool_options.html" title="Struct pool_options">pool_options</a> <span class="special">&</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="keyword">noexcept</span><span class="special">;</span> + <a class="link" href="unsynchr_idm46583871327984.html#idm46583871280624-bb"><span class="identifier">unsynchronized_pool_resource</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <span class="keyword">explicit</span> <a class="link" href="unsynchr_idm46583871327984.html#idm46583871278000-bb"><span class="identifier">unsynchronized_pool_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="keyword">noexcept</span><span class="special">;</span> + <span class="keyword">explicit</span> <a class="link" href="unsynchr_idm46583871327984.html#idm46583871274736-bb"><span class="identifier">unsynchronized_pool_resource</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="pool_options.html" title="Struct pool_options">pool_options</a> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <a class="link" href="unsynchr_idm46583871327984.html#idm46583871271296-bb"><span class="identifier">unsynchronized_pool_resource</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="unsynchr_idm46583871327984.html" title="Class unsynchronized_pool_resource">unsynchronized_pool_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="unsynchr_idm46583871327984.html" title="Class unsynchronized_pool_resource">unsynchronized_pool_resource</a> + <a class="link" href="unsynchr_idm46583871327984.html#idm46583871269584-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="unsynchr_idm46583871327984.html" title="Class unsynchronized_pool_resource">unsynchronized_pool_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="unsynchr_idm46583871327984.html#idm46583871267440-bb"><span class="special">~</span><span class="identifier">unsynchronized_pool_resource</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="unsynchr_idm46583871327984.html#idm46583871320064-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="unsynchr_idm46583871327984.html#idm46583871319504-bb"><span class="identifier">release</span></a><span class="special">(</span><span class="special">)</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="unsynchr_idm46583871327984.html#idm46583871316640-bb"><span class="identifier">upstream_resource</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <a class="link" href="pool_options.html" title="Struct pool_options">pool_options</a> <a class="link" href="unsynchr_idm46583871327984.html#idm46583871314192-bb"><span class="identifier">options</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="unsynchr_idm46583871327984.html#idm46583871311696-bb"><span class="identifier">pool_count</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="unsynchr_idm46583871327984.html#idm46583871308688-bb"><span class="identifier">pool_index</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="keyword">const</span><span class="special">;</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="unsynchr_idm46583871327984.html#idm46583871303168-bb"><span class="identifier">pool_next_blocks_per_chunk</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="keyword">const</span><span class="special">;</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="unsynchr_idm46583871327984.html#idm46583871297840-bb"><span class="identifier">pool_block</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="keyword">const</span><span class="special">;</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="unsynchr_idm46583871327984.html#idm46583871292576-bb"><span class="identifier">pool_cached_blocks</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="keyword">const</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="unsynchr_idm46583871327984.html#idm46583871265728-bb">protected member functions</a></span> + <span class="keyword">virtual</span> <span class="keyword">void</span> <span class="special">*</span> <a class="link" href="unsynchr_idm46583871327984.html#idm46583871265152-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="unsynchr_idm46583871327984.html#idm46583871256480-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="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="unsynchr_idm46583871327984.html#idm46583871250896-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="idm45555397846992"></a><h2>Description</h2> +<p>A <a class="link" href="unsynchr_idm46583871327984.html" title="Class unsynchronized_pool_resource">unsynchronized_pool_resource</a> is a general-purpose memory resources having the following qualities:</p> +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> +<li class="listitem"><p>Each resource owns the allocated memory, and frees it on destruction, even if deallocate has not been called for some of the allocated blocks.</p></li> +<li class="listitem"><p>A pool resource consists of a collection of pools, serving requests for different block sizes. Each individual pool manages a collection of chunks that are in turn divided into blocks of uniform size, returned via calls to do_allocate. Each call to do_allocate(size, alignment) is dispatched to the pool serving the smallest blocks accommodating at least size bytes.</p></li> +<li class="listitem"><p>When a particular pool is exhausted, allocating a block from that pool results in the allocation of an additional chunk of memory from the upstream allocator (supplied at construction), thus replenishing the pool. With each successive replenishment, the chunk size obtained increases geometrically. [ Note: By allocating memory in chunks, the pooling strategy increases the chance that consecutive allocations will be close together in memory. - end note ]</p></li> +<li class="listitem"><p>Allocation requests that exceed the largest block size of any pool are fulfilled directly from the upstream allocator.</p></li> +<li class="listitem"><p>A <a class="link" href="pool_options.html" title="Struct pool_options">pool_options</a> struct may be passed to the pool resource constructors to tune the largest block size and the maximum chunk size.</p></li> +</ul></div> +<p> +</p> +<p>An <a class="link" href="unsynchr_idm46583871327984.html" title="Class unsynchronized_pool_resource">unsynchronized_pool_resource</a> class may not be accessed from multiple threads simultaneously and thus avoids the cost of synchronization entirely in single-threaded applications. </p> +<div class="refsect2"> +<a name="idm45555397839504"></a><h3> +<a name="boost.container.pmr.unsynchr_idm46583871327984construct-copy-destruct"></a><code class="computeroutput">unsynchronized_pool_resource</code> + public + construct/copy/destruct</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><a name="idm46583871287088-bb"></a><span class="identifier">unsynchronized_pool_resource</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="pool_options.html" title="Struct pool_options">pool_options</a> <span class="special">&</span> opts<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="keyword">noexcept</span><span class="special">;</span></pre> +<p><span class="bold"><strong>Requires</strong></span>: <code class="computeroutput">upstream</code> is the address of a valid memory resource.</p> +<p><span class="bold"><strong>Effects</strong></span>: Constructs a pool resource object that will obtain memory from upstream whenever the pool resource is unable to satisfy a memory request from its own internal data structures. The resulting object will hold a copy of upstream, but will not own the resource to which upstream points. [ Note: The intention is that calls to upstream->allocate() will be substantially fewer than calls to this->allocate() in most cases. - end note The behavior of the pooling mechanism is tuned according to the value of the opts argument.</p> +<p><span class="bold"><strong>Throws</strong></span>: Nothing unless upstream->allocate() throws. It is unspecified if or under what conditions this constructor calls upstream->allocate(). </p> +</li> +<li class="listitem"> +<pre class="literallayout"><a name="idm46583871280624-bb"></a><span class="identifier">unsynchronized_pool_resource</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>: Same as <code class="computeroutput"><code class="computeroutput"><a class="link" href="unsynchr_idm46583871327984.html" title="Class unsynchronized_pool_resource">unsynchronized_pool_resource</a></code>(pool_options(), get_default_resource())</code>. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">explicit</span> <a name="idm46583871278000-bb"></a><span class="identifier">unsynchronized_pool_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="keyword">noexcept</span><span class="special">;</span></pre> +<p><span class="bold"><strong>Effects</strong></span>: Same as <code class="computeroutput">unsynchronized_pool_resource(pool_options(), upstream)</code>. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">explicit</span> <a name="idm46583871274736-bb"></a><span class="identifier">unsynchronized_pool_resource</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="pool_options.html" title="Struct pool_options">pool_options</a> <span class="special">&</span> opts<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<p><span class="bold"><strong>Effects</strong></span>: Same as <code class="computeroutput">unsynchronized_pool_resource(opts, get_default_resource())</code>. </p> +</li> +<li class="listitem"><pre class="literallayout"><a name="idm46583871271296-bb"></a><span class="identifier">unsynchronized_pool_resource</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="unsynchr_idm46583871327984.html" title="Class unsynchronized_pool_resource">unsynchronized_pool_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="unsynchr_idm46583871327984.html" title="Class unsynchronized_pool_resource">unsynchronized_pool_resource</a> +<a name="idm46583871269584-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="unsynchr_idm46583871327984.html" title="Class unsynchronized_pool_resource">unsynchronized_pool_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="idm46583871267440-bb"></a><span class="special">~</span><span class="identifier">unsynchronized_pool_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> +</li> +</ol></div> +</div> +<div class="refsect2"> +<a name="idm45555397778992"></a><h3> +<a name="idm46583871320064-bb"></a><code class="computeroutput">unsynchronized_pool_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="idm46583871319504-bb"></a><span class="identifier">release</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<p><span class="bold"><strong>Effects</strong></span>: Calls Calls <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 deallocate has not been called for some of the allocated blocks. - 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="idm46583871316640-bb"></a><span class="identifier">upstream_resource</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p><span class="bold"><strong>Returns</strong></span>: The value of the upstream argument provided to the constructor of this object. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="pool_options.html" title="Struct pool_options">pool_options</a> <a name="idm46583871314192-bb"></a><span class="identifier">options</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p><span class="bold"><strong>Returns</strong></span>: The options that control the pooling behavior of this resource. The values in the returned struct may differ from those supplied to the pool resource constructor in that values of zero will be replaced with implementation-defined defaults and sizes may be rounded to unspecified granularity. </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="idm46583871311696-bb"></a><span class="identifier">pool_count</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p><span class="bold"><strong>Returns</strong></span>: The number of pools that will be used in the pool resource.</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="idm46583871308688-bb"></a><span class="identifier">pool_index</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="keyword">const</span><span class="special">;</span></pre> +<p><span class="bold"><strong>Returns</strong></span>: The index of the pool that will be used to serve the allocation of <code class="computeroutput">bytes</code>. Returns <code class="computeroutput">pool_count()</code> if <code class="computeroutput">bytes</code> is bigger than <code class="computeroutput">options().largest_required_pool_block</code> (no pool will be used to serve this).</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="idm46583871303168-bb"></a><span class="identifier">pool_next_blocks_per_chunk</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> pool_idx<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p><span class="bold"><strong>Requires</strong></span>: <code class="computeroutput">pool_idx < pool_index()</code></p> +<p><span class="bold"><strong>Returns</strong></span>: The number blocks that will be allocated in the next chunk from the pool specified by <code class="computeroutput">pool_idx</code>.</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="idm46583871297840-bb"></a><span class="identifier">pool_block</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> pool_idx<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p><span class="bold"><strong>Requires</strong></span>: <code class="computeroutput">pool_idx < pool_index()</code></p> +<p><span class="bold"><strong>Returns</strong></span>: The number of bytes of the block that the specified <code class="computeroutput">pool_idx</code> pool manages.</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="idm46583871292576-bb"></a><span class="identifier">pool_cached_blocks</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> pool_idx<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p><span class="bold"><strong>Requires</strong></span>: <code class="computeroutput">pool_idx < pool_index()</code></p> +<p><span class="bold"><strong>Returns</strong></span>: The number of blocks that the specified <code class="computeroutput">pool_idx</code> pool has cached and will be served without calling the upstream_allocator.</p> +<p><span class="bold"><strong>Note</strong></span>: Non-standard extension. </p> +</li> +</ol></div> +</div> +<div class="refsect2"> +<a name="idm45555397701504"></a><h3> +<a name="idm46583871265728-bb"></a><code class="computeroutput">unsynchronized_pool_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="idm46583871265152-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 pool selected for a block of size bytes is unable to satisfy the memory request from its own internal data structures, it will call <code class="computeroutput">upstream_resource()->allocate()</code> to obtain more memory. If <code class="computeroutput">bytes</code> is larger than that which the largest pool can handle, then memory will be allocated using <code class="computeroutput">upstream_resource()->allocate()</code>.</p> +<p><span class="bold"><strong>Throws</strong></span>: Nothing unless <code class="computeroutput">upstream_resource()->allocate()</code> throws. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idm46583871256480-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></pre> +<p><span class="bold"><strong>Effects</strong></span>: Return the memory at p to the pool. It is unspecified if or under what circumstances this operation will result in a call to <code class="computeroutput">upstream_resource()->deallocate()</code>.</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="idm46583871250896-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 unsynchronized_pool_resource*>(&other)</code>. </p> +</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="synchronized_pool_resource.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.unsynchronized_pool_resource_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="../scoped_allocator_adaptor.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost/container/pmr/vector_of.html b/doc/html/boost/container/pmr/vector_of.html new file mode 100644 index 0000000000..25d1d36134 --- /dev/null +++ b/doc/html/boost/container/pmr/vector_of.html @@ -0,0 +1,54 @@ +<!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 template vector_of</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.vector_hpp" title="Header <boost/container/pmr/vector.hpp>"> +<link rel="prev" href="../vector.html" title="Class template vector"> +<link rel="next" href="../../../container/acknowledgements_notes.html" title="Acknowledgements, notes and links"> +</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="../vector.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.vector_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="../../../container/acknowledgements_notes.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.container.pmr.vector_of"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Struct template vector_of</span></h2> +<p>boost::container::pmr::vector_of</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.vector_hpp" title="Header <boost/container/pmr/vector.hpp>">boost/container/pmr/vector.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> +<span class="keyword">struct</span> <a class="link" href="vector_of.html" title="Struct template vector_of">vector_of</a> <span class="special">{</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <a class="link" href="../vector.html" title="Class template vector">boost::container::vector</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <a class="link" href="polymorphic_allocator.html" title="Class template polymorphic_allocator">polymorphic_allocator</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">></span> <a name="boost.container.pmr.vector_of.type"></a><span class="identifier">type</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></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="../vector.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.vector_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="../../../container/acknowledgements_notes.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> |