diff options
Diffstat (limited to 'libs/align/doc/html/index.html')
| -rw-r--r-- | libs/align/doc/html/index.html | 226 |
1 files changed, 226 insertions, 0 deletions
diff --git a/libs/align/doc/html/index.html b/libs/align/doc/html/index.html new file mode 100644 index 0000000000..a543cd00b8 --- /dev/null +++ b/libs/align/doc/html/index.html @@ -0,0 +1,226 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Chapter 1. Boost.Align</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="Chapter 1. Boost.Align"> +<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="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 1. 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, 2015 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> +<dt><span class="section"><a href="index.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="index.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 1.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: May 05, 2016 at 21:18:23 GMT</small></p></td> +<td align="right"><div class="copyright-footer"></div></td> +</tr></table> +<hr> +<div class="spirit-nav"><a accesskey="n" href="align/rationale.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a></div> +</body> +</html> |