diff options
| author | Anas Nashif <anas.nashif@intel.com> | 2013-08-26 08:15:55 -0400 |
|---|---|---|
| committer | Anas Nashif <anas.nashif@intel.com> | 2013-08-26 08:15:55 -0400 |
| commit | bb4dd8289b351fae6b55e303f189127a394a1edd (patch) | |
| tree | 77c9c35a31b1459dd7988c2448e797d142530c41 /doc/html/boost/container/scoped_allocator_adaptor.html | |
| parent | 1a78a62555be32868418fe52f8e330c9d0f95d5a (diff) | |
| download | boost-bb4dd8289b351fae6b55e303f189127a394a1edd.tar.gz boost-bb4dd8289b351fae6b55e303f189127a394a1edd.tar.bz2 boost-bb4dd8289b351fae6b55e303f189127a394a1edd.zip | |
Imported Upstream version 1.51.0upstream/1.51.0
Diffstat (limited to 'doc/html/boost/container/scoped_allocator_adaptor.html')
| -rw-r--r-- | doc/html/boost/container/scoped_allocator_adaptor.html | 268 |
1 files changed, 268 insertions, 0 deletions
diff --git a/doc/html/boost/container/scoped_allocator_adaptor.html b/doc/html/boost/container/scoped_allocator_adaptor.html new file mode 100644 index 0000000000..464c14dbb3 --- /dev/null +++ b/doc/html/boost/container/scoped_allocator_adaptor.html @@ -0,0 +1,268 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Class template scoped_allocator_adaptor</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../boost_container_header_reference.html#header.boost.container.scoped_allocator_hpp" title="Header <boost/container/scoped_allocator.hpp>"> +<link rel="prev" href="uses_allocator.html" title="Struct template uses_allocator"> +<link rel="next" href="scoped_allocator_adaptor/rebind.html" title="Struct template rebind"> +</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="uses_allocator.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_container_header_reference.html#header.boost.container.scoped_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="scoped_allocator_adaptor/rebind.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.container.scoped_allocator_adaptor"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Class template scoped_allocator_adaptor</span></h2> +<p>boost::container::scoped_allocator_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.scoped_allocator_hpp" title="Header <boost/container/scoped_allocator.hpp>">boost/container/scoped_allocator.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> OuterAlloc<span class="special">,</span> <span class="keyword">typename</span><span class="special">...</span> InnerAllocs<span class="special">></span> +<span class="keyword">class</span> <a class="link" href="scoped_allocator_adaptor.html" title="Class template scoped_allocator_adaptor">scoped_allocator_adaptor</a> <span class="special">{</span> +<span class="keyword">public</span><span class="special">:</span> + <span class="comment">// <a class="link" href="scoped_allocator_adaptor.html#boost.container.scoped_allocator_adaptortypes">types</a></span> + <span class="keyword">typedef</span> <span class="identifier">OuterAlloc</span> <a name="boost.container.scoped_allocator_adaptor.outer_allocator_type"></a><span class="identifier">outer_allocator_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <a class="link" href="../../allocator_traits.html" title="Struct template allocator_traits">allocator_traits</a><span class="special"><</span> <span class="identifier">OuterAlloc</span> <span class="special">></span> <a class="link" href="scoped_allocator_adaptor.html#boost.container.scoped_allocator_adaptor.outer_traits_type"><span class="identifier">outer_traits_type</span></a><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">base_type</span><span class="special">::</span><span class="identifier">inner_allocator_type</span> <a class="link" href="scoped_allocator_adaptor.html#boost.container.scoped_allocator_adaptor.inner_allocator_type"><span class="identifier">inner_allocator_type</span></a><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">outer_traits_type</span><span class="special">::</span><span class="identifier">value_type</span> <a name="boost.container.scoped_allocator_adaptor.value_type"></a><span class="identifier">value_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">outer_traits_type</span><span class="special">::</span><span class="identifier">size_type</span> <a name="boost.container.scoped_allocator_adaptor.size_type"></a><span class="identifier">size_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">outer_traits_type</span><span class="special">::</span><span class="identifier">difference_type</span> <a name="boost.container.scoped_allocator_adaptor.difference_type"></a><span class="identifier">difference_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">outer_traits_type</span><span class="special">::</span><span class="identifier">pointer</span> <a name="boost.container.scoped_allocator_adaptor.pointer"></a><span class="identifier">pointer</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">outer_traits_type</span><span class="special">::</span><span class="identifier">const_pointer</span> <a name="boost.container.scoped_allocator_adaptor.const_pointer"></a><span class="identifier">const_pointer</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">outer_traits_type</span><span class="special">::</span><span class="identifier">void_pointer</span> <a name="boost.container.scoped_allocator_adaptor.void_pointer"></a><span class="identifier">void_pointer</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">outer_traits_type</span><span class="special">::</span><span class="identifier">const_void_pointer</span> <a name="boost.container.scoped_allocator_adaptor.const_void_pointer"></a><span class="identifier">const_void_pointer</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">base_type</span><span class="special">::</span><span class="identifier">propagate_on_container_copy_assignment</span> <a class="link" href="scoped_allocator_adaptor.html#boost.container.scoped_allocator_adaptor.propagate_on_cont_id411272"><span class="identifier">propagate_on_container_copy_assignment</span></a><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">base_type</span><span class="special">::</span><span class="identifier">propagate_on_container_move_assignment</span> <a class="link" href="scoped_allocator_adaptor.html#boost.container.scoped_allocator_adaptor.propagate_on_cont_id411285"><span class="identifier">propagate_on_container_move_assignment</span></a><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">base_type</span><span class="special">::</span><span class="identifier">propagate_on_container_swap</span> <a class="link" href="scoped_allocator_adaptor.html#boost.container.scoped_allocator_adaptor.propagate_on_cont_id410544"><span class="identifier">propagate_on_container_swap</span></a><span class="special">;</span> + + <span class="comment">// member classes/structs/unions</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> U<span class="special">></span> + <span class="keyword">struct</span> <a class="link" href="scoped_allocator_adaptor/rebind.html" title="Struct template rebind">rebind</a> <span class="special">{</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <a class="link" href="scoped_allocator_adaptor.html" title="Class template scoped_allocator_adaptor">scoped_allocator_adaptor</a><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">outer_traits_type</span><span class="special">::</span><span class="keyword">template</span> <span class="identifier">portable_rebind_alloc</span><span class="special"><</span> <span class="identifier">U</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span><span class="special">,</span> <span class="identifier">InnerAllocs</span><span class="special">...</span> <span class="special">></span> <a class="link" href="scoped_allocator_adaptor/rebind.html#boost.container.scoped_allocator_adaptor.rebind.other"><span class="identifier">other</span></a><span class="special">;</span> + <span class="special">}</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="scoped_allocator_adaptor.html#boost.container.scoped_allocator_adaptorconstruct-copy-destruct">construct/copy/destruct</a></span> + <a class="link" href="scoped_allocator_adaptor.html#id411165-bb"><span class="identifier">scoped_allocator_adaptor</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="scoped_allocator_adaptor.html#id411176-bb"><span class="identifier">scoped_allocator_adaptor</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="scoped_allocator_adaptor.html" title="Class template scoped_allocator_adaptor">scoped_allocator_adaptor</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="scoped_allocator_adaptor.html#id411196-bb"><span class="identifier">scoped_allocator_adaptor</span></a><span class="special">(</span><a class="link" href="scoped_allocator_adaptor.html" title="Class template scoped_allocator_adaptor">scoped_allocator_adaptor</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> OuterA2<span class="special">></span> + <a class="link" href="scoped_allocator_adaptor.html#id411215-bb"><span class="identifier">scoped_allocator_adaptor</span></a><span class="special">(</span><span class="identifier">OuterA2</span> <span class="special">&&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">InnerAllocs</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> OuterA2<span class="special">></span> + <a class="link" href="scoped_allocator_adaptor.html#id410120-bb"><span class="identifier">scoped_allocator_adaptor</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="scoped_allocator_adaptor.html" title="Class template scoped_allocator_adaptor">scoped_allocator_adaptor</a><span class="special"><</span> <span class="identifier">OuterA2</span><span class="special">,</span> <span class="identifier">InnerAllocs</span><span class="special">...</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> OuterA2<span class="special">></span> + <a class="link" href="scoped_allocator_adaptor.html#id410155-bb"><span class="identifier">scoped_allocator_adaptor</span></a><span class="special">(</span><a class="link" href="scoped_allocator_adaptor.html" title="Class template scoped_allocator_adaptor">scoped_allocator_adaptor</a><span class="special"><</span> <span class="identifier">OuterA2</span><span class="special">,</span> <span class="identifier">InnerAllocs</span><span class="special">...</span> <span class="special">></span> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + scoped_allocator_adaptor& <a class="link" href="scoped_allocator_adaptor.html#id410189-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="scoped_allocator_adaptor.html" title="Class template scoped_allocator_adaptor">scoped_allocator_adaptor</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + scoped_allocator_adaptor& <a class="link" href="scoped_allocator_adaptor.html#id410200-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="scoped_allocator_adaptor.html" title="Class template scoped_allocator_adaptor">scoped_allocator_adaptor</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="scoped_allocator_adaptor.html#id411175-bb"><span class="special">~</span><span class="identifier">scoped_allocator_adaptor</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="scoped_allocator_adaptor.html#id410557-bb">public member functions</a></span> + <span class="identifier">outer_allocator_type</span> <span class="special">&</span> <a class="link" href="scoped_allocator_adaptor.html#id410560-bb"><span class="identifier">outer_allocator</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">const</span> <span class="identifier">outer_allocator_type</span> <span class="special">&</span> <a class="link" href="scoped_allocator_adaptor.html#id410577-bb"><span class="identifier">outer_allocator</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">inner_allocator_type</span> <span class="special">&</span> <a class="link" href="scoped_allocator_adaptor.html#id411226-bb"><span class="identifier">inner_allocator</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">inner_allocator_type</span> <span class="keyword">const</span> <span class="special">&</span> <a class="link" href="scoped_allocator_adaptor.html#id411243-bb"><span class="identifier">inner_allocator</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">size_type</span> <a class="link" href="scoped_allocator_adaptor.html#id410598-bb"><span class="identifier">max_size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">void</span> <a class="link" href="scoped_allocator_adaptor.html#id410614-bb"><span class="identifier">destroy</span></a><span class="special">(</span><span class="identifier">T</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">pointer</span> <a class="link" href="scoped_allocator_adaptor.html#id410644-bb"><span class="identifier">allocate</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">pointer</span> <a class="link" href="scoped_allocator_adaptor.html#id410667-bb"><span class="identifier">allocate</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">const_void_pointer</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="scoped_allocator_adaptor.html#id410695-bb"><span class="identifier">deallocate</span></a><span class="special">(</span><span class="identifier">pointer</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="scoped_allocator_adaptor.html" title="Class template scoped_allocator_adaptor">scoped_allocator_adaptor</a> <a class="link" href="scoped_allocator_adaptor.html#id410723-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> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<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="scoped_allocator_adaptor.html#id410750-bb"><span class="identifier">construct</span></a><span class="special">(</span><span class="identifier">T</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> T1<span class="special">,</span> <span class="keyword">typename</span> T2<span class="special">></span> <span class="keyword">void</span> <a class="link" href="scoped_allocator_adaptor.html#id410857-bb"><span class="identifier">construct</span></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">T1</span><span class="special">,</span> <span class="identifier">T2</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> T1<span class="special">,</span> <span class="keyword">typename</span> T2<span class="special">></span> <span class="keyword">void</span> <a class="link" href="scoped_allocator_adaptor.html#id410882-bb"><span class="identifier">construct</span></a><span class="special">(</span><span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">)</span><span class="special">;</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">typename</span> U<span class="special">,</span> <span class="keyword">typename</span> V<span class="special">></span> + <span class="keyword">void</span> <a class="link" href="scoped_allocator_adaptor.html#id410909-bb"><span class="identifier">construct</span></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">T1</span><span class="special">,</span> <span class="identifier">T2</span> <span class="special">></span> <span class="special">*</span><span class="special">,</span> <span class="identifier">U</span> <span class="special">&&</span><span class="special">,</span> <span class="identifier">V</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> T1<span class="special">,</span> <span class="keyword">typename</span> T2<span class="special">,</span> <span class="keyword">typename</span> U<span class="special">,</span> <span class="keyword">typename</span> V<span class="special">></span> + <span class="keyword">void</span> <a class="link" href="scoped_allocator_adaptor.html#id410954-bb"><span class="identifier">construct</span></a><span class="special">(</span><span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">,</span> <span class="identifier">U</span> <span class="special">&&</span><span class="special">,</span> <span class="identifier">V</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> T1<span class="special">,</span> <span class="keyword">typename</span> T2<span class="special">,</span> <span class="keyword">typename</span> U<span class="special">,</span> <span class="keyword">typename</span> V<span class="special">></span> + <span class="keyword">void</span> <a class="link" href="scoped_allocator_adaptor.html#id411001-bb"><span class="identifier">construct</span></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">T1</span><span class="special">,</span> <span class="identifier">T2</span> <span class="special">></span> <span class="special">*</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span> <span class="identifier">U</span><span class="special">,</span> <span class="identifier">V</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> T1<span class="special">,</span> <span class="keyword">typename</span> T2<span class="special">,</span> <span class="keyword">typename</span> U<span class="special">,</span> <span class="keyword">typename</span> V<span class="special">></span> + <span class="keyword">void</span> <a class="link" href="scoped_allocator_adaptor.html#id411041-bb"><span class="identifier">construct</span></a><span class="special">(</span><span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">)</span><span class="special">;</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">typename</span> U<span class="special">,</span> <span class="keyword">typename</span> V<span class="special">></span> + <span class="keyword">void</span> <a class="link" href="scoped_allocator_adaptor.html#id411083-bb"><span class="identifier">construct</span></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">T1</span><span class="special">,</span> <span class="identifier">T2</span> <span class="special">></span> <span class="special">*</span><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">U</span><span class="special">,</span> <span class="identifier">V</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> T1<span class="special">,</span> <span class="keyword">typename</span> T2<span class="special">,</span> <span class="keyword">typename</span> U<span class="special">,</span> <span class="keyword">typename</span> V<span class="special">></span> + <span class="keyword">void</span> <a class="link" href="scoped_allocator_adaptor.html#id411123-bb"><span class="identifier">construct</span></a><span class="special">(</span><span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">)</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id1225316"></a><h2>Description</h2> +<p>This class is a C++03-compatible implementation of std::scoped_allocator_adaptor. The class template <a class="link" href="scoped_allocator_adaptor.html" title="Class template scoped_allocator_adaptor">scoped_allocator_adaptor</a> is an allocator template that specifies the memory resource (the outer allocator) to be used by a container (as any other allocator does) and also specifies an inner allocator resource to be passed to the constructor of every element within the container.</p> +<p>This adaptor is instantiated with one outer and zero or more inner allocator types. If instantiated with only one allocator type, the inner allocator becomes the <a class="link" href="scoped_allocator_adaptor.html" title="Class template scoped_allocator_adaptor">scoped_allocator_adaptor</a> itself, thus using the same allocator resource for the container and every element within the container and, if the elements themselves are containers, each of their elements recursively. If instantiated with more than one allocator, the first allocator is the outer allocator for use by the container, the second allocator is passed to the constructors of the container's elements, and, if the elements themselves are containers, the third allocator is passed to the elements' elements, and so on. If containers are nested to a depth greater than the number of allocators, the last allocator is used repeatedly, as in the single-allocator case, for any remaining recursions.</p> +<p>[<span class="bold"><strong>Note</strong></span>: The <a class="link" href="scoped_allocator_adaptor.html" title="Class template scoped_allocator_adaptor">scoped_allocator_adaptor</a> is derived from the outer allocator type so it can be substituted for the outer allocator type in most expressions. -end note]</p> +<p>In the construct member functions, `OUTERMOST(x)` is x if x does not have an `outer_allocator()` member function and `OUTERMOST(x.outer_allocator())` otherwise; `OUTERMOST_ALLOC_TRAITS(x)` is `allocator_traits<decltype(OUTERMOST(x))>`.</p> +<p>[<span class="bold"><strong>Note</strong></span>: `OUTERMOST(x)` and `OUTERMOST_ALLOC_TRAITS(x)` are recursive operations. It is incumbent upon the definition of `outer_allocator()` to ensure that the recursion terminates. It will terminate for all instantiations of <a class="link" href="scoped_allocator_adaptor.html" title="Class template scoped_allocator_adaptor">scoped_allocator_adaptor</a>. -end note] </p> +<div class="refsect2"> +<a name="id1225397"></a><h3> +<a name="boost.container.scoped_allocator_adaptortypes"></a><code class="computeroutput">scoped_allocator_adaptor</code> + public + types</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<p> +<span class="keyword">typedef</span> <a class="link" href="../../allocator_traits.html" title="Struct template allocator_traits">allocator_traits</a><span class="special"><</span> <span class="identifier">OuterAlloc</span> <span class="special">></span> <a name="boost.container.scoped_allocator_adaptor.outer_traits_type"></a><span class="identifier">outer_traits_type</span><span class="special">;</span></p> +<p>Type: For exposition only </p> +</li> +<li class="listitem"> +<p> +<span class="keyword">typedef</span> <span class="identifier">base_type</span><span class="special">::</span><span class="identifier">inner_allocator_type</span> <a name="boost.container.scoped_allocator_adaptor.inner_allocator_type"></a><span class="identifier">inner_allocator_type</span><span class="special">;</span></p> +<p>Type: `scoped_allocator_adaptor<OuterAlloc>` if `sizeof...(InnerAllocs)` is zero; otherwise, `scoped_allocator_adaptor<InnerAllocs...>`. </p> +</li> +<li class="listitem"> +<p> +<span class="keyword">typedef</span> <span class="identifier">base_type</span><span class="special">::</span><span class="identifier">propagate_on_container_copy_assignment</span> <a name="boost.container.scoped_allocator_adaptor.propagate_on_cont_id411272"></a><span class="identifier">propagate_on_container_copy_assignment</span><span class="special">;</span></p> +<p>Type: `true_type` if `allocator_traits::propagate_on_container_copy_assignment::value` is true for any `A` in the set of `OuterAlloc` and `InnerAllocs...`; otherwise, false_type. </p> +</li> +<li class="listitem"> +<p> +<span class="keyword">typedef</span> <span class="identifier">base_type</span><span class="special">::</span><span class="identifier">propagate_on_container_move_assignment</span> <a name="boost.container.scoped_allocator_adaptor.propagate_on_cont_id411285"></a><span class="identifier">propagate_on_container_move_assignment</span><span class="special">;</span></p> +<p>Type: `true_type` if `allocator_traits::propagate_on_container_move_assignment::value` is true for any `A` in the set of `OuterAlloc` and `InnerAllocs...`; otherwise, false_type. </p> +</li> +<li class="listitem"> +<p> +<span class="keyword">typedef</span> <span class="identifier">base_type</span><span class="special">::</span><span class="identifier">propagate_on_container_swap</span> <a name="boost.container.scoped_allocator_adaptor.propagate_on_cont_id410544"></a><span class="identifier">propagate_on_container_swap</span><span class="special">;</span></p> +<p>Type: `true_type` if `allocator_traits::propagate_on_container_swap::value` is true for any `A` in the set of `OuterAlloc` and `InnerAllocs...`; otherwise, false_type. </p> +</li> +</ol></div> +</div> +<div class="refsect2"> +<a name="id1225645"></a><h3> +<a name="boost.container.scoped_allocator_adaptorconstruct-copy-destruct"></a><code class="computeroutput">scoped_allocator_adaptor</code> + public + construct/copy/destruct</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><a name="id411165-bb"></a><span class="identifier">scoped_allocator_adaptor</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<p><span class="bold"><strong>Effects</strong></span>: value-initializes the OuterAlloc base class and the inner allocator object. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><a name="id411176-bb"></a><span class="identifier">scoped_allocator_adaptor</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="scoped_allocator_adaptor.html" title="Class template scoped_allocator_adaptor">scoped_allocator_adaptor</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> +<p><span class="bold"><strong>Effects</strong></span>: initializes each allocator within the adaptor with the corresponding allocator from other. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><a name="id411196-bb"></a><span class="identifier">scoped_allocator_adaptor</span><span class="special">(</span><a class="link" href="scoped_allocator_adaptor.html" title="Class template scoped_allocator_adaptor">scoped_allocator_adaptor</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 each allocator within the adaptor with the corresponding allocator from other. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> OuterA2<span class="special">></span> + <a name="id411215-bb"></a><span class="identifier">scoped_allocator_adaptor</span><span class="special">(</span><span class="identifier">OuterA2</span> <span class="special">&&</span> outerAlloc<span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">InnerAllocs</span> <span class="special">&</span><span class="special">...</span> innerAllocs<span class="special">)</span><span class="special">;</span></pre> +<p><span class="bold"><strong>Requires</strong></span>: OuterAlloc shall be constructible from OuterA2.</p> +<p><span class="bold"><strong>Effects</strong></span>: initializes the OuterAlloc base class with boost::forward<OuterA2>(outerAlloc) and inner with innerAllocs...(hence recursively initializing each allocator within the adaptor with the corresponding allocator from the argument list). </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> OuterA2<span class="special">></span> + <a name="id410120-bb"></a><span class="identifier">scoped_allocator_adaptor</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="scoped_allocator_adaptor.html" title="Class template scoped_allocator_adaptor">scoped_allocator_adaptor</a><span class="special"><</span> <span class="identifier">OuterA2</span><span class="special">,</span> <span class="identifier">InnerAllocs</span><span class="special">...</span> <span class="special">></span> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> +<p><span class="bold"><strong>Requires</strong></span>: OuterAlloc shall be constructible from OuterA2.</p> +<p><span class="bold"><strong>Effects</strong></span>: initializes each allocator within the adaptor with the corresponding allocator from other. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> OuterA2<span class="special">></span> + <a name="id410155-bb"></a><span class="identifier">scoped_allocator_adaptor</span><span class="special">(</span><a class="link" href="scoped_allocator_adaptor.html" title="Class template scoped_allocator_adaptor">scoped_allocator_adaptor</a><span class="special"><</span> <span class="identifier">OuterA2</span><span class="special">,</span> <span class="identifier">InnerAllocs</span><span class="special">...</span> <span class="special">></span> <span class="special">&&</span> other<span class="special">)</span><span class="special">;</span></pre> +<p><span class="bold"><strong>Requires</strong></span>: OuterAlloc shall be constructible from OuterA2.</p> +<p><span class="bold"><strong>Effects</strong></span>: initializes each allocator within the adaptor with the corresponding allocator rvalue from other. </p> +</li> +<li class="listitem"><pre class="literallayout">scoped_allocator_adaptor& <a name="id410189-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="scoped_allocator_adaptor.html" title="Class template scoped_allocator_adaptor">scoped_allocator_adaptor</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout">scoped_allocator_adaptor& <a name="id410200-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="scoped_allocator_adaptor.html" title="Class template scoped_allocator_adaptor">scoped_allocator_adaptor</a> <span class="special">&&</span> other<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="id411175-bb"></a><span class="special">~</span><span class="identifier">scoped_allocator_adaptor</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +</ol></div> +</div> +<div class="refsect2"> +<a name="id1226277"></a><h3> +<a name="id410557-bb"></a><code class="computeroutput">scoped_allocator_adaptor</code> public member functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">outer_allocator_type</span> <span class="special">&</span> <a name="id410560-bb"></a><span class="identifier">outer_allocator</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<p><span class="bold"><strong>Returns</strong></span>: `static_cast<OuterAlloc&>(*this)`. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">outer_allocator_type</span> <span class="special">&</span> <a name="id410577-bb"></a><span class="identifier">outer_allocator</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>: `static_cast<const OuterAlloc&>(*this)`. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">inner_allocator_type</span> <span class="special">&</span> <a name="id411226-bb"></a><span class="identifier">inner_allocator</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<p><span class="bold"><strong>Returns</strong></span>: this if `sizeof...(InnerAllocs)` is zero; otherwise, inner. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">inner_allocator_type</span> <span class="keyword">const</span> <span class="special">&</span> <a name="id411243-bb"></a><span class="identifier">inner_allocator</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>: this if `sizeof...(InnerAllocs)` is zero; otherwise, inner. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">size_type</span> <a name="id410598-bb"></a><span class="identifier">max_size</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>: `allocator_traits<OuterAlloc>::max_size(outer_allocator())`. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">void</span> <a name="id410614-bb"></a><span class="identifier">destroy</span><span class="special">(</span><span class="identifier">T</span> <span class="special">*</span> p<span class="special">)</span><span class="special">;</span></pre> +<p><span class="bold"><strong>Effects</strong></span>: calls `OUTERMOST_ALLOC_TRAITS(*this)::destroy(OUTERMOST(*this), p)`. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">pointer</span> <a name="id410644-bb"></a><span class="identifier">allocate</span><span class="special">(</span><span class="identifier">size_type</span> n<span class="special">)</span><span class="special">;</span></pre> +<p><span class="bold"><strong>Returns</strong></span>: `allocator_traits<OuterAlloc>::allocate(outer_allocator(), n)`. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">pointer</span> <a name="id410667-bb"></a><span class="identifier">allocate</span><span class="special">(</span><span class="identifier">size_type</span> n<span class="special">,</span> <span class="identifier">const_void_pointer</span> hint<span class="special">)</span><span class="special">;</span></pre> +<p><span class="bold"><strong>Returns</strong></span>: `allocator_traits<OuterAlloc>::allocate(outer_allocator(), n, hint)`. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="id410695-bb"></a><span class="identifier">deallocate</span><span class="special">(</span><span class="identifier">pointer</span> p<span class="special">,</span> <span class="identifier">size_type</span> n<span class="special">)</span><span class="special">;</span></pre> +<p><span class="bold"><strong>Effects</strong></span>: `allocator_traits<OuterAlloc>::deallocate(outer_allocator(), p, n)`. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><a class="link" href="scoped_allocator_adaptor.html" title="Class template scoped_allocator_adaptor">scoped_allocator_adaptor</a> <a name="id410723-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>: A new <code class="computeroutput"><a class="link" href="scoped_allocator_adaptor.html" title="Class template scoped_allocator_adaptor">scoped_allocator_adaptor</a></code> object where each allocator A in the adaptor is initialized from the result of calling `allocator_traits::select_on_container_copy_construction()` on the corresponding allocator in *this. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<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="id410750-bb"></a><span class="identifier">construct</span><span class="special">(</span><span class="identifier">T</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>Effects</strong></span>: 1) If `uses_allocator<T, inner_allocator_type>::value` is false calls `OUTERMOST_ALLOC_TRAITS(*this)::construct (OUTERMOST(*this), p, std::forward<Args>(args)...)`.</p> +<p>2) Otherwise, if `uses_allocator<T, inner_allocator_type>::value` is true and `is_constructible<T, <code class="computeroutput"><a class="link" href="allocator_arg_t.html" title="Struct allocator_arg_t">allocator_arg_t</a></code>, inner_allocator_type, Args...>::value` is true, calls `OUTERMOST_ALLOC_TRAITS(*this)::construct(OUTERMOST(*this), p, allocator_arg, inner_allocator(), std::forward<Args>(args)...)`.</p> +<p>[<span class="bold"><strong>Note</strong></span>: In compilers without advanced decltype SFINAE support, `is_constructible` can't be implemented so that condition will be replaced by constructible_with_allocator_prefix<T>::value. -end note]</p> +<p>3) Otherwise, if uses_allocator<T, inner_allocator_type>::value is true and `is_constructible<T, Args..., inner_allocator_type>::value` is true, calls `OUTERMOST_ALLOC_TRAITS(*this)::construct(OUTERMOST(*this), p, std::forward<Args>(args)..., inner_allocator())`.</p> +<p>[<span class="bold"><strong>Note</strong></span>: In compilers without advanced decltype SFINAE support, `is_constructible` can't be implemented so that condition will be replaced by `constructible_with_allocator_suffix<T>::value`. -end note]</p> +<p>4) Otherwise, the program is ill-formed.</p> +<p>[<span class="bold"><strong>Note</strong></span>: An error will result if `uses_allocator` evaluates to true but the specific constructor does not take an allocator. This definition prevents a silent failure to pass an inner allocator to a contained element. -end note] </p> +</li> +<li class="listitem"><pre class="literallayout"><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">void</span> <a name="id410857-bb"></a><span class="identifier">construct</span><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">T1</span><span class="special">,</span> <span class="identifier">T2</span> <span class="special">></span> <span class="special">*</span> p<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><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">void</span> <a name="id410882-bb"></a><span class="identifier">construct</span><span class="special">(</span><span class="emphasis"><em><span class="identifier">unspecified</span></em></span> p<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><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">typename</span> U<span class="special">,</span> <span class="keyword">typename</span> V<span class="special">></span> + <span class="keyword">void</span> <a name="id410909-bb"></a><span class="identifier">construct</span><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">T1</span><span class="special">,</span> <span class="identifier">T2</span> <span class="special">></span> <span class="special">*</span> p<span class="special">,</span> <span class="identifier">U</span> <span class="special">&&</span> x<span class="special">,</span> <span class="identifier">V</span> <span class="special">&&</span> y<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><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">typename</span> U<span class="special">,</span> <span class="keyword">typename</span> V<span class="special">></span> + <span class="keyword">void</span> <a name="id410954-bb"></a><span class="identifier">construct</span><span class="special">(</span><span class="emphasis"><em><span class="identifier">unspecified</span></em></span> p<span class="special">,</span> <span class="identifier">U</span> <span class="special">&&</span> x<span class="special">,</span> <span class="identifier">V</span> <span class="special">&&</span> y<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><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">typename</span> U<span class="special">,</span> <span class="keyword">typename</span> V<span class="special">></span> + <span class="keyword">void</span> <a name="id411001-bb"></a><span class="identifier">construct</span><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">T1</span><span class="special">,</span> <span class="identifier">T2</span> <span class="special">></span> <span class="special">*</span> p<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span> <span class="identifier">U</span><span class="special">,</span> <span class="identifier">V</span> <span class="special">></span> <span class="special">&</span> x<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><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">typename</span> U<span class="special">,</span> <span class="keyword">typename</span> V<span class="special">></span> + <span class="keyword">void</span> <a name="id411041-bb"></a><span class="identifier">construct</span><span class="special">(</span><span class="emphasis"><em><span class="identifier">unspecified</span></em></span> p<span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> x<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><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">typename</span> U<span class="special">,</span> <span class="keyword">typename</span> V<span class="special">></span> + <span class="keyword">void</span> <a name="id411083-bb"></a><span class="identifier">construct</span><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">T1</span><span class="special">,</span> <span class="identifier">T2</span> <span class="special">></span> <span class="special">*</span> p<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">U</span><span class="special">,</span> <span class="identifier">V</span> <span class="special">></span> <span class="special">&&</span> x<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><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">typename</span> U<span class="special">,</span> <span class="keyword">typename</span> V<span class="special">></span> + <span class="keyword">void</span> <a name="id411123-bb"></a><span class="identifier">construct</span><span class="special">(</span><span class="emphasis"><em><span class="identifier">unspecified</span></em></span> p<span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> x<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-2012 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="uses_allocator.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_container_header_reference.html#header.boost.container.scoped_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="scoped_allocator_adaptor/rebind.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> |