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
|
<!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>Chapter 3. Boost.Align</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="libraries.html" title="Part I. The Boost C++ Libraries (BoostBook Subset)">
<link rel="prev" href="string_algo/credits.html" title="Credits">
<link rel="next" href="align/rationale.html" title="Rationale">
</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="string_algo/credits.html"><img src="../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="libraries.html"><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="align/rationale.html"><img src="../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="chapter">
<div class="titlepage"><div>
<div><h2 class="title">
<a name="align"></a>Chapter 3. Boost.Align</h2></div>
<div><div class="author"><h3 class="author">
<span class="firstname">Glen</span> <span class="surname">Fernandes</span>
</h3></div></div>
<div><p class="copyright">Copyright © 2014-2016 Glen Joseph Fernandes</p></div>
<div><div class="legalnotice">
<a name="align.legal"></a><p>
Distributed under the Boost Software License, Version 1.0.
</p>
</div></div>
</div></div>
<div class="toc">
<p><b>Table of Contents</b></p>
<dl class="toc">
<dt><span class="section"><a href="align.html#align.introduction">Introduction</a></span></dt>
<dt><span class="section"><a href="align/rationale.html">Rationale</a></span></dt>
<dt><span class="section"><a href="align/tutorial.html">Tutorial</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="align/tutorial.html#align.tutorial.align">align</a></span></dt>
<dt><span class="section"><a href="align/tutorial.html#align.tutorial.aligned_alloc">aligned_alloc and aligned_free</a></span></dt>
<dt><span class="section"><a href="align/tutorial.html#align.tutorial.aligned_allocator">aligned_allocator</a></span></dt>
<dt><span class="section"><a href="align/tutorial.html#align.tutorial.aligned_allocator_adaptor">aligned_allocator_adaptor</a></span></dt>
<dt><span class="section"><a href="align/tutorial.html#align.tutorial.aligned_delete">aligned_delete</a></span></dt>
<dt><span class="section"><a href="align/tutorial.html#align.tutorial.alignment_of">alignment_of</a></span></dt>
<dt><span class="section"><a href="align/tutorial.html#align.tutorial.assume_aligned">assume_aligned</a></span></dt>
<dt><span class="section"><a href="align/tutorial.html#align.tutorial.is_aligned">is_aligned</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="align/examples.html">Examples</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="align/examples.html#align.examples.aligned_ptr">aligned_ptr and make_aligned</a></span></dt>
<dt><span class="section"><a href="align/examples.html#align.examples.aligned_vector">aligned_vector</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="align/reference.html">Reference</a></span></dt>
<dd><dl>
<dt><span class="section"><a href="align/reference.html#align.reference.align">align</a></span></dt>
<dt><span class="section"><a href="align/reference.html#align.reference.align_down">align_down</a></span></dt>
<dt><span class="section"><a href="align/reference.html#align.reference.align_up">align_up</a></span></dt>
<dt><span class="section"><a href="align/reference.html#align.reference.aligned_alloc">aligned_alloc and aligned_free</a></span></dt>
<dt><span class="section"><a href="align/reference.html#align.reference.aligned_allocator">aligned_allocator</a></span></dt>
<dt><span class="section"><a href="align/reference.html#align.reference.aligned_allocator_adaptor">aligned_allocator_adaptor</a></span></dt>
<dt><span class="section"><a href="align/reference.html#align.reference.aligned_delete">aligned_delete</a></span></dt>
<dt><span class="section"><a href="align/reference.html#align.reference.alignment_of">alignment_of</a></span></dt>
<dt><span class="section"><a href="align/reference.html#align.reference.assume_aligned">assume_aligned</a></span></dt>
<dt><span class="section"><a href="align/reference.html#align.reference.is_aligned">is_aligned</a></span></dt>
</dl></dd>
<dt><span class="section"><a href="align/vocabulary.html">Vocabulary</a></span></dt>
<dt><span class="section"><a href="align/compatibility.html">Compatibility</a></span></dt>
<dt><span class="section"><a href="align/acknowledgments.html">Acknowledgments</a></span></dt>
<dt><span class="section"><a href="align/history.html">History</a></span></dt>
</dl>
</div>
<div class="section">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="align.introduction"></a><a class="link" href="align.html#align.introduction" title="Introduction">Introduction</a>
</h2></div></div></div>
<p>
This library provides an alignment function, aligned allocation and deallocation
functions, an aligned allocator, an aligned allocator adaptor, an aligned deleter,
a type trait to query alignment requirements, a macro to hint pointer alignment,
and a function to verify pointer value alignment.
</p>
<div class="table">
<a name="align.introduction.the_boost_align_library"></a><p class="title"><b>Table 3.1. The Boost.Align Library</b></p>
<div class="table-contents"><table class="table" summary="The Boost.Align Library">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Component
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">align</span></code>
</p>
</td>
<td>
<p>
Pointer alignment function
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">align_up</span></code>, <code class="computeroutput"><span class="identifier">align_down</span></code>
</p>
</td>
<td>
<p>
Pointer and integral alignment functions
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">aligned_alloc</span></code>, <code class="computeroutput"><span class="identifier">aligned_free</span></code>
</p>
</td>
<td>
<p>
Aligned allocation and deallocation functions
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">aligned_allocator</span></code>
</p>
</td>
<td>
<p>
Alignment aware allocator
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">aligned_allocator_adaptor</span></code>
</p>
</td>
<td>
<p>
Alignment aware allocator adaptor
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">aligned_delete</span></code>
</p>
</td>
<td>
<p>
Deleter for deallocation of aligned allocations
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">alignment_of</span></code>
</p>
</td>
<td>
<p>
Trait to query alignment requirement of a type
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">assume_aligned</span></code>
</p>
</td>
<td>
<p>
Macro for static pointer alignment hint
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">is_aligned</span></code>
</p>
</td>
<td>
<p>
Pointer and integral alignment checking
</p>
</td>
</tr>
</tbody>
</table></div>
</div>
<br class="table-break">
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"><p><small>Last revised: September 21, 2016 at 14:37:13 GMT</small></p></td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="string_algo/credits.html"><img src="../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="libraries.html"><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="align/rationale.html"><img src="../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
|
