Boost-Commit mailing page: [Boost-commit] svn:boost r64958 - in sandbox/SOC/2010/bit_masks/lib/integer/doc/html: . Rationale Rationale/bit_masks Rationale/bit_masks/overview bit_width bit_width/bit_masks bitfield_tuple bits_mask bits_mask/bit_masks boost_integer_bits_masks_extension boost_integer_bits_masks_extension/bit_masks boost_integer_bits_masks_extension/bit_masks/overview boost_integer_bits_masks_extension/bitfield_tuple boost_integer_bits_masks_extension/bitfield_tuple/appendices boost_integer_bits_masks_extension/bitfield_tuple/appendices/implementation_details boost_integer_bits_masks_extension/bitfield_tuple/appendices/implementation_details/internal_documentation boost_integer_bits_masks_extension/bitfield_tuple/overview boost_integer_bits_masks_extension/bitfield_tuple/reference boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_class_reference boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_macro_reference boost_integer_bits_masks_extension/bitfield_tuple/reference/function_reference boost_integer_bits_masks_extension/bitfield_tuple/reference/meta_function_reference boost_integer_bits_masks_extension/bitfield_tuple/users_guide boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started high_bits_mask high_bits_mask/bit_masks integral_mask integral_mask/bit_masks low_bits_mask low_bits_mask/bit

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r64958 - in sandbox/SOC/2010/bit_masks/lib/integer/doc/html: . Rationale Rationale/bit_masks Rationale/bit_masks/overview bit_width bit_width/bit_masks bitfield_tuple bits_mask bits_mask/bit_masks boost_integer_bits_masks_extension boost_integer_bits_masks_extension/bit_masks boost_integer_bits_masks_extension/bit_masks/overview boost_integer_bits_masks_extension/bitfield_tuple boost_integer_bits_masks_extension/bitfield_tuple/appendices boost_integer_bits_masks_extension/bitfield_tuple/appendices/implementation_details boost_integer_bits_masks_extension/bitfield_tuple/appendices/implementation_details/internal_documentation boost_integer_bits_masks_extension/bitfield_tuple/overview boost_integer_bits_masks_extension/bitfield_tuple/reference boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_class_reference boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_macro_reference boost_integer_bits_masks_extension/bitfield_tuple/reference/function_reference boost_integer_bits_masks_extension/bitfield_tuple/reference/meta_function_reference boost_integer_bits_masks_extension/bitfield_tuple/users_guide boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started high_bits_mask high_bits_mask/bit_masks integral_mask integral_mask/bit_masks low_bits_mask low_bits_mask/bit_masks
From: bbartmanboost_at_[hidden]
Date: 2010-08-22 11:27:18

Author: bbartman
Date: 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
New Revision: 64958
URL: http://svn.boost.org/trac/boost/changeset/64958

Log:
now adding documentation again
Added:
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/Rationale/
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/Rationale/bit_masks/
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/Rationale/bit_masks/overview/
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/Rationale/bit_masks/overview/rationale.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/bit_width/
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/bit_width/bit_masks/
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/bit_width/bit_masks/bit_width.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/bitfield_tuple/
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/bitfield_tuple/bitfield_tuple.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/bits_mask/
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/bits_mask/bit_masks/
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/bits_mask/bit_masks/bits_mask.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/HeaderSummary.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bit_masks/
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bit_masks.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bit_masks/overview/
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bit_masks/overview.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bit_masks/overview/description.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/acknowledgments.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/design_rationale.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/future_work.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/implementation_details/
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/implementation_details.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/implementation_details/internal_documentation/
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/implementation_details/internal_documentation.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/implementation_details/internal_documentation/class_templates.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/implementation_details/internal_documentation/function_templates.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/implementation_details/internal_documentation/macros.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/overview/
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/overview.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/overview/description.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/overview/motivation.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_class_reference/
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_class_reference.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_class_reference/align.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_class_reference/bitfield_tuple_and_bitfield_reference.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_class_reference/custom.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_class_reference/flag.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_class_reference/member.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_class_reference/padding.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_class_reference/pointer.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_class_reference/storage.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_macro_reference/
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_macro_reference.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_macro_reference/code_generation_macros.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_macro_reference/parameter_adjustment_macros.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/boost_fusion_sequence_extension.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/concepts.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/files.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/function_reference/
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/function_reference.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/function_reference/get.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/function_reference/make_bitfield_tuple.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/meta_function_reference/
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/meta_function_reference.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/meta_function_reference/element.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/meta_function_reference/element_n.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/external_resources.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started/
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started/building_with_bitfield_tuple.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started/dependencies.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started/installation.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started/testing.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/glossary.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/tutorial.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/high_bits_mask/
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/high_bits_mask/bit_masks/
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/high_bits_mask/bit_masks/high_bits_maskbits.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/index.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/integral_mask/
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/integral_mask/bit_masks/
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/integral_mask/bit_masks/integral_mask.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/low_bits_mask/
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/low_bits_mask/bit_masks/
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/low_bits_mask/bit_masks/low_bits_mask.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/standalone_HTML.manifest (contents, props changed)

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/Rationale/bit_masks/overview/rationale.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/Rationale/bit_masks/overview/rationale.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,49 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Rationale</title>
+<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../../../boost_integer_bits_masks_extension/bit_masks/overview.html" title="Overview">
+<link rel="prev" href="../../../boost_integer_bits_masks_extension/bit_masks/overview/description.html" title="Description">
+<link rel="next" href="../../../integral_mask/bit_masks/integral_mask.html" title="integral_mask">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../../../boost_integer_bits_masks_extension/bit_masks/overview/description.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_integer_bits_masks_extension/bit_masks/overview.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="../../../integral_mask/bit_masks/integral_mask.html"><img src="../../../images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="Rationale.bit_masks.overview.rationale"></a><a class="link" href="rationale.html" title="Rationale">Rationale</a>
+</h4></div></div></div>
+
+ The primary motivation for the creation of the bit masks library extension
+ lies in a need to quickly compose masks which are static typed and provide
+ additional additional information about the mask itself as well as abstract
+ the notion of contiguous bits within a mask. Bit masks are usually created
+ by using the preprocessor or by using hexadecimal characters. Often times
+ both previous methods of creating bit masks, by either macro or hexadecimal,
+ can make code less readable and at times harder to deduce types the values
+ are going to be used to represent. The other feature which this library
+ extension provides is a means to represent masks as a contiguous section
+ of bits within an integral type, which can be difficult to represent when
+ looking at hex.
+ 
+</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 © 2010 Brian Bartman
+ 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="../../../boost_integer_bits_masks_extension/bit_masks/overview/description.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_integer_bits_masks_extension/bit_masks/overview.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="../../../integral_mask/bit_masks/integral_mask.html"><img src="../../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/bit_width/bit_masks/bit_width.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/bit_width/bit_masks/bit_width.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,200 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>bit_width</title>
+<link rel="stylesheet" href="../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../../boost_integer_bits_masks_extension/bit_masks.html" title="Bit Masks">
+<link rel="prev" href="../../bits_mask/bit_masks/bits_mask.html" title="bits_mask">
+<link rel="next" href="../../bitfield_tuple/bitfield_tuple.html" title="bitfield_tuple">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../../bits_mask/bit_masks/bits_mask.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_integer_bits_masks_extension/bit_masks.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../../bitfield_tuple/bitfield_tuple.html"><img src="../../images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="bit_width.bit_masks.bit_width"></a><a class="link" href="bit_width.html" title="bit_width"> bit_width</a>
+</h3></div></div></div>
+<a name="bit_width.bit_masks.bit_width.description"></a><h4>
+<a name="id3219947"></a>
+ <a class="link" href="bit_width.html#bit_width.bit_masks.bit_width.description">Description</a>
+ </h4>
+
+ <code class="computeroutput">bit_width</code> is a basic type
+ trait style meta-function which takes a type, and gives you the width of
+ that type in bits.
+ 
+<a name="bit_width.bit_masks.bit_width.header_file_information"></a><h4>
+<a name="id3219979"></a>
+ <a class="link" href="bit_width.html#bit_width.bit_masks.bit_width.header_file_information">Header
+ File Information</a>
+ </h4>
+
+
+
+<pre class="programlisting">#include <boost/integer/bit_width.hpp>
+</pre>
+
+ 
+<a name="bit_width.bit_masks.bit_width.template_signature"></a><h4>
+<a name="id3220051"></a>
+ <a class="link" href="bit_width.html#bit_width.bit_masks.bit_width.template_signature">Template
+ Signature</a>
+ </h4>
+
+ <code class="computeroutput">bit_width</code> has the following
+ template signature:
+
+<pre class="programlisting">namespace boost {
+template <typename T> struct bit_width;
+}
+</pre>
+
+ 
+<a name="bit_width.bit_masks.bit_width.template_parameters"></a><h4>
+<a name="id3220146"></a>
+ <a class="link" href="bit_width.html#bit_width.bit_masks.bit_width.template_parameters">Template
+ Parameters</a>
+ </h4>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Parameter
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ 
+ <code class="computeroutput">T</code>
+ 
+ </td>
+<td>
+ 
+ A type which you would like the width of.
+ 
+ </td>
+</tr></tbody>
+</table></div>
+<a name="bit_width.bit_masks.bit_width.interface"></a><h4>
+<a name="id3220224"></a>
+ <a class="link" href="bit_width.html#bit_width.bit_masks.bit_width.interface">Interface</a>
+ </h4>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Operation
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ 
+ <code class="computeroutput">N::value</code>
+ 
+ </td>
+<td>
+ 
+ Returns a value of type <code class="computeroutput">std::size_t</code>
+ which is the number of bits within <code class="computeroutput">T</code>.
+ 
+ </td>
+</tr></tbody>
+</table></div>
+<a name="bit_width.bit_masks.bit_width.preconditions"></a><h4>
+<a name="id3220338"></a>
+ <a class="link" href="bit_width.html#bit_width.bit_masks.bit_width.preconditions">Preconditions</a>
+ </h4>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Precondition
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+<th>
+ 
+ Enforcement
+ 
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ 
+ 
+ </td>
+<td>
+ 
+ You must be able to call <code class="computeroutput">sizeof</code>
+ on type <code class="computeroutput">T</code>
+ 
+ </td>
+<td>
+ 
+ This is enforced by attempting to take the <code class="computeroutput">sizeof</code>
+ <code class="computeroutput">T</code> and the compiler
+ telling you you can not.
+ 
+ </td>
+</tr></tbody>
+</table></div>
+<a name="bit_width.bit_masks.bit_width.examples"></a><h4>
+<a name="id3220460"></a>
+ <a class="link" href="bit_width.html#bit_width.bit_masks.bit_width.examples">Examples</a>
+ </h4>
+
+ Example:
+
+<pre class="programlisting">assert( bit_width<int>::value == 32);
+</pre>
+
+ 
+</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 © 2010 Brian Bartman
+ 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="../../bits_mask/bit_masks/bits_mask.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_integer_bits_masks_extension/bit_masks.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../../bitfield_tuple/bitfield_tuple.html"><img src="../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/bitfield_tuple/bitfield_tuple.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/bitfield_tuple/bitfield_tuple.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,125 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>bitfield_tuple</title>
+<link rel="stylesheet" href="../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="prev" href="../bit_width/bit_masks/bit_width.html" title="bit_width">
+<link rel="next" href="../boost_integer_bits_masks_extension/bitfield_tuple/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"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../bit_width/bit_masks/bit_width.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="../boost_integer_bits_masks_extension/bitfield_tuple/overview.html"><img src="../images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="bitfield_tuple.bitfield_tuple"></a><a class="link" href="bitfield_tuple.html" title="bitfield_tuple">bitfield_tuple</a>
+</h2></div></div></div>
+<div class="toc"><dl>
+<dt>overview</dt>
+<dd><dl>
+<dt>Description</dt>
+<dt>Motivation</dt>
+</dl></dd>
+<dt><a href="../boost_integer_bits_masks_extension/bitfield_tuple/users_guide.html">Users
+ Guide</a></dt>
+<dd><dl>
+<dt><a href="../boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started.html">Getting
+ Started</a></dt>
+<dd><dl>
+<dt>Installation</dt>
+<dt>Dependencies</dt>
+<dt><a href="../boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started/building_with_bitfield_tuple.html">Building
+ With bitfield_tuple</a></dt>
+<dt>Testing</dt>
+</dl></dd>
+<dt>Tutorial</dt>
+<dt><a href="../boost_integer_bits_masks_extension/bitfield_tuple/users_guide/external_resources.html">External
+ Resources</a></dt>
+<dt>Glossary</dt>
+</dl></dd>
+<dt>Reference</dt>
+<dd><dl>
+<dt>Concepts</dt>
+<dt><a href="../boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_class_reference.html">bitfield_tuple
+ Class Reference</a></dt>
+<dd><dl>
+<dt><a href="../boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_class_reference/bitfield_tuple_and_bitfield_reference.html">bitfield_tuple
+ and bitfield_reference</a></dt>
+<dt>padding</dt>
+<dt>member</dt>
+<dt>flag</dt>
+<dt>align</dt>
+<dt>storage</dt>
+<dt>pointer</dt>
+<dt>custom</dt>
+</dl></dd>
+<dt><a href="../boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_macro_reference.html">bitfield_tuple
+ Macro Reference</a></dt>
+<dd><dl>
+<dt><a href="../boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_macro_reference/parameter_adjustment_macros.html">Parameter
+ Adjustment macros</a></dt>
+<dt><a href="../boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_macro_reference/code_generation_macros.html">Code
+ Generation Macros</a></dt>
+</dl></dd>
+<dt><a href="../boost_integer_bits_masks_extension/bitfield_tuple/reference/function_reference.html">Function
+ Reference</a></dt>
+<dd><dl>
+<dt><a href="../boost_integer_bits_masks_extension/bitfield_tuple/reference/function_reference/make_bitfield_tuple.html">
+ make_bitfield_tuple Free Function</a></dt>
+<dt><a href="../boost_integer_bits_masks_extension/bitfield_tuple/reference/function_reference/get.html">
+ get Free Function</a></dt>
+</dl></dd>
+<dt><a href="../boost_integer_bits_masks_extension/bitfield_tuple/reference/meta_function_reference.html">Meta-Function
+ Reference</a></dt>
+<dd><dl>
+<dt><a href="../boost_integer_bits_masks_extension/bitfield_tuple/reference/meta_function_reference/element.html">
+ struct element</a></dt>
+<dt><a href="../boost_integer_bits_masks_extension/bitfield_tuple/reference/meta_function_reference/element_n.html">
+ struct element_n</a></dt>
+</dl></dd>
+<dt><a href="../boost_integer_bits_masks_extension/bitfield_tuple/reference/boost_fusion_sequence_extension.html">Boost.Fusion
+ Sequence Extension</a></dt>
+<dt>Files</dt>
+</dl></dd>
+<dt>Appendices</dt>
+<dd><dl>
+<dt><a href="../boost_integer_bits_masks_extension/bitfield_tuple/appendices/design_rationale.html">Design
+ Rationale</a></dt>
+<dt><a href="../boost_integer_bits_masks_extension/bitfield_tuple/appendices/implementation_details.html">Implementation
+ Details</a></dt>
+<dd><dl>
+<dt><a href="../boost_integer_bits_masks_extension/bitfield_tuple/appendices/implementation_details/internal_documentation.html">Internal
+ documentation</a></dt>
+<dd><dl>
+<dt>Macros</dt>
+<dt><a href="../boost_integer_bits_masks_extension/bitfield_tuple/appendices/implementation_details/internal_documentation/class_templates.html">Class
+ Templates</a></dt>
+<dt><a href="../boost_integer_bits_masks_extension/bitfield_tuple/appendices/implementation_details/internal_documentation/function_templates.html">Function
+ Templates</a></dt>
+</dl></dd>
+</dl></dd>
+<dt>Acknowledgments</dt>
+<dt><a href="../boost_integer_bits_masks_extension/bitfield_tuple/appendices/future_work.html">Future
+ Work</a></dt>
+</dl></dd>
+</dl></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 © 2010 Brian Bartman
+ 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="../bit_width/bit_masks/bit_width.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="../boost_integer_bits_masks_extension/bitfield_tuple/overview.html"><img src="../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/bits_mask/bit_masks/bits_mask.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/bits_mask/bit_masks/bits_mask.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,444 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>bits_mask</title>
+<link rel="stylesheet" href="../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../../boost_integer_bits_masks_extension/bit_masks.html" title="Bit Masks">
+<link rel="prev" href="../../low_bits_mask/bit_masks/low_bits_mask.html" title="low_bits_mask">
+<link rel="next" href="../../bit_width/bit_masks/bit_width.html" title="bit_width">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../../low_bits_mask/bit_masks/low_bits_mask.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_integer_bits_masks_extension/bit_masks.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../../bit_width/bit_masks/bit_width.html"><img src="../../images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="bits_mask.bit_masks.bits_mask"></a><a class="link" href="bits_mask.html" title="bits_mask"> bits_mask</a>
+</h3></div></div></div>
+<a name="bits_mask.bit_masks.bits_mask.description"></a><h4>
+<a name="id3218100"></a>
+ <a class="link" href="bits_mask.html#bits_mask.bit_masks.bits_mask.description">Description</a>
+ </h4>
+
+ The <code class="computeroutput">bits_mask</code> template provides
+ an extention to the <code class="computeroutput">low_bits_mask</code>
+ template, by incorporating an <code class="computeroutput">Offset</code>
+ with the template. The <code class="computeroutput">offest</code>
+ is always relative to the right most bit, or bit 0. For a basic view of how
+ <code class="computeroutput">bits_mask</code> works consider
+ the following examples:
+ 
+
+
+
+<pre class="programlisting">typedef bits_mask<int, 10, 3> mask;
+// mask::value has the following binary value
+// 0000 0000 0000 0000 0001 1100 0000 0000
+</pre>
+
+ For simplicity there is a defualt parameter for <code class="computeroutput">Width</code>
+ giving it a value of <code class="computeroutput">1</code>. This
+ makes writing of normally left or right shift masks simple and staticly checkable.
+ For example,
+ 
+
+
+
+<pre class="programlisting">// If one would need to create a mask for checking the 11th bit within an
+// integer it can be done simple with the following mask
+typedef bits_mask<int,11> mask;
+// this creates a mask at the 11th bit within an integer.
+</pre>
+
+ 
+<a name="bits_mask.bit_masks.bits_mask.header_file_information"></a><h4>
+<a name="id3218325"></a>
+ <a class="link" href="bits_mask.html#bits_mask.bit_masks.bits_mask.header_file_information">Header
+ File Information</a>
+ </h4>
+
+
+
+<pre class="programlisting">#include <boost/integer/bits_mask.hpp>
+</pre>
+
+ 
+<a name="bits_mask.bit_masks.bits_mask.template_signature"></a><h4>
+<a name="id3218397"></a>
+ <a class="link" href="bits_mask.html#bits_mask.bit_masks.bits_mask.template_signature">Template
+ Signature</a>
+ </h4>
+
+ <code class="computeroutput">bits_mask</code> has the following
+ template signature:
+
+<pre class="programlisting">namespace boost {
+template <typename T, unsigned int Offset, unsigned int Width = 1u > struct bits_mask;
+}
+</pre>
+
+ 
+<a name="bits_mask.bit_masks.bits_mask.bit_mask_hierarchy"></a><h4>
+<a name="id3218543"></a>
+ <a class="link" href="bits_mask.html#bits_mask.bit_masks.bits_mask.bit_mask_hierarchy">Bit Mask
+ Hierarchy</a>
+ </h4>
+
+ <code class="computeroutput">bits_mask</code> inherits from
+ <code class="computeroutput">integral_mask</code>.
+ 
+<a name="bits_mask.bit_masks.bits_mask.template_parameters"></a><h4>
+<a name="id3218583"></a>
+ <a class="link" href="bits_mask.html#bits_mask.bit_masks.bits_mask.template_parameters">Template
+ Parameters</a>
+ </h4>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Parameter
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">T</code>
+ 
+ </td>
+<td>
+ 
+ Is an integral type which the mask is to be created over.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">Offset</code>
+ 
+ </td>
+<td>
+ 
+ This is the number of bits from the least significant bit to the
+ first bit being used to compose the mask. Another way to think
+ of this is the amount that the mask has been shifted to the left
+ (using the left shift operator).
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">Width</code>
+ 
+ </td>
+<td>
+ 
+ This is the width of the mask in bits. <code class="computeroutput">Width</code>
+ has a default value of <code class="computeroutput">1u</code>
+ so that <code class="computeroutput">bits_mask</code>
+ can be easily used to create boolean flags by providing only an
+ <code class="computeroutput">Offset</code> to the bit.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="bits_mask.bit_masks.bits_mask.preconditions"></a><h4>
+<a name="id3218756"></a>
+ <a class="link" href="bits_mask.html#bits_mask.bit_masks.bits_mask.preconditions">Preconditions</a>
+ </h4>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Precondition
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+<th>
+ 
+ Enforcement
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">T</code> must be an integral
+ type.
+ 
+ </td>
+<td>
+ 
+ This is only a documented precondition. It is not enforced.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">(Offset
+ + Width) <=
+ ( bit_width<T>::value
+ )</code>
+ 
+ </td>
+<td>
+ 
+ The <code class="computeroutput">Width +
+ Offset</code> must be less then
+ or equal to the number of bits within the integral type <code class="computeroutput">T</code>
+ 
+ </td>
+<td>
+ 
+ Enforced by static assert.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Valid range for mask width is > 0.
+ 
+ </td>
+<td>
+ 
+ The <code class="computeroutput">Width</code> of a
+ mask must not be zero. Because <code class="computeroutput">Width</code>
+ is of <code class="computeroutput">std::size_t</code> it can not be negative.
+ 
+ </td>
+<td>
+ 
+ Enforced by domain of template parameter and by static assert.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="bits_mask.bit_masks.bits_mask.interface"></a><h4>
+<a name="id3219032"></a>
+ <a class="link" href="bits_mask.html#bits_mask.bit_masks.bits_mask.interface">Interface</a>
+ </h4>
+
+ <code class="computeroutput">bits_mask</code> Compile time interface.
+ Assume that <code class="computeroutput">N</code> is of type
+ <code class="computeroutput">bits_mask<unsigned int,4,1></code> the type
+ supplied here is only for example.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Operation
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::value</code>
+ 
+ </td>
+<td>
+ 
+ Returns the <code class="computeroutput">value</code>
+ associated with <code class="computeroutput">N</code>.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::value_type</code>
+ 
+ </td>
+<td>
+ 
+ Returns <code class="computeroutput">T</code> which
+ is the type associated with <code class="computeroutput">value</code>
+ inside <code class="computeroutput">N</code>.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::type</code>
+ 
+ </td>
+<td>
+ 
+ Returns the current types type.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::width</code>
+ 
+ </td>
+<td>
+ 
+ Returns the integral value associated with the <code class="computeroutput">width</code>
+ template parameter.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::offset</code>
+ 
+ </td>
+<td>
+ 
+ Returns the integral value associated with the <code class="computeroutput">Offset</code>
+ template parameter.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">operator T()</code>
+ 
+ </td>
+<td>
+ 
+ Run time support function. All this function does is return the
+ value associated with the type.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="bits_mask.bit_masks.bits_mask.examples"></a><h4>
+<a name="id3219424"></a>
+ <a class="link" href="bits_mask.html#bits_mask.bit_masks.bits_mask.examples">Examples</a>
+ </h4>
+
+ Examples and use cases related to the <code class="computeroutput">bits_mask</code>
+ template.
+ 
+
+ Example:
+ 
+
+ Single bit mask using the default parameter for width.
+
+<pre class="programlisting">typedef bits_mask< int, 0 > mask;
+// mask in this case has the following value
+// 0000 0000 0000 0000 0000 0000 0000 0001
+
+int some_bit_value = 0xdeadbeef;
+
+// now testing to see if the zero bit is set in some_bit_value
+if(some_bit_value & mask() ) {
+ ...
+ true case
+ ...
+} else {
+ ...
+ false case
+ ...
+}
+</pre>
+
+ 
+
+ Here is another case where the <code class="computeroutput">bits_mask</code>
+ template is used used similar to a bit field. The goal in this case would
+ be to extract a single value from within an integral storage type, which
+ may be storing one or more values.
+ 
+
+
+
+<pre class="programlisting">typedef bits_mask<int,10,3> mask;
+// binary value of mask
+// 0000 0000 0000 0000 0001 1111 1111 1000
+
+// this will then be used to retrieve a value within an integer.
+int some_bit_value = 0xdeadbeef;
+// binary value of some_bit_value
+// 1101 1110 1010 1011 1011 1110 1110 1111
+
+// now to extract the value from within some_bit_value
+int new_int_value = ( some_bit_value & mask() ) >> mask::offset;
+
+// basic operations taking place.
+// 1101 1110 1010 1011 1011 1110 1110 1111 <- some_bit_value
+// 0000 0000 0000 0000 0001 1111 1111 1000 <- mask::value
+
+// preforming bitwise and operator.
+
+// 0000 0000 0000 0000 0001 1110 1110 1000 <- result of bitwise and operator
+// preform right shift operation.
+// 0000 0000 0000 0000 0000 0011 1101 1101 <- value of new_int_value.
+</pre>
+
+ 
+
+ The implicit cast operator allows for simplicity, clarity of code. In the
+ above example <code class="computeroutput">mask()</code>
+ could be replaced with <code class="computeroutput">mask::value</code>
+ to achieve the same result. The same applies to all other bitwise operators.
+ 
+</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 © 2010 Brian Bartman
+ 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="../../low_bits_mask/bit_masks/low_bits_mask.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_integer_bits_masks_extension/bit_masks.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../../bit_width/bit_masks/bit_width.html"><img src="../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/HeaderSummary.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/HeaderSummary.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,218 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Header File Summary</title>
+<link rel="stylesheet" href="../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="prev" href="../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="next" href="bit_masks.html" title="Bit Masks">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../index.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="bit_masks.html"><img src="../images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="boost_integer_bits_masks_extension.HeaderSummary"></a><a class="link" href="HeaderSummary.html" title="Header File Summary"> Header
+ File Summary</a>
+</h2></div></div></div>
+
+ The following table contains header files used within the bit masks library
+ extension. For additional information such as full descriptions, tutorials
+ and interface guides please use the table of contents above.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Component
+ 
+ </th>
+<th>
+ 
+ Header
+ 
+ </th>
+<th>
+ 
+ Contence
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">integral_mask</code> type
+ 
+ </td>
+<td>
+ 
+ <code class="literal"><boost/integer/integral_mask.hpp></code>
+ 
+ </td>
+<td>
+ 
+ Header contains <code class="computeroutput">integral_mask</code>
+ template.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">high_bits_mask</code> type
+ 
+ </td>
+<td>
+ 
+ <code class="literal"><boost/integer/high_bits_mask.hpp></code>
+ 
+ </td>
+<td>
+ 
+ Header contains <code class="computeroutput">high_bits_mask</code>
+ template.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">low_bits_mask</code> type
+ 
+ </td>
+<td>
+ 
+ <code class="literal"><boost/integer/low_bits_mask.hpp></code>
+ 
+ </td>
+<td>
+ 
+ Header contains <code class="computeroutput">low_bits_mask</code>
+ template.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">high_bits_mask</code> type
+ and <code class="computeroutput">low_bits_mask</code>
+ type
+ 
+ </td>
+<td>
+ 
+ <code class="literal"><boost/integer/high_low_bits.hpp></code>
+ 
+ </td>
+<td>
+ 
+ Header contains includes for <code class="computeroutput">high_bits_mask</code>
+ and <code class="computeroutput">low_bits_mask</code>.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">bits_mask</code> type
+ 
+ </td>
+<td>
+ 
+ <code class="literal"><boost/integer/bits_mask.hpp></code>
+ 
+ </td>
+<td>
+ 
+ Header contains <code class="computeroutput">bits_mask</code>
+ template.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">bit_width</code> type
+ 
+ </td>
+<td>
+ 
+ <code class="literal"><boost/integer/bit_width.hpp></code>
+ 
+ </td>
+<td>
+ 
+ Contains the <code class="computeroutput">bit_width</code>
+ meta-function .
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">bitfield_tuple</code> type
+ 
+ </td>
+<td>
+ 
+ <code class="literal"><boost/integer/bitfield_tuple.hpp></code>
+ 
+ </td>
+<td>
+ 
+ Header contains <code class="computeroutput">bitfield_tuple</code>
+ data structure and all of the interface used for or with <code class="computeroutput">bitfield_tuple</code>. For a full list
+ of header files relating to the <code class="computeroutput">bitfield_tuple</code>
+ please see the <a class="link" href="bitfield_tuple/reference/files.html" title="Files">Files</a>
+ section of the <code class="computeroutput">bitfield_tuple</code>
+ documentation.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">bitfield_tuple_fwd</code>
+ type
+ 
+ </td>
+<td>
+ 
+ <code class="literal"><boost/integer/bitfield_tuple_fwd.hpp></code>
+ 
+ </td>
+<td>
+ 
+ Header contains a forward declaration for <code class="computeroutput">bitfield_tuple</code>.
+ 
+ </td>
+</tr>
+</tbody>
+</table></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 © 2010 Brian Bartman
+ 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="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="bit_masks.html"><img src="../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bit_masks.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bit_masks.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,65 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Bit Masks</title>
+<link rel="stylesheet" href="../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="prev" href="HeaderSummary.html" title="Header File Summary">
+<link rel="next" href="bit_masks/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"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="HeaderSummary.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="bit_masks/overview.html"><img src="../images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="boost_integer_bits_masks_extension.bit_masks"></a><a class="link" href="bit_masks.html" title="Bit Masks">Bit Masks</a>
+</h2></div></div></div>
+<div class="toc"><dl>
+<dt>Overview</dt>
+<dd><dl>
+<dt>Description</dt>
+<dt>Rationale</dt>
+</dl></dd>
+<dt><a href="../integral_mask/bit_masks/integral_mask.html"> integral_mask
+ </a></dt>
+<dt> high_bits_mask</dt>
+<dt> low_bits_mask</dt>
+<dt> bits_mask</dt>
+<dt> bit_width</dt>
+</dl></div>
+
+ The Bits Masks library extension was created to help simplify the creation
+ of bit masks on compile time. The library contains multiple utilities for creating
+ and representing contiguous sections of bits within an integral type as well
+ as a utility for determining the width in bits of a type on compile time.
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+</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 © 2010 Brian Bartman
+ 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="HeaderSummary.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="bit_masks/overview.html"><img src="../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bit_masks/overview.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bit_masks/overview.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,44 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Overview</title>
+<link rel="stylesheet" href="../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../bit_masks.html" title="Bit Masks">
+<link rel="prev" href="../bit_masks.html" title="Bit Masks">
+<link rel="next" href="overview/description.html" title="Description">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../bit_masks.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../bit_masks.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="overview/description.html"><img src="../../images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_integer_bits_masks_extension.bit_masks.overview"></a><a class="link" href="overview.html" title="Overview">Overview</a>
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt>Description</dt>
+<dt>Rationale</dt>
+</dl></div>
+
+ Description of the libraries uses and use cases and the rationale for the
+ creation of the libarary extension itself.
+ 
+</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 © 2010 Brian Bartman
+ 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="../bit_masks.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../bit_masks.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="overview/description.html"><img src="../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bit_masks/overview/description.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bit_masks/overview/description.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,162 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Description</title>
+<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../overview.html" title="Overview">
+<link rel="prev" href="../overview.html" title="Overview">
+<link rel="next" href="../../../Rationale/bit_masks/overview/rationale.html" title="Rationale">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../overview.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../overview.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="../../../Rationale/bit_masks/overview/rationale.html"><img src="../../../images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_integer_bits_masks_extension.bit_masks.overview.description"></a><a class="link" href="description.html" title="Description">Description</a>
+</h4></div></div></div>
+
+ The purpose of this library extension to the Boost.Integer library is to
+ make the creation of simple and complex integral masks simple and easy
+ and compossible on compile time. The structure of the bit masks are an
+ extensions of the type <code class="computeroutput">integral_constant</code>
+ provided by Boost.Type Traits library. All masks are able to be treated
+ as the <code class="computeroutput">integral_constant</code>
+ type. All masks provide the following three compile time accessible features"
+ <code class="computeroutput">::type</code>,
+ <code class="computeroutput">::value_type</code>,
+ <code class="computeroutput">::value</code>
+ <code class="computeroutput">::offset</code>
+ and <code class="computeroutput">::width</code>
+ for compile time support. This also means that all masks can be used with
+ the Boost.MPL bitwise operator meta-functions for creation of more complex
+ masks. For runtime support all mask types in this library extension provide
+ the implicit cast operator allowing for the meta-function objects to be
+ used as if they were the integral value they are being used to represent.
+ The implicit cast operator is also provided by the <code class="computeroutput">integral_constant</code>
+ type which the masks are based upon. For example,
+ 
+
+
+
+<pre class="programlisting">#include <boost/integer/integral_mask.hpp>
+
+using namespace boost;
+
+
+int main() {
+ int t = 0xdeadbeef;
+ typedef integral_mask<int, 3> mask_type;
+
+ int unmasked_t = t & mask_type();
+ return 0;
+}
+</pre>
+
+ For the use of a mask all that one needs to do is to construct the mask
+ and simply treat it as though it were an integer.
+ 
+<div class="note"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td align="left" valign="top">
+ All masks are trivially default constructible and destructible.
+ </td></tr>
+</table></div>
+
+ Using masks to describe contiguious sections of bits within an integral
+ value is simplified by doing it at a higher level, using the <code class="computeroutput">offset</code> from the least or greatest significant
+ bit, <code class="computeroutput">width</code> of the contigious
+ bits, and the integral type which is to be used for masking. The following
+ are examples of how one would use the different masks to create masks at
+ a high level.
+ 
+<a name="boost_integer_bits_masks_extension.bit_masks.overview.description.general_use_cases"></a><h5>
+<a name="id3213904"></a>
+ <a class="link" href="description.html#boost_integer_bits_masks_extension.bit_masks.overview.description.general_use_cases">General
+ use cases</a>
+ </h5>
+
+ Example: Using <code class="computeroutput">integral_mask</code>
+ as a trival example. The following example is of an integral mask which
+ is being used to represent hex.
+
+<pre class="programlisting">typedef integral_mask<unsigned int, 0x20> mask;
+
+// Used to represent the following binary value.
+// most significant least significant
+// 31 23 15 7 0
+// 0000 0000 0000 0000 0000 0000 0010 0000
+</pre>
+
+ 
+
+ Example: Using <code class="computeroutput">low_bits_mask</code>
+ to defines that the last 3 bits should be set to 1.
+
+<pre class="programlisting">typedef low_bits_mask<unsigned short, 3> mask_2_low;
+
+// Used to represent the following binary value.
+// most significant least significant
+// 15 7 0
+// 0000 0000 0000 0111
+</pre>
+
+ 
+
+ Example: Using <code class="computeroutput">high_bits_mask</code>
+ to quickly specify the sign bit of a provided type.
+
+<pre class="programlisting">typedef high_bits_mask<short, 1> sign_bit;
+
+// Used to represent the following binary value.
+// most significant least significant
+// 15 7 0
+// 1000 0000 0000 0000
+
+</pre>
+
+ Within the above example if <code class="computeroutput">short</code>
+ is replaced with any other type it will represent the most significant
+ bit of that type. In the case of signed types that is the sign bit of that
+ type.
+ 
+
+ Example: Using <code class="computeroutput">bits_mask</code>
+ quickly create a mask over for a bit flag within an integral type.
+
+<pre class="programlisting">typedef bits_mask<int, 3> flag_mask;
+
+// Used to represent the following binary value.
+// most significant least significant
+// 31 23 15 7 0
+// 0000 0000 0000 0000 0000 0000 0000 0100
+</pre>
+
+ 
+
+ For additional uses and information about each of the different templates
+ used for creating integral masks please see the documentation relating
+ to each of the corresponding masks.
+ 
+</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 © 2010 Brian Bartman
+ 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="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../overview.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="../../../Rationale/bit_masks/overview/rationale.html"><img src="../../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,56 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Appendices</title>
+<link rel="stylesheet" href="../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../../bitfield_tuple/bitfield_tuple.html" title="bitfield_tuple">
+<link rel="prev" href="reference/files.html" title="Files">
+<link rel="next" href="appendices/design_rationale.html" title="Design Rationale">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="reference/files.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../bitfield_tuple/bitfield_tuple.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="appendices/design_rationale.html"><img src="../../images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.appendices"></a><a class="link" href="appendices.html" title="Appendices">Appendices</a>
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt><a href="appendices/design_rationale.html">Design
+ Rationale</a></dt>
+<dt><a href="appendices/implementation_details.html">Implementation
+ Details</a></dt>
+<dd><dl>
+<dt><a href="appendices/implementation_details/internal_documentation.html">Internal
+ documentation</a></dt>
+<dd><dl>
+<dt>Macros</dt>
+<dt><a href="appendices/implementation_details/internal_documentation/class_templates.html">Class
+ Templates</a></dt>
+<dt><a href="appendices/implementation_details/internal_documentation/function_templates.html">Function
+ Templates</a></dt>
+</dl></dd>
+</dl></dd>
+<dt>Acknowledgments</dt>
+<dt><a href="appendices/future_work.html">Future
+ Work</a></dt>
+</dl></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 © 2010 Brian Bartman
+ 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/files.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../bitfield_tuple/bitfield_tuple.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="appendices/design_rationale.html"><img src="../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/acknowledgments.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/acknowledgments.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,34 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Acknowledgments</title>
+<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../appendices.html" title="Appendices">
+<link rel="prev" href="implementation_details/internal_documentation/function_templates.html" title="Function Templates">
+<link rel="next" href="future_work.html" title="Future Work">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="implementation_details/internal_documentation/function_templates.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../appendices.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="future_work.html"><img src="../../../images/next.png" alt="Next"></a>
+</div>
+<div class="section"><div class="titlepage"><div><div><h4 class="title">
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.appendices.acknowledgments"></a><a class="link" href="acknowledgments.html" title="Acknowledgments">Acknowledgments</a>
+</h4></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 © 2010 Brian Bartman
+ 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="implementation_details/internal_documentation/function_templates.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../appendices.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="future_work.html"><img src="../../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/design_rationale.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/design_rationale.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,35 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Design Rationale</title>
+<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../appendices.html" title="Appendices">
+<link rel="prev" href="../appendices.html" title="Appendices">
+<link rel="next" href="implementation_details.html" title="Implementation Details">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../appendices.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../appendices.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="implementation_details.html"><img src="../../../images/next.png" alt="Next"></a>
+</div>
+<div class="section"><div class="titlepage"><div><div><h4 class="title">
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.appendices.design_rationale"></a><a class="link" href="design_rationale.html" title="Design Rationale">Design
+ Rationale</a>
+</h4></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 © 2010 Brian Bartman
+ 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="../appendices.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../appendices.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="implementation_details.html"><img src="../../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/future_work.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/future_work.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,34 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Future Work</title>
+<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../appendices.html" title="Appendices">
+<link rel="prev" href="acknowledgments.html" title="Acknowledgments">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="acknowledgments.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../appendices.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a>
+</div>
+<div class="section"><div class="titlepage"><div><div><h4 class="title">
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.appendices.future_work"></a><a class="link" href="future_work.html" title="Future Work">Future
+ Work</a>
+</h4></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 © 2010 Brian Bartman
+ 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="acknowledgments.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../appendices.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/implementation_details.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/implementation_details.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,48 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Implementation Details</title>
+<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../appendices.html" title="Appendices">
+<link rel="prev" href="design_rationale.html" title="Design Rationale">
+<link rel="next" href="implementation_details/internal_documentation.html" title="Internal documentation">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="design_rationale.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../appendices.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="implementation_details/internal_documentation.html"><img src="../../../images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.appendices.implementation_details"></a><a class="link" href="implementation_details.html" title="Implementation Details">Implementation
+ Details</a>
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt><a href="implementation_details/internal_documentation.html">Internal
+ documentation</a></dt>
+<dd><dl>
+<dt>Macros</dt>
+<dt><a href="implementation_details/internal_documentation/class_templates.html">Class
+ Templates</a></dt>
+<dt><a href="implementation_details/internal_documentation/function_templates.html">Function
+ Templates</a></dt>
+</dl></dd>
+</dl></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 © 2010 Brian Bartman
+ 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="design_rationale.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../appendices.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="implementation_details/internal_documentation.html"><img src="../../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/implementation_details/internal_documentation/macros.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/implementation_details/internal_documentation/macros.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,1099 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Macros</title>
+<link rel="stylesheet" href="../../../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../../../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../internal_documentation.html" title="Internal documentation">
+<link rel="prev" href="../internal_documentation.html" title="Internal documentation">
+<link rel="next" href="class_templates.html" title="Class Templates">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../internal_documentation.html"><img src="../../../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../internal_documentation.html"><img src="../../../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../../../index.html"><img src="../../../../../images/home.png" alt="Home"></a><a accesskey="n" href="class_templates.html"><img src="../../../../../images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h6 class="title">
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.appendices.implementation_details.internal_documentation.macros"></a><a class="link" href="macros.html" title="Macros">Macros</a>
+</h6></div></div></div>
+
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Macro:
+ 
+ </th>
+<th>
+ 
+ <code class="computeroutput">BOOST_MAKE_BFT_TEMPLATE_PARAMS()</code>
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ Pattern:
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">typename T</code>##<code class="computeroutput">0
+ = mpl::void_,</code> ... <code class="computeroutput">typename
+ T</code>##<code class="computeroutput">N =
+ mpl::void_</code>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Description:
+ 
+ </td>
+<td>
+ 
+ Internal Use Only. Used
+ for making template parameters for the <code class="computeroutput">bitfield_tuple</code>
+ struct.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Where its used:
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">bitfield_tuple</code>'s
+ template parameters
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Header Defined in:
+ 
+ </td>
+<td>
+ 
+ template_expansion_macros.hpp
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+
+ 
+
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Macro:
+ 
+ </th>
+<th>
+ 
+ <code class="computeroutput">BOOST_BFT_MAKE_PARAMS(Z, N, DATA)</code>
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ Pattern:
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">typename T</code>##<code class="computeroutput">N
+ = mpl::void_</code>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Description:
+ 
+ </td>
+<td>
+ 
+ Internal Use Only. Used
+ in the implementation of <code class="computeroutput">BOOST_MAKE_BFT_TEMPLATE_PARAMS()</code>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Where its used:
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">BOOST_MAKE_BFT_TEMPLATE_PARAMS()</code>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Header Defined in:
+ 
+ </td>
+<td>
+ 
+ template_expansion_macros.hpp
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+
+ 
+
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Macro:
+ 
+ </th>
+<th>
+ 
+ <code class="computeroutput">BOOST_BFT_UNPACK_PARAMS()</code>
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ Pattern:
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">::template
+ process<T</code>##<code class="computeroutput">1>::type</code>
+ ... <code class="computeroutput">::template
+ process<T</code>##<code class="computeroutput">N>::type</code>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Description:
+ 
+ </td>
+<td>
+ 
+ Internal Use Only. This
+ is used for processing all of the template parameters by
+ "rebinding" the bft_arg_parse_impl using its
+ process template member.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Where its used:
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">bitfield_tuple_base</code>
+ with macro <code class="computeroutput">BOOST_BFT_ARG_PROCESSING</code>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Header Defined in:
+ 
+ </td>
+<td>
+ 
+ template_expansion_macros.hpp
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+
+ 
+
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Macro:
+ 
+ </th>
+<th>
+ 
+ <code class="computeroutput">BOOST_BFT_UNPACK_CALL(Z, N, DATA)</code>
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ Pattern:
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">::template
+ process<T</code>##<code class="computeroutput">N
+ >::type</code>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Description:
+ 
+ </td>
+<td>
+ 
+ Internal Use Only. Used
+ to create pattern for the <code class="computeroutput">BOOST_BFT_UNPACK_PARAMS()</code> macro.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Where its used:
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">BOOST_BFT_UNPACK_PARAMS()</code>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Header Defined in:
+ 
+ </td>
+<td>
+ 
+ template_expansion_macros.hpp
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+
+ 
+
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Macro:
+ 
+ </th>
+<th>
+ 
+ <code class="computeroutput">BOOST_BFT_ARG_PROCESSING</code>
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ Pattern:
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">details::bft_arg_parse_impl<T0,mpl::void_, mpl::vector<>, mpl::size_t<0u> >
+ BOOST_BFT_UNPACK_PARAMS()</code>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Description:
+ 
+ </td>
+<td>
+ 
+ Internal Use Only. This
+ is used for processing the template arguments by passing
+ each of the arguments into the bft_arg_parse_impl.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Where its used:
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">bitfield_tuple_base</code>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Header Defined in:
+ 
+ </td>
+<td>
+ 
+ bitfield_tuple_impl.hpp
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+
+ 
+
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Macro:
+ 
+ </th>
+<th>
+ 
+ <code class="computeroutput">BOOST_BFT_PARAM_LIST(Z,N,DATA)</code>
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ Pattern:
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">DATA</code>##<code class="computeroutput">N</code>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Description:
+ 
+ </td>
+<td>
+ 
+ Internal Use Only. Helps
+ produce the sequence T0, ... TN, both with and with out
+ typename before it.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Where its used:
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">BOOST_BFT_PARAMETER_LIST()</code>, <code class="computeroutput">BOOST_BFT_BASE_TEMPLATE_PARAMS()</code> and <code class="computeroutput">BOOST_BFT_TEMPLATE_ARGS_NO_DEFAULTS()</code>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Header Defined in:
+ 
+ </td>
+<td>
+ 
+ template_expansion_macros.hpp
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+
+ 
+
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Macro:
+ 
+ </th>
+<th>
+ 
+ <code class="computeroutput">BOOST_BFT_PARAMETER_LIST()</code>
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ Pattern:
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">T</code>##<code class="computeroutput">0,</code>
+ ... <code class="computeroutput">T</code>##<code class="computeroutput">N</code>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Description:
+ 
+ </td>
+<td>
+ 
+ Internal Use Only. used
+ to help generate type names and maintain the variadic behavior
+ of <code class="computeroutput">bitfield_tuple</code>
+ and other internal types typenames.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Where its used:
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">bitfield_tuple</code>
+ for the creation of <code class="computeroutput">typedef</code>s
+ for <code class="computeroutput">_base</code>
+ and <code class="computeroutput">_self</code>.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Header Defined in:
+ 
+ </td>
+<td>
+ 
+ template_expansion_macros.hpp
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+
+ 
+
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Macro:
+ 
+ </th>
+<th>
+ 
+ <code class="computeroutput">BOOST_BFT_BASE_TEMPLATE_PARAMS()</code>
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ Pattern:
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">typename T</code>##<code class="computeroutput">0,</code> ... <code class="computeroutput">typename
+ T</code>##<code class="computeroutput">N</code>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Description:
+ 
+ </td>
+<td>
+ 
+ Internal Use Only. Macro
+ is used for generating template parameters for the <code class="computeroutput">bitfield_tuple_base</code>.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Where its used:
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">bitfield_tuple_base</code>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Header Defined in:
+ 
+ </td>
+<td>
+ 
+ template_expansion_macros.hpp
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+
+ 
+
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Macro:
+ 
+ </th>
+<th>
+ 
+ <code class="computeroutput">BOOST_BFT_TEMPLATE_ARGS_NO_DEFAULTS()</code>
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ Pattern:
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">typename T</code>##<code class="computeroutput">0,</code> ... <code class="computeroutput">typename
+ T</code>##<code class="computeroutput">N</code>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Description:
+ 
+ </td>
+<td>
+ 
+ Part of interface. Helps
+ the the creation of template parameters for use in partial
+ specilization of class templates.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Where its used:
+ 
+ </td>
+<td>
+ 
+ Not used within library.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Header Defined in:
+ 
+ </td>
+<td>
+ 
+ template_expansion_macros.hpp
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+
+ 
+
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Macro:
+ 
+ </th>
+<th>
+ 
+ <code class="computeroutput">BOOST_BFT_SPECILIZATION_PARAM_LIST()</code>
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ Pattern:
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">T</code>##<code class="computeroutput">0,</code>
+ ... <code class="computeroutput">T</code>##<code class="computeroutput">N</code>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Description:
+ 
+ </td>
+<td>
+ 
+ Part of interface. Helps
+ aid in the creation of class template specialization.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Where its used:
+ 
+ </td>
+<td>
+ 
+ Not used within library.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Header Defined in:
+ 
+ </td>
+<td>
+ 
+ template_expansion_macros.hpp
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+
+ 
+
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Macro:
+ 
+ </th>
+<th>
+ 
+ <code class="computeroutput">BOOST_MAKE_BITFIELD_TUPLE_SINGLE_PARAMETER(z, n, data
+ )</code>
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ Pattern:
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">typename details::get_create_parameter<BitfieldTuple, n>::type
+ parameter</code>##<code class="computeroutput">n =
+ 0</code>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Description:
+ 
+ </td>
+<td>
+ 
+ Internal Use Only. Helps
+ create a deduced parameter for the <code class="computeroutput">make_bitfield_tuple</code>
+ function.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Where its used:
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">BOOST_MAKE_BITFIELD_TUPLE_CREATE_FUNCTION_PARAMETERS()</code>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Header Defined in:
+ 
+ </td>
+<td>
+ 
+ make_bitfield_tuple.hpp
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+
+ 
+
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Macro:
+ 
+ </th>
+<th>
+ 
+ <code class="computeroutput">BOOST_MAKE_BITFIELD_TUPLE_CREATE_FUNCTION_PARAMETERS()</code>
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ Pattern:
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">typename details::get_create_parameter<BitfieldTuple, 0>::type
+ parameter</code>##<code class="computeroutput">0 =
+ 0,
+ </code>...<code class="computeroutput"> typename
+ details::get_create_parameter<BitfieldTuple, n>::type
+ parameter</code>##<code class="computeroutput">n =
+ 0</code>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Description:
+ 
+ </td>
+<td>
+ 
+ Internal Use only. This
+ macro is used to create function parameters for the <code class="computeroutput">make_bitfield_tuple</code> function.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Where its used:
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">make_bitfield_tuple</code>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Header Defined in:
+ 
+ </td>
+<td>
+ 
+ make_bitfield_tuple.hpp
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+
+ 
+
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Macro:
+ 
+ </th>
+<th>
+ 
+ <code class="computeroutput">BOOST_MAKE_BITFIELD_TUPLE_ASSIGN_PARAMETER_TO_BFT_CALL(z,n,data)</code>
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ Pattern:
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">details::assign_parameter_to_bft<n>(bft, parameter</code>##<code class="computeroutput">n);</code>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Description:
+ 
+ </td>
+<td>
+ 
+ Internal Use Only Represents
+ a function call that is generated by the <code class="computeroutput">BOOST_MAKE_BITFIELD_TUPLE_CREATE_FUNCTION_PARSE_ARGUMENTS()</code> macro for each parameter
+ of <code class="computeroutput">make_bitfield_tuple</code>.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Where its used:
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">make_bitfield_tuple</code>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Header Defined in:
+ 
+ </td>
+<td>
+ 
+ make_bitfield_tuple.hpp
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+
+ 
+
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Macro:
+ 
+ </th>
+<th>
+ 
+ <code class="computeroutput">BOOST_MAKE_BITFIELD_TUPLE_CREATE_FUNCTION_PARSE_ARGUMENTS()</code>
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ Pattern:
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">details::assign_parameter_to_bft<0>(bft, parameter</code>##<code class="computeroutput">0);</code>
+ ... <code class="computeroutput">details::assign_parameter_to_bft<n>(bft, parameter</code>##<code class="computeroutput">n);</code>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Description:
+ 
+ </td>
+<td>
+ 
+ Internal Use Only. Generates
+ function calls which are either no-op's or store data into
+ a member of the <code class="computeroutput">bitfield_tuple</code>
+ inside of <code class="computeroutput">make_bitfield_tuple</code>.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Where its used:
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">make_bitfield_tuple</code>
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Header Defined in:
+ 
+ </td>
+<td>
+ 
+ make_bitfield_tuple.hpp
+ 
+ </td>
+</tr>
+</tbody>
+</table></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 © 2010 Brian Bartman
+ 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="../internal_documentation.html"><img src="../../../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../internal_documentation.html"><img src="../../../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../../../index.html"><img src="../../../../../images/home.png" alt="Home"></a><a accesskey="n" href="class_templates.html"><img src="../../../../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/overview.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/overview.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,40 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>overview</title>
+<link rel="stylesheet" href="../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../../bitfield_tuple/bitfield_tuple.html" title="bitfield_tuple">
+<link rel="prev" href="../../bitfield_tuple/bitfield_tuple.html" title="bitfield_tuple">
+<link rel="next" href="overview/description.html" title="Description">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../../bitfield_tuple/bitfield_tuple.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../bitfield_tuple/bitfield_tuple.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="overview/description.html"><img src="../../images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.overview"></a><a class="link" href="overview.html" title="overview">overview</a>
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt>Description</dt>
+<dt>Motivation</dt>
+</dl></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 © 2010 Brian Bartman
+ 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="../../bitfield_tuple/bitfield_tuple.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../bitfield_tuple/bitfield_tuple.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="overview/description.html"><img src="../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/overview/description.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/overview/description.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,228 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Description</title>
+<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../overview.html" title="overview">
+<link rel="prev" href="../overview.html" title="overview">
+<link rel="next" href="motivation.html" title="Motivation">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../overview.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../overview.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="motivation.html"><img src="../../../images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.overview.description"></a><a class="link" href="description.html" title="Description">Description</a>
+</h4></div></div></div>
+
+ A <code class="computeroutput">bitfield_tuple</code> is a type
+ that provides access to bitfields stored within integral or integral like
+ types. The interface of this type is similar to that of a tuple, with slight
+ variations on the template parameters and <code class="computeroutput">get</code>
+ function, while still providing similar functionality to the boost.tuple.
+ A piratical example for using a <code class="computeroutput">bitfield_tuple</code>
+ could be for storing colors.
+
+<pre class="programlisting">#include <boost/integer/bitfield_tuple.hpp>
+
+using namespace boost;
+struct red;
+struct green;
+struct blue;
+
+
+typedef bitfield_tuple<
+ storage<unsigned short>,
+ member<unsigned char, red,5>,
+ member<unsigned char, green, 6>,
+ member<unsigned char, blue, 5>
+> rgb565_t ;
+</pre>
+
+ To use the storage of bitfield_tuple for retrieving and storing data, all
+ that needs to be done is to call <code class="computeroutput">get</code>,
+ just like a Boost.Tuple. Each of the named parameters do something slightly
+ different, in the above example <code class="computeroutput">storage<unsigned short></code>
+ is used to specify that the type to be used for storing the bitfields within
+ is going to be an unsigned short. The <code class="computeroutput">member<unsigned int, red, 5></code>
+ member is used to specify a bitfield within the <code class="computeroutput">bitfield_tuple</code>.
+ Here is how <code class="computeroutput">member</code> works,
+ and relates directly back to regular recognizable C++.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ <code class="computeroutput">bitfield_tuple</code>
+ 
+ </th>
+<th>
+ 
+ <code class="computeroutput">classic Struct
+ Example</code>
+ 
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ 
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">#include <boost/integer/bitfield_tuple.hpp>
+
+using namespace boost;
+
+struct red;
+struct green;
+struct blue;
+
+typedef bitfield_tuple<
+ ...
+ member<unsigned char, red,5>,
+ ...
+> rgb656_t
+</pre>
+
+ 
+ </td>
+<td>
+ 
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">struct rgb656_t {
+ ...
+ unsigned char red:5;
+ ...
+};
+</pre>
+
+ 
+ </td>
+</tr></tbody>
+</table></div>
+
+ Observing the above example <code class="computeroutput">member<unsigned char, red,5>,</code>
+ and <code class="computeroutput">unsigned char
+ red:5;</code> are specified
+ in almost the exact same way. First parameter in <code class="computeroutput">member</code>
+ relates directly to the <code class="computeroutput">unsigned
+ char</code> type used in the bitfield
+ <code class="computeroutput">red</code> in the struct above.
+ The second parameter of member <code class="computeroutput">red</code>
+ which is in the above using a bitfield is a type, and the the struct rgb656_t
+ it's the name of the variable. The second parameter for member is also
+ a name for the bitfield it corresponds to and can be used with the get
+ function to retrieve the bitfield its being associated with. The third
+ parameter is the width of the bitfield in bits just as it is specified
+ using <code class="computeroutput">:5</code>
+ in the above example. Accessing of bitfields can be done either by index
+ or by name. If one chooses to retrieve a bitfield by index, the index value
+ is based on the other member which are specified before it. The following
+ is an example of how to use both an index accessor and the name accessor,
+ the two examples do the exact same thing.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Access By Name
+ 
+ </th>
+<th>
+ 
+ Access By Index
+ 
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ 
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">int main() {
+ rgb565_t rgb565;
+
+ rgb565.get<red>() = 31;
+ rgb565.get<green>() = 15;
+ rgb565.get<blue>() = 12;
+
+ return 0;
+}
+</pre>
+
+ 
+ </td>
+<td>
+ 
+
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">int main() {
+ rgb565_t rgb565;
+
+ rgb565.get<0>() = 31;
+ rgb565.get<1>() = 15;
+ rgb565.get<2>() = 12;
+
+ return 0;
+}
+</pre>
+
+ 
+ </td>
+</tr></tbody>
+</table></div>
+
+ The <code class="computeroutput">bitfield_tuple</code> get
+ functions return proxies to the bitfield they represent. Using a proxy
+ provides a way for the user to access the bitfields directly without the
+ hassle of doing the masking themselves.
+ 
+
+ There are many more complex examples to follow through out this documentation,
+ but for the sake of brevity they are not listed within this section and
+ are instead listed in the example section. Here is a brief description
+ of the different things one can accomplish with the bitfield_tuple:
+ 
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ Bit stuffing pointers.
+ </li>
+<li class="listitem">
+ Bit stuffing into integral types.
+ </li>
+<li class="listitem">
+ Custom encoding and decoding of the storage of bits within an integral
+ or integral like type.
+ </li>
+<li class="listitem">
+ Using non-POD types for storage.
+ </li>
+</ul></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 © 2010 Brian Bartman
+ 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="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../overview.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="motivation.html"><img src="../../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/overview/motivation.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/overview/motivation.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,88 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Motivation</title>
+<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../overview.html" title="overview">
+<link rel="prev" href="description.html" title="Description">
+<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"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="description.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../overview.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="../users_guide.html"><img src="../../../images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.overview.motivation"></a><a class="link" href="motivation.html" title="Motivation">Motivation</a>
+</h4></div></div></div>
+
+
+
+<pre class="programlisting">typedef bitfield_tuple<
+ storage<char>,
+ member<bool,bool_one,1>,
+ member<bool,bool_two,1>,
+ member<int,int_one,2>,
+ member<int,int_two,2>
+> example_type;
+</pre>
+
+ 
+
+ The goal of a bitfield tuple is to provide a method for constructing bitfields
+ which is not subject to packing restrictions of structs or classes, while
+ providing an interface simlar to that of a struct or class. For instance,
+ if a user wanted to create a struct or class which was similar to <code class="computeroutput">example_type</code> in the above example they
+ would write the following,
+ 
+
+
+
+<pre class="programlisting">struct foo {
+ bool bool_one:1;
+ bool bool_two:1;
+ int int_one:2;
+ int int_two:2;
+};
+</pre>
+
+ There is a problem with <code class="computeroutput">struct foo</code>, it is not one which is so simple
+ to see. <code class="computeroutput">struct foo</code>
+ has a <code class="computeroutput">sizeof</code> 4 bytes, while
+ <code class="computeroutput">example_type</code> is storing
+ its data within in a single byte. One can imagine the problems that arise
+ from creating a <code class="computeroutput">union</code> of
+ <code class="computeroutput">struct foo</code>
+ with a <code class="computeroutput">char</code> type.
+ 
+
+ One of the more advanced use cases for the bitfield_tuple is to create
+ a simple method for storing bit stuff pointers and other integral types
+ which may have additional bit which are not being used. Pointers which
+ are aligned to DWORD boundaries have the last to bits always zero. Those
+ last two bits can be used for storing a 2 bit integral type or two boolean
+ values. Another use case for the bit stuffing abilities of this data structure
+ is to allowing for bit stuffing of anything which may have always empty
+ bits. For instance, if an integer is always an even number then the last
+ bit is always going to be zero and that could be used for storing a boolean
+ value.
+ 
+</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 © 2010 Brian Bartman
+ 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="description.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../overview.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="../users_guide.html"><img src="../../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,79 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Reference</title>
+<link rel="stylesheet" href="../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../../bitfield_tuple/bitfield_tuple.html" title="bitfield_tuple">
+<link rel="prev" href="users_guide/glossary.html" title="Glossary">
+<link rel="next" href="reference/concepts.html" title="Concepts">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="users_guide/glossary.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../bitfield_tuple/bitfield_tuple.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="reference/concepts.html"><img src="../../images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference"></a><a class="link" href="reference.html" title="Reference">Reference</a>
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt>Concepts</dt>
+<dt><a href="reference/bitfield_tuple_class_reference.html">bitfield_tuple
+ Class Reference</a></dt>
+<dd><dl>
+<dt><a href="reference/bitfield_tuple_class_reference/bitfield_tuple_and_bitfield_reference.html">bitfield_tuple
+ and bitfield_reference</a></dt>
+<dt>padding</dt>
+<dt>member</dt>
+<dt>flag</dt>
+<dt>align</dt>
+<dt>storage</dt>
+<dt>pointer</dt>
+<dt>custom</dt>
+</dl></dd>
+<dt><a href="reference/bitfield_tuple_macro_reference.html">bitfield_tuple
+ Macro Reference</a></dt>
+<dd><dl>
+<dt><a href="reference/bitfield_tuple_macro_reference/parameter_adjustment_macros.html">Parameter
+ Adjustment macros</a></dt>
+<dt><a href="reference/bitfield_tuple_macro_reference/code_generation_macros.html">Code
+ Generation Macros</a></dt>
+</dl></dd>
+<dt><a href="reference/function_reference.html">Function
+ Reference</a></dt>
+<dd><dl>
+<dt><a href="reference/function_reference/make_bitfield_tuple.html">
+ make_bitfield_tuple Free Function</a></dt>
+<dt><a href="reference/function_reference/get.html">
+ get Free Function</a></dt>
+</dl></dd>
+<dt><a href="reference/meta_function_reference.html">Meta-Function
+ Reference</a></dt>
+<dd><dl>
+<dt><a href="reference/meta_function_reference/element.html">
+ struct element</a></dt>
+<dt><a href="reference/meta_function_reference/element_n.html">
+ struct element_n</a></dt>
+</dl></dd>
+<dt><a href="reference/boost_fusion_sequence_extension.html">Boost.Fusion
+ Sequence Extension</a></dt>
+<dt>Files</dt>
+</dl></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 © 2010 Brian Bartman
+ 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/glossary.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../bitfield_tuple/bitfield_tuple.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="reference/concepts.html"><img src="../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_class_reference.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_class_reference.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,53 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>bitfield_tuple Class Reference</title>
+<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../reference.html" title="Reference">
+<link rel="prev" href="concepts.html" title="Concepts">
+<link rel="next" href="bitfield_tuple_class_reference/bitfield_tuple_and_bitfield_reference.html" title="bitfield_tuple and bitfield_reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="concepts.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="bitfield_tuple_class_reference/bitfield_tuple_and_bitfield_reference.html"><img src="../../../images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference"></a><a class="link" href="bitfield_tuple_class_reference.html" title="bitfield_tuple Class Reference">bitfield_tuple
+ Class Reference</a>
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt><a href="bitfield_tuple_class_reference/bitfield_tuple_and_bitfield_reference.html">bitfield_tuple
+ and bitfield_reference</a></dt>
+<dt>padding</dt>
+<dt>member</dt>
+<dt>flag</dt>
+<dt>align</dt>
+<dt>storage</dt>
+<dt>pointer</dt>
+<dt>custom</dt>
+</dl></div>
+
+ This section contains information about the interface provided by the
+ <code class="computeroutput">bitfield_tuple</code> struct and
+ the different structs which can be used to compose it.
+ 
+</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 © 2010 Brian Bartman
+ 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="concepts.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="bitfield_tuple_class_reference/bitfield_tuple_and_bitfield_reference.html"><img src="../../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_class_reference/align.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_class_reference/align.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,151 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>align</title>
+<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../bitfield_tuple_class_reference.html" title="bitfield_tuple Class Reference">
+<link rel="prev" href="flag.html" title="flag">
+<link rel="next" href="storage.html" title="storage">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="flag.html"><img src="../../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../bitfield_tuple_class_reference.html"><img src="../../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../images/home.png" alt="Home"></a><a accesskey="n" href="storage.html"><img src="../../../../images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.align"></a><a class="link" href="align.html" title="align">align</a>
+</h5></div></div></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.align.description"></a><h5>
+<a name="id3234972"></a>
+ <a class="link" href="align.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.align.description">Description</a>
+ </h5>
+
+ Adjusts the next <code class="computeroutput">member</code>
+ or <code class="computeroutput">flag</code> template inside
+ of the <code class="computeroutput">bitfield_tuple</code>'s
+ template parameter to a multiple of the <code class="computeroutput">AlignTo</code>
+ parameter. If the current next position is a multiple of <code class="computeroutput">AlignTo</code> then no adjustment will be
+ made.
+ 
+<div class="note"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td align="left" valign="top">
+ Calling <code class="computeroutput">align<8></code>
+ more then once in a row will have the same effect as calling <code class="computeroutput">align<8></code>
+ once.
+ </td></tr>
+</table></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.align.template_signature"></a><h5>
+<a name="id3235117"></a>
+ <a class="link" href="align.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.align.template_signature">Template
+ Signature</a>
+ </h5>
+
+
+
+<pre class="programlisting">namespace boost { namespace bitfields {
+template <std::size_t AlignTo> struct align;
+}}
+</pre>
+
+ 
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.align.template_parameters"></a><h5>
+<a name="id3235238"></a>
+ <a class="link" href="align.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.align.template_parameters">Template
+ Parameters</a>
+ </h5>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ template Parameter
+ 
+ </th>
+<th>
+ 
+ Explanation
+ 
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ 
+ <code class="computeroutput">AlignTo</code>
+ 
+ </td>
+<td>
+ 
+ The value that the next bitfield's first bit should be a multiple
+ of.
+ 
+ </td>
+</tr></tbody>
+</table></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.align.header_file_locaton"></a><h5>
+<a name="id3235330"></a>
+ <a class="link" href="align.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.align.header_file_locaton">Header
+ file Locaton</a>
+ </h5>
+
+ This header file is included with the <boost/integer/bitfield_tuple.hpp>
+ header file.
+
+<pre class="programlisting">#include <boost/integer/details/bft/align.hpp>
+</pre>
+
+ 
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.align.example"></a><h5>
+<a name="id3235439"></a>
+ <a class="link" href="align.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.align.example">Example</a>
+ </h5>
+
+
+
+<pre class="programlisting">#include <boost/integer/bitfield_tuple.hpp>
+using namespace boost::bitfields;
+struct i;
+struct red;
+struct green;
+struct blue;
+
+typedef bitfield_tuple<
+ storage<unsigned long long>,
+ member<unsigned int,red,5>,
+ member<unsigned int, green, 6>,
+ member<unsinged int, blue,5>,
+ align<32>,
+ member<int,i,32>
+> color_plus_int;
+</pre>
+
+ With in the above example the first 3 fields are the size of a short
+ then the alignment is pushed up to the next boundary and a full sized
+ integer is then stored at the end. This actually does make accessing
+ slightly for the integer.
+ 
+</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 © 2010 Brian Bartman
+ 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="flag.html"><img src="../../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../bitfield_tuple_class_reference.html"><img src="../../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../images/home.png" alt="Home"></a><a accesskey="n" href="storage.html"><img src="../../../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_class_reference/bitfield_tuple_and_bitfield_reference.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_class_reference/bitfield_tuple_and_bitfield_reference.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,989 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>bitfield_tuple and bitfield_reference</title>
+<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../bitfield_tuple_class_reference.html" title="bitfield_tuple Class Reference">
+<link rel="prev" href="../bitfield_tuple_class_reference.html" title="bitfield_tuple Class Reference">
+<link rel="next" href="padding.html" title="padding">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../bitfield_tuple_class_reference.html"><img src="../../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../bitfield_tuple_class_reference.html"><img src="../../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../images/home.png" alt="Home"></a><a accesskey="n" href="padding.html"><img src="../../../../images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.bitfield_tuple_and_bitfield_reference"></a><a class="link" href="bitfield_tuple_and_bitfield_reference.html" title="bitfield_tuple and bitfield_reference">bitfield_tuple
+ and bitfield_reference</a>
+</h5></div></div></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.bitfield_tuple_and_bitfield_reference.bitfield_tuple_interface"></a><h5>
+<a name="id3227898"></a>
+ <a class="link" href="bitfield_tuple_and_bitfield_reference.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.bitfield_tuple_and_bitfield_reference.bitfield_tuple_interface">bitfield_tuple
+ interface</a>
+ </h5>
+
+ There are two main sections to the interface of a <code class="computeroutput">bitfield_tuple</code>.
+ The first part of a <code class="computeroutput">bitfield_tuple</code>'s
+ interface is how its specified and how those specifications effect its
+ behavior and composition. The second part of the interface is the runtime
+ portion of the interface.
+ 
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.bitfield_tuple_and_bitfield_reference.template_interface"></a><h5>
+<a name="id3227956"></a>
+ <a class="link" href="bitfield_tuple_and_bitfield_reference.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.bitfield_tuple_and_bitfield_reference.template_interface">Template
+ Interface</a>
+ </h5>
+
+ For all but one of the types used to specify a <code class="computeroutput">bitfield_tuple</code>'s
+ template parameters, order does matter, the one type which is not part
+ of the implicit ordering of a <code class="computeroutput">bitfield_tuples</code>
+ composition is the <code class="computeroutput">storage<></code> type. For more information on
+ the storage type as it relates to ordering please see documentation relating
+ to the <code class="computeroutput">storage</code> template.
+ Basically the template parameters which are of type <code class="computeroutput">flag</code>
+ and <code class="computeroutput">member</code> increment
+ the <code class="computeroutput">get</code> function accessor's
+ index by 1. (meaning that if one was to construct a bitfield tuple using
+ a flag followed by a <code class="computeroutput">filler</code>,
+ followed by a <code class="computeroutput">member</code>,
+ than the index for the <code class="computeroutput">flag</code>
+ would be 0 and the index for the <code class="computeroutput">member</code>
+ would be 1 because <code class="computeroutput">filler</code>
+ doesn't have a value associated with it).
+ 
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.bitfield_tuple_and_bitfield_reference.runtime_support_interface"></a><h5>
+<a name="id3228134"></a>
+ <a class="link" href="bitfield_tuple_and_bitfield_reference.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.bitfield_tuple_and_bitfield_reference.runtime_support_interface">Runtime
+ Support Interface</a>
+ </h5>
+
+ The runtime interface of a <code class="computeroutput">bitfield_tuple</code>
+ is composed of the basic tuple interface, that being it is default and
+ copy constructible, and provids the regular <code class="computeroutput">get</code>
+ funtions which a tuple does. The two main difference between the boost.tuple
+ and the <code class="computeroutput">bitfield_tuple</code>
+ are as follows: First, the <code class="computeroutput">bitfield_tuple</code>
+ doesn't return references to its data members it has to return a proxy
+ to them. Second, the bitfield_tuple provides an additional <code class="computeroutput">get</code> function which uses a name or empty
+ struct to access internal data elements (the <code class="computeroutput">bitfield_tuple</code>
+ still provides the regular <code class="computeroutput">get<Index>()</code> by index function as boost.tuple).
+ 
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.bitfield_tuple_and_bitfield_reference.include_files"></a><h6>
+<a name="id3228265"></a>
+ <a class="link" href="bitfield_tuple_and_bitfield_reference.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.bitfield_tuple_and_bitfield_reference.include_files">Include
+ Files</a>
+ </h6>
+
+ Header file:
+
+<pre class="programlisting">#include <boost/bitfield_tuple.hpp>
+</pre>
+
+ Forward declaration file:
+
+<pre class="programlisting">#include <boost/bitfield_tuple_fwd.hpp>
+</pre>
+
+ 
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.bitfield_tuple_and_bitfield_reference.template_signature"></a><h6>
+<a name="id3228387"></a>
+ <a class="link" href="bitfield_tuple_and_bitfield_reference.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.bitfield_tuple_and_bitfield_reference.template_signature">Template
+ Signature</a>
+ </h6>
+
+
+
+<pre class="programlisting">namespace boost { namespace bitfields {
+template <typename... Args> struct bitfield_tuple;
+}}
+</pre>
+
+ For additional information on creating specilizations over the <code class="computeroutput">bitfield_tuple</code>'s implementation documentation
+ reguarding macros.
+ 
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.bitfield_tuple_and_bitfield_reference.typedefs"></a><h6>
+<a name="id3228523"></a>
+ <a class="link" href="bitfield_tuple_and_bitfield_reference.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.bitfield_tuple_and_bitfield_reference.typedefs">Typedefs</a>
+ </h6>
+
+ <code class="computeroutput">N</code> is used to represent
+ a <code class="computeroutput">bitfield_tuple</code>.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Type
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::members</code>
+ 
+ </td>
+<td>
+ 
+ This is an boost.mpl sequence, specifically <code class="computeroutput">mpl::vector</code>.
+ <code class="computeroutput">members</code> holds
+ the information about the different member within the bitfield_tuple.
+ The only reason this is part of the public interface is so
+ that the fusion sequence can be made to work correctly. One
+ should never have to use the <code class="computeroutput">members</code>
+ type directly, however, if you must the elements contained
+ within are of type <code class="computeroutput">bitfeild_element</code>
+ mentioned more in the implementation section.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::storage_type</code>
+ 
+ </td>
+<td>
+ 
+ The integral type being used to store bitfields within the
+ <code class="computeroutput">bitfield_tuple</code>.
+ For more information about how this type is either deduced
+ or supplied see the <code class="computeroutput">struct
+ storage</code> section of
+ the class reference documentation.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::bits_used</code>
+ 
+ </td>
+<td>
+ 
+ The number of bits offset by the fields supplied by the user.
+ Bits used is of type <code class="computeroutput">mpl::size_t<M></code> where <code class="computeroutput">M</code>
+ is the sum of the bits use by all bitfields and filler bits
+ within the <code class="computeroutput">bitfield_tuple</code>.
+ This is also the index of of the first bit of the next bitfield
+ that would be added into the <code class="computeroutput">bitfield_tuple</code>.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.bitfield_tuple_and_bitfield_reference.template_members"></a><h6>
+<a name="id3228884"></a>
+ <a class="link" href="bitfield_tuple_and_bitfield_reference.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.bitfield_tuple_and_bitfield_reference.template_members">Template
+ Members</a>
+ </h6>
+
+ The <code class="computeroutput">bitfield_reference</code>
+ type is responsible for acting as the proxy reference type into the storage
+ of a <code class="computeroutput">bitfield_tuple</code>.
+ This works similar to the proxy reference type supplied by <code class="computeroutput">std::vector<bool></code>
+ specilization.
+ 
+<div class="note"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td align="left" valign="top">
+ If one wishes to work with the reference direcrly please not that the
+ <code class="computeroutput">const</code>'ness of the <code class="computeroutput">BitfieldElement</code> template parameter
+ is used to specify if reference type is a const or non const type.
+ This is due to construction of the structure which is repsonsible to
+ extracting or storing data within each bitfield.
+ </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="../../../../images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td align="left" valign="top">
+ The <code class="computeroutput">bitfieldElement</code>
+ type is also used to specify the bitfield to retrieve and store data
+ within.
+ </td></tr>
+</table></div>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Name
+ 
+ </th>
+<th>
+ 
+ Signature
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ 
+ <code class="computeroutput">bitfield_reference</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">N::template <typename BitfieldElement> bitfield_reference;</code>
+ 
+ </td>
+<td>
+ 
+ This is the proxy reference type use to create a fake reference
+ to a bitfield within the bitfield_tuple.
+ 
+ </td>
+</tr></tbody>
+</table></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.bitfield_tuple_and_bitfield_reference.bitfield_reference_internal_types"></a><h6>
+<a name="id3229157"></a>
+ <a class="link" href="bitfield_tuple_and_bitfield_reference.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.bitfield_tuple_and_bitfield_reference.bitfield_reference_internal_types">bitfield_reference
+ Internal Types</a>
+ </h6>
+
+ <code class="computeroutput">ref</code> refers to a <code class="computeroutput">bitfield_reference</code> type
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Type
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">ref::return_type</code>
+ 
+ </td>
+<td>
+ 
+ The return type specified by the user, via either a member
+ or flag parameter.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">ref::storage_t</code>
+ 
+ </td>
+<td>
+ 
+ The storage type with the same <code class="computeroutput">const</code>
+ ness as the <code class="computeroutput">BitfieldElement</code>
+ template parameter.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">ref::field_type</code>
+ 
+ </td>
+<td>
+ 
+ The <code class="computeroutput">boost::integer::bitfield</code> that relates to
+ the data you are storing within the integral value. This is
+ the type which does the actual retrieval and storage of data
+ into and from the <code class="computeroutput">bitfield_tuple</code>.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.bitfield_tuple_and_bitfield_reference.bitfield_reference_constructors"></a><h6>
+<a name="id3229424"></a>
+ <a class="link" href="bitfield_tuple_and_bitfield_reference.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.bitfield_tuple_and_bitfield_reference.bitfield_reference_constructors">bitfield_reference
+ constructors</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Name
+ 
+ </th>
+<th>
+ 
+ Constructor Signature
+ 
+ </th>
+<th>
+ 
+ Exception Safty
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ Reference Constructor
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">explicit bitfield_reference(storage_t& field)</code>
+ 
+ </td>
+<td>
+ 
+ TBD
+ 
+ </td>
+<td>
+ 
+ Just like a reference the bitfield_reference is constrctible
+ over the type it references.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Copy Constructor
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">bitfield_reference( bitfield_reference
+ const&
+ x)</code>
+ 
+ </td>
+<td>
+ 
+ TBD
+ 
+ </td>
+<td>
+ 
+ Copy makes a copy of the reference inside of <code class="computeroutput">x</code>.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.bitfield_tuple_and_bitfield_reference.bitfield_reference_operators"></a><h6>
+<a name="id3229661"></a>
+ <a class="link" href="bitfield_tuple_and_bitfield_reference.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.bitfield_tuple_and_bitfield_reference.bitfield_reference_operators">bitfield_reference
+ operators</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Name
+ 
+ </th>
+<th>
+ 
+ Signature
+ 
+ </th>
+<th>
+ 
+ Exception Safty
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ Implicit Conversion Operator
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">inline operator
+ return_type()
+ const</code>
+ 
+ </td>
+<td>
+ 
+ TBD
+ 
+ </td>
+<td>
+ 
+ Allows the <code class="computeroutput">bitfield_reference</code>
+ type to be treated as though it is the <code class="computeroutput">return_type</code>.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Assignment Operator
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">bitfield_reference
+ const&
+ operator=(return_type const& rhs)</code>
+ 
+ </td>
+<td>
+ 
+ TBD
+ 
+ </td>
+<td>
+ 
+ takes the value <code class="computeroutput">rhs</code>
+ and stores its value in the corrosponding bitfield in the storage
+ of the <code class="computeroutput">bitfield_tuple</code>.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.bitfield_tuple_and_bitfield_reference.constructors"></a><h6>
+<a name="id3229939"></a>
+ <a class="link" href="bitfield_tuple_and_bitfield_reference.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.bitfield_tuple_and_bitfield_reference.constructors">Constructors</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Name
+ 
+ </th>
+<th>
+ 
+ Constructor Signature
+ 
+ </th>
+<th>
+ 
+ Exception Safty
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ Value Constructor
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">explicit bitfield_tuple(storage_type
+ x =
+ 0)</code>
+ 
+ </td>
+<td>
+ 
+ No Throw
+ 
+ </td>
+<td>
+ 
+ This constructor acts as both a default constructor and allows
+ for construction over the storage type. This constructor is
+ one way of giving a <code class="computeroutput">bitfield_tuple</code>
+ an initial value.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Copy Constructor
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">bitfield_tuple( bitfield_tuple
+ const&
+ x )</code>
+ 
+ </td>
+<td>
+ 
+ No Throw
+ 
+ </td>
+<td>
+ 
+ Copies the value from <code class="computeroutput">x</code>
+ into the current <code class="computeroutput">bitfield_tuple</code>.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.bitfield_tuple_and_bitfield_reference.operators"></a><h6>
+<a name="id3230205"></a>
+ <a class="link" href="bitfield_tuple_and_bitfield_reference.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.bitfield_tuple_and_bitfield_reference.operators">Operators</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Name
+ 
+ </th>
+<th>
+ 
+ Signature
+ 
+ </th>
+<th>
+ 
+ Exception Safty
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ Value Assignment Operator
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">bitfield_tuple const&
+ operator=(
+ storage_type const&)</code>
+ 
+ </td>
+<td>
+ 
+ No Throw
+ 
+ </td>
+<td>
+ 
+ Assigns a new value to the internal storage of the <code class="computeroutput">bitfield_tuple</code>.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Copy Assignment Operator
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">bitfield_tuple const&
+ operator=(
+ bitfield_tuple const&)</code>
+ 
+ </td>
+<td>
+ 
+ No Throw
+ 
+ </td>
+<td>
+ 
+ Assigns a new value to the internal storage of the <code class="computeroutput">bitfield_tuple</code>.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.bitfield_tuple_and_bitfield_reference.member_functions"></a><h6>
+<a name="id3230464"></a>
+ <a class="link" href="bitfield_tuple_and_bitfield_reference.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.bitfield_tuple_and_bitfield_reference.member_functions">Member
+ functions</a>
+ </h6>
+<div class="note"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td align="left" valign="top">
+ All of the <code class="computeroutput">bitfield_reference</code>
+ types returned by the <code class="computeroutput">get</code>
+ functions listed below are deduced at compile time so they are ommited
+ for clarity.
+ </td></tr>
+</table></div>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Signature
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">storage_type data(
+ ) const</code>
+ 
+ </td>
+<td>
+ 
+ This returns a copy of the internal storage from within a bitfield
+ tuple.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">template <typename Name></code> <code><code class="computeroutput">bitfield_reference</code> type</code>
+ <code class="computeroutput">get()</code>
+ 
+ </td>
+<td>
+ 
+ Returns a reference type corrisponding to the field stored
+ with <code class="computeroutput">Name</code> specified
+ in the template parameters.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">template <typename Name></code> <code><code class="computeroutput">bitfield_reference</code> type</code>
+ <code class="computeroutput">get()
+ const</code>
+ 
+ </td>
+<td>
+ 
+ Const version of the above function.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">template <std::size_t Index></code> <code><code class="computeroutput">bitfield_reference</code> type</code>
+ <code class="computeroutput">get()</code>
+ 
+ </td>
+<td>
+ 
+ This is the same as the boost.tuple get function. The only
+ difference is that it returns a proxy reference type.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">template <std::size_t Index></code> <code><code class="computeroutput">bitfield_reference</code> type</code>
+ <code class="computeroutput">get()
+ const</code>
+ 
+ </td>
+<td>
+ 
+ Const version of the above function.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.bitfield_tuple_and_bitfield_reference.preconditions_on_the_bitfield_tuple_template"></a><h6>
+<a name="id3230959"></a>
+ <a class="link" href="bitfield_tuple_and_bitfield_reference.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.bitfield_tuple_and_bitfield_reference.preconditions_on_the_bitfield_tuple_template">Preconditions
+ on the bitfield_tuple template</a>
+ </h6>
+
+ The following is a list of documented and/or enforeced preconditions
+ for constructing a <code class="computeroutput">bitfield_tuple</code>.
+ All of the preconditions will be noted as either being documentation
+ only or enfocred. For documentation only preconditions please treat them
+ as recomended usage of a <code class="computeroutput">bitfield_tuple</code>,
+ if you do not follow the documentation only preconditions the <code class="computeroutput">bitfield_tuple</code> may not behave as you
+ intend. All enforced preconditions if violated will result in compilation
+ failure normally resulting from a static assertion, look up failure or
+ an error message generated by <code class="computeroutput">#error</code>.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Precondition
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+<th>
+ 
+ Enfocement
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ The storage policy must not be specified more then once within
+ the template parameters of bitfield_tuple template.
+ 
+ </td>
+<td>
+ 
+ Don't supply multiple <code class="computeroutput">storage<></code> parameters to the
+ <code class="computeroutput">bitfield_tuple</code>.
+ 
+ </td>
+<td>
+ 
+ Enforced by static assert
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ A member or flag can not have the same name type as another
+ member or flag
+ 
+ </td>
+<td>
+ 
+ Don't supply <code class="computeroutput">memeber<int,red,1></code> and <code class="computeroutput">flag<red></code> to the same <code class="computeroutput">bitfield_tuple</code> template.
+ 
+ </td>
+<td>
+ 
+ Enforced by static assert
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ A <code class="computeroutput">member</code> can
+ not have a width of 0.
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">member<int,red,0></code>
+ will result in an error.
+ 
+ </td>
+<td>
+ 
+ Enforced by static assert
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ The width of a member can not exceed the width, in bits, of
+ its return type.
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">member<int,red,33></code>
+ will result in an error.
+ 
+ </td>
+<td>
+ 
+ Enforced by static assert
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ The total width of the sum of all bit fields must not exceed
+ the bit width of the storage type.
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">bitfield_tuple<member<int,red,20>, member<int,blue,21>, storage<int> >
+ bft</code> Will result in
+ an error. Please see documentation for storage type for behavior
+ when a storage type is not specified by the user as this behavior
+ still applies in that situation.
+ 
+ </td>
+<td>
+ 
+ Enforced by Static Assert
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">BOOST_BFT_PARAM_COUNT</code>
+ must not exceed 50.
+ 
+ </td>
+<td>
+ 
+ Don't set the <code class="computeroutput">BOOST_BFT_PARAM_COUNT</code>
+ to a value higher then 50. This is because the <code class="computeroutput">mpl::vector</code> doesn't support more
+ then 50 parameters. Please see documentation <code class="computeroutput">BOOST_BFT_PARAM_COUNT</code> under
+ macro reference section for additional information regarding
+ the <code class="computeroutput">BOOST_BFT_PARAM_COUNT</code>
+ macro.
+ 
+ </td>
+<td>
+ 
+ Enforced by macro error message.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Don't set <code class="computeroutput">BOOST_MPL_LIMIT_VECTOR_SIZE</code>
+ to be less then <code class="computeroutput">BOOST_BFT_PARAM_COUNT</code>.
+ 
+ </td>
+<td>
+ 
+ If <code class="computeroutput">BOOST_MPL_LIMIT_VECTOR_SIZE</code>
+ is set and <code class="computeroutput">BOOST_BFT_PARAM_COUNT</code>
+ is set and <code class="computeroutput">BOOST_MPL_LIMIT_VECTOR_SIZE</code>
+ < <code class="computeroutput">BOOST_BFT_PARAM_COUNT</code>
+ is true, it is impossible for the <code class="computeroutput">bitfield_tuple</code>
+ to store all of its parameters inside of the <code class="computeroutput">mpl::vector</code>.
+ 
+ </td>
+<td>
+ 
+ Enforced by macro error message.
+ 
+ </td>
+</tr>
+</tbody>
+</table></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 © 2010 Brian Bartman
+ 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="../bitfield_tuple_class_reference.html"><img src="../../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../bitfield_tuple_class_reference.html"><img src="../../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../images/home.png" alt="Home"></a><a accesskey="n" href="padding.html"><img src="../../../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_class_reference/custom.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_class_reference/custom.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,536 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>custom</title>
+<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../bitfield_tuple_class_reference.html" title="bitfield_tuple Class Reference">
+<link rel="prev" href="pointer.html" title="pointer">
+<link rel="next" href="../bitfield_tuple_macro_reference.html" title="bitfield_tuple Macro Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="pointer.html"><img src="../../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../bitfield_tuple_class_reference.html"><img src="../../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../images/home.png" alt="Home"></a><a accesskey="n" href="../bitfield_tuple_macro_reference.html"><img src="../../../../images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.custom"></a><a class="link" href="custom.html" title="custom">custom</a>
+</h5></div></div></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.custom.description"></a><h5>
+<a name="id3239190"></a>
+ <a class="link" href="custom.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.custom.description">Description</a>
+ </h5>
+
+ The <code class="computeroutput">custom</code> member is
+ a template which is used to do to integers what <code class="computeroutput">pointer</code>
+ does to pointers. That being said, the custom class allows for semi-intrusive
+ behavior with regards to the storage of <code class="computeroutput">bitfield_tuple</code>.
+ In the simplest use cases the <code class="computeroutput">custom</code>
+ member will only ever take three template parameters and will use the
+ default policy which is supplied.
+ 
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.custom.template_signature"></a><h5>
+<a name="id3239265"></a>
+ <a class="link" href="custom.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.custom.template_signature">Template
+ Signature</a>
+ </h5>
+
+
+
+<pre class="programlisting">namespace boost { namespace bitfields {
+template <
+ typename ReturnType,
+ typename Name,
+ typename Mask,
+ template <typename, typename, typename, typename>
+ class Policy = detail::custom_packing_policy
+>
+struct custom;
+}}
+</pre>
+
+ 
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.custom.template_parameters"></a><h5>
+<a name="id3239504"></a>
+ <a class="link" href="custom.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.custom.template_parameters">Template
+ Parameters</a>
+ </h5>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ template Parameter
+ 
+ </th>
+<th>
+ 
+ Explanation
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">ReturnType</code>
+ 
+ </td>
+<td>
+ 
+ The type that the value is to be returned from the get function
+ as.You may supply a signed type for a member but please note
+ that a singed bit will be stored within the width you specify,
+ so if you don't need negative values you should not store them.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">Name</code>
+ 
+ </td>
+<td>
+ 
+ This is a type which is associated with the bitfield which
+ is represented by this member template.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">Mask</code>
+ 
+ </td>
+<td>
+ 
+ This is a mask which minimally defines the following two <code class="computeroutput">typedef</code>s and static constant:
+ <code class="computeroutput">Mask::type</code>, <code class="computeroutput">Mask::value_type</code>,
+ and <code class="computeroutput">Mask::value</code>. There are masking
+ utilities which are included with <code class="computeroutput">bitfield_tuple</code>
+ which make using this parameter easier.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">Policy</code>
+ 
+ </td>
+<td>
+ 
+ See below in the <code class="computeroutput">Policy</code>
+ Section of this page. Default behavior is to apply the Mask
+ to the incoming information and extract it, shift the new information
+ to the correct location of the bitfield within the <code class="computeroutput">bitfield_tuples</code> storage.
+ The next step is to take the complement of the current shifted
+ mask and & that with the storage, and | that with the shifted
+ value then store that in the <code class="computeroutput">bitfield_tuple</code>'s
+ storage. The similar is done to get the information out of
+ the <code class="computeroutput">bitfield_tuple</code>'s
+ storage. For MOST cases this will NOT
+ have to be used and the default case will work just fine.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.custom.preconditions"></a><h4>
+<a name="id3239832"></a>
+ <a class="link" href="custom.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.custom.preconditions">Preconditions</a>
+ </h4>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Precondition
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+<th>
+ 
+ Enforcement
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">Mask::value !=
+ 0</code>
+ 
+ </td>
+<td>
+ 
+ The value associated with the mask can not be zero.
+ 
+ </td>
+<td>
+ 
+ Enforced by static assert.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">Name</code> must be
+ unique.
+ 
+ </td>
+<td>
+ 
+ The <code class="computeroutput">Name</code> template
+ parameter can only be supplied once per <code class="computeroutput">bitfield_tuple</code>.
+ 
+ </td>
+<td>
+ 
+ Enforced by static assert.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.custom.header_file_location"></a><h5>
+<a name="id3240010"></a>
+ <a class="link" href="custom.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.custom.header_file_location">Header
+ file Location</a>
+ </h5>
+
+ This header file is included with the <boost/integer/bitfield_tuple.hpp>
+ header file.
+
+<pre class="programlisting">#include <boost/integer/details/bft/custom.hpp>
+</pre>
+
+ 
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.custom.examples"></a><h5>
+<a name="id3240120"></a>
+ <a class="link" href="custom.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.custom.examples">Examples</a>
+ </h5>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.custom.using_a__code__phrase_role__identifier__custom__phrase___code__member_to_store_the_16_most_significant_bits_of_an_integer"></a><h6>
+<a name="id3240144"></a>
+ <a class="link" href="custom.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.custom.using_a__code__phrase_role__identifier__custom__phrase___code__member_to_store_the_16_most_significant_bits_of_an_integer">Using
+ a <code class="computeroutput">custom</code> member to store
+ the 16 most significant bits of an integer</a>
+ </h6>
+
+
+
+<pre class="programlisting">#include <boost/integer/bifield_tuple.hpp>
+
+using namespace boost::bitifields;
+typedef boost::high_bits_mask<unsigned int, 16> top16bits;
+struct int1;
+struct int2;
+typedef bitfield_tuple<
+ storage<unsigned int>,
+ custom<unsigned int, int1, top16bits>,
+ member<unsigned int, int2, 16>
+> two_different_halves;
+</pre>
+
+ <code class="computeroutput">custom</code> members are accessed
+ just the same as every other member within a <code class="computeroutput">bitfield_tuple</code>
+ by simply using the get function followed by its index or <code class="computeroutput">Name</code>.
+ 
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.custom.how_to_define_a_policy_for_a_custom_member"></a><h5>
+<a name="id3240550"></a>
+ <a class="link" href="custom.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.custom.how_to_define_a_policy_for_a_custom_member">How
+ to Define a Policy For a Custom Member</a>
+ </h5>
+
+ As stated before, if the previous case works for you then this is unnecessary.
+ Defining a policy is only necessary when you need to do custom packing
+ of a type before it's stored and custom unpack before it's returned.
+ Custom packing means that you are storing a mass of normally non contiguous
+ bits in a contiguous manner and expanding them to be non-contiguous afterwards.
+ 
+
+ The template signature of a policy, as seen above in the template parameters,
+ table takes 4 arguments. Here is what to expect for each of those template
+ arguments.
+
+<pre class="programlisting">template <typename Mask, typename ValueType, typename Offset, typename Width>
+struct my_policy;
+</pre>
+
+ 
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.custom.policy_parameter_description"></a><h6>
+<a name="id3240692"></a>
+ <a class="link" href="custom.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.custom.policy_parameter_description">Policy
+ Parameter Description</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Parameter Name
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">Mask</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">Mask</code> is the
+ template parameter which was supplied to the <code class="computeroutput">custom</code> member as a <code class="computeroutput">Mask</code>.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">ValueType</code>
+ 
+ </td>
+<td>
+ 
+ This is the type which was supplied to the <code class="computeroutput">custom</code>
+ template as the <code class="computeroutput">ReturnType</code>.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">Offset</code>
+ 
+ </td>
+<td>
+ 
+ This of type <code class="computeroutput">mpl::size_t<</code>Implementation
+ Defined<code class="computeroutput">></code>
+ which is used to denote the number of bits from the least significant
+ bit the field is supposed to be.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">Width</code>
+ 
+ </td>
+<td>
+ 
+ This of type <code class="computeroutput">mpl::size_t<</code>Implementation
+ Defined<code class="computeroutput">></code>.
+ The width is deduced from the mask supplied to the <code class="computeroutput">bitfield_tuple</code> based on leading
+ and trailing zeros within <code class="computeroutput">Mask</code>.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.custom.policy_body"></a><h6>
+<a name="id3241022"></a>
+ <a class="link" href="custom.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.custom.policy_body">Policy
+ Body</a>
+ </h6>
+
+ The body of the class template must contain the following <code class="computeroutput">typedef</code> and member template.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Type
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">value_type</code>
+ 
+ </td>
+<td>
+ 
+ This is the ValueType which was supplied to the policy. If
+ the <code class="computeroutput">typedef</code> isn't
+ the same as ValueType it could cause problems however there
+ is nothing enforcing this. So if you attempt to specify a different
+ type for value_type then ValueType do so at your own risk.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">template<typename StorageType> struct
+ apply;</code>
+ 
+ </td>
+<td>
+ 
+ Because at the time the policy is being instantiated and kept
+ for later use the type of the storage may not be known yet.
+ It has to be passed in at a later time. The <code class="computeroutput">StorageType</code>
+ in the apply member template refers to the integral type which
+ the <code class="computeroutput">bitfield_tuple</code>
+ is using for storing its bitfields.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<div class="tip"><table border="0" summary="Tip">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="../../../../images/tip.png"></td>
+<th align="left">Tip</th>
+</tr>
+<tr><td align="left" valign="top">
+ I recommend that if you wish to specialize the policy you do so by
+ having the <code class="computeroutput">template<typename StorageType> struct
+ apply;</code>
+ inherit something which takes all five template parameters in scope:
+ <code class="computeroutput">Mask</code>, <code class="computeroutput">ValueType</code>, <code class="computeroutput">Offset</code>,
+ <code class="computeroutput">Width</code> and <code class="computeroutput">StorageType</code> and then define the necessary
+ two static functions there.
+ </td></tr>
+</table></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.custom.the__code__phrase_role__identifier__apply__phrase___code__member_template"></a><h6>
+<a name="id3241342"></a>
+ <a class="link" href="custom.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.custom.the__code__phrase_role__identifier__apply__phrase___code__member_template">The
+ <code class="computeroutput">apply</code> member template</a>
+ </h6>
+
+ The apply member template is where the actual magic happens so to speak.
+ The apply template defines two static functions. The two static functions
+ are what is called to preform the actual storage and retrieval of the
+ bitfield itself.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Static Function
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">static StorageType
+ set(StorageType storage, ValueType
+ value);</code>
+ 
+ </td>
+<td>
+ 
+ This function is used to set the value of the bitfield and
+ store it inside of storage then return storage. The returned
+ storage is set to the storage which <code class="computeroutput">bitfield_tuple</code>
+ uses.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">static ValueType
+ get(StorageType storage);</code>
+ 
+ </td>
+<td>
+ 
+ Retrieves the value of from <code class="computeroutput">storage</code>
+ which is the actual storage from within <code class="computeroutput">bitfield_tuple</code>
+ and returns the value of the bitfield.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.custom.completed_policy_structure_"></a><h6>
+<a name="id3241594"></a>
+ <a class="link" href="custom.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.custom.completed_policy_structure_">Completed
+ Policy Structure </a>
+ </h6>
+
+ Example of what a completed policy will need to look like.
+
+<pre class="programlisting">template <typename Mask, typename ValueType, typename Offset, typename Width>
+struct my_policy {
+
+ typedef ValueType value_type;
+
+ template <typename StorageType>
+ struct apply {
+ static ValueType get(StorageType storage);
+ static StorageType set(StorageType storage, ValueType value);
+ };
+};
+</pre>
+
+ 
+</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 © 2010 Brian Bartman
+ 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="pointer.html"><img src="../../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../bitfield_tuple_class_reference.html"><img src="../../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../images/home.png" alt="Home"></a><a accesskey="n" href="../bitfield_tuple_macro_reference.html"><img src="../../../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_class_reference/flag.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_class_reference/flag.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,204 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>flag</title>
+<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../bitfield_tuple_class_reference.html" title="bitfield_tuple Class Reference">
+<link rel="prev" href="member.html" title="member">
+<link rel="next" href="align.html" title="align">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="member.html"><img src="../../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../bitfield_tuple_class_reference.html"><img src="../../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../images/home.png" alt="Home"></a><a accesskey="n" href="align.html"><img src="../../../../images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.flag"></a><a class="link" href="flag.html" title="flag">flag</a>
+</h5></div></div></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.flag.description"></a><h5>
+<a name="id3233856"></a>
+ <a class="link" href="flag.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.flag.description">Description</a>
+ </h5>
+
+ <code class="computeroutput">flag</code> is used to specify
+ a boolean member of width one. This is a simplification of <code class="computeroutput">member<bool,NameType,1></code> and
+ does the exact same thing.
+ 
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.flag.template_signature"></a><h5>
+<a name="id3233940"></a>
+ <a class="link" href="flag.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.flag.template_signature">Template
+ Signature</a>
+ </h5>
+
+
+
+<pre class="programlisting">namespace boost { namespace bitfields {
+template <typename Name> struct flag;
+}}
+</pre>
+
+ 
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.flag.template_parameters"></a><h5>
+<a name="id3234057"></a>
+ <a class="link" href="flag.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.flag.template_parameters">Template
+ Parameters</a>
+ </h5>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ template Parameter
+ 
+ </th>
+<th>
+ 
+ Explanation
+ 
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ 
+ <code class="computeroutput">Name</code>
+ 
+ </td>
+<td>
+ 
+ This is the name which can be used to access the template parameter
+ using the get function.
+ 
+ </td>
+</tr></tbody>
+</table></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.flag.preconditions"></a><h4>
+<a name="id3234147"></a>
+ <a class="link" href="flag.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.flag.preconditions">Preconditions</a>
+ </h4>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Precondition
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+<th>
+ 
+ Enforcement
+ 
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ 
+ <code class="computeroutput">Name</code> must be
+ unique.
+ 
+ </td>
+<td>
+ 
+ The <code class="computeroutput">Name</code> template
+ parameter can only be supplied once per <code class="computeroutput">bitfield_tuple</code>.
+ 
+ </td>
+<td>
+ 
+ Enforced by static assert.
+ 
+ </td>
+</tr></tbody>
+</table></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.flag.header_file_location"></a><h5>
+<a name="id3234270"></a>
+ <a class="link" href="flag.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.flag.header_file_location">Header
+ File Location</a>
+ </h5>
+
+ This header file is included with the <boost/integer/bitfield_tuple.hpp>
+ header file.
+
+<pre class="programlisting">#include <boost/integer/details/bft/flag.hpp>
+</pre>
+
+ 
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.flag.example"></a><h5>
+<a name="id3234379"></a>
+ <a class="link" href="flag.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.flag.example">Example</a>
+ </h5>
+
+ This is the simplification which <code class="computeroutput">flag</code>
+ makes in comparison to writing the same thing using the <code class="computeroutput">member</code> template.
+
+<pre class="programlisting">struct b;
+
+typedef bitfield_tuple<
+ flag<b>
+> bitfield_tuple_1;
+
+
+typedef btifield_tuple<
+ member<bool,b,1>
+> bitfield_tuple_2;
+</pre>
+
+ 
+
+ Example of how to use <code class="computeroutput">flag</code>
+ within the declaration of a <code class="computeroutput">bitfield_tuple</code>
+ template.
+
+<pre class="programlisting">#include <boost/integer/bitfield_tuple.hpp>
+
+using namespace boost::bitfields;
+
+struct b0;
+struct b1;
+struct b2;
+struct b3;
+struct something;
+
+typedef btifield_tuple<
+ flag<b0>,
+ flag<b1>,
+ flag<b2>,
+ flag<b3>,
+ member<unsigned int, something,4>
+> int_bool_size_char;
+</pre>
+
+ The above type is used to represent a char which is split between 4
+ <code class="computeroutput">bool</code> values and a 4 bit
+ <code class="computeroutput">unsigned int</code>
+ 
+</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 © 2010 Brian Bartman
+ 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="member.html"><img src="../../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../bitfield_tuple_class_reference.html"><img src="../../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../images/home.png" alt="Home"></a><a accesskey="n" href="align.html"><img src="../../../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_class_reference/member.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_class_reference/member.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,263 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>member</title>
+<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../bitfield_tuple_class_reference.html" title="bitfield_tuple Class Reference">
+<link rel="prev" href="padding.html" title="padding">
+<link rel="next" href="flag.html" title="flag">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="padding.html"><img src="../../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../bitfield_tuple_class_reference.html"><img src="../../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../images/home.png" alt="Home"></a><a accesskey="n" href="flag.html"><img src="../../../../images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.member"></a><a class="link" href="member.html" title="member">member</a>
+</h5></div></div></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.member.description"></a><h5>
+<a name="id3232619"></a>
+ <a class="link" href="member.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.member.description">Description</a>
+ </h5>
+
+ <code class="computeroutput">member</code> is used for specifying
+ different bitfields within a <code class="computeroutput">bitfield_tuple</code>.
+ A <code class="computeroutput">member</code> is meant to
+ look like a bitfield when it is declared within a <code class="computeroutput">class</code>
+ or <code class="computeroutput">struct</code>. A <code class="computeroutput">member</code> is the most basic type of bitfield
+ that can be used for a <code class="computeroutput">bitfield_tuple</code>.
+ When other templates used to specify a <code class="computeroutput">bitfield_tuple</code>
+ are noted as members, it means they have storage space as a bitfield
+ within the <code class="computeroutput">bitfield_tuple</code>.
+ 
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.member.template_signature"></a><h5>
+<a name="id3232748"></a>
+ <a class="link" href="member.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.member.template_signature">Template
+ Signature</a>
+ </h5>
+
+
+
+<pre class="programlisting">namespace boost { namespace bitfields {
+template <typename ReturnType, typename NameType, std::size_t Width> struct member;
+}}
+</pre>
+
+ 
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.member.template_parameters"></a><h5>
+<a name="id3232907"></a>
+ <a class="link" href="member.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.member.template_parameters">Template
+ Parameters</a>
+ </h5>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ template Parameter
+ 
+ </th>
+<th>
+ 
+ Explanation
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">ReturnType</code>
+ 
+ </td>
+<td>
+ 
+ The type that the value is to be returned from the get function
+ as.You may supply a signed type for a member but please note
+ that a singed bit will be stored within the width you specify,
+ so if you don't need negative values you should not store them.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">NameType</code>
+ 
+ </td>
+<td>
+ 
+ This is a type which is associated with the bitfield which
+ is represented by this member template. All names supplied
+ to a <code class="computeroutput">bitfield_tuple</code>
+ can only be used one per <code class="computeroutput">bitfield_tuple</code>.
+ The is enforced as a precondition.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">Width</code>
+ 
+ </td>
+<td>
+ 
+ The number of bits you would like associated with the field
+ represented by the <code class="computeroutput">member</code>
+ template.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.member.preconditions"></a><h4>
+<a name="id3233099"></a>
+ <a class="link" href="member.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.member.preconditions">Preconditions</a>
+ </h4>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Precondition
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+<th>
+ 
+ Enforcement
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">Width !=
+ 0</code>
+ 
+ </td>
+<td>
+ 
+ The <code class="computeroutput">Width</code> template
+ parameter must not be zero.
+ 
+ </td>
+<td>
+ 
+ Enforced by static assert.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">Width <=
+ bit_width<ReturnType>::value</code>
+ 
+ </td>
+<td>
+ 
+ The <code class="computeroutput">Width</code> parameter
+ of <code class="computeroutput">member</code> must
+ not exceed the width in bits of <code class="computeroutput">ReturnType</code>
+ template parameter.
+ 
+ </td>
+<td>
+ 
+ Enforced by static assert.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">NameType</code> must
+ be unique.
+ 
+ </td>
+<td>
+ 
+ The <code class="computeroutput">NameType</code>
+ template parameter can only be supplied once per <code class="computeroutput">bitfield_tuple</code>.
+ 
+ </td>
+<td>
+ 
+ Enforced by static assert.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.member.header_file_location"></a><h5>
+<a name="id3233379"></a>
+ <a class="link" href="member.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.member.header_file_location">Header
+ file Location</a>
+ </h5>
+
+ This header file is included with the <boost/integer/bitfield_tuple.hpp>
+ header file.
+
+<pre class="programlisting">#include <boost/integer/details/bft/member.hpp>
+</pre>
+
+ 
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.member.example"></a><h5>
+<a name="id3233488"></a>
+ <a class="link" href="member.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.member.example">Example</a>
+ </h5>
+
+
+
+<pre class="programlisting">#include <boost/integer/bitfield_tuple.hpp>
+
+using namespace boost::bitfields;
+
+struct red;
+struct green;
+struct salmon;
+
+typedef bitfield_tuple<
+ member<char,red,4>,
+ member<unsigned char, green,5>,
+ member<int, salmon, 16>
+> color_tuple;
+</pre>
+
+ The <code class="computeroutput">member</code>s specified
+ in <code class="computeroutput">color_tuple</code> above
+ are used to specify the different bitfields within the <code class="computeroutput">bitfield_tuple</code>.
+ 
+</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 © 2010 Brian Bartman
+ 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="padding.html"><img src="../../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../bitfield_tuple_class_reference.html"><img src="../../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../images/home.png" alt="Home"></a><a accesskey="n" href="flag.html"><img src="../../../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_class_reference/padding.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_class_reference/padding.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,142 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>padding</title>
+<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../bitfield_tuple_class_reference.html" title="bitfield_tuple Class Reference">
+<link rel="prev" href="bitfield_tuple_and_bitfield_reference.html" title="bitfield_tuple and bitfield_reference">
+<link rel="next" href="member.html" title="member">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="bitfield_tuple_and_bitfield_reference.html"><img src="../../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../bitfield_tuple_class_reference.html"><img src="../../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../images/home.png" alt="Home"></a><a accesskey="n" href="member.html"><img src="../../../../images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.padding"></a><a class="link" href="padding.html" title="padding">padding</a>
+</h5></div></div></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.padding.description"></a><h5>
+<a name="id3231794"></a>
+ <a class="link" href="padding.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.padding.description">Description</a>
+ </h5>
+
+ <code class="computeroutput">padding</code> specifies a number
+ of empty bits to be ignored. Another good way to think about this is
+ as bit padding, it adds the number of bits in padding when specified.
+ From an implementation stand point it adds <code class="computeroutput">Bits</code>
+ to the starting the next starting position of the next bitfield specified
+ in the template parameter list. This class is used to give explicit control
+ to the user when it comes to the internal storage of the bits within
+ the <code class="computeroutput">bitfield_tuple</code>.
+ 
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.padding.template_signature"></a><h5>
+<a name="id3231860"></a>
+ <a class="link" href="padding.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.padding.template_signature">Template
+ Signature</a>
+ </h5>
+
+
+
+<pre class="programlisting">namespace boost { namespace bitfields {
+template <std::size_t Bits> struct padding;
+}}
+</pre>
+
+ 
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.padding.template_parameters"></a><h5>
+<a name="id3231986"></a>
+ <a class="link" href="padding.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.padding.template_parameters">Template
+ Parameters</a>
+ </h5>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Parameter
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ 
+ <code class="computeroutput">Bits</code>
+ 
+ </td>
+<td>
+ 
+ The amount of padding to add.
+ 
+ </td>
+</tr></tbody>
+</table></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.padding.header_file_location"></a><h5>
+<a name="id3232075"></a>
+ <a class="link" href="padding.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.padding.header_file_location">Header
+ File Location</a>
+ </h5>
+
+ This header file is included with the <boost/integer/bitfield_tuple.hpp>
+ header file.
+
+<pre class="programlisting">#include <boost/integer/details/bft/padding.hpp>
+</pre>
+
+ 
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.padding.example"></a><h5>
+<a name="id3232182"></a>
+ <a class="link" href="padding.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.padding.example">Example</a>
+ </h5>
+
+
+
+<pre class="programlisting">#include <boost\integer\bitfield_tuple.hpp>
+
+using namespace boost::bitfields;
+
+struct red;
+struct green;
+struct pink;
+struct blue;
+struct salmon;
+
+typedef bitfield_tuple<
+ storage<std::size_t>,
+ member<char,red,4>,
+ member<unsigned char, green,5>,
+ padding<3>,
+ member<int, salmon, 16>,
+ flag<blue>
+> tuple_with_padding;
+</pre>
+
+ All the padding does in the above is shift the last two members over
+ by 3 bits.
+ 
+</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 © 2010 Brian Bartman
+ 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="bitfield_tuple_and_bitfield_reference.html"><img src="../../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../bitfield_tuple_class_reference.html"><img src="../../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../images/home.png" alt="Home"></a><a accesskey="n" href="member.html"><img src="../../../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_class_reference/pointer.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_class_reference/pointer.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,358 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>pointer</title>
+<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../bitfield_tuple_class_reference.html" title="bitfield_tuple Class Reference">
+<link rel="prev" href="storage.html" title="storage">
+<link rel="next" href="custom.html" title="custom">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="storage.html"><img src="../../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../bitfield_tuple_class_reference.html"><img src="../../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../images/home.png" alt="Home"></a><a accesskey="n" href="custom.html"><img src="../../../../images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.pointer"></a><a class="link" href="pointer.html" title="pointer">pointer</a>
+</h5></div></div></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.pointer.description"></a><h5>
+<a name="id3237064"></a>
+ <a class="link" href="pointer.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.pointer.description">Description</a>
+ </h5>
+
+ The pointer member is a member of a bitfield_tuple which allows the user
+ to use a bitfield to store a pointer. This is useful when a user has
+ allocated an object on a DWORD boundry, when that happens the last two
+ bits of a pointer are 0. Because the last to bits of the pointer are
+ zero two boolean values can be stored within those two bits effectivly
+ saving 2 bytes per pointer. There are other types of space optimizations
+ which can be preformed when you know how a perticular object is going
+ to be allocated. Another example of what the pointer member can be used
+ for stuffing bits into the leading bits of the pointer. This can be done
+ in a valid manner if the address of the pointer is at a lower value.
+ 
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.pointer.template_signature"></a><h5>
+<a name="id3237118"></a>
+ <a class="link" href="pointer.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.pointer.template_signature">Template
+ Signature</a>
+ </h5>
+
+
+
+<pre class="programlisting">namespace boost { namespace bitfields {
+template <
+ typename ReturnType,
+ typename Name,
+ typename Mask = implementation defined
+ >
+>
+struct pointer;
+}}
+</pre>
+
+ 
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.pointer.template_parameters"></a><h5>
+<a name="id3237291"></a>
+ <a class="link" href="pointer.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.pointer.template_parameters">Template
+ Parameters</a>
+ </h5>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ template Parameter
+ 
+ </th>
+<th>
+ 
+ Explanation
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">ReturnType</code>
+ 
+ </td>
+<td>
+ 
+ This is the type which a pointer is being made to.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">Name</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">Name</code> of the
+ field which is can be used to access the field with the get
+ function.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">Mask</code>
+ 
+ </td>
+<td>
+ 
+ This is a mask which minimally defines the following two <code class="computeroutput">typedef</code>s and static constant:
+ <code class="computeroutput">Mask::type</code>, <code class="computeroutput">Mask::value_type</code>,
+ and <code class="computeroutput">Mask::value</code>. There are masking
+ utilities which are included with <code class="computeroutput">bitfield_tuple</code>
+ which make using this parameter easier. The <code class="computeroutput">Mask</code>
+ is used to define the value bits of the pointer which are to
+ be stored within the <code class="computeroutput">bitfield_tuple</code>.
+ The default value for this parameter is to define a <code class="computeroutput">Mask</code> over an integral type
+ which is the same size as a pointer, and leaves off the 2 least
+ significant bits of the pointer. This is because on most 32
+ and 64 bit architectures it is common for most allocation to
+ be DWORD aligned, which makes the address divisible by 4.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.pointer.preconditions"></a><h4>
+<a name="id3237579"></a>
+ <a class="link" href="pointer.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.pointer.preconditions">Preconditions</a>
+ </h4>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Precondition
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+<th>
+ 
+ Enforcement
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">Mask::value !=
+ 0</code>
+ 
+ </td>
+<td>
+ 
+ The value associated with the mask can not be zero.
+ 
+ </td>
+<td>
+ 
+ Enforced by static assert.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">sizeof(Mask::value_type)
+ == sizeof(void*)</code>
+ 
+ </td>
+<td>
+ 
+ The value type of the mask must be the same size as a pointer.
+ 
+ </td>
+<td>
+ 
+ Enforced by static assert.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">Name</code> must be
+ unique.
+ 
+ </td>
+<td>
+ 
+ The <code class="computeroutput">Name</code> template
+ parameter can only be supplied once per <code class="computeroutput">bitfield_tuple</code>.
+ 
+ </td>
+<td>
+ 
+ Enforced by static assert.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.pointer.header_file_locaton"></a><h5>
+<a name="id3237841"></a>
+ <a class="link" href="pointer.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.pointer.header_file_locaton">Header
+ file Locaton</a>
+ </h5>
+
+ This header file is included with the <boost/integer/bitfield_tuple.hpp>
+ header file.
+
+<pre class="programlisting">#include <boost/integer/details/bft/pointer.hpp>
+</pre>
+
+ 
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.pointer.basic_example"></a><h5>
+<a name="id3237950"></a>
+ <a class="link" href="pointer.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.pointer.basic_example">Basic
+ Example</a>
+ </h5>
+
+ Basic use case for stuffing the 2 least significant bits of a pointer.
+
+
+<pre class="programlisting">#include <boost/integer/bitfield_tuple.hpp>
+
+using namespace boost::bitfields;
+
+struct ptr;
+struct b1;
+struct b2;
+
+typedef bitfield_tuple<
+ pointer<int, ptr>,
+ flag<b1>,
+ flag<b2>
+> bool_stuffed_ptr;
+
+
+
+int main() {
+ int* some_ptr = new int();
+ bool_stuffed_ptr bsp;
+ bsp.get<ptr>() = some_ptr;
+
+ // prints the value of the integer being pointed at.
+ std::cout << *bsp.get<ptr>() << std::endl;
+
+ return 0;
+}
+
+</pre>
+
+ The <code class="computeroutput">bool_stuffed_ptr</code>
+ type allows for a the <code class="computeroutput">ptr</code>
+ member to point to an integer which is DWORD aligned within memory and
+ use the unused bits inside of it for storage of 2 additional boolean
+ values. If a valid address has been stored for <code class="computeroutput">ptr</code>
+ the value returned from the get function will be dereferenceable just
+ like a regular pointer.
+ 
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.pointer.mask_example"></a><h5>
+<a name="id3238474"></a>
+ <a class="link" href="pointer.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.pointer.mask_example">Mask
+ Example</a>
+ </h5>
+
+ Example of how to define a the <code class="computeroutput">Mask</code>
+ parameter for differently aligned memory allocations. The following allocations
+ are 8 byte aligned rather then 4 byte aligned, which leaves 3 bits instead
+ of 2 bits.
+
+<pre class="programlisting">using namespace boost::bitfields;
+
+struct ptr;
+struct b1;
+struct b2;
+struct b3;
+
+typedef boost::high_bits_mask<
+ std::size_t,
+ bit_width<std::size_t>::value - 3
+> ptr_mask;
+
+typedef bitfield_tuple<
+ pointer<int, ptr, ptr_mask>,
+ flag<b1>,
+ flag<b2>,
+ flag<b3>
+> bool_stuffed_ptr;
+</pre>
+
+ The <code class="computeroutput">boost::high_bits_mask</code> defines a mask which
+ starting at the most significant bit makes a contiguous section of 1
+ bits which are used to compose a mask. In the above example <code class="computeroutput">high_bits_mask</code> is being used to create
+ the following mask in binary (assuming a 32 bit architecture):
+ 
+<pre class="programlisting">most significant bit least significant bit
+ 31 0
+ 1111 1111 1111 1111 1111 1111 1111 1000
+</pre>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.pointer.two_pointers_and_a_4_bit_integer"></a><h6>
+<a name="id3238894"></a>
+ <a class="link" href="pointer.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.pointer.two_pointers_and_a_4_bit_integer">Two
+ Pointers and a 4 Bit Integer</a>
+ </h6>
+
+ The next example is how to on a 32 bit system to stuff two pointers to
+ DWORD aligned memory and a 4 bit integer into a single <code class="computeroutput">unsigned long
+ long</code> type.
+
+<pre class="programlisting">struct ptr1;
+struct ptr2;
+struct four_bit_int;
+
+typedef bitfield_tuple<
+ pointer<int, ptr1>,
+ pointer<int, ptr2>,
+ member<unsigned int,four_bit_int,4>
+> pointer_double_stuffed;
+</pre>
+
+ The <code class="computeroutput">pointer</code> members are
+ treated as bitfields and simply move around within the storage of the
+ <code class="computeroutput">bitfield_tuple</code> as a normal
+ member would be. This can effect the access time but only by a shift
+ operation to correctly place place the pointer to match the value bits
+ of its mask.
+ 
+</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 © 2010 Brian Bartman
+ 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="storage.html"><img src="../../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../bitfield_tuple_class_reference.html"><img src="../../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../images/home.png" alt="Home"></a><a accesskey="n" href="custom.html"><img src="../../../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_class_reference/storage.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_class_reference/storage.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,230 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>storage</title>
+<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../bitfield_tuple_class_reference.html" title="bitfield_tuple Class Reference">
+<link rel="prev" href="align.html" title="align">
+<link rel="next" href="pointer.html" title="pointer">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="align.html"><img src="../../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../bitfield_tuple_class_reference.html"><img src="../../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../images/home.png" alt="Home"></a><a accesskey="n" href="pointer.html"><img src="../../../../images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.storage"></a><a class="link" href="storage.html" title="storage">storage</a>
+</h5></div></div></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.storage.description"></a><h5>
+<a name="id3235895"></a>
+ <a class="link" href="storage.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.storage.description">Description</a>
+ </h5>
+
+ The <code class="computeroutput">storage</code> template
+ is optional (you don't have to have one in the template parameter list
+ of a <code class="computeroutput">bitfield_tuple</code>).
+ You may use it to specify that type you would like your bitfields to
+ be stored within. If you don't specify a storage type using the <code class="computeroutput">storage</code> parameter a type will be selected
+ for you which can hold all of your bitfields. The deduced type will be
+ unsigned and one off the following types from within <boost/cstdint.hpp>,
+ uint_least8_t, uint_least16_t, uint_least32_t or if you have long long
+ support enabled, uint_least64_t. You can use boost.integer endian to
+ specify your storage type as one which is different from your current
+ machine and the <code class="computeroutput">bitfield_tuple</code>
+ will store the data values in the endianness specified as well as return
+ and accept values in the endianness of your native machine.
+ 
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.storage.template_signature"></a><h5>
+<a name="id3235991"></a>
+ <a class="link" href="storage.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.storage.template_signature">Template
+ Signature</a>
+ </h5>
+
+
+
+<pre class="programlisting">namespace boost { namespace bitfields {
+template <typename StorageType> struct storage;
+}}
+</pre>
+
+ 
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.storage.template_parameters"></a><h5>
+<a name="id3236109"></a>
+ <a class="link" href="storage.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.storage.template_parameters">Template
+ Parameters</a>
+ </h5>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ template Parameter
+ 
+ </th>
+<th>
+ 
+ Explanation
+ 
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ 
+ <code class="computeroutput">StorageType</code>
+ 
+ </td>
+<td>
+ 
+ The storage type to be used for storing data inside of the
+ <code class="computeroutput">bitfield_tuple</code>.
+ 
+ </td>
+</tr></tbody>
+</table></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.storage.preconditions"></a><h4>
+<a name="id3236215"></a>
+ <a class="link" href="storage.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.storage.preconditions">Preconditions</a>
+ </h4>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Precondition
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+<th>
+ 
+ Enforcement
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ storage type can be supplied 0 or 1 times for the <code class="computeroutput">bitfield_tuple</code>.
+ 
+ </td>
+<td>
+ 
+ The <code class="computeroutput">storage</code>
+ not be specified more then once per inside of the template
+ parameters for a single <code class="computeroutput">bitfield_tuple</code>.
+ 
+ </td>
+<td>
+ 
+ Enforced by static assert.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ Total width of all bitfields in a single <code class="computeroutput">bitfield_tuple</code>
+ can not exceed the width in bits of the storage type when the
+ storage type is specified or 64 bits when a storage type is
+ not specified if you system supports some form 64 bit integer
+ other wise the limit is set to 32 bits.
+ 
+ </td>
+<td>
+ 
+ This is a limitation on the internal storage that <code class="computeroutput">bitfield_tuple</code> uses to hold
+ its bitfields.
+ 
+ </td>
+<td>
+ 
+ Enforced by static assert.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.storage.header_file_locaton"></a><h5>
+<a name="id3236395"></a>
+ <a class="link" href="storage.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.storage.header_file_locaton">Header
+ file Locaton</a>
+ </h5>
+
+ This header file is included with the <boost/integer/bitfield_tuple.hpp>
+ header file.
+
+<pre class="programlisting">#include <boost/integer/details/bft/storage.hpp>
+</pre>
+
+ 
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.storage.example"></a><h5>
+<a name="id3236505"></a>
+ <a class="link" href="storage.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_class_reference.storage.example">Example</a>
+ </h5>
+
+ Specified storage type example.
+
+<pre class="programlisting">struct red;
+struct green;
+struct blue;
+
+typedef bitfield_tuple<
+ storage<unsinged int>,
+ member<unsigned int,red,4>,
+ member<unsigned int,green,4>,
+ member<unsigned int,blue,4>
+> rgb444;
+</pre>
+
+ The type <code class="computeroutput">rgb444</code> shown
+ in the above example has the size of 4. <code class="computeroutput">rgb444</code>
+ has the same size as the integer type which the storage type specifies.
+ 
+
+ non-specified storage type example.
+
+<pre class="programlisting">struct red;
+struct green;
+struct blue;
+
+typedef bitfield_tuple<
+ member<unsigned int,red,4>,
+ member<unsigned int,green,4>,
+ member<unsigned int,blue,4>
+> rgb444_2;
+</pre>
+
+ The in this example a storage type is being deduced by the <code class="computeroutput">bitfield_tuple</code>. So the type <code class="computeroutput">rgb444_2</code> has a size of 2 which is the
+ size of an unsigned short which is the smallest type that could hold
+ all of the bitfields.
+ 
+</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 © 2010 Brian Bartman
+ 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="align.html"><img src="../../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../bitfield_tuple_class_reference.html"><img src="../../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../images/home.png" alt="Home"></a><a accesskey="n" href="pointer.html"><img src="../../../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_macro_reference.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_macro_reference.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,43 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>bitfield_tuple Macro Reference</title>
+<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../reference.html" title="Reference">
+<link rel="prev" href="bitfield_tuple_class_reference/custom.html" title="custom">
+<link rel="next" href="bitfield_tuple_macro_reference/parameter_adjustment_macros.html" title="Parameter Adjustment macros">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="bitfield_tuple_class_reference/custom.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="bitfield_tuple_macro_reference/parameter_adjustment_macros.html"><img src="../../../images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_macro_reference"></a><a class="link" href="bitfield_tuple_macro_reference.html" title="bitfield_tuple Macro Reference">bitfield_tuple
+ Macro Reference</a>
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt><a href="bitfield_tuple_macro_reference/parameter_adjustment_macros.html">Parameter
+ Adjustment macros</a></dt>
+<dt><a href="bitfield_tuple_macro_reference/code_generation_macros.html">Code
+ Generation Macros</a></dt>
+</dl></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 © 2010 Brian Bartman
+ 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="bitfield_tuple_class_reference/custom.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="bitfield_tuple_macro_reference/parameter_adjustment_macros.html"><img src="../../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_macro_reference/code_generation_macros.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_macro_reference/code_generation_macros.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,136 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Code Generation Macros</title>
+<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../bitfield_tuple_macro_reference.html" title="bitfield_tuple Macro Reference">
+<link rel="prev" href="parameter_adjustment_macros.html" title="Parameter Adjustment macros">
+<link rel="next" href="../function_reference.html" title="Function Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="parameter_adjustment_macros.html"><img src="../../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../bitfield_tuple_macro_reference.html"><img src="../../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../images/home.png" alt="Home"></a><a accesskey="n" href="../function_reference.html"><img src="../../../../images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_macro_reference.code_generation_macros"></a><a class="link" href="code_generation_macros.html" title="Code Generation Macros">Code
+ Generation Macros</a>
+</h5></div></div></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_macro_reference.code_generation_macros.macros"></a><h6>
+<a name="id3242210"></a>
+ <a class="link" href="code_generation_macros.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_macro_reference.code_generation_macros.macros">Macros</a>
+ </h6>
+
+ Macros used for generating template parameters for use in specilization
+ and generating template parameters. The <code class="computeroutput">N</code>
+ value in the below sequences below represent the value of <code class="computeroutput">BOOST_BFT_PARAM_COUNT</code>.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Name
+ 
+ </th>
+<th>
+ 
+ Pattern
+ 
+ </th>
+<th>
+ 
+ Usage
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">BOOST_BFT_TEMPLATE_ARGS_NO_DEFAULTS()</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">typename T0, ...
+ typename TN</code>
+ 
+ </td>
+<td>
+ 
+ Recomended for use outside of <code class="computeroutput">bitfield_tuple</code>.
+ This macro is used to create template parameters which can
+ be used for specialization over a <code class="computeroutput">bitfield_tuple</code>
+ type.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">BOOST_BFT_SPECILIZATION_PARAM_LIST()</code>
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">T0,
+ ... TN</code>
+ 
+ </td>
+<td>
+ 
+ Recomended for use outside of <code class="computeroutput">bitfield_tuple</code>.
+ This macro is used to create template parameters which are
+ then supplied to the template of a <code class="computeroutput">bitfield_tuple</code>
+ type.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+
+ Here is example useage of the macros that can be used to specilize a
+ class template over the <code class="computeroutput">bitfield_tuple</code>
+ type.
+ 
+
+
+
+<pre class="programlisting">#include <boost/integer/bitfield_tuple.hpp>
+
+template <typename T>
+struct foo;
+
+
+template<BOOST_BFT_TEMPLATE_ARGS_NO_DEFAULTS()>
+struct foo< boost::bitfield_tuple< BOOST_BFT_SPECILIZATION_PARAM_LIST() > >
+{
+};
+
+</pre>
+
+ 
+</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 © 2010 Brian Bartman
+ 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="parameter_adjustment_macros.html"><img src="../../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../bitfield_tuple_macro_reference.html"><img src="../../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../images/home.png" alt="Home"></a><a accesskey="n" href="../function_reference.html"><img src="../../../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_macro_reference/parameter_adjustment_macros.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_macro_reference/parameter_adjustment_macros.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,67 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Parameter Adjustment macros</title>
+<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../bitfield_tuple_macro_reference.html" title="bitfield_tuple Macro Reference">
+<link rel="prev" href="../bitfield_tuple_macro_reference.html" title="bitfield_tuple Macro Reference">
+<link rel="next" href="code_generation_macros.html" title="Code Generation Macros">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../bitfield_tuple_macro_reference.html"><img src="../../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../bitfield_tuple_macro_reference.html"><img src="../../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../images/home.png" alt="Home"></a><a accesskey="n" href="code_generation_macros.html"><img src="../../../../images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_macro_reference.parameter_adjustment_macros"></a><a class="link" href="parameter_adjustment_macros.html" title="Parameter Adjustment macros">Parameter
+ Adjustment macros</a>
+</h5></div></div></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_macro_reference.parameter_adjustment_macros.template_parameter_control"></a><h6>
+<a name="id3241931"></a>
+ <a class="link" href="parameter_adjustment_macros.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.bitfield_tuple_macro_reference.parameter_adjustment_macros.template_parameter_control">Template
+ Parameter Control</a>
+ </h6>
+
+ The <code class="computeroutput">BOOST_BFT_PARAM_COUNT</code>
+ macro is used for controlling the max number of template parameters that
+ are able to be used by the <code class="computeroutput">bitfield_tuple</code>
+ and the function templates and class templates relating to it. The <code class="computeroutput">BOOST_BFT_PARAM_COUNT</code> macro if definded
+ sets the upper limit of the <code class="computeroutput">bitfield_tuple</code>'s
+ template parameter's to a higher number. The max <code class="computeroutput">BOOST_BFT_PARAM_COUNT</code>
+ can be set to is 50 and the default is 10. The side effect of setting
+ <code class="computeroutput">BOOST_BFT_PARAM_COUNT</code>
+ can be that the <code class="computeroutput">BOOST_MPL_LIMIT_VECTOR_SIZE</code>
+ vector is set to a size which is larger or equal to the value of <code class="computeroutput">BOOST_BFT_PARAM_COUNT</code>. If one wishes
+ to set the value of both <code class="computeroutput">BOOST_BFT_PARAM_COUNT</code>
+ and <code class="computeroutput">BOOST_MPL_LIMIT_VECTOR_SIZE</code>
+ both must be set before the <code class="computeroutput">bitfield_tuple</code>
+ header file is included. Don't include <boost/mpl/vector.hpp> before
+ the bitfield_tuple header file if you you intend to set the <code class="computeroutput">BOOST_BFT_PARAM_COUNT</code>.
+ 
+
+ Example of setting the parameter count to 11.
+
+<pre class="programlisting">#define BOOST_BFT_PARAM_COUNT 11
+#include <boost/integer/bitfield_tuple.hpp>
+</pre>
+
+ 
+</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 © 2010 Brian Bartman
+ 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="../bitfield_tuple_macro_reference.html"><img src="../../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../bitfield_tuple_macro_reference.html"><img src="../../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../images/home.png" alt="Home"></a><a accesskey="n" href="code_generation_macros.html"><img src="../../../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/boost_fusion_sequence_extension.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/boost_fusion_sequence_extension.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,124 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Boost.Fusion Sequence Extension</title>
+<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../reference.html" title="Reference">
+<link rel="prev" href="meta_function_reference/element_n.html" title="struct element_n">
+<link rel="next" href="files.html" title="Files">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="meta_function_reference/element_n.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="files.html"><img src="../../../images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.boost_fusion_sequence_extension"></a><a class="link" href="boost_fusion_sequence_extension.html" title="Boost.Fusion Sequence Extension">Boost.Fusion
+ Sequence Extension</a>
+</h4></div></div></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.boost_fusion_sequence_extension.boost_fusion_sequence_extension"></a><h6>
+<a name="id3248992"></a>
+ <a class="link" href="boost_fusion_sequence_extension.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.boost_fusion_sequence_extension.boost_fusion_sequence_extension">Boost.Fusion
+ Sequence Extension</a>
+ </h6>
+
+ The type modeled by the boost.fusion iterator is of the following category:
+
+
+<pre class="programlisting">struct bft_category
+ : boost::fusion::random_access_traversal_tag,
+ boost::fusion::associative_tag
+{ };
+</pre>
+
+ 
+
+ List of supported funtions on <code class="computeroutput">bitfield_tuple</code>
+ 
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ begin
+ </li>
+<li class="listitem">
+ end
+ </li>
+<li class="listitem">
+ is_sequence
+ </li>
+<li class="listitem">
+ is_view
+ </li>
+<li class="listitem">
+ category_of
+ </li>
+<li class="listitem">
+ at
+ </li>
+<li class="listitem">
+ size
+ </li>
+<li class="listitem">
+ at_key
+ </li>
+<li class="listitem">
+ tag_of
+ </li>
+<li class="listitem">
+ All intrinsic functions which are available because of the implementation
+ of the above functions.
+ </li>
+</ul></div>
+
+ List of functions supported by <code class="computeroutput">bitfield_tuple_iterator</code>:
+ 
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ deref
+ </li>
+<li class="listitem">
+ value_of
+ </li>
+<li class="listitem">
+ next
+ </li>
+<li class="listitem">
+ prior
+ </li>
+<li class="listitem">
+ distance
+ </li>
+<li class="listitem">
+ key_of
+ </li>
+<li class="listitem">
+ value_at_data
+ </li>
+<li class="listitem">
+ deref_data
+ </li>
+<li class="listitem">
+ advance
+ </li>
+<li class="listitem">
+ Additional intrinsic functions are available for use with this iterator.
+ </li>
+</ul></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 © 2010 Brian Bartman
+ 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="meta_function_reference/element_n.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="files.html"><img src="../../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/concepts.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/concepts.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,34 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Concepts</title>
+<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../reference.html" title="Reference">
+<link rel="prev" href="../reference.html" title="Reference">
+<link rel="next" href="bitfield_tuple_class_reference.html" title="bitfield_tuple Class Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../reference.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="bitfield_tuple_class_reference.html"><img src="../../../images/next.png" alt="Next"></a>
+</div>
+<div class="section"><div class="titlepage"><div><div><h4 class="title">
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.concepts"></a><a class="link" href="concepts.html" title="Concepts">Concepts</a>
+</h4></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 © 2010 Brian Bartman
+ 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="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="bitfield_tuple_class_reference.html"><img src="../../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/files.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/files.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,34 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Files</title>
+<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../reference.html" title="Reference">
+<link rel="prev" href="boost_fusion_sequence_extension.html" title="Boost.Fusion Sequence Extension">
+<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"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="boost_fusion_sequence_extension.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="../appendices.html"><img src="../../../images/next.png" alt="Next"></a>
+</div>
+<div class="section"><div class="titlepage"><div><div><h4 class="title">
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.files"></a><a class="link" href="files.html" title="Files">Files</a>
+</h4></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 © 2010 Brian Bartman
+ 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="boost_fusion_sequence_extension.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="../appendices.html"><img src="../../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/function_reference.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/function_reference.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,43 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Function Reference</title>
+<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../reference.html" title="Reference">
+<link rel="prev" href="bitfield_tuple_macro_reference/code_generation_macros.html" title="Code Generation Macros">
+<link rel="next" href="function_reference/make_bitfield_tuple.html" title="make_bitfield_tuple Free Function">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="bitfield_tuple_macro_reference/code_generation_macros.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="function_reference/make_bitfield_tuple.html"><img src="../../../images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.function_reference"></a><a class="link" href="function_reference.html" title="Function Reference">Function
+ Reference</a>
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt><a href="function_reference/make_bitfield_tuple.html">
+ make_bitfield_tuple Free Function</a></dt>
+<dt><a href="function_reference/get.html">
+ get Free Function</a></dt>
+</dl></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 © 2010 Brian Bartman
+ 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="bitfield_tuple_macro_reference/code_generation_macros.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="function_reference/make_bitfield_tuple.html"><img src="../../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/function_reference/get.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/function_reference/get.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,114 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>get Free Function</title>
+<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../function_reference.html" title="Function Reference">
+<link rel="prev" href="make_bitfield_tuple.html" title="make_bitfield_tuple Free Function">
+<link rel="next" href="../meta_function_reference.html" title="Meta-Function Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="make_bitfield_tuple.html"><img src="../../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../function_reference.html"><img src="../../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../images/home.png" alt="Home"></a><a accesskey="n" href="../meta_function_reference.html"><img src="../../../../images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.function_reference.get"></a><a class="link" href="get.html" title="get Free Function">
+ get Free Function</a>
+</h5></div></div></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.function_reference.get.description"></a><h6>
+<a name="id3243498"></a>
+ <a class="link" href="get.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.function_reference.get.description">Description</a>
+ </h6>
+
+ There are two variations on the <code class="computeroutput">get</code>
+ function overloads. The first, is a member function of <code class="computeroutput">bitfield_tuple</code>. The second, is a free
+ function with similar interface. The free function version of <code class="computeroutput">get</code> simplifies things for writing inside
+ of a template scope. The member function version of <code class="computeroutput">get</code>
+ requires the user to constantly put the word template before it, while
+ the free function version does not require the word template inside of
+ a template scope.
+ 
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.function_reference.get.get_free_function_overloads"></a><h6>
+<a name="id3243576"></a>
+ <a class="link" href="get.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.function_reference.get.get_free_function_overloads">get
+ Free Function Overloads</a>
+ </h6>
+
+
+
+<pre class="programlisting">template <std::size_t Index, typename BitfieldTuple>
+inline (Implementation Defined proxy_reference_type) get(BitfieldTuple& bft);
+
+template <typename Name, typename BitfieldTuple>
+inline (Implementation Defined proxy_reference_type) get(BitfieldTuple& bft);
+
+template <std::size_t Index, typename BitfieldTuple>
+inline (Implementation Defined proxy_reference_type) get(BitfieldTuple const& bft);
+
+template <typename Name, typename BitfieldTuple>
+inline (Implementation Defined proxy_reference_type) get(BitfieldTuple const& bft);
+
+</pre>
+
+ 
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.function_reference.get.examples"></a><h6>
+<a name="id3244056"></a>
+ <a class="link" href="get.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.function_reference.get.examples">Examples</a>
+ </h6>
+
+
+
+<pre class="programlisting">#include <boost/integer/bitfield_tuple.hpp>
+#include <cassert>
+
+using namespace boost;
+
+struct red;
+struct green;
+struct pink;
+struct blue;
+struct salmon;
+
+typedef bitfield_tuple<
+ member<char,red,4>,
+ member<unsigned char, green,5>,
+ storage<std::size_t>,
+ filler<3>,
+ member<int, salmon, 16>,
+ flag<blue>
+> get_free_function_example;
+
+int main(){
+
+ get_free_function_example t1;
+
+ // equivalent operations.
+ assert(get<red>(t1) == t1.get<red>());
+
+ // equivalent operations.
+ assert(get<0>(t1) == t1.get<0>());
+ return 0;
+}
+</pre>
+
+ 
+</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 © 2010 Brian Bartman
+ 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="make_bitfield_tuple.html"><img src="../../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../function_reference.html"><img src="../../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../images/home.png" alt="Home"></a><a accesskey="n" href="../meta_function_reference.html"><img src="../../../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/function_reference/make_bitfield_tuple.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/function_reference/make_bitfield_tuple.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,109 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>make_bitfield_tuple Free Function</title>
+<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../function_reference.html" title="Function Reference">
+<link rel="prev" href="../function_reference.html" title="Function Reference">
+<link rel="next" href="get.html" title="get Free Function">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../function_reference.html"><img src="../../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../function_reference.html"><img src="../../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../images/home.png" alt="Home"></a><a accesskey="n" href="get.html"><img src="../../../../images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.function_reference.make_bitfield_tuple"></a><a class="link" href="make_bitfield_tuple.html" title="make_bitfield_tuple Free Function">
+ make_bitfield_tuple Free Function</a>
+</h5></div></div></div>
+
+ The <code class="computeroutput">make_bitfield_tuple</code>
+ function is included with the bitfield_tuple header. <code class="computeroutput">make_bitfield_tuple</code>
+ like <code class="computeroutput">make_tuple</code> takes
+ a variadic number of parameters. However, differing from the <code class="computeroutput">make_tuple</code>, <code class="computeroutput">make_bitfield_tuple</code>
+ requires one to specify the <code class="computeroutput">bitfield_tuple</code>
+ the wish to create.
+ 
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.function_reference.make_bitfield_tuple.function_signature"></a><h6>
+<a name="id3242814"></a>
+ <a class="link" href="make_bitfield_tuple.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.function_reference.make_bitfield_tuple.function_signature">Function
+ Signature</a>
+ </h6>
+
+ Function signature for <code class="computeroutput">make_bitfield_tuple</code>:
+ 
+
+ <code class="computeroutput">template <typename BitfieldTuple> BitfieldTuple
+ make_bitfield_tuple(</code>
+ <code>Implementation Defined</code><code class="computeroutput"> );</code>
+ 
+<div class="note"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td align="left" valign="top">
+ <code>Implementation defined</code> in the function signature
+ leaves a lot to be desired, however the function is variadic in nature
+ and can take upto as many parameters as <code class="computeroutput">BOOST_BFT_PARAM_COUNT</code>.
+ If the number of parameters supplied to the function is greater the
+ the number of members within the supplied <code class="computeroutput">bitfield_tuple</code>
+ type those parameters will be ignored.
+ </td></tr>
+</table></div>
+
+ Here is an example for using the <code class="computeroutput">make_bitfield_tuple</code>
+ function to create a <code class="computeroutput">bitfield_tuple</code>.
+ 
+
+
+
+<pre class="programlisting">#include <boost/integer/bitfield_tuple.hpp>
+
+
+
+using namespace boost;
+
+struct red;
+struct green;
+struct pink;
+struct blue;
+struct salmon;
+
+typedef bitfield_tuple<
+ member<char,red,4>,
+ member<unsigned char, green,5>,
+ storage<std::size_t>,
+ filler<3>,
+ member<int, salmon, 16>,
+ flag<blue>
+> test_tuple;
+
+int main(){
+ test_tuple bft = make_bitfield_tuple<test_tuple>(1,2,4,true);
+
+
+ return 0;
+}
+</pre>
+
+ 
+</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 © 2010 Brian Bartman
+ 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="../function_reference.html"><img src="../../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../function_reference.html"><img src="../../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../images/home.png" alt="Home"></a><a accesskey="n" href="get.html"><img src="../../../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/meta_function_reference.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/meta_function_reference.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,45 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Meta-Function Reference</title>
+<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../reference.html" title="Reference">
+<link rel="prev" href="function_reference/get.html" title="get Free Function">
+<link rel="next" href="meta_function_reference/element.html" title="struct element">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="function_reference/get.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="meta_function_reference/element.html"><img src="../../../images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.meta_function_reference"></a><a class="link" href="meta_function_reference.html" title="Meta-Function Reference">Meta-Function
+ Reference</a>
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt><a href="meta_function_reference/element.html">
+ struct element</a></dt>
+<dt><a href="meta_function_reference/element_n.html">
+ struct element_n</a></dt>
+</dl></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 © 2010 Brian Bartman
+ 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="function_reference/get.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="meta_function_reference/element.html"><img src="../../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/meta_function_reference/element.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/meta_function_reference/element.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,333 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>struct element</title>
+<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../meta_function_reference.html" title="Meta-Function Reference">
+<link rel="prev" href="../meta_function_reference.html" title="Meta-Function Reference">
+<link rel="next" href="element_n.html" title="struct element_n">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../meta_function_reference.html"><img src="../../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../meta_function_reference.html"><img src="../../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../images/home.png" alt="Home"></a><a accesskey="n" href="element_n.html"><img src="../../../../images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.meta_function_reference.element"></a><a class="link" href="element.html" title="struct element">
+ struct element</a>
+</h5></div></div></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.meta_function_reference.element.description"></a><h6>
+<a name="id3244732"></a>
+ <a class="link" href="element.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.meta_function_reference.element.description">Description</a>
+ </h6>
+
+ The <code class="computeroutput">element</code> meta-function,
+ is a template which behaves the in a similar fashion to that of Boost.Tuple's
+ <code class="computeroutput">element</code>. It takes a
+ <code class="computeroutput">bitfield_tuple</code> followed
+ by an index and returns the proxy reference type that would be returned
+ from calling the <code class="computeroutput">get</code>
+ function with the same index. It is possible to use <code class="computeroutput">element</code>
+ to create a type of view into another integral type which is not a <code class="computeroutput">bitfield_tuple</code>. This is done by using
+ the proxy reference type to construct a proxy reference over an integral
+ instead of over another proxy reference type which is the only other
+ constructor, for the <code class="computeroutput">bitfield_reference</code>
+ type.
+ 
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.meta_function_reference.element.template_signature"></a><h6>
+<a name="id3244848"></a>
+ <a class="link" href="element.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.meta_function_reference.element.template_signature">Template
+ Signature</a>
+ </h6>
+
+
+
+<pre class="programlisting">namespace boost { namespace bitfields {
+template<typename BitfieldTuple, std::size_t Index> struct element;
+}}
+</pre>
+
+ 
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.meta_function_reference.element.template_parameters"></a><h6>
+<a name="id3244987"></a>
+ <a class="link" href="element.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.meta_function_reference.element.template_parameters">Template
+ Parameters</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Parameter
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">BitfieldTuple</code>
+ 
+ </td>
+<td>
+ 
+ The <code class="computeroutput">bitfield_tuple</code>
+ which is to be used to retrieve the proxy reference type from.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">Index</code>
+ 
+ </td>
+<td>
+ 
+ The index to use for retrieving the proxy reference type.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<div class="note"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td align="left" valign="top">
+ If there is a need for retrieving a <code class="computeroutput">const</code>
+ version of a proxy reference type there is a convention for retrieving
+ a <code class="computeroutput">const</code> proxy reference
+ type from the <code class="computeroutput">element</code>
+ meta-function. To retrieve a <code class="computeroutput">const</code>
+ proxy reference type all that needs to be done is to supply the <code class="computeroutput">const</code> qualifier along with the <code class="computeroutput">BitfieldTuple</code> template parameter.
+ For an example, see below within the example section.
+ </td></tr>
+</table></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.meta_function_reference.element.preconditions"></a><h6>
+<a name="id3245194"></a>
+ <a class="link" href="element.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.meta_function_reference.element.preconditions">Preconditions</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Precondition
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+<th>
+ 
+ Enforcement
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">Index <
+ mpl::size<BitfieldTuple::members>::type::value</code>
+ 
+ </td>
+<td>
+ 
+ The index supplied must be less then the number of members
+ within the <code class="computeroutput">bitfield_tuple</code>
+ which is supplied as a template parameter. All this means is
+ that if the <code class="computeroutput">Index</code>
+ supplied is not a valid index the <code class="computeroutput">element</code>
+ meta-function will statically assert.
+ 
+ </td>
+<td>
+ 
+ Enforced by static assert.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ BitfieldTuple must be a <code class="computeroutput">bitfield_tuple</code>.
+ 
+ </td>
+<td>
+ 
+ Means that if something other then a <code class="computeroutput">bitfield_tuple</code>
+ is supplied for the <code class="computeroutput">BitfieldTuple</code>
+ template parameter that this meta-function will not work.
+ 
+ </td>
+<td>
+ 
+ Documented requirement only. Not enforced.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.meta_function_reference.element.interface"></a><h6>
+<a name="id3245454"></a>
+ <a class="link" href="element.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.meta_function_reference.element.interface">Interface</a>
+ </h6>
+
+ <code class="computeroutput">N</code> is used for type <code class="computeroutput">element</code> within the following interface
+ documentation.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Operation
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ 
+ <code class="computeroutput">N::type</code>
+ 
+ </td>
+<td>
+ 
+ This is set to the proxy reference type which would be returned
+ from the get function at the specified <code class="computeroutput">Index</code>.
+ 
+ </td>
+</tr></tbody>
+</table></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.meta_function_reference.element.header_file_location"></a><h6>
+<a name="id3245590"></a>
+ <a class="link" href="element.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.meta_function_reference.element.header_file_location">Header
+ File Location</a>
+ </h6>
+
+ This meta-function is included along with the <boost/integer/bitfield_tuple.hpp>
+ header file. There is no need to directly include the element header
+ file within your code.
+ 
+<pre class="programlisting">#include <boost/integer/bitfield_tuple/element.hpp>
+</pre>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.meta_function_reference.element.example"></a><h6>
+<a name="id3245637"></a>
+ <a class="link" href="element.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.meta_function_reference.element.example">Example</a>
+ </h6>
+
+ Basic example of how to use the <code class="computeroutput">element</code>
+ meta-function to retrieve the return type of the <code class="computeroutput">get</code>
+ member or free function.
+
+<pre class="programlisting">#include <boost/integer/bitfield_tuple.hpp>
+
+using namespace boost::bitfields;
+
+struct i;
+struct red;
+struct green;
+struct blue;
+
+typedef bitfield_tuple<
+ member<unsigned int,red,5>,
+ member<unsigned int, green, 6>,
+ member<unsinged int, blue,5>
+> rgb565;
+
+// write a function whose return type is the proxy reference type
+// which would be returned from calling get<0>() or get<red>()
+element<rgb565,0>::type my_func(rgb565 bft) {
+ return bft.get<red>(); // this could be replaced with get<0>()
+}
+
+// make a const version of my_func
+element<const rgb565,0>::type my_func(rgb565 const& bft) {
+ return bft.get<red>(); // this could be replaced with get<0>()
+}
+</pre>
+
+ 
+
+ How to use element to make views from a <code class="computeroutput">bitfield_tuple</code>
+ type. <code class="computeroutput">const</code> still applies
+ to the views, if one would like a <code class="computeroutput">const</code>
+ view into something simply supply the <code class="computeroutput">const</code>
+ qualifier to the BitfieldTuple template parameter and that's all that
+ needs to be done.
+
+<pre class="programlisting">#include <boost/integer/bitfield_tuple.hpp>
+#include <cassert>
+
+using namespace boost::bitfields;
+
+struct red;
+struct green;
+struct blue;
+
+typedef bitfield_tuple<
+ storage<std::size_t>,
+ member<char,red,4>,
+ member<unsigned char, green,5>,
+ member<int, salmon, 16>
+> test_tuple_1;
+
+int main() {
+
+ typedef element<test_tuple_1,0>::type view_red;
+ std::size_t storage = 0;
+ // constructs the red view type over storage
+ // which is simply std::size_t.
+ view_red red_v(storage);
+ assert(red_v == 0);
+ red_v = 3;
+ assert(red_v == 3);
+ return 0;
+}
+</pre>
+
+ 
+</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 © 2010 Brian Bartman
+ 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="../meta_function_reference.html"><img src="../../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../meta_function_reference.html"><img src="../../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../images/home.png" alt="Home"></a><a accesskey="n" href="element_n.html"><img src="../../../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/meta_function_reference/element_n.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/meta_function_reference/element_n.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,324 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>struct element_n</title>
+<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../meta_function_reference.html" title="Meta-Function Reference">
+<link rel="prev" href="element.html" title="struct element">
+<link rel="next" href="../boost_fusion_sequence_extension.html" title="Boost.Fusion Sequence Extension">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="element.html"><img src="../../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../meta_function_reference.html"><img src="../../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../images/home.png" alt="Home"></a><a accesskey="n" href="../boost_fusion_sequence_extension.html"><img src="../../../../images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.meta_function_reference.element_n"></a><a class="link" href="element_n.html" title="struct element_n">
+ struct element_n</a>
+</h5></div></div></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.meta_function_reference.element_n.description"></a><h6>
+<a name="id3246902"></a>
+ <a class="link" href="element_n.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.meta_function_reference.element_n.description">Description</a>
+ </h6>
+
+ <code class="computeroutput">element_n</code> is a meta-function
+ similar to the <code class="computeroutput">element</code>.
+ The only difference between this <code class="computeroutput">element</code>
+ and <code class="computeroutput">element_n</code> is that
+ <code class="computeroutput">element_n</code> operates using
+ the member's name instead of its index.
+ 
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.meta_function_reference.element_n.template_signature"></a><h6>
+<a name="id3246988"></a>
+ <a class="link" href="element_n.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.meta_function_reference.element_n.template_signature">Template
+ Signature</a>
+ </h6>
+
+
+
+<pre class="programlisting">namespace boost { namespace bitfields {
+template<typename BitfieldTuple, typename Name> struct element_n;
+}}
+</pre>
+
+ 
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.meta_function_reference.element_n.template_parameters"></a><h6>
+<a name="id3247119"></a>
+ <a class="link" href="element_n.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.meta_function_reference.element_n.template_parameters">Template
+ Parameters</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Parameter
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">BitfieldTuple</code>
+ 
+ </td>
+<td>
+ 
+ The <code class="computeroutput">bitfield_tuple</code>
+ which is to be used to retrieve the proxy reference type from.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">Name</code>
+ 
+ </td>
+<td>
+ 
+ The <code class="computeroutput">Name</code> supplied
+ to the member when the <code class="computeroutput">bitfield_tuple</code>.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<div class="note"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td align="left" valign="top">
+ If there is a need for retrieving a <code class="computeroutput">const</code>
+ version of a proxy reference type there is a convention for retrieving
+ a <code class="computeroutput">const</code> proxy reference
+ type from the <code class="computeroutput">element_n</code>
+ meta-function. To retrieve a <code class="computeroutput">const</code>
+ proxy reference type all that needs to be done is to supply the <code class="computeroutput">const</code> qualifier along with the <code class="computeroutput">BitfieldTuple</code> template parameter.
+ For an example, see below within the example section.
+ </td></tr>
+</table></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.meta_function_reference.element_n.preconditions"></a><h6>
+<a name="id3247348"></a>
+ <a class="link" href="element_n.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.meta_function_reference.element_n.preconditions">Preconditions</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Precondition
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+<th>
+ 
+ Enforcement
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">Name</code> must exist
+ 
+ </td>
+<td>
+ 
+ The <code class="computeroutput">Name</code> template
+ parameter must exist within the <code class="computeroutput">BitfieldTuple</code>
+ template parameter.
+ 
+ </td>
+<td>
+ 
+ Enforced by static assert.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ BitfieldTuple must be a <code class="computeroutput">bitfield_tuple</code>.
+ 
+ </td>
+<td>
+ 
+ Means that if something other then a <code class="computeroutput">bitfield_tuple</code>
+ is supplied for the <code class="computeroutput">BitfieldTuple</code>
+ template parameter that this meta-function will not work.
+ 
+ </td>
+<td>
+ 
+ Documented requirement only. Not enforced.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.meta_function_reference.element_n.interface"></a><h6>
+<a name="id3247537"></a>
+ <a class="link" href="element_n.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.meta_function_reference.element_n.interface">Interface</a>
+ </h6>
+
+ <code class="computeroutput">N</code> is used for type <code class="computeroutput">element_n</code> within the following interface
+ documentation.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Operation
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ 
+ <code class="computeroutput">N::type</code>
+ 
+ </td>
+<td>
+ 
+ This is the type which would be returned from the <code class="computeroutput">get</code> function when it is called
+ with <code class="computeroutput">Name</code>.
+ 
+ </td>
+</tr></tbody>
+</table></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.meta_function_reference.element_n.header_file_location"></a><h6>
+<a name="id3247683"></a>
+ <a class="link" href="element_n.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.meta_function_reference.element_n.header_file_location">Header
+ File Location</a>
+ </h6>
+
+ This meta-function is included along with the <boost/integer/bitfield_tuple.hpp>
+ header file. There is no need to directly include the element header
+ file within your code.
+ 
+<pre class="programlisting">#include <boost/integer/bitfield_tuple/element.hpp>
+</pre>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference.meta_function_reference.element_n.example"></a><h6>
+<a name="id3247728"></a>
+ <a class="link" href="element_n.html#boost_integer_bits_masks_extension.bitfield_tuple.reference.meta_function_reference.element_n.example">Example</a>
+ </h6>
+
+ Basic example of how to use the <code class="computeroutput">element_n</code>
+ meta-function to retrieve the return type of the <code class="computeroutput">get</code>
+ member or free function.
+
+<pre class="programlisting">#include <boost/integer/bitfield_tuple.hpp>
+
+using namespace boost::bitfields;
+
+struct i;
+struct red;
+struct green;
+struct blue;
+
+typedef bitfield_tuple<
+ member<unsigned int,red,5>,
+ member<unsigned int, green, 6>,
+ member<unsinged int, blue,5>
+> rgb565;
+
+// write a function whose return type is the proxy reference type
+// which would be returned from calling get<0>() or get<red>()
+element_n<rgb565,red>::type my_func(rgb565 bft) {
+ return bft.get<red>(); // this could be replaced with get<0>()
+}
+
+// make a const version of my_func
+element_n<const rgb565,red>::type my_func(rgb565 const& bft) {
+ return bft.get<red>(); // this could be replaced with get<0>()
+}
+</pre>
+
+ 
+
+ How to use element_n to make views from a <code class="computeroutput">bitfield_tuple</code>
+ type. <code class="computeroutput">const</code> still applies
+ to the views, if one would like a <code class="computeroutput">const</code>
+ view into something simply supply the <code class="computeroutput">const</code>
+ qualifier to the BitfieldTuple template parameter and that's all that
+ needs to be done.
+
+<pre class="programlisting">#include <boost/integer/bitfield_tuple.hpp>
+#include <cassert>
+
+using namespace boost::bitfields;
+
+struct red;
+struct green;
+struct blue;
+
+typedef bitfield_tuple<
+ storage<std::size_t>,
+ member<char,red,4>,
+ member<unsigned char, green,5>,
+ member<int, salmon, 16>
+> test_tuple_1;
+
+int main() {
+
+ typedef element_n<test_tuple_1,red>::type view_red;
+ std::size_t storage = 0;
+ // constructs the red view type over storage
+ // which is simply std::size_t.
+ view_red red_v(storage);
+ assert(red_v == 0);
+ red_v = 3;
+ assert(red_v == 3);
+ return 0;
+}
+</pre>
+
+ 
+</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 © 2010 Brian Bartman
+ 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="element.html"><img src="../../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../meta_function_reference.html"><img src="../../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../images/home.png" alt="Home"></a><a accesskey="n" href="../boost_fusion_sequence_extension.html"><img src="../../../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,52 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Users Guide</title>
+<link rel="stylesheet" href="../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../../bitfield_tuple/bitfield_tuple.html" title="bitfield_tuple">
+<link rel="prev" href="overview/motivation.html" title="Motivation">
+<link rel="next" href="users_guide/getting_started.html" title="Getting Started">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="overview/motivation.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../bitfield_tuple/bitfield_tuple.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="users_guide/getting_started.html"><img src="../../images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.users_guide"></a><a class="link" href="users_guide.html" title="Users Guide">Users
+ Guide</a>
+</h3></div></div></div>
+<div class="toc"><dl>
+<dt><a href="users_guide/getting_started.html">Getting
+ Started</a></dt>
+<dd><dl>
+<dt>Installation</dt>
+<dt>Dependencies</dt>
+<dt><a href="users_guide/getting_started/building_with_bitfield_tuple.html">Building
+ With bitfield_tuple</a></dt>
+<dt>Testing</dt>
+</dl></dd>
+<dt>Tutorial</dt>
+<dt><a href="users_guide/external_resources.html">External
+ Resources</a></dt>
+<dt>Glossary</dt>
+</dl></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 © 2010 Brian Bartman
+ 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/motivation.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../bitfield_tuple/bitfield_tuple.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="users_guide/getting_started.html"><img src="../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/external_resources.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/external_resources.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,35 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>External Resources</title>
+<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../users_guide.html" title="Users Guide">
+<link rel="prev" href="tutorial.html" title="Tutorial">
+<link rel="next" href="glossary.html" title="Glossary">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="tutorial.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../users_guide.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="glossary.html"><img src="../../../images/next.png" alt="Next"></a>
+</div>
+<div class="section"><div class="titlepage"><div><div><h4 class="title">
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.users_guide.external_resources"></a><a class="link" href="external_resources.html" title="External Resources">External
+ Resources</a>
+</h4></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 © 2010 Brian Bartman
+ 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="tutorial.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../users_guide.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="glossary.html"><img src="../../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,44 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Getting Started</title>
+<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../users_guide.html" title="Users Guide">
+<link rel="prev" href="../users_guide.html" title="Users Guide">
+<link rel="next" href="getting_started/installation.html" title="Installation">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../users_guide.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../users_guide.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="getting_started/installation.html"><img src="../../../images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.users_guide.getting_started"></a><a class="link" href="getting_started.html" title="Getting Started">Getting
+ Started</a>
+</h4></div></div></div>
+<div class="toc"><dl>
+<dt>Installation</dt>
+<dt>Dependencies</dt>
+<dt><a href="getting_started/building_with_bitfield_tuple.html">Building
+ With bitfield_tuple</a></dt>
+<dt>Testing</dt>
+</dl></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 © 2010 Brian Bartman
+ 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="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../users_guide.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="getting_started/installation.html"><img src="../../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started/building_with_bitfield_tuple.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started/building_with_bitfield_tuple.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,40 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Building With bitfield_tuple</title>
+<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../getting_started.html" title="Getting Started">
+<link rel="prev" href="dependencies.html" title="Dependencies">
+<link rel="next" href="testing.html" title="Testing">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="dependencies.html"><img src="../../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../getting_started.html"><img src="../../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../images/home.png" alt="Home"></a><a accesskey="n" href="testing.html"><img src="../../../../images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.users_guide.getting_started.building_with_bitfield_tuple"></a><a class="link" href="building_with_bitfield_tuple.html" title="Building With bitfield_tuple">Building
+ With bitfield_tuple</a>
+</h5></div></div></div>
+
+ Coming Soon.
+ 
+</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 © 2010 Brian Bartman
+ 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="dependencies.html"><img src="../../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../getting_started.html"><img src="../../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../images/home.png" alt="Home"></a><a accesskey="n" href="testing.html"><img src="../../../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started/dependencies.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started/dependencies.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,283 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Dependencies</title>
+<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../getting_started.html" title="Getting Started">
+<link rel="prev" href="installation.html" title="Installation">
+<link rel="next" href="building_with_bitfield_tuple.html" title="Building With bitfield_tuple">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="installation.html"><img src="../../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../getting_started.html"><img src="../../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../images/home.png" alt="Home"></a><a accesskey="n" href="building_with_bitfield_tuple.html"><img src="../../../../images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.users_guide.getting_started.dependencies"></a><a class="link" href="dependencies.html" title="Dependencies">Dependencies</a>
+</h5></div></div></div>
+
+ This section covers both dependencies which are from within boost as
+ well as the requirements for how to enable different extensions of the
+ <code class="computeroutput">bitfield_tuple</code>. Some
+ of the extensions include adjustment of variadic template parameters,
+ and adjust meant for long long support.
+ 
+
+ The following is a list of all dependencies which are included with the
+ <code class="computeroutput">bitfield_tuple</code> header
+ file ( <code class="computeroutput"><boost/integer/bitfield_tuple.hpp></code> ).
+ 
+<div class="note"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td align="left" valign="top">
+ The following header files are included along with the <code class="computeroutput">bitfield_tuple</code> header and are not
+ need to be included by the user to use <code class="computeroutput">bitfield_tuple</code>.
+ This documentation exists for impact analysis and so that the user
+ knows exactly what they are getting when the include the bitfield_tuple
+ header file.
+ </td></tr>
+</table></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.users_guide.getting_started.dependencies.standard_library_includes"></a><h6>
+<a name="id3222585"></a>
+ <a class="link" href="dependencies.html#boost_integer_bits_masks_extension.bitfield_tuple.users_guide.getting_started.dependencies.standard_library_includes">Standard
+ Library Includes</a>
+ </h6>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
+ <cstddef> - Included for <code class="computeroutput">std::size_t</code>.
+ <div class="itemizedlist"><ul class="itemizedlist" type="circle"><li class="listitem">
+ Included by Boost.Integer.Bitfield
+ <div class="itemizedlist"><ul class="itemizedlist" type="square">
+<li class="listitem">
+ <cassert>
+ </li>
+<li class="listitem">
+ <limits>
+ </li>
+</ul></div>
+</li></ul></div>
+</li></ul></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.users_guide.getting_started.dependencies.boost_library_includes"></a><h5>
+<a name="id3222659"></a>
+ <a class="link" href="dependencies.html#boost_integer_bits_masks_extension.bitfield_tuple.users_guide.getting_started.dependencies.boost_library_includes">Boost
+ Library Includes</a>
+ </h5>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.users_guide.getting_started.dependencies.boost_preprocessor"></a><h6>
+<a name="id3222683"></a>
+ <a class="link" href="dependencies.html#boost_integer_bits_masks_extension.bitfield_tuple.users_guide.getting_started.dependencies.boost_preprocessor">boost.Preprocessor</a>
+ </h6>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ <boost/preprocessor/repetition/enum.hpp>
+ </li>
+<li class="listitem">
+ <boost/preprocessor/repetition/repeat_from_to.hpp>
+ </li>
+</ul></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.users_guide.getting_started.dependencies.boost_config"></a><h6>
+<a name="id3222721"></a>
+ <a class="link" href="dependencies.html#boost_integer_bits_masks_extension.bitfield_tuple.users_guide.getting_started.dependencies.boost_config">Boost.Config</a>
+ </h6>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
+ <boost/config.hpp>
+ </li></ul></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.users_guide.getting_started.dependencies.boost_mpl"></a><h6>
+<a name="id3222752"></a>
+ <a class="link" href="dependencies.html#boost_integer_bits_masks_extension.bitfield_tuple.users_guide.getting_started.dependencies.boost_mpl">Boost.MPL</a>
+ </h6>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ <boost/mpl/vector.hpp>
+ </li>
+<li class="listitem">
+ <boost/mpl/not.hpp>
+ </li>
+<li class="listitem">
+ <boost/mpl/deref.hpp>
+ </li>
+<li class="listitem">
+ <boost/mpl/at.hpp>
+ </li>
+<li class="listitem">
+ <boost/mpl/less.hpp>
+ </li>
+<li class="listitem">
+ <boost/mpl/size.hpp>
+ </li>
+<li class="listitem">
+ <boost/mpl/int.hpp>
+ </li>
+<li class="listitem">
+ <boost/mpl/assert.hpp>
+ </li>
+<li class="listitem">
+ <boost/mpl/if.hpp>
+ </li>
+<li class="listitem">
+ <boost/mpl/minus.hpp>
+ </li>
+<li class="listitem">
+ <boost/mpl/size_t.hpp>
+ </li>
+<li class="listitem">
+ <boost/mpl/void.hpp>
+ </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="../../../../images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td align="left" valign="top">
+ The <code class="computeroutput">mpl::vector</code> is a limiting factor of the
+ <code class="computeroutput">bitfield_tuple</code> for
+ more information on how to deal with limitations of the <code class="computeroutput">bitfield_tuple</code> and its dependencies
+ please see the class reference documentation for <code class="computeroutput">bitfield_tuple</code>
+ and <code class="computeroutput">bitfield_reference</code>
+ regarding Preconditions.
+ </td></tr>
+</table></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.users_guide.getting_started.dependencies.boost_type_traits"></a><h6>
+<a name="id3222902"></a>
+ <a class="link" href="dependencies.html#boost_integer_bits_masks_extension.bitfield_tuple.users_guide.getting_started.dependencies.boost_type_traits">Boost.Type
+ Traits</a>
+ </h6>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ <boost/type_traits/add_reference.hpp>
+ </li>
+<li class="listitem">
+ <boost/type_traits/is_const.hpp>
+ </li>
+<li class="listitem">
+ <boost/type_traits/make_unsigned.hpp>
+ </li>
+<li class="listitem">
+ <boost/type_traits/is_same.hpp>
+ </li>
+<li class="listitem">
+ <boost/type_traits/is_pod.hpp>
+ </li>
+</ul></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.users_guide.getting_started.dependencies.boost_static_assert"></a><h6>
+<a name="id3222956"></a>
+ <a class="link" href="dependencies.html#boost_integer_bits_masks_extension.bitfield_tuple.users_guide.getting_started.dependencies.boost_static_assert">Boost.Static
+ Assert</a>
+ </h6>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
+ <boost/static_assert.hpp>
+ </li></ul></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.users_guide.getting_started.dependencies.boost_enable_if"></a><h6>
+<a name="id3222988"></a>
+ <a class="link" href="dependencies.html#boost_integer_bits_masks_extension.bitfield_tuple.users_guide.getting_started.dependencies.boost_enable_if">Boost.Enable
+ If</a>
+ </h6>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
+ <boost/utility/enable_if.hpp>
+ </li></ul></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.users_guide.getting_started.dependencies.boost_fusion"></a><h6>
+<a name="id3223020"></a>
+ <a class="link" href="dependencies.html#boost_integer_bits_masks_extension.bitfield_tuple.users_guide.getting_started.dependencies.boost_fusion">Boost.Fusion</a>
+ </h6>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ <boost/fusion/sequence/intrinsic.hpp>
+ </li>
+<li class="listitem">
+ <boost/fusion/support/is_sequence.hpp>
+ </li>
+<li class="listitem">
+ <boost/fusion/support/is_view.hpp>
+ </li>
+<li class="listitem">
+ <boost/fusion/support/tag_of_fwd.hpp>
+ </li>
+<li class="listitem">
+ <boost/fusion/iterator/iterator_facade.hpp>
+ </li>
+<li class="listitem">
+ <boost/fusion/iterator/value_of.hpp>
+ </li>
+<li class="listitem">
+ <boost/fusion/iterator/deref.hpp>
+ </li>
+<li class="listitem">
+ <boost/fusion/iterator/next.hpp>
+ </li>
+<li class="listitem">
+ <boost/fusion/iterator/prior.hpp>
+ </li>
+<li class="listitem">
+ <boost/fusion/iterator/distance.hpp>
+ </li>
+<li class="listitem">
+ <boost/fusion/iterator/key_of.hpp>
+ </li>
+<li class="listitem">
+ <boost/fusion/iterator/value_of_data.hpp>
+ </li>
+<li class="listitem">
+ <boost/fusion/iterator/deref_data.hpp>
+ </li>
+</ul></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.users_guide.getting_started.dependencies.boost_vault_includes"></a><h6>
+<a name="id3223120"></a>
+ <a class="link" href="dependencies.html#boost_integer_bits_masks_extension.bitfield_tuple.users_guide.getting_started.dependencies.boost_vault_includes">Boost
+ Vault Includes</a>
+ </h6>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
+ <boost/bitfield/bitfield.hpp>
+ </li></ul></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.users_guide.getting_started.dependencies.boost_integer_bit_mask_extension_includes"></a><h6>
+<a name="id3223149"></a>
+ <a class="link" href="dependencies.html#boost_integer_bits_masks_extension.bitfield_tuple.users_guide.getting_started.dependencies.boost_integer_bit_mask_extension_includes">Boost.Integer
+ Bit Mask Extension Includes</a>
+ </h6>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ <boost/integer/bits_mask.hpp>
+ </li>
+<li class="listitem">
+ <boost/integer/bit_width.hpp>
+ </li>
+<li class="listitem">
+ <boost/integer/high_bits_mask.hpp>
+ </li>
+<li class="listitem">
+ <boost/integer/low_bits_mask.hpp>
+ </li>
+<li class="listitem">
+ <boost/integer/integral_mask.hpp>
+ </li>
+</ul></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.users_guide.getting_started.dependencies.bitfield_tuple_include_files_"></a><h6>
+<a name="id3223205"></a>
+ <a class="link" href="dependencies.html#boost_integer_bits_masks_extension.bitfield_tuple.users_guide.getting_started.dependencies.bitfield_tuple_include_files_">Bitfield
+ Tuple Include Files </a>
+ </h6>
+
+ Please see the Files section for a full list and description of all files
+ which are part of the <code class="computeroutput">bitfield_tuple</code>
+ and its interface.
+ 
+</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 © 2010 Brian Bartman
+ 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="installation.html"><img src="../../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../getting_started.html"><img src="../../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../images/home.png" alt="Home"></a><a accesskey="n" href="building_with_bitfield_tuple.html"><img src="../../../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started/installation.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started/installation.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,39 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Installation</title>
+<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../getting_started.html" title="Getting Started">
+<link rel="prev" href="../getting_started.html" title="Getting Started">
+<link rel="next" href="dependencies.html" title="Dependencies">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../getting_started.html"><img src="../../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../getting_started.html"><img src="../../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../images/home.png" alt="Home"></a><a accesskey="n" href="dependencies.html"><img src="../../../../images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.users_guide.getting_started.installation"></a><a class="link" href="installation.html" title="Installation">Installation</a>
+</h5></div></div></div>
+
+ Coming Soon.
+ 
+</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 © 2010 Brian Bartman
+ 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="../getting_started.html"><img src="../../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../getting_started.html"><img src="../../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../images/home.png" alt="Home"></a><a accesskey="n" href="dependencies.html"><img src="../../../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started/testing.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started/testing.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,75 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Testing</title>
+<link rel="stylesheet" href="../../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../getting_started.html" title="Getting Started">
+<link rel="prev" href="building_with_bitfield_tuple.html" title="Building With bitfield_tuple">
+<link rel="next" href="../tutorial.html" title="Tutorial">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="building_with_bitfield_tuple.html"><img src="../../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../getting_started.html"><img src="../../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../images/home.png" alt="Home"></a><a accesskey="n" href="../tutorial.html"><img src="../../../../images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.users_guide.getting_started.testing"></a><a class="link" href="testing.html" title="Testing">Testing</a>
+</h5></div></div></div>
+
+ List of compilers which the library has been tested on.
+ 
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ GCC
+ <div class="itemizedlist"><ul class="itemizedlist" type="circle"><li class="listitem">
+ GCC-4.4.3
+ </li></ul></div>
+</li>
+<li class="listitem">
+ MSVC
+ <div class="itemizedlist"><ul class="itemizedlist" type="circle">
+<li class="listitem">
+ MSVC 10.0
+ </li>
+<li class="listitem">
+ MSVC 9.0
+ </li>
+</ul></div>
+</li>
+<li class="listitem">
+ Cygwin
+ <div class="itemizedlist"><ul class="itemizedlist" type="circle"><li class="listitem">
+ GCC-3.4.4
+ </li></ul></div>
+</li>
+<li class="listitem">
+ MinGW with
+ <div class="itemizedlist"><ul class="itemizedlist" type="circle">
+<li class="listitem">
+ GCC 4.4.0
+ </li>
+<li class="listitem">
+ GCC 4.5.0
+ </li>
+</ul></div>
+</li>
+</ul></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 © 2010 Brian Bartman
+ 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="building_with_bitfield_tuple.html"><img src="../../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../getting_started.html"><img src="../../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../images/home.png" alt="Home"></a><a accesskey="n" href="../tutorial.html"><img src="../../../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/glossary.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/glossary.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,82 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Glossary</title>
+<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../users_guide.html" title="Users Guide">
+<link rel="prev" href="external_resources.html" title="External Resources">
+<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"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="external_resources.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../users_guide.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="../reference.html"><img src="../../../images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.users_guide.glossary"></a><a class="link" href="glossary.html" title="Glossary">Glossary</a>
+</h4></div></div></div>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+ Bit Field Related Resourses
+ <div class="itemizedlist"><ul class="itemizedlist" type="circle">
+<li class="listitem">
+<a href="http://en.wikipedia.org/wiki/Bit_field" target="_top">Wikipedia Bit
+ Field</a> - Wikipedia article on bit fields.
+ </li>
+<li class="listitem">
+<a href="http://msdn.microsoft.com/en-us/library/ewwyfdbe%28VS.71%29.aspx" target="_top">Microsoft
+ Bit Field</a> - MSDN article on bit fields.
+ </li>
+<li class="listitem">
+<a href="http://publications.gbdirect.co.uk/c_book/chapter6/bitfields.html" target="_top">C
+ - Book: Bitfields</a> - Chapter on bit fields from a book on
+ C.
+ </li>
+<li class="listitem">
+<a href="http://publib.boulder.ibm.com/infocenter/macxhelp/v6v81/index.jsp?topic=/com.ibm.vacpp6m.doc/language/ref/clrc03defbitf.htm" target="_top">IBM
+ Bit Field Documentation</a> - Documentation page on the IBM about
+ bit fields.
+ </li>
+</ul></div>
+</li>
+<li class="listitem">
+ Data Structure Packing Resourses.
+ <div class="itemizedlist"><ul class="itemizedlist" type="circle"><li class="listitem">
+<a href="http://en.wikipedia.org/wiki/Data_structure_alignment" target="_top">Wikipedia
+ Data Struture Alignment</a> - Data Structure Alignment article
+ from Wikipedia. This relates directly to packing of data structures.
+ </li></ul></div>
+</li>
+<li class="listitem">
+ Endianness
+ <div class="itemizedlist"><ul class="itemizedlist" type="circle">
+<li class="listitem">
+Wikipedia Endianness
+ - Wikipedia article on endianness.
+ </li>
+<li class="listitem">
+Endians
+ - In boost standbox.
+ </li>
+</ul></div>
+</li>
+</ul></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 © 2010 Brian Bartman
+ 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="external_resources.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../users_guide.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="../reference.html"><img src="../../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/tutorial.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/tutorial.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,481 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Tutorial</title>
+<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../users_guide.html" title="Users Guide">
+<link rel="prev" href="getting_started/testing.html" title="Testing">
+<link rel="next" href="external_resources.html" title="External Resources">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="getting_started/testing.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../users_guide.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="external_resources.html"><img src="../../../images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.users_guide.tutorial"></a><a class="link" href="tutorial.html" title="Tutorial">Tutorial</a>
+</h4></div></div></div>
+
+ In this section I will walk you through step by step process about how
+ to create a <code class="computeroutput">bitfield_tuple</code>
+ and all of the different functionalities it provides.
+ 
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.users_guide.tutorial.part_1__the_basics"></a><h6>
+<a name="id3223378"></a>
+ <a class="link" href="tutorial.html#boost_integer_bits_masks_extension.bitfield_tuple.users_guide.tutorial.part_1__the_basics">Part
+ 1: The Basics</a>
+ </h6>
+
+ The <code class="computeroutput">bitfield_tuple</code> template
+ is included into your project including the following header:
+
+<pre class="programlisting">#include <boost/integer/bitfield_tuple.hpp>
+</pre>
+
+ After the file is included you're ready to begin creating a <code class="computeroutput">bitfield_tuple</code>. Here is a <code class="computeroutput">struct</code> that, contains bitfields, that is
+ going to be used to model an instance of the bitfield tuple after.
+
+<pre class="programlisting">struct foo {
+ bool flag_1:1;
+ bool flag_2:1;
+ int int_1:2;
+ int int_2:2;
+};
+</pre>
+
+ In the next example a <code class="computeroutput">bitfield_tuple</code>
+ type is made to model <code class="computeroutput">struct foo</code>'s behavior but reduce its storage
+ from 4 bytes to one.
+
+<pre class="programlisting">using namespace boost;
+using namespace boost::bitfields;
+// names used to mimic the names in struct foo.
+struct flag_1;
+struct flag_2;
+struct int_1;
+struct int_2;
+
+
+typedef bitfield_tuple<
+ storage<char>,
+ member<bool,flag_1,1>,
+ member<bool, flag_2,1>,
+ member<int, int_1,2>,
+ member<int, int_2,2>
+> bitfield_tuple_foo;
+</pre>
+
+ The above example may look a little confusing at first but when broken
+ down it's made to be as simple as possible. <code class="computeroutput">storage<char></code> specifies to the <code class="computeroutput">bitfield_tuple</code>
+ template that the type which is going to be used for storage is a <code class="computeroutput">char</code> type(this can be any integral type).
+ The <code class="computeroutput">member</code> templates read
+ just like the bitfields within <code class="computeroutput">struct
+ foo</code>, so type, name, width in
+ bits. <code class="computeroutput">member<int, int_1,2></code>
+ specifies a bitfield which is of type <code class="computeroutput">int</code>,
+ has the name <code class="computeroutput">int_1</code>, and
+ a width of 2 bits.
+ 
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.users_guide.tutorial.part_2__using_the_tuple"></a><h5>
+<a name="id3224056"></a>
+ <a class="link" href="tutorial.html#boost_integer_bits_masks_extension.bitfield_tuple.users_guide.tutorial.part_2__using_the_tuple">Part
+ 2: Using the tuple</a>
+ </h5>
+
+ Here is an example of the <code class="computeroutput">bitfield_tuple</code>
+ accessor function. <code class="computeroutput">bitfield_tuple</code>
+ uses the similar accessor function as boost.tuple, there are two main differences
+ between the accessor funciton's for <code class="computeroutput">bitfield_tuple</code>
+ and boost.tuple. The first difference is that <code class="computeroutput">bitfield_tuple</code>
+ doesn't return a real reference, it instead returns a proxy to the bitfeild
+ that it represents. Second, the names specified in the above example are
+ not just for show, they are actually used to name the type within the a
+ bitfield_tuple and can be used to access them in the same fashion as the
+ index relative get function.
+ 
+<div class="note"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td align="left" valign="top">
+ <code class="computeroutput">get</code> index accessor function.
+ The index for accessing member of <code class="computeroutput">bitfield_tuple</code>
+ is relative to the number of <code class="computeroutput">members</code>
+ specified inside of the <code class="computeroutput">bitfield_tuple</code>'s
+ template parameters. Other types supplied to the <code class="computeroutput">bitfield_tuple</code>
+ and not counted for the index. For instance, in the above example the
+ type <code class="computeroutput">storage<char></code>
+ does not effect the index of any of the members after it.
+ </td></tr>
+</table></div>
+
+ The following example shows the two different ways that the <code class="computeroutput">get</code> member funciton can be used to retrieve
+ data from within a <code class="computeroutput">bitfield_tuple</code>
+ by either using a name or an index.
+
+<pre class="programlisting">#include <boost/integer/bitfield_tuple.hpp>
+#include <iostream>
+
+using namespace boost::bitfields;
+
+// names used to mimic the names in struct foo.
+struct flag_1;
+struct flag_2;
+struct int_1;
+struct int_2;
+
+
+typedef bitfield_tuple<
+ storage<char>,
+ member<bool,flag_1,1>,
+ member<bool, flag_2,1>,
+ member<int, int_1,2>,
+ member<int, int_2,2>
+> bitfield_tuple_foo;
+
+int main() {
+ bitfield_tuple_foo foo;
+ foo.get<flag_1>() = true; // returns the proxy to the boolean member at flag_1
+ if(foo.get<0>() ){ // get<0>() gets the member at index 0 which is the same as flag_1
+ std::cout << "flag_1 is true"<< std::endl;
+ }
+}
+</pre>
+
+ 
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.users_guide.tutorial.part_3__slightly_more_advanced"></a><h6>
+<a name="id3224773"></a>
+ <a class="link" href="tutorial.html#boost_integer_bits_masks_extension.bitfield_tuple.users_guide.tutorial.part_3__slightly_more_advanced">Part
+ 3: Slightly More Advanced</a>
+ </h6>
+
+ There are ways to simplify the <code class="computeroutput">bitfield_tuple_foo</code>'s
+ template declaration. This part of the tutorial covers the additional functionalities
+ provided by the <code class="computeroutput">bitfield_tuple</code>
+ which can be used to simplify the creation of more complex <code class="computeroutput">bitfield_tuple</code>.
+ 
+
+ The different templates that can be used within a <code class="computeroutput">bitfield_tuple</code>'s
+ template declaration.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Signature
+ 
+ </th>
+<th>
+ 
+ Brief Description
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">padding<std::size_t></code>
+ 
+ </td>
+<td>
+ 
+ Padding in bits that can be used to separate bitfield.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">align<std::size_t></code>
+ 
+ </td>
+<td>
+ 
+ Sets the offset of the first bit of the next bitfield supplied
+ to a multiple of the integer supplied.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">flag<typename></code>
+ 
+ </td>
+<td>
+ 
+ Makes a single bit width boolean <code class="computeroutput">member</code>
+ with a name supplied to as the parameter.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">member<typename,
+ typename,
+ std::size_t></code>
+ 
+ </td>
+<td>
+ 
+ Used for specifying a member where the first parameter is the
+ type being stored, the second is the name and the third is the
+ width in bits.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">storage<typename></code>
+ 
+ </td>
+<td>
+ 
+ The type specified in this parameter is used as the storage.
+ This parameter is optional and it doesn't matter where in the
+ template you put it.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">pointer<typename,typename,typename></code>
+ 
+ </td>
+<td>
+ 
+ This allows for a pointer to have bits stuffed into it and have
+ both extracted separately but stored together.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">custom<typename,typename,typename,typename></code>
+ 
+ </td>
+<td>
+ 
+ This type allows for custom packing and unpacking of the the
+ data before it is stored within the bitfield_tuple.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<div class="tip"><table border="0" summary="Tip">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="../../../images/tip.png"></td>
+<th align="left">Tip</th>
+</tr>
+<tr><td align="left" valign="top">
+ Read the documentation under the class reference section for additional
+ information about the templates used to create the <code class="computeroutput">bitfield_tuple</code>
+ type.
+ </td></tr>
+</table></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.users_guide.tutorial.part_4__fusion_sequence_extension"></a><h6>
+<a name="id3225317"></a>
+ <a class="link" href="tutorial.html#boost_integer_bits_masks_extension.bitfield_tuple.users_guide.tutorial.part_4__fusion_sequence_extension">Part
+ 4: Fusion Sequence extension</a>
+ </h6>
+
+ The <code class="computeroutput">bitfield_tuple</code> is a
+ boost.fusion sequence. It supports the all of the functionality that is
+ supported by a random access container and an associative sequence. The
+ <code class="computeroutput">bitfield_tuple</code> internally
+ stores its fields as an associative array. This allows the <code class="computeroutput">bitfield_tuple</code> to provide both index
+ based as well as named <code class="computeroutput">get</code>
+ functions. For full documentation of how to use boost.fusion see the boost.fusion
+ documentation. For the Boost.Fusion features supported by the <code class="computeroutput">bitfield_tuple</code> see the fusion extension
+ documentation located in the reference section of the documentation.
+ 
+
+
+
+<pre class="programlisting">#include <boost/integer/bitfield_tuple.hpp>
+#include <iostream>
+#include <boost/fusion/include/for_each.hpp>
+
+using namespace boost::bitfields;
+
+struct red;
+struct green;
+struct pink;
+struct blue;
+struct salmon;
+
+typedef bitfield_tuple<
+ member<char,red,4>,
+ member<unsigned char, green,5>,
+ member<int, salmon, 16>,
+ storage<std::size_t>
+> fusion_example_tuple;
+
+struct unary_function_object{
+ template <typename T>
+ void operator() (T x) {
+ std::cout << x << std::endl;
+ }
+};
+
+int main() {
+
+ fusion_example_tuple bft;
+ bft.get<0>() = 1;
+ bft.get<1>() = 2;
+ bft.get<2>() = 3;
+
+ boost::fusion::for_each(bft,unary_function_object());
+ return 0;
+}
+</pre>
+
+ The above code uses the fusion for_each to iterate over each element within
+ the bitfield_tuple and print it. For a full description of all of the Boost.Fusion
+ supported operations please see the section of the documentation relating
+ to the Boost.Fusion sequence extension.
+ 
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.users_guide.tutorial.part_5__pointer_stuffing"></a><h6>
+<a name="id3226221"></a>
+ <a class="link" href="tutorial.html#boost_integer_bits_masks_extension.bitfield_tuple.users_guide.tutorial.part_5__pointer_stuffing">Part
+ 5: Pointer stuffing</a>
+ </h6>
+
+ <code class="computeroutput">bitfield_tuple</code> provides
+ a mechanism for for stuffing bits into pointers (as well as other things).
+ For a more in depth description of the <code class="computeroutput">pointer</code>
+ member of <code class="computeroutput">bitfield_tuple</code>
+ please refer to the documentation for <code class="computeroutput">pointer</code>.
+ The following is a basic example for pointers which point to DWORD aligned
+ sections of memory.
+ 
+
+
+
+<pre class="programlisting">#include <boost/integer/bitfield_tuple.hpp>
+#include <boost/assert.hpp>
+struct color;
+struct ptr;
+
+typedef bitfield_tuple<
+ pointer<int, ptr>,
+ member<unsigned int,color,2>
+> color_stuffed_ptr_tuple;
+
+using namespace boost::bitfields;
+
+int main() {
+ int* some_ptr = new int();
+ color_stuffed_ptr_tuple colored_ptr;
+ colored_ptr.get<ptr>() = some_ptr;
+ colored_ptr.get<color>() = 3;
+
+ // set the value of the thing being pointed at to 3.
+ *colored_ptr.get<ptr>() = 3;
+
+ // make sure that the color is correctly set.
+ BOOST_ASSERT(( colored_ptr.get<color>() == 3 ));
+
+ return 0;
+}
+
+</pre>
+
+ There is much more one can do with a stuffed pointer but this is the minimal
+ example of how to use the <code class="computeroutput">pointer</code>
+ member.
+ 
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.users_guide.tutorial.part_5__custom_integral_stuffing"></a><h6>
+<a name="id3226875"></a>
+ <a class="link" href="tutorial.html#boost_integer_bits_masks_extension.bitfield_tuple.users_guide.tutorial.part_5__custom_integral_stuffing">Part
+ 5: Custom Integral Stuffing</a>
+ </h6>
+
+ The <code class="computeroutput">custom</code> member allows
+ the user to specify a section of bits within a type and extract those bits
+ and then store them inside of the <code class="computeroutput">bitfield_tuple</code>.
+ One of the use cases for something like this is if a number is always even
+ then the last bit is always zero. The following example is how to specify
+ the <code class="computeroutput">custom</code> member such
+ that it is used to store an always even number.
+ 
+
+
+
+<pre class="programlisting">#include <boost/integer/bitfield_tuple.hpp>
+
+using namespace boost::bitfields;
+struct always_even_int;
+struct extra_bool;
+typedef bitfield_tuple<
+ custom<
+ unsigned int,
+ always_even_int,
+ boost::high_bits_mask<
+ unsigned int,
+ (boost::bit_width<unsigned int>::value - 1)
+ >
+ >,
+ flag<extra_bool>
+> custom_stuffing;
+
+int main() {
+ custom_stuffing cs;
+ cs.get<always_even_int>() = 4;
+
+ BOOST_ASSERT(( cs.get<always_even_int>() == 4));
+ cs.get<extra_bool>() = true;
+
+ BOOST_ASSERT(( sizeof(custom_stuffing) == sizeof(unsigned int) ));
+}
+</pre>
+
+ The <code class="computeroutput">high_bits_mask</code> in the
+ above example, is what is used to specify the value bits within the value
+ type. The mask is used to extract the value bits out of the <code class="computeroutput">unsigned int</code>
+ when the <code class="computeroutput">get<alway_even_int()</code>'s
+ value type assignment operator is called. When the <code class="computeroutput">operator
+ value_type()</code>
+ the function returns the value bits so that they match the mask that was
+ used to take them. For instance, if the order of the template parameters
+ was switched so that the <code class="computeroutput">flag<extra_bool></code> was to be first and the <code class="computeroutput">custom</code> member second the data structure
+ would look exactly the same, but there would be a slight difference in
+ performance because of the shifts which would have to occur in order to
+ correctly unpack or pack the type before it is returned or stored.
+ 
+
+ There is much more that can be done with the <code class="computeroutput">custom</code>
+ member type then what is shown for additional information on how to fully
+ utilize all features of this type please see the documentation relating
+ the <code class="computeroutput">custom</code> member.
+ 
+</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 © 2010 Brian Bartman
+ 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="getting_started/testing.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../users_guide.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="external_resources.html"><img src="../../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/high_bits_mask/bit_masks/high_bits_maskbits.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/high_bits_mask/bit_masks/high_bits_maskbits.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,352 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>high_bits_mask</title>
+<link rel="stylesheet" href="../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../../boost_integer_bits_masks_extension/bit_masks.html" title="Bit Masks">
+<link rel="prev" href="../../integral_mask/bit_masks/integral_mask.html" title="integral_mask">
+<link rel="next" href="../../low_bits_mask/bit_masks/low_bits_mask.html" title="low_bits_mask">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../../integral_mask/bit_masks/integral_mask.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_integer_bits_masks_extension/bit_masks.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../../low_bits_mask/bit_masks/low_bits_mask.html"><img src="../../images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="high_bits_mask.bit_masks.high_bits_maskbits"></a><a class="link" href="high_bits_maskbits.html" title="high_bits_mask"> high_bits_mask</a>
+</h3></div></div></div>
+<a name="high_bits_mask.bit_masks.high_bits_maskbits.description"></a><h4>
+<a name="id3215549"></a>
+ <a class="link" href="high_bits_maskbits.html#high_bits_mask.bit_masks.high_bits_maskbits.description">Description</a>
+ </h4>
+
+ The <code class="computeroutput">high_bits_mask</code> is an
+ abstract representation of a contiguous section of bits which extend out
+ from the most significant bit towards the least significant bit. The <code class="computeroutput">high_bits_mask</code> changes base on the width
+ of the type but always maintains the same high level description of the bits.
+ For example,
+
+<pre class="programlisting">// using high bits to create a mask starting from the left most bit with a width
+// of 15
+typedef high_bits_mask<int, 15> bits;
+// bits::value will have the following value in binary.
+// 1111 1111 1111 1110 0000 0000 0000 0000
+</pre>
+
+ 
+<a name="high_bits_mask.bit_masks.high_bits_maskbits.header_file_information"></a><h4>
+<a name="id3215662"></a>
+ <a class="link" href="high_bits_maskbits.html#high_bits_mask.bit_masks.high_bits_maskbits.header_file_information">Header
+ File Information</a>
+ </h4>
+
+
+
+<pre class="programlisting">#include <boost/integer/high_bits_mask.hpp>
+#include <boost/integer/high_low_mask.hpp>
+</pre>
+
+ 
+<a name="high_bits_mask.bit_masks.high_bits_maskbits.template_signature"></a><h4>
+<a name="id3215777"></a>
+ <a class="link" href="high_bits_maskbits.html#high_bits_mask.bit_masks.high_bits_maskbits.template_signature">Template
+ Signature</a>
+ </h4>
+
+ <code class="computeroutput">high_bits_mask</code> has the following
+ template signature:
+
+<pre class="programlisting">namespace boost {
+template <typename T, unsigned int Width> struct high_bits_mask;
+}
+</pre>
+
+ 
+<a name="high_bits_mask.bit_masks.high_bits_maskbits.bit_mask_hierarchy"></a><h4>
+<a name="id3215893"></a>
+ <a class="link" href="high_bits_maskbits.html#high_bits_mask.bit_masks.high_bits_maskbits.bit_mask_hierarchy">Bit
+ Mask Hierarchy</a>
+ </h4>
+
+ <code class="computeroutput">high_bits_mask</code> inherits from
+ <code class="computeroutput">integral_mask</code>.
+ 
+<a name="high_bits_mask.bit_masks.high_bits_maskbits.template_parameters"></a><h4>
+<a name="id3215933"></a>
+ <a class="link" href="high_bits_maskbits.html#high_bits_mask.bit_masks.high_bits_maskbits.template_parameters">Template
+ Parameters</a>
+ </h4>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Parameter
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">T</code>
+ 
+ </td>
+<td>
+ 
+ Is an integral type which the mask is to be created over.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">Width</code>
+ 
+ </td>
+<td>
+ 
+ This is the width of the mask in bits.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="high_bits_mask.bit_masks.high_bits_maskbits.interface"></a><h4>
+<a name="id3216040"></a>
+ <a class="link" href="high_bits_maskbits.html#high_bits_mask.bit_masks.high_bits_maskbits.interface">Interface</a>
+ </h4>
+
+ <code class="computeroutput">high_bits_mask</code> Compile time
+ interface. Assume that N is of type <code class="computeroutput">high_bits_mask<int,
+ 10></code>
+ the type supplied here is only for example.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Operation
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::value</code>
+ 
+ </td>
+<td>
+ 
+ Returns the <code class="computeroutput">value</code>
+ associated with <code class="computeroutput">N</code>.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::value_type</code>
+ 
+ </td>
+<td>
+ 
+ Returns <code class="computeroutput">T</code> which
+ is the type associated with <code class="computeroutput">value</code>
+ inside <code class="computeroutput">N</code>.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::type</code>
+ 
+ </td>
+<td>
+ 
+ Returns the current types type.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::offset</code>
+ 
+ </td>
+<td>
+ 
+ Always set to zero for this type. The offset is something which
+ all of the mask type support and refers the amount the mask has
+ been shifted to the right or the left (Depending on the type of
+ mask used). In the case of <code class="computeroutput">integral_mask</code>,
+ no left or right shift has occurred so <code class="computeroutput">N::offset</code>
+ is always set to zero.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::width</code>
+ 
+ </td>
+<td>
+ 
+ Returns the integral value associated with the <code class="computeroutput">width</code>
+ template parameter.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">operator T()</code>
+ 
+ </td>
+<td>
+ 
+ Run time support function. Returns <code class="computeroutput">value</code>.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="high_bits_mask.bit_masks.high_bits_maskbits.preconditions"></a><h4>
+<a name="id3216440"></a>
+ <a class="link" href="high_bits_maskbits.html#high_bits_mask.bit_masks.high_bits_maskbits.preconditions">Preconditions</a>
+ </h4>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Precondition
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+<th>
+ 
+ Enforcement
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">bit_width<T>::value >=
+ Width</code>
+ 
+ </td>
+<td>
+ 
+ The <code class="computeroutput">Width</code> must
+ not be greater then the size in bits of type <code class="computeroutput">T</code>.
+ 
+ </td>
+<td>
+ 
+ Enforced by static assert.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">T</code> must be an integral
+ type.
+ 
+ </td>
+<td>
+ 
+ This is only a documented precondition. It is not enforced.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="high_bits_mask.bit_masks.high_bits_maskbits.examples"></a><h4>
+<a name="id3216614"></a>
+ <a class="link" href="high_bits_maskbits.html#high_bits_mask.bit_masks.high_bits_maskbits.examples">Examples</a>
+ </h4>
+
+ Examples and use cases related to the <code class="computeroutput">high_bits_mask</code>
+ template.
+ 
+
+ Example:
+
+<pre class="programlisting">typedef high_bits_mask<int,4> mask;
+
+// binary for mask::value
+// 1111 0000 0000 0000 0000 0000 0000 0000
+
+int integral_value = 0xc000000c;
+
+// integral_value's binary value
+// 1100 0000 0000 0000 0000 0000 0000 1100
+
+int result = integral_value & mask();
+// binary value of result
+// 1100 0000 0000 0000 0000 0000 0000 0000
+
+</pre>
+
+ 
+
+ The implicit cast operator allows for simplicity, clairity of code. In the
+ above example <code class="computeroutput">mask()</code>
+ could be replaced with <code class="computeroutput">mask::value</code>
+ to achieve the same result. The same applies to all other bitwise operators.
+ 
+</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 © 2010 Brian Bartman
+ 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="../../integral_mask/bit_masks/integral_mask.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_integer_bits_masks_extension/bit_masks.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../../low_bits_mask/bit_masks/low_bits_mask.html"><img src="../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/index.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/index.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,144 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Boost.Integer Bits Masks Extension</title>
+<link rel="stylesheet" href="boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="next" href="boost_integer_bits_masks_extension/HeaderSummary.html" title="Header File Summary">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav"><a accesskey="n" href="boost_integer_bits_masks_extension/HeaderSummary.html"><img src="images/next.png" alt="Next"></a></div>
+<div class="article">
+<div class="titlepage">
+<div>
+<div><h2 class="title">
+<a name="boost_integer_bits_masks_extension"></a>Boost.Integer Bits Masks Extension</h2></div>
+<div><div class="authorgroup"><div class="author"><h3 class="author">
+Brian Bartman
+</h3></div></div></div>
+<div>Copyright © 2010 Brian Bartman</div>
+<div><div class="legalnotice">
+<a name="id3204141"></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><a href="boost_integer_bits_masks_extension/HeaderSummary.html"> Header
+ File Summary</a></dt>
+<dt>Bit Masks</dt>
+<dd><dl>
+<dt>Overview</dt>
+<dd><dl>
+<dt>Description</dt>
+<dt>Rationale</dt>
+</dl></dd>
+<dt><a href="integral_mask/bit_masks/integral_mask.html"> integral_mask
+ </a></dt>
+<dt> high_bits_mask</dt>
+<dt> low_bits_mask</dt>
+<dt> bits_mask</dt>
+<dt> bit_width</dt>
+</dl></dd>
+<dt>bitfield_tuple</dt>
+<dd><dl>
+<dt>overview</dt>
+<dd><dl>
+<dt>Description</dt>
+<dt>Motivation</dt>
+</dl></dd>
+<dt><a href="boost_integer_bits_masks_extension/bitfield_tuple/users_guide.html">Users
+ Guide</a></dt>
+<dd><dl>
+<dt><a href="boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started.html">Getting
+ Started</a></dt>
+<dd><dl>
+<dt>Installation</dt>
+<dt>Dependencies</dt>
+<dt><a href="boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started/building_with_bitfield_tuple.html">Building
+ With bitfield_tuple</a></dt>
+<dt>Testing</dt>
+</dl></dd>
+<dt>Tutorial</dt>
+<dt><a href="boost_integer_bits_masks_extension/bitfield_tuple/users_guide/external_resources.html">External
+ Resources</a></dt>
+<dt>Glossary</dt>
+</dl></dd>
+<dt>Reference</dt>
+<dd><dl>
+<dt>Concepts</dt>
+<dt><a href="boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_class_reference.html">bitfield_tuple
+ Class Reference</a></dt>
+<dd><dl>
+<dt><a href="boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_class_reference/bitfield_tuple_and_bitfield_reference.html">bitfield_tuple
+ and bitfield_reference</a></dt>
+<dt>padding</dt>
+<dt>member</dt>
+<dt>flag</dt>
+<dt>align</dt>
+<dt>storage</dt>
+<dt>pointer</dt>
+<dt>custom</dt>
+</dl></dd>
+<dt><a href="boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_macro_reference.html">bitfield_tuple
+ Macro Reference</a></dt>
+<dd><dl>
+<dt><a href="boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_macro_reference/parameter_adjustment_macros.html">Parameter
+ Adjustment macros</a></dt>
+<dt><a href="boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_macro_reference/code_generation_macros.html">Code
+ Generation Macros</a></dt>
+</dl></dd>
+<dt><a href="boost_integer_bits_masks_extension/bitfield_tuple/reference/function_reference.html">Function
+ Reference</a></dt>
+<dd><dl>
+<dt><a href="boost_integer_bits_masks_extension/bitfield_tuple/reference/function_reference/make_bitfield_tuple.html">
+ make_bitfield_tuple Free Function</a></dt>
+<dt><a href="boost_integer_bits_masks_extension/bitfield_tuple/reference/function_reference/get.html">
+ get Free Function</a></dt>
+</dl></dd>
+<dt><a href="boost_integer_bits_masks_extension/bitfield_tuple/reference/meta_function_reference.html">Meta-Function
+ Reference</a></dt>
+<dd><dl>
+<dt><a href="boost_integer_bits_masks_extension/bitfield_tuple/reference/meta_function_reference/element.html">
+ struct element</a></dt>
+<dt><a href="boost_integer_bits_masks_extension/bitfield_tuple/reference/meta_function_reference/element_n.html">
+ struct element_n</a></dt>
+</dl></dd>
+<dt><a href="boost_integer_bits_masks_extension/bitfield_tuple/reference/boost_fusion_sequence_extension.html">Boost.Fusion
+ Sequence Extension</a></dt>
+<dt>Files</dt>
+</dl></dd>
+<dt>Appendices</dt>
+<dd><dl>
+<dt><a href="boost_integer_bits_masks_extension/bitfield_tuple/appendices/design_rationale.html">Design
+ Rationale</a></dt>
+<dt><a href="boost_integer_bits_masks_extension/bitfield_tuple/appendices/implementation_details.html">Implementation
+ Details</a></dt>
+<dd><dl><dt><a href="boost_integer_bits_masks_extension/bitfield_tuple/appendices/implementation_details/internal_documentation.html">Internal
+ documentation</a></dt></dl></dd>
+<dt>Acknowledgments</dt>
+<dt><a href="boost_integer_bits_masks_extension/bitfield_tuple/appendices/future_work.html">Future
+ Work</a></dt>
+</dl></dd>
+</dl></dd>
+</dl>
+</div>
+
+ 
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left">Last revised: August 22, 2010 at 14:33:26 GMT</td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav"><a accesskey="n" href="boost_integer_bits_masks_extension/HeaderSummary.html"><img src="images/next.png" alt="Next"></a></div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/integral_mask/bit_masks/integral_mask.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/integral_mask/bit_masks/integral_mask.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,349 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>integral_mask</title>
+<link rel="stylesheet" href="../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../../boost_integer_bits_masks_extension/bit_masks.html" title="Bit Masks">
+<link rel="prev" href="../../Rationale/bit_masks/overview/rationale.html" title="Rationale">
+<link rel="next" href="../../high_bits_mask/bit_masks/high_bits_maskbits.html" title="high_bits_mask">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../../Rationale/bit_masks/overview/rationale.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_integer_bits_masks_extension/bit_masks.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../../high_bits_mask/bit_masks/high_bits_maskbits.html"><img src="../../images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="integral_mask.bit_masks.integral_mask"></a><a class="link" href="integral_mask.html" title="integral_mask"> integral_mask
+ </a>
+</h3></div></div></div>
+<a name="integral_mask.bit_masks.integral_mask.description"></a><h4>
+<a name="id3214326"></a>
+ <a class="link" href="integral_mask.html#integral_mask.bit_masks.integral_mask.description">Description</a>
+ </h4>
+
+ The <code class="computeroutput">integral_mask</code> type is
+ the most basic mask type. It is used to abstract all masks back to a simple
+ integral type. This type is used similar to an <code class="computeroutput">integral_constant</code>
+ type from the Boost.Type Traits library.
+ 
+<a name="integral_mask.bit_masks.integral_mask.header_file_information"></a><h4>
+<a name="id3214370"></a>
+ <a class="link" href="integral_mask.html#integral_mask.bit_masks.integral_mask.header_file_information">Header
+ File Information</a>
+ </h4>
+
+
+
+<pre class="programlisting">#include <boost/integer/integral_mask.hpp>
+</pre>
+
+ 
+<a name="integral_mask.bit_masks.integral_mask.template_signature"></a><h4>
+<a name="id3214441"></a>
+ <a class="link" href="integral_mask.html#integral_mask.bit_masks.integral_mask.template_signature">Template
+ Signature</a>
+ </h4>
+
+ <code class="computeroutput">integral_mask</code> has the following
+ template signature:
+
+<pre class="programlisting">namespace boost {
+template <typename T, T Value> struct integral_mask;
+} // end boost
+</pre>
+
+ 
+<a name="integral_mask.bit_masks.integral_mask.bit_mask_hierarchy"></a><h4>
+<a name="id3214556"></a>
+ <a class="link" href="integral_mask.html#integral_mask.bit_masks.integral_mask.bit_mask_hierarchy">Bit
+ Mask Hierarchy</a>
+ </h4>
+
+ All other mask types either derive directly or indirectly from this class.
+ The <code class="computeroutput">integral_mask</code> class inherits
+ from <code class="computeroutput">integral_constant</code>.
+ 
+<a name="integral_mask.bit_masks.integral_mask.template_parameters"></a><h4>
+<a name="id3214598"></a>
+ <a class="link" href="integral_mask.html#integral_mask.bit_masks.integral_mask.template_parameters">Template
+ Parameters</a>
+ </h4>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Parameter
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">T</code>
+ 
+ </td>
+<td>
+ 
+ The type of the the mask.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">value</code>
+ 
+ </td>
+<td>
+ 
+ The integral value of the mask.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="integral_mask.bit_masks.integral_mask.preconditions"></a><h4>
+<a name="id3214706"></a>
+ <a class="link" href="integral_mask.html#integral_mask.bit_masks.integral_mask.preconditions">Preconditions</a>
+ </h4>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Precondition
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+<th>
+ 
+ Enforcement
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">T</code> must be an integral
+ type.
+ 
+ </td>
+<td>
+ 
+ This is only a documented precondition. It is not enforced.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">Value</code> must be in
+ the domain of the integral type <code class="computeroutput">T</code>.
+ 
+ </td>
+<td>
+ 
+ This is only a documented precondition. It is not enforced.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="integral_mask.bit_masks.integral_mask.interface"></a><h4>
+<a name="id3214844"></a>
+ <a class="link" href="integral_mask.html#integral_mask.bit_masks.integral_mask.interface">Interface</a>
+ </h4>
+
+ <code class="computeroutput">Integral_mask</code> Compile time
+ interface. Assume that <code class="computeroutput">N</code>
+ is of type <code class="computeroutput">integral_mask<int,
+ 16></code>
+ the type supplied here is only for example.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Operation
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::value</code>
+ 
+ </td>
+<td>
+ 
+ Returns the <code class="computeroutput">value</code>
+ associated with <code class="computeroutput">N</code>
+ (in the current case that is 16).
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::value_type</code>
+ 
+ </td>
+<td>
+ 
+ Returns <code class="computeroutput">T</code> which
+ is the type associated with <code class="computeroutput">value</code>
+ inside <code class="computeroutput">N</code> (in the
+ current case that is int).
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::type</code>
+ 
+ </td>
+<td>
+ 
+ Returns the current types type (using <code class="computeroutput">N</code>
+ as an example, <code class="computeroutput">N::type</code>
+ is equivalent to <code class="computeroutput">integral_mask<int,16></code> )
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::offset</code>
+ 
+ </td>
+<td>
+ 
+ Always set to zero for this type. The offset is something which
+ all of the mask type support and refers the amount the mask has
+ been shifted to the right or the left (Depending on the type of
+ mask used). In the case of <code class="computeroutput">integral_mask</code>,
+ no left or right shift has occurred so <code class="computeroutput">N::offset</code>
+ is always set to zero.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::width</code>
+ 
+ </td>
+<td>
+ 
+ The value of <code class="computeroutput">N::width</code>
+ is always set to zero because the width refers the width of a contiguous
+ section of bits and the contiguity of the an integral mask is unknown.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">operator T()</code>
+ 
+ </td>
+<td>
+ 
+ Run time support function.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="integral_mask.bit_masks.integral_mask.examples"></a><h4>
+<a name="id3215314"></a>
+ <a class="link" href="integral_mask.html#integral_mask.bit_masks.integral_mask.examples">Examples</a>
+ </h4>
+
+ Examples and use cases related to the <code class="computeroutput">integral_mask</code>
+ template.
+ 
+
+ Example:
+
+<pre class="programlisting">int bits = 255;
+
+typedef integral_mask<int, 16> mask;
+// mask has the folling binary value
+// 0000 0000 0000 0000 0000 0000 0001 0110
+
+// bits has binary value of:
+// 0000 0000 0000 0000 0000 0000 0010 0101
+
+// the following is a bitwise and operation
+// which is done to bits using the integral_mask type
+int new_bits = bits & mask();
+
+// Resulting value of new_bits:
+// 0000 0000 0000 0000 0000 0000 0000 0100
+
+
+</pre>
+
+ The implicit cast operator allows for simplicity, clairity of code. In the
+ above example <code class="computeroutput">mask()</code>
+ could be replaced with <code class="computeroutput">mask::value</code>
+ to achieve the same result. The same applies to all other bitwise operators.
+ 
+</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 © 2010 Brian Bartman
+ 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="../../Rationale/bit_masks/overview/rationale.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_integer_bits_masks_extension/bit_masks.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../../high_bits_mask/bit_masks/high_bits_maskbits.html"><img src="../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/low_bits_mask/bit_masks/low_bits_mask.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/low_bits_mask/bit_masks/low_bits_mask.html 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,348 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>low_bits_mask</title>
+<link rel="stylesheet" href="../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../../boost_integer_bits_masks_extension/bit_masks.html" title="Bit Masks">
+<link rel="prev" href="../../high_bits_mask/bit_masks/high_bits_maskbits.html" title="high_bits_mask">
+<link rel="next" href="../../bits_mask/bit_masks/bits_mask.html" title="bits_mask">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../../high_bits_mask/bit_masks/high_bits_maskbits.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_integer_bits_masks_extension/bit_masks.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../../bits_mask/bit_masks/bits_mask.html"><img src="../../images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="low_bits_mask.bit_masks.low_bits_mask"></a><a class="link" href="low_bits_mask.html" title="low_bits_mask"> low_bits_mask</a>
+</h3></div></div></div>
+<a name="low_bits_mask.bit_masks.low_bits_mask.description"></a><h4>
+<a name="id3216842"></a>
+ <a class="link" href="low_bits_mask.html#low_bits_mask.bit_masks.low_bits_mask.description">Description</a>
+ </h4>
+
+ <code class="computeroutput">low_bits_mask</code> is a section
+ of contiguous of bits which extend out from the least significant bit toward
+ the most significant bit. The following is a basic example of how <code class="computeroutput">low_bits_mask</code> works:
+ 
+
+
+
+<pre class="programlisting">typedef low_bits_mask<int, 10> mask;
+// mask::value has the following binary value
+// 0000 0000 0000 0000 0000 0011 1111 1111
+</pre>
+
+ 
+<a name="low_bits_mask.bit_masks.low_bits_mask.header_file_information"></a><h4>
+<a name="id3216945"></a>
+ <a class="link" href="low_bits_mask.html#low_bits_mask.bit_masks.low_bits_mask.header_file_information">Header
+ File Information</a>
+ </h4>
+
+
+
+<pre class="programlisting">#include <boost/integer/low_bits_mask.hpp>
+#include <boost/integer/high_low_mask.hpp>
+</pre>
+
+ 
+<a name="low_bits_mask.bit_masks.low_bits_mask.template_signature"></a><h4>
+<a name="id3217060"></a>
+ <a class="link" href="low_bits_mask.html#low_bits_mask.bit_masks.low_bits_mask.template_signature">Template
+ Signature</a>
+ </h4>
+
+ <code class="computeroutput">low_bits_mask</code> has the following
+ template signature:
+
+<pre class="programlisting">namespace boost {
+template <typename T, unsigned int Width> struct low_bits_mask;
+}
+</pre>
+
+ 
+<a name="low_bits_mask.bit_masks.low_bits_mask.bit_mask_hierarchy"></a><h4>
+<a name="id3217175"></a>
+ <a class="link" href="low_bits_mask.html#low_bits_mask.bit_masks.low_bits_mask.bit_mask_hierarchy">Bit
+ Mask Hierarchy</a>
+ </h4>
+
+ <code class="computeroutput">low_bits_mask</code> inherits from
+ <code class="computeroutput">integral_mask</code>.
+ 
+<a name="low_bits_mask.bit_masks.low_bits_mask.template_parameters"></a><h4>
+<a name="id3217215"></a>
+ <a class="link" href="low_bits_mask.html#low_bits_mask.bit_masks.low_bits_mask.template_parameters">Template
+ Parameters</a>
+ </h4>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Parameter
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">T</code>
+ 
+ </td>
+<td>
+ 
+ Is an integral type which the mask is to be created over.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">Width</code>
+ 
+ </td>
+<td>
+ 
+ This is the width of the mask in bits.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="low_bits_mask.bit_masks.low_bits_mask.interface"></a><h4>
+<a name="id3217322"></a>
+ <a class="link" href="low_bits_mask.html#low_bits_mask.bit_masks.low_bits_mask.interface">Interface</a>
+ </h4>
+
+ <code class="computeroutput">low_bits_mask</code> Compile time
+ interface. Assume that <code class="computeroutput">N</code>
+ is of type <code class="computeroutput">low_bits_mask<int,10></code> the
+ type supplied here is only for example.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Operation
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::value</code>
+ 
+ </td>
+<td>
+ 
+ Returns the <code class="computeroutput">value</code>
+ associated with <code class="computeroutput">N</code>.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::value_type</code>
+ 
+ </td>
+<td>
+ 
+ Returns <code class="computeroutput">T</code> which
+ is the type associated with <code class="computeroutput">value</code>
+ inside <code class="computeroutput">N</code>.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::type</code>
+ 
+ </td>
+<td>
+ 
+ Returns the current types type.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::width</code>
+ 
+ </td>
+<td>
+ 
+ Returns the integral value associated with the <code class="computeroutput">width</code>
+ template parameter.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::offset</code>
+ 
+ </td>
+<td>
+ 
+ Returns 0 for this mask because the <code class="computeroutput">low_bits_mask</code>
+ is not shifted in any direction and always starts at the least
+ significant bit.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">operator T()</code>
+ 
+ </td>
+<td>
+ 
+ Run time support function. All this function does is return the
+ value associated with the type.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="low_bits_mask.bit_masks.low_bits_mask.preconditions"></a><h4>
+<a name="id3217702"></a>
+ <a class="link" href="low_bits_mask.html#low_bits_mask.bit_masks.low_bits_mask.preconditions">Preconditions</a>
+ </h4>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Precondition
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+<th>
+ 
+ Enforcement
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">bit_width<T>::value >=
+ Width</code>
+ 
+ </td>
+<td>
+ 
+ The <code class="computeroutput">Width</code> must
+ not be greater then the size in bits of type <code class="computeroutput">T</code>.
+ 
+ </td>
+<td>
+ 
+ Enforced by static assert.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ 
+ </td>
+<td>
+ 
+ <code class="computeroutput">T</code> must be an integral
+ type.
+ 
+ </td>
+<td>
+ 
+ This is only a documented precondition. It is not enforced.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="low_bits_mask.bit_masks.low_bits_mask.examples"></a><h4>
+<a name="id3217875"></a>
+ <a class="link" href="low_bits_mask.html#low_bits_mask.bit_masks.low_bits_mask.examples">Examples</a>
+ </h4>
+
+ Examples and use cases related to the <code class="computeroutput">low_bits_mask</code>
+ template.
+ 
+
+ Example:
+
+<pre class="programlisting">typedef low_bits_mask<int,4> mask;
+
+// binary for mask::value
+// 0000 0000 0000 0000 0000 0000 0000 1111
+
+int integral_value = 0xc000000c;
+
+// integral_value's binary value
+// 1100 0000 0000 0000 0000 0000 0000 1100
+
+int result = integral_value & mask();
+// binary value of result
+// 0000 0000 0000 0000 0000 0000 0000 1100
+</pre>
+
+ 
+
+ The implicit cast operator allows for simplicity, clairity of code. In the
+ above example <code class="computeroutput">mask()</code>
+ could be replaced with <code class="computeroutput">mask::value</code>
+ to achieve the same result. The same applies to all other bitwise operators.
+ 
+</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 © 2010 Brian Bartman
+ 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="../../high_bits_mask/bit_masks/high_bits_maskbits.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_integer_bits_masks_extension/bit_masks.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../../bits_mask/bit_masks/bits_mask.html"><img src="../../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/standalone_HTML.manifest
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/standalone_HTML.manifest 2010-08-22 11:27:10 EDT (Sun, 22 Aug 2010)
@@ -0,0 +1,55 @@
+index.html
+boost_integer_bits_masks_extension/HeaderSummary.html
+boost_integer_bits_masks_extension/bit_masks.html
+boost_integer_bits_masks_extension/bit_masks/overview.html
+boost_integer_bits_masks_extension/bit_masks/overview/description.html
+Rationale/bit_masks/overview/rationale.html
+integral_mask/bit_masks/integral_mask.html
+high_bits_mask/bit_masks/high_bits_maskbits.html
+low_bits_mask/bit_masks/low_bits_mask.html
+bits_mask/bit_masks/bits_mask.html
+bit_width/bit_masks/bit_width.html
+bitfield_tuple/bitfield_tuple.html
+boost_integer_bits_masks_extension/bitfield_tuple/overview.html
+boost_integer_bits_masks_extension/bitfield_tuple/overview/description.html
+boost_integer_bits_masks_extension/bitfield_tuple/overview/motivation.html
+boost_integer_bits_masks_extension/bitfield_tuple/users_guide.html
+boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started.html
+boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started/installation.html
+boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started/dependencies.html
+boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started/building_with_bitfield_tuple.html
+boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started/testing.html
+boost_integer_bits_masks_extension/bitfield_tuple/users_guide/tutorial.html
+boost_integer_bits_masks_extension/bitfield_tuple/users_guide/external_resources.html
+boost_integer_bits_masks_extension/bitfield_tuple/users_guide/glossary.html
+boost_integer_bits_masks_extension/bitfield_tuple/reference.html
+boost_integer_bits_masks_extension/bitfield_tuple/reference/concepts.html
+boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_class_reference.html
+boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_class_reference/bitfield_tuple_and_bitfield_reference.html
+boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_class_reference/padding.html
+boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_class_reference/member.html
+boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_class_reference/flag.html
+boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_class_reference/align.html
+boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_class_reference/storage.html
+boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_class_reference/pointer.html
+boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_class_reference/custom.html
+boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_macro_reference.html
+boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_macro_reference/parameter_adjustment_macros.html
+boost_integer_bits_masks_extension/bitfield_tuple/reference/bitfield_tuple_macro_reference/code_generation_macros.html
+boost_integer_bits_masks_extension/bitfield_tuple/reference/function_reference.html
+boost_integer_bits_masks_extension/bitfield_tuple/reference/function_reference/make_bitfield_tuple.html
+boost_integer_bits_masks_extension/bitfield_tuple/reference/function_reference/get.html
+boost_integer_bits_masks_extension/bitfield_tuple/reference/meta_function_reference.html
+boost_integer_bits_masks_extension/bitfield_tuple/reference/meta_function_reference/element.html
+boost_integer_bits_masks_extension/bitfield_tuple/reference/meta_function_reference/element_n.html
+boost_integer_bits_masks_extension/bitfield_tuple/reference/boost_fusion_sequence_extension.html
+boost_integer_bits_masks_extension/bitfield_tuple/reference/files.html
+boost_integer_bits_masks_extension/bitfield_tuple/appendices.html
+boost_integer_bits_masks_extension/bitfield_tuple/appendices/design_rationale.html
+boost_integer_bits_masks_extension/bitfield_tuple/appendices/implementation_details.html
+boost_integer_bits_masks_extension/bitfield_tuple/appendices/implementation_details/internal_documentation.html
+boost_integer_bits_masks_extension/bitfield_tuple/appendices/implementation_details/internal_documentation/macros.html
+boost_integer_bits_masks_extension/bitfield_tuple/appendices/implementation_details/internal_documentation/class_templates.html
+boost_integer_bits_masks_extension/bitfield_tuple/appendices/implementation_details/internal_documentation/function_templates.html
+boost_integer_bits_masks_extension/bitfield_tuple/appendices/acknowledgments.html
+boost_integer_bits_masks_extension/bitfield_tuple/appendices/future_work.html

Date view	Thread view	Subject view	Author view