-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathuses_allocator.html
More file actions
339 lines (276 loc) · 22.4 KB
/
uses_allocator.html
File metadata and controls
339 lines (276 loc) · 22.4 KB
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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
<!doctype html>
<html class="cpprefjp" lang="ja" itemscope="" itemtype="http://schema.org/WebPage">
<head>
<!-- Google tag (gtag.js) -->
<script async src="https://www.googletagmanager.com/gtag/js?id=G-NXNBNVBTJS"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'G-NXNBNVBTJS');
</script>
<meta charset="UTF-8">
<title>uses_allocator - cpprefjp C++日本語リファレンス</title>
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="keywords" content="
C++,標準ライブラリ,リファレンス,ドキュメント,STL,std,memory,std,class template,cpp11
">
<meta name="title" content="uses_allocator - cpprefjp C++日本語リファレンス" />
<meta itemprop="name" content="uses_allocator - cpprefjp C++日本語リファレンス" />
<meta property="og:title" content="uses_allocator - cpprefjp C++日本語リファレンス" />
<meta property="og:url" content="https://cpprefjp.github.io/reference/memory/uses_allocator.html" />
<meta property="og:site_name" content="cpprefjp - C++日本語リファレンス" />
<meta property="og:type" content="article" />
<meta property="og:description" content="型 `T` が `Alloc` 型のアロケータオブジェクトを用いた uses-allocator 構築をする際に、実際にアロケータオブジェクトを使用するかを調べる。" />
<meta name="twitter:card" content="summary" />
<meta name="twitter:title" content="uses_allocator - cpprefjp C++日本語リファレンス" />
<meta name="twitter:url" content="https://cpprefjp.github.io/reference/memory/uses_allocator.html" />
<meta name="twitter:description" content="型 `T` が `Alloc` 型のアロケータオブジェクトを用いた uses-allocator 構築をする際に、実際にアロケータオブジェクトを使用するかを調べる。" />
<link rel="alternate" type="application/atom+xml" title="Atom" href="https://cpprefjp.github.io/rss.xml" />
<link rel="apple-touch-icon" sizes="180x180" href="../../static/favicons/apple-touch-icon.png?cachebust=be86fa2321ebe02b6955b61b98b778e377bcbf95">
<link rel="icon" type="image/png" sizes="32x32" href="../../static/favicons/favicon-32x32.png?cachebust=be86fa2321ebe02b6955b61b98b778e377bcbf95">
<link rel="icon" type="image/png" sizes="16x16" href="../../static/favicons/favicon-16x16.png?cachebust=be86fa2321ebe02b6955b61b98b778e377bcbf95">
<link rel="manifest" href="../../manifest.json?cachebust=be86fa2321ebe02b6955b61b98b778e377bcbf95">
<meta name="theme-color" content="#f5f8fc">
<link rel="stylesheet" href="../../static/pygments/default.css?cachebust=be86fa2321ebe02b6955b61b98b778e377bcbf95">
<!-- <link rel="stylesheet" href="../../static/css/root.css"> -->
<link href="../../static/kunai/css/kunai-stage-0.css?cachebust=be86fa2321ebe02b6955b61b98b778e377bcbf95" rel="stylesheet">
<link href="../../static/kunai/css/kunai-stage-1.css?cachebust=be86fa2321ebe02b6955b61b98b778e377bcbf95" rel="stylesheet">
<link href="../../static/kunai/css/kunai-stage-2.css?cachebust=be86fa2321ebe02b6955b61b98b778e377bcbf95" rel="stylesheet">
<link href="../../static/kunai/css/kunai-stage-3.css?cachebust=be86fa2321ebe02b6955b61b98b778e377bcbf95" rel="stylesheet">
<script type="text/javascript" src="../../static/kunai/js/kunai-vendor.js?cachebust=be86fa2321ebe02b6955b61b98b778e377bcbf95"></script>
<script type="text/javascript" src="../../static/kunai/js/kunai.js?cachebust=be86fa2321ebe02b6955b61b98b778e377bcbf95"></script>
<script type="text/javascript">
document.addEventListener('DOMContentLoaded', function() {
var kn = new Kunai;
kn.cpprefjp();
});
</script>
</head>
<body>
<header data-kunai-mdinfo="{"meta": {"header": ["memory"], "namespace": ["std"], "id-type": ["class template"], "cpp": ["cpp11"]}, "sources": [{"id": "556016676aa7d7172daac951d7dd94468c6a79f2", "source": "#include <iostream>\n#include <memory>\n\ntemplate <class T, class Allocator = std::allocator<T>>\nstruct X {\n T x_;\n Allocator alloc_;\npublic:\n using allocator_type = Allocator;\n\n X(std::allocator_arg_t, Allocator alloc, T x)\n : alloc_(alloc), x_(x) {}\n};\n\nint main()\n{\n const bool result = std::uses_allocator<X<int>, std::allocator<int>>::value;\n static_assert(result, \"should be true\");\n}\n"}], "page_id": ["reference", "memory", "uses_allocator"]}">
<nav class="navbar navbar-default" role="navigation">
<div class="container-fluid">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../../index.html">
<div class="title-wrapper clearfix">
<div class="title">cpprefjp - C++日本語リファレンス</div>
</div>
</a>
</div>
<div class="collapse navbar-collapse" id="navbar-collapse">
<ul class="nav navbar-nav navbar-right">
<li>
<div class="google-search">
<script>
(function() {
var cx = '013316413321391058734:ji_u66hl7hq';
var gcse = document.createElement('script');
gcse.type = 'text/javascript';
gcse.async = true;
gcse.src = (document.location.protocol == 'https:' ? 'https:' : 'http:') +
'//www.google.com/cse/cse.js?cx=' + cx;
var s = document.getElementsByTagName('script')[0];
s.parentNode.insertBefore(gcse, s);
})();
</script>
<div class="gcse-search"></div>
</div>
</li>
<li>
<a href="https://github.com/cpprefjp/site">GitHub Project</a>
</li>
</ul>
</div>
</div>
</nav>
</header>
<main id="main" role="main">
<div class="container-fluid">
<div class="row">
<div class="col-sm-9 col-sm-push-3" itemscope itemtype="http://schema.org/Article">
<div class="row">
<div class="col-sm-12 google-search-result">
<gcse:searchresults></gcse:searchresults>
</div>
</div>
<div class="row">
<div class="col-sm-12 content-header">
<ol class="breadcrumb">
<li itemscope itemtype="http://www.schema.org/SiteNavigationElement">
<span>
<a href="../../index.html" itemprop="url">
<i class="fa fa-fw fa-home"></i>
</a>
</span>
</li>
<li itemscope itemtype="http://www.schema.org/SiteNavigationElement">
<span>
<a href="../../reference.html" itemprop="url">
<span itemprop="name">リファレンス</span>
</a>
</span>
</li>
<li itemscope itemtype="http://www.schema.org/SiteNavigationElement">
<span>
<a href="../../reference/memory.html" itemprop="url">
<span itemprop="name">memory</span>
</a>
</span>
</li>
<li class="active" itemscope itemtype="http://www.schema.org/SiteNavigationElement">
<span>
<span itemprop="name">uses_allocator</span>
</span>
</li>
</ol>
<div class="crsearch"></div>
</div>
</div>
<div class="row">
<div class="col-sm-12 edit-button">
<p class="text-right"><small>
最終更新日時(UTC):
<span itemprop="datePublished" content="2025-07-08T15:33:39">
2025年07月08日 15時33分39秒
</span>
<br/>
<span itemprop="author" itemscope itemtype="http://schema.org/Person">
<span itemprop="name">Akira Takahashi</span>
</span>
が更新
</small></p>
<p class="text-right">
<a class="history" target="_blank" href="https://github.com/cpprefjp/site/commits/master/reference/memory/uses_allocator.md">
<span class="fa fa-fw fa-clock-o fa-flip-horizontal"></span>履歴
</a>
<a class="edit" target="_blank" href="https://github.com/cpprefjp/site/edit/master/reference/memory/uses_allocator.md">
<span class="fa fa-fw fa-pencil"></span>編集
</a>
</p>
</div>
</div>
<div class="row">
<div class="col-sm-12 content-body">
<div class="identifier-type">class template</div><div class="header"><memory></div><h1 itemprop="name"><span class="namespace" title="namespace std">std::</span><span class="token">uses_allocator</span><span class="cpp cpp11" title="C++11で追加">(C++11)</span></h1>
<div itemprop="articleBody"><p><div class="codehilite"><pre><span></span><code><span class="k">namespace</span><span class="w"> </span><span class="nn">std</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="k">template</span><span class="w"> </span><span class="o"><</span><span class="k">class</span><span class="w"> </span><span class="nc">T</span><span class="p">,</span><span class="w"> </span><span class="k">class</span><span class="w"> </span><span class="nc">Alloc</span><span class="o">></span>
<span class="w"> </span><span class="k">struct</span><span class="w"> </span><span class="nc">uses_allocator</span><span class="p">;</span>
<span class="w"> </span><span class="k">template</span><span class="w"> </span><span class="o"><</span><span class="k">class</span><span class="w"> </span><span class="nc">T</span><span class="p">,</span><span class="w"> </span><span class="k">class</span><span class="w"> </span><span class="nc">Alloc</span><span class="o">></span>
<span class="w"> </span><span class="kr">inline</span><span class="w"> </span><span class="k">constexpr</span><span class="w"> </span><span class="kt">bool</span><span class="w"> </span><span class="n">uses_allocator_v</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">uses_allocator</span><span class="o"><</span><span class="n">T</span><span class="p">,</span><span class="w"> </span><span class="n">Alloc</span><span class="o">>::</span><span class="n">value</span><span class="p">;</span><span class="w"> </span><span class="c1">// C++17 から</span>
<span class="p">}</span>
</code></pre></div>
</p>
<h2>概要</h2>
<p>型 <code>T</code> が <code>Alloc</code> 型のアロケータオブジェクトを用いた uses-allocator 構築をする際に、実際にアロケータオブジェクトを使用するかを調べる。</p>
<p>このクラスが <code><a href="../type_traits/true_type.html">true_type</a></code> から派生する場合、以下のいずれかの構築が可能である：</p>
<ul>
<li><code>T(allocator_arg, alloc, args...)</code> のように、第1引数に <code><a href="allocator_arg_t.html">allocator_arg</a></code>、第2引数に <code>Alloc</code> 型のアロケータオブジェクト <code>alloc</code> をとる構築。</li>
<li><code>T(args..., alloc)</code> のように、最後の引数として <code>Alloc</code> 型のアロケータオブジェクト <code>alloc</code> をとる構築。</li>
</ul>
<p>このクラスのデフォルト実装は、型 <code>T</code> が <code>public</code> なメンバ型 <code>allocator_type</code> を持っており、その型が <code>Alloc</code> から変換可能であれば <code><a href="../type_traits/true_type.html">true_type</a></code> から派生し、そうでなければ <code><a href="../type_traits/false_type.html">false_type</a></code> から派生する。 </p>
<p>型 <code>T</code> が <code>Alloc</code> から変換可能なメンバ型 <code>allocator_type</code> を持っていないが上記いずれかの構築が可能な場合は、<code><a href="../type_traits/true_type.html">true_type</a></code> から派生した本クラステンプレートの特殊化を提供することで、アロケータを用いた構築をサポートしていることを示すことが可能である。</p>
<h3>uses-allocator 構築</h3>
<p>「uses-allocator 構築」とは、型 <code>T</code> のオブジェクト <code>obj</code> を構築する際に、引数とアロケータを <code>T</code> のコンストラクタに適切に引き渡すような構築方法である。</p>
<p>アロケータのオブジェクトを <code>alloc</code>、型を <code>Alloc</code> とし、引数列を <code>v1, v2, ..., vN</code>、その型を <code>V1, V2, ..., VN</code> とすると</p>
<ul>
<li>
<p><code>T</code> がアロケータを利用しない場合（<code>uses_allocator<T, Alloc>::value == false</code>かつ、<code><a href="../type_traits/is_constructible.html">is_constructible</a><T, V1, V2, ..., VN>::value == true</code>ならば）<br />
<code>obj(v1, v2, ..., vN);</code> の形でコンストラクタを呼び出す。</p>
</li>
<li>
<p><code>T</code> がアロケータを利用し、アロケータをコンストラクタ引数の先頭で受け取る場合（<code>uses_allocator<T, Alloc>::value == true</code>かつ、<code><a href="../type_traits/is_constructible.html">is_constructible</a><T, <a href="allocator_arg_t.html">allocator_arg_t</a>, Alloc, V1, V2, ..., VN>::value == true</code>ならば）<br />
<code>obj(allocator_arg, alloc, v1, v2, ..., vN);</code> の形でコンストラクタを呼び出す。</p>
</li>
<li>
<p><code>T</code> がアロケータを利用し、アロケータをコンストラクタ引数の末尾で受け取る場合（<code>uses_allocator<T, Alloc>::value == true</code>かつ、<code><a href="../type_traits/is_constructible.html">is_constructible</a><T, V1, V2, ..., VN, Alloc>::value == true</code>ならば）<br />
<code>obj(v1, v2, ..., vN, alloc);</code> の形でコンストラクタを呼び出す。</p>
</li>
<li>
<p>それ以外の場合、要求された構築はill-formedである。</p>
</li>
</ul>
<p>すなわち、構築したい型がアロケータを利用するならば引数とアロケータを適切な順序でコンストラクタに与えて呼び出し、利用しないならば通常のコンストラクタ呼び出しを行うような構築方法である。</p>
<p>更に上記に加え C++20 以降では、構築する対象の型 <code>T</code> が <code><a href="../utility/pair.html">pair</a></code> の特殊化だった場合には、当該 <code><a href="../utility/pair.html">pair</a></code> のそれぞれの要素に対して再帰的に上記の構築方法を適用することが規定された。</p>
<h2>備考</h2>
<ul>
<li>本型トレイツは、主にスコープアロケータモデルを採用するアロケータで使用されることを意図している。<br />
標準ライブラリでは、<code><a href="../scoped_allocator/scoped_allocator_adaptor.html">scoped_allocator_adaptor</a></code>、<code><a href="../memory_resource/polymorphic_allocator.html">polymorphic_allocator</a></code> クラステンプレートで使用されている。</li>
<li>標準ライブラリで提供されるいくつかの型は本型トレイツの特殊化を提供している。（<code><a href="../tuple/tuple.html">tuple</a></code>、<code><a href="../future/promise.html">promise</a></code>、各種<a class="cpprefjp-defined-word" data-desc="コンテナをラップしたクラス。一部のコンテナインタフェースをもたない場合がある">コンテナアダプタ</a>等） </li>
<li><code><a href="../utility/pair.html">pair</a></code> は <code><a href="../tuple/tuple.html">tuple</a></code> と同列の機能と考えられるが、本型トレイツの特殊化を提供していない。このため、標準ライブラリで提供されるスコープアロケータモデルを採用したアロケータでは C++17 までは独自に <code><a href="../utility/pair.html">pair</a></code> の各要素に対して uses-allocator 構築を適用している（ただし、ネストした <code><a href="../utility/pair.html">pair</a></code> の要素に対してはアロケータは伝播されない）。<br />
スコープアロケータモデルを採用したアロケータを自作する場合には、同様の対応を行う方が良いだろう。<br />
なお、C++20 で <code><a href="../utility/pair.html">pair</a></code> に対する特殊対応を含めた uses-allocator 構築サポートのためのユーティリティ関数が追加されたため、以前に比べて容易に uses-allocator 構築への対応が可能となった。</li>
</ul>
<h2>例</h2>
<p><div class="yata" id="556016676aa7d7172daac951d7dd94468c6a79f2"><div class="codehilite"><pre><span></span><code><span class="cp">#include <a href="../iostream.html"><iostream></a></span>
<span class="cp">#include <a href="../memory.html"><memory></a></span>
<span class="k">template</span><span class="w"> </span><span class="o"><</span><span class="k">class</span><span class="w"> </span><span class="nc">T</span><span class="p">,</span><span class="w"> </span><span class="k">class</span><span class="w"> </span><span class="nc">Allocator</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n"><a href="allocator.html">std::allocator</a></span><span class="o"><</span><span class="n">T</span><span class="o">>></span>
<span class="k">struct</span><span class="w"> </span><span class="nc">X</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="n">T</span><span class="w"> </span><span class="n">x_</span><span class="p">;</span>
<span class="w"> </span><span class="n">Allocator</span><span class="w"> </span><span class="n">alloc_</span><span class="p">;</span>
<span class="k">public</span><span class="o">:</span>
<span class="w"> </span><span class="k">using</span><span class="w"> </span><span class="n">allocator_type</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">Allocator</span><span class="p">;</span>
<span class="w"> </span><span class="n">X</span><span class="p">(</span><span class="n"><a href="allocator_arg_t.html">std::allocator_arg_t</a></span><span class="p">,</span><span class="w"> </span><span class="n">Allocator</span><span class="w"> </span><span class="n">alloc</span><span class="p">,</span><span class="w"> </span><span class="n">T</span><span class="w"> </span><span class="n">x</span><span class="p">)</span>
<span class="w"> </span><span class="o">:</span><span class="w"> </span><span class="n">alloc_</span><span class="p">(</span><span class="n">alloc</span><span class="p">),</span><span class="w"> </span><span class="n">x_</span><span class="p">(</span><span class="n">x</span><span class="p">)</span><span class="w"> </span><span class="p">{}</span>
<span class="p">};</span>
<span class="kt">int</span><span class="w"> </span><span class="nf">main</span><span class="p">()</span>
<span class="p">{</span>
<span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="kt">bool</span><span class="w"> </span><span class="n">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n"><span style="color:#ff0000">std::uses_allocator</span></span><span class="o"><</span><span class="n">X</span><span class="o"><</span><span class="kt">int</span><span class="o">></span><span class="p">,</span><span class="w"> </span><span class="n"><a href="allocator.html">std::allocator</a></span><span class="o"><</span><span class="kt">int</span><span class="o">>>::</span><span class="n">value</span><span class="p">;</span>
<span class="w"> </span><span class="k">static_assert</span><span class="p">(</span><span class="n">result</span><span class="p">,</span><span class="w"> </span><span class="s">"should be true"</span><span class="p">);</span>
<span class="p">}</span>
</code></pre></div>
</div></p>
<h3>出力</h3>
<p><pre><code></code></pre></p>
<h2>バージョン</h2>
<h3>言語</h3>
<ul>
<li>C++11</li>
</ul>
<h3>処理系</h3>
<ul>
<li><a href="../../implementation.html#clang">Clang</a>: 3.0 <span aria-label="検証済" role="img" title="検証済">✅</span></li>
<li><a href="../../implementation.html#gcc">GCC</a>: 4.6.4 <span aria-label="検証済" role="img" title="検証済">✅</span></li>
<li><a href="../../implementation.html#icc">ICC</a>: ??</li>
<li><a href="../../implementation.html#visual_cpp">Visual C++</a>: 2012 <span aria-label="検証済" role="img" title="検証済">✅</span>, 2013 <span aria-label="検証済" role="img" title="検証済">✅</span></li>
</ul>
<h2>関連項目</h2>
<ul>
<li><code><a href="../scoped_allocator/scoped_allocator_adaptor.html">scoped_allocator_adaptor</a></code></li>
<li><code><a href="../memory_resource/polymorphic_allocator.html">polymorphic_allocator</a></code></li>
<li><code><a href="../tuple/tuple.html">tuple</a></code></li>
<li><code><a href="../future/promise.html">promise</a></code></li>
<li><code><a href="uses_allocator_construction_args.html">uses_allocator_construction_args</a></code></li>
<li><code><a href="make_obj_using_allocator.html">make_obj_using_allocator</a></code></li>
<li><code><a href="uninitialized_construct_using_allocator.html">uninitialized_construct_using_allocator</a></code></li>
</ul>
<h2>参照</h2>
<ul>
<li><a href="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2015/p0006r0.html" target="_blank">P0006R0 Adopt Type Traits Variable Templates from Library Fundamentals TS for C++17</a></li>
<li><a href="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2018/p0591r4.pdf" target="_blank">P0591R4 Utility functions to implement uses-allocator construction</a></li>
</ul></div>
</div>
</div>
</div>
<div id="sidebar" class="col-sm-3 col-sm-pull-9">
</div>
</div>
</div>
</main>
<footer class="footer navbar navbar-default">
<div class="container-fluid">
<p><small>
本サイトの情報は、
<a href="https://creativecommons.org/licenses/by/4.0/deed.ja" rel="nofollow">クリエイティブ・コモンズ 表示 4.0 非移植 ライセンス(CC BY)</a>
の下に提供されています。
</small></p>
</div>
</footer>
</body>
</html>