|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r64940 - in sandbox/SOC/2010/bit_masks/lib/integer/doc/html: . bitfield_tuple 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/users_guide boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started high_bits_mask/bit_masks integral_mask/bit_masks low_bits_mask/bit_masks
From: bbartmanboost_at_[hidden]
Date: 2010-08-21 16:12:31
Author: bbartman
Date: 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
New Revision: 64940
URL: http://svn.boost.org/trac/boost/changeset/64940
Log:
completed large amount of documentation
Text files modified:
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/bitfield_tuple/bitfield_tuple.html | 10
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/bits_mask/bit_masks/bits_mask.html | 211 +++++++++--------
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/HeaderSummary.html | 4
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bit_masks.html | 5
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bit_masks/overview.html | 4
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bit_masks/overview/description.html | 8
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices.html | 4
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/acknowledgments.html | 4
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/design_rationale.html | 4
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/future_work.html | 4
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/implementation_details.html | 4
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/implementation_details/internal_documentation.html | 4
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/implementation_details/internal_documentation/class_templates.html | 4
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/implementation_details/internal_documentation/function_templates.html | 4
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/implementation_details/internal_documentation/macros.html | 4
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/overview.html | 4
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/overview/description.html | 31 +
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/overview/motivation.html | 16 +
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference.html | 4
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/_bitfield_tuple__class_reference.html | 4
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 | 46 ++-
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/_bitfield_tuple__class_reference/_struct_align_.html | 77 +++++
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/_bitfield_tuple__class_reference/_struct_custom_.html | 476 +++++++++++++++++++++++++++++++++++++++
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/_bitfield_tuple__class_reference/_struct_flag_.html | 168 +++++++++++--
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/_bitfield_tuple__class_reference/_struct_member_.html | 166 ++++++++++++-
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/_bitfield_tuple__class_reference/_struct_padding_.html | 95 ++++++-
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/_bitfield_tuple__class_reference/_struct_pointer_.html | 287 +++++++++++++++++++++++
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/_bitfield_tuple__class_reference/_struct_storage_.html | 158 ++++++++++++
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/_bitfield_tuple__macro_reference.html | 4
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 | 6
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 | 6
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/boost_fusion_sequence_extension.html | 6
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/concepts.html | 4
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/files.html | 4
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/function_reference.html | 4
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/function_reference/function__make_bitfield_tuple_.html | 6
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/meta_function_reference.html | 4
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide.html | 8
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/external_resources.html | 4
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started.html | 8
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started/dependencies.html | 397 ++++++++++++--------------------
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started/installation.html | 8
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started/testing.html | 47 +++
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/glossary.html | 17 +
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/tutorial.html | 217 ++++++++++++++++-
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/high_bits_mask/bit_masks/high_bits_maskbits.html | 98 +++++++-
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/index.html | 13
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/integral_mask/bit_masks/integral_mask.html | 32 +-
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/low_bits_mask/bit_masks/low_bits_mask.html | 138 ++++++++++-
sandbox/SOC/2010/bit_masks/lib/integer/doc/html/standalone_HTML.manifest | 3
50 files changed, 2212 insertions(+), 632 deletions(-)
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/bitfield_tuple/bitfield_tuple.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/bitfield_tuple/bitfield_tuple.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/bitfield_tuple/bitfield_tuple.html 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -6,14 +6,14 @@
<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="../bits_mask/bit_masks/bits_mask.html" title="bits_mask">
+<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="../bits_mask/bit_masks/bits_mask.html"><img src="..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../boost_integer_bits_masks_extension/bitfield_tuple/overview.html"><img src="..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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">
@@ -33,8 +33,8 @@
<dd><dl>
<dt><span class="section">Installation</span></dt>
<dt><span class="section">Dependencies</span></dt>
-<dt><span class="section"><a href="../boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started/building_with__bitfield_tuple_.html">Building
- With <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code></a></span></dt>
+<dt><span class="section"><a href="../boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started/building_with_bitfield_tuple.html">Building
+ With bitfield_tuple</a></span></dt>
<dt><span class="section">Testing</span></dt>
</dl></dd>
<dt><span class="section">Tutorial</span></dt>
@@ -106,7 +106,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../bits_mask/bit_masks/bits_mask.html"><img src="..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../boost_integer_bits_masks_extension/bitfield_tuple/overview.html"><img src="..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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>
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/bits_mask/bit_masks/bits_mask.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/bits_mask/bit_masks/bits_mask.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/bits_mask/bit_masks/bits_mask.html 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -7,20 +7,20 @@
<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="../../bitfield_tuple/bitfield_tuple.html" title="bitfield_tuple">
+<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="../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_integer_bits_masks_extension/bit_masks.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../../bitfield_tuple/bitfield_tuple.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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="id701402"></a>
+<a name="id3052280"></a>
<a class="link" href="bits_mask.html#bits_mask.bit_masks.bits_mask.description">Description</a>
</h4>
<p>
@@ -55,12 +55,20 @@
</span></pre>
<p>
</p>
+<a name="bits_mask.bit_masks.bits_mask.header_file_information"></a><h4>
+<a name="id3052506"></a>
+ <a class="link" href="bits_mask.html#bits_mask.bit_masks.bits_mask.header_file_information">Header
+ File Information</a>
+ </h4>
+<p>
+
+</p>
+<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">integer</span><span class="special">/</span><span class="identifier">bits_mask</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
+</pre>
<p>
- The <code class="computeroutput"><span class="identifier">bits_mask</span></code> template is
- located in the <boost/integer/bits_mask.hpp> header file.
</p>
<a name="bits_mask.bit_masks.bits_mask.template_signature"></a><h4>
-<a name="id701622"></a>
+<a name="id3052577"></a>
<a class="link" href="bits_mask.html#bits_mask.bit_masks.bits_mask.template_signature">Template
Signature</a>
</h4>
@@ -68,11 +76,26 @@
<code class="computeroutput"><span class="identifier">bits_mask</span></code> has the following
template signature:
</p>
-<pre class="programlisting"><span class="keyword">template</span> <span class="special"><</span><span class="keyword">typename</span> <span class="identifier">T</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">int</span> <span class="identifier">Offset</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">int</span> <span class="identifier">Width</span> <span class="special">=</span> <span class="number">1</span> <span class="special">></span>
-<span class="keyword">struct</span> <span class="identifier">bits_mask</span><span class="special">;</span>
+<pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span>
+<span class="keyword">template</span> <span class="special"><</span><span class="keyword">typename</span> <span class="identifier">T</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">int</span> <span class="identifier">Offset</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">int</span> <span class="identifier">Width</span> <span class="special">=</span> <span class="number">1u</span> <span class="special">></span> <span class="keyword">struct</span> <span class="identifier">bits_mask</span><span class="special">;</span>
+<span class="special">}</span>
</pre>
<p>
</p>
+<a name="bits_mask.bit_masks.bits_mask.bit_mask_hierarchy"></a><h4>
+<a name="id3052724"></a>
+ <a class="link" href="bits_mask.html#bits_mask.bit_masks.bits_mask.bit_mask_hierarchy">Bit Mask
+ Hierarchy</a>
+ </h4>
+<p>
+ <code class="computeroutput"><span class="identifier">bits_mask</span></code> inherits from
+ <code class="computeroutput"><span class="identifier">integral_mask</span></code>.
+ </p>
+<a name="bits_mask.bit_masks.bits_mask.template_parameters"></a><h4>
+<a name="id3052763"></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>
@@ -111,8 +134,10 @@
</td>
<td>
<p>
- This is the number of bits which is used for a left shift of the
- <code class="computeroutput"><span class="identifier">width</span></code>.
+ 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).
</p>
</td>
</tr>
@@ -124,30 +149,30 @@
</td>
<td>
<p>
- This is the width of the mask in bits.
+ This is the width of the mask in bits. <code class="computeroutput"><span class="identifier">Width</span></code>
+ has a default value of <code class="computeroutput"><span class="number">1u</span></code>
+ so that <code class="computeroutput"><span class="identifier">bits_mask</span></code>
+ can be easily used to create boolean flags by providing only an
+ <code class="computeroutput"><span class="identifier">Offset</span></code> to the bit.
</p>
</td>
</tr>
</tbody>
</table></div>
-<a name="bits_mask.bit_masks.bits_mask.interface"></a><h4>
-<a name="id701858"></a>
- <a class="link" href="bits_mask.html#bits_mask.bit_masks.bits_mask.interface">Interface</a>
+<a name="bits_mask.bit_masks.bits_mask.preconditions"></a><h4>
+<a name="id3052937"></a>
+ <a class="link" href="bits_mask.html#bits_mask.bit_masks.bits_mask.preconditions">Preconditions</a>
</h4>
-<p>
- <code class="computeroutput"><span class="identifier">TYPENAME</span></code> Compile time interface.
- Assume that N is of type <code class="computeroutput"><span class="identifier">N</span> <span class="identifier">TYPE</span></code> the type supplied here is only for
- example.
- </p>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
+<col>
</colgroup>
<thead><tr>
<th>
<p>
- Operation
+ Precondition
</p>
</th>
<th>
@@ -155,120 +180,97 @@
Description
</p>
</th>
+<th>
+ <p>
+ Enforcement
+ </p>
+ </th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
- <code class="computeroutput"><span class="identifier">N</span><span class="special">::</span><span class="identifier">value</span></code>
- </p>
- </td>
-<td>
- <p>
- Returns the <code class="computeroutput"><span class="identifier">value</span></code>
- associated with <code class="computeroutput"><span class="identifier">N</span></code>.
</p>
</td>
-</tr>
-<tr>
<td>
<p>
- <code class="computeroutput"><span class="identifier">N</span><span class="special">::</span><span class="identifier">value_type</span></code>
+ <code class="computeroutput"><span class="identifier">T</span></code> must be an integral
+ type.
</p>
</td>
<td>
<p>
- Returns <code class="computeroutput"><span class="identifier">T</span></code> which
- is the type associated with <code class="computeroutput"><span class="identifier">value</span></code>
- inside <code class="computeroutput"><span class="identifier">N</span></code>.
+ This is only a documented precondition. It is not enforced.
</p>
</td>
</tr>
<tr>
<td>
<p>
- <code class="computeroutput"><span class="identifier">N</span><span class="special">::</span><span class="identifier">type</span></code>
- </p>
- </td>
-<td>
- <p>
- Returns the current types type.
+ <code class="computeroutput"><span class="special">(</span><span class="identifier">Offset</span>
+ <span class="special">+</span> <span class="identifier">Width</span><span class="special">)</span> <span class="special"><=</span>
+ <span class="special">(</span> <span class="identifier">bit_width</span><span class="special"><</span><span class="identifier">T</span><span class="special">>::</span><span class="identifier">value</span>
+ <span class="special">)</span></code>
</p>
</td>
-</tr>
-<tr>
<td>
<p>
- <code class="computeroutput"><span class="identifier">N</span><span class="special">::</span><span class="identifier">width</span></code>
+ The <code class="computeroutput"><span class="identifier">Width</span> <span class="special">+</span>
+ <span class="identifier">Offset</span></code> must be less then
+ or equal to the number of bits within the integral type <code class="computeroutput"><span class="identifier">T</span></code>
</p>
</td>
<td>
<p>
- Returns the integral value associated with the <code class="computeroutput"><span class="identifier">width</span></code>
- template parameter.
+ Enforced by static assert.
</p>
</td>
</tr>
<tr>
<td>
<p>
- <code class="computeroutput"><span class="identifier">N</span><span class="special">::</span><span class="identifier">offset</span></code>
+ Valid range for mask width is > 0.
</p>
</td>
<td>
<p>
- Returns the integral value associated with the <code class="computeroutput"><span class="identifier">Offset</span></code>
- template parameter.
+ The <code class="computeroutput"><span class="identifier">Width</span></code> of a
+ mask must not be zero. Because <code class="computeroutput"><span class="identifier">Width</span></code>
+ is of <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span></code> it can not be negative.
</p>
</td>
-</tr>
-<tr>
<td>
<p>
- <code class="computeroutput"><span class="keyword">operator</span> <span class="identifier">T</span><span class="special">()</span></code>
- </p>
- </td>
-<td>
- <p>
- Run time support function. All this function does is return the
- value associated with the type. With the c++0x feature <code class="computeroutput"><span class="identifier">constexper</span></code> this function will
- be made fasters and more effieient.
+ Enforced by domain of template parameter and by static assert.
</p>
</td>
</tr>
</tbody>
</table></div>
-<a name="bits_mask.bit_masks.bits_mask.preconditions"></a><h4>
-<a name="id702199"></a>
- <a class="link" href="bits_mask.html#bits_mask.bit_masks.bits_mask.preconditions">Preconditions</a>
+<a name="bits_mask.bit_masks.bits_mask.interface"></a><h4>
+<a name="id3053212"></a>
+ <a class="link" href="bits_mask.html#bits_mask.bit_masks.bits_mask.interface">Interface</a>
</h4>
<p>
- Preconditions associated with the <code class="computeroutput"><span class="identifier">bits_mask</span></code>
- template. There are two types of precondtions ones which are only documented
- and ones which are both enforced and documented. Preconditions will specify
- which are which within the documentation. All of the preconditions will document
- how they are enforced when they are enforced.
+ <code class="computeroutput"><span class="identifier">bits_mask</span></code> Compile time interface.
+ Assume that <code class="computeroutput"><span class="identifier">N</span></code> is of type
+ <code class="computeroutput"><span class="identifier">bits_mask</span><span class="special"><</span><span class="keyword">unsigned</span> <span class="keyword">int</span><span class="special">,</span><span class="number">4</span><span class="special">,</span><span class="number">1</span><span class="special">></span></code> the type
+ supplied here is only for example.
</p>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
-<col>
</colgroup>
<thead><tr>
<th>
<p>
- Precondition
- </p>
- </th>
-<th>
- <p>
- Reasoning
+ Operation
</p>
</th>
<th>
<p>
- Enforcement
+ Description
</p>
</th>
</tr></thead>
@@ -276,70 +278,85 @@
<tr>
<td>
<p>
- <code class="computeroutput"><span class="special">(</span><span class="identifier">Offset</span>
- <span class="special">+</span> <span class="identifier">Width</span><span class="special">)</span> <span class="special"><</span>
- <span class="special">(</span> <span class="identifier">bit_width</span><span class="special"><</span><span class="identifier">T</span><span class="special">>::</span><span class="identifier">value</span>
- <span class="special">-</span> <span class="number">1</span><span class="special">)</span></code>
+ <code class="computeroutput"><span class="identifier">N</span><span class="special">::</span><span class="identifier">value</span></code>
</p>
</td>
<td>
<p>
- It will cause overflow if the width plus the offset is greater
- then total width of the type in bits.
+ Returns the <code class="computeroutput"><span class="identifier">value</span></code>
+ associated with <code class="computeroutput"><span class="identifier">N</span></code>.
</p>
</td>
+</tr>
+<tr>
<td>
<p>
- Enforced by <code class="computeroutput"><span class="identifier">BOOST_STATIC_ASSERT</span></code>.
+ <code class="computeroutput"><span class="identifier">N</span><span class="special">::</span><span class="identifier">value_type</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ Returns <code class="computeroutput"><span class="identifier">T</span></code> which
+ is the type associated with <code class="computeroutput"><span class="identifier">value</span></code>
+ inside <code class="computeroutput"><span class="identifier">N</span></code>.
</p>
</td>
</tr>
<tr>
<td>
<p>
- <code class="computeroutput"><span class="identifier">Width</span> <span class="special">></span>
- <span class="number">0</span></code>
+ <code class="computeroutput"><span class="identifier">N</span><span class="special">::</span><span class="identifier">type</span></code>
</p>
</td>
<td>
<p>
- This would create an empty mask, which won't do anything.
+ Returns the current types type.
</p>
</td>
+</tr>
+<tr>
<td>
<p>
- Enfoced by the domain of the <code class="computeroutput"><span class="identifier">Width</span></code>
- template parameter which is an <code class="computeroutput"><span class="keyword">unsigned</span>
- <span class="keyword">int</span></code>, which prevents the
- value from being negative, and by <code class="computeroutput"><span class="identifier">BOOST_STATIC_ASSERT</span></code>,
- which prevents the value from being zero.
+ <code class="computeroutput"><span class="identifier">N</span><span class="special">::</span><span class="identifier">width</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ Returns the integral value associated with the <code class="computeroutput"><span class="identifier">width</span></code>
+ template parameter.
</p>
</td>
</tr>
<tr>
<td>
<p>
- <code class="computeroutput"><span class="identifier">T</span></code> must satisfy
- the <code class="computeroutput"><span class="identifier">is_integral</span></code>
- type trait.
+ <code class="computeroutput"><span class="identifier">N</span><span class="special">::</span><span class="identifier">offset</span></code>
</p>
</td>
<td>
<p>
- The <code class="computeroutput"><span class="identifier">bits_mask</span></code> template
- has only been tested with integral types.
+ Returns the integral value associated with the <code class="computeroutput"><span class="identifier">Offset</span></code>
+ template parameter.
</p>
</td>
+</tr>
+<tr>
<td>
<p>
- This is only a documented precondition.
+ <code class="computeroutput"><span class="keyword">operator</span> <span class="identifier">T</span><span class="special">()</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ Run time support function. All this function does is return the
+ value associated with the type.
</p>
</td>
</tr>
</tbody>
</table></div>
<a name="bits_mask.bit_masks.bits_mask.examples"></a><h4>
-<a name="id702494"></a>
+<a name="id3053604"></a>
<a class="link" href="bits_mask.html#bits_mask.bit_masks.bits_mask.examples">Examples</a>
</h4>
<p>
@@ -405,7 +422,7 @@
<p>
</p>
<p>
- The implicit cast operator allows for simplicity, clairity of code. In the
+ The implicit cast operator allows for simplicity, clarity of code. In the
above example <code class="computeroutput"><span class="identifier">mask</span><span class="special">()</span></code>
could be replaced with <code class="computeroutput"><span class="identifier">mask</span><span class="special">::</span><span class="identifier">value</span></code>
to achieve the same result. The same applies to all other bitwise operators.
@@ -421,7 +438,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../../low_bits_mask/bit_masks/low_bits_mask.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_integer_bits_masks_extension/bit_masks.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../../bitfield_tuple/bitfield_tuple.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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>
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/HeaderSummary.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/HeaderSummary.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/HeaderSummary.html 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -13,7 +13,7 @@
<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="..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="bit_masks.html"><img src="..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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">
@@ -212,7 +212,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../index.html"><img src="..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="bit_masks.html"><img src="..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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>
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bit_masks.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bit_masks.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bit_masks.html 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -13,7 +13,7 @@
<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="..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="bit_masks/overview.html"><img src="..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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">
@@ -30,6 +30,7 @@
<dt><span class="section"> high_bits_mask</span></dt>
<dt><span class="section"> low_bits_mask</span></dt>
<dt><span class="section"> bits_mask</span></dt>
+<dt><span class="section"> bit_width</span></dt>
</dl></div>
<p>
The Bits Masks library extension was created to help simplify the creation
@@ -58,7 +59,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="HeaderSummary.html"><img src="..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="bit_masks/overview.html"><img src="..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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>
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bit_masks/overview.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bit_masks/overview.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bit_masks/overview.html 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -13,7 +13,7 @@
<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="../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../bit_masks.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="overview/description.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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">
@@ -38,7 +38,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../bit_masks.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../bit_masks.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="overview/description.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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>
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bit_masks/overview/description.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bit_masks/overview/description.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bit_masks/overview/description.html 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -13,7 +13,7 @@
<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="../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../overview.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../../../Rationale/bit_masks/overview/rationale.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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">
@@ -62,7 +62,7 @@
</p>
<div class="note"><table border="0" summary="Note">
<tr>
-<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../..//home/brian/boost/boost-trunk/doc/html/images/note.png"></td>
+<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"><p>
@@ -78,7 +78,7 @@
a high level.
</p>
<a name="boost_integer_bits_masks_extension.bit_masks.overview.description.general_use_cases"></a><h5>
-<a name="id698193"></a>
+<a name="id3048084"></a>
<a class="link" href="description.html#boost_integer_bits_masks_extension.bit_masks.overview.description.general_use_cases">General
use cases</a>
</h5>
@@ -156,7 +156,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../overview.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../overview.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../../../Rationale/bit_masks/overview/rationale.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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>
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices.html 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -13,7 +13,7 @@
<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="../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../bitfield_tuple/bitfield_tuple.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="appendices/design_rationale.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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">
@@ -50,7 +50,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="reference/files.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../bitfield_tuple/bitfield_tuple.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="appendices/design_rationale.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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>
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/acknowledgments.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/acknowledgments.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/acknowledgments.html 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -13,7 +13,7 @@
<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="../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../appendices.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="future_work.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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>
@@ -28,7 +28,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="implementation_details/internal_documentation/function_templates.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../appendices.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="future_work.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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>
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/design_rationale.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/design_rationale.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/design_rationale.html 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -13,7 +13,7 @@
<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="../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../appendices.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="implementation_details.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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
@@ -29,7 +29,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../appendices.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../appendices.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="implementation_details.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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>
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/future_work.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/future_work.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/future_work.html 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -12,7 +12,7 @@
<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="../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../appendices.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a>
+<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
@@ -28,7 +28,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="acknowledgments.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../appendices.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a>
+<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>
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/implementation_details.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/implementation_details.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/implementation_details.html 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -13,7 +13,7 @@
<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="../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../appendices.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="implementation_details/internal_documentation.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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">
@@ -42,7 +42,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="design_rationale.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../appendices.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="implementation_details/internal_documentation.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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>
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/implementation_details/internal_documentation.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/implementation_details/internal_documentation.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/implementation_details/internal_documentation.html 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -13,7 +13,7 @@
<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../implementation_details.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../implementation_details.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="internal_documentation/macros.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="../implementation_details.html"><img src="../../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../implementation_details.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="internal_documentation/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.appendices.implementation_details.internal_documentation"></a><a class="link" href="internal_documentation.html" title="Internal documentation">Internal
@@ -29,7 +29,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../implementation_details.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../implementation_details.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="internal_documentation/macros.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="../implementation_details.html"><img src="../../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../implementation_details.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="internal_documentation/macros.html"><img src="../../../../images/next.png" alt="Next"></a>
</div>
</body>
</html>
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/implementation_details/internal_documentation/class_templates.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/implementation_details/internal_documentation/class_templates.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/implementation_details/internal_documentation/class_templates.html 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -13,7 +13,7 @@
<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="macros.html"><img src="../../../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../internal_documentation.html"><img src="../../../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../../index.html"><img src="../../../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="function_templates.html"><img src="../../../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="macros.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="function_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.class_templates"></a><a class="link" href="class_templates.html" title="Class Templates">Class
@@ -29,7 +29,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="macros.html"><img src="../../../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../internal_documentation.html"><img src="../../../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../../index.html"><img src="../../../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="function_templates.html"><img src="../../../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="macros.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="function_templates.html"><img src="../../../../../images/next.png" alt="Next"></a>
</div>
</body>
</html>
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/implementation_details/internal_documentation/function_templates.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/implementation_details/internal_documentation/function_templates.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/implementation_details/internal_documentation/function_templates.html 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -13,7 +13,7 @@
<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="class_templates.html"><img src="../../../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../internal_documentation.html"><img src="../../../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../../index.html"><img src="../../../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../../acknowledgments.html"><img src="../../../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="class_templates.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="../../acknowledgments.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.function_templates"></a><a class="link" href="function_templates.html" title="Function Templates">Function
@@ -29,7 +29,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="class_templates.html"><img src="../../../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../internal_documentation.html"><img src="../../../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../../index.html"><img src="../../../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../../acknowledgments.html"><img src="../../../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="class_templates.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="../../acknowledgments.html"><img src="../../../../../images/next.png" alt="Next"></a>
</div>
</body>
</html>
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/implementation_details/internal_documentation/macros.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/appendices/implementation_details/internal_documentation/macros.html (original)
+++ 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-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -13,7 +13,7 @@
<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="../../../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../internal_documentation.html"><img src="../../../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../../index.html"><img src="../../../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="class_templates.html"><img src="../../../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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">
@@ -1093,7 +1093,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../internal_documentation.html"><img src="../../../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../internal_documentation.html"><img src="../../../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../../index.html"><img src="../../../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="class_templates.html"><img src="../../../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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>
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/overview.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/overview.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/overview.html 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -13,7 +13,7 @@
<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="../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../bitfield_tuple/bitfield_tuple.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="overview/description.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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">
@@ -34,7 +34,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../../bitfield_tuple/bitfield_tuple.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../bitfield_tuple/bitfield_tuple.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="overview/description.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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>
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/overview/description.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/overview/description.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/overview/description.html 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -13,7 +13,7 @@
<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="../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../overview.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="motivation.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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">
@@ -52,7 +52,7 @@
is going to be an unsigned short. The <code class="computeroutput"><span class="identifier">member</span><span class="special"><</span><span class="keyword">unsigned</span> <span class="keyword">int</span><span class="special">,</span> <span class="identifier">red</span><span class="special">,</span> <span class="number">5</span><span class="special">></span></code>
member is used to specify a bitfield within the <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>.
Here is how <code class="computeroutput"><span class="identifier">member</span></code> works,
- and relates directly back to regular reconizable C++.
+ and relates directly back to regular recognizable C++.
</p>
<div class="informaltable"><table class="table">
<colgroup>
@@ -191,13 +191,26 @@
hassle of doing the masking themselves.
</p>
<p>
- One might be wondering just what is the benefit of doing all of this extra
- work for something that seems much easier to do using conventional means?
- Well the <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>
- is used to abstract the storage and retrieval of data into and out of an
- integral type, by doing so allows for the storage and retrieval of types
- with different endianness.
+ 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:
</p>
+<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>
@@ -209,7 +222,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../overview.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../overview.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="motivation.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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>
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/overview/motivation.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/overview/motivation.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/overview/motivation.html 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -13,7 +13,7 @@
<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="../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../overview.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../users_guide.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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">
@@ -59,6 +59,18 @@
<code class="computeroutput"><span class="keyword">struct</span> <span class="identifier">foo</span></code>
with a <code class="computeroutput"><span class="keyword">char</span></code> type.
</p>
+<p>
+ 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.
+ </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
@@ -70,7 +82,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="description.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../overview.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../users_guide.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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>
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference.html 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -13,7 +13,7 @@
<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="../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../bitfield_tuple/bitfield_tuple.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="reference/concepts.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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">
@@ -60,7 +60,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="users_guide/glossary.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../bitfield_tuple/bitfield_tuple.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="reference/concepts.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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>
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/_bitfield_tuple__class_reference.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/_bitfield_tuple__class_reference.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/_bitfield_tuple__class_reference.html 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -13,7 +13,7 @@
<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="../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="_bitfield_tuple__class_reference/_bitfield_tuple__and__bitfield_reference_.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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">
@@ -45,7 +45,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="concepts.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="_bitfield_tuple__class_reference/_bitfield_tuple__and__bitfield_reference_.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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>
Modified: 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
==============================================================================
--- 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 (original)
+++ 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-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -13,14 +13,14 @@
<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="../../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../_bitfield_tuple__class_reference.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="_struct_padding_.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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="_struct_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"><code class="computeroutput"><span class="identifier">bitfield_tuple</span></code> and <code class="computeroutput"><span class="identifier">bitfield_reference</span></code></a>
</h5></div></div></div>
<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._bitfield_tuple__and__bitfield_reference_._code__phrase_role__identifier__bitfield_tuple__phrase___code__interface"></a><h5>
-<a name="id707875"></a>
+<a name="id3062110"></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_._code__phrase_role__identifier__bitfield_tuple__phrase___code__interface"><code class="computeroutput"><span class="identifier">bitfield_tuple</span></code> interface</a>
</h5>
<p>
@@ -31,7 +31,7 @@
portion of the interface.
</p>
<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="id707935"></a>
+<a name="id3062180"></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>
@@ -54,7 +54,7 @@
doesn't have a value associated with it).
</p>
<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="id708097"></a>
+<a name="id3062360"></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>
@@ -71,7 +71,7 @@
still provides the regular <code class="computeroutput"><span class="identifier">get</span><span class="special"><</span><span class="identifier">Index</span><span class="special">>()</span></code> by index function as boost.tuple).
</p>
<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="id708214"></a>
+<a name="id3062493"></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>
@@ -88,21 +88,23 @@
<p>
</p>
<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="id708330"></a>
+<a name="id3062614"></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>
<p>
</p>
-<pre class="programlisting"><span class="identifier">tempate</span> <span class="special"><</span><span class="keyword">typename</span><span class="special">...</span> <span class="identifier">Args</span><span class="special">></span> <span class="keyword">struct</span> <span class="identifier">bitfield_tuple</span><span class="special">;</span>
+<pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span> <span class="keyword">namespace</span> <span class="identifier">bitfields</span> <span class="special">{</span>
+<span class="keyword">template</span> <span class="special"><</span><span class="keyword">typename</span><span class="special">...</span> <span class="identifier">Args</span><span class="special">></span> <span class="keyword">struct</span> <span class="identifier">bitfield_tuple</span><span class="special">;</span>
+<span class="special">}}</span>
</pre>
<p>
For additional information on creating specilizations over the <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>'s implementation documentation
reguarding macros.
</p>
<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._bitfield_tuple__and__bitfield_reference_.types"></a><h6>
-<a name="id708420"></a>
+<a name="id3062752"></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_.types">types</a>
</h6>
<p>
@@ -184,20 +186,20 @@
</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="id708760"></a>
+<a name="id3063114"></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>
<p>
The <code class="computeroutput"><span class="identifier">bitfield_reference</span></code>
type is responsible for acting as the proxy reference type into the storage
- of a <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>,
+ of a <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>.
This works similar to the proxy reference type supplied by <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">bool</span><span class="special">></span></code>
specilization.
</p>
<div class="note"><table border="0" summary="Note">
<tr>
-<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../..//home/brian/boost/boost-trunk/doc/html/images/note.png"></td>
+<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"><p>
@@ -210,7 +212,7 @@
</table></div>
<div class="note"><table border="0" summary="Note">
<tr>
-<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../..//home/brian/boost/boost-trunk/doc/html/images/note.png"></td>
+<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"><p>
@@ -262,7 +264,7 @@
</tr></tbody>
</table></div>
<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._bitfield_tuple__and__bitfield_reference_._code__phrase_role__identifier__bitfield_reference__phrase___code__internal_types"></a><h6>
-<a name="id709017"></a>
+<a name="id3063388"></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_._code__phrase_role__identifier__bitfield_reference__phrase___code__internal_types"><code class="computeroutput"><span class="identifier">bitfield_reference</span></code> Internal Types</a>
</h6>
<p>
@@ -331,7 +333,7 @@
</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="id709278"></a>
+<a name="id3063666"></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>
@@ -415,7 +417,7 @@
</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="id709503"></a>
+<a name="id3063904"></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>
@@ -503,7 +505,7 @@
</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="id709766"></a>
+<a name="id3064182"></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">
@@ -591,7 +593,7 @@
</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="id710018"></a>
+<a name="id3064449"></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">
@@ -675,13 +677,13 @@
</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="id710266"></a>
+<a name="id3064709"></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="../../../..//home/brian/boost/boost-trunk/doc/html/images/note.png"></td>
+<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"><p>
@@ -783,7 +785,7 @@
</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__code__phrase_role__identifier__bitfield_tuple__phrase___code__template"></a><h6>
-<a name="id710743"></a>
+<a name="id3065204"></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__code__phrase_role__identifier__bitfield_tuple__phrase___code__template">Preconditions
on the <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>
template</a>
@@ -939,7 +941,7 @@
</td>
<td>
<p>
- Enforced macro macro error message.
+ Enforced by macro error message.
</p>
</td>
</tr>
@@ -979,7 +981,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../_bitfield_tuple__class_reference.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../_bitfield_tuple__class_reference.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="_struct_padding_.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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="_struct_padding_.html"><img src="../../../../images/next.png" alt="Next"></a>
</div>
</body>
</html>
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/_bitfield_tuple__class_reference/_struct_align_.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/_bitfield_tuple__class_reference/_struct_align_.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/_bitfield_tuple__class_reference/_struct_align_.html 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -13,14 +13,14 @@
<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="_struct_flag_.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../_bitfield_tuple__class_reference.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="_struct_storage_.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="_struct_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="_struct_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._struct_align_"></a><a class="link" href="_struct_align_.html" title="struct align"><code class="computeroutput"><span class="keyword">struct</span> <span class="identifier">align</span></code></a>
</h5></div></div></div>
<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_align_.description"></a><h5>
-<a name="id712937"></a>
+<a name="id3069301"></a>
<a class="link" href="_struct_align_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_align_.description">Description</a>
</h5>
<p>
@@ -33,7 +33,7 @@
</p>
<div class="note"><table border="0" summary="Note">
<tr>
-<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../..//home/brian/boost/boost-trunk/doc/html/images/note.png"></td>
+<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"><p>
@@ -43,7 +43,7 @@
</p></td></tr>
</table></div>
<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_align_.template_signature"></a><h5>
-<a name="id713073"></a>
+<a name="id3069447"></a>
<a class="link" href="_struct_align_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_align_.template_signature">Template
Signature</a>
</h5>
@@ -52,12 +52,48 @@
</p>
<pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span> <span class="keyword">namespace</span> <span class="identifier">bitfields</span> <span class="special">{</span>
<span class="keyword">template</span> <span class="special"><</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">AlignTo</span><span class="special">></span> <span class="keyword">struct</span> <span class="identifier">align</span><span class="special">;</span>
-<span class="special">}}</span> <span class="comment">// end boost::bitfields
-</span></pre>
+<span class="special">}}</span>
+</pre>
<p>
</p>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_align_.template_parameters"></a><h5>
+<a name="id3069573"></a>
+ <a class="link" href="_struct_align_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_align_.template_parameters">Template
+ Parameters</a>
+ </h5>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ template Parameter
+ </p>
+ </th>
+<th>
+ <p>
+ Explanation
+ </p>
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">AlignTo</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ The value that the next bitfield's first bit should be a multiple
+ of.
+ </p>
+ </td>
+</tr></tbody>
+</table></div>
<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_align_.header_file_locaton"></a><h5>
-<a name="id713199"></a>
+<a name="id3069665"></a>
<a class="link" href="_struct_align_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_align_.header_file_locaton">Header
file Locaton</a>
</h5>
@@ -70,10 +106,33 @@
<p>
</p>
<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_align_.example"></a><h5>
-<a name="id713298"></a>
+<a name="id3069775"></a>
<a class="link" href="_struct_align_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_align_.example">Example</a>
</h5>
<p>
+
+</p>
+<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">integer</span><span class="special">/</span><span class="identifier">bitfield_tuple</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
+<span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">bitfields</span><span class="special">;</span>
+<span class="keyword">struct</span> <span class="identifier">i</span><span class="special">;</span>
+<span class="keyword">struct</span> <span class="identifier">red</span><span class="special">;</span>
+<span class="keyword">struct</span> <span class="identifier">green</span><span class="special">;</span>
+<span class="keyword">struct</span> <span class="identifier">blue</span><span class="special">;</span>
+
+<span class="keyword">typedef</span> <span class="identifier">bitfield_tuple</span><span class="special"><</span>
+ <span class="identifier">storage</span><span class="special"><</span><span class="keyword">unsigned</span> <span class="keyword">long</span> <span class="keyword">long</span><span class="special">>,</span>
+ <span class="identifier">member</span><span class="special"><</span><span class="keyword">unsigned</span> <span class="keyword">int</span><span class="special">,</span><span class="identifier">red</span><span class="special">,</span><span class="number">5</span><span class="special">>,</span>
+ <span class="identifier">member</span><span class="special"><</span><span class="keyword">unsigned</span> <span class="keyword">int</span><span class="special">,</span> <span class="identifier">green</span><span class="special">,</span> <span class="number">6</span><span class="special">>,</span>
+ <span class="identifier">member</span><span class="special"><</span><span class="identifier">unsinged</span> <span class="keyword">int</span><span class="special">,</span> <span class="identifier">blue</span><span class="special">,</span><span class="number">5</span><span class="special">>,</span>
+ <span class="identifier">align</span><span class="special"><</span><span class="number">32</span><span class="special">>,</span>
+ <span class="identifier">member</span><span class="special"><</span><span class="keyword">int</span><span class="special">,</span><span class="identifier">i</span><span class="special">,</span><span class="number">32</span><span class="special">></span>
+<span class="special">></span> <span class="identifier">color_plus_int</span><span class="special">;</span>
+</pre>
+<p>
+ 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.
</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
@@ -86,7 +145,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="_struct_flag_.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../_bitfield_tuple__class_reference.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="_struct_storage_.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="_struct_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="_struct_storage_.html"><img src="../../../../images/next.png" alt="Next"></a>
</div>
</body>
</html>
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/_bitfield_tuple__class_reference/_struct_custom_.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/_bitfield_tuple__class_reference/_struct_custom_.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/_bitfield_tuple__class_reference/_struct_custom_.html 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -13,18 +13,27 @@
<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="_struct_pointer_.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../_bitfield_tuple__class_reference.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../_bitfield_tuple__macro_reference.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="_struct_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._struct_custom_"></a><a class="link" href="_struct_custom_.html" title="struct custom"><code class="computeroutput"><span class="keyword">struct</span> <span class="identifier">custom</span></code></a>
</h5></div></div></div>
<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_custom_.description"></a><h5>
-<a name="id714071"></a>
+<a name="id3073559"></a>
<a class="link" href="_struct_custom_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_custom_.description">Description</a>
</h5>
+<p>
+ The <code class="computeroutput"><span class="identifier">custom</span></code> member is
+ a template which is used to do to integers what <code class="computeroutput"><span class="identifier">pointer</span></code>
+ does to pointers. That being said, the custom class allows for semi-intrusive
+ behavior with regards to the storage of <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>.
+ In the simplest use cases the <code class="computeroutput"><span class="identifier">custom</span></code>
+ member will only ever take three template parameters and will use the
+ default policy which is supplied.
+ </p>
<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_custom_.template_signature"></a><h5>
-<a name="id714093"></a>
+<a name="id3073638"></a>
<a class="link" href="_struct_custom_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_custom_.template_signature">Template
Signature</a>
</h5>
@@ -40,12 +49,170 @@
<span class="keyword">class</span> <span class="identifier">Policy</span> <span class="special">=</span> <span class="identifier">detail</span><span class="special">::</span><span class="identifier">custom_packing_policy</span>
<span class="special">></span>
<span class="keyword">struct</span> <span class="identifier">custom</span><span class="special">;</span>
-<span class="special">}}</span> <span class="comment">// end boost::bitfields
-</span></pre>
+<span class="special">}}</span>
+</pre>
<p>
</p>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_custom_.template_parameters"></a><h5>
+<a name="id3073876"></a>
+ <a class="link" href="_struct_custom_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_custom_.template_parameters">Template
+ Parameters</a>
+ </h5>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ template Parameter
+ </p>
+ </th>
+<th>
+ <p>
+ Explanation
+ </p>
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">ReturnType</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ 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.
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">Name</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ This is a type which is associated with the bitfield which
+ is represented by this member template.
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">Mask</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ This is a mask which minimally defines the following two <code class="computeroutput"><span class="keyword">typedef</span></code>s and static constant:
+ <code class="computeroutput"><span class="identifier">Mask</span><span class="special">::</span><span class="identifier">type</span></code>, <code class="computeroutput"><span class="identifier">Mask</span><span class="special">::</span><span class="identifier">value_type</span></code>,
+ and <code class="computeroutput"><span class="identifier">Mask</span><span class="special">::</span><span class="identifier">value</span></code>. There are masking
+ utilities which are included with <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>
+ which make using this parameter easier.
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">Policy</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ See below in the <code class="computeroutput"><span class="identifier">Policy</span></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"><span class="identifier">bitfield_tuples</span></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"><span class="identifier">bitfield_tuple</span></code>'s
+ storage. The similar is done to get the information out of
+ the <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>'s
+ storage. <span class="bold"><strong>For MOST cases this will NOT
+ have to be used and the default case will work just fine.</strong></span>
+ </p>
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_custom_.preconditions"></a><h4>
+<a name="id3074202"></a>
+ <a class="link" href="_struct_custom_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_custom_.preconditions">Preconditions</a>
+ </h4>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ Precondition
+ </p>
+ </th>
+<th>
+ <p>
+ Description
+ </p>
+ </th>
+<th>
+ <p>
+ Enforcement
+ </p>
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">Mask</span><span class="special">::</span><span class="identifier">value</span> <span class="special">!=</span>
+ <span class="number">0</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ The value associated with the mask can not be zero.
+ </p>
+ </td>
+<td>
+ <p>
+ Enforced by static assert.
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">Name</span></code> must be
+ unique.
+ </p>
+ </td>
+<td>
+ <p>
+ The <code class="computeroutput"><span class="identifier">Name</span></code> template
+ parameter can only be supplied once per <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>.
+ </p>
+ </td>
+<td>
+ <p>
+ Enforced by static assert.
+ </p>
+ </td>
+</tr>
+</tbody>
+</table></div>
<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_custom_.header_file_locaton"></a><h5>
-<a name="id714332"></a>
+<a name="id3074387"></a>
<a class="link" href="_struct_custom_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_custom_.header_file_locaton">Header
file Locaton</a>
</h5>
@@ -57,10 +224,299 @@
</pre>
<p>
</p>
-<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_custom_.example"></a><h5>
-<a name="id714431"></a>
- <a class="link" href="_struct_custom_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_custom_.example">Example</a>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_custom_.examples"></a><h5>
+<a name="id3074493"></a>
+ <a class="link" href="_struct_custom_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_custom_.examples">Examples</a>
</h5>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_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="id3074522"></a>
+ <a class="link" href="_struct_custom_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_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"><span class="identifier">custom</span></code> member to store
+ the 16 most significant bits of an integer</a>
+ </h6>
+<p>
+
+</p>
+<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">integer</span><span class="special">/</span><span class="identifier">bifield_tuple</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
+
+<span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">bitifields</span><span class="special">;</span>
+<span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">high_bits_mask</span><span class="special"><</span><span class="keyword">unsigned</span> <span class="keyword">int</span><span class="special">,</span> <span class="number">16</span><span class="special">></span> <span class="identifier">top16bits</span><span class="special">;</span>
+<span class="keyword">struct</span> <span class="identifier">int1</span><span class="special">;</span>
+<span class="keyword">struct</span> <span class="identifier">int2</span><span class="special">;</span>
+<span class="keyword">typedef</span> <span class="identifier">bitfield_tuple</span><span class="special"><</span>
+ <span class="identifier">storage</span><span class="special"><</span><span class="keyword">unsigned</span> <span class="keyword">int</span><span class="special">>,</span>
+ <span class="identifier">custom</span><span class="special"><</span><span class="keyword">unsigned</span> <span class="keyword">int</span><span class="special">,</span> <span class="identifier">int1</span><span class="special">,</span> <span class="identifier">top16bits</span><span class="special">>,</span>
+ <span class="identifier">member</span><span class="special"><</span><span class="keyword">unsigned</span> <span class="keyword">int</span><span class="special">,</span> <span class="identifier">int2</span><span class="special">,</span> <span class="number">16</span><span class="special">></span>
+<span class="special">></span> <span class="identifier">two_different_halves</span><span class="special">;</span>
+</pre>
+<p>
+ <code class="computeroutput"><span class="identifier">custom</span></code> members are accessed
+ just the same as every other member within a <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>
+ by simply using the get function followed by its index or <code class="computeroutput"><span class="identifier">Name</span></code>.
+ </p>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_custom_.how_to_define_a_policy_for_a_custom_member"></a><h5>
+<a name="id3074928"></a>
+ <a class="link" href="_struct_custom_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_custom_.how_to_define_a_policy_for_a_custom_member">How
+ to Define a Policy For a Custom Member</a>
+ </h5>
+<p>
+ 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.
+ </p>
+<p>
+ 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.
+</p>
+<pre class="programlisting"><span class="keyword">template</span> <span class="special"><</span><span class="keyword">typename</span> <span class="identifier">Mask</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">ValueType</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Offset</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Width</span><span class="special">></span>
+<span class="keyword">struct</span> <span class="identifier">my_policy</span><span class="special">;</span>
+</pre>
+<p>
+ </p>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_custom_.policy_parameter_description"></a><h6>
+<a name="id3075070"></a>
+ <a class="link" href="_struct_custom_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_custom_.policy_parameter_description">Policy
+ Parameter Description</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ Parameter Name
+ </p>
+ </th>
+<th>
+ <p>
+ Description
+ </p>
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">Mask</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">Mask</span></code> is the
+ template parameter which was supplied to the <code class="computeroutput"><span class="identifier">custom</span></code> member as a <code class="computeroutput"><span class="identifier">Mask</span></code>.
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">ValueType</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ This is the type which was supplied to the <code class="computeroutput"><span class="identifier">custom</span></code>
+ template as the <code class="computeroutput"><span class="identifier">ReturnType</span></code>.
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">Offset</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ This of type <code class="computeroutput"><span class="identifier">mpl</span><span class="special">::</span><span class="identifier">size_t</span><span class="special"><</span></code><span class="emphasis"><em>Implementation
+ Defined</em></span><code class="computeroutput"><span class="special">></span></code>
+ which is used to denote the number of bits from the least significant
+ bit the field is supposed to be.
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">Width</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ This of type <code class="computeroutput"><span class="identifier">mpl</span><span class="special">::</span><span class="identifier">size_t</span><span class="special"><</span></code><span class="emphasis"><em>Implementation
+ Defined</em></span><code class="computeroutput"><span class="special">></span></code>.
+ The width is deduced from the mask supplied to the <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code> based on leading
+ and trailing zeros within <code class="computeroutput"><span class="identifier">Mask</span></code>.
+ </p>
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_custom_.policy_body"></a><h6>
+<a name="id3075398"></a>
+ <a class="link" href="_struct_custom_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_custom_.policy_body">Policy
+ Body</a>
+ </h6>
+<p>
+ The body of the class template must contain the following <code class="computeroutput"><span class="keyword">typedef</span></code> and member template.
+ </p>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ Type
+ </p>
+ </th>
+<th>
+ <p>
+ Description
+ </p>
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">value_type</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ This is the ValueType which was supplied to the policy. If
+ the <code class="computeroutput"><span class="keyword">typedef</span></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.
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">StorageType</span><span class="special">></span> <span class="keyword">struct</span>
+ <span class="identifier">apply</span><span class="special">;</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ 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"><span class="identifier">StorageType</span></code>
+ in the apply member template refers to the integral type which
+ the <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>
+ is using for storing its bitfields.
+ </p>
+ </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"><p>
+ I recommend that if you wish to specialize the policy you do so by
+ having the <code class="computeroutput"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">StorageType</span><span class="special">></span> <span class="keyword">struct</span>
+ <span class="identifier">apply</span><span class="special">;</span></code>
+ inherit something which takes all five template parameters in scope:
+ <code class="computeroutput"><span class="identifier">Mask</span></code>, <code class="computeroutput"><span class="identifier">ValueType</span></code>, <code class="computeroutput"><span class="identifier">Offset</span></code>,
+ <code class="computeroutput"><span class="identifier">Width</span></code> and <code class="computeroutput"><span class="identifier">StorageType</span></code> and then define the necessary
+ two static functions there.
+ </p></td></tr>
+</table></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_custom_.the__code__phrase_role__identifier__apply__phrase___code__member_template"></a><h6>
+<a name="id3075722"></a>
+ <a class="link" href="_struct_custom_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_custom_.the__code__phrase_role__identifier__apply__phrase___code__member_template">The
+ <code class="computeroutput"><span class="identifier">apply</span></code> member template</a>
+ </h6>
+<p>
+ 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.
+ </p>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ Static Function
+ </p>
+ </th>
+<th>
+ <p>
+ Description
+ </p>
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="keyword">static</span> <span class="identifier">StorageType</span>
+ <span class="identifier">set</span><span class="special">(</span><span class="identifier">StorageType</span> <span class="identifier">storage</span><span class="special">,</span> <span class="identifier">ValueType</span>
+ <span class="identifier">value</span><span class="special">);</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ 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"><span class="identifier">bitfield_tuple</span></code>
+ uses.
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="keyword">static</span> <span class="identifier">ValueType</span>
+ <span class="identifier">get</span><span class="special">(</span><span class="identifier">StorageType</span> <span class="identifier">storage</span><span class="special">);</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ Retrieves the value of from <code class="computeroutput"><span class="identifier">storage</span></code>
+ which is the actual storage from within <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>
+ and returns the value of the bitfield.
+ </p>
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_custom_.completed_policy_structure_"></a><h6>
+<a name="id3075977"></a>
+ <a class="link" href="_struct_custom_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_custom_.completed_policy_structure_">Completed
+ Policy Structure </a>
+ </h6>
+<p>
+ Example of what a completed policy will need to look like.
+</p>
+<pre class="programlisting"><span class="keyword">template</span> <span class="special"><</span><span class="keyword">typename</span> <span class="identifier">Mask</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">ValueType</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Offset</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Width</span><span class="special">></span>
+<span class="keyword">struct</span> <span class="identifier">my_policy</span> <span class="special">{</span>
+
+ <span class="keyword">typedef</span> <span class="identifier">ValueType</span> <span class="identifier">value_type</span><span class="special">;</span>
+
+ <span class="keyword">template</span> <span class="special"><</span><span class="keyword">typename</span> <span class="identifier">StorageType</span><span class="special">></span>
+ <span class="keyword">struct</span> <span class="identifier">apply</span> <span class="special">{</span>
+ <span class="keyword">static</span> <span class="identifier">ValueType</span> <span class="identifier">get</span><span class="special">(</span><span class="identifier">StorageType</span> <span class="identifier">storage</span><span class="special">);</span>
+ <span class="keyword">static</span> <span class="identifier">StorageType</span> <span class="identifier">set</span><span class="special">(</span><span class="identifier">StorageType</span> <span class="identifier">storage</span><span class="special">,</span> <span class="identifier">ValueType</span> <span class="identifier">value</span><span class="special">);</span>
+ <span class="special">};</span>
+<span class="special">};</span>
+</pre>
<p>
</p>
</div>
@@ -74,7 +530,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="_struct_pointer_.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../_bitfield_tuple__class_reference.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../_bitfield_tuple__macro_reference.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="_struct_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>
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/_bitfield_tuple__class_reference/_struct_flag_.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/_bitfield_tuple__class_reference/_struct_flag_.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/_bitfield_tuple__class_reference/_struct_flag_.html 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -13,39 +13,23 @@
<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="_struct_member_.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../_bitfield_tuple__class_reference.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="_struct_align_.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="_struct_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="_struct_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._struct_flag_"></a><a class="link" href="_struct_flag_.html" title="struct flag"><code class="computeroutput"><span class="keyword">struct</span> <span class="identifier">flag</span></code></a>
</h5></div></div></div>
<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_flag_.description"></a><h5>
-<a name="id712386"></a>
+<a name="id3068167"></a>
<a class="link" href="_struct_flag_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_flag_.description">Description</a>
</h5>
<p>
<code class="computeroutput"><span class="identifier">flag</span></code> is used to specify
- a boolean member of width one. For example,
-</p>
-<pre class="programlisting"><span class="keyword">struct</span> <span class="identifier">red</span><span class="special">;</span>
-
-<span class="keyword">typedef</span> <span class="identifier">bitfield_tuple</span><span class="special"><</span>
- <span class="identifier">flag</span><span class="special"><</span><span class="identifier">red</span><span class="special">></span>
-<span class="special">></span> <span class="identifier">bitfield_tuple_1</span><span class="special">;</span>
-
-
-<span class="keyword">typedef</span> <span class="identifier">btifield_tuple</span><span class="special"><</span>
- <span class="identifier">member</span><span class="special"><</span><span class="keyword">bool</span><span class="special">,</span><span class="identifier">red</span><span class="special">,</span><span class="number">1</span><span class="special">></span>
-<span class="special">></span> <span class="identifier">bitfield_tuple_2</span><span class="special">;</span>
-</pre>
-<p>
- the types <code class="computeroutput"><span class="identifier">bitfield_tuple_1</span></code>
- and <code class="computeroutput"><span class="identifier">bitfield_tuple_2</span></code>
- specify the same internal structure for their data. <code class="computeroutput"><span class="identifier">flag</span><span class="special"><</span><span class="identifier">red</span><span class="special">></span></code> has the same affect on a <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code> as <code class="computeroutput"><span class="identifier">member</span><span class="special"><</span><span class="keyword">bool</span><span class="special">,</span><span class="identifier">red</span><span class="special">,</span><span class="number">1</span><span class="special">></span></code>
- would have.
+ a boolean member of width one. This is a simplification of <code class="computeroutput"><span class="identifier">member</span><span class="special"><</span><span class="keyword">bool</span><span class="special">,</span><span class="identifier">NameType</span><span class="special">,</span><span class="number">1</span><span class="special">></span></code> and
+ does the exact same thing.
</p>
<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_flag_.template_signature"></a><h5>
-<a name="id712665"></a>
+<a name="id3068251"></a>
<a class="link" href="_struct_flag_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_flag_.template_signature">Template
Signature</a>
</h5>
@@ -54,14 +38,97 @@
</p>
<pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span> <span class="keyword">namespace</span> <span class="identifier">bitfields</span> <span class="special">{</span>
<span class="keyword">template</span> <span class="special"><</span><span class="keyword">typename</span> <span class="identifier">Name</span><span class="special">></span> <span class="keyword">struct</span> <span class="identifier">flag</span><span class="special">;</span>
-<span class="special">}}</span> <span class="comment">// end boost::bitfields
-</span></pre>
+<span class="special">}}</span>
+</pre>
<p>
</p>
-<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_flag_.header_file_locaton"></a><h5>
-<a name="id712782"></a>
- <a class="link" href="_struct_flag_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_flag_.header_file_locaton">Header
- file Locaton</a>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_flag_.template_parameters"></a><h5>
+<a name="id3068369"></a>
+ <a class="link" href="_struct_flag_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_flag_.template_parameters">Template
+ Parameters</a>
+ </h5>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ template Parameter
+ </p>
+ </th>
+<th>
+ <p>
+ Explanation
+ </p>
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">Name</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ This is the name which can be used to access the template parameter
+ using the get function.
+ </p>
+ </td>
+</tr></tbody>
+</table></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_flag_.preconditions"></a><h4>
+<a name="id3068460"></a>
+ <a class="link" href="_struct_flag_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_flag_.preconditions">Preconditions</a>
+ </h4>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ Precondition
+ </p>
+ </th>
+<th>
+ <p>
+ Description
+ </p>
+ </th>
+<th>
+ <p>
+ Enforcement
+ </p>
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">Name</span></code> must be
+ unique.
+ </p>
+ </td>
+<td>
+ <p>
+ The <code class="computeroutput"><span class="identifier">Name</span></code> template
+ parameter can only be supplied once per <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>.
+ </p>
+ </td>
+<td>
+ <p>
+ Enforced by static assert.
+ </p>
+ </td>
+</tr></tbody>
+</table></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_flag_.header_file_location"></a><h5>
+<a name="id3068588"></a>
+ <a class="link" href="_struct_flag_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_flag_.header_file_location">Header
+ File Location</a>
</h5>
<p>
This header file is included with the <boost/integer/bitfield_tuple.hpp>
@@ -72,10 +139,53 @@
<p>
</p>
<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_flag_.example"></a><h5>
-<a name="id712881"></a>
+<a name="id3068699"></a>
<a class="link" href="_struct_flag_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_flag_.example">Example</a>
</h5>
<p>
+ This is the simplification which <code class="computeroutput"><span class="identifier">flag</span></code>
+ makes in comparison to writing the same thing using the <code class="computeroutput"><span class="identifier">member</span></code> template.
+</p>
+<pre class="programlisting"><span class="keyword">struct</span> <span class="identifier">b</span><span class="special">;</span>
+
+<span class="keyword">typedef</span> <span class="identifier">bitfield_tuple</span><span class="special"><</span>
+ <span class="identifier">flag</span><span class="special"><</span><span class="identifier">b</span><span class="special">></span>
+<span class="special">></span> <span class="identifier">bitfield_tuple_1</span><span class="special">;</span>
+
+
+<span class="keyword">typedef</span> <span class="identifier">btifield_tuple</span><span class="special"><</span>
+ <span class="identifier">member</span><span class="special"><</span><span class="keyword">bool</span><span class="special">,</span><span class="identifier">b</span><span class="special">,</span><span class="number">1</span><span class="special">></span>
+<span class="special">></span> <span class="identifier">bitfield_tuple_2</span><span class="special">;</span>
+</pre>
+<p>
+ </p>
+<p>
+ Example of how to use <code class="computeroutput"><span class="identifier">flag</span></code>
+ within the declaration of a <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>
+ template.
+</p>
+<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">integer</span><span class="special">/</span><span class="identifier">bitfield_tuple</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
+
+<span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">bitfields</span><span class="special">;</span>
+
+<span class="keyword">struct</span> <span class="identifier">b0</span><span class="special">;</span>
+<span class="keyword">struct</span> <span class="identifier">b1</span><span class="special">;</span>
+<span class="keyword">struct</span> <span class="identifier">b2</span><span class="special">;</span>
+<span class="keyword">struct</span> <span class="identifier">b3</span><span class="special">;</span>
+<span class="keyword">struct</span> <span class="identifier">something</span><span class="special">;</span>
+
+<span class="keyword">typedef</span> <span class="identifier">btifield_tuple</span><span class="special"><</span>
+ <span class="identifier">flag</span><span class="special"><</span><span class="identifier">b0</span><span class="special">>,</span>
+ <span class="identifier">flag</span><span class="special"><</span><span class="identifier">b1</span><span class="special">>,</span>
+ <span class="identifier">flag</span><span class="special"><</span><span class="identifier">b2</span><span class="special">>,</span>
+ <span class="identifier">flag</span><span class="special"><</span><span class="identifier">b3</span><span class="special">>,</span>
+ <span class="identifier">member</span><span class="special"><</span><span class="keyword">unsigned</span> <span class="keyword">int</span><span class="special">,</span> <span class="identifier">something</span><span class="special">,</span><span class="number">4</span><span class="special">></span>
+<span class="special">></span> <span class="identifier">int_bool_size_char</span><span class="special">;</span>
+</pre>
+<p>
+ The above type is used to represent a char which is split between 4
+ <code class="computeroutput"><span class="keyword">bool</span></code> values and a 4 bit
+ <code class="computeroutput"><span class="keyword">unsigned</span> <span class="keyword">int</span></code>
</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
@@ -88,7 +198,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="_struct_member_.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../_bitfield_tuple__class_reference.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="_struct_align_.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="_struct_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="_struct_align_.html"><img src="../../../../images/next.png" alt="Next"></a>
</div>
</body>
</html>
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/_bitfield_tuple__class_reference/_struct_member_.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/_bitfield_tuple__class_reference/_struct_member_.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/_bitfield_tuple__class_reference/_struct_member_.html 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -13,20 +13,46 @@
<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="_struct_padding_.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../_bitfield_tuple__class_reference.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="_struct_flag_.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="_struct_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="_struct_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._struct_member_"></a><a class="link" href="_struct_member_.html" title="struct member"><code class="computeroutput"><span class="keyword">struct</span> <span class="identifier">member</span></code></a>
</h5></div></div></div>
<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_member_.description"></a><h5>
-<a name="id711875"></a>
+<a name="id3066909"></a>
<a class="link" href="_struct_member_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_member_.description">Description</a>
</h5>
<p>
- <code class="computeroutput"><span class="identifier">member</span></code> us used for specifying
+ <code class="computeroutput"><span class="identifier">member</span></code> is used for specifying
different bitfields within a <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>.
+ A <code class="computeroutput"><span class="identifier">member</span></code> is meant to
+ look like a bitfield when it is declared within a <code class="computeroutput"><span class="keyword">class</span></code>
+ or <code class="computeroutput"><span class="keyword">struct</span></code>. A <code class="computeroutput"><span class="identifier">member</span></code> is the most basic type of bitfield
+ that can be used for a <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>.
+ When other templates used to specify a <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>
+ are noted as members, it means they have storage space as a bitfield
+ within the <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>.
</p>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_member_.template_signature"></a><h5>
+<a name="id3067041"></a>
+ <a class="link" href="_struct_member_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_member_.template_signature">Template
+ Signature</a>
+ </h5>
+<p>
+
+</p>
+<pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span> <span class="keyword">namespace</span> <span class="identifier">bitfields</span> <span class="special">{</span>
+<span class="keyword">template</span> <span class="special"><</span><span class="keyword">typename</span> <span class="identifier">ReturnType</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">NameType</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">Width</span><span class="special">></span> <span class="keyword">struct</span> <span class="identifier">member</span><span class="special">;</span>
+<span class="special">}}</span>
+</pre>
+<p>
+ </p>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_member_.template_parameters"></a><h5>
+<a name="id3067200"></a>
+ <a class="link" href="_struct_member_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_member_.template_parameters">Template
+ Parameters</a>
+ </h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
@@ -53,10 +79,10 @@
</td>
<td>
<p>
- The type that the value is to be returnd from the get function
+ 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 shouldn't store them.
+ so if you don't need negative values you should not store them.
</p>
</td>
</tr>
@@ -92,23 +118,97 @@
</tr>
</tbody>
</table></div>
-<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_member_.template_signature"></a><h5>
-<a name="id712073"></a>
- <a class="link" href="_struct_member_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_member_.template_signature">Template
- Signature</a>
- </h5>
-<p>
-
-</p>
-<pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span> <span class="keyword">namespace</span> <span class="identifier">bitfields</span> <span class="special">{</span>
-<span class="keyword">template</span> <span class="special"><</span><span class="keyword">typename</span> <span class="identifier">ReturnType</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">NameType</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">Width</span><span class="special">></span>
-<span class="keyword">struct</span> <span class="identifier">member</span><span class="special">;</span>
-<span class="special">}}</span> <span class="comment">// end boost::bitfields
-</span></pre>
-<p>
- </p>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_member_.preconditions"></a><h4>
+<a name="id3067389"></a>
+ <a class="link" href="_struct_member_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_member_.preconditions">Preconditions</a>
+ </h4>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ Precondition
+ </p>
+ </th>
+<th>
+ <p>
+ Description
+ </p>
+ </th>
+<th>
+ <p>
+ Enforcement
+ </p>
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">Width</span> <span class="special">!=</span>
+ <span class="number">0</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ The <code class="computeroutput"><span class="identifier">Width</span></code> template
+ parameter must not be zero.
+ </p>
+ </td>
+<td>
+ <p>
+ Enforced by static assert.
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">Width</span> <span class="special"><=</span>
+ <span class="identifier">bit_width</span><span class="special"><</span><span class="identifier">ReturnType</span><span class="special">>::</span><span class="identifier">value</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ The <code class="computeroutput"><span class="identifier">Width</span></code> parameter
+ of <code class="computeroutput"><span class="identifier">member</span></code> must
+ not exceed the width in bits of <code class="computeroutput"><span class="identifier">ReturnType</span></code>
+ template parameter.
+ </p>
+ </td>
+<td>
+ <p>
+ Enforced by static assert.
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">NameType</span></code> must
+ be unique.
+ </p>
+ </td>
+<td>
+ <p>
+ The <code class="computeroutput"><span class="identifier">NameType</span></code>
+ template parameter can only be supplied once per <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>.
+ </p>
+ </td>
+<td>
+ <p>
+ Enforced by static assert.
+ </p>
+ </td>
+</tr>
+</tbody>
+</table></div>
<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_member_.header_file_locaton"></a><h5>
-<a name="id712231"></a>
+<a name="id3067675"></a>
<a class="link" href="_struct_member_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_member_.header_file_locaton">Header
file Locaton</a>
</h5>
@@ -121,10 +221,30 @@
<p>
</p>
<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_member_.example"></a><h5>
-<a name="id712328"></a>
+<a name="id3067782"></a>
<a class="link" href="_struct_member_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_member_.example">Example</a>
</h5>
<p>
+
+</p>
+<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">integer</span><span class="special">/</span><span class="identifier">bitfield_tuple</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
+
+<span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">bitfields</span><span class="special">;</span>
+
+<span class="keyword">struct</span> <span class="identifier">red</span><span class="special">;</span>
+<span class="keyword">struct</span> <span class="identifier">green</span><span class="special">;</span>
+<span class="keyword">struct</span> <span class="identifier">salmon</span><span class="special">;</span>
+
+<span class="keyword">typedef</span> <span class="identifier">bitfield_tuple</span><span class="special"><</span>
+ <span class="identifier">member</span><span class="special"><</span><span class="keyword">char</span><span class="special">,</span><span class="identifier">red</span><span class="special">,</span><span class="number">4</span><span class="special">>,</span>
+ <span class="identifier">member</span><span class="special"><</span><span class="keyword">unsigned</span> <span class="keyword">char</span><span class="special">,</span> <span class="identifier">green</span><span class="special">,</span><span class="number">5</span><span class="special">>,</span>
+ <span class="identifier">member</span><span class="special"><</span><span class="keyword">int</span><span class="special">,</span> <span class="identifier">salmon</span><span class="special">,</span> <span class="number">16</span><span class="special">></span>
+<span class="special">></span> <span class="identifier">color_tuple</span><span class="special">;</span>
+</pre>
+<p>
+ The <code class="computeroutput"><span class="identifier">member</span></code>s specified
+ in <code class="computeroutput"><span class="identifier">color_tuple</span></code> above
+ are used to specify the different bitfields within the <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>.
</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
@@ -137,7 +257,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="_struct_padding_.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../_bitfield_tuple__class_reference.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="_struct_flag_.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="_struct_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="_struct_flag_.html"><img src="../../../../images/next.png" alt="Next"></a>
</div>
</body>
</html>
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/_bitfield_tuple__class_reference/_struct_padding_.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/_bitfield_tuple__class_reference/_struct_padding_.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/_bitfield_tuple__class_reference/_struct_padding_.html 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -13,26 +13,28 @@
<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="../../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../_bitfield_tuple__class_reference.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="_struct_member_.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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="_struct_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._struct_padding_"></a><a class="link" href="_struct_padding_.html" title="struct padding"><code class="computeroutput"><span class="keyword">struct</span> <span class="identifier">padding</span></code></a>
</h5></div></div></div>
<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_padding_.description"></a><h5>
-<a name="id711552"></a>
+<a name="id3066064"></a>
<a class="link" href="_struct_padding_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_padding_.description">Description</a>
</h5>
<p>
- padding 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"><span class="identifier">Bits</span></code> to the starting
- the next starting position of the next bitfield specified in the template
- parameter list.
+ <code class="computeroutput"><span class="identifier">padding</span></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"><span class="identifier">Bits</span></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"><span class="identifier">bitfield_tuple</span></code>.
</p>
<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_padding_.template_signature"></a><h5>
-<a name="id711592"></a>
+<a name="id3066133"></a>
<a class="link" href="_struct_padding_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_padding_.template_signature">Template
Signature</a>
</h5>
@@ -41,14 +43,49 @@
</p>
<pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span> <span class="keyword">namespace</span> <span class="identifier">bitfields</span> <span class="special">{</span>
<span class="keyword">template</span> <span class="special"><</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">Bits</span><span class="special">></span> <span class="keyword">struct</span> <span class="identifier">padding</span><span class="special">;</span>
-<span class="special">}}</span> <span class="comment">// end boost::bitfields
-</span></pre>
+<span class="special">}}</span>
+</pre>
<p>
</p>
-<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_padding_.header_file_locaton"></a><h5>
-<a name="id711719"></a>
- <a class="link" href="_struct_padding_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_padding_.header_file_locaton">Header
- file Locaton</a>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_padding_.template_parameters"></a><h5>
+<a name="id3066260"></a>
+ <a class="link" href="_struct_padding_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_padding_.template_parameters">Template
+ Parameters</a>
+ </h5>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ Parameter
+ </p>
+ </th>
+<th>
+ <p>
+ Description
+ </p>
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">Bits</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ The amount of padding to add.
+ </p>
+ </td>
+</tr></tbody>
+</table></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_padding_.header_file_location"></a><h5>
+<a name="id3066349"></a>
+ <a class="link" href="_struct_padding_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_padding_.header_file_location">Header
+ File Location</a>
</h5>
<p>
This header file is included with the <boost/integer/bitfield_tuple.hpp>
@@ -59,10 +96,34 @@
<p>
</p>
<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_padding_.example"></a><h5>
-<a name="id711818"></a>
+<a name="id3066455"></a>
<a class="link" href="_struct_padding_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_padding_.example">Example</a>
</h5>
<p>
+
+</p>
+<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">\</span><span class="identifier">integer</span><span class="special">\</span><span class="identifier">bitfield_tuple</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
+
+<span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">bitfields</span><span class="special">;</span>
+
+<span class="keyword">struct</span> <span class="identifier">red</span><span class="special">;</span>
+<span class="keyword">struct</span> <span class="identifier">green</span><span class="special">;</span>
+<span class="keyword">struct</span> <span class="identifier">pink</span><span class="special">;</span>
+<span class="keyword">struct</span> <span class="identifier">blue</span><span class="special">;</span>
+<span class="keyword">struct</span> <span class="identifier">salmon</span><span class="special">;</span>
+
+<span class="keyword">typedef</span> <span class="identifier">bitfield_tuple</span><span class="special"><</span>
+ <span class="identifier">storage</span><span class="special"><</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">>,</span>
+ <span class="identifier">member</span><span class="special"><</span><span class="keyword">char</span><span class="special">,</span><span class="identifier">red</span><span class="special">,</span><span class="number">4</span><span class="special">>,</span>
+ <span class="identifier">member</span><span class="special"><</span><span class="keyword">unsigned</span> <span class="keyword">char</span><span class="special">,</span> <span class="identifier">green</span><span class="special">,</span><span class="number">5</span><span class="special">>,</span>
+ <span class="identifier">padding</span><span class="special"><</span><span class="number">3</span><span class="special">>,</span>
+ <span class="identifier">member</span><span class="special"><</span><span class="keyword">int</span><span class="special">,</span> <span class="identifier">salmon</span><span class="special">,</span> <span class="number">16</span><span class="special">>,</span>
+ <span class="identifier">flag</span><span class="special"><</span><span class="identifier">blue</span><span class="special">></span>
+<span class="special">></span> <span class="identifier">tuple_with_padding</span><span class="special">;</span>
+</pre>
+<p>
+ All the padding does in the above is shift the last two members over
+ by 3 bits.
</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
@@ -75,7 +136,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="_bitfield_tuple__and__bitfield_reference_.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../_bitfield_tuple__class_reference.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="_struct_member_.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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="_struct_member_.html"><img src="../../../../images/next.png" alt="Next"></a>
</div>
</body>
</html>
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/_bitfield_tuple__class_reference/_struct_pointer_.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/_bitfield_tuple__class_reference/_struct_pointer_.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/_bitfield_tuple__class_reference/_struct_pointer_.html 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -13,14 +13,14 @@
<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="_struct_storage_.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../_bitfield_tuple__class_reference.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="_struct_custom_.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="_struct_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="_struct_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._struct_pointer_"></a><a class="link" href="_struct_pointer_.html" title="struct pointer"><code class="computeroutput"><span class="keyword">struct</span> <span class="identifier">pointer</span></code></a>
</h5></div></div></div>
<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_pointer_.description"></a><h5>
-<a name="id713708"></a>
+<a name="id3071427"></a>
<a class="link" href="_struct_pointer_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_pointer_.description">Description</a>
</h5>
<p>
@@ -36,7 +36,7 @@
in a valid manner if the address of the pointer is at a lower value.
</p>
<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_pointer_.template_signature"></a><h5>
-<a name="id713740"></a>
+<a name="id3071470"></a>
<a class="link" href="_struct_pointer_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_pointer_.template_signature">Template
Signature</a>
</h5>
@@ -51,12 +51,171 @@
<span class="special">></span>
<span class="special">></span>
<span class="keyword">struct</span> <span class="identifier">pointer</span><span class="special">;</span>
-<span class="special">}}</span> <span class="comment">// end boost::bitfields
-</span></pre>
+<span class="special">}}</span>
+</pre>
<p>
</p>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_pointer_.template_parameters"></a><h5>
+<a name="id3071644"></a>
+ <a class="link" href="_struct_pointer_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_pointer_.template_parameters">Template
+ Parameters</a>
+ </h5>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ template Parameter
+ </p>
+ </th>
+<th>
+ <p>
+ Explanation
+ </p>
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">ReturnType</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ This is the type which a pointer is being made to.
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">Name</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">Name</span></code> of the
+ field which is can be used to access the field with the get
+ function.
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">Mask</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ This is a mask which minimally defines the following two <code class="computeroutput"><span class="keyword">typedef</span></code>s and static constant:
+ <code class="computeroutput"><span class="identifier">Mask</span><span class="special">::</span><span class="identifier">type</span></code>, <code class="computeroutput"><span class="identifier">Mask</span><span class="special">::</span><span class="identifier">value_type</span></code>,
+ and <code class="computeroutput"><span class="identifier">Mask</span><span class="special">::</span><span class="identifier">value</span></code>. There are masking
+ utilities which are included with <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>
+ which make using this parameter easier. The <code class="computeroutput"><span class="identifier">Mask</span></code>
+ is used to define the value bits of the pointer which are to
+ be stored within the <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>.
+ The default value for this parameter is to define a <code class="computeroutput"><span class="identifier">Mask</span></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.
+ </p>
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_pointer_.preconditions"></a><h4>
+<a name="id3071929"></a>
+ <a class="link" href="_struct_pointer_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_pointer_.preconditions">Preconditions</a>
+ </h4>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ Precondition
+ </p>
+ </th>
+<th>
+ <p>
+ Description
+ </p>
+ </th>
+<th>
+ <p>
+ Enforcement
+ </p>
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">Mask</span><span class="special">::</span><span class="identifier">value</span> <span class="special">!=</span>
+ <span class="number">0</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ The value associated with the mask can not be zero.
+ </p>
+ </td>
+<td>
+ <p>
+ Enforced by static assert.
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="keyword">sizeof</span><span class="special">(</span><span class="identifier">Mask</span><span class="special">::</span><span class="identifier">value_type</span><span class="special">)</span>
+ <span class="special">==</span> <span class="keyword">sizeof</span><span class="special">(</span><span class="keyword">void</span><span class="special">*)</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ The value type of the mask must be the same size as a pointer.
+ </p>
+ </td>
+<td>
+ <p>
+ Enforced by static assert.
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">Name</span></code> must be
+ unique.
+ </p>
+ </td>
+<td>
+ <p>
+ The <code class="computeroutput"><span class="identifier">Name</span></code> template
+ parameter can only be supplied once per <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>.
+ </p>
+ </td>
+<td>
+ <p>
+ Enforced by static assert.
+ </p>
+ </td>
+</tr>
+</tbody>
+</table></div>
<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_pointer_.header_file_locaton"></a><h5>
-<a name="id713914"></a>
+<a name="id3072197"></a>
<a class="link" href="_struct_pointer_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_pointer_.header_file_locaton">Header
file Locaton</a>
</h5>
@@ -68,11 +227,119 @@
</pre>
<p>
</p>
-<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_pointer_.example"></a><h5>
-<a name="id714013"></a>
- <a class="link" href="_struct_pointer_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_pointer_.example">Example</a>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_pointer_.basic_example"></a><h5>
+<a name="id3072303"></a>
+ <a class="link" href="_struct_pointer_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_pointer_.basic_example">Basic
+ Example</a>
+ </h5>
+<p>
+ Basic use case for stuffing the 2 least significant bits of a pointer.
+
+</p>
+<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">integer</span><span class="special">/</span><span class="identifier">bitfield_tuple</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
+
+<span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">bitfields</span><span class="special">;</span>
+
+<span class="keyword">struct</span> <span class="identifier">ptr</span><span class="special">;</span>
+<span class="keyword">struct</span> <span class="identifier">b1</span><span class="special">;</span>
+<span class="keyword">struct</span> <span class="identifier">b2</span><span class="special">;</span>
+
+<span class="keyword">typedef</span> <span class="identifier">bitfield_tuple</span><span class="special"><</span>
+ <span class="identifier">pointer</span><span class="special"><</span><span class="keyword">int</span><span class="special">,</span> <span class="identifier">ptr</span><span class="special">>,</span>
+ <span class="identifier">flag</span><span class="special"><</span><span class="identifier">b1</span><span class="special">>,</span>
+ <span class="identifier">flag</span><span class="special"><</span><span class="identifier">b2</span><span class="special">></span>
+<span class="special">></span> <span class="identifier">bool_stuffed_ptr</span><span class="special">;</span>
+
+
+
+<span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span> <span class="special">{</span>
+ <span class="keyword">int</span><span class="special">*</span> <span class="identifier">some_ptr</span> <span class="special">=</span> <span class="keyword">new</span> <span class="keyword">int</span><span class="special">();</span>
+ <span class="identifier">bool_stuffed_ptr</span> <span class="identifier">bsp</span><span class="special">;</span>
+ <span class="identifier">bsp</span><span class="special">.</span><span class="identifier">get</span><span class="special"><</span><span class="identifier">ptr</span><span class="special">>()</span> <span class="special">=</span> <span class="identifier">some_ptr</span><span class="special">;</span>
+
+ <span class="comment">// prints the value of the integer being pointed at.
+</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special"><<</span> <span class="special">*</span><span class="identifier">bsp</span><span class="special">.</span><span class="identifier">get</span><span class="special"><</span><span class="identifier">ptr</span><span class="special">>()</span> <span class="special"><<</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
+
+ <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span>
+<span class="special">}</span>
+
+</pre>
+<p>
+ The <code class="computeroutput"><span class="identifier">bool_stuffed_ptr</span></code>
+ type allows for a the <code class="computeroutput"><span class="identifier">ptr</span></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"><span class="identifier">ptr</span></code>
+ the value returned from the get function will be dereferenceable just
+ like a regular pointer.
+ </p>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_pointer_.mask_example"></a><h5>
+<a name="id3072827"></a>
+ <a class="link" href="_struct_pointer_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_pointer_.mask_example">Mask
+ Example</a>
</h5>
<p>
+ Example of how to define a the <code class="computeroutput"><span class="identifier">Mask</span></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.
+</p>
+<pre class="programlisting"><span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">bitfields</span><span class="special">;</span>
+
+<span class="keyword">struct</span> <span class="identifier">ptr</span><span class="special">;</span>
+<span class="keyword">struct</span> <span class="identifier">b1</span><span class="special">;</span>
+<span class="keyword">struct</span> <span class="identifier">b2</span><span class="special">;</span>
+<span class="keyword">struct</span> <span class="identifier">b3</span><span class="special">;</span>
+
+<span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">high_bits_mask</span><span class="special"><</span>
+ <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">,</span>
+ <span class="identifier">bit_width</span><span class="special"><</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">>::</span><span class="identifier">value</span> <span class="special">-</span> <span class="number">3</span>
+<span class="special">></span> <span class="identifier">ptr_mask</span><span class="special">;</span>
+
+<span class="keyword">typedef</span> <span class="identifier">bitfield_tuple</span><span class="special"><</span>
+ <span class="identifier">pointer</span><span class="special"><</span><span class="keyword">int</span><span class="special">,</span> <span class="identifier">ptr</span><span class="special">,</span> <span class="identifier">ptr_mask</span><span class="special">>,</span>
+ <span class="identifier">flag</span><span class="special"><</span><span class="identifier">b1</span><span class="special">>,</span>
+ <span class="identifier">flag</span><span class="special"><</span><span class="identifier">b2</span><span class="special">>,</span>
+ <span class="identifier">flag</span><span class="special"><</span><span class="identifier">b3</span><span class="special">></span>
+<span class="special">></span> <span class="identifier">bool_stuffed_ptr</span><span class="special">;</span>
+</pre>
+<p>
+ The <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">high_bits_mask</span></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"><span class="identifier">high_bits_mask</span></code> is being used to create
+ the following mask in binary (assuming a 32 bit architecture):
+ </p>
+<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._struct_pointer_.two_pointers_and_a_4_bit_integer"></a><h6>
+<a name="id3073252"></a>
+ <a class="link" href="_struct_pointer_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_pointer_.two_pointers_and_a_4_bit_integer">Two
+ Pointers and a 4 Bit Integer</a>
+ </h6>
+<p>
+ 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"><span class="keyword">unsigned</span> <span class="keyword">long</span>
+ <span class="keyword">long</span></code> type.
+</p>
+<pre class="programlisting"><span class="keyword">struct</span> <span class="identifier">ptr1</span><span class="special">;</span>
+<span class="keyword">struct</span> <span class="identifier">ptr2</span><span class="special">;</span>
+<span class="keyword">struct</span> <span class="identifier">four_bit_int</span><span class="special">;</span>
+
+<span class="keyword">typedef</span> <span class="identifier">bitfield_tuple</span><span class="special"><</span>
+ <span class="identifier">pointer</span><span class="special"><</span><span class="keyword">int</span><span class="special">,</span> <span class="identifier">ptr1</span><span class="special">>,</span>
+ <span class="identifier">pointer</span><span class="special"><</span><span class="keyword">int</span><span class="special">,</span> <span class="identifier">ptr2</span><span class="special">>,</span>
+ <span class="identifier">member</span><span class="special"><</span><span class="keyword">unsigned</span> <span class="keyword">int</span><span class="special">,</span><span class="identifier">four_bit_int</span><span class="special">,</span><span class="number">4</span><span class="special">></span>
+<span class="special">></span> <span class="identifier">pointer_double_stuffed</span><span class="special">;</span>
+</pre>
+<p>
+ The <code class="computeroutput"><span class="identifier">pointer</span></code> members are
+ treated as bitfields and simply move around within the storage of the
+ <code class="computeroutput"><span class="identifier">bitfield_tuple</span></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.
</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
@@ -85,7 +352,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="_struct_storage_.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../_bitfield_tuple__class_reference.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="_struct_custom_.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="_struct_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="_struct_custom_.html"><img src="../../../../images/next.png" alt="Next"></a>
</div>
</body>
</html>
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/_bitfield_tuple__class_reference/_struct_storage_.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/_bitfield_tuple__class_reference/_struct_storage_.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/_bitfield_tuple__class_reference/_struct_storage_.html 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -13,14 +13,14 @@
<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="_struct_align_.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../_bitfield_tuple__class_reference.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="_struct_pointer_.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="_struct_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="_struct_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._struct_storage_"></a><a class="link" href="_struct_storage_.html" title="struct storage"><code class="computeroutput"><span class="keyword">struct</span> <span class="identifier">storage</span></code></a>
</h5></div></div></div>
<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_storage_.description"></a><h5>
-<a name="id713354"></a>
+<a name="id3070241"></a>
<a class="link" href="_struct_storage_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_storage_.description">Description</a>
</h5>
<p>
@@ -39,7 +39,7 @@
and accept values in the endianness of your native machine.
</p>
<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_storage_.template_signature"></a><h5>
-<a name="id713436"></a>
+<a name="id3070342"></a>
<a class="link" href="_struct_storage_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_storage_.template_signature">Template
Signature</a>
</h5>
@@ -48,12 +48,119 @@
</p>
<pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span> <span class="keyword">namespace</span> <span class="identifier">bitfields</span> <span class="special">{</span>
<span class="keyword">template</span> <span class="special"><</span><span class="keyword">typename</span> <span class="identifier">StorageType</span><span class="special">></span> <span class="keyword">struct</span> <span class="identifier">storage</span><span class="special">;</span>
-<span class="special">}}</span> <span class="comment">// end boost::bitfields
-</span></pre>
+<span class="special">}}</span>
+</pre>
<p>
</p>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_storage_.template_parameters"></a><h5>
+<a name="id3070460"></a>
+ <a class="link" href="_struct_storage_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_storage_.template_parameters">Template
+ Parameters</a>
+ </h5>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ template Parameter
+ </p>
+ </th>
+<th>
+ <p>
+ Explanation
+ </p>
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">StorageType</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ The storage type to be used for storing data inside of the
+ <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>.
+ </p>
+ </td>
+</tr></tbody>
+</table></div>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_storage_.preconditions"></a><h4>
+<a name="id3070562"></a>
+ <a class="link" href="_struct_storage_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_storage_.preconditions">Preconditions</a>
+ </h4>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ Precondition
+ </p>
+ </th>
+<th>
+ <p>
+ Description
+ </p>
+ </th>
+<th>
+ <p>
+ Enforcement
+ </p>
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <p>
+ storage type can be supplied 0 or 1 times for the <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>.
+ </p>
+ </td>
+<td>
+ <p>
+ The <code class="computeroutput"><span class="identifier">storage</span></code>
+ not be specified more then once per inside of the template
+ parameters for a single <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>.
+ </p>
+ </td>
+<td>
+ <p>
+ Enforced by static assert.
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ Total width of all bitfields in a single <code class="computeroutput"><span class="identifier">bitfield_tuple</span></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.
+ </p>
+ </td>
+<td>
+ <p>
+ This is a limitation on the internal storage that <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code> uses to hold
+ its bitfields.
+ </p>
+ </td>
+<td>
+ <p>
+ Enforced by static assert.
+ </p>
+ </td>
+</tr>
+</tbody>
+</table></div>
<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_storage_.header_file_locaton"></a><h5>
-<a name="id713552"></a>
+<a name="id3070746"></a>
<a class="link" href="_struct_storage_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_storage_.header_file_locaton">Header
file Locaton</a>
</h5>
@@ -66,10 +173,45 @@
<p>
</p>
<a name="boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_storage_.example"></a><h5>
-<a name="id713652"></a>
+<a name="id3070851"></a>
<a class="link" href="_struct_storage_.html#boost_integer_bits_masks_extension.bitfield_tuple.reference._bitfield_tuple__class_reference._struct_storage_.example">Example</a>
</h5>
<p>
+ Specified storage type example.
+</p>
+<pre class="programlisting"><span class="keyword">struct</span> <span class="identifier">red</span><span class="special">;</span>
+<span class="keyword">struct</span> <span class="identifier">green</span><span class="special">;</span>
+<span class="keyword">struct</span> <span class="identifier">blue</span><span class="special">;</span>
+
+<span class="keyword">typedef</span> <span class="identifier">bitfield_tuple</span><span class="special"><</span>
+ <span class="identifier">storage</span><span class="special"><</span><span class="identifier">unsinged</span> <span class="keyword">int</span><span class="special">>,</span>
+ <span class="identifier">member</span><span class="special"><</span><span class="keyword">unsigned</span> <span class="keyword">int</span><span class="special">,</span><span class="identifier">red</span><span class="special">,</span><span class="number">4</span><span class="special">>,</span>
+ <span class="identifier">member</span><span class="special"><</span><span class="keyword">unsigned</span> <span class="keyword">int</span><span class="special">,</span><span class="identifier">green</span><span class="special">,</span><span class="number">4</span><span class="special">>,</span>
+ <span class="identifier">member</span><span class="special"><</span><span class="keyword">unsigned</span> <span class="keyword">int</span><span class="special">,</span><span class="identifier">blue</span><span class="special">,</span><span class="number">4</span><span class="special">></span>
+<span class="special">></span> <span class="identifier">rgb444</span><span class="special">;</span>
+</pre>
+<p>
+ The type <code class="computeroutput"><span class="identifier">rgb444</span></code> shown
+ in the above example has the size of 4. <code class="computeroutput"><span class="identifier">rgb444</span></code>
+ has the same size as the integer type which the storage type specifies.
+ </p>
+<p>
+ non-specified storage type example.
+</p>
+<pre class="programlisting"><span class="keyword">struct</span> <span class="identifier">red</span><span class="special">;</span>
+<span class="keyword">struct</span> <span class="identifier">green</span><span class="special">;</span>
+<span class="keyword">struct</span> <span class="identifier">blue</span><span class="special">;</span>
+
+<span class="keyword">typedef</span> <span class="identifier">bitfield_tuple</span><span class="special"><</span>
+ <span class="identifier">member</span><span class="special"><</span><span class="keyword">unsigned</span> <span class="keyword">int</span><span class="special">,</span><span class="identifier">red</span><span class="special">,</span><span class="number">4</span><span class="special">>,</span>
+ <span class="identifier">member</span><span class="special"><</span><span class="keyword">unsigned</span> <span class="keyword">int</span><span class="special">,</span><span class="identifier">green</span><span class="special">,</span><span class="number">4</span><span class="special">>,</span>
+ <span class="identifier">member</span><span class="special"><</span><span class="keyword">unsigned</span> <span class="keyword">int</span><span class="special">,</span><span class="identifier">blue</span><span class="special">,</span><span class="number">4</span><span class="special">></span>
+<span class="special">></span> <span class="identifier">rgb444_2</span><span class="special">;</span>
+</pre>
+<p>
+ The in this example a storage type is being deduced by the <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>. So the type <code class="computeroutput"><span class="identifier">rgb444_2</span></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.
</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
@@ -82,7 +224,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="_struct_align_.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../_bitfield_tuple__class_reference.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="_struct_pointer_.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="_struct_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="_struct_pointer_.html"><img src="../../../../images/next.png" alt="Next"></a>
</div>
</body>
</html>
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/_bitfield_tuple__macro_reference.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/_bitfield_tuple__macro_reference.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/_bitfield_tuple__macro_reference.html 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -13,7 +13,7 @@
<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/_struct_custom_.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="_bitfield_tuple__macro_reference/parameter_adjustment_macros.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="_bitfield_tuple__class_reference/_struct_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">
@@ -36,7 +36,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="_bitfield_tuple__class_reference/_struct_custom_.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="_bitfield_tuple__macro_reference/parameter_adjustment_macros.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="_bitfield_tuple__class_reference/_struct_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>
Modified: 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
==============================================================================
--- 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 (original)
+++ 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-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -13,7 +13,7 @@
<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="../../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../_bitfield_tuple__macro_reference.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../function_reference.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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">
@@ -21,7 +21,7 @@
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="id714756"></a>
+<a name="id3076605"></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>
<p>
@@ -130,7 +130,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="parameter_adjustment_macros.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../_bitfield_tuple__macro_reference.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../function_reference.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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>
Modified: 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
==============================================================================
--- 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 (original)
+++ 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-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -13,7 +13,7 @@
<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="../../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../_bitfield_tuple__macro_reference.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="code_generation_macros.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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">
@@ -21,7 +21,7 @@
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="id714503"></a>
+<a name="id3076325"></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>
@@ -61,7 +61,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../_bitfield_tuple__macro_reference.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../_bitfield_tuple__macro_reference.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="code_generation_macros.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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>
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/boost_fusion_sequence_extension.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/boost_fusion_sequence_extension.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/boost_fusion_sequence_extension.html 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -13,7 +13,7 @@
<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="../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="files.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="meta_function_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="files.html"><img src="../../../images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
@@ -21,7 +21,7 @@
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="id716002"></a>
+<a name="id3077895"></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>
@@ -118,7 +118,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="meta_function_reference.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="files.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="meta_function_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="files.html"><img src="../../../images/next.png" alt="Next"></a>
</div>
</body>
</html>
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/concepts.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/concepts.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/concepts.html 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -13,7 +13,7 @@
<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="../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="_bitfield_tuple__class_reference.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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>
@@ -28,7 +28,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../reference.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="_bitfield_tuple__class_reference.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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>
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/files.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/files.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/files.html 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -13,7 +13,7 @@
<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="../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../appendices.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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>
@@ -28,7 +28,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="boost_fusion_sequence_extension.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../appendices.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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>
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/function_reference.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/function_reference.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/function_reference.html 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -13,7 +13,7 @@
<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="../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="function_reference/function__make_bitfield_tuple_.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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/function__make_bitfield_tuple_.html"><img src="../../../images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
@@ -33,7 +33,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="_bitfield_tuple__macro_reference/code_generation_macros.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="function_reference/function__make_bitfield_tuple_.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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/function__make_bitfield_tuple_.html"><img src="../../../images/next.png" alt="Next"></a>
</div>
</body>
</html>
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/function_reference/function__make_bitfield_tuple_.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/function_reference/function__make_bitfield_tuple_.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/function_reference/function__make_bitfield_tuple_.html 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -13,7 +13,7 @@
<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="../../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../function_reference.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../meta_function_reference.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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="../meta_function_reference.html"><img src="../../../../images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
@@ -38,7 +38,7 @@
</p>
<div class="note"><table border="0" summary="Note">
<tr>
-<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../..//home/brian/boost/boost-trunk/doc/html/images/note.png"></td>
+<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"><p>
@@ -98,7 +98,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../function_reference.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../function_reference.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../meta_function_reference.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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="../meta_function_reference.html"><img src="../../../../images/next.png" alt="Next"></a>
</div>
</body>
</html>
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/meta_function_reference.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/meta_function_reference.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/meta_function_reference.html 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -13,7 +13,7 @@
<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="function_reference/function__make_bitfield_tuple_.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="boost_fusion_sequence_extension.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="function_reference/function__make_bitfield_tuple_.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="boost_fusion_sequence_extension.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
@@ -29,7 +29,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="function_reference/function__make_bitfield_tuple_.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="boost_fusion_sequence_extension.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="function_reference/function__make_bitfield_tuple_.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="boost_fusion_sequence_extension.html"><img src="../../../images/next.png" alt="Next"></a>
</div>
</body>
</html>
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide.html 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -13,7 +13,7 @@
<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="../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../bitfield_tuple/bitfield_tuple.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="users_guide/getting_started.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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">
@@ -26,8 +26,8 @@
<dd><dl>
<dt><span class="section">Installation</span></dt>
<dt><span class="section">Dependencies</span></dt>
-<dt><span class="section"><a href="users_guide/getting_started/building_with__bitfield_tuple_.html">Building
- With <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code></a></span></dt>
+<dt><span class="section"><a href="users_guide/getting_started/building_with_bitfield_tuple.html">Building
+ With bitfield_tuple</a></span></dt>
<dt><span class="section">Testing</span></dt>
</dl></dd>
<dt><span class="section">Tutorial</span></dt>
@@ -46,7 +46,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="overview/motivation.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../bitfield_tuple/bitfield_tuple.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="users_guide/getting_started.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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>
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/external_resources.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/external_resources.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/external_resources.html 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -13,7 +13,7 @@
<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="../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../users_guide.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="glossary.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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
@@ -29,7 +29,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="tutorial.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../users_guide.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="glossary.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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>
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started.html 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -13,7 +13,7 @@
<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="../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../users_guide.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="getting_started/installation.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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">
@@ -23,8 +23,8 @@
<div class="toc"><dl>
<dt><span class="section">Installation</span></dt>
<dt><span class="section">Dependencies</span></dt>
-<dt><span class="section"><a href="getting_started/building_with__bitfield_tuple_.html">Building
- With <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code></a></span></dt>
+<dt><span class="section"><a href="getting_started/building_with_bitfield_tuple.html">Building
+ With bitfield_tuple</a></span></dt>
<dt><span class="section">Testing</span></dt>
</dl></div>
</div>
@@ -38,7 +38,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../users_guide.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../users_guide.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="getting_started/installation.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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>
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started/dependencies.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started/dependencies.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started/dependencies.html 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -7,13 +7,13 @@
<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">
+<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="../../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../getting_started.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="building_with__bitfield_tuple_.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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">
@@ -33,7 +33,7 @@
</p>
<div class="note"><table border="0" summary="Note">
<tr>
-<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../..//home/brian/boost/boost-trunk/doc/html/images/note.png"></td>
+<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"><p>
@@ -45,14 +45,14 @@
</p></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="id704908"></a>
+<a name="id3056765"></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"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span></code>.
<div class="itemizedlist"><ul class="itemizedlist" type="circle"><li class="listitem">
- Included by boost.integer.bitfield
+ Included by Boost.Integer.Bitfield
<div class="itemizedlist"><ul class="itemizedlist" type="square">
<li class="listitem">
<cassert>
@@ -60,32 +60,78 @@
<li class="listitem">
<limits>
</li>
-<li class="listitem">
- <netinet/in.h> <- Need to do implact analysis and
- remove this header from the includes before final draft.
- </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><h6>
-<a name="id704976"></a>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.users_guide.getting_started.dependencies.boost_library_includes"></a><h5>
+<a name="id3056839"></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="id3056863"></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="id3056901"></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.Preprocessor
- <div class="itemizedlist"><ul class="itemizedlist" type="circle">
+ <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="id3056933"></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/preprocessor/repetition/enum.hpp>
- </li>
+ <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/preprocessor/repetition/repeat_from_to.hpp>
- </li>
+ <boost/mpl/size_t.hpp>
+ </li>
+<li class="listitem">
+ <boost/mpl/void.hpp>
+ </li>
</ul></div>
-</li></ul></div>
<div class="note"><table border="0" summary="Note">
<tr>
-<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../..//home/brian/boost/boost-trunk/doc/html/images/note.png"></td>
+<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"><p>
@@ -97,259 +143,101 @@
regarding Preconditions.
</p></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="id3057083"></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.MPL
- <div class="itemizedlist"><ul class="itemizedlist" type="circle">
-<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>
-</li>
-<li class="listitem">
- boost.Type Traits
- <div class="itemizedlist"><ul class="itemizedlist" type="circle">
-<li class="listitem">
- <boost/type_traits.hpp> <- Need to figure out which parts
- of type_traits are being used and make sure that I only include
- those.
- </li>
-<li class="listitem">
- <boost/type_traits/is_const.hpp>
- </li>
-</ul></div>
-</li>
-<li class="listitem">
- boost.Static Assert
- <div class="itemizedlist"><ul class="itemizedlist" type="circle"><li class="listitem">
- <boost/static_assert.hpp>
- </li></ul></div>
-</li>
-<li class="listitem">
- boost.Enable If
- <div class="itemizedlist"><ul class="itemizedlist" type="circle"><li class="listitem">
- <boost/utility/enable_if.hpp>
- </li></ul></div>
-</li>
-<li class="listitem">
- boost.Fusion
- <div class="itemizedlist"><ul class="itemizedlist" type="circle">
-<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>
+ <boost/type_traits/add_reference.hpp>
+ </li>
<li class="listitem">
- <boost/fusion/iterator/distance.hpp>
- </li>
+ <boost/type_traits/is_const.hpp>
+ </li>
<li class="listitem">
- <boost/fusion/iterator/key_of.hpp>
- </li>
+ <boost/type_traits/make_unsigned.hpp>
+ </li>
<li class="listitem">
- <boost/fusion/iterator/value_of_data.hpp>
- </li>
+ <boost/type_traits/is_same.hpp>
+ </li>
<li class="listitem">
- <boost/fusion/iterator/deref_data.hpp>
- </li>
-</ul></div>
-</li>
+ <boost/type_traits/is_pod.hpp>
+ </li>
</ul></div>
-<a name="boost_integer_bits_masks_extension.bitfield_tuple.users_guide.getting_started.dependencies.bitfield_tuple_specific_headers"></a><h5>
-<a name="id705241"></a>
- <a class="link" href="dependencies.html#boost_integer_bits_masks_extension.bitfield_tuple.users_guide.getting_started.dependencies.bitfield_tuple_specific_headers">Bitfield
- Tuple Specific Headers</a>
- </h5>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.users_guide.getting_started.dependencies.boost_static_assert"></a><h6>
+<a name="id3057137"></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="id3057168"></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="id3057200"></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/integer/details/bft/template_expansion_macros.hpp>
- <div class="itemizedlist"><ul class="itemizedlist" type="circle"><li class="listitem">
- Includes macros for tempate parameter generation and defining macros
- which can be used for specilization over a bitfield_tuple type.
- </li></ul></div>
-</li>
-<li class="listitem">
- <boost/integer/details/bitfield_tuple_impl.hpp>
- <div class="itemizedlist"><ul class="itemizedlist" type="circle"><li class="listitem">
- Base class for a <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>
- that is responsible for enforcing some of the preconditions related
- to the <code class="computeroutput"><span class="identifier">bitfield_tuples</span></code>
- template parameters.
- </li></ul></div>
-</li>
-<li class="listitem">
- <boost/integer/details/bft/bft_element.hpp>
- <div class="itemizedlist"><ul class="itemizedlist" type="circle"><li class="listitem">
- Element used for storing information about the <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>'s
- bitfields.
- </li></ul></div>
-</li>
-<li class="listitem">
- <boost/integer/details/bft/arg_parse_impl.hpp>
- <div class="itemizedlist"><ul class="itemizedlist" type="circle"><li class="listitem">
- A structure and its specializations which are responsible for the
- paring of template parameters into <code class="computeroutput"><span class="identifier">bitfield_element</span></code>s
- which are then stored in an mpl sequence.
- </li></ul></div>
-</li>
-<li class="listitem">
- <boost/integer/details/bft/deduce_storage.hpp>
- <div class="itemizedlist"><ul class="itemizedlist" type="circle"><li class="listitem">
- Functionality for deducing the storage type for a bitfield tuple
- if one isn't supplied.
- </li></ul></div>
-</li>
-<li class="listitem">
- <boost/integer/details/bft/name_lookup.hpp>
- <div class="itemizedlist"><ul class="itemizedlist" type="circle"><li class="listitem">
- predicate used with <code class="computeroutput"><span class="identifier">mpl</span><span class="special">::</span><span class="identifier">find_if</span></code>
- for locating items within the mpl sequence with the name tag specified
- by the user.
- </li></ul></div>
-</li>
-<li class="listitem">
- <boost/integer/details/bft/reference_builder.hpp>
- <div class="itemizedlist"><ul class="itemizedlist" type="circle"><li class="listitem">
- used to aid with the construction of the <code class="computeroutput"><span class="identifier">bitfield_reference</span></code>
- template of a bitfield, from a <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>.
- </li></ul></div>
-</li>
-<li class="listitem">
- <boost/integer/bitfield_tuple_fwd.hpp>
- <div class="itemizedlist"><ul class="itemizedlist" type="circle"><li class="listitem">
- forward declaration of the <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>.
- </li></ul></div>
-</li>
+ <boost/fusion/sequence/intrinsic.hpp>
+ </li>
<li class="listitem">
- <boost/integer/details/fusion_ext_includes.hpp>
- <div class="itemizedlist"><ul class="itemizedlist" type="circle"><li class="listitem">
- Includes all of the headers necessary for creating the boost.fusion
- extension of the <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>.
- </li></ul></div>
-</li>
+ <boost/fusion/support/is_sequence.hpp>
+ </li>
<li class="listitem">
- <boost/integer/details/bft/ext/bitfield_tuple_fusion_includes.hpp>
- <div class="itemizedlist"><ul class="itemizedlist" type="circle"><li class="listitem">
- Include all header files from the related to the bitfield tuple
- which compose the fusion extension interface of a <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>.
- </li></ul></div>
-</li>
+ <boost/fusion/support/is_view.hpp>
+ </li>
<li class="listitem">
- <boost/integer/details/bft/make_bitfield_tuple.hpp>
- <div class="itemizedlist"><ul class="itemizedlist" type="circle"><li class="listitem">
- contains macros and functions used for creating the <code class="computeroutput"><span class="identifier">make_bitfield_tuple</span></code> funciton
- template.
- </li></ul></div>
-</li>
-</ul></div>
-<a name="boost_integer_bits_masks_extension.bitfield_tuple.users_guide.getting_started.dependencies.bitfield_tuple_fusion_extension"></a><h6>
-<a name="id705497"></a>
- <a class="link" href="dependencies.html#boost_integer_bits_masks_extension.bitfield_tuple.users_guide.getting_started.dependencies.bitfield_tuple_fusion_extension">Bitfield
- Tuple Fusion Extension</a>
- </h6>
-<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
- header files which compose the boost.Fusion interface extension of
- a <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>.
- <div class="itemizedlist"><ul class="itemizedlist" type="circle">
+ <boost/fusion/support/tag_of_fwd.hpp>
+ </li>
<li class="listitem">
- <boost/integer/bft/ext/tag_of.hpp>
- </li>
+ <boost/fusion/iterator/iterator_facade.hpp>
+ </li>
<li class="listitem">
- <boost/integer/bft/ext/bitfield_iterator.hpp>
- </li>
+ <boost/fusion/iterator/value_of.hpp>
+ </li>
<li class="listitem">
- <boost/integer/bft/ext/fusion/is_sequence_impl.hpp>
- </li>
+ <boost/fusion/iterator/deref.hpp>
+ </li>
<li class="listitem">
- <boost/integer/bft/ext/fusion/is_view_impl.hpp>
- </li>
+ <boost/fusion/iterator/next.hpp>
+ </li>
<li class="listitem">
- <boost/integer/bft/ext/fusion/category_of_impl.hpp>
- </li>
+ <boost/fusion/iterator/prior.hpp>
+ </li>
<li class="listitem">
- <boost/integer/bft/ext/fusion/at_impl.hpp>
- </li>
+ <boost/fusion/iterator/distance.hpp>
+ </li>
<li class="listitem">
- <boost/integer/bft/ext/fusion/begin_impl.hpp>
- </li>
+ <boost/fusion/iterator/key_of.hpp>
+ </li>
<li class="listitem">
- <boost/integer/bft/ext/fusion/size_impl.hpp>
- </li>
+ <boost/fusion/iterator/value_of_data.hpp>
+ </li>
<li class="listitem">
- <boost/integer/bft/ext/fusion/end_impl.hpp>
- </li>
+ <boost/fusion/iterator/deref_data.hpp>
+ </li>
</ul></div>
-</li></ul></div>
<a name="boost_integer_bits_masks_extension.bitfield_tuple.users_guide.getting_started.dependencies.boost_vault_includes"></a><h6>
-<a name="id705576"></a>
+<a name="id3057300"></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>
- <div class="itemizedlist"><ul class="itemizedlist" type="circle"><li class="listitem">
- Does the storage and retrieval of data to and from the bitfield_tuples
- internal storage.
- </li></ul></div>
-</li></ul></div>
-<a name="boost_integer_bits_masks_extension.bitfield_tuple.users_guide.getting_started.dependencies.boost_integer_bit_mask_includes"></a><h6>
-<a name="id705612"></a>
- <a class="link" href="dependencies.html#boost_integer_bits_masks_extension.bitfield_tuple.users_guide.getting_started.dependencies.boost_integer_bit_mask_includes">Boost.integer
- Bit Mask Includes</a>
+ </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="id3057330"></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">
@@ -358,7 +246,26 @@
<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="id3057385"></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>
+<p>
+ Please see the Files section for a full list and description of all files
+ which are part of the <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>
+ and its interface.
+ </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
@@ -370,7 +277,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="installation.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../getting_started.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="building_with__bitfield_tuple_.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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>
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started/installation.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started/installation.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started/installation.html 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -13,16 +13,14 @@
<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="../../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../getting_started.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="dependencies.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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>
<p>
- There is no need to install or link against bitfield_tuple. It is a header
- only component. For additional dependencies of bitfield_tuple please
- see the Dependencies section of the documentation.
+ Coming Soon.
</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
@@ -35,7 +33,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../getting_started.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../getting_started.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="dependencies.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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>
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started/testing.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started/testing.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started/testing.html 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -6,25 +6,58 @@
<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="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="../../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../getting_started.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../tutorial.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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>
<p>
- Currently only tested on GCC 4.4.
- </p>
-<p>
- TODO: Test on more compilers and add the information here.
+ List of compilers which the library has been tested on.
</p>
+<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>
@@ -36,7 +69,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="building_with__bitfield_tuple_.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../getting_started.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../tutorial.html"><img src="../../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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>
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/glossary.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/glossary.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/glossary.html 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -13,7 +13,7 @@
<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="../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../users_guide.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../reference.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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">
@@ -51,6 +51,19 @@
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>
@@ -63,7 +76,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="external_resources.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../users_guide.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../reference.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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>
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/tutorial.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/tutorial.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/tutorial.html 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -13,7 +13,7 @@
<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="../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../users_guide.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="external_resources.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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">
@@ -25,7 +25,7 @@
and all of the different functionalities it provides.
</p>
<a name="boost_integer_bits_masks_extension.bitfield_tuple.users_guide.tutorial.part_1__the_basics"></a><h6>
-<a name="id705720"></a>
+<a name="id3057559"></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>
@@ -81,7 +81,7 @@
a width of 2 bits.
</p>
<a name="boost_integer_bits_masks_extension.bitfield_tuple.users_guide.tutorial.part_2__using_the_tuple"></a><h5>
-<a name="id706406"></a>
+<a name="id3058236"></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>
@@ -99,7 +99,7 @@
</p>
<div class="note"><table border="0" summary="Note">
<tr>
-<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../..//home/brian/boost/boost-trunk/doc/html/images/note.png"></td>
+<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"><p>
@@ -121,7 +121,6 @@
<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">integer</span><span class="special">/</span><span class="identifier">bitfield_tuple</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">iostream</span><span class="special">></span>
-<span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">;</span>
<span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">bitfields</span><span class="special">;</span>
<span class="comment">// names used to mimic the names in struct foo.
@@ -150,7 +149,7 @@
<p>
</p>
<a name="boost_integer_bits_masks_extension.bitfield_tuple.users_guide.tutorial.part_3__slightly_more_advanced"></a><h6>
-<a name="id707184"></a>
+<a name="id3058953"></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>
@@ -162,7 +161,7 @@
</p>
<p>
The different templates that can be used within a <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>'s
- template decalaration.
+ template declaration.
</p>
<div class="informaltable"><table class="table">
<colgroup>
@@ -185,19 +184,19 @@
<tr>
<td>
<p>
- <code class="computeroutput"><span class="identifier">filler</span><span class="special"><</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">></span></code>
+ <code class="computeroutput"><span class="identifier">padding</span><span class="special"><</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">></span></code>
</p>
</td>
<td>
<p>
- Padding in bits that can be used to seperate bitfield.
+ Padding in bits that can be used to separate bitfield.
</p>
</td>
</tr>
<tr>
<td>
<p>
- <code class="computeroutput"><span class="identifier">bit_align</span><span class="special"><</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">></span></code>
+ <code class="computeroutput"><span class="identifier">align</span><span class="special"><</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">></span></code>
</p>
</td>
<td>
@@ -250,11 +249,37 @@
</p>
</td>
</tr>
+<tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">pointer</span><span class="special"><</span><span class="keyword">typename</span><span class="special">,</span><span class="keyword">typename</span><span class="special">,</span><span class="keyword">typename</span><span class="special">></span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ This allows for a pointer to have bits stuffed into it and have
+ both extracted separately but stored together.
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">custom</span><span class="special"><</span><span class="keyword">typename</span><span class="special">,</span><span class="keyword">typename</span><span class="special">,</span><span class="keyword">typename</span><span class="special">,</span><span class="keyword">typename</span><span class="special">></span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ This type allows for custom packing and unpacking of the the
+ data before it is stored within the bitfield_tuple.
+ </p>
+ </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="../../..//home/brian/boost/boost-trunk/doc/html/images/tip.png"></td>
+<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"><p>
@@ -264,21 +289,181 @@
</p></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="id707575"></a>
+<a name="id3059497"></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>
<p>
The <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code> is a
boost.fusion sequence. It supports the all of the functionality that is
- supported by a random access container and an associtve sequence. The
+ supported by a random access container and an associative sequence. The
<code class="computeroutput"><span class="identifier">bitfield_tuple</span></code> internally
stores its fields as an associative array. This allows the <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code> to provide both index
based as well as named <code class="computeroutput"><span class="identifier">get</span></code>
- functions. For full documentataion of how to use boost.fusion see the boost.fusion
- documentation. For the boost.fusion features supported by the <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code> see the fusion extension
+ 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"><span class="identifier">bitfield_tuple</span></code> see the fusion extension
documentation located in the reference section of the documentation.
</p>
+<p>
+
+</p>
+<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">integer</span><span class="special">/</span><span class="identifier">bitfield_tuple</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
+<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">iostream</span><span class="special">></span>
+<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">fusion</span><span class="special">/</span><span class="identifier">include</span><span class="special">/</span><span class="identifier">for_each</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
+
+<span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">bitfields</span><span class="special">;</span>
+
+<span class="keyword">struct</span> <span class="identifier">red</span><span class="special">;</span>
+<span class="keyword">struct</span> <span class="identifier">green</span><span class="special">;</span>
+<span class="keyword">struct</span> <span class="identifier">pink</span><span class="special">;</span>
+<span class="keyword">struct</span> <span class="identifier">blue</span><span class="special">;</span>
+<span class="keyword">struct</span> <span class="identifier">salmon</span><span class="special">;</span>
+
+<span class="keyword">typedef</span> <span class="identifier">bitfield_tuple</span><span class="special"><</span>
+ <span class="identifier">member</span><span class="special"><</span><span class="keyword">char</span><span class="special">,</span><span class="identifier">red</span><span class="special">,</span><span class="number">4</span><span class="special">>,</span>
+ <span class="identifier">member</span><span class="special"><</span><span class="keyword">unsigned</span> <span class="keyword">char</span><span class="special">,</span> <span class="identifier">green</span><span class="special">,</span><span class="number">5</span><span class="special">>,</span>
+ <span class="identifier">member</span><span class="special"><</span><span class="keyword">int</span><span class="special">,</span> <span class="identifier">salmon</span><span class="special">,</span> <span class="number">16</span><span class="special">>,</span>
+ <span class="identifier">storage</span><span class="special"><</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">></span>
+<span class="special">></span> <span class="identifier">fusion_example_tuple</span><span class="special">;</span>
+
+<span class="keyword">struct</span> <span class="identifier">unary_function_object</span><span class="special">{</span>
+ <span class="keyword">template</span> <span class="special"><</span><span class="keyword">typename</span> <span class="identifier">T</span><span class="special">></span>
+ <span class="keyword">void</span> <span class="keyword">operator</span><span class="special">()</span> <span class="special">(</span><span class="identifier">T</span> <span class="identifier">x</span><span class="special">)</span> <span class="special">{</span>
+ <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special"><<</span> <span class="identifier">x</span> <span class="special"><<</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
+ <span class="special">}</span>
+<span class="special">};</span>
+
+<span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span> <span class="special">{</span>
+
+ <span class="identifier">fusion_example_tuple</span> <span class="identifier">bft</span><span class="special">;</span>
+ <span class="identifier">bft</span><span class="special">.</span><span class="identifier">get</span><span class="special"><</span><span class="number">0</span><span class="special">>()</span> <span class="special">=</span> <span class="number">1</span><span class="special">;</span>
+ <span class="identifier">bft</span><span class="special">.</span><span class="identifier">get</span><span class="special"><</span><span class="number">1</span><span class="special">>()</span> <span class="special">=</span> <span class="number">2</span><span class="special">;</span>
+ <span class="identifier">bft</span><span class="special">.</span><span class="identifier">get</span><span class="special"><</span><span class="number">2</span><span class="special">>()</span> <span class="special">=</span> <span class="number">3</span><span class="special">;</span>
+
+ <span class="identifier">boost</span><span class="special">::</span><span class="identifier">fusion</span><span class="special">::</span><span class="identifier">for_each</span><span class="special">(</span><span class="identifier">bft</span><span class="special">,</span><span class="identifier">unary_function_object</span><span class="special">());</span>
+ <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span>
+<span class="special">}</span>
+</pre>
+<p>
+ 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.
+ </p>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.users_guide.tutorial.part_5__pointer_stuffing"></a><h6>
+<a name="id3060401"></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>
+<p>
+ <code class="computeroutput"><span class="identifier">bitfield_tuple</span></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"><span class="identifier">pointer</span></code>
+ member of <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>
+ please refer to the documentation for <code class="computeroutput"><span class="identifier">pointer</span></code>.
+ The following is a basic example for pointers which point to DWORD aligned
+ sections of memory.
+ </p>
+<p>
+
+</p>
+<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">integer</span><span class="special">/</span><span class="identifier">bitfield_tuple</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
+<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">assert</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
+<span class="keyword">struct</span> <span class="identifier">color</span><span class="special">;</span>
+<span class="keyword">struct</span> <span class="identifier">ptr</span><span class="special">;</span>
+
+<span class="keyword">typedef</span> <span class="identifier">bitfield_tuple</span><span class="special"><</span>
+ <span class="identifier">pointer</span><span class="special"><</span><span class="keyword">int</span><span class="special">,</span> <span class="identifier">ptr</span><span class="special">>,</span>
+ <span class="identifier">member</span><span class="special"><</span><span class="keyword">unsigned</span> <span class="keyword">int</span><span class="special">,</span><span class="identifier">color</span><span class="special">,</span><span class="number">2</span><span class="special">></span>
+<span class="special">></span> <span class="identifier">color_stuffed_ptr_tuple</span><span class="special">;</span>
+
+<span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">bitfields</span><span class="special">;</span>
+
+<span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span> <span class="special">{</span>
+ <span class="keyword">int</span><span class="special">*</span> <span class="identifier">some_ptr</span> <span class="special">=</span> <span class="keyword">new</span> <span class="keyword">int</span><span class="special">();</span>
+ <span class="identifier">color_stuffed_ptr_tuple</span> <span class="identifier">colored_ptr</span><span class="special">;</span>
+ <span class="identifier">colored_ptr</span><span class="special">.</span><span class="identifier">get</span><span class="special"><</span><span class="identifier">ptr</span><span class="special">>()</span> <span class="special">=</span> <span class="identifier">some_ptr</span><span class="special">;</span>
+ <span class="identifier">colored_ptr</span><span class="special">.</span><span class="identifier">get</span><span class="special"><</span><span class="identifier">color</span><span class="special">>()</span> <span class="special">=</span> <span class="number">3</span><span class="special">;</span>
+
+ <span class="comment">// set the value of the thing being pointed at to 3.
+</span> <span class="special">*</span><span class="identifier">colored_ptr</span><span class="special">.</span><span class="identifier">get</span><span class="special"><</span><span class="identifier">ptr</span><span class="special">>()</span> <span class="special">=</span> <span class="number">3</span><span class="special">;</span>
+
+ <span class="comment">// make sure that the color is correctly set.
+</span> <span class="identifier">BOOST_ASSERT</span><span class="special">((</span> <span class="identifier">colored_ptr</span><span class="special">.</span><span class="identifier">get</span><span class="special"><</span><span class="identifier">color</span><span class="special">>()</span> <span class="special">==</span> <span class="number">3</span> <span class="special">));</span>
+
+ <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span>
+<span class="special">}</span>
+
+</pre>
+<p>
+ 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"><span class="identifier">pointer</span></code>
+ member.
+ </p>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.users_guide.tutorial.part_5__custom_integral_stuffing"></a><h6>
+<a name="id3061055"></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>
+<p>
+ The <code class="computeroutput"><span class="identifier">custom</span></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"><span class="identifier">bitfield_tuple</span></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"><span class="identifier">custom</span></code> member such
+ that it is used to store an always even number.
+ </p>
+<p>
+
+</p>
+<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">integer</span><span class="special">/</span><span class="identifier">bitfield_tuple</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
+
+<span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">bitfields</span><span class="special">;</span>
+<span class="keyword">struct</span> <span class="identifier">always_even_int</span><span class="special">;</span>
+<span class="keyword">struct</span> <span class="identifier">extra_bool</span><span class="special">;</span>
+<span class="keyword">typedef</span> <span class="identifier">bitfield_tuple</span><span class="special"><</span>
+ <span class="identifier">custom</span><span class="special"><</span>
+ <span class="keyword">unsigned</span> <span class="keyword">int</span><span class="special">,</span>
+ <span class="identifier">always_even_int</span><span class="special">,</span>
+ <span class="identifier">boost</span><span class="special">::</span><span class="identifier">high_bits_mask</span><span class="special"><</span>
+ <span class="keyword">unsigned</span> <span class="keyword">int</span><span class="special">,</span>
+ <span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">bit_width</span><span class="special"><</span><span class="keyword">unsigned</span> <span class="keyword">int</span><span class="special">>::</span><span class="identifier">value</span> <span class="special">-</span> <span class="number">1</span><span class="special">)</span>
+ <span class="special">></span>
+ <span class="special">>,</span>
+ <span class="identifier">flag</span><span class="special"><</span><span class="identifier">extra_bool</span><span class="special">></span>
+<span class="special">></span> <span class="identifier">custom_stuffing</span><span class="special">;</span>
+
+<span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span> <span class="special">{</span>
+ <span class="identifier">custom_stuffing</span> <span class="identifier">cs</span><span class="special">;</span>
+ <span class="identifier">cs</span><span class="special">.</span><span class="identifier">get</span><span class="special"><</span><span class="identifier">always_even_int</span><span class="special">>()</span> <span class="special">=</span> <span class="number">4</span><span class="special">;</span>
+
+ <span class="identifier">BOOST_ASSERT</span><span class="special">((</span> <span class="identifier">cs</span><span class="special">.</span><span class="identifier">get</span><span class="special"><</span><span class="identifier">always_even_int</span><span class="special">>()</span> <span class="special">==</span> <span class="number">4</span><span class="special">));</span>
+ <span class="identifier">cs</span><span class="special">.</span><span class="identifier">get</span><span class="special"><</span><span class="identifier">extra_bool</span><span class="special">>()</span> <span class="special">=</span> <span class="keyword">true</span><span class="special">;</span>
+
+ <span class="identifier">BOOST_ASSERT</span><span class="special">((</span> <span class="keyword">sizeof</span><span class="special">(</span><span class="identifier">custom_stuffing</span><span class="special">)</span> <span class="special">==</span> <span class="keyword">sizeof</span><span class="special">(</span><span class="keyword">unsigned</span> <span class="keyword">int</span><span class="special">)</span> <span class="special">));</span>
+<span class="special">}</span>
+</pre>
+<p>
+ The <code class="computeroutput"><span class="identifier">high_bits_mask</span></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"><span class="keyword">unsigned</span> <span class="keyword">int</span></code>
+ when the <code class="computeroutput"><span class="identifier">get</span><span class="special"><</span><span class="identifier">alway_even_int</span><span class="special">()</span></code>'s
+ value type assignment operator is called. When the <code class="computeroutput"><span class="keyword">operator</span>
+ <span class="identifier">value_type</span><span class="special">()</span></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"><span class="identifier">flag</span><span class="special"><</span><span class="identifier">extra_bool</span><span class="special">></span></code> was to be first and the <code class="computeroutput"><span class="identifier">custom</span></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.
+ </p>
+<p>
+ There is much more that can be done with the <code class="computeroutput"><span class="identifier">custom</span></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"><span class="identifier">custom</span></code> member.
+ </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
@@ -290,7 +475,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="getting_started/testing.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../users_guide.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="external_resources.html"><img src="../../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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>
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/high_bits_mask/bit_masks/high_bits_maskbits.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/high_bits_mask/bit_masks/high_bits_maskbits.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/high_bits_mask/bit_masks/high_bits_maskbits.html 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -13,14 +13,14 @@
<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="../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_integer_bits_masks_extension/bit_masks.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../../low_bits_mask/bit_masks/low_bits_mask.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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="id699641"></a>
+<a name="id3049729"></a>
<a class="link" href="high_bits_maskbits.html#high_bits_mask.bit_masks.high_bits_maskbits.description">Description</a>
</h4>
<p>
@@ -39,15 +39,20 @@
<p>
</p>
<a name="high_bits_mask.bit_masks.high_bits_maskbits.header_file_information"></a><h4>
-<a name="id699742"></a>
+<a name="id3049842"></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>
<p>
- Header file: <boost/integer/high_bits_mask.hpp> Header file: <boost/integer/high_low_mask.hpp>
+
+</p>
+<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">integer</span><span class="special">/</span><span class="identifier">high_bits_mask</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
+<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">integer</span><span class="special">/</span><span class="identifier">high_low_mask</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
+</pre>
+<p>
</p>
<a name="high_bits_mask.bit_masks.high_bits_maskbits.template_signature"></a><h4>
-<a name="id699764"></a>
+<a name="id3049957"></a>
<a class="link" href="high_bits_maskbits.html#high_bits_mask.bit_masks.high_bits_maskbits.template_signature">Template
Signature</a>
</h4>
@@ -56,19 +61,22 @@
template signature:
</p>
<pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span>
-<span class="keyword">template</span> <span class="special"><</span><span class="keyword">typename</span> <span class="identifier">T</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">int</span> <span class="identifier">Width</span><span class="special">></span>
-<span class="keyword">struct</span> <span class="identifier">high_bits_mask</span><span class="special">;</span>
+<span class="keyword">template</span> <span class="special"><</span><span class="keyword">typename</span> <span class="identifier">T</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">int</span> <span class="identifier">Width</span><span class="special">></span> <span class="keyword">struct</span> <span class="identifier">high_bits_mask</span><span class="special">;</span>
<span class="special">}</span>
</pre>
<p>
</p>
<a name="high_bits_mask.bit_masks.high_bits_maskbits.bit_mask_hierarchy"></a><h4>
-<a name="id699876"></a>
+<a name="id3050073"></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>
+<p>
+ <code class="computeroutput"><span class="identifier">high_bits_mask</span></code> inherits from
+ <code class="computeroutput"><span class="identifier">integral_mask</span></code>.
+ </p>
<a name="high_bits_mask.bit_masks.high_bits_maskbits.template_parameters"></a><h4>
-<a name="id699893"></a>
+<a name="id3050114"></a>
<a class="link" href="high_bits_maskbits.html#high_bits_mask.bit_masks.high_bits_maskbits.template_parameters">Template
Parameters</a>
</h4>
@@ -117,7 +125,7 @@
</tbody>
</table></div>
<a name="high_bits_mask.bit_masks.high_bits_maskbits.interface"></a><h4>
-<a name="id699991"></a>
+<a name="id3050220"></a>
<a class="link" href="high_bits_maskbits.html#high_bits_mask.bit_masks.high_bits_maskbits.interface">Interface</a>
</h4>
<p>
@@ -227,8 +235,74 @@
</tr>
</tbody>
</table></div>
+<a name="high_bits_mask.bit_masks.high_bits_maskbits.preconditions"></a><h4>
+<a name="id3050621"></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>
+ <p>
+ Precondition
+ </p>
+ </th>
+<th>
+ <p>
+ Description
+ </p>
+ </th>
+<th>
+ <p>
+ Enforcement
+ </p>
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">bit_width</span><span class="special"><</span><span class="identifier">T</span><span class="special">>::</span><span class="identifier">value</span> <span class="special">>=</span>
+ <span class="identifier">Width</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ The <code class="computeroutput"><span class="identifier">Width</span></code> must
+ not be greater then the size in bits of type <code class="computeroutput"><span class="identifier">T</span></code>.
+ </p>
+ </td>
+<td>
+ <p>
+ Enforced by static assert.
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ </p>
+ </td>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">T</span></code> must be an integral
+ type.
+ </p>
+ </td>
+<td>
+ <p>
+ This is only a documented precondition. It is not enforced.
+ </p>
+ </td>
+</tr>
+</tbody>
+</table></div>
<a name="high_bits_mask.bit_masks.high_bits_maskbits.examples"></a><h4>
-<a name="id700366"></a>
+<a name="id3050794"></a>
<a class="link" href="high_bits_maskbits.html#high_bits_mask.bit_masks.high_bits_maskbits.examples">Examples</a>
</h4>
<p>
@@ -272,7 +346,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../../integral_mask/bit_masks/integral_mask.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_integer_bits_masks_extension/bit_masks.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../../low_bits_mask/bit_masks/low_bits_mask.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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>
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/index.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/index.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/index.html 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -10,7 +10,7 @@
<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="/home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a></div>
+<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>
@@ -21,7 +21,7 @@
</h3></div></div></div>
<div><p class="copyright">Copyright © 2010 Brian Bartman</p></div>
<div><div class="legalnotice">
-<a name="id688691"></a><p>
+<a name="id3038321"></a><p>
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)
</p>
@@ -46,6 +46,7 @@
<dt><span class="section"> high_bits_mask</span></dt>
<dt><span class="section"> low_bits_mask</span></dt>
<dt><span class="section"> bits_mask</span></dt>
+<dt><span class="section"> bit_width</span></dt>
</dl></dd>
<dt><span class="section">bitfield_tuple</span></dt>
<dd><dl>
@@ -62,8 +63,8 @@
<dd><dl>
<dt><span class="section">Installation</span></dt>
<dt><span class="section">Dependencies</span></dt>
-<dt><span class="section"><a href="boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started/building_with__bitfield_tuple_.html">Building
- With <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code></a></span></dt>
+<dt><span class="section"><a href="boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started/building_with_bitfield_tuple.html">Building
+ With bitfield_tuple</a></span></dt>
<dt><span class="section">Testing</span></dt>
</dl></dd>
<dt><span class="section">Tutorial</span></dt>
@@ -121,10 +122,10 @@
</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left"><p><small>Last revised: August 19, 2010 at 19:58:02 GMT</small></p></td>
+<td align="left"><p><small>Last revised: August 21, 2010 at 20:10:54 GMT</small></p></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="/home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a></div>
+<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>
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/integral_mask/bit_masks/integral_mask.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/integral_mask/bit_masks/integral_mask.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/integral_mask/bit_masks/integral_mask.html 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -13,7 +13,7 @@
<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="../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_integer_bits_masks_extension/bit_masks.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../../high_bits_mask/bit_masks/high_bits_maskbits.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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">
@@ -21,7 +21,7 @@
</a>
</h3></div></div></div>
<a name="integral_mask.bit_masks.integral_mask.description"></a><h4>
-<a name="id698571"></a>
+<a name="id3048506"></a>
<a class="link" href="integral_mask.html#integral_mask.bit_masks.integral_mask.description">Description</a>
</h4>
<p>
@@ -31,15 +31,19 @@
type from the Boost.Type Traits library.
</p>
<a name="integral_mask.bit_masks.integral_mask.header_file_information"></a><h4>
-<a name="id698610"></a>
+<a name="id3048550"></a>
<a class="link" href="integral_mask.html#integral_mask.bit_masks.integral_mask.header_file_information">Header
File Information</a>
</h4>
<p>
- Header file: <boost/integer/integral_mask.hpp>
+
+</p>
+<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">integer</span><span class="special">/</span><span class="identifier">integral_mask</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
+</pre>
+<p>
</p>
<a name="integral_mask.bit_masks.integral_mask.template_signature"></a><h4>
-<a name="id698632"></a>
+<a name="id3048621"></a>
<a class="link" href="integral_mask.html#integral_mask.bit_masks.integral_mask.template_signature">Template
Signature</a>
</h4>
@@ -54,7 +58,7 @@
<p>
</p>
<a name="integral_mask.bit_masks.integral_mask.bit_mask_hierarchy"></a><h4>
-<a name="id698742"></a>
+<a name="id3048736"></a>
<a class="link" href="integral_mask.html#integral_mask.bit_masks.integral_mask.bit_mask_hierarchy">Bit
Mask Hierarchy</a>
</h4>
@@ -64,7 +68,7 @@
from <code class="computeroutput"><span class="identifier">integral_constant</span></code>.
</p>
<a name="integral_mask.bit_masks.integral_mask.template_parameters"></a><h4>
-<a name="id698780"></a>
+<a name="id3048778"></a>
<a class="link" href="integral_mask.html#integral_mask.bit_masks.integral_mask.template_parameters">Template
Parameters</a>
</h4>
@@ -113,7 +117,7 @@
</tbody>
</table></div>
<a name="integral_mask.bit_masks.integral_mask.preconditions"></a><h4>
-<a name="id698881"></a>
+<a name="id3048886"></a>
<a class="link" href="integral_mask.html#integral_mask.bit_masks.integral_mask.preconditions">Preconditions</a>
</h4>
<div class="informaltable"><table class="table">
@@ -147,7 +151,8 @@
</td>
<td>
<p>
- T must be an integral type.
+ <code class="computeroutput"><span class="identifier">T</span></code> must be an integral
+ type.
</p>
</td>
<td>
@@ -163,7 +168,8 @@
</td>
<td>
<p>
- Value must be in the domain of the integral type T.
+ <code class="computeroutput"><span class="identifier">Value</span></code> must be in
+ the domain of the integral type <code class="computeroutput"><span class="identifier">T</span></code>.
</p>
</td>
<td>
@@ -175,7 +181,7 @@
</tbody>
</table></div>
<a name="integral_mask.bit_masks.integral_mask.interface"></a><h4>
-<a name="id698982"></a>
+<a name="id3049024"></a>
<a class="link" href="integral_mask.html#integral_mask.bit_masks.integral_mask.interface">Interface</a>
</h4>
<p>
@@ -292,7 +298,7 @@
</tbody>
</table></div>
<a name="integral_mask.bit_masks.integral_mask.examples"></a><h4>
-<a name="id699421"></a>
+<a name="id3049494"></a>
<a class="link" href="integral_mask.html#integral_mask.bit_masks.integral_mask.examples">Examples</a>
</h4>
<p>
@@ -337,7 +343,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../../Rationale/bit_masks/overview/rationale.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_integer_bits_masks_extension/bit_masks.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../../high_bits_mask/bit_masks/high_bits_maskbits.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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>
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/low_bits_mask/bit_masks/low_bits_mask.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/low_bits_mask/bit_masks/low_bits_mask.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/low_bits_mask/bit_masks/low_bits_mask.html 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -13,23 +13,20 @@
<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="../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_integer_bits_masks_extension/bit_masks.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../../bits_mask/bit_masks/bits_mask.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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="id700577"></a>
+<a name="id3051023"></a>
<a class="link" href="low_bits_mask.html#low_bits_mask.bit_masks.low_bits_mask.description">Description</a>
</h4>
<p>
- <code class="computeroutput"><span class="identifier">low_bits_mask</span></code> creates a mask
- of bits starting from the right most bit and extending out to the left. The
- <code class="computeroutput"><span class="identifier">low_bits_mask</span></code> is similar
- to the <code class="computeroutput"><span class="identifier">high_bits_mask</span></code> just
- starts on the right most bit instead of the left most bit. The way <code class="computeroutput"><span class="identifier">low_bits_mask</span></code> behaves in the following
- example:
+ <code class="computeroutput"><span class="identifier">low_bits_mask</span></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"><span class="identifier">low_bits_mask</span></code> works:
</p>
<p>
@@ -39,11 +36,22 @@
</span><span class="comment">// 0000 0000 0000 0000 0000 0011 1111 1111
</span></pre>
<p>
- The <code class="computeroutput"><span class="identifier">low_bits_mask</span></code> template
- is located in the <boost/integer/low_bits_mask.hpp> header file.
+ </p>
+<a name="low_bits_mask.bit_masks.low_bits_mask.header_file_information"></a><h4>
+<a name="id3051125"></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>
+<p>
+
+</p>
+<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">integer</span><span class="special">/</span><span class="identifier">low_bits_mask</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
+<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">integer</span><span class="special">/</span><span class="identifier">high_low_mask</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
+</pre>
+<p>
</p>
<a name="low_bits_mask.bit_masks.low_bits_mask.template_signature"></a><h4>
-<a name="id700698"></a>
+<a name="id3051240"></a>
<a class="link" href="low_bits_mask.html#low_bits_mask.bit_masks.low_bits_mask.template_signature">Template
Signature</a>
</h4>
@@ -51,11 +59,26 @@
<code class="computeroutput"><span class="identifier">low_bits_mask</span></code> has the following
template signature:
</p>
-<pre class="programlisting"><span class="keyword">template</span> <span class="special"><</span><span class="keyword">typename</span> <span class="identifier">T</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">int</span> <span class="identifier">Width</span><span class="special">></span>
-<span class="keyword">struct</span> <span class="identifier">low_bits_mask</span><span class="special">;</span>
+<pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span>
+<span class="keyword">template</span> <span class="special"><</span><span class="keyword">typename</span> <span class="identifier">T</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">int</span> <span class="identifier">Width</span><span class="special">></span> <span class="keyword">struct</span> <span class="identifier">low_bits_mask</span><span class="special">;</span>
+<span class="special">}</span>
</pre>
<p>
</p>
+<a name="low_bits_mask.bit_masks.low_bits_mask.bit_mask_hierarchy"></a><h4>
+<a name="id3051356"></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>
+<p>
+ <code class="computeroutput"><span class="identifier">low_bits_mask</span></code> inherits from
+ <code class="computeroutput"><span class="identifier">integral_mask</span></code>.
+ </p>
+<a name="low_bits_mask.bit_masks.low_bits_mask.template_parameters"></a><h4>
+<a name="id3051396"></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>
@@ -101,7 +124,7 @@
</tbody>
</table></div>
<a name="low_bits_mask.bit_masks.low_bits_mask.interface"></a><h4>
-<a name="id700870"></a>
+<a name="id3051503"></a>
<a class="link" href="low_bits_mask.html#low_bits_mask.bit_masks.low_bits_mask.interface">Interface</a>
</h4>
<p>
@@ -183,21 +206,100 @@
<tr>
<td>
<p>
+ <code class="computeroutput"><span class="identifier">N</span><span class="special">::</span><span class="identifier">offset</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ Returns 0 for this mask because the <code class="computeroutput"><span class="identifier">low_bits_mask</span></code>
+ is not shifted in any direction and always starts at the least
+ significant bit.
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
<code class="computeroutput"><span class="keyword">operator</span> <span class="identifier">T</span><span class="special">()</span></code>
</p>
</td>
<td>
<p>
Run time support function. All this function does is return the
- value associated with the type. With the c++0x feature <code class="computeroutput"><span class="identifier">constexper</span></code> this function will
- be made fasters and more effieient.
+ value associated with the type.
+ </p>
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="low_bits_mask.bit_masks.low_bits_mask.preconditions"></a><h4>
+<a name="id3051882"></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>
+ <p>
+ Precondition
+ </p>
+ </th>
+<th>
+ <p>
+ Description
+ </p>
+ </th>
+<th>
+ <p>
+ Enforcement
+ </p>
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">bit_width</span><span class="special"><</span><span class="identifier">T</span><span class="special">>::</span><span class="identifier">value</span> <span class="special">>=</span>
+ <span class="identifier">Width</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ The <code class="computeroutput"><span class="identifier">Width</span></code> must
+ not be greater then the size in bits of type <code class="computeroutput"><span class="identifier">T</span></code>.
+ </p>
+ </td>
+<td>
+ <p>
+ Enforced by static assert.
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ </p>
+ </td>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">T</span></code> must be an integral
+ type.
+ </p>
+ </td>
+<td>
+ <p>
+ This is only a documented precondition. It is not enforced.
</p>
</td>
</tr>
</tbody>
</table></div>
<a name="low_bits_mask.bit_masks.low_bits_mask.examples"></a><h4>
-<a name="id701192"></a>
+<a name="id3052055"></a>
<a class="link" href="low_bits_mask.html#low_bits_mask.bit_masks.low_bits_mask.examples">Examples</a>
</h4>
<p>
@@ -240,7 +342,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../../high_bits_mask/bit_masks/high_bits_maskbits.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_integer_bits_masks_extension/bit_masks.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../../bits_mask/bit_masks/bits_mask.html"><img src="../..//home/brian/boost/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<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>
Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/standalone_HTML.manifest
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/standalone_HTML.manifest (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/standalone_HTML.manifest 2010-08-21 16:12:23 EDT (Sat, 21 Aug 2010)
@@ -8,6 +8,7 @@
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
@@ -16,7 +17,7 @@
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/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-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk