Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r68849 - in sandbox/endian_ext/libs/integer/endian/doc: . html html/toward_boost_integer_endian
From: vicente.botet_at_[hidden]
Date: 2011-02-13 14:58:07

Author: viboes
Date: 2011-02-13 14:58:05 EST (Sun, 13 Feb 2011)
New Revision: 68849
URL: http://svn.boost.org/trac/boost/changeset/68849

Log:
Integer.Endian: Update doc
Added:
   sandbox/endian_ext/libs/integer/endian/doc/html/
   sandbox/endian_ext/libs/integer/endian/doc/html/index.html (contents, props changed)
   sandbox/endian_ext/libs/integer/endian/doc/html/standalone_HTML.manifest (contents, props changed)
   sandbox/endian_ext/libs/integer/endian/doc/html/toward_boost_integer_endian/
   sandbox/endian_ext/libs/integer/endian/doc/html/toward_boost_integer_endian/appendices.html (contents, props changed)
   sandbox/endian_ext/libs/integer/endian/doc/html/toward_boost_integer_endian/overview.html (contents, props changed)
   sandbox/endian_ext/libs/integer/endian/doc/html/toward_boost_integer_endian/reference.html (contents, props changed)
   sandbox/endian_ext/libs/integer/endian/doc/html/toward_boost_integer_endian/users_guide.html (contents, props changed)
   sandbox/endian_ext/libs/integer/endian/doc/integer_endian.pdf (contents, props changed)
Text files modified:
   sandbox/endian_ext/libs/integer/endian/doc/Jamfile.v2 | 18
   sandbox/endian_ext/libs/integer/endian/doc/integer_endian.qbk | 558 +++++++++++++++++++++------------------
   2 files changed, 315 insertions(+), 261 deletions(-)

Modified: sandbox/endian_ext/libs/integer/endian/doc/Jamfile.v2
==============================================================================
--- sandbox/endian_ext/libs/integer/endian/doc/Jamfile.v2 (original)
+++ sandbox/endian_ext/libs/integer/endian/doc/Jamfile.v2 2011-02-13 14:58:05 EST (Sun, 13 Feb 2011)
@@ -33,7 +33,7 @@
 # Use graphics not text for navigation:
 <xsl:param>navig.graphics=1
 # How far down we chunk nested sections, basically all of them:
- <xsl:param>chunk.section.depth=2
+ <xsl:param>chunk.section.depth=1
 # Don't put the first section on the same page as the TOC:
 <xsl:param>chunk.first.sections=1
 # How far down sections get TOC's
@@ -47,15 +47,15 @@
 # Path for libraries index:
 <xsl:param>boost.libraries=../../../../libs/libraries.htm
 # Use the main Boost stylesheet:
- <xsl:param>html.stylesheet=../../../../doc/html/boostbook.css
+ <xsl:param>html.stylesheet=../../../../doc/src/boostbook.css

 # PDF Options:
 # TOC Generation: this is needed for FOP-0.9 and later:
- #<xsl:param>fop1.extensions=1
+ <format>pdf:<xsl:param>fop1.extensions=0
 # Or enable this if you're using XEP:
- <xsl:param>xep.extensions=1
+ <format>pdf:<xsl:param>xep.extensions=1
 # TOC generation: this is needed for FOP 0.2, but must not be set to zero for FOP-0.9!
- <xsl:param>fop.extensions=0
+ <format>pdf:<xsl:param>fop.extensions=0
 # No indent on body text:
 <xsl:param>body.start.indent=0pt
 # Margin size:
@@ -68,5 +68,9 @@
 # default pnd graphics are awful in PDF form,
 # better use SVG's instead:
 <format>pdf:<xsl:param>admon.graphics.extension=".svg"
- <format>pdf:<xsl:param>admon.graphics.path=$(boost-images)/
- ;
+ <format>pdf:<xsl:param>admon.graphics.path=$(boost-images)
+ <format>pdf:<xsl:param>boost.url.prefix=http://www.boost.org/doc/libs/release/libs/endian/doc/html
+ ;
+
+install pdf-install : standalone : <location>. <install-type>PDF ;
+

Added: sandbox/endian_ext/libs/integer/endian/doc/html/index.html
==============================================================================
--- (empty file)
+++ sandbox/endian_ext/libs/integer/endian/doc/html/index.html 2011-02-13 14:58:05 EST (Sun, 13 Feb 2011)
@@ -0,0 +1,119 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Toward Boost.Integer.Endian 0.2.0</title>
+<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="index.html" title="Toward Boost.Integer.Endian 0.2.0">
+<link rel="next" href="toward_boost_integer_endian/overview.html" title="Overview">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav"><a accesskey="n" href="toward_boost_integer_endian/overview.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a></div>
+<div class="article">
+<div class="titlepage">
+<div>
+<div><h2 class="title">
+<a name="toward_boost_integer_endian"></a>Toward Boost.Integer.Endian 0.2.0</h2></div>
+<div><div class="authorgroup">
+<div class="author"><h3 class="author">
+Beman Dawes
+</h3></div>
+<div class="author"><h3 class="author">
+Vicente J. Botet Escriba
+</h3></div>
+</div></div>
+<div>Copyright © 2006 -2009 Beman Dawes</div>
+<div>Copyright © 2010 Vicente J. Botet Escriba</div>
+<div><div class="legalnotice">
+<a name="id2922534"></a>
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></div>
+</div>
+<hr>
+</div>
+<div class="toc">
+Table of Contents
+<dl>
+<dt>Overview</dt>
+<dd><dl>
+<dt>Motivation</dt>
+<dt>Description</dt>
+</dl></dd>
+<dt>Users'Guide</dt>
+<dd><dl>
+<dt><a href="toward_boost_integer_endian/users_guide.html#toward_boost_integer_endian.users_guide.getting_started">Getting
+ Started</a></dt>
+<dt>Tutorial</dt>
+<dt>Examples</dt>
+<dt>References</dt>
+</dl></dd>
+<dt>Reference</dt>
+<dd><dl>
+<dt><a href="toward_boost_integer_endian/reference.html#toward_boost_integer_endian.reference.binary_stream_hpp">Header
+ <code class="computeroutput"><boost/binary_stream.hpp></code></a></dt>
+<dt><a href="toward_boost_integer_endian/reference.html#toward_boost_integer_endian.reference.integer_endianness_hpp">Header
+ <code class="computeroutput"><boost/integer/endian/endiannes.hpp></code></a></dt>
+<dt><a href="toward_boost_integer_endian/reference.html#toward_boost_integer_endian.reference.endian_domain_map_hpp">Header
+ <code class="computeroutput"><boost/integer/endian/domain_map.hpp></code></a></dt>
+<dt><a href="toward_boost_integer_endian/reference.html#toward_boost_integer_endian.reference.integer_endian_pack_hpp">Header
+ <code class="computeroutput"><boost/integer/endian/endian_pack.hpp></code></a></dt>
+<dt><a href="toward_boost_integer_endian/reference.html#toward_boost_integer_endian.reference.integer_endian_hpp">Header
+ <code class="computeroutput"><boost/integer/endian/endian.hpp></code></a></dt>
+<dt><a href="toward_boost_integer_endian/reference.html#toward_boost_integer_endian.reference.integer_endian_binary_stream_hpp">Header
+ <code class="computeroutput"><boost/integer/endian/endian_binary_stream.hpp></code></a></dt>
+<dt><a href="toward_boost_integer_endian/reference.html#toward_boost_integer_endian.reference.integer_endian_type_hpp">Header
+ <code class="computeroutput"><boost/integer/endian/endian_type.hpp></code></a></dt>
+<dt><a href="toward_boost_integer_endian/reference.html#toward_boost_integer_endian.reference.integer_endian_view_hpp">Header
+ <code class="computeroutput"><boost/integer/endian/endian_view.hpp></code></a></dt>
+<dt><a href="toward_boost_integer_endian/reference.html#toward_boost_integer_endian.reference.integer_endian_conversion_hpp">Header
+ <code class="computeroutput"><boost/integer/endian/endian_conversion.hpp></code></a></dt>
+</dl></dd>
+<dt>Appendices</dt>
+<dd><dl>
+<dt><a href="toward_boost_integer_endian/appendices.html#toward_boost_integer_endian.appendices.history">Appendix
+ A: History</a></dt>
+<dt><a href="toward_boost_integer_endian/appendices.html#toward_boost_integer_endian.appendices.rationale">Appendix
+ B: Rationale</a></dt>
+<dt><a href="toward_boost_integer_endian/appendices.html#toward_boost_integer_endian.appendices.implementation">Appendix
+ C: Implementation Notes</a></dt>
+<dt><a href="toward_boost_integer_endian/appendices.html#toward_boost_integer_endian.appendices.acknowledgements">Appendix
+ D: Acknowledgements</a></dt>
+<dt><a href="toward_boost_integer_endian/appendices.html#toward_boost_integer_endian.appendices.appendix_e__tests">Appendix
+ E: Tests</a></dt>
+<dt><a href="toward_boost_integer_endian/appendices.html#toward_boost_integer_endian.appendices.appendix_f__tickets">Appendix
+ F: Tickets</a></dt>
+<dt><a href="toward_boost_integer_endian/appendices.html#toward_boost_integer_endian.appendices.todo">Appendix
+ G: Future plans</a></dt>
+</dl></dd>
+</dl>
+</div>
+<div class="warning"><table border="0" summary="Warning">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="../../../../doc/src/images/warning.png"></td>
+<th align="left">Warning</th>
+</tr>
+<tr><td align="left" valign="top">
+ Boost.Integer.Endian.Ext is not a part of
+ the Boost libraries.
+ </td></tr>
+</table></div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left">Last revised: February 13, 2011 at 18:09:53 GMT</td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav"><a accesskey="n" href="toward_boost_integer_endian/overview.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a></div>
+</body>
+</html>

Added: sandbox/endian_ext/libs/integer/endian/doc/html/standalone_HTML.manifest
==============================================================================
--- (empty file)
+++ sandbox/endian_ext/libs/integer/endian/doc/html/standalone_HTML.manifest 2011-02-13 14:58:05 EST (Sun, 13 Feb 2011)
@@ -0,0 +1,5 @@
+index.html
+toward_boost_integer_endian/overview.html
+toward_boost_integer_endian/users_guide.html
+toward_boost_integer_endian/reference.html
+toward_boost_integer_endian/appendices.html

Added: sandbox/endian_ext/libs/integer/endian/doc/html/toward_boost_integer_endian/appendices.html
==============================================================================
--- (empty file)
+++ sandbox/endian_ext/libs/integer/endian/doc/html/toward_boost_integer_endian/appendices.html 2011-02-13 14:58:05 EST (Sun, 13 Feb 2011)
@@ -0,0 +1,1035 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Appendices</title>
+<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../index.html" title="Toward Boost.Integer.Endian 0.2.0">
+<link rel="up" href="../index.html" title="Toward Boost.Integer.Endian 0.2.0">
+<link rel="prev" href="reference.html" title="Reference">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="reference.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="toward_boost_integer_endian.appendices"></a><a class="link" href="appendices.html" title="Appendices">Appendices</a>
+</h2></div></div></div>
+<div class="toc"><dl>
+<dt><a href="appendices.html#toward_boost_integer_endian.appendices.history">Appendix
+ A: History</a></dt>
+<dd><dl>
+<dt>Version 0.2.0, Febraury 15, 2011 </dt>
+<dt>Version 0.1.0, June 15, 2010</dt>
+</dl></dd>
+<dt><a href="appendices.html#toward_boost_integer_endian.appendices.rationale">Appendix
+ B: Rationale</a></dt>
+<dt><a href="appendices.html#toward_boost_integer_endian.appendices.implementation">Appendix
+ C: Implementation Notes</a></dt>
+<dt><a href="appendices.html#toward_boost_integer_endian.appendices.acknowledgements">Appendix
+ D: Acknowledgements</a></dt>
+<dt><a href="appendices.html#toward_boost_integer_endian.appendices.appendix_e__tests">Appendix
+ E: Tests</a></dt>
+<dd><dl>
+<dt>binary_stream_test</dt>
+<dt>integer_endian_pack_test</dt>
+<dt>integer_endian_test</dt>
+<dt>integer_endian_arithmetic_operation_test</dt>
+<dt>integer_endian_view_test</dt>
+<dt>integer_endian_convert_test</dt>
+</dl></dd>
+<dt><a href="appendices.html#toward_boost_integer_endian.appendices.appendix_f__tickets">Appendix
+ F: Tickets</a></dt>
+<dt><a href="appendices.html#toward_boost_integer_endian.appendices.todo">Appendix
+ G: Future plans</a></dt>
+</dl></div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_integer_endian.appendices.history"></a><a class="link" href="appendices.html#toward_boost_integer_endian.appendices.history" title="Appendix A: History">Appendix
+ A: History</a>
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt>Version 0.2.0, Febraury 15, 2011 </dt>
+<dt>Version 0.1.0, June 15, 2010</dt>
+</dl></div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_integer_endian.appendices.history.__version_0_2_0__febraury_15__2011__"></a><a class="link" href="appendices.html#toward_boost_integer_endian.appendices.history.__version_0_2_0__febraury_15__2011__" title="Version 0.2.0, Febraury 15, 2011">Version 0.2.0, Febraury 15, 2011 </a>
+</h4></div></div></div>
+
+ Move to boost/integer/endian directory.
+ 
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_integer_endian.appendices.history.__version_0_1_0__june_15__2010_"></a><a class="link" href="appendices.html#toward_boost_integer_endian.appendices.history.__version_0_1_0__june_15__2010_" title="Version 0.1.0, June 15, 2010">Version 0.1.0, June 15, 2010</a>
+</h4></div></div></div>
+
+ Split of Boost.Integer.Endian + Added Endian views.
+ 
+
+ Features:
+ 
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+
+ Endian packs
+ 
+<div class="itemizedlist"><ul class="itemizedlist" type="circle">
+<li class="listitem">
+ Big endian | little endian | native endian byte ordering.
+ </li>
+<li class="listitem">
+ Signed | unsigned
+ </li>
+<li class="listitem">
+ Unaligned | aligned
+ </li>
+<li class="listitem">
+ 1-8 byte (unaligned) | 2, 4, 8 byte (aligned)
+ </li>
+<li class="listitem">
+ Choice of integer value type
+ </li>
+</ul></div>
+</li>
+<li class="listitem">
+ Endian integers with the whole set of arithmetics operators based on
+ endian pack.
+ </li>
+<li class="listitem">
+ Operators <= and => for unformatted binary (as opposed to formatted
+ character) stream insertion and extraction of built-in, std::string
+ types and of endian types.
+ </li>
+<li class="listitem">
+ Views of aligned endian unaware integer types as endian packs or endian
+ integers so we can make endian conversion.
+ </li>
+<li class="listitem">
+
+ Generic in place conversion between different endian formats.
+ 
+<div class="itemizedlist"><ul class="itemizedlist" type="circle">
+<li class="listitem">
+ Very simple interface: convert_to/from<endiannes domain>(),
+ </li>
+<li class="listitem">
+ Support for built-in and user-defined data types view as fusion
+ sequences.
+ </li>
+</ul></div>
+</li>
+</ul></div>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_integer_endian.appendices.rationale"></a><a class="link" href="appendices.html#toward_boost_integer_endian.appendices.rationale" title="Appendix B: Rationale">Appendix
+ B: Rationale</a>
+</h3></div></div></div>
+<a name="toward_boost_integer_endian.appendices.rationale.design_considerations_for__emphasis_role__bold__boost_integer_endian_ext__emphasis_"></a><h5>
+<a name="id2967515"></a>
+ <a class="link" href="appendices.html#toward_boost_integer_endian.appendices.rationale.design_considerations_for__emphasis_role__bold__boost_integer_endian_ext__emphasis_">Design
+ considerations for Boost.Integer.Endian.Ext</a>
+ </h5>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ Must be suitable for I/O - in other words, must be memcpyable.
+ </li>
+<li class="listitem">
+ Must provide exactly the size and internal byte ordering specified.
+ </li>
+<li class="listitem">
+ Must work correctly when the internal integer representation has more
+ bits that the sum of the bits in the external byte representation. Sign
+ extension must work correctly when the internal integer representation
+ type has more bits than the sum of the bits in the external bytes. For
+ example, using a 64-bit integer internally to represent 40-bit (5 byte)
+ numbers must work for both positive and negative values.
+ </li>
+<li class="listitem">
+ Must work correctly (including using the same defined external representation)
+ regardless of whether a compiler treats char as signed or unsigned.
+ </li>
+<li class="listitem">
+ Unaligned types must not cause compilers to insert padding bytes.
+ </li>
+<li class="listitem">
+ The implementation should supply optimizations only in very limited circumstances.
+ Experience has shown that optimizations of endian integers often become
+ pessimizations. While this may be obvious when changing machines or compilers,
+ it also happens when changing compiler switches, compiler versions, or
+ CPU models of the same architecture.
+ </li>
+<li class="listitem">
+ It is better software engineering if the same implementation works regardless
+ of the CPU endianness. In other words, #ifdefs should be avoided where
+ possible.
+ </li>
+</ul></div>
+<a name="toward_boost_integer_endian.appendices.rationale.experience"></a><h5>
+<a name="id2967623"></a>
+ <a class="link" href="appendices.html#toward_boost_integer_endian.appendices.rationale.experience">Experience</a>
+ </h5>
+
+ Classes with similar functionality have been independently developed by several
+ Boost programmers and used very successful in high-value, high-use applications
+ for many years. These independently developed endian libraries often evolved
+ from C libraries that were also widely used. Endian integers have proven
+ widely useful across a wide range of computer architectures and applications.
+ 
+<a name="toward_boost_integer_endian.appendices.rationale.motivating_use_cases"></a><h5>
+<a name="id2967656"></a>
+ <a class="link" href="appendices.html#toward_boost_integer_endian.appendices.rationale.motivating_use_cases">Motivating
+ use cases</a>
+ </h5>
+
+ Neil Mayhew writes: "I can also provide a meaningful use-case for this
+ library: reading TrueType font files from disk and processing the contents.
+ The data format has fixed endianness (big) and has unaligned values in various
+ places. Using Boost.Integer.Endian.Ext simplifies
+ and cleans the code wonderfully."
+ 
+<a name="toward_boost_integer_endian.appendices.rationale.c__0x"></a><h5>
+<a name="id2967693"></a>
+ <a class="link" href="appendices.html#toward_boost_integer_endian.appendices.rationale.c__0x">C++0x</a>
+ </h5>
+
+ The availability of the C++0x Defaulted Functions feature is detected automatically,
+ and will be used if present to ensure that objects of class endian are trivial,
+ and thus POD's.
+ 
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_integer_endian.appendices.implementation"></a><a class="link" href="appendices.html#toward_boost_integer_endian.appendices.implementation" title="Appendix C: Implementation Notes">Appendix
+ C: Implementation Notes</a>
+</h3></div></div></div>
+<a name="toward_boost_integer_endian.appendices.implementation.faq"></a><h5>
+<a name="id2967741"></a>
+ <a class="link" href="appendices.html#toward_boost_integer_endian.appendices.implementation.faq">FAQ</a>
+ </h5>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ Why bother with endian types? External
+ data portability and both speed and space efficiency. Availability of
+ additional binary integer sizes and alignments is important in some applications.
+ </li>
+<li class="listitem">
+ Why not just use Boost.Serialization?
+ Serialization involves a conversion for every object involved in I/O.
+ Endian objects require no conversion or copying. They are already in
+ the desired format for binary I/O. Thus they can be read or written in
+ bulk.
+ </li>
+<li class="listitem">
+ Why bother with binary I/O? Why not just use C++
+ Standard Library stream inserters and extractors? Using binary
+ rather than character representations can be more space efficient, with
+ a side benefit of faster I/O. CPU time is minimized because conversions
+ to and from string are eliminated. Furthermore, binary integers are fixed
+ size, and so fixed-size disk records are possible, easing sorting and
+ allowing direct access. Disadvantages, such as the inability to use text
+ utilities on the resulting files, limit usefulness to applications where
+ the binary I/O advantages are paramount.
+ </li>
+<li class="listitem">
+ Do these types have any uses outside of I/O?
+ Probably not, except for native endianness which can be used for fine
+ grained control over size and alignment.
+ </li>
+<li class="listitem">
+ Is there a performance hit when doing arithmetic
+ using integer endian types? Yes, for sure, compared to arithmetic
+ operations on native integer types. However, these types are usually
+ be faster, and sometimes much faster, for I/O compared to stream inserters
+ and extractors, or to serialization.
+ </li>
+<li class="listitem">
+ Are endian types POD's? Yes for C++0x.
+ No for C++03, although several macros are available to force PODness
+ in all cases.
+ </li>
+<li class="listitem">
+ What are the implications endian types not being
+ POD's with C++03 compilers? They can't be used in unions.
+ Also, compilers aren't required to align or lay out storage in portable
+ ways, although this potential problem hasn't prevented use of Boost.Integer.Endian.Ext with real compilers.
+ </li>
+<li class="listitem">
+ Which is better, big-endian or little-endian?
+ Big-endian tends to be a bit more of an industry standard, but little-endian
+ may be preferred for applications that run primarily on x86 (Intel/AMD)
+ and other little-endian CPU's. The Wikipedia
+ article gives more pros and cons.
+ </li>
+<li class="listitem">
+ What good is native endianness? It provides
+ alignment and size guarantees not available from the built-in types.
+ It eases generic programming.
+ </li>
+<li class="listitem">
+ Why bother with the aligned endian types?
+ Aligned integer operations may be faster (20 times, in one measurement)
+ if the endianness and alignment of the type matches the endianness and
+ alignment requirements of the machine. On common CPU architectures, that
+ optimization is only available for aligned types. That allows I/O of
+ maximally efficient types on an application's primary platform, yet produces
+ data files are portable to all platforms. The code, however, is likely
+ to be more fragile and less portable than with the unaligned types.
+ </li>
+<li class="listitem">
+ Endian types are really just byte-holders. Why
+ provide the arithmetic operations at all? Providing a full
+ set of operations reduces program clutter and makes code both easier
+ to write and to read. Consider incrementing a variable in a record. It
+ is very convenient to write:
+ </li>
+</ul></div>
+<pre class="programlisting">++record.foo;
+</pre>
+
+ Rather than:
+ 
+<pre class="programlisting">int temp( record.foo);
+++temp;
+record.foo = temp;
+</pre>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
+ Why do binary stream insertion and extraction use
+ operators <= and >= rather than <<= and >>=?
+ <<= and >>= associate right-to-left, which is the opposite
+ of << and >>, so would be very confusing and error prone.
+ <= and >= associate left-to-right.
+ </li></ul></div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_integer_endian.appendices.acknowledgements"></a><a class="link" href="appendices.html#toward_boost_integer_endian.appendices.acknowledgements" title="Appendix D: Acknowledgements">Appendix
+ D: Acknowledgements</a>
+</h3></div></div></div>
+
+ Original design developed by Darin Adler based on classes developed by Mark
+ Borgerding. Four original class templates combined into a single endian class
+ template by Beman Dawes, who put the library together, provided documentation,
+ and added the typedefs. He also added the unrolled_byte_loops sign partial
+ specialization to correctly extend the sign when cover integer size differs
+ from endian representation size.
+ 
+
+ Comments and suggestions were received from Benaka Moorthi, Christopher Kohlhoff,
+ Cliff Green, Gennaro Proto, Giovanni Piero Deretta, dizzy, Jeff Flinn, John
+ Maddock, Kim Barrett, Marsh Ray, Martin Bonner, Matias Capeletto, Neil Mayhew,
+ Phil Endecott, Rene Rivera, Roland Schwarz, Scott McMurray, Sebastian Redl,
+ Tomas Puverle and Yuval Ronen.
+ 
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_integer_endian.appendices.appendix_e__tests"></a><a class="link" href="appendices.html#toward_boost_integer_endian.appendices.appendix_e__tests" title="Appendix E: Tests">Appendix
+ E: Tests</a>
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt>binary_stream_test</dt>
+<dt>integer_endian_pack_test</dt>
+<dt>integer_endian_test</dt>
+<dt>integer_endian_arithmetic_operation_test</dt>
+<dt>integer_endian_view_test</dt>
+<dt>integer_endian_convert_test</dt>
+</dl></div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_integer_endian.appendices.appendix_e__tests.binary_stream_test"></a><a class="link" href="appendices.html#toward_boost_integer_endian.appendices.appendix_e__tests.binary_stream_test" title="binary_stream_test">binary_stream_test</a>
+</h4></div></div></div>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Name
+ 
+ </th>
+<th>
+ 
+ kind
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+<th>
+ 
+ Result
+ 
+ </th>
+<th>
+ 
+ Ticket
+ 
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ 
+ check_op
+ 
+ </td>
+<td>
+ 
+ run
+ 
+ </td>
+<td>
+ 
+ checl binary streams operations on builtin types
+ 
+ </td>
+<td>
+ 
+ Pass
+ 
+ </td>
+<td>
+ 
+ #
+ 
+ </td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_integer_endian.appendices.appendix_e__tests.integer_endian_pack_test"></a><a class="link" href="appendices.html#toward_boost_integer_endian.appendices.appendix_e__tests.integer_endian_pack_test" title="integer_endian_pack_test">integer_endian_pack_test</a>
+</h4></div></div></div>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Name
+ 
+ </th>
+<th>
+ 
+ kind
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+<th>
+ 
+ Result
+ 
+ </th>
+<th>
+ 
+ Ticket
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ detect_endianness
+ 
+ </td>
+<td>
+ 
+ run
+ 
+ </td>
+<td>
+ 
+ detect endianness
+ 
+ </td>
+<td>
+ 
+ Pass
+ 
+ </td>
+<td>
+ 
+ #
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ check_size
+ 
+ </td>
+<td>
+ 
+ run
+ 
+ </td>
+<td>
+ 
+ check size for different endian types
+ 
+ </td>
+<td>
+ 
+ Pass
+ 
+ </td>
+<td>
+ 
+ #
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ check_alignment
+ 
+ </td>
+<td>
+ 
+ run
+ 
+ </td>
+<td>
+ 
+ check alignement for different endian types
+ 
+ </td>
+<td>
+ 
+ Pass
+ 
+ </td>
+<td>
+ 
+ #
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ check_representation_and_range_and_ops
+ 
+ </td>
+<td>
+ 
+ run
+ 
+ </td>
+<td>
+ 
+ check representation and range and operations
+ 
+ </td>
+<td>
+ 
+ Pass
+ 
+ </td>
+<td>
+ 
+ #
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_integer_endian.appendices.appendix_e__tests.integer_endian_test"></a><a class="link" href="appendices.html#toward_boost_integer_endian.appendices.appendix_e__tests.integer_endian_test" title="integer_endian_test">integer_endian_test</a>
+</h4></div></div></div>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Name
+ 
+ </th>
+<th>
+ 
+ kind
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+<th>
+ 
+ Result
+ 
+ </th>
+<th>
+ 
+ Ticket
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ detect_endianness
+ 
+ </td>
+<td>
+ 
+ run
+ 
+ </td>
+<td>
+ 
+ detect endianness
+ 
+ </td>
+<td>
+ 
+ Pass
+ 
+ </td>
+<td>
+ 
+ #
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ check_size
+ 
+ </td>
+<td>
+ 
+ run
+ 
+ </td>
+<td>
+ 
+ check size for different endian types
+ 
+ </td>
+<td>
+ 
+ Pass
+ 
+ </td>
+<td>
+ 
+ #
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ check_alignment
+ 
+ </td>
+<td>
+ 
+ run
+ 
+ </td>
+<td>
+ 
+ check alignement for different endian types
+ 
+ </td>
+<td>
+ 
+ Pass
+ 
+ </td>
+<td>
+ 
+ #
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ check_representation_and_range_and_ops
+ 
+ </td>
+<td>
+ 
+ run
+ 
+ </td>
+<td>
+ 
+ check representation and range and operations
+ 
+ </td>
+<td>
+ 
+ Pass
+ 
+ </td>
+<td>
+ 
+ #
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ check_data
+ 
+ </td>
+<td>
+ 
+ run
+ 
+ </td>
+<td>
+ 
+ check data starts at the same address
+ 
+ </td>
+<td>
+ 
+ Pass
+ 
+ </td>
+<td>
+ 
+ #
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_integer_endian.appendices.appendix_e__tests.integer_endian_arithmetic_operation_test"></a><a class="link" href="appendices.html#toward_boost_integer_endian.appendices.appendix_e__tests.integer_endian_arithmetic_operation_test" title="integer_endian_arithmetic_operation_test">integer_endian_arithmetic_operation_test</a>
+</h4></div></div></div>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Name
+ 
+ </th>
+<th>
+ 
+ kind
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+<th>
+ 
+ Result
+ 
+ </th>
+<th>
+ 
+ Ticket
+ 
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ 
+ check_op
+ 
+ </td>
+<td>
+ 
+ run
+ 
+ </td>
+<td>
+ 
+ check arithmethic operations on integer endian types
+ 
+ </td>
+<td>
+ 
+ Pass
+ 
+ </td>
+<td>
+ 
+ #
+ 
+ </td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_integer_endian.appendices.appendix_e__tests.integer_endian_view_test"></a><a class="link" href="appendices.html#toward_boost_integer_endian.appendices.appendix_e__tests.integer_endian_view_test" title="integer_endian_view_test">integer_endian_view_test</a>
+</h4></div></div></div>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Name
+ 
+ </th>
+<th>
+ 
+ kind
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+<th>
+ 
+ Result
+ 
+ </th>
+<th>
+ 
+ Ticket
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ check_read
+ 
+ </td>
+<td>
+ 
+ run
+ 
+ </td>
+<td>
+ 
+ check read access
+ 
+ </td>
+<td>
+ 
+ Pass
+ 
+ </td>
+<td>
+ 
+ #
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ check_write
+ 
+ </td>
+<td>
+ 
+ run
+ 
+ </td>
+<td>
+ 
+ check write access
+ 
+ </td>
+<td>
+ 
+ Pass
+ 
+ </td>
+<td>
+ 
+ #
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_integer_endian.appendices.appendix_e__tests.integer_endian_convert_test"></a><a class="link" href="appendices.html#toward_boost_integer_endian.appendices.appendix_e__tests.integer_endian_convert_test" title="integer_endian_convert_test">integer_endian_convert_test</a>
+</h4></div></div></div>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Name
+ 
+ </th>
+<th>
+ 
+ kind
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+<th>
+ 
+ Result
+ 
+ </th>
+<th>
+ 
+ Ticket
+ 
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ 
+ check_in_place_conversion
+ 
+ </td>
+<td>
+ 
+ run
+ 
+ </td>
+<td>
+ 
+ check in place conversion
+ 
+ </td>
+<td>
+ 
+ Pass
+ 
+ </td>
+<td>
+ 
+ #
+ 
+ </td>
+</tr></tbody>
+</table></div>
+</div>
+</div>
+<div class="section"><div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_integer_endian.appendices.appendix_f__tickets"></a><a class="link" href="appendices.html#toward_boost_integer_endian.appendices.appendix_f__tickets" title="Appendix F: Tickets">Appendix
+ F: Tickets</a>
+</h3></div></div></div></div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_integer_endian.appendices.todo"></a><a class="link" href="appendices.html#toward_boost_integer_endian.appendices.todo" title="Appendix G: Future plans">Appendix
+ G: Future plans</a>
+</h3></div></div></div>
+<a name="toward_boost_integer_endian.appendices.todo.tasks_to_do_before_review"></a><h5>
+<a name="id2969241"></a>
+ <a class="link" href="appendices.html#toward_boost_integer_endian.appendices.todo.tasks_to_do_before_review">Tasks
+ to do before review</a>
+ </h5>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ Support for 'pure' endian conversion for endian unaware UDT.
+ </li>
+<li class="listitem">
+ Support for 'in place' endian conversion for ranges of endian unaware
+ types.
+ </li>
+<li class="listitem">
+ endian iterator, which will iterate across a range endian converting
+ values as necessary. It works with any type supporting the convert_to/from
+ functions.
+ </li>
+</ul></div>
+<a name="toward_boost_integer_endian.appendices.todo.for_later_releases"></a><h5>
+<a name="id2969293"></a>
+ <a class="link" href="appendices.html#toward_boost_integer_endian.appendices.todo.for_later_releases">For
+ later releases</a>
+ </h5>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
+ The library doesn't take advantage of special instructions on architectures
+ which natively support endian conversion. This functionality could, however,
+ be part of future releases.
+ </li></ul></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 © 2006 -2009 Beman Dawes Copyright © 2010 Vicente J. Botet Escriba
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="reference.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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>
+</div>
+</body>
+</html>

Added: sandbox/endian_ext/libs/integer/endian/doc/html/toward_boost_integer_endian/overview.html
==============================================================================
--- (empty file)
+++ sandbox/endian_ext/libs/integer/endian/doc/html/toward_boost_integer_endian/overview.html 2011-02-13 14:58:05 EST (Sun, 13 Feb 2011)
@@ -0,0 +1,395 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Overview</title>
+<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../index.html" title="Toward Boost.Integer.Endian 0.2.0">
+<link rel="up" href="../index.html" title="Toward Boost.Integer.Endian 0.2.0">
+<link rel="prev" href="../index.html" title="Toward Boost.Integer.Endian 0.2.0">
+<link rel="next" href="users_guide.html" title="Users'Guide">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../index.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="users_guide.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="toward_boost_integer_endian.overview"></a><a class="link" href="overview.html" title="Overview">Overview</a>
+</h2></div></div></div>
+<div class="toc"><dl>
+<dt>Motivation</dt>
+<dt>Description</dt>
+</dl></div>
+<a name="toward_boost_integer_endian.overview.how_to_use_this_documentation"></a><h4>
+<a name="id2922582"></a>
+ <a class="link" href="overview.html#toward_boost_integer_endian.overview.how_to_use_this_documentation">How
+ to Use This Documentation</a>
+ </h4>
+
+ This documentation makes use of the following naming and formatting conventions.
+ 
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ Code is in <code class="computeroutput">fixed width
+ font</code> and is syntax-highlighted.
+ </li>
+<li class="listitem">
+ Replaceable text that you will need to supply is in <code>italics</code>.
+ </li>
+<li class="listitem">
+ Free functions are rendered in the code font followed by (), as in <code class="computeroutput">free_function()</code>.
+ </li>
+<li class="listitem">
+ If a name refers to a class template, it is specified like this: <code class="computeroutput">class_template<></code>;
+ that is, it is in code font and its name is followed by <code class="computeroutput"><></code>
+ to indicate that it is a class template.
+ </li>
+<li class="listitem">
+ If a name refers to a function-like macro, it is specified like this:
+ <code class="computeroutput">MACRO()</code>;
+ that is, it is uppercase in code font and its name is followed by <code class="computeroutput">()</code> to indicate that it is a function-like
+ macro. Object-like macros appear without the trailing <code class="computeroutput">()</code>.
+ </li>
+<li class="listitem">
+ Names that refer to concepts in the generic programming
+ sense are specified in CamelCase.
+ </li>
+</ul></div>
+<div class="note"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td align="left" valign="top">
+ In addition, notes such as this one specify non-essential information that
+ provides additional background or rationale.
+ </td></tr>
+</table></div>
+<div class="note"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td align="left" valign="top">
+ In addition, notes such as this one specify non-essential information that
+ provides additional background or rationale.
+ </td></tr>
+</table></div>
+
+ Finally, you can mentally add the following to any code fragments in this document:
+ 
+<pre class="programlisting">// Include all of endian files
+#include <boost/integer/endian.hpp>
+using namespace boost::integer;
+</pre>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_integer_endian.overview.motivation"></a><a class="link" href="overview.html#toward_boost_integer_endian.overview.motivation" title="Motivation">Motivation</a>
+</h3></div></div></div>
+
+ The original Beman's version provided through the boost::integer::endian<>
+ class an integer-like class that providing arithmetics operations on
+ 
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ Big endian | little endian | native endian byte ordering.
+ </li>
+<li class="listitem">
+ Signed | unsigned
+ </li>
+<li class="listitem">
+ Unaligned | aligned
+ </li>
+<li class="listitem">
+ 1-8 byte (unaligned) | 2, 4, 8 byte (aligned)
+ </li>
+<li class="listitem">
+ Choice of integer value type
+ </li>
+</ul></div>
+
+ This endian aware design seems to be unappropiated to work with endian unaware
+ types, but as we will see this is not completly true, as we can construct
+ on top of the Beman's design endian unaware operation. Next follows some
+ of the main critics that have been done recently.
+ 
+<a name="toward_boost_integer_endian.overview.motivation.intrusive_verus_non_intrusive"></a><h5>
+<a name="id2881294"></a>
+ <a class="link" href="overview.html#toward_boost_integer_endian.overview.motivation.intrusive_verus_non_intrusive">Intrusive
+ verus non-intrusive</a>
+ </h5>
+
+ Endian conversion must be possible to any type even if you can't modify the
+ original source code. Many people think that originel Beman's library requires
+ the data types which need to be converted to be coded using his endian types
+ as members.
+ 
+
+ We will see that this is not true, as the user can always use casting to
+ reinterpret a given structure on another one, as the proposed extension does
+ with the endian_views.
+ 
+<pre class="programlisting">struct endian_unaware_structure {
+ int32_t a;
+ int16_t b;
+};
+endian_unaware_structure st_a;
+
+endian_unaware_structure st_b;
+as_endian<native>(st_b) = as_endian<big>(st_a);
+</pre>
+<a name="toward_boost_integer_endian.overview.motivation.physical_versus_logical_data"></a><h5>
+<a name="id2881488"></a>
+ <a class="link" href="overview.html#toward_boost_integer_endian.overview.motivation.physical_versus_logical_data">Physical
+ versus Logical data</a>
+ </h5>
+
+ The typical use case is to use native endianness until ready to read/write
+ using wire format. It is only when ready to do I/O that there is a need to
+ account for endianness.
+ 
+
+ Beman's original library requires two types one to specify the physical data
+ and the other representing the logical data. Many people think that this
+ means that the user has to maintain two separate structs/classes when only
+ one is needed. This could be sometimes the case, but in other cases, the
+ user will store the information elements include in the message on local
+ variables and specific contexts that don't follow the external format.
+ 
+
+ Applications that don't separate the physical and the logical data structures
+ don't scale well as any change on the external format will mean a refactoring
+ of the whole application. Also, the wire structures cannot maintain invariants,
+ so having a separate class is often useful even if its contents are essentially
+ identical to the wire version.
+ 
+
+ In addition a single and efficient view is only possible when the pysical
+ view can be represented by native aligned integers. But when the physical
+ view contains unaliged integers with sizes not supported by the platform,
+ the need to separate both view becomes anavoidable. Here the Beman's design
+ is the best adapted.
+ 
+<a name="toward_boost_integer_endian.overview.motivation.inherent_inefficient_arithmetic_operations"></a><h5>
+<a name="id2881548"></a>
+ <a class="link" href="overview.html#toward_boost_integer_endian.overview.motivation.inherent_inefficient_arithmetic_operations">Inherent
+ inefficient arithmetic operations</a>
+ </h5>
+
+ The fact that the endian types provide operators gives the impression that
+ it's ok to operate on them, as these operations can potentially require two
+ endian conversions when the endianness is different.
+ 
+
+ Some people don't agree with that design choice, as they think the operation
+ of endian conversion and operating on the data should be divorced from each
+ other. A less experienced user that you may end up not realizing what the
+ hidden costs are and use the endian aware integer-like types throughout the
+ application, paying unnecessary overheads. They prefer a library that makes
+ hard to misuse in that way; borrowing a phrase from python, "explicit
+ is better than implicit". They believe that forcing the user to do the
+ explicit endian conversion leads to better separation of concerns for the
+ application, but they don't propose any mean to force this conversion.
+ 
+
+ The extension proposal separates the endian aware byte-holder type from the
+ one able to make arithmetic operations so the user will be forced to convert
+ for one to/from the native type, and avoid unfortunate costly atithmetic
+ operations.
+ 
+<pre class="programlisting">struct endian_aware_structure {
+ endian_pack<big,int32_t> a;
+ endian_pack<big,int16_t> b;
+};
+</pre>
+
+ Structure endian_aware_structure can not be used without converting to native
+ types, as endian_pack don't provide other operations than conversion.
+ 
+<pre class="programlisting">endian_aware_structure st;
+// ...
+st.a=i;
+st.b=j;
+</pre>
+
+ But don't removes the inefficient and endian safe class, as less demanding
+ applications would benefit from the safe and transparent approach.
+ 
+<a name="toward_boost_integer_endian.overview.motivation.in_place_conversion"></a><h5>
+<a name="id2932442"></a>
+ <a class="link" href="overview.html#toward_boost_integer_endian.overview.motivation.in_place_conversion">In-place
+ conversion</a>
+ </h5>
+
+ Other contexts force the user to make in place conversions. While this could
+ be dangerous, there are context on which a funtional conversion is not possible,
+ mainly because the duplicated space could not be an option. These in-place
+ conversions are only possible for aligned endian unaware types.
+ 
+<pre class="programlisting">struct endian_unaware_structure {
+ int32_t a;
+ int16_t b;
+};
+endian_unaware_structure st;
+
+as_endian<native>(st) = as_endian<big>(st);
+</pre>
+
+ The fact that some context need this in-place conversion doesn't mean that
+ every application should use this approach.
+ 
+<a name="toward_boost_integer_endian.overview.motivation.udt_endianness"></a><h5>
+<a name="id2932602"></a>
+ <a class="link" href="overview.html#toward_boost_integer_endian.overview.motivation.udt_endianness">UDT
+ endianness</a>
+ </h5>
+
+ boost::integer::endian class didn't accept a UDT. We have updated the library
+ so now UDT can be used for endian aligned types.
+ 
+<pre class="programlisting">struct UserMessage {
+ endian_pack<little, system_clock::time_point > timestamp;
+ ulittle32_pt aircraft_id;
+ struct Position {
+ endian_pack<little, quantity<si::length, boost::int_least32_t> > x;
+ endian_pack<little, quantity<si::length, boost::int_least32_t> > y;
+ endian_pack<little, quantity<si::length, boost::int_least32_t> > z;
+ } position;
+ struct Attitude {
+ endian_pack<little, quantity<si::plane_angle, boost::int_least8_t> > heading;
+ endian_pack<little, quantity<si::plane_angle, boost::int_least8_t> > pitch;
+ endian_pack<little, quantity<si::plane_angle, boost::int_least8_t> > roll;
+ } attitude;
+}; // UserMessage
+</pre>
+<a name="toward_boost_integer_endian.overview.motivation.mixed_endianness"></a><h5>
+<a name="id2933232"></a>
+ <a class="link" href="overview.html#toward_boost_integer_endian.overview.motivation.mixed_endianness">Mixed
+ endianness</a>
+ </h5>
+
+ Sometimes we need to deal with messages with mixed endianness. A functional
+ approach means the programmer has to "know" which endianess the
+ data he wants to convert has.
+ 
+<pre class="programlisting">struct UdpHeader {
+ ubig16_pt source_port;
+ ubig16_pt destination_port;
+ ubig16_pt length;
+ ubig16_pt checksum;
+}; // UdpHeader
+
+struct Packet {
+ internet::UdpHeader udpHeader;
+ UserMessage userMessage;
+}; // Packet
+</pre>
+<a name="toward_boost_integer_endian.overview.motivation.floating_point"></a><h5>
+<a name="id2933409"></a>
+ <a class="link" href="overview.html#toward_boost_integer_endian.overview.motivation.floating_point">Floating
+ point</a>
+ </h5>
+
+ From my understanding floating point types are not only concerned by endianness,
+ but also by a multitude of standard on not standard formats.
+ 
+<a name="toward_boost_integer_endian.overview.motivation.conclusion"></a><h5>
+<a name="id2933434"></a>
+ <a class="link" href="overview.html#toward_boost_integer_endian.overview.motivation.conclusion">Conclusion</a>
+ </h5>
+
+ The library must support applications needing to work safely with endian
+ aware types and efficiently with in place endian conversions.
+ 
+
+ Conversions between native and big/little endian formats must be simple.
+ 
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_integer_endian.overview.description"></a><a class="link" href="overview.html#toward_boost_integer_endian.overview.description" title="Description">Description</a>
+</h3></div></div></div>
+
+ This is an extension of the Beman's Boost.Integer.Endian, which was able
+ to work with endian aware types, used to convert between types with different
+ endian or even to carry on with arithmetic operations, by spliting the endian
+ part from integer part and by adding support for aligned endian unaware types.
+ 
+
+ Boost.Integer.Endian.Ext provides:
+ 
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+
+ Endian packs
+ 
+<div class="itemizedlist"><ul class="itemizedlist" type="circle">
+<li class="listitem">
+ Big endian | little endian | native endian byte ordering.
+ </li>
+<li class="listitem">
+ Signed | unsigned
+ </li>
+<li class="listitem">
+ Unaligned | aligned
+ </li>
+<li class="listitem">
+ 1-8 byte (unaligned) | 2, 4, 8 byte (aligned)
+ </li>
+<li class="listitem">
+ Choice of integer value type
+ </li>
+</ul></div>
+</li>
+<li class="listitem">
+ Endian integers with the whole set of arithmetics operators.
+ </li>
+<li class="listitem">
+ Operators <= and => for unformatted binary (as opposed to formatted
+ character) stream insertion and extraction of built-in, std::string types
+ and of endian types.
+ </li>
+<li class="listitem">
+ Views of aligned endian unaware integer types as endian packs or endian
+ integers so we can make endian conversion.
+ </li>
+<li class="listitem">
+
+ Generic in place conversion between different endian formats.
+ 
+<div class="itemizedlist"><ul class="itemizedlist" type="circle">
+<li class="listitem">
+ Very simple interface: convert_to/from<endiannes domain>(),
+ </li>
+<li class="listitem">
+ Support for built-in and user-defined data types view as fusion sequences.
+ </li>
+</ul></div>
+</li>
+</ul></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 © 2006 -2009 Beman Dawes Copyright © 2010 Vicente J. Botet Escriba
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../index.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="users_guide.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/endian_ext/libs/integer/endian/doc/html/toward_boost_integer_endian/reference.html
==============================================================================
--- (empty file)
+++ sandbox/endian_ext/libs/integer/endian/doc/html/toward_boost_integer_endian/reference.html 2011-02-13 14:58:05 EST (Sun, 13 Feb 2011)
@@ -0,0 +1,1403 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Reference</title>
+<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../index.html" title="Toward Boost.Integer.Endian 0.2.0">
+<link rel="up" href="../index.html" title="Toward Boost.Integer.Endian 0.2.0">
+<link rel="prev" href="users_guide.html" title="Users'Guide">
+<link rel="next" href="appendices.html" title="Appendices">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="users_guide.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="appendices.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="toward_boost_integer_endian.reference"></a><a class="link" href="reference.html" title="Reference">Reference</a>
+</h2></div></div></div>
+<div class="toc"><dl>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.binary_stream_hpp">Header
+ <code class="computeroutput"><boost/binary_stream.hpp></code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endianness_hpp">Header
+ <code class="computeroutput"><boost/integer/endian/endiannes.hpp></code></a></dt>
+<dd><dl>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endianness_hpp.endian_big">Class
+ <code class="computeroutput">big</code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endianness_hpp.endian_little">Class
+ <code class="computeroutput">little</code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endianness_hpp.endian_middle">Class
+ <code class="computeroutput">middle</code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endianness_hpp.endian_mixed">Class
+ <code class="computeroutput">mixed</code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endianness_hpp.endian_native">Class
+ <code class="computeroutput">native</code></a></dt>
+</dl></dd>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.endian_domain_map_hpp">Header
+ <code class="computeroutput"><boost/integer/endian/domain_map.hpp></code></a></dt>
+<dd><dl><dt><a href="reference.html#toward_boost_integer_endian.reference.endian_domain_map_hpp.domain_map">Meta
+ Function <code class="computeroutput">domain_map<></code></a></dt></dl></dd>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_pack_hpp">Header
+ <code class="computeroutput"><boost/integer/endian/endian_pack.hpp></code></a></dt>
+<dd><dl>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_pack_hpp.endian_pack">Template
+ class <code class="computeroutput">endian_pack<></code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_pack_hpp.typedefs">Common
+ typedefs</a></dt>
+</dl></dd>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_hpp">Header
+ <code class="computeroutput"><boost/integer/endian/endian.hpp></code></a></dt>
+<dd><dl>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_hpp.endian">Template
+ class <code class="computeroutput">endian<></code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_hpp.typedefs">Common
+ typedefs</a></dt>
+</dl></dd>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_binary_stream_hpp">Header
+ <code class="computeroutput"><boost/integer/endian/endian_binary_stream.hpp></code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_type_hpp">Header
+ <code class="computeroutput"><boost/integer/endian/endian_type.hpp></code></a></dt>
+<dd><dl><dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_type_hpp.integer_endian_type">Meta
+ Function <code class="computeroutput">endian_type<></code></a></dt></dl></dd>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_view_hpp">Header
+ <code class="computeroutput"><boost/integer/endian/endian_view.hpp></code></a></dt>
+<dd><dl>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_view_hpp.endian_view">Template
+ class <code class="computeroutput">endian_view<></code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_view_hpp.as_endian">Non-Member
+ Function Template <code class="computeroutput">as_endian<></code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_view_hpp.as">Non-Member
+ Function Template <code class="computeroutput">as<></code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_view_hpp.as_little">Non-Member
+ Function Template <code class="computeroutput">as_little<></code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_view_hpp.as_big">Non-Member
+ Function Template <code class="computeroutput">as_big<></code></a></dt>
+</dl></dd>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_conversion_hpp">Header
+ <code class="computeroutput"><boost/integer/endian/endian_conversion.hpp></code></a></dt>
+<dd><dl>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_conversion_hpp.convert_to_from">Non-Member
+ Function Template <code class="computeroutput">convert_to_from<></code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_conversion_hpp.convert_from">Non-Member
+ Function Template <code class="computeroutput">convert_from<></code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_conversion_hpp.convert_to">Non-Member
+ Function Template <code class="computeroutput">convert_to<></code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_conversion_hpp.to">Class
+ Template <code class="computeroutput">to<></code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_conversion_hpp.from">Class
+ Template <code class="computeroutput">from<></code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_conversion_hpp.is_to">Class
+ Template <code class="computeroutput">is_to<></code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_conversion_hpp.is_from">Class
+ Template <code class="computeroutput">is_from<></code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_conversion_hpp.convert">Non-Member
+ Function Template <code class="computeroutput">convert<></code></a></dt>
+</dl></dd>
+</dl></div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_integer_endian.reference.binary_stream_hpp"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.binary_stream_hpp" title="Header <boost/binary_stream.hpp>">Header
+ <code class="computeroutput"><boost/binary_stream.hpp></code></a>
+</h3></div></div></div>
+
+ Header <boost/binary_stream.hpp> provides operators <code class="computeroutput"><=</code>
+ and <code class="computeroutput">=></code> for unformatted binary
+ (as opposed to formatted character) stream insertion and extraction of built-in
+ and std::string types.
+ 
+<a name="toward_boost_integer_endian.reference.binary_stream_hpp.synopsis"></a><h5>
+<a name="id2942695"></a>
+ <a class="link" href="reference.html#toward_boost_integer_endian.reference.binary_stream_hpp.synopsis">Synopsis</a>
+ </h5>
+<pre class="programlisting">namespace boost
+{
+
+ // built-in types ------------------------------------------------------------------//
+
+ std::ostream& operator<=(std::ostream& os, short v);
+ std::istream& operator>=(std::istream& is, short& v);
+
+ std::ostream& operator<=(std::ostream& os, unsigned short v);
+ std::istream& operator>=(std::istream& is, unsigned short& v);
+
+ std::ostream& operator<=(std::ostream& os, int v);
+ std::istream& operator>=(std::istream& is, int& v);
+
+ std::ostream& operator<=(std::ostream& os, unsigned int v);
+ std::istream& operator>=(std::istream& is, unsigned int& v);
+
+ std::ostream& operator<=(std::ostream& os, long v);
+ std::istream& operator>=(std::istream& is, long& v);
+
+ std::ostream& operator<=(std::ostream& os, unsigned long v);
+ std::istream& operator>=(std::istream& is, unsigned long& v);
+
+ std::ostream& operator<=(std::ostream& os, long long v);
+ std::istream& operator>=(std::istream& is, long long& v);
+
+ std::ostream& operator<=(std::ostream& os, unsigned long long v);
+ std::istream& operator>=(std::istream& is, unsigned long long& v);
+
+ std::ostream& operator<=(std::ostream& os, float v);
+ std::istream& operator>=(std::istream& is, float& v);
+
+ std::ostream& operator<=(std::ostream& os, double v);
+ std::istream& operator>=(std::istream& is, double& v);
+
+ std::ostream& operator<=(std::ostream& os, long double v);
+ std::istream& operator>=(std::istream& is, long double& v);
+
+ std::ostream& operator<=(std::ostream& os, char c);
+ std::istream& operator>=(std::istream& is, char& c);
+
+ std::ostream& operator<=(std::ostream& os, signed char c);
+ std::istream& operator>=(std::istream& is, signed char& c);
+
+ std::ostream& operator<=(std::ostream& os, unsigned char c);
+ std::istream& operator>=(std::istream& is, unsigned char& c);
+
+ std::ostream& operator<=(std::ostream& os, wchar_t v);
+ std::istream& operator>=(std::istream& is, wchar_t& v);
+
+ // strings -------------------------------------------------------------------------//
+
+ std::ostream& operator<=(std::ostream& os, const char* p);
+
+ std::ostream& operator<=(std::ostream& os, const signed char* p);
+
+ std::ostream& operator<=(std::ostream& os, const unsigned char* p);
+
+#ifndef BOOST_NO_CWCHAR
+ std::ostream& operator<=(std::ostream& os, const wchar_t* p);
+#endif
+
+ std::ostream& operator<=(std::ostream& os, const std::string& s);
+ std::istream& operator>=(std::istream& is, std::string& s);
+
+#ifndef BOOST_NO_STD_WSTRING
+ std::ostream& operator<=(std::ostream& os, const std::wstring& s);
+ std::istream& operator>=(std::istream& is, std::wstring& s);
+#endif
+
+} // namespace boost
+</pre>
+<div class="note"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td align="left" valign="top">
+ Omission of bool and void* is deliberate; any semantics would be questionable
+ </td></tr>
+</table></div>
+<div class="warning"><table border="0" summary="Warning">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="../../../../../doc/src/images/warning.png"></td>
+<th align="left">Warning</th>
+</tr>
+<tr><td align="left" valign="top">
+ Note the asymmetry between output and input; a string with embedded nulls
+ will be output with the embedded nulls, but input will stop at the first
+ null. So it probably isn't a good idea to use these functions for strings
+ with nulls.
+ </td></tr>
+</table></div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_integer_endian.reference.integer_endianness_hpp"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endianness_hpp" title="Header <boost/integer/endian/endiannes.hpp>">Header
+ <code class="computeroutput"><boost/integer/endian/endiannes.hpp></code></a>
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endianness_hpp.endian_big">Class
+ <code class="computeroutput">big</code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endianness_hpp.endian_little">Class
+ <code class="computeroutput">little</code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endianness_hpp.endian_middle">Class
+ <code class="computeroutput">middle</code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endianness_hpp.endian_mixed">Class
+ <code class="computeroutput">mixed</code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endianness_hpp.endian_native">Class
+ <code class="computeroutput">native</code></a></dt>
+</dl></div>
+
+ Header <boost/endian/endian/endianness.hpp> provides the endianness
+ tags.
+ 
+<a name="toward_boost_integer_endian.reference.integer_endianness_hpp.synopsis"></a><h5>
+<a name="id2945850"></a>
+ <a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endianness_hpp.synopsis">Synopsis</a>
+ </h5>
+<pre class="programlisting">namespace boost {
+ namespace endianness {
+ struct big;
+ struct little;
+ struct middle;
+ struct mixed;
+ typedef <platform dependent> native ;
+ }
+}
+</pre>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_integer_endian.reference.integer_endianness_hpp.endian_big"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endianness_hpp.endian_big" title="Class big">Class
+ <code class="computeroutput">big</code></a>
+</h4></div></div></div>
+
+ Big endian tag.
+ 
+<pre class="programlisting">struct big {};
+</pre>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_integer_endian.reference.integer_endianness_hpp.endian_little"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endianness_hpp.endian_little" title="Class little">Class
+ <code class="computeroutput">little</code></a>
+</h4></div></div></div>
+
+ Little endian tag.
+ 
+<pre class="programlisting">struct little {};
+</pre>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_integer_endian.reference.integer_endianness_hpp.endian_middle"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endianness_hpp.endian_middle" title="Class middle">Class
+ <code class="computeroutput">middle</code></a>
+</h4></div></div></div>
+
+ Middle endian tag.
+ 
+<pre class="programlisting">struct middle {};
+</pre>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_integer_endian.reference.integer_endianness_hpp.endian_mixed"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endianness_hpp.endian_mixed" title="Class mixed">Class
+ <code class="computeroutput">mixed</code></a>
+</h4></div></div></div>
+
+ Mixed endian tag.
+ 
+<pre class="programlisting">struct mixed {};
+</pre>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_integer_endian.reference.integer_endianness_hpp.endian_native"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endianness_hpp.endian_native" title="Class native">Class
+ <code class="computeroutput">native</code></a>
+</h4></div></div></div>
+
+ Native endian tag.
+ 
+<pre class="programlisting">typedef <platform dependent> native ;
+</pre>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_integer_endian.reference.endian_domain_map_hpp"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.endian_domain_map_hpp" title="Header <boost/integer/endian/domain_map.hpp>">Header
+ <code class="computeroutput"><boost/integer/endian/domain_map.hpp></code></a>
+</h3></div></div></div>
+<div class="toc"><dl><dt><a href="reference.html#toward_boost_integer_endian.reference.endian_domain_map_hpp.domain_map">Meta
+ Function <code class="computeroutput">domain_map<></code></a></dt></dl></div>
+
+ This file contains the default implementation ofr the <code class="computeroutput">domain_map</code>
+ metafunction.
+ 
+<a name="toward_boost_integer_endian.reference.endian_domain_map_hpp.synopsis"></a><h5>
+<a name="id2946414"></a>
+ <a class="link" href="reference.html#toward_boost_integer_endian.reference.endian_domain_map_hpp.synopsis">Synopsis</a>
+ </h5>
+<pre class="programlisting">namespace boost {
+namespace endian {
+ template <typename Domain, typename T>
+ struct domain_map;
+}}
+</pre>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_integer_endian.reference.endian_domain_map_hpp.domain_map"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.endian_domain_map_hpp.domain_map" title="Meta Function domain_map<>">Meta
+ Function <code class="computeroutput">domain_map<></code></a>
+</h4></div></div></div>
+<pre class="programlisting">template <typename Domain, typename T>
+struct domain_map {
+ typedef <see below> type;
+};
+</pre>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+
+ Requires:
+ 
+<div class="itemizedlist"><ul class="itemizedlist" type="circle"><li class="listitem">
+ <code class="computeroutput">Domain</code> any class.
+ Can be also <code class="computeroutput">endianness::big</code>
+ or <code class="computeroutput">endianness::little</code>.
+ </li></ul></div>
+</li>
+<li class="listitem">
+ Result: The member typedef <code class="computeroutput">type</code> names a mpl tree of sequence
+ of <code class="computeroutput">endianness</code> types
+ as view from the point of view of the <code class="computeroutput">Domain</code>.
+ The default definition is a mpl tree having as leaves the <code class="computeroutput">Domain</code> class for <code class="computeroutput">T</code>
+ fundamental types, and fusion sequences.
+ </li>
+<li class="listitem">
+ Example:
+ </li>
+</ul></div>
+<pre class="programlisting">is_same<domain_map<endianness::big, int>::type, endianness::big>::value == true
+
+struct ifA {};
+</pre>
+
+ The user needs to specialize this metafunction for specific domains.
+ 
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_integer_endian.reference.integer_endian_pack_hpp"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_pack_hpp" title="Header <boost/integer/endian/endian_pack.hpp>">Header
+ <code class="computeroutput"><boost/integer/endian/endian_pack.hpp></code></a>
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_pack_hpp.endian_pack">Template
+ class <code class="computeroutput">endian_pack<></code></a></dt>
+<dd><dl>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_pack_hpp.endian_pack.endian">Default
+ Contructor <code class="computeroutput">endian_pack()</code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_pack_hpp.endian_pack.endianT">Contructor
+ from value_type <code class="computeroutput">endian_pack(T)</code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_pack_hpp.endian_pack.assignment">Assignment
+ Operator from value_type <code class="computeroutput">operator=(T)</code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_pack_hpp.endian_pack.conversion">Conversion
+ Operator <code class="computeroutput">operator T()</code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_pack_hpp.endian_pack.data">Member
+ Function <code class="computeroutput">data()</code></a></dt>
+</dl></dd>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_pack_hpp.typedefs">Common
+ typedefs</a></dt>
+</dl></div>
+
+ This file contains the core class template of Boost.Integer.Endian.Ext.
+ Provides byte-holder binary types with explicit control over byte order,
+ value type, size, and alignment. Typedefs provide easy-to-use names for common
+ configurations.
+ 
+<a name="toward_boost_integer_endian.reference.integer_endian_pack_hpp.synopsis"></a><h5>
+<a name="id2947047"></a>
+ <a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_pack_hpp.synopsis">Synopsis</a>
+ </h5>
+<pre class="programlisting">namespace boost {
+namespace integer {
+ BOOST_SCOPED_ENUM_START(alignment) { unaligned, aligned }; BOOST_SCOPED_ENUM_END
+
+ template <typename E,
+ typename T,
+ std::size_t n_bits=sizeof(T)*8,
+ BOOST_SCOPED_ENUM(alignment) A = alignment::aligned
+ > class endian_pack;
+
+ // unaligned big endian_pack signed integer types
+ typedef endian_pack< endianness::big, int_least8_t, 8, alignment::unaligned > big8_pt;
+ typedef endian_pack< endianness::big, int_least16_t, 16, alignment::unaligned > big16_pt;
+ typedef endian_pack< endianness::big, int_least32_t, 24, alignment::unaligned > big24_pt;
+ typedef endian_pack< endianness::big, int_least32_t, 32, alignment::unaligned > big32_pt;
+ typedef endian_pack< endianness::big, int_least64_t, 40, alignment::unaligned > big40_pt;
+ typedef endian_pack< endianness::big, int_least64_t, 48, alignment::unaligned > big48_pt;
+ typedef endian_pack< endianness::big, int_least64_t, 56, alignment::unaligned > big56_pt;
+ typedef endian_pack< endianness::big, int_least64_t, 64, alignment::unaligned > big64_pt;
+
+ // unaligned big endian_pack unsigned integer types
+ typedef endian_pack< endianness::big, uint_least8_t, 8, alignment::unaligned > ubig8_pt;
+ typedef endian_pack< endianness::big, uint_least16_t, 16, alignment::unaligned > ubig16_pt;
+ typedef endian_pack< endianness::big, uint_least32_t, 24, alignment::unaligned > ubig24_pt;
+ typedef endian_pack< endianness::big, uint_least32_t, 32, alignment::unaligned > ubig32_pt;
+ typedef endian_pack< endianness::big, uint_least64_t, 40, alignment::unaligned > ubig40_pt;
+ typedef endian_pack< endianness::big, uint_least64_t, 48, alignment::unaligned > ubig48_pt;
+ typedef endian_pack< endianness::big, uint_least64_t, 56, alignment::unaligned > ubig56_pt;
+ typedef endian_pack< endianness::big, uint_least64_t, 64, alignment::unaligned > ubig64_pt;
+
+ // unaligned little endian_pack signed integer types
+ typedef endian_pack< endianness::little, int_least8_t, 8, alignment::unaligned > little8_pt;
+ typedef endian_pack< endianness::little, int_least16_t, 16, alignment::unaligned > little16_pt;
+ typedef endian_pack< endianness::little, int_least32_t, 24, alignment::unaligned > little24_pt;
+ typedef endian_pack< endianness::little, int_least32_t, 32, alignment::unaligned > little32_pt;
+ typedef endian_pack< endianness::little, int_least64_t, 40, alignment::unaligned > little40_pt;
+ typedef endian_pack< endianness::little, int_least64_t, 48, alignment::unaligned > little48_pt;
+ typedef endian_pack< endianness::little, int_least64_t, 56, alignment::unaligned > little56_pt;
+ typedef endian_pack< endianness::little, int_least64_t, 64, alignment::unaligned > little64_pt;
+
+ // unaligned little endian_pack unsigned integer types
+ typedef endian_pack< endianness::little, uint_least8_t, 8, alignment::unaligned > ulittle8_pt;
+ typedef endian_pack< endianness::little, uint_least16_t, 16, alignment::unaligned > ulittle16_pt;
+ typedef endian_pack< endianness::little, uint_least32_t, 24, alignment::unaligned > ulittle24_pt;
+ typedef endian_pack< endianness::little, uint_least32_t, 32, alignment::unaligned > ulittle32_pt;
+ typedef endian_pack< endianness::little, uint_least64_t, 40, alignment::unaligned > ulittle40_pt;
+ typedef endian_pack< endianness::little, uint_least64_t, 48, alignment::unaligned > ulittle48_pt;
+ typedef endian_pack< endianness::little, uint_least64_t, 56, alignment::unaligned > ulittle56_pt;
+ typedef endian_pack< endianness::little, uint_least64_t, 64, alignment::unaligned > ulittle64_pt;
+
+ // unaligned native endian_pack signed integer types
+ typedef endian_pack< endianness::native, int_least8_t, 8, alignment::unaligned > native8_pt;
+ typedef endian_pack< endianness::native, int_least16_t, 16, alignment::unaligned > native16_pt;
+ typedef endian_pack< endianness::native, int_least32_t, 24, alignment::unaligned > native24_pt;
+ typedef endian_pack< endianness::native, int_least32_t, 32, alignment::unaligned > native32_pt;
+ typedef endian_pack< endianness::native, int_least64_t, 40, alignment::unaligned > native40_pt;
+ typedef endian_pack< endianness::native, int_least64_t, 48, alignment::unaligned > native48_pt;
+ typedef endian_pack< endianness::native, int_least64_t, 56, alignment::unaligned > native56_pt;
+ typedef endian_pack< endianness::native, int_least64_t, 64, alignment::unaligned > native64_pt;
+
+ // unaligned native endian_pack unsigned integer types
+ typedef endian_pack< endianness::native, uint_least8_t, 8, alignment::unaligned > unative8_pt;
+ typedef endian_pack< endianness::native, uint_least16_t, 16, alignment::unaligned > unative16_pt;
+ typedef endian_pack< endianness::native, uint_least32_t, 24, alignment::unaligned > unative24_pt;
+ typedef endian_pack< endianness::native, uint_least32_t, 32, alignment::unaligned > unative32_pt;
+ typedef endian_pack< endianness::native, uint_least64_t, 40, alignment::unaligned > unative40_pt;
+ typedef endian_pack< endianness::native, uint_least64_t, 48, alignment::unaligned > unative48_pt;
+ typedef endian_pack< endianness::native, uint_least64_t, 56, alignment::unaligned > unative56_pt;
+ typedef endian_pack< endianness::native, uint_least64_t, 64, alignment::unaligned > unative64_pt;
+
+#define BOOST_HAS_INT16_T
+#define BOOST_HAS_INT32_T
+#define BOOST_HAS_INT64_T
+
+ // These types only present if platform has exact size integers:
+ // aligned big endian_pack signed integer types
+ // aligned big endian_pack unsigned integer types
+ // aligned little endian_pack signed integer types
+ // aligned little endian_pack unsigned integer types
+
+ // aligned native endian_pack typedefs are not provided because
+ // <cstdint> types are superior for this use case
+
+# if defined(BOOST_HAS_INT16_T)
+ typedef endian_pack< endianness::big, int16_t, 16, alignment::aligned > aligned_big16_pt;
+ typedef endian_pack< endianness::big, uint16_t, 16, alignment::aligned > aligned_ubig16_pt;
+ typedef endian_pack< endianness::little, int16_t, 16, alignment::aligned > aligned_little16_pt;
+ typedef endian_pack< endianness::little, uint16_t, 16, alignment::aligned > aligned_ulittle16_pt;
+# endif
+
+# if defined(BOOST_HAS_INT32_T)
+ typedef endian_pack< endianness::big, int32_t, 32, alignment::aligned > aligned_big32_pt;
+ typedef endian_pack< endianness::big, uint32_t, 32, alignment::aligned > aligned_ubig32_pt;
+ typedef endian_pack< endianness::little, int32_t, 32, alignment::aligned > aligned_little32_pt;
+ typedef endian_pack< endianness::little, uint32_t, 32, alignment::aligned > aligned_ulittle32_pt;
+# endif
+
+# if defined(BOOST_HAS_INT64_T)
+ typedef endian_pack< endianness::big, int64_t, 64, alignment::aligned > aligned_big64_pt;
+ typedef endian_pack< endianness::big, uint64_t, 64, alignment::aligned > aligned_ubig64_pt;
+ typedef endian_pack< endianness::little, int64_t, 64, alignment::aligned > aligned_little64_pt;
+ typedef endian_pack< endianness::little, uint64_t, 64, alignment::aligned > aligned_ulittle64_pt;
+# endif
+
+}
+}
+</pre>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_integer_endian.reference.integer_endian_pack_hpp.endian_pack"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_pack_hpp.endian_pack" title="Template class endian_pack<>">Template
+ class <code class="computeroutput">endian_pack<></code></a>
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_pack_hpp.endian_pack.endian">Default
+ Contructor <code class="computeroutput">endian_pack()</code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_pack_hpp.endian_pack.endianT">Contructor
+ from value_type <code class="computeroutput">endian_pack(T)</code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_pack_hpp.endian_pack.assignment">Assignment
+ Operator from value_type <code class="computeroutput">operator=(T)</code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_pack_hpp.endian_pack.conversion">Conversion
+ Operator <code class="computeroutput">operator T()</code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_pack_hpp.endian_pack.data">Member
+ Function <code class="computeroutput">data()</code></a></dt>
+</dl></div>
+
+ An <code class="computeroutput">endian_pack</code> is a byte-holder
+ with user-specified endianness, value type, size, and alignment.
+ 
+<pre class="programlisting">template <
+ typename E,
+ typename T,
+ std::size_t n_bits=8*sizeof(T),
+ alignment A = alignment::aligned>
+class endian_pack {
+public:
+ typedef E endian_type;
+ typedef T value_type;
+ static const std::size_t width = n_bits;
+ static const alignment alignment_value = A;
+
+ endian_pack() = default; // = default replaced by {} on C++03
+ explicit endian_pack(T v);
+ endian_pack & operator=(T v);
+ operator T() const;
+ const char* data() const;
+};
+</pre>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
+
+ Requires:
+ 
+<div class="itemizedlist"><ul class="itemizedlist" type="circle">
+<li class="listitem">
+ <code class="computeroutput">E</code> is one of <code class="computeroutput">endianness::big</code> or <code class="computeroutput">endianness::little</code>.
+ </li>
+<li class="listitem">
+ <code class="computeroutput">T</code> must be a POD
+ with value semantics.
+ </li>
+<li class="listitem">
+ <code class="computeroutput">nbits</code> is a multiple
+ of <code class="computeroutput">8</code>
+ </li>
+<li class="listitem">
+ If <code class="computeroutput">A</code> is <code class="computeroutput">alignment::aligned</code> then <code class="computeroutput">nbits</code>
+ must be equal to <code class="computeroutput">8*sizeof(T)</code>
+ </li>
+</ul></div>
+</li></ul></div>
+<div class="note"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td align="left" valign="top">
+ if BOOST_ENDIAN_FORCE_PODNESS is defined && C++0x POD's are not
+ available then these two constructors will not be present
+ </td></tr>
+</table></div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_integer_endian.reference.integer_endian_pack_hpp.endian_pack.endian"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_pack_hpp.endian_pack.endian" title="Default Contructor endian_pack()">Default
+ Contructor <code class="computeroutput">endian_pack()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">endian_pack() = default; // C++03: endian(){}
+</pre>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
+ Effects: Constructs an object of
+ type <code class="computeroutput">endian<E, T, n_bits,
+ A></code>.
+ </li></ul></div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_integer_endian.reference.integer_endian_pack_hpp.endian_pack.endianT"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_pack_hpp.endian_pack.endianT" title="Contructor from value_type endian_pack(T)">Contructor
+ from value_type <code class="computeroutput">endian_pack(T)</code></a>
+</h5></div></div></div>
+<pre class="programlisting">explicit endian_pack(T v);
+</pre>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ Effects: Constructs an object of
+ type <code class="computeroutput">endian_pack<E, T, n_bits, A></code>.
+ </li>
+<li class="listitem">
+ Postcondition: <code class="computeroutput">x
+ == v</code>,
+ where <code class="computeroutput">x</code> is the constructed
+ object.
+ </li>
+</ul></div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_integer_endian.reference.integer_endian_pack_hpp.endian_pack.assignment"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_pack_hpp.endian_pack.assignment" title="Assignment Operator from value_type operator=(T)">Assignment
+ Operator from value_type <code class="computeroutput">operator=(T)</code></a>
+</h5></div></div></div>
+<pre class="programlisting">endian & operator=(T v);
+</pre>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ Postcondition: <code class="computeroutput">x
+ == v</code>,
+ where <code class="computeroutput">x</code> is the constructed
+ object.
+ </li>
+<li class="listitem">
+ Returns: <code class="computeroutput">*this</code>.
+ </li>
+</ul></div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_integer_endian.reference.integer_endian_pack_hpp.endian_pack.conversion"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_pack_hpp.endian_pack.conversion" title="Conversion Operator operator T()">Conversion
+ Operator <code class="computeroutput">operator T()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">operator T() const;
+</pre>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
+ Returns: The current value stored
+ in <code class="computeroutput">*this</code>,
+ converted to <code class="computeroutput">value_type</code>.
+ </li></ul></div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_integer_endian.reference.integer_endian_pack_hpp.endian_pack.data"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_pack_hpp.endian_pack.data" title="Member Function data()">Member
+ Function <code class="computeroutput">data()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">const char* data() const;
+</pre>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
+ Returns: The current value stored
+ in <code class="computeroutput">*this</code>,
+ converted to <code class="computeroutput">value_type</code>.
+ </li></ul></div>
+</div>
+</div>
+<div class="section"><div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_integer_endian.reference.integer_endian_pack_hpp.typedefs"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_pack_hpp.typedefs" title="Common typedefs">Common
+ typedefs</a>
+</h4></div></div></div></div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_integer_endian.reference.integer_endian_hpp"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_hpp" title="Header <boost/integer/endian/endian.hpp>">Header
+ <code class="computeroutput"><boost/integer/endian/endian.hpp></code></a>
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_hpp.endian">Template
+ class <code class="computeroutput">endian<></code></a></dt>
+<dd><dl>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_hpp.endian.endian">Default
+ Contructor <code class="computeroutput">endian()</code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_hpp.endian.endianT">Contructor
+ from value_type <code class="computeroutput">endian(T)</code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_hpp.endian.assignment">Assignment
+ Operator from value_type <code class="computeroutput">operator=(T)</code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_hpp.endian.conversion">Conversion
+ Operator <code class="computeroutput">operator T()</code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_hpp.endian.data">Member
+ Function <code class="computeroutput">data()</code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_hpp.endian.other">Other
+ operators </a></dt>
+</dl></dd>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_hpp.typedefs">Common
+ typedefs</a></dt>
+</dl></div>
+
+ Header <code class="computeroutput"><boost/integer/endian/endian.hpp></code>
+ provides integer-like byte-holder binary types with explicit control over
+ byte order, value type, size, and alignment. Typedefs provide easy-to-use
+ names for common configurations.
+ 
+<a name="toward_boost_integer_endian.reference.integer_endian_hpp.synopsis"></a><h5>
+<a name="id2954325"></a>
+ <a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_hpp.synopsis">Synopsis</a>
+ </h5>
+<pre class="programlisting">namespace boost {
+namespace integer {
+
+ template <typename E, typename T, std::size_t n_bits,
+ alignment A = alignment::unaligned>
+ class endian;
+
+ // unaligned big endian signed integer types
+ typedef endian< endianness::big, int_least8_t, 8, alignment::unaligned > big8_t;
+ typedef endian< endianness::big, int_least16_t, 16, alignment::unaligned > big16_t;
+ typedef endian< endianness::big, int_least32_t, 24, alignment::unaligned > big24_t;
+ typedef endian< endianness::big, int_least32_t, 32, alignment::unaligned > big32_t;
+ typedef endian< endianness::big, int_least64_t, 40, alignment::unaligned > big40_t;
+ typedef endian< endianness::big, int_least64_t, 48, alignment::unaligned > big48_t;
+ typedef endian< endianness::big, int_least64_t, 56, alignment::unaligned > big56_t;
+ typedef endian< endianness::big, int_least64_t, 64, alignment::unaligned > big64_t;
+
+ // unaligned big endian unsigned integer types
+ typedef endian< endianness::big, uint_least8_t, 8, alignment::unaligned > ubig8_t;
+ typedef endian< endianness::big, uint_least16_t, 16, alignment::unaligned > ubig16_t;
+ typedef endian< endianness::big, uint_least32_t, 24, alignment::unaligned > ubig24_t;
+ typedef endian< endianness::big, uint_least32_t, 32, alignment::unaligned > ubig32_t;
+ typedef endian< endianness::big, uint_least64_t, 40, alignment::unaligned > ubig40_t;
+ typedef endian< endianness::big, uint_least64_t, 48, alignment::unaligned > ubig48_t;
+ typedef endian< endianness::big, uint_least64_t, 56, alignment::unaligned > ubig56_t;
+ typedef endian< endianness::big, uint_least64_t, 64, alignment::unaligned > ubig64_t;
+
+ // unaligned little endian signed integer types
+ typedef endian< endianness::little, int_least8_t, 8, alignment::unaligned > little8_t;
+ typedef endian< endianness::little, int_least16_t, 16, alignment::unaligned > little16_t;
+ typedef endian< endianness::little, int_least32_t, 24, alignment::unaligned > little24_t;
+ typedef endian< endianness::little, int_least32_t, 32, alignment::unaligned > little32_t;
+ typedef endian< endianness::little, int_least64_t, 40, alignment::unaligned > little40_t;
+ typedef endian< endianness::little, int_least64_t, 48, alignment::unaligned > little48_t;
+ typedef endian< endianness::little, int_least64_t, 56, alignment::unaligned > little56_t;
+ typedef endian< endianness::little, int_least64_t, 64, alignment::unaligned > little64_t;
+
+ // unaligned little endian unsigned integer types
+ typedef endian< endianness::little, uint_least8_t, 8, alignment::unaligned > ulittle8_t;
+ typedef endian< endianness::little, uint_least16_t, 16, alignment::unaligned > ulittle16_t;
+ typedef endian< endianness::little, uint_least32_t, 24, alignment::unaligned > ulittle24_t;
+ typedef endian< endianness::little, uint_least32_t, 32, alignment::unaligned > ulittle32_t;
+ typedef endian< endianness::little, uint_least64_t, 40, alignment::unaligned > ulittle40_t;
+ typedef endian< endianness::little, uint_least64_t, 48, alignment::unaligned > ulittle48_t;
+ typedef endian< endianness::little, uint_least64_t, 56, alignment::unaligned > ulittle56_t;
+ typedef endian< endianness::little, uint_least64_t, 64, alignment::unaligned > ulittle64_t;
+
+ // unaligned native endian signed integer types
+ typedef endian< endianness::native, int_least8_t, 8, alignment::unaligned > native8_t;
+ typedef endian< endianness::native, int_least16_t, 16, alignment::unaligned > native16_t;
+ typedef endian< endianness::native, int_least32_t, 24, alignment::unaligned > native24_t;
+ typedef endian< endianness::native, int_least32_t, 32, alignment::unaligned > native32_t;
+ typedef endian< endianness::native, int_least64_t, 40, alignment::unaligned > native40_t;
+ typedef endian< endianness::native, int_least64_t, 48, alignment::unaligned > native48_t;
+ typedef endian< endianness::native, int_least64_t, 56, alignment::unaligned > native56_t;
+ typedef endian< endianness::native, int_least64_t, 64, alignment::unaligned > native64_t;
+
+ // unaligned native endian unsigned integer types
+ typedef endian< endianness::native, uint_least8_t, 8, alignment::unaligned > unative8_t;
+ typedef endian< endianness::native, uint_least16_t, 16, alignment::unaligned > unative16_t;
+ typedef endian< endianness::native, uint_least32_t, 24, alignment::unaligned > unative24_t;
+ typedef endian< endianness::native, uint_least32_t, 32, alignment::unaligned > unative32_t;
+ typedef endian< endianness::native, uint_least64_t, 40, alignment::unaligned > unative40_t;
+ typedef endian< endianness::native, uint_least64_t, 48, alignment::unaligned > unative48_t;
+ typedef endian< endianness::native, uint_least64_t, 56, alignment::unaligned > unative56_t;
+ typedef endian< endianness::native, uint_least64_t, 64, alignment::unaligned > unative64_t;
+
+ // These types only present if platform has exact size integers:
+
+ // aligned big endian signed integer types
+ typedef endian< endianness::big, int16_t, 16, alignment::aligned > aligned_big16_t;
+ typedef endian< endianness::big, int32_t, 32, alignment::aligned > aligned_big32_t;
+ typedef endian< endianness::big, int64_t, 64, alignment::aligned > aligned_big64_t;
+
+ // aligned big endian unsigned integer types
+ typedef endian< endianness::big, uint16_t, 16, alignment::aligned > aligned_ubig16_t;
+ typedef endian< endianness::big, uint32_t, 32, alignment::aligned > aligned_ubig32_t;
+ typedef endian< endianness::big, uint64_t, 64, alignment::aligned > aligned_ubig64_t;
+
+ // aligned little endian signed integer types
+ typedef endian< endianness::little, int16_t, 16, alignment::aligned > aligned_little2_t;
+ typedef endian< endianness::little, int32_t, 32, alignment::aligned > aligned_little4_t;
+ typedef endian< endianness::little, int64_t, 64, alignment::aligned > aligned_little8_t;
+
+ // aligned little endian unsigned integer types
+ typedef endian< endianness::little, uint16_t, 16, alignment::aligned > aligned_ulittle2_t;
+ typedef endian< endianness::little, uint32_t, 32, alignment::aligned > aligned_ulittle4_t;
+ typedef endian< endianness::little, uint64_t, 64, alignment::aligned > aligned_ulittle8_t;
+
+
+ // aligned native endian typedefs are not provided because
+ // <cstdint> types are superior for this use case
+
+} // namespace integer
+} // namespace boost
+</pre>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_integer_endian.reference.integer_endian_hpp.endian"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_hpp.endian" title="Template class endian<>">Template
+ class <code class="computeroutput">endian<></code></a>
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_hpp.endian.endian">Default
+ Contructor <code class="computeroutput">endian()</code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_hpp.endian.endianT">Contructor
+ from value_type <code class="computeroutput">endian(T)</code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_hpp.endian.assignment">Assignment
+ Operator from value_type <code class="computeroutput">operator=(T)</code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_hpp.endian.conversion">Conversion
+ Operator <code class="computeroutput">operator T()</code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_hpp.endian.data">Member
+ Function <code class="computeroutput">data()</code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_hpp.endian.other">Other
+ operators </a></dt>
+</dl></div>
+
+ An endian integer is an integer byte-holder with user-specified endianness,
+ value type, size, and alignment. The usual operations on integers are supplied.
+ 
+<pre class="programlisting">template <
+ typename E,
+ typename T,
+ std::size_t n_bits=8*sizeof(T),
+ alignment A = alignment::aligned>
+class endian : integer_cover_operators< endian<E, T, n_bits, A>, T > {
+public:
+ typedef E endian_type;
+ typedef T value_type;
+ static const std::size_t width = n_bits;
+ static const alignment alignment_value = A;
+
+ endian() = default; // = default replaced by {} on C++03
+ explicit endian(T v);
+ endian & operator=(T v);
+ operator T() const;
+ const char* data() const;
+};
+</pre>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
+
+ Requires:
+ 
+<div class="itemizedlist"><ul class="itemizedlist" type="circle">
+<li class="listitem">
+ <code class="computeroutput">E</code> is one of <code class="computeroutput">endianness::big</code> or <code class="computeroutput">endianness::little</code>.
+ </li>
+<li class="listitem">
+ <code class="computeroutput">T</code> must be a POD
+ with value semantics.
+ </li>
+<li class="listitem">
+ <code class="computeroutput">nbits</code> is a multiple
+ of <code class="computeroutput">8</code>
+ </li>
+<li class="listitem">
+ If <code class="computeroutput">A</code> is <code class="computeroutput">alignment::aligned</code> then <code class="computeroutput">nbits</code>
+ must be equal to <code class="computeroutput">8*sizeof(T)</code>
+ </li>
+</ul></div>
+</li></ul></div>
+<div class="note"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td align="left" valign="top">
+ if BOOST_ENDIAN_FORCE_PODNESS is defined && C++0x POD's are not
+ available then these two constructors will not be present
+ </td></tr>
+</table></div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_integer_endian.reference.integer_endian_hpp.endian.endian"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_hpp.endian.endian" title="Default Contructor endian()">Default
+ Contructor <code class="computeroutput">endian()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">endian() = default; // C++03: endian(){}
+</pre>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
+ Effects: Constructs an object of
+ type <code class="computeroutput">endian<E, T, n_bits,
+ A></code>.
+ </li></ul></div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_integer_endian.reference.integer_endian_hpp.endian.endianT"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_hpp.endian.endianT" title="Contructor from value_type endian(T)">Contructor
+ from value_type <code class="computeroutput">endian(T)</code></a>
+</h5></div></div></div>
+<pre class="programlisting">explicit endian(T v);
+</pre>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ Effects: Constructs an object of
+ type <code class="computeroutput">endian<E, T, n_bits,
+ A></code>.
+ </li>
+<li class="listitem">
+ Postcondition: <code class="computeroutput">x
+ == v</code>,
+ where <code class="computeroutput">x</code> is the constructed
+ object.
+ </li>
+</ul></div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_integer_endian.reference.integer_endian_hpp.endian.assignment"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_hpp.endian.assignment" title="Assignment Operator from value_type operator=(T)">Assignment
+ Operator from value_type <code class="computeroutput">operator=(T)</code></a>
+</h5></div></div></div>
+<pre class="programlisting">endian & operator=(T v);
+</pre>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ Postcondition: <code class="computeroutput">value_type(*this) == v</code>.
+ </li>
+<li class="listitem">
+ Returns: <code class="computeroutput">*this</code>.
+ </li>
+</ul></div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_integer_endian.reference.integer_endian_hpp.endian.conversion"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_hpp.endian.conversion" title="Conversion Operator operator T()">Conversion
+ Operator <code class="computeroutput">operator T()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">operator T() const;
+</pre>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
+ Returns: The current value stored
+ in <code class="computeroutput">*this</code>,
+ converted to <code class="computeroutput">value_type</code>.
+ </li></ul></div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_integer_endian.reference.integer_endian_hpp.endian.data"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_hpp.endian.data" title="Member Function data()">Member
+ Function <code class="computeroutput">data()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">const char* data() const;
+</pre>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
+ Returns: The current value stored
+ in <code class="computeroutput">*this</code>,
+ converted to <code class="computeroutput">value_type</code>.
+ </li></ul></div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_integer_endian.reference.integer_endian_hpp.endian.other"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_hpp.endian.other" title="Other operators">Other
+ operators </a>
+</h5></div></div></div>
+
+ Other operators on endian objects are forwarded to the equivalent operator
+ on <code class="computeroutput">value_type</code>.
+ 
+</div>
+</div>
+<div class="section"><div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_integer_endian.reference.integer_endian_hpp.typedefs"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_hpp.typedefs" title="Common typedefs">Common
+ typedefs</a>
+</h4></div></div></div></div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_integer_endian.reference.integer_endian_binary_stream_hpp"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_binary_stream_hpp" title="Header <boost/integer/endian/endian_binary_stream.hpp>">Header
+ <code class="computeroutput"><boost/integer/endian/endian_binary_stream.hpp></code></a>
+</h3></div></div></div>
+
+ Header <boost/integer/endian/endian_binary_stream.hpp> provides operators
+ <code class="computeroutput"><=</code> and <code class="computeroutput">=></code>
+ for unformatted binary (as opposed to formatted character) stream insertion
+ and extraction of endian types.
+ 
+<a name="toward_boost_integer_endian.reference.integer_endian_binary_stream_hpp.synopsis"></a><h5>
+<a name="id2961452"></a>
+ <a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_binary_stream_hpp.synopsis">Synopsis</a>
+ </h5>
+<pre class="programlisting">namespace boost
+{
+ namespace integer
+ {
+ template< class T >
+ struct is_endian { static const bool value = false; };
+ template< typename E, typename T, std::size_t n_bits, alignment A >
+ struct is_endian<endian_pack<E,T,n_bits,A> { static const bool value = true; };
+ template< typename E, typename T, std::size_t n_bits, alignment A >
+ struct is_endian<endian<E,T,n_bits,A> { static const bool value = true; };
+
+ template < class Endian >
+ typename boost::enable_if< is_endian<Endian>, std::ostream & >::type
+ operator<=( std::ostream & os, const Endian & e );
+
+ template < class Endian >
+ typename boost::enable_if< is_endian<Endian>, std::istream & >::type
+ operator>=( std::istream & is, Endian & e );
+ }
+}
+</pre>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_integer_endian.reference.integer_endian_type_hpp"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_type_hpp" title="Header <boost/integer/endian/endian_type.hpp>">Header
+ <code class="computeroutput"><boost/integer/endian/endian_type.hpp></code></a>
+</h3></div></div></div>
+<div class="toc"><dl><dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_type_hpp.integer_endian_type">Meta
+ Function <code class="computeroutput">endian_type<></code></a></dt></dl></div>
+<a name="toward_boost_integer_endian.reference.integer_endian_type_hpp.synopsis"></a><h5>
+<a name="id2962418"></a>
+ <a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_type_hpp.synopsis">Synopsis</a>
+ </h5>
+<pre class="programlisting">namespace boost {
+namespace integer {
+ template <typename T>
+ struct endian_type;
+}
+}
+</pre>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_integer_endian.reference.integer_endian_type_hpp.integer_endian_type"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_type_hpp.integer_endian_type" title="Meta Function endian_type<>">Meta
+ Function <code class="computeroutput">endian_type<></code></a>
+</h4></div></div></div>
+<pre class="programlisting">template <typename Domain, typename T>
+struct endian_type {
+ typedef type;
+}
+</pre>
+
+ The member typedef <code class="computeroutput">type</code>
+ names one of the <code class="computeroutput">endianness</code>
+ types <code class="computeroutput">big</code>, <code class="computeroutput">little</code> or <code class="computeroutput">mixed</code>.
+ If all the leaves of the type T are of the same endianness type is this
+ endiannes, otherwise it is <code class="computeroutput">mixed</code>.
+ 
+
+ The default behavior works for all the endian aware types, fundamental
+ types and any type that is a fusion sequence.
+ 
+
+ The user can specialize this metafunction for specific clases.
+ 
+<a name="toward_boost_integer_endian.reference.integer_endian_type_hpp.integer_endian_type.example"></a><h6>
+<a name="id2962736"></a>
+ <a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_type_hpp.integer_endian_type.example">Example</a>
+ </h6>
+<pre class="programlisting">is_same<endian_type<endian<endianness::big, int> >::type, endianness::big>::value == true
+is_same<endian_type<int>::type, endianness::native>::value == true
+</pre>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_integer_endian.reference.integer_endian_view_hpp"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_view_hpp" title="Header <boost/integer/endian/endian_view.hpp>">Header
+ <code class="computeroutput"><boost/integer/endian/endian_view.hpp></code></a>
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_view_hpp.endian_view">Template
+ class <code class="computeroutput">endian_view<></code></a></dt>
+<dd><dl>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_view_hpp.endian_view.endian_view">Constructor
+ <code class="computeroutput">endian_view</code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_view_hpp.endian_view.operator_value_type">Conversion
+ <code class="computeroutput">operator value_type()</code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_view_hpp.endian_view.assignement">Assignement
+ <code class="computeroutput">operator =(endian_view const& )</code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_view_hpp.endian_view.assignement2">Assignement
+ from different endianness<code class="computeroutput">operator
+ =(endian_view<Endian2,T>
+ const&
+ )</code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_view_hpp.endian_view.assignement_value_type">Assignement
+ from value_type <code class="computeroutput">operator =(value_type)</code></a></dt>
+</dl></dd>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_view_hpp.as_endian">Non-Member
+ Function Template <code class="computeroutput">as_endian<></code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_view_hpp.as">Non-Member
+ Function Template <code class="computeroutput">as<></code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_view_hpp.as_little">Non-Member
+ Function Template <code class="computeroutput">as_little<></code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_view_hpp.as_big">Non-Member
+ Function Template <code class="computeroutput">as_big<></code></a></dt>
+</dl></div>
+
+ This file provides the <code class="computeroutput">endian_view<></code> class template as well as some factory
+ helper functions.
+ 
+<a name="toward_boost_integer_endian.reference.integer_endian_view_hpp.synopsis"></a><h5>
+<a name="id2963041"></a>
+ <a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_view_hpp.synopsis">Synopsis</a>
+ </h5>
+<pre class="programlisting">namespace boost {
+namespace integer {
+
+ template <typename Endian>
+ class endian_view;
+
+ template <typename E, typename T>
+ endian_view<endian_pack<E,T> > as_endian(T& v);
+ template <typename T>
+ endian_view<endian_pack<endianness::native, T> > as(T& v);
+ template <typename T>
+ endian_view<endian_pack<endianness::little,T> > as_little(T& v);
+ template <typename T>
+ endian_view<endian_pack<endianness::big,T> > as_big(T& v);
+
+
+} // namespace integer
+} // namespace boost
+</pre>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_integer_endian.reference.integer_endian_view_hpp.endian_view"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_view_hpp.endian_view" title="Template class endian_view<>">Template
+ class <code class="computeroutput">endian_view<></code></a>
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_view_hpp.endian_view.endian_view">Constructor
+ <code class="computeroutput">endian_view</code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_view_hpp.endian_view.operator_value_type">Conversion
+ <code class="computeroutput">operator value_type()</code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_view_hpp.endian_view.assignement">Assignement
+ <code class="computeroutput">operator =(endian_view const& )</code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_view_hpp.endian_view.assignement2">Assignement
+ from different endianness<code class="computeroutput">operator
+ =(endian_view<Endian2,T>
+ const&
+ )</code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_view_hpp.endian_view.assignement_value_type">Assignement
+ from value_type <code class="computeroutput">operator =(value_type)</code></a></dt>
+</dl></div>
+<pre class="programlisting">template <typename Endian, typename T>
+class endian_view {
+public:
+ typedef T value_type;
+ endian_view()=delete;
+ endian_view(value_type& ref);
+ operator value_type() const;
+ endian_view& operator=(value_type val);
+ endian_view& operator=(endian_view const& rhs);
+ template <typename Endian2 >
+ endian_view& operator=(endian_view<Endian2,T> const& rhs) {
+};
+</pre>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_integer_endian.reference.integer_endian_view_hpp.endian_view.endian_view"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_view_hpp.endian_view.endian_view" title="Constructor endian_view">Constructor
+ <code class="computeroutput">endian_view</code></a>
+</h5></div></div></div>
+<pre class="programlisting">endian_view(value_type& ref);
+</pre>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
+ Effects: Constructs an object of
+ type <code class="computeroutput">endian_view<E, T, n_bits, A></code>.
+ </li></ul></div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_integer_endian.reference.integer_endian_view_hpp.endian_view.operator_value_type"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_view_hpp.endian_view.operator_value_type" title="Conversion operator value_type()">Conversion
+ <code class="computeroutput">operator value_type()</code></a>
+</h5></div></div></div>
+<pre class="programlisting">operator value_type() const;
+</pre>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
+ Returns: The converted <code class="computeroutput">value_type</code> of the referenced type
+ as it was seen as an endian aware type.
+ </li></ul></div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_integer_endian.reference.integer_endian_view_hpp.endian_view.assignement"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_view_hpp.endian_view.assignement" title="Assignement operator =(endian_view const& )">Assignement
+ <code class="computeroutput">operator =(endian_view const& )</code></a>
+</h5></div></div></div>
+<pre class="programlisting">endian_view& operator=(endian_view const& rhs);
+</pre>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ Postcondition: <code class="computeroutput">this->ref_
+ == rhs.ref_</code>.
+ </li>
+<li class="listitem">
+ Returns: <code class="computeroutput">*this</code>.
+ </li>
+</ul></div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_integer_endian.reference.integer_endian_view_hpp.endian_view.assignement2"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_view_hpp.endian_view.assignement2" title="Assignement from different endiannessoperator =(endian_view<Endian2,T> const& )">Assignement
+ from different endianness<code class="computeroutput">operator
+ =(endian_view<Endian2,T>
+ const&
+ )</code></a>
+</h5></div></div></div>
+<pre class="programlisting">template <typename Endian2 >
+endian_view& operator=(endian_view<Endian2,T> const& rhs) {
+</pre>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ Postcondition: <code class="computeroutput">value_type(this->ref_) == value_type(rhs.ref_)</code>.
+ </li>
+<li class="listitem">
+ Returns: <code class="computeroutput">*this</code>.
+ </li>
+</ul></div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_integer_endian.reference.integer_endian_view_hpp.endian_view.assignement_value_type"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_view_hpp.endian_view.assignement_value_type" title="Assignement from value_type operator =(value_type)">Assignement
+ from value_type <code class="computeroutput">operator =(value_type)</code></a>
+</h5></div></div></div>
+<pre class="programlisting">endian_view& operator=(value_type val);
+</pre>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ Postcondition: <code class="computeroutput">value_type(this->ref_) == v</code>.
+ </li>
+<li class="listitem">
+ Returns: <code class="computeroutput">*this</code>.
+ </li>
+</ul></div>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_integer_endian.reference.integer_endian_view_hpp.as_endian"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_view_hpp.as_endian" title="Non-Member Function Template as_endian<>">Non-Member
+ Function Template <code class="computeroutput">as_endian<></code></a>
+</h4></div></div></div>
+<pre class="programlisting">template <typename E, typename T>
+endian_view<endian<E,T> > as_endian(T& v);
+</pre>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_integer_endian.reference.integer_endian_view_hpp.as"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_view_hpp.as" title="Non-Member Function Template as<>">Non-Member
+ Function Template <code class="computeroutput">as<></code></a>
+</h4></div></div></div>
+<pre class="programlisting">template <typename T>
+endian_view<endian<endian::native, T> > as(T& v);
+</pre>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_integer_endian.reference.integer_endian_view_hpp.as_little"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_view_hpp.as_little" title="Non-Member Function Template as_little<>">Non-Member
+ Function Template <code class="computeroutput">as_little<></code></a>
+</h4></div></div></div>
+<pre class="programlisting">template <typename T>
+endian_view<endian<endian::little, T> > as_little(T& v);
+</pre>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_integer_endian.reference.integer_endian_view_hpp.as_big"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_view_hpp.as_big" title="Non-Member Function Template as_big<>">Non-Member
+ Function Template <code class="computeroutput">as_big<></code></a>
+</h4></div></div></div>
+<pre class="programlisting">template <typename T>
+endian_view<endian<endian::big, T> > as_big(T& v);
+</pre>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_integer_endian.reference.integer_endian_conversion_hpp"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_conversion_hpp" title="Header <boost/integer/endian/endian_conversion.hpp>">Header
+ <code class="computeroutput"><boost/integer/endian/endian_conversion.hpp></code></a>
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_conversion_hpp.convert_to_from">Non-Member
+ Function Template <code class="computeroutput">convert_to_from<></code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_conversion_hpp.convert_from">Non-Member
+ Function Template <code class="computeroutput">convert_from<></code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_conversion_hpp.convert_to">Non-Member
+ Function Template <code class="computeroutput">convert_to<></code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_conversion_hpp.to">Class
+ Template <code class="computeroutput">to<></code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_conversion_hpp.from">Class
+ Template <code class="computeroutput">from<></code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_conversion_hpp.is_to">Class
+ Template <code class="computeroutput">is_to<></code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_conversion_hpp.is_from">Class
+ Template <code class="computeroutput">is_from<></code></a></dt>
+<dt><a href="reference.html#toward_boost_integer_endian.reference.integer_endian_conversion_hpp.convert">Non-Member
+ Function Template <code class="computeroutput">convert<></code></a></dt>
+</dl></div>
+<a name="toward_boost_integer_endian.reference.integer_endian_conversion_hpp.synopsis"></a><h5>
+<a name="id2965574"></a>
+ <a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_conversion_hpp.synopsis">Synopsis</a>
+ </h5>
+<pre class="programlisting">namespace boost {
+namespace integer {
+
+ template <typename TargetDomain, typename SourceDomain, typename T>
+ void convert_to_from(T& r);
+
+ template <typename SourceDomain, typename T>
+ void convert_from(T& r);
+
+ template <typename TargetDomain, typename T>
+ void convert_to(T& r);
+
+ template <typename Endian> struct to;
+ template <typename Endian> struct from;
+ template <typename Endian> struct is_to;
+ template <typename Endian> struct is_from;
+
+ template <typename Endian1, typename Endian2, typename T>
+ void convert(T& r);
+
+
+} // namespace integer
+} // namespace boost
+</pre>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_integer_endian.reference.integer_endian_conversion_hpp.convert_to_from"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_conversion_hpp.convert_to_from" title="Non-Member Function Template convert_to_from<>">Non-Member
+ Function Template <code class="computeroutput">convert_to_from<></code></a>
+</h4></div></div></div>
+<pre class="programlisting">template <typename TargetDomain, typename SourceDomain, typename T>
+void convert_to_from(T& r);
+</pre>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_integer_endian.reference.integer_endian_conversion_hpp.convert_from"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_conversion_hpp.convert_from" title="Non-Member Function Template convert_from<>">Non-Member
+ Function Template <code class="computeroutput">convert_from<></code></a>
+</h4></div></div></div>
+<pre class="programlisting">template <typename SourceDomain, typename T>
+void convert_from(T& r);
+</pre>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_integer_endian.reference.integer_endian_conversion_hpp.convert_to"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_conversion_hpp.convert_to" title="Non-Member Function Template convert_to<>">Non-Member
+ Function Template <code class="computeroutput">convert_to<></code></a>
+</h4></div></div></div>
+<pre class="programlisting">template <typename TargetDomain, typename T>
+void convert_to(T& r);
+</pre>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_integer_endian.reference.integer_endian_conversion_hpp.to"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_conversion_hpp.to" title="Class Template to<>">Class
+ Template <code class="computeroutput">to<></code></a>
+</h4></div></div></div>
+<pre class="programlisting">template <typename Endian>
+struct to {
+ typedef Endian type;
+};
+</pre>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_integer_endian.reference.integer_endian_conversion_hpp.from"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_conversion_hpp.from" title="Class Template from<>">Class
+ Template <code class="computeroutput">from<></code></a>
+</h4></div></div></div>
+<pre class="programlisting">template <typename Endian>
+struct from {
+ typedef Endian type;
+};
+</pre>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_integer_endian.reference.integer_endian_conversion_hpp.is_to"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_conversion_hpp.is_to" title="Class Template is_to<>">Class
+ Template <code class="computeroutput">is_to<></code></a>
+</h4></div></div></div>
+<pre class="programlisting">template <typename Endian>
+struct is_to : mpl::false_ {};
+template <typename Endian>
+struct is_to< to<Endian> > : mpl::true_ {};
+</pre>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_integer_endian.reference.integer_endian_conversion_hpp.is_from"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_conversion_hpp.is_from" title="Class Template is_from<>">Class
+ Template <code class="computeroutput">is_from<></code></a>
+</h4></div></div></div>
+<pre class="programlisting">template <typename Endian>
+struct is_from : mpl::false_ {};
+template <typename Endian>
+struct is_from< from<Endian> > : mpl::true_ {};
+</pre>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_integer_endian.reference.integer_endian_conversion_hpp.convert"></a><a class="link" href="reference.html#toward_boost_integer_endian.reference.integer_endian_conversion_hpp.convert" title="Non-Member Function Template convert<>">Non-Member
+ Function Template <code class="computeroutput">convert<></code></a>
+</h4></div></div></div>
+<pre class="programlisting">template <typename Endian1, typename Endian2, typename T>
+void convert(T& r);
+</pre>
+</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 © 2006 -2009 Beman Dawes Copyright © 2010 Vicente J. Botet Escriba
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="users_guide.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="appendices.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/endian_ext/libs/integer/endian/doc/html/toward_boost_integer_endian/users_guide.html
==============================================================================
--- (empty file)
+++ sandbox/endian_ext/libs/integer/endian/doc/html/toward_boost_integer_endian/users_guide.html 2011-02-13 14:58:05 EST (Sun, 13 Feb 2011)
@@ -0,0 +1,1465 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Users'Guide</title>
+<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../index.html" title="Toward Boost.Integer.Endian 0.2.0">
+<link rel="up" href="../index.html" title="Toward Boost.Integer.Endian 0.2.0">
+<link rel="prev" href="overview.html" title="Overview">
+<link rel="next" href="reference.html" title="Reference">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="overview.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="reference.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="toward_boost_integer_endian.users_guide"></a><a class="link" href="users_guide.html" title="Users'Guide">Users'Guide</a>
+</h2></div></div></div>
+<div class="toc"><dl>
+<dt><a href="users_guide.html#toward_boost_integer_endian.users_guide.getting_started">Getting
+ Started</a></dt>
+<dd><dl>
+<dt><a href="users_guide.html#toward_boost_integer_endian.users_guide.getting_started.install">Installing
+ Boost.Integer.Endian.Ext</a></dt>
+<dt><a href="users_guide.html#toward_boost_integer_endian.users_guide.getting_started.hello_endian_world__">Hello
+ Endian World! </a></dt>
+<dt><a href="users_guide.html#toward_boost_integer_endian.users_guide.getting_started.limitations_">Limitations
+ </a></dt>
+</dl></dd>
+<dt>Tutorial</dt>
+<dd><dl>
+<dt><a href="users_guide.html#toward_boost_integer_endian.users_guide.tutorial.endian_aware_types">Endian
+ aware types</a></dt>
+<dt><a href="users_guide.html#toward_boost_integer_endian.users_guide.tutorial.endian_unaware_types">Endian
+ unaware types</a></dt>
+</dl></dd>
+<dt>Examples</dt>
+<dd><dl>
+<dt><a href="users_guide.html#toward_boost_integer_endian.users_guide.examples.aware">Endian
+ Aware</a></dt>
+<dt><a href="users_guide.html#toward_boost_integer_endian.users_guide.examples.receiver_makes_right">"receiver
+ makes right"</a></dt>
+</dl></dd>
+<dt>References</dt>
+</dl></div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_integer_endian.users_guide.getting_started"></a><a class="link" href="users_guide.html#toward_boost_integer_endian.users_guide.getting_started" title="Getting Started">Getting
+ Started</a>
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt><a href="users_guide.html#toward_boost_integer_endian.users_guide.getting_started.install">Installing
+ Boost.Integer.Endian.Ext</a></dt>
+<dt><a href="users_guide.html#toward_boost_integer_endian.users_guide.getting_started.hello_endian_world__">Hello
+ Endian World! </a></dt>
+<dt><a href="users_guide.html#toward_boost_integer_endian.users_guide.getting_started.limitations_">Limitations
+ </a></dt>
+</dl></div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_integer_endian.users_guide.getting_started.install"></a><a class="link" href="users_guide.html#toward_boost_integer_endian.users_guide.getting_started.install" title="Installing Boost.Integer.Endian.Ext">Installing
+ Boost.Integer.Endian.Ext</a>
+</h4></div></div></div>
+<a name="toward_boost_integer_endian.users_guide.getting_started.install.getting__emphasis_role__bold__boost_integer_endian_ext__emphasis_"></a><h6>
+<a name="id2933658"></a>
+ <a class="link" href="users_guide.html#toward_boost_integer_endian.users_guide.getting_started.install.getting__emphasis_role__bold__boost_integer_endian_ext__emphasis_">Getting
+ Boost.Integer.Endian.Ext</a>
+ </h6>
+
+ You can get the last stable release of Boost.Integer.Endian.Ext
+ by downloading <code class="literal">integer_endian.zip</code> from the <a href="http://www.boost-consulting.com/vault/index.php?directory=Portability%20Programming" target="_top">Boost
+ Vault</a>
+ 
+
+ You can also access the latest (unstable?) state from the <a href="https://svn.boost.org/svn/boost/sandbox/endian_ext" target="_top">Boost
+ Sandbox</a>.
+ 
+<a name="toward_boost_integer_endian.users_guide.getting_started.install.building__emphasis_role__bold__boost_integer_endian_ext__emphasis_"></a><h6>
+<a name="id2933719"></a>
+ <a class="link" href="users_guide.html#toward_boost_integer_endian.users_guide.getting_started.install.building__emphasis_role__bold__boost_integer_endian_ext__emphasis_">Building
+ Boost.Integer.Endian.Ext</a>
+ </h6>
+
+ Boost.Integer.Endian.Ext is implemented
+ entirely within headers, with no need to link to any Boost object libraries.
+ 
+
+ Several macros allow user control over features:
+ 
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ BOOST_ENDIAN_NO_CTORS causes class endian to have no constructors.
+ The intended use is for compiling user code that must be portable between
+ compilers regardless of C++0x Defaulted Functions support. Use of constructors
+ will always fail,
+ </li>
+<li class="listitem">
+ BOOST_ENDIAN_FORCE_PODNESS causes BOOST_ENDIAN_NO_CTORS to be defined
+ if the compiler does not support C++0x Defaulted Functions. This is
+ ensures that , and so can be used in unions. In C++0x, class endian
+ objects are POD's even though they have constructors.
+ </li>
+</ul></div>
+<a name="toward_boost_integer_endian.users_guide.getting_started.install.requirements"></a><h6>
+<a name="id2933790"></a>
+ <a class="link" href="users_guide.html#toward_boost_integer_endian.users_guide.getting_started.install.requirements">Requirements</a>
+ </h6>
+
+ Boost.Integer.Endian.Ext depends on some
+ Boost library. The library has been tested on trunk but an older version
+ should works also.
+ 
+
+ In particular, Boost.Integer.Endian.Ext
+ depends on:
+ 
+<div class="variablelist">
+
+<dl>
+<dt>Boost.Config</dt>
+<dd>
+ for configuration purposes, ...
+ </dd>
+</dl>
+</div>
+<a name="toward_boost_integer_endian.users_guide.getting_started.install.exceptions_safety"></a><h6>
+<a name="id2933856"></a>
+ <a class="link" href="users_guide.html#toward_boost_integer_endian.users_guide.getting_started.install.exceptions_safety">Exceptions
+ safety</a>
+ </h6>
+
+ All functions in the library are exception-neutral and provide strong guarantee
+ of exception safety as long as the underlying parameters provide it.
+ 
+<a name="toward_boost_integer_endian.users_guide.getting_started.install.thread_safety"></a><h6>
+<a name="id2933884"></a>
+ <a class="link" href="users_guide.html#toward_boost_integer_endian.users_guide.getting_started.install.thread_safety">Thread
+ safety</a>
+ </h6>
+
+ All functions in the library are thread-unsafe except when noted explicitly.
+ 
+<a name="toward_boost_integer_endian.users_guide.getting_started.install.tested_compilers"></a><h6>
+<a name="id2933910"></a>
+ <a class="link" href="users_guide.html#toward_boost_integer_endian.users_guide.getting_started.install.tested_compilers">Tested
+ compilers</a>
+ </h6>
+
+ The implementation will eventually work with most C++03 conforming compilers.
+ Current version has been tested on:
+ 
+
+ Cygwin 1.7 with
+ 
+<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
+ GCC 4.3.4
+ </li></ul></div>
+
+ MinGW with
+ 
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ GCC 4.4.0
+ </li>
+<li class="listitem">
+ GCC 4.5.0
+ </li>
+<li class="listitem">
+ GCC 4.5.0 -std=c++0x
+ </li>
+</ul></div>
+
+ Ubuntu 10.10
+ 
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ GCC 4.4.5
+ </li>
+<li class="listitem">
+ GCC 4.4.5 -std=c++0x
+ </li>
+</ul></div>
+<div class="note"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td align="left" valign="top">
+ Please let us know how this works on other platforms/compilers.
+ </td></tr>
+</table></div>
+<div class="note"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td align="left" valign="top">
+ Please send any questions, comments and bug reports to boost <at>
+ lists <dot> boost <dot> org.
+ </td></tr>
+</table></div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_integer_endian.users_guide.getting_started.hello_endian_world__"></a><a class="link" href="users_guide.html#toward_boost_integer_endian.users_guide.getting_started.hello_endian_world__" title="Hello Endian World!">Hello
+ Endian World! </a>
+</h4></div></div></div>
+<pre class="programlisting">#include <boost/integer/endian/endian.hpp>
+#include <boost/integer/endian/endian_binary_stream.hpp>
+#include <boost/binary_stream.hpp>
+#include <iostream>
+
+using namespace boost;
+using namespace boost::integer;
+
+int main()
+{
+ int_least32_t v = 0x31323334L; // = ASCII { '1', '2', '3', '4' }
+ // value chosen to work on text stream
+ big32_t b(v);
+ little32_t l(v);
+
+ std::cout << "Hello, endian world!\n\n";
+
+ std::cout << v << ' ' << b << ' ' << l << '\n';
+ std::cout <= v <= ' ' <= b <= ' ' <= l <= '\n';
+}
+</pre>
+
+ On a little-endian CPU, this program outputs:
+ 
+<pre class="programlisting">Hello, endian world!
+
+825373492 825373492 825373492
+4321 1234 4321
+</pre>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_integer_endian.users_guide.getting_started.limitations_"></a><a class="link" href="users_guide.html#toward_boost_integer_endian.users_guide.getting_started.limitations_" title="Limitations">Limitations
+ </a>
+</h4></div></div></div>
+
+ Requires <code class="computeroutput"><climits> CHAR_BIT
+ == 8</code>.
+ If <code class="computeroutput">CHAR_BIT</code> is some other
+ value, compilation will result in an <code class="computeroutput">#error</code>.
+ This restriction is in place because the design, implementation, testing,
+ and documentation has only considered issues related to 8-bit bytes, and
+ there have been no real-world use cases presented for other sizes.
+ 
+
+ In C++03, endian does not meet the requirements for POD types because it
+ has constructors, private data members, and a base class. This means that
+ common use cases are relying on unspecified behavior in that the C++ Standard
+ does not guarantee memory layout for non-POD types. This has not been a
+ problem in practice since all known C++ compilers do layout memory as if
+ endian were a POD type. In C++0x, it will be possible to specify the default
+ constructor as trivial, and private data members and base classes will
+ no longer disqualify a type from being a POD. Thus under C++0x, endian
+ will no longer be relying on unspecified behavior.
+ 
+<a name="toward_boost_integer_endian.users_guide.getting_started.limitations_.binary_i_o_warnings_and_cautions"></a><h6>
+<a name="id2934700"></a>
+ <a class="link" href="users_guide.html#toward_boost_integer_endian.users_guide.getting_started.limitations_.binary_i_o_warnings_and_cautions">Binary
+ I/O warnings and cautions</a>
+ </h6>
+<div class="warning"><table border="0" summary="Warning">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="../../../../../doc/src/images/warning.png"></td>
+<th align="left">Warning</th>
+</tr>
+<tr><td align="left" valign="top">
+ Use only on streams opened with filemode <code class="computeroutput">std::ios_base::binary</code>.
+ Thus unformatted binary I/O should not be with the standard streams (<code class="computeroutput">cout</code>, <code class="computeroutput">cin</code>,
+ etc.) since they are opened in text mode. Use on text streams may produce
+ incorrect results, such as insertion of unwanted characters or premature
+ end-of-file. For example, on Windows <code class="computeroutput">0x0D</code>
+ would become <code class="computeroutput">0x0D</code>, <code class="computeroutput">0x0A</code>.
+ </td></tr>
+</table></div>
+<div class="warning"><table border="0" summary="Warning">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="../../../../../doc/src/images/warning.png"></td>
+<th align="left">Warning</th>
+</tr>
+<tr><td align="left" valign="top">
+
+ Caution: When mixing formatted (i.e. operator <code class="computeroutput"><<</code>
+ or <code class="computeroutput">>></code>) and unformatted
+ (i.e. operator <code class="computeroutput"><=</code> or
+ <code class="computeroutput">>=</code>) stream I/O, be aware
+ that <code class="computeroutput"><<</code> and <code class="computeroutput">>></code> take precedence over <code class="computeroutput"><=</code> and <code class="computeroutput">>=</code>.
+ Use parentheses to force correct order of evaluation. For example:
+ 
+
+
+
+<pre class="programlisting">my_stream << foo <= bar; // no parentheses needed
+(my_stream <= foo) << bar; // parentheses required
+</pre>
+
+ As a practical matter, it may be easier and safer to never mix the character
+ and binary insertion or extraction operators in the same statement.
+ 
+</td></tr>
+</table></div>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_integer_endian.users_guide.tutorial"></a><a class="link" href="users_guide.html#toward_boost_integer_endian.users_guide.tutorial" title="Tutorial">Tutorial</a>
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt><a href="users_guide.html#toward_boost_integer_endian.users_guide.tutorial.endian_aware_types">Endian
+ aware types</a></dt>
+<dd><dl><dt><a href="users_guide.html#toward_boost_integer_endian.users_guide.tutorial.endian_aware_types.endian_aware_integers">Endian
+ aware integers</a></dt></dl></dd>
+<dt><a href="users_guide.html#toward_boost_integer_endian.users_guide.tutorial.endian_unaware_types">Endian
+ unaware types</a></dt>
+</dl></div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_integer_endian.users_guide.tutorial.endian_aware_types"></a><a class="link" href="users_guide.html#toward_boost_integer_endian.users_guide.tutorial.endian_aware_types" title="Endian aware types">Endian
+ aware types</a>
+</h4></div></div></div>
+<div class="toc"><dl><dt><a href="users_guide.html#toward_boost_integer_endian.users_guide.tutorial.endian_aware_types.endian_aware_integers">Endian
+ aware integers</a></dt></dl></div>
+<a name="toward_boost_integer_endian.users_guide.tutorial.endian_aware_types.basic_endian_holders"></a><h6>
+<a name="id2935008"></a>
+ <a class="link" href="users_guide.html#toward_boost_integer_endian.users_guide.tutorial.endian_aware_types.basic_endian_holders">basic
+ endian holders</a>
+ </h6>
+
+ Boost.Integer.Endian.Ext provides an endian
+ aware byte-holder class template:
+ 
+<pre class="programlisting">template <endianness::enum_t E, typename T, std::size_t n_bytes=8*sizeof(T),
+ alignment::enum_t A = alignment::aligned>
+class endian_pack;
+</pre>
+
+ This class provide portable byte-holders for data, independent of particular
+ computer architectures. Use cases almost always involve I/O, either via
+ files or network connections. Although data portability is the primary
+ motivation, these byte-holders may also be used to reduce memory use, file
+ size, or network activity since they provide binary integer sizes not otherwise
+ available.
+ 
+
+ Such byte-holder types are traditionally called endian types. See the Wikipedia
+ for a full exploration of endianness, including definitions of big endian
+ and little endian.
+ 
+
+ This class doesn't provides arithmetic operators, but of course automatic
+ conversion to and assignment from the underlying integer value type are
+ provided.
+ 
+<pre class="programlisting">#include <boost/integer/endian/endian_pack.hpp>
+#include <iostream>
+
+using namespace boost;
+using namespace boost::integer;
+using namespace boost::integer::endianness;
+
+
+int main()
+{
+ int_least32_t v = 0x31323334L; // = ASCII { '1', '2', '3', '4' }
+ // value chosen to work on text stream
+
+ endian_pack<big, int_least32_t> b(v);
+ endian_pack<little, int_least32_t> l(v);
+
+ std::cout << v << ' ' << b << ' ' << l << '\n';
+ return 0;
+}
+</pre>
+
+ On a little-endian CPU, this program outputs:
+ 
+<pre class="programlisting">825373492 825373492 825373492
+</pre>
+<a name="toward_boost_integer_endian.users_guide.tutorial.endian_aware_types.binary_streams"></a><h6>
+<a name="id2935648"></a>
+ <a class="link" href="users_guide.html#toward_boost_integer_endian.users_guide.tutorial.endian_aware_types.binary_streams">Binary
+ streams</a>
+ </h6>
+
+ Header <boost/binary_stream.hpp> provides operators <code class="computeroutput"><=</code> and <code class="computeroutput">=></code>
+ for unformatted binary (as opposed to formatted character) stream insertion
+ and extraction of built-in and std::string types.
+ 
+
+ Header <boost/integer/endian/endian_binary_stream.hpp> provides operators
+ <code class="computeroutput"><=</code> and <code class="computeroutput">=></code>
+ for unformatted binary (as opposed to formatted character) stream insertion
+ and extraction of endian types.
+ 
+<pre class="programlisting">#include <boost/integer/endian/endian_pack.hpp>
+#include <boost/integer/endian/endian_binary_stream.hpp>
+#include <boost/binary_stream.hpp>
+#include <iostream>
+
+using namespace boost;
+using namespace boost::integer;
+using namespace boost::integer::endianness;
+
+
+int main()
+{
+ int_least32_t n = 0x31323334L; // = ASCII { '1', '2', '3', '4' }
+ // value chosen to work on text stream
+
+ endian_pack<big, int_least32_t> b(n);
+ endian_pack<little, int_least32_t> l(n);
+
+ std::cout << n << ' ' << b << ' ' << l << '\n';
+ std::cout <= n <= ' ' <= b <= ' ' <= l <= '\n';
+ return 0;
+}
+</pre>
+
+ On a little-endian CPU, this program outputs:
+ 
+<pre class="programlisting">Hello, endian world!
+
+825373492 825373492 825373492
+4321 1234 4321
+</pre>
+<a name="toward_boost_integer_endian.users_guide.tutorial.endian_aware_types.endian_aware_unaligned_byte_holders"></a><h6>
+<a name="id2936359"></a>
+ <a class="link" href="users_guide.html#toward_boost_integer_endian.users_guide.tutorial.endian_aware_types.endian_aware_unaligned_byte_holders">endian
+ aware unaligned byte holders</a>
+ </h6>
+<pre class="programlisting">#include <boost/integer/endian/endian_pack.hpp>
+#include <iostream>
+
+using namespace boost;
+using namespace boost::integer;
+using namespace boost::integer::endianness;
+
+
+int main()
+{
+ int_least32_t v = 0x313233L; // = ASCII { '1', '2', '3' }
+ // value chosen to work on text stream
+
+ endian_pack<big, int_least32_t, 24, unaligned> b(v);
+ endian_pack<little, int_least32_t, 24, unaligned> l(v);
+
+ std::cout << v << ' ' << b << ' ' << l << '\n';
+ std::cout <= b <= ' ' <= l <= '\n';
+ return 0;
+}
+</pre>
+
+ On a little-endian CPU, this program outputs:
+ 
+<pre class="programlisting">3224115 3224115 3224115
+123 321
+</pre>
+<a name="toward_boost_integer_endian.users_guide.tutorial.endian_aware_types.endian_holders_common_typedefs"></a><h6>
+<a name="id2936918"></a>
+ <a class="link" href="users_guide.html#toward_boost_integer_endian.users_guide.tutorial.endian_aware_types.endian_holders_common_typedefs">endian
+ holders common typedefs</a>
+ </h6>
+
+ Sixty typedefs, such as big32_t, provide convenient naming conventions
+ for common use cases:
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Name
+ 
+ </th>
+<th>
+ 
+ Endianness
+ 
+ </th>
+<th>
+ 
+ Sign
+ 
+ </th>
+<th>
+ 
+ Sizes in bits (n)
+ 
+ </th>
+<th>
+ 
+ Alignment
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">big</code>n<code class="computeroutput">_t</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">big</code>
+ 
+ </td>
+<td>
+ 
+ signed
+ 
+ </td>
+<td>
+ 
+ 8,16,24,32,40,48,56,64
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">unaligned</code>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">ubig</code>n<code class="computeroutput">_t</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">big</code>
+ 
+ </td>
+<td>
+ 
+ unsigned
+ 
+ </td>
+<td>
+ 
+ 8,16,24,32,40,48,56,64
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">unaligned</code>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">little</code>n<code class="computeroutput">_t</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">little</code>
+ 
+ </td>
+<td>
+ 
+ signed
+ 
+ </td>
+<td>
+ 
+ 8,16,24,32,40,48,56,64
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">unaligned</code>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">ulittle</code>n<code class="computeroutput">_t</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">little</code>
+ 
+ </td>
+<td>
+ 
+ unsigned
+ 
+ </td>
+<td>
+ 
+ 8,16,24,32,40,48,56,64
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">unaligned</code>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">ulittle</code>n<code class="computeroutput">_t</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">native</code>
+ 
+ </td>
+<td>
+ 
+ signed
+ 
+ </td>
+<td>
+ 
+ 8,16,24,32,40,48,56,64
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">unaligned</code>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">unative</code>n<code class="computeroutput">_t</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">native</code>
+ 
+ </td>
+<td>
+ 
+ unsigned
+ 
+ </td>
+<td>
+ 
+ 16,32,64
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">aligned</code>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">aligned_big</code>n<code class="computeroutput">_t</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">big</code>
+ 
+ </td>
+<td>
+ 
+ signed
+ 
+ </td>
+<td>
+ 
+ 16,32,64
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">aligned</code>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">aligned_ubig</code>n<code class="computeroutput">_t</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">big</code>
+ 
+ </td>
+<td>
+ 
+ unsigned
+ 
+ </td>
+<td>
+ 
+ 16,32,64
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">aligned</code>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">aligned_little</code>n<code class="computeroutput">_t</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">big</code>
+ 
+ </td>
+<td>
+ 
+ signed
+ 
+ </td>
+<td>
+ 
+ 16,32,64
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">aligned</code>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">aligned_ulittle</code>n<code class="computeroutput">_t</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">big</code>
+ 
+ </td>
+<td>
+ 
+ unsigned
+ 
+ </td>
+<td>
+ 
+ 16,32,64
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">aligned</code>
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+
+ The unaligned types do not cause compilers to insert padding bytes in classes
+ and structs. This is an important characteristic that can be exploited
+ to minimize wasted space in memory, files, and network transmissions.
+ 
+<div class="warning"><table border="0" summary="Warning">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="../../../../../doc/src/images/warning.png"></td>
+<th align="left">Warning</th>
+</tr>
+<tr><td align="left" valign="top">
+ Code that uses aligned types is inherently non-portable because alignment
+ requirements vary between hardware architectures and because alignment
+ may be affected by compiler switches or pragmas. Furthermore, aligned
+ types are only available on architectures with 16, 32, and 64-bit integer
+ types.
+ </td></tr>
+</table></div>
+<div class="note"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td align="left" valign="top">
+ One-byte big-endian, little-endian, and native-endian types provide identical
+ functionality. All three names are provided to improve code readability
+ and searchability.
+ </td></tr>
+</table></div>
+
+ Comment on naming
+ 
+
+ When first exposed to endian types, programmers often fit them into a mental
+ model based on the <cstdint> types. Using that model, it is natural
+ to expect a 56-bit big-endian signed integer to be named <code class="computeroutput">int_big56_t</code>. But these byte-hodlers are
+ not realy integers.
+ 
+
+ That seems to lead to formation of a new mental model specific to endian
+ byte-holder types. In that model, the endianness is the key feature, and
+ the integer aspect is downplayed. Once that mental transition is made,
+ a name like <code class="computeroutput">big56_t</code> is
+ a good reflection of the mental model.
+ 
+<pre class="programlisting">#include <boost/integer/endian/endian_pack.hpp>
+#include <iostream>
+
+using namespace boost;
+using namespace boost::integer;
+
+
+int main()
+{
+ int_least32_t v = 0x31323334L; // = ASCII { '1', '2', '3', '4' }
+ // value chosen to work on text stream
+ big32_t b(v);
+ little32_t l(v);
+
+ std::cout << v << ' ' << b << ' ' << l << '\n';
+ return 0;
+}
+</pre>
+
+ On a little-endian CPU, this program outputs:
+ 
+<pre class="programlisting">825373492 825373492 825373492
+</pre>
+<a name="toward_boost_integer_endian.users_guide.tutorial.endian_aware_types.endian_holders_of_udt"></a><h6>
+<a name="id2938188"></a>
+ <a class="link" href="users_guide.html#toward_boost_integer_endian.users_guide.tutorial.endian_aware_types.endian_holders_of_udt">endian
+ holders of UDT</a>
+ </h6>
+
+ The user can define wrappers to integer types that behave as integers,
+ as it is the case for quantity<> class. This UDT can be packaged
+ on an endian holder to take care of endian issues, as show the following
+ example.
+ 
+<pre class="programlisting">#include <boost/integer/endian/endian_pack.hpp>
+#include <boost/integer/endian/endian_binary_stream.hpp>
+#include <boost/binary_stream.hpp>
+#include <iostream>
+#include <boost/units/io.hpp>
+#include <boost/units/quantity.hpp>
+#include <boost/units/systems/si/length.hpp>
+#include <boost/units/systems/si/plane_angle.hpp>
+
+using namespace boost;
+using namespace boost::integer;
+using namespace boost::integer::endianness;
+using namespace boost::units;
+
+int main()
+{
+ quantity<si::length, boost::int_least32_t> q = 825373492 * si::meter;
+ endian_pack<big, quantity<si::length, boost::int_least32_t> > b;
+ endian_pack<little, quantity<si::length, boost::int_least32_t> > l;
+ b=q;
+ l=q;
+ std::cout << q << ' ' << b << ' ' << l << '\n';
+ std::cout <= b <= ' ' <= l <= '\n';
+ return 0;
+}
+</pre>
+
+ On a little-endian CPU, this program outputs:
+ 
+<pre class="programlisting">825373492 m 825373492 m 825373492 m
+1234 4321
+</pre>
+<a name="toward_boost_integer_endian.users_guide.tutorial.endian_aware_types.arrays_of_endian_holders"></a><h6>
+<a name="id2939206"></a>
+ <a class="link" href="users_guide.html#toward_boost_integer_endian.users_guide.tutorial.endian_aware_types.arrays_of_endian_holders">Arrays
+ of endian holders</a>
+ </h6>
+
+ Up to now we have see how to work with endian aware byte holders variables.
+ In this section we will see how to work with arrays of endian aware byte
+ holders.
+ 
+<pre class="programlisting">#include <boost/integer/endian/endian_pack.hpp>
+#include <boost/integer/endian/endian_binary_stream.hpp>
+#include <boost/binary_stream.hpp>
+#include <iostream>
+
+using namespace boost;
+using namespace boost::integer;
+
+int main()
+{
+ int_least32_t an[100] = { 0x31323334L }; // = ASCII { '1', '2', '3', '4' }
+ // value chosen to work on text stream
+ big32_t ab[100];
+ little32_t al[100];
+
+ for_each
+
+ std::cout << an[3] << ' ' << ab[3] << ' ' << al[3] << '\n';
+ std::cout <= an[3] <= ' ' <= ab[3] <= ' ' <= al[3] <= '\n';
+ return 0;
+}
+</pre>
+<a name="toward_boost_integer_endian.users_guide.tutorial.endian_aware_types.structures_of_endian_holders"></a><h6>
+<a name="id2939824"></a>
+ <a class="link" href="users_guide.html#toward_boost_integer_endian.users_guide.tutorial.endian_aware_types.structures_of_endian_holders">Structures
+ of endian holders</a>
+ </h6>
+<pre class="programlisting">struct UdpHeader {
+ ubig16_pt source_port;
+ ubig16_pt destination_port;
+ ubig16_pt length;
+ ubig16_pt checksum;
+}; // UdpHeader
+
+UdpHeader header;
+header.source_port = 1111;
+header.destination_port = 1234;
+header.length = get_length(p);
+header.checksum = checksum_of(p);
+</pre>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="toward_boost_integer_endian.users_guide.tutorial.endian_aware_types.endian_aware_integers"></a><a class="link" href="users_guide.html#toward_boost_integer_endian.users_guide.tutorial.endian_aware_types.endian_aware_integers" title="Endian aware integers">Endian
+ aware integers</a>
+</h5></div></div></div>
+
+ Boost endian integers are based on the byte_holder endian_pack class
+ template and provide in addition the same full set of C++ assignment,
+ arithmetic, and relational operators as C++ standard integral types,
+ with the standard semantics.
+ 
+
+ One class template is provided:
+ 
+<pre class="programlisting">template <typename E, typename T, std::size_t n_bytes=8*sizeof(T),
+ alignment::enum_t A = alignment::aligned>
+class endian;
+</pre>
+
+ Unary arithmetic operators are <code class="computeroutput">+</code>,
+ <code class="computeroutput">-</code>, <code class="computeroutput">~</code>,
+ <code class="computeroutput">!</code>, prefix and postfix <code class="computeroutput">--</code> and <code class="computeroutput">++</code>.
+ Binary arithmetic operators are <code class="computeroutput">+</code>,
+ <code class="computeroutput">+=</code>, <code class="computeroutput">-</code>,
+ <code class="computeroutput">-=</code>, <code class="computeroutput">*</code>,
+ <code class="computeroutput">*=</code>, <code class="computeroutput">/</code>,
+ <code class="computeroutput">/=</code>, <code class="computeroutput">%</code>,
+ <code class="computeroutput">%=</code>, <code class="computeroutput">&</code>,
+ <code class="computeroutput">&=</code>, <code class="computeroutput">|</code>,
+ <code class="computeroutput">|=</code>, <code class="computeroutput">^</code>,
+ <code class="computeroutput">^=</code>, <code class="computeroutput"><<</code>,
+ <code class="computeroutput"><<=</code>, <code class="computeroutput">>></code>, <code class="computeroutput">>>=</code>.
+ Binary relational operators are <code class="computeroutput">==</code>,
+ <code class="computeroutput">!=</code>, <code class="computeroutput"><</code>,
+ <code class="computeroutput"><=</code>, <code class="computeroutput">></code>,
+ <code class="computeroutput">>=</code>.
+ 
+
+ Automatic conversion is provided to the underlying integer value type.
+ 
+<a name="toward_boost_integer_endian.users_guide.tutorial.endian_aware_types.endian_aware_integers.typedefs"></a><h6>
+<a name="id2940554"></a>
+ <a class="link" href="users_guide.html#toward_boost_integer_endian.users_guide.tutorial.endian_aware_types.endian_aware_integers.typedefs">Typedefs</a>
+ </h6>
+
+ Sixty typedefs, such as big32_t, provide convenient naming conventions
+ for common use cases:
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Name
+ 
+ </th>
+<th>
+ 
+ Endianness
+ 
+ </th>
+<th>
+ 
+ Sign
+ 
+ </th>
+<th>
+ 
+ Sizes in bits (n)
+ 
+ </th>
+<th>
+ 
+ Alignment
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">int_big</code>n<code class="computeroutput">_t</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">big</code>
+ 
+ </td>
+<td>
+ 
+ signed
+ 
+ </td>
+<td>
+ 
+ 8,16,24,32,40,48,56,64
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">unaligned</code>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">uint_big</code>n<code class="computeroutput">_t</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">big</code>
+ 
+ </td>
+<td>
+ 
+ unsigned
+ 
+ </td>
+<td>
+ 
+ 8,16,24,32,40,48,56,64
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">unaligned</code>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">int_little</code>n<code class="computeroutput">_t</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">little</code>
+ 
+ </td>
+<td>
+ 
+ signed
+ 
+ </td>
+<td>
+ 
+ 8,16,24,32,40,48,56,64
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">unaligned</code>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">uint_little</code>n<code class="computeroutput">_t</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">little</code>
+ 
+ </td>
+<td>
+ 
+ unsigned
+ 
+ </td>
+<td>
+ 
+ 8,16,24,32,40,48,56,64
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">unaligned</code>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">uint_little</code>n<code class="computeroutput">_t</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">native</code>
+ 
+ </td>
+<td>
+ 
+ signed
+ 
+ </td>
+<td>
+ 
+ 8,16,24,32,40,48,56,64
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">unaligned</code>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">uint_native</code>n<code class="computeroutput">_t</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">native</code>
+ 
+ </td>
+<td>
+ 
+ unsigned
+ 
+ </td>
+<td>
+ 
+ 16,32,64
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">aligned</code>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">aligned_int_big</code>n<code class="computeroutput">_t</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">big</code>
+ 
+ </td>
+<td>
+ 
+ signed
+ 
+ </td>
+<td>
+ 
+ 16,32,64
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">aligned</code>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">aligned_uint_big</code>n<code class="computeroutput">_t</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">big</code>
+ 
+ </td>
+<td>
+ 
+ unsigned
+ 
+ </td>
+<td>
+ 
+ 16,32,64
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">aligned</code>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">aligned_int_little</code>n<code class="computeroutput">_t</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">little</code>
+ 
+ </td>
+<td>
+ 
+ signed
+ 
+ </td>
+<td>
+ 
+ 16,32,64
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">aligned</code>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">aligned_uint_little</code>n<code class="computeroutput">_t</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">little</code>
+ 
+ </td>
+<td>
+ 
+ unsigned
+ 
+ </td>
+<td>
+ 
+ 16,32,64
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">aligned</code>
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="toward_boost_integer_endian.users_guide.tutorial.endian_aware_types.endian_aware_integers.comment_on_naming"></a><h6>
+<a name="id2941400"></a>
+ <a class="link" href="users_guide.html#toward_boost_integer_endian.users_guide.tutorial.endian_aware_types.endian_aware_integers.comment_on_naming">Comment
+ on naming</a>
+ </h6>
+
+ When first exposed to endian types, programmers often fit them into a
+ mental model based on the <cstdint> types. Using that model, it
+ is natural to expect a 56-bit big-endian signed integer to be named
+ <code class="computeroutput">int_big56_t</code>.
+ 
+
+ As experience using these types grows, the realization creeps in that
+ they are lousy arithmetic integers - they are really byte holders that
+ for convenience support arithmetic operations - and that for use in internal
+ interfaces or anything more than trivial arithmetic computations it is
+ far better to convert values of these endian types to traditional integer
+ types.
+ 
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_integer_endian.users_guide.tutorial.endian_unaware_types"></a><a class="link" href="users_guide.html#toward_boost_integer_endian.users_guide.tutorial.endian_unaware_types" title="Endian unaware types">Endian
+ unaware types</a>
+</h4></div></div></div>
+<a name="toward_boost_integer_endian.users_guide.tutorial.endian_unaware_types.working_with_third_party_structures"></a><h6>
+<a name="id2941477"></a>
+ <a class="link" href="users_guide.html#toward_boost_integer_endian.users_guide.tutorial.endian_unaware_types.working_with_third_party_structures">Working
+ with third party structures</a>
+ </h6>
+<a name="toward_boost_integer_endian.users_guide.tutorial.endian_unaware_types.domain_map"></a><h6>
+<a name="id2941500"></a>
+ <a class="link" href="users_guide.html#toward_boost_integer_endian.users_guide.tutorial.endian_unaware_types.domain_map">Domain
+ map</a>
+ </h6>
+<a name="toward_boost_integer_endian.users_guide.tutorial.endian_unaware_types.in_place_conversions"></a><h6>
+<a name="id2941522"></a>
+ <a class="link" href="users_guide.html#toward_boost_integer_endian.users_guide.tutorial.endian_unaware_types.in_place_conversions">In-place
+ conversions</a>
+ </h6>
+</div>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_integer_endian.users_guide.examples"></a><a class="link" href="users_guide.html#toward_boost_integer_endian.users_guide.examples" title="Examples">Examples</a>
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt><a href="users_guide.html#toward_boost_integer_endian.users_guide.examples.aware">Endian
+ Aware</a></dt>
+<dt><a href="users_guide.html#toward_boost_integer_endian.users_guide.examples.receiver_makes_right">"receiver
+ makes right"</a></dt>
+</dl></div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_integer_endian.users_guide.examples.aware"></a><a class="link" href="users_guide.html#toward_boost_integer_endian.users_guide.examples.aware" title="Endian Aware">Endian
+ Aware</a>
+</h4></div></div></div>
+
+ The endian_example.cpp program writes a binary file containing four byte
+ big-endian and little-endian integers.
+ 
+
+ This is an extract from a very widely used GIS file format. I have no idea
+ why a designer would mix big and little endians in the same file - but
+ this is a real-world format and users wishing to write low level code manipulating
+ these files have to deal with the mixed endianness.
+ 
+
+ Low-level I/O such as POSIX read/write or <cstdio> fread/fwrite is
+ sometimes used for binary file operations when ultimate efficiency is important.
+ Such I/O is often performed in some C++ wrapper class, but to drive home
+ the point that endian integers are often used in fairly low-level code
+ that does bulk I/O operations, <cstdio> fopen/fwrite is used for
+ I/O in this example.
+ 
+<pre class="programlisting">#include <iostream>
+#include <cassert>
+#include <cstdio>
+#include <boost/integer/endian.hpp>
+
+using namespace boost::integer;
+
+namespace
+{
+
+ struct header
+ {
+ big32_t file_code;
+ big32_t file_length;
+ little32_t version;
+ little32_t shape_type;
+ };
+
+ const char * filename = "test.dat";
+}
+
+int main()
+{
+ assert( sizeof( header ) == 16 ); // requirement for interoperability
+
+ header h;
+
+ h.file_code = 0x04030201;
+ h.file_length = sizeof( header );
+ h.version = -1;
+ h.shape_type = 0x04030201;
+
+ std::FILE * fi;
+
+ if ( !(fi = std::fopen( filename, "wb" )) ) // MUST BE BINARY
+ {
+ std::cout << "could not open " << filename << '\n';
+ return 1;
+ }
+
+ if ( std::fwrite( &h, sizeof( header ), 1, fi ) != 1 )
+ {
+ std::cout << "write failure for " << filename << '\n';
+ return 1;
+ }
+
+ std::fclose( fi );
+
+ std::cout << "created file " << filename << '\n';
+ return 0;
+}
+</pre>
+
+ After compiling and executing endian_example.cpp, a hex dump of test.dat
+ shows:
+ 
+<pre class="programlisting">0403 0201 0000 0010 ffff ffff 0102 0304
+</pre>
+</div>
+<div class="section"><div class="titlepage"><div><div><h4 class="title">
+<a name="toward_boost_integer_endian.users_guide.examples.receiver_makes_right"></a><a class="link" href="users_guide.html#toward_boost_integer_endian.users_guide.examples.receiver_makes_right" title='"receiver makes right"'>"receiver
+ makes right"</a>
+</h4></div></div></div></div>
+</div>
+<div class="section"><div class="titlepage"><div><div><h3 class="title">
+<a name="toward_boost_integer_endian.users_guide.ext_references"></a><a class="link" href="users_guide.html#toward_boost_integer_endian.users_guide.ext_references" title="References">References</a>
+</h3></div></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 © 2006 -2009 Beman Dawes Copyright © 2010 Vicente J. Botet Escriba
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="overview.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="reference.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/endian_ext/libs/integer/endian/doc/integer_endian.pdf
==============================================================================
Binary file. No diff available.

Modified: sandbox/endian_ext/libs/integer/endian/doc/integer_endian.qbk
==============================================================================
--- sandbox/endian_ext/libs/integer/endian/doc/integer_endian.qbk (original)
+++ sandbox/endian_ext/libs/integer/endian/doc/integer_endian.qbk 2011-02-13 14:58:05 EST (Sun, 13 Feb 2011)
@@ -8,11 +8,12 @@

[article Toward Boost.Integer.Endian
 [quickbook 1.4]
+ [version 0.2.0]
 [authors [Dawes, Beman]]
 [authors [Botet Escriba, Vicente J.]]
 [copyright 2006-2009 Beman Dawes]
 [copyright 2010 Vicente J. Botet Escriba]
- [purpose Endian Integers]
+
 [license
 Distributed under the Boost Software License, Version 1.0.
 (See accompanying file LICENSE_1_0.txt or copy at
@@ -20,6 +21,8 @@
 ]
]

+[def __Boost_Endian [*Boost.Integer.Endian.Ext]]
+
[/
[section Preface]

@@ -29,37 +32,13 @@
[endsect]
/]

-[warning Integer.Endian is not a part of the Boost libraries.]
+[warning __Boost_Endian is not a part of the Boost libraries.]

[/========================]
[section Overview]
[/========================]

-[/==================]
-[heading Description]
-[/==================]
-
-This is an extension of the Beman's Boost.Integer.Endian, which was able to work with endian aware types, used to convert between types with different endian or even to carry on with arithmetic operations, by spliting the endian part from integer part and by adding support for aligned endian unaware types.
-
-[*Boost.Integer.Endian.Ext] provides:
-
-* Endian packs
- * Big endian | little endian | native endian byte ordering.
- * Signed | unsigned
- * Unaligned | aligned
- * 1-8 byte (unaligned) | 2, 4, 8 byte (aligned)
- * Choice of integer value type
-
-* Endian integers with the whole set of arithmetics operators.
-
-* Operators <= and => for unformatted binary (as opposed to formatted character) stream insertion and extraction of built-in, std::string types and of endian types.
-
-* Views of aligned endian unaware integer types as endian packs or endian integers so we can make endian conversion.
-
-* Generic in place conversion between different endian formats.
- * Very simple interface: convert_to/from<endiannes domain>(),
- * Support for built-in and user-defined data types view as fusion sequences.

[/====================================]
@@ -70,12 +49,13 @@

* Code is in `fixed width font` and is syntax-highlighted.
* Replaceable text that you will need to supply is in [~italics].
-* If a name refers to a free function, it is specified like this:
- `free_function()`; that is, it is in code font and its name is followed by `()` to indicate that it is a free function.
+* Free functions are rendered in the code font followed by (), as in `free_function()`.
* If a name refers to a class template, it is specified like this: `class_template<>`; that is, it is in code font and its name is followed by `<>` to indicate that it is a class template.
* If a name refers to a function-like macro, it is specified like this: `MACRO()`;
 that is, it is uppercase in code font and its name is followed by `()` to indicate that it is a function-like macro. Object-like macros appear without the trailing `()`.
-* Names that refer to /concepts/ in the generic programming sense are specified in CamelCase.
+* Names that refer to /concepts/ in the generic programming sense are specified in CamelCase.
+
+[note In addition, notes such as this one specify non-essential information that provides additional background or rationale.]

[note In addition, notes such as this one specify non-essential information that provides additional background or rationale.]

@@ -83,6 +63,7 @@

 // Include all of endian files
 #include <boost/integer/endian.hpp>
+ using namespace boost::integer;

[/=================]
[section Motivation]
@@ -96,7 +77,7 @@
* 1-8 byte (unaligned) | 2, 4, 8 byte (aligned)
* Choice of integer value type

-This endain aware design seems to be unappropiated to work with endian unaware types, but as we will see this is not completly true, as we can construct on top of the Beman's design endian unaware operation. Next follows some of the main critics that have been done recently.
+This endian aware design seems to be unappropiated to work with endian unaware types, but as we will see this is not completly true, as we can construct on top of the Beman's design endian unaware operation. Next follows some of the main critics that have been done recently.

[heading Intrusive verus non-intrusive]
[/====================================]
@@ -234,6 +215,34 @@
Conversions between native and big/little endian formats must be simple.

[endsect]
+
+
+[/==================]
+[section Description]
+[/==================]
+
+This is an extension of the Beman's Boost.Integer.Endian, which was able to work with endian aware types, used to convert between types with different endian or even to carry on with arithmetic operations, by spliting the endian part from integer part and by adding support for aligned endian unaware types.
+
+__Boost_Endian provides:
+
+* Endian packs
+ * Big endian | little endian | native endian byte ordering.
+ * Signed | unsigned
+ * Unaligned | aligned
+ * 1-8 byte (unaligned) | 2, 4, 8 byte (aligned)
+ * Choice of integer value type
+
+* Endian integers with the whole set of arithmetics operators.
+
+* Operators <= and => for unformatted binary (as opposed to formatted character) stream insertion and extraction of built-in, std::string types and of endian types.
+
+* Views of aligned endian unaware integer types as endian packs or endian integers so we can make endian conversion.
+
+* Generic in place conversion between different endian formats.
+ * Very simple interface: convert_to/from<endiannes domain>(),
+ * Support for built-in and user-defined data types view as fusion sequences.
+
+[endsect]
[endsect]

[/==============================]
@@ -245,22 +254,22 @@
[/======================================]

[/======================================]
-[section:install Installing Integer.Endian]
+[section:install Installing __Boost_Endian]
[/======================================]

[/=================================]
-[heading Getting Boost.Integer.Endian]
+[heading Getting __Boost_Endian]
[/=================================]

-You can get the last stable release of Boost.Integer.Endian by downloading [^integer_endian.zip] from the
+You can get the last stable release of __Boost_Endian by downloading [^integer_endian.zip] from the
[@http://www.boost-consulting.com/vault/index.php?directory=Portability%20Programming Boost Vault]

-You can also access the latest (unstable?) state from the [@https://svn.boost.org/svn/boost/sandbox/endian_split Boost Sandbox].
+You can also access the latest (unstable?) state from the [@https://svn.boost.org/svn/boost/sandbox/endian_ext Boost Sandbox].

-[heading Building Boost.Integer.Endian]
+[heading Building __Boost_Endian]
[/====================================]

-Boost.Integer.Endian is implemented entirely within headers, with no need to link to any Boost object libraries.
+__Boost_Endian is implemented entirely within headers, with no need to link to any Boost object libraries.

Several macros allow user control over features:

@@ -274,8 +283,15 @@
[heading Requirements]
[/=========================]

-[*Boost.Integer.Endian] depends on some Boost library. The library has been tested with version 1.43.0 but an older version should works also.
+__Boost_Endian depends on some Boost library. The library has been tested on trunk but an older version should works also.

+In particular, __Boost_Endian depends on:
+
+[variablelist
+[
+ [[@http://www.boost.org/libs/config [*Boost.Config]]] [for configuration purposes, ...]
+]
+]

[/========================]
[heading Exceptions safety]
@@ -293,25 +309,48 @@
[heading Tested compilers]
[/=======================]

-Currently, [*Boost.Integer.Endian] has been tested in the following compilers/platforms:
+The implementation will eventually work with most C++03 conforming compilers.
+Current version has been tested on:
+
+[/Windows with
+
+* MSVC 10.0
+
+Cygwin 1.5 with
+
+* GCC 3.4.4
+]
+Cygwin 1.7 with
+
+* GCC 4.3.4
+
+MinGW with
+
+* GCC 4.4.0
+* GCC 4.5.0
+* GCC 4.5.0 -std=c++0x
+[/* GCC 4.6.0
+* GCC 4.6.0 -std=c++0x]
+
+Ubuntu 10.10
+
+* GCC 4.4.5
+* GCC 4.4.5 -std=c++0x

-* GCC 3.4.4 Cygwin
-* GCC 4.4.0 MinGw
-* MSV9 9 EXpress Windows

-[/* GCC 4.3.2 Cygwin]
-[/* GCC 4.1.2 Linux]
+[note Please let us know how this works on other platforms/compilers.]

[note Please send any questions, comments and bug reports to boost <at> lists <dot> boost <dot> org.]

+
[endsect]
[/=============================]
[section Hello Endian World! ]
[/=============================]

- #include <boost/integer/endian.hpp>
- #include <boost/integer/endian_binary_stream.hpp>
+ #include <boost/integer/endian/endian.hpp>
+ #include <boost/integer/endian/endian_binary_stream.hpp>
 #include <boost/binary_stream.hpp>
 #include <iostream>

@@ -374,7 +413,7 @@

[heading basic endian holders]

-Boost.Integer.Endian provides an endian aware byte-holder class template:
+__Boost_Endian provides an endian aware byte-holder class template:

 template <endianness::enum_t E, typename T, std::size_t n_bytes=8*sizeof(T),
 alignment::enum_t A = alignment::aligned>
@@ -386,12 +425,12 @@

This class doesn't provides arithmetic operators, but of course automatic conversion to and assignment from the underlying integer value type are provided.

- #include <boost/integer/endian_pack.hpp>
+ #include <boost/integer/endian/endian_pack.hpp>
 #include <iostream>

 using namespace boost;
 using namespace boost::integer;
- using namespace boost::endianness;
+ using namespace boost::integer::endianness;

 int main()
@@ -414,16 +453,16 @@

Header <boost/binary_stream.hpp> provides operators `<=` and `=>` for unformatted binary (as opposed to formatted character) stream insertion and extraction of built-in and std::string types.

-Header <boost/integer/endian_binary_stream.hpp> provides operators `<=` and `=>` for unformatted binary (as opposed to formatted character) stream insertion and extraction of endian types.
+Header <boost/integer/endian/endian_binary_stream.hpp> provides operators `<=` and `=>` for unformatted binary (as opposed to formatted character) stream insertion and extraction of endian types.

- #include <boost/integer/endian_pack.hpp>
- #include <boost/integer/endian_binary_stream.hpp>
+ #include <boost/integer/endian/endian_pack.hpp>
+ #include <boost/integer/endian/endian_binary_stream.hpp>
 #include <boost/binary_stream.hpp>
 #include <iostream>

 using namespace boost;
 using namespace boost::integer;
- using namespace boost::endianness;
+ using namespace boost::integer::endianness;

 int main()
@@ -450,12 +489,12 @@
[heading endian aware unaligned byte holders]

- #include <boost/integer/endian_pack.hpp>
+ #include <boost/integer/endian/endian_pack.hpp>
 #include <iostream>

 using namespace boost;
 using namespace boost::integer;
- using namespace boost::endianness;
+ using namespace boost::integer::endianness;

 int main()
@@ -512,7 +551,7 @@

- #include <boost/integer/endian_pack.hpp>
+ #include <boost/integer/endian/endian_pack.hpp>
 #include <iostream>

 using namespace boost;
@@ -540,8 +579,8 @@
The user can define wrappers to integer types that behave as integers, as it is the case for
quantity<> class. This UDT can be packaged on an endian holder to take care of endian issues, as show the following example.

- #include <boost/integer/endian_pack.hpp>
- #include <boost/integer/endian_binary_stream.hpp>
+ #include <boost/integer/endian/endian_pack.hpp>
+ #include <boost/integer/endian/endian_binary_stream.hpp>
 #include <boost/binary_stream.hpp>
 #include <iostream>
 #include <boost/units/io.hpp>
@@ -551,7 +590,7 @@

 using namespace boost;
 using namespace boost::integer;
- using namespace boost::endianness;
+ using namespace boost::integer::endianness;
 using namespace boost::units;

 int main()
@@ -575,8 +614,8 @@

Up to now we have see how to work with endian aware byte holders variables. In this section we will see how to work with arrays of endian aware byte holders.

- #include <boost/integer/endian_pack.hpp>
- #include <boost/integer/endian_binary_stream.hpp>
+ #include <boost/integer/endian/endian_pack.hpp>
+ #include <boost/integer/endian/endian_binary_stream.hpp>
 #include <boost/binary_stream.hpp>
 #include <iostream>

@@ -615,14 +654,14 @@

[/===========================]
-[section Endian unaware integers]
+[section Endian aware integers]
[/===========================]

Boost endian integers are based on the byte_holder endian_pack class template and provide in addition the same full set of C++ assignment, arithmetic, and relational operators as C++ standard integral types, with the standard semantics.

One class template is provided:

- template <endianness::enum_t E, typename T, std::size_t n_bytes=8*sizeof(T),
+ template <typename E, typename T, std::size_t n_bytes=8*sizeof(T),
 alignment::enum_t A = alignment::aligned>
 class endian;

@@ -678,6 +717,91 @@

[endsect]

+[section Examples]
+
+[section:aware Endian Aware]
+
+The endian_example.cpp program writes a binary file containing four byte big-endian and little-endian integers.
+
+This is an extract from a very widely used GIS file format. I have no idea
+why a designer would mix big and little endians in the same file - but
+this is a real-world format and users wishing to write low level code
+manipulating these files have to deal with the mixed endianness.
+
+Low-level I/O such as POSIX read/write or <cstdio> fread/fwrite is sometimes
+used for binary file operations when ultimate efficiency is important.
+Such I/O is often performed in some C++ wrapper class, but to drive home the
+point that endian integers are often used in fairly low-level code that
+does bulk I/O operations, <cstdio> fopen/fwrite is used for I/O in this example.
+
+
+ #include <iostream>
+ #include <cassert>
+ #include <cstdio>
+ #include <boost/integer/endian.hpp>
+
+ using namespace boost::integer;
+
+ namespace
+ {
+
+ struct header
+ {
+ big32_t file_code;
+ big32_t file_length;
+ little32_t version;
+ little32_t shape_type;
+ };
+
+ const char * filename = "test.dat";
+ }
+
+ int main()
+ {
+ assert( sizeof( header ) == 16 ); // requirement for interoperability
+
+ header h;
+
+ h.file_code = 0x04030201;
+ h.file_length = sizeof( header );
+ h.version = -1;
+ h.shape_type = 0x04030201;
+
+ std::FILE * fi;
+
+ if ( !(fi = std::fopen( filename, "wb" )) ) // MUST BE BINARY
+ {
+ std::cout << "could not open " << filename << '\n';
+ return 1;
+ }
+
+ if ( std::fwrite( &h, sizeof( header ), 1, fi ) != 1 )
+ {
+ std::cout << "write failure for " << filename << '\n';
+ return 1;
+ }
+
+ std::fclose( fi );
+
+ std::cout << "created file " << filename << '\n';
+ return 0;
+ }
+
+After compiling and executing endian_example.cpp, a hex dump of test.dat shows:
+
+ 0403 0201 0000 0010 ffff ffff 0102 0304
+
+
+
+[endsect]
+
+[/=============================]
+[section:receiver_makes_right "receiver makes right"]
+[/=============================]
+
+[endsect]
+[endsect]
+

[/================================]
[section:ext_references References]
@@ -705,6 +829,98 @@
[/================]

[/==========================================================================================]
+[section:binary_stream_hpp Header `<boost/binary_stream.hpp>`]
+[/==========================================================================================]
+
+Header <boost/binary_stream.hpp> provides operators `<=` and `=>` for unformatted binary (as opposed to formatted character) stream insertion and extraction of built-in and std::string types.
+
+[heading Synopsis]
+
+ namespace boost
+ {
+
+ // built-in types ------------------------------------------------------------------//
+
+ std::ostream& operator<=(std::ostream& os, short v);
+ std::istream& operator>=(std::istream& is, short& v);
+
+ std::ostream& operator<=(std::ostream& os, unsigned short v);
+ std::istream& operator>=(std::istream& is, unsigned short& v);
+
+ std::ostream& operator<=(std::ostream& os, int v);
+ std::istream& operator>=(std::istream& is, int& v);
+
+ std::ostream& operator<=(std::ostream& os, unsigned int v);
+ std::istream& operator>=(std::istream& is, unsigned int& v);
+
+ std::ostream& operator<=(std::ostream& os, long v);
+ std::istream& operator>=(std::istream& is, long& v);
+
+ std::ostream& operator<=(std::ostream& os, unsigned long v);
+ std::istream& operator>=(std::istream& is, unsigned long& v);
+
+ std::ostream& operator<=(std::ostream& os, long long v);
+ std::istream& operator>=(std::istream& is, long long& v);
+
+ std::ostream& operator<=(std::ostream& os, unsigned long long v);
+ std::istream& operator>=(std::istream& is, unsigned long long& v);
+
+ std::ostream& operator<=(std::ostream& os, float v);
+ std::istream& operator>=(std::istream& is, float& v);
+
+ std::ostream& operator<=(std::ostream& os, double v);
+ std::istream& operator>=(std::istream& is, double& v);
+
+ std::ostream& operator<=(std::ostream& os, long double v);
+ std::istream& operator>=(std::istream& is, long double& v);
+
+ std::ostream& operator<=(std::ostream& os, char c);
+ std::istream& operator>=(std::istream& is, char& c);
+
+ std::ostream& operator<=(std::ostream& os, signed char c);
+ std::istream& operator>=(std::istream& is, signed char& c);
+
+ std::ostream& operator<=(std::ostream& os, unsigned char c);
+ std::istream& operator>=(std::istream& is, unsigned char& c);
+
+ std::ostream& operator<=(std::ostream& os, wchar_t v);
+ std::istream& operator>=(std::istream& is, wchar_t& v);
+
+ // strings -------------------------------------------------------------------------//
+
+ std::ostream& operator<=(std::ostream& os, const char* p);
+
+ std::ostream& operator<=(std::ostream& os, const signed char* p);
+
+ std::ostream& operator<=(std::ostream& os, const unsigned char* p);
+
+ #ifndef BOOST_NO_CWCHAR
+ std::ostream& operator<=(std::ostream& os, const wchar_t* p);
+ #endif
+
+ std::ostream& operator<=(std::ostream& os, const std::string& s);
+ std::istream& operator>=(std::istream& is, std::string& s);
+
+ #ifndef BOOST_NO_STD_WSTRING
+ std::ostream& operator<=(std::ostream& os, const std::wstring& s);
+ std::istream& operator>=(std::istream& is, std::wstring& s);
+ #endif
+
+ } // namespace boost
+
+[note Omission of bool and void* is deliberate; any semantics would be questionable]
+
+[warning
+Note the asymmetry between output and input; a string with embedded
+nulls will be output with the embedded nulls, but input will stop at the first null.
+So it probably isn't a good idea to use these functions for strings with nulls.
+]
+
+[endsect]
+
+
+[/
+[/==========================================================================================]
[section:alignment_hpp Header `<boost/alignment.hpp>`]
[/==========================================================================================]

@@ -727,12 +943,12 @@
[endsect]

[endsect]
-
+]
[/==========================================================================================]
-[section:integer_endianness_hpp Header `<boost/integer/endiannes.hpp>`]
+[section:integer_endianness_hpp Header `<boost/integer/endian/endiannes.hpp>`]
[/==========================================================================================]

-Header <boost/endian/endianness.hpp> provides the endianness tags.
+Header <boost/endian/endian/endianness.hpp> provides the endianness tags.

[heading Synopsis]

@@ -813,10 +1029,10 @@
[endsect]

[/==========================================================================================]
-[section:endian_domain_map_hpp Header `<boost/endian/domain_map.hpp>`]
+[section:endian_domain_map_hpp Header `<boost/integer/endian/domain_map.hpp>`]
[/==========================================================================================]

-This file contains the default implementation ofr the `domaain_map` metafunction.
+This file contains the default implementation ofr the `domain_map` metafunction.

[heading Synopsis]

@@ -857,102 +1073,12 @@

[endsect]

-[/==========================================================================================]
-[section:binary_stream_hpp Header `<boost/binary_stream.hpp>`]
-[/==========================================================================================]
-
-Header <boost/binary_stream.hpp> provides operators `<=` and `=>` for unformatted binary (as opposed to formatted character) stream insertion and extraction of built-in and std::string types.
-
-[heading Synopsis]
-
- namespace boost
- {
-
- // built-in types ------------------------------------------------------------------//
-
- std::ostream& operator<=(std::ostream& os, short v);
- std::istream& operator>=(std::istream& is, short& v);
-
- std::ostream& operator<=(std::ostream& os, unsigned short v);
- std::istream& operator>=(std::istream& is, unsigned short& v);
-
- std::ostream& operator<=(std::ostream& os, int v);
- std::istream& operator>=(std::istream& is, int& v);
-
- std::ostream& operator<=(std::ostream& os, unsigned int v);
- std::istream& operator>=(std::istream& is, unsigned int& v);
-
- std::ostream& operator<=(std::ostream& os, long v);
- std::istream& operator>=(std::istream& is, long& v);
-
- std::ostream& operator<=(std::ostream& os, unsigned long v);
- std::istream& operator>=(std::istream& is, unsigned long& v);
-
- std::ostream& operator<=(std::ostream& os, long long v);
- std::istream& operator>=(std::istream& is, long long& v);
-
- std::ostream& operator<=(std::ostream& os, unsigned long long v);
- std::istream& operator>=(std::istream& is, unsigned long long& v);
-
- std::ostream& operator<=(std::ostream& os, float v);
- std::istream& operator>=(std::istream& is, float& v);
-
- std::ostream& operator<=(std::ostream& os, double v);
- std::istream& operator>=(std::istream& is, double& v);
-
- std::ostream& operator<=(std::ostream& os, long double v);
- std::istream& operator>=(std::istream& is, long double& v);
-
- std::ostream& operator<=(std::ostream& os, char c);
- std::istream& operator>=(std::istream& is, char& c);
-
- std::ostream& operator<=(std::ostream& os, signed char c);
- std::istream& operator>=(std::istream& is, signed char& c);
-
- std::ostream& operator<=(std::ostream& os, unsigned char c);
- std::istream& operator>=(std::istream& is, unsigned char& c);
-
- std::ostream& operator<=(std::ostream& os, wchar_t v);
- std::istream& operator>=(std::istream& is, wchar_t& v);
-
- // strings -------------------------------------------------------------------------//
-
- std::ostream& operator<=(std::ostream& os, const char* p);
-
- std::ostream& operator<=(std::ostream& os, const signed char* p);
-
- std::ostream& operator<=(std::ostream& os, const unsigned char* p);
-
- #ifndef BOOST_NO_CWCHAR
- std::ostream& operator<=(std::ostream& os, const wchar_t* p);
- #endif
-
- std::ostream& operator<=(std::ostream& os, const std::string& s);
- std::istream& operator>=(std::istream& is, std::string& s);
-
- #ifndef BOOST_NO_STD_WSTRING
- std::ostream& operator<=(std::ostream& os, const std::wstring& s);
- std::istream& operator>=(std::istream& is, std::wstring& s);
- #endif
-
- } // namespace boost
-
-[note Omission of bool and void* is deliberate; any semantics would be questionable]
-
-[warning
-Note the asymmetry between output and input; a string with embedded
-nulls will be output with the embedded nulls, but input will stop at the first null.
-So it probably isn't a good idea to use these functions for strings with nulls.
-]
-
-[endsect]
-

[/==========================================================================================]
-[section:integer_endian_pack_hpp Header `<boost/integer/endian_pack.hpp>`]
+[section:integer_endian_pack_hpp Header `<boost/integer/endian/endian_pack.hpp>`]
[/==========================================================================================]

-This file contains the core class template of Boost.Integer.Endian. Provides byte-holder binary types with explicit control over byte order, value type, size, and alignment. Typedefs provide easy-to-use names for common configurations.
+This file contains the core class template of __Boost_Endian. Provides byte-holder binary types with explicit control over byte order, value type, size, and alignment. Typedefs provide easy-to-use names for common configurations.

[heading Synopsis]

@@ -1067,7 +1193,7 @@
[section:endian_pack Template class `endian_pack<>`]
[/==========================================================================================]

-An `endian_pack` is an byte-holder with user-specified endianness, value type, size, and alignment.
+An `endian_pack` is a byte-holder with user-specified endianness, value type, size, and alignment.

 template <
 typename E,
@@ -1162,10 +1288,10 @@

[endsect]
[/==========================================================================================]
-[section:integer_endian_hpp Header `<boost/integer/endian.hpp>`]
+[section:integer_endian_hpp Header `<boost/integer/endian/endian.hpp>`]
[/==========================================================================================]

-Header `<boost/integer/endian.hpp>` provides integer-like byte-holder binary types with explicit control over byte order, value type, size, and alignment. Typedefs provide easy-to-use names for common configurations.
+Header `<boost/integer/endian/endian.hpp>` provides integer-like byte-holder binary types with explicit control over byte order, value type, size, and alignment. Typedefs provide easy-to-use names for common configurations.

[heading Synopsis]
@@ -1375,10 +1501,10 @@
[endsect]

[/==========================================================================================]
-[section:integer_endian_binary_stream_hpp Header `<boost/integer/endian_binary_stream.hpp>`]
+[section:integer_endian_binary_stream_hpp Header `<boost/integer/endian/endian_binary_stream.hpp>`]
[/==========================================================================================]

-Header <boost/integer/endian_binary_stream.hpp> provides operators `<=` and `=>` for unformatted binary (as opposed to formatted character) stream insertion and extraction of endian types.
+Header <boost/integer/endian/endian_binary_stream.hpp> provides operators `<=` and `=>` for unformatted binary (as opposed to formatted character) stream insertion and extraction of endian types.

[heading Synopsis]

@@ -1406,7 +1532,7 @@
[endsect]

[/==========================================================================================]
-[section:integer_endian_type_hpp Header `<boost/integer/endian_type.hpp>`]
+[section:integer_endian_type_hpp Header `<boost/integer/endian/endian_type.hpp>`]
[/==========================================================================================]

[heading Synopsis]
@@ -1444,7 +1570,7 @@

[endsect]
[/==========================================================================================]
-[section:integer_endian_view_hpp Header `<boost/integer/endian_view.hpp>`]
+[section:integer_endian_view_hpp Header `<boost/integer/endian/endian_view.hpp>`]
[/==========================================================================================]

This file provides the `endian_view<>` class template as well as some factory helper functions.
@@ -1586,7 +1712,7 @@
[endsect]

[/==========================================================================================]
-[section:integer_endian_conversion_hpp Header `<boost/integer/endian_conversion.hpp>`]
+[section:integer_endian_conversion_hpp Header `<boost/integer/endian/endian_conversion.hpp>`]
[/==========================================================================================]

[heading Synopsis]
@@ -1701,97 +1827,21 @@
[endsect]

[endsect]
-[section Examples]
-
-[section: Endian Aware]

-The endian_example.cpp program writes a binary file containing four byte big-endian and little-endian integers.
-
-This is an extract from a very widely used GIS file format. I have no idea
-why a designer would mix big and little endians in the same file - but
-this is a real-world format and users wishing to write low level code
-manipulating these files have to deal with the mixed endianness.

-Low-level I/O such as POSIX read/write or <cstdio> fread/fwrite is sometimes
-used for binary file operations when ultimate efficiency is important.
-Such I/O is often performed in some C++ wrapper class, but to drive home the
-point that endian integers are often used in fairly low-level code that
-does bulk I/O operations, <cstdio> fopen/fwrite is used for I/O in this example.
-
-
- #include <iostream>
- #include <cassert>
- #include <cstdio>
- #include <boost/integer/endian.hpp>
-
- using namespace boost::integer;
-
- namespace
- {
-
- struct header
- {
- big32_t file_code;
- big32_t file_length;
- little32_t version;
- little32_t shape_type;
- };
-
- const char * filename = "test.dat";
- }
-
- int main()
- {
- assert( sizeof( header ) == 16 ); // requirement for interoperability
-
- header h;
-
- h.file_code = 0x04030201;
- h.file_length = sizeof( header );
- h.version = -1;
- h.shape_type = 0x04030201;
-
- std::FILE * fi;
-
- if ( !(fi = std::fopen( filename, "wb" )) ) // MUST BE BINARY
- {
- std::cout << "could not open " << filename << '\n';
- return 1;
- }
-
- if ( std::fwrite( &h, sizeof( header ), 1, fi ) != 1 )
- {
- std::cout << "write failure for " << filename << '\n';
- return 1;
- }
-
- std::fclose( fi );
-
- std::cout << "created file " << filename << '\n';
- return 0;
- }
-
-After compiling and executing endian_example.cpp, a hex dump of test.dat shows:
-
- 0403 0201 0000 0010 ffff ffff 0102 0304
-
-
-
-[endsect]
+[/=================]
+[section Appendices]
+[/=================]
+[section:history Appendix A: History]
+[section [*Version 0.2.0, Febraury 15, 2011] ]

-[/=============================]
-[section:receiver_makes_right "receiver makes right"]
-[/=============================]
+Move to boost/integer/endian directory.

[endsect]
-[endsect]

+[section [*Version 0.1.0, June 15, 2010]]

-[/=================]
-[section Appendices]
-[/=================]
-[section:history Appendix A: History]
-[section [*Version 0.1.0, June 15, 2010] ['Split of Boost.Integer.Endian + Added Endian views]]
+Split of Boost.Integer.Endian + Added Endian views.

[*Features:]

@@ -1817,7 +1867,7 @@

[section:rationale Appendix B: Rationale]

-[heading Design considerations for Boost.Integer.Endian]
+[heading Design considerations for __Boost_Endian]

* Must be suitable for I/O - in other words, must be memcpyable.
* Must provide exactly the size and internal byte ordering specified.
@@ -1833,7 +1883,7 @@

[heading Motivating use cases]

-Neil Mayhew writes: "I can also provide a meaningful use-case for this library: reading TrueType font files from disk and processing the contents. The data format has fixed endianness (big) and has unaligned values in various places. Using Boost.Integer.Endian simplifies and cleans the code wonderfully."
+Neil Mayhew writes: "I can also provide a meaningful use-case for this library: reading TrueType font files from disk and processing the contents. The data format has fixed endianness (big) and has unaligned values in various places. Using __Boost_Endian simplifies and cleans the code wonderfully."

[heading C++0x]

@@ -1858,7 +1908,7 @@

* *Are endian types POD's?* Yes for C++0x. No for C++03, although several macros are available to force PODness in all cases.

-* *What are the implications endian types not being POD's with C++03 compilers?* They can't be used in unions. Also, compilers aren't required to align or lay out storage in portable ways, although this potential problem hasn't prevented use of Boost.Integer.Endian with real compilers.
+* *What are the implications endian types not being POD's with C++03 compilers?* They can't be used in unions. Also, compilers aren't required to align or lay out storage in portable ways, although this potential problem hasn't prevented use of __Boost_Endian with real compilers.

* *Which is better, big-endian or little-endian?* Big-endian tends to be a bit more of an industry standard, but little-endian may be preferred for applications that run primarily on x86 (Intel/AMD) and other little-endian CPU's. The [@http://en.wikipedia.org/wiki/Endian Wikipedia] article gives more pros and cons.

Date view	Thread view	Subject view	Author view

Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk