1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
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.79.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#idp46361872-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#idp46363152-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#idp46365568-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#idp46367824-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#idp46370064-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#idp46372304-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#idp46375296-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#idp46357488-bb">public member functions</a></span>
<span class="identifier">allocator_type</span> <span class="special">&</span> <a class="link" href="resource_adaptor_imp.html#idp46358048-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#idp46359744-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#idp46378128-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#idp46378704-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#idp46383056-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#idp46388192-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="idp289161856"></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="idp289177728"></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="idp46361872-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="idp46363152-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="idp46365568-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="idp46367824-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="idp46370064-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="idp46372304-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="idp46375296-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="idp289228048"></a><h3>
<a name="idp46357488-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="idp46358048-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="idp46359744-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="idp289242976"></a><h3>
<a name="idp46378128-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="idp46378704-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="idp46383056-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="idp46388192-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>
|
