Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r62598 - in sandbox/SOC/2010/bit_masks/lib/integer/doc: . html html/bits_mask html/boost_integer_bits_masks_extension html/high_bits html/high_bits_mask html/integral_mask html/low_bits_mask html/rationale
From: bbartmanboost_at_[hidden]
Date: 2010-06-08 15:53:01

Author: bbartman
Date: 2010-06-08 15:52:58 EDT (Tue, 08 Jun 2010)
New Revision: 62598
URL: http://svn.boost.org/trac/boost/changeset/62598

Log:
working on adding my documentation into subversion

Added:
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/bits_mask/
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/bits_mask/bits_mask.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bit_mask_purpose.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/high_bits/
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/high_bits/high_bits.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/high_bits/high_bits_maskbits.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/high_bits_mask/
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/high_bits_mask/high_bits_maskbits.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/index.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/integral_mask/
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/integral_mask/integral_mask.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/low_bits_mask/
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/low_bits_mask/MASKNAME.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/low_bits_mask/low_bits_mask.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/rationale/
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/rationale/rationale.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/standalone_HTML.manifest (contents, props changed)
Text files modified:
   sandbox/SOC/2010/bit_masks/lib/integer/doc/Jamfile.v2 | 6 +++---
   1 files changed, 3 insertions(+), 3 deletions(-)

Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/Jamfile.v2
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/Jamfile.v2 (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/Jamfile.v2 2010-06-08 15:52:58 EDT (Tue, 08 Jun 2010)
@@ -27,11 +27,11 @@
 # How far down we go with TOC's
 <xsl:param>generate.section.toc.level=4
 # Path for links to Boost:
- <xsl:param>boost.root=$(BOOST_ROOT)
+ <xsl:param>boost.root=../../../..
 # Path for libraries index:
- <xsl:param>boost.libraries=$(BOOST_ROOT)/libs/libraries.htm
+ <xsl:param>boost.libraries=../../../../libs/libraries.htm
 # Use the main Boost stylesheet:
- <xsl:param>html.stylesheet=$(BOOST_ROOT)/doc/html/boostbook.css
+ <xsl:param>html.stylesheet=../../../../doc/html/boostbook.css

 # PDF Options:
 # TOC Generation: this is needed for FOP-0.9 and later:

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/bits_mask/bits_mask.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/bits_mask/bits_mask.html 2010-06-08 15:52:58 EDT (Tue, 08 Jun 2010)
@@ -0,0 +1,424 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>bits_mask</title>
+<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="prev" href="../low_bits_mask/low_bits_mask.html" title="low_bits_mask">
+<link rel="next" href="../rationale/rationale.html" title="Rationale And Motivation">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../low_bits_mask/low_bits_mask.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../rationale/rationale.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="bits_mask.bits_mask"></a><a class="link" href="bits_mask.html" title="bits_mask"> bits_mask</a>
+</h2></div></div></div>
+<a name="bits_mask.bits_mask.description"></a><h4>
+<a name="id2936130"></a>
+ <a class="link" href="bits_mask.html#bits_mask.bits_mask.description">Description</a>
+ </h4>
+
+ The <code class="computeroutput">bits_mask</code> template provides
+ an extention to the <code class="computeroutput">low_bits_mask</code>
+ template, by incorporating an <code class="computeroutput">Offset</code>
+ with the template. The <code class="computeroutput">offest</code>
+ is always relative to the right most bit, or bit 0. For a basic view of how
+ <code class="computeroutput">bits_mask</code> works consider the
+ following examples:
+ 
+
+
+
+<pre class="programlisting">typedef bits_mask<int, 10, 3> mask;
+// mask::value has the following binary value
+// 0000 0000 0000 0000 0001 1100 0000 0000
+</pre>
+
+ For simplicity there is a defualt parameter for <code class="computeroutput">Width</code>
+ giving it a value of <code class="computeroutput">1</code>. This makes
+ writing of normally left or right shift masks simple and staticly checkable.
+ For example,
+ 
+
+
+
+<pre class="programlisting">// If one would need to create a mask for checking the 11th bit within an
+// integer it can be done simple with the following mask
+typedef bits_mask<int,11> mask;
+// this creates a mask at the 11th bit within an integer.
+</pre>
+
+ 
+
+ The <code class="computeroutput">bits_mask</code> template is located
+ in the <boost/integer/bits_mask.hpp> header file.
+ 
+<a name="bits_mask.bits_mask.template_signature"></a><h4>
+<a name="id2936370"></a>
+ <a class="link" href="bits_mask.html#bits_mask.bits_mask.template_signature">Template Signature</a>
+ </h4>
+
+ <code class="computeroutput">bits_mask</code> has the following
+ template signature:
+
+<pre class="programlisting">template <typename T, unsigned int Offset, unsigned int Width = 1 >
+struct bits_mask;
+</pre>
+
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Parameter
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">T</code>
+ 
+ </td>
+<td>
+ 
+ Is an integral type which the mask is to be created over.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">Offset</code>
+ 
+ </td>
+<td>
+ 
+ This is the number of bits which is used for a left shift of the
+ <code class="computeroutput">width</code>.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">Width</code>
+ 
+ </td>
+<td>
+ 
+ This is the width of the mask in bits.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="bits_mask.bits_mask.interface"></a><h4>
+<a name="id2936618"></a>
+ <a class="link" href="bits_mask.html#bits_mask.bits_mask.interface">Interface</a>
+ </h4>
+
+ <code class="computeroutput">TYPENAME</code> Compile time interface.
+ Assume that N is of type <code class="computeroutput">N TYPE</code> the type supplied here is only for example.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Operation
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::value</code>
+ 
+ </td>
+<td>
+ 
+ Returns the <code class="computeroutput">value</code>
+ associated with <code class="computeroutput">N</code>.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::value_type</code>
+ 
+ </td>
+<td>
+ 
+ Returns <code class="computeroutput">T</code> which is
+ the type associated with <code class="computeroutput">value</code>
+ inside <code class="computeroutput">N</code>.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::type</code>
+ 
+ </td>
+<td>
+ 
+ Returns the current types type.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::width</code>
+ 
+ </td>
+<td>
+ 
+ Returns the integral value associated with the <code class="computeroutput">width</code>
+ template parameter.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::offset</code>
+ 
+ </td>
+<td>
+ 
+ Returns the integral value associated with the <code class="computeroutput">Offset</code>
+ template parameter.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">operator T()</code>
+ 
+ </td>
+<td>
+ 
+ Run time support function. All this function does is return the value
+ associated with the type. With the c++0x feature <code class="computeroutput">constexper</code>
+ this function will be made fasters and more effieient.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="bits_mask.bits_mask.preconditions"></a><h4>
+<a name="id2936982"></a>
+ <a class="link" href="bits_mask.html#bits_mask.bits_mask.preconditions">Preconditions</a>
+ </h4>
+
+ Preconditions associated with the <code class="computeroutput">bits_mask</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.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Precondition
+ 
+ </th>
+<th>
+ 
+ Reasoning
+ 
+ </th>
+<th>
+ 
+ Enforcement
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">(Offset
+ + Width) < ( bit_width<T>::value
+ - 1)</code>
+ 
+ </td>
+<td>
+ 
+ It will cause overflow if the width plus the offset is greater then
+ total width of the type in bits.
+ 
+ </td>
+<td>
+ 
+ Enforced by <code class="computeroutput">BOOST_STATIC_ASSERT</code>.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">Width >
+ 0</code>
+ 
+ </td>
+<td>
+ 
+ This would create an empty mask, which won't do anything.
+ 
+ </td>
+<td>
+ 
+ Enfoced by the domain of the <code class="computeroutput">Width</code>
+ template parameter which is an <code class="computeroutput">unsigned
+ int</code>, which prevents the value
+ from being negative, and by <code class="computeroutput">BOOST_STATIC_ASSERT</code>,
+ which prevents the value from being zero.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">T</code> must satisfy the
+ <code class="computeroutput">is_integral</code> type
+ trait.
+ 
+ </td>
+<td>
+ 
+ The <code class="computeroutput">bits_mask</code> template
+ has only been tested with integral types.
+ 
+ </td>
+<td>
+ 
+ This is only a documented precondition.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="bits_mask.bits_mask.examples"></a><h4>
+<a name="id2937301"></a>
+ <a class="link" href="bits_mask.html#bits_mask.bits_mask.examples">Examples</a>
+ </h4>
+
+ Examples and use cases related to the <code class="computeroutput">bits_mask</code>
+ template.
+ 
+
+ Example:
+ 
+
+ Single bit mask using the default parameter for width.
+
+<pre class="programlisting">typedef bits_mask< int, 0 > mask;
+// mask in this case has the following value
+// 0000 0000 0000 0000 0000 0000 0000 0001
+
+int some_bit_value = 0xdeadbeef;
+
+// now testing to see if the zero bit is set in some_bit_value
+if(some_bit_value & mask() ) {
+ ...
+ true case
+ ...
+} else {
+ ...
+ false case
+ ...
+}
+</pre>
+
+ 
+
+ Here is another case where the <code class="computeroutput">bits_mask</code>
+ template is used used similar to a bit field. The goal in this case would be
+ to extract a single value from within an integral storage type, which may be
+ storing one or more values.
+ 
+
+
+
+<pre class="programlisting">typedef bits_mask<int,10,3> mask;
+// binary value of mask
+// 0000 0000 0000 0000 0001 1111 1111 1000
+
+// this will then be used to retrieve a value within an integer.
+int some_bit_value = 0xdeadbeef;
+// binary value of some_bit_value
+// 1101 1110 1010 1011 1011 1110 1110 1111
+
+// now to extract the value from within some_bit_value
+int new_int_value = ( some_bit_value & mask() ) >> mask::offset;
+
+// basic operations taking place.
+// 1101 1110 1010 1011 1011 1110 1110 1111 <- some_bit_value
+// 0000 0000 0000 0000 0001 1111 1111 1000 <- mask::value
+
+// preforming bitwise and operator.
+
+// 0000 0000 0000 0000 0001 1110 1110 1000 <- result of bitwise and operator
+// preform right shift operation.
+// 0000 0000 0000 0000 0000 0011 1101 1101 <- value of new_int_value.
+</pre>
+
+ 
+
+ The implicit cast operator allows for simplicity, clairity of code. In the
+ above example <code class="computeroutput">mask()</code>
+ could be replaced with <code class="computeroutput">mask::value</code> to
+ achieve the same result. The same applies to all other bitwise operators.
+ 
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2010 Brian Bartman
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../low_bits_mask/low_bits_mask.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../rationale/rationale.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bit_mask_purpose.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bit_mask_purpose.html 2010-06-08 15:52:58 EDT (Tue, 08 Jun 2010)
@@ -0,0 +1,79 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Purpose</title>
+<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="prev" href="../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="next" href="../integral_mask/integral_mask.html" title="integral_mask type">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../index.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../integral_mask/integral_mask.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="boost_integer_bits_masks_extension.bit_mask_purpose"></a><a class="link" href="bit_mask_purpose.html" title="Purpose"> Purpose</a>
+</h2></div></div></div>
+
+ The purpose of this library extension to the boost.integer library is to make
+ the creation of simple and complex integral masks simple and easy and constructable
+ on compile time. The structure of the masks are extensions of the type <code class="computeroutput">integral_constant</code> provided by boost.type_traits
+ library. All masks are able to be treated as the <code class="computeroutput">integral_constant</code>
+ type. All masks provide the following three compile time accessible features.
+ They all provide <code class="computeroutput">::type</code>,<code class="computeroutput">::value_type</code>
+ and <code class="computeroutput">::value</code>
+ for compile time support. This also means that all masks can be used with the
+ boost.mpl bitwise operator meta-functions for creation of more complex masks.
+ Now because these values were intended to be used during the runtime of a program
+ all of the masking types which are provided by this library provide an additional
+ functionality for run time support. All of the mask types in this library provide
+ the implicit cast operator allowing for the meta-function objects to be used
+ as if they were the integral value they were used to construct. For example,
+
+
+<pre class="programlisting">#include <boost/integer/integral_mask.hpp>
+
+using namespace boost;
+
+
+int main() {
+ int t = 0xdeadbeef;
+ typedef integral_mask<int, 3> mask_type;
+
+ int unmasked_t = t & mask_type();
+ return 0;
+}
+</pre>
+
+ For the use of a mask all that one needs to do is to construct the mask and
+ simply treat it as though it were an integer.
+ 
+<div class="note"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/html/images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td align="left" valign="top">
+ All masks are trivially default constructible and destructible.
+ </td></tr>
+</table></div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2010 Brian Bartman
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../index.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../integral_mask/integral_mask.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/high_bits/high_bits.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/high_bits/high_bits.html 2010-06-08 15:52:58 EDT (Tue, 08 Jun 2010)
@@ -0,0 +1,242 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>high_bits</title>
+<link rel="stylesheet" href="..//home/brian/gsoc/boost-trunk/doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="prev" href="../integral_mask/integral_mask.html" title="integral_mask type">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../integral_mask/integral_mask.html"><img src="..//home/brian/gsoc/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="..//home/brian/gsoc/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="..//home/brian/gsoc/boost-trunk/doc/html/images/home.png" alt="Home"></a>
+</div>
+<div class="section" title="high_bits">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="high_bits.high_bits"></a><a class="link" href="high_bits.html" title="high_bits"> high_bits</a>
+</h2></div></div></div>
+<a name="high_bits.high_bits.description"></a><h4>
+<a name="id3086886"></a>
+ <a class="link" href="high_bits.html#high_bits.high_bits.description">Description</a>
+ </h4>
+
+ THe template <code class="computeroutput">high_bits</code> preforms
+ bitwise operations on compile time then exposes the newly created mask via
+ <code class="computeroutput">value</code> and <code class="computeroutput">operator
+ T()</code>.
+ What <code class="computeroutput">high_bits</code> does is create
+ a mask inside your integral type which sets all bits starting from the left
+ most bit reaching out width bits to the right. For example,
+
+<pre class="programlisting">// using high bits to create a mask starting from the left most bit with a width
+// of 15
+typedef high_bits<int, 15> bits;
+// bits::value will have the following value in binary.
+// 1111 1111 1111 1110 0000 0000 0000 0000
+</pre>
+
+ 
+<a name="high_bits.high_bits.template_signature"></a><h4>
+<a name="id3087022"></a>
+ <a class="link" href="high_bits.html#high_bits.high_bits.template_signature">Template Signature</a>
+ </h4>
+
+ <code class="computeroutput">high_bits</code> has the following
+ template signature:
+
+<pre class="programlisting">template <typename T, unsigned int Width>
+struct high_bits;
+</pre>
+
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Parameter
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">T</code>
+ 
+ </td>
+<td>
+ 
+ Is an integral type which the mask is to be created over.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">Width</code>
+ 
+ </td>
+<td>
+ 
+ This is the width of the mask in bits.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="high_bits.high_bits.interface"></a><h4>
+<a name="id3087204"></a>
+ <a class="link" href="high_bits.html#high_bits.high_bits.interface">Interface</a>
+ </h4>
+
+ <code class="computeroutput">high_bits</code> Compile time interface.
+ Assume that N is of type <code class="computeroutput">high_bits</code>
+ the type supplied here is only for example.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Operation
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::value</code>
+ 
+ </td>
+<td>
+ 
+ Returns the <code class="computeroutput">value</code>
+ associated with <code class="computeroutput">N</code>.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::value_type</code>
+ 
+ </td>
+<td>
+ 
+ Returns <code class="computeroutput">T</code> which is
+ the type associated with <code class="computeroutput">value</code>
+ inside <code class="computeroutput">N</code>.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::type</code>
+ 
+ </td>
+<td>
+ 
+ Returns the current types type.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::width</code>
+ 
+ </td>
+<td>
+ 
+ Returns the integral value associated with the <code class="computeroutput">width</code>
+ template parameter.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">operator T()</code>
+ 
+ </td>
+<td>
+ 
+ Run time support function. All this function does is return the value
+ associated with the type. With the c++0x feature constexper this
+ function will be made fasters and more effieient.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="high_bits.high_bits.examples"></a><h4>
+<a name="id3087509"></a>
+ <a class="link" href="high_bits.html#high_bits.high_bits.examples">Examples</a>
+ </h4>
+
+ Examples and use cases related to the <code class="computeroutput">high_bits</code>
+ type.
+ 
+
+ Exaple:
+
+<pre class="programlisting">typedef high_bits<int,4> mask;
+
+// binary for mask::value
+// 1111 0000 0000 0000 0000 0000 0000 0000
+
+int integral_value = 0xc000000c;
+
+// integral_value's binary value
+// 1100 0000 0000 0000 0000 0000 0000 1100
+
+int result = integral_value & mask();
+// binary value of result
+// 1100 0000 0000 0000 0000 0000 0000 0000
+
+</pre>
+
+ 
+
+ The implicit cast operator allows for simplicity, clairity of code. In the
+ above example <code class="computeroutput">mask()</code>
+ could be replaced with <code class="computeroutput">mask::value</code> to
+ achieve the same result. The same applies to all other bitwise operators.
+ 
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2010 Brian Bartman
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../integral_mask/integral_mask.html"><img src="..//home/brian/gsoc/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="..//home/brian/gsoc/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="..//home/brian/gsoc/boost-trunk/doc/html/images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/high_bits/high_bits_maskbits.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/high_bits/high_bits_maskbits.html 2010-06-08 15:52:58 EDT (Tue, 08 Jun 2010)
@@ -0,0 +1,240 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>high_bits_mask</title>
+<link rel="stylesheet" href="..//home/brian/gsoc/boost-trunk/doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="prev" href="../integral_mask/integral_mask.html" title="integral_mask type">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../integral_mask/integral_mask.html"><img src="..//home/brian/gsoc/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="..//home/brian/gsoc/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="..//home/brian/gsoc/boost-trunk/doc/html/images/home.png" alt="Home"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="high_bits.high_bits_maskbits"></a><a class="link" href="high_bits_maskbits.html" title="high_bits_mask"> high_bits_mask</a>
+</h2></div></div></div>
+<a name="high_bits.high_bits_maskbits.description"></a><h4>
+<a name="id3321880"></a>
+ <a class="link" href="high_bits_maskbits.html#high_bits.high_bits_maskbits.description">Description</a>
+ </h4>
+
+ THe template <code class="computeroutput">high_bits_mask</code>
+ preforms bitwise operations on compile time then exposes the newly created
+ mask via <code class="computeroutput">value</code> and <code class="computeroutput">operator T()</code>. What <code class="computeroutput">high_bits_mask</code>
+ does is create a mask inside your integral type which sets all bits starting
+ from the left most bit reaching out width bits to the right. For example,
+
+<pre class="programlisting">// using high bits to create a mask starting from the left most bit with a width
+// of 15
+typedef high_bits_mask<int, 15> bits;
+// bits::value will have the following value in binary.
+// 1111 1111 1111 1110 0000 0000 0000 0000
+</pre>
+
+ 
+<a name="high_bits.high_bits_maskbits.template_signature"></a><h4>
+<a name="id3322017"></a>
+ <a class="link" href="high_bits_maskbits.html#high_bits.high_bits_maskbits.template_signature">Template Signature</a>
+ </h4>
+
+ <code class="computeroutput">high_bits_mask</code> has the following
+ template signature:
+
+<pre class="programlisting">template <typename T, unsigned int Width>
+struct high_bits_mask;
+</pre>
+
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Parameter
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">T</code>
+ 
+ </td>
+<td>
+ 
+ Is an integral type which the mask is to be created over.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">Width</code>
+ 
+ </td>
+<td>
+ 
+ This is the width of the mask in bits.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="high_bits.high_bits_maskbits.interface"></a><h4>
+<a name="id3322198"></a>
+ <a class="link" href="high_bits_maskbits.html#high_bits.high_bits_maskbits.interface">Interface</a>
+ </h4>
+
+ <code class="computeroutput">high_bits_mask</code> Compile time
+ interface. Assume that N is of type <code class="computeroutput">high_bits_mask</code>
+ the type supplied here is only for example.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Operation
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::value</code>
+ 
+ </td>
+<td>
+ 
+ Returns the <code class="computeroutput">value</code>
+ associated with <code class="computeroutput">N</code>.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::value_type</code>
+ 
+ </td>
+<td>
+ 
+ Returns <code class="computeroutput">T</code> which is
+ the type associated with <code class="computeroutput">value</code>
+ inside <code class="computeroutput">N</code>.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::type</code>
+ 
+ </td>
+<td>
+ 
+ Returns the current types type.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::width</code>
+ 
+ </td>
+<td>
+ 
+ Returns the integral value associated with the <code class="computeroutput">width</code>
+ template parameter.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">operator T()</code>
+ 
+ </td>
+<td>
+ 
+ Run time support function. All this function does is return the value
+ associated with the type. With the c++0x feature constexper this
+ function will be made fasters and more effieient.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="high_bits.high_bits_maskbits.examples"></a><h4>
+<a name="id3322503"></a>
+ <a class="link" href="high_bits_maskbits.html#high_bits.high_bits_maskbits.examples">Examples</a>
+ </h4>
+
+ Examples and use cases related to the <code class="computeroutput">high_bits_mask</code>
+ type.
+ 
+
+ Exaple:
+
+<pre class="programlisting">typedef high_bits_mask<int,4> mask;
+
+// binary for mask::value
+// 1111 0000 0000 0000 0000 0000 0000 0000
+
+int integral_value = 0xc000000c;
+
+// integral_value's binary value
+// 1100 0000 0000 0000 0000 0000 0000 1100
+
+int result = integral_value & mask();
+// binary value of result
+// 1100 0000 0000 0000 0000 0000 0000 0000
+
+</pre>
+
+ 
+
+ The implicit cast operator allows for simplicity, clairity of code. In the
+ above example <code class="computeroutput">mask()</code>
+ could be replaced with <code class="computeroutput">mask::value</code> to
+ achieve the same result. The same applies to all other bitwise operators.
+ 
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2010 Brian Bartman
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../integral_mask/integral_mask.html"><img src="..//home/brian/gsoc/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="..//home/brian/gsoc/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="..//home/brian/gsoc/boost-trunk/doc/html/images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/high_bits_mask/high_bits_maskbits.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/high_bits_mask/high_bits_maskbits.html 2010-06-08 15:52:58 EDT (Tue, 08 Jun 2010)
@@ -0,0 +1,243 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>high_bits_mask</title>
+<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="prev" href="../integral_mask/integral_mask.html" title="integral_mask type">
+<link rel="next" href="../low_bits_mask/low_bits_mask.html" title="low_bits_mask">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../integral_mask/integral_mask.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../low_bits_mask/low_bits_mask.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="high_bits_mask.high_bits_maskbits"></a><a class="link" href="high_bits_maskbits.html" title="high_bits_mask"> high_bits_mask</a>
+</h2></div></div></div>
+<a name="high_bits_mask.high_bits_maskbits.description"></a><h4>
+<a name="id2934373"></a>
+ <a class="link" href="high_bits_maskbits.html#high_bits_mask.high_bits_maskbits.description">Description</a>
+ </h4>
+
+ THe template <code class="computeroutput">high_bits_mask</code>
+ preforms bitwise operations on compile time then exposes the newly created
+ mask via <code class="computeroutput">value</code> and <code class="computeroutput">operator T()</code>. What <code class="computeroutput">high_bits_mask</code>
+ does is create a mask inside your integral type which sets all bits starting
+ from the left most bit reaching out width bits to the right. For example,
+
+<pre class="programlisting">// using high bits to create a mask starting from the left most bit with a width
+// of 15
+typedef high_bits_mask<int, 15> bits;
+// bits::value will have the following value in binary.
+// 1111 1111 1111 1110 0000 0000 0000 0000
+</pre>
+
+ 
+<a name="high_bits_mask.high_bits_maskbits.template_signature"></a><h4>
+<a name="id2934509"></a>
+ <a class="link" href="high_bits_maskbits.html#high_bits_mask.high_bits_maskbits.template_signature">Template
+ Signature</a>
+ </h4>
+
+ <code class="computeroutput">high_bits_mask</code> has the following
+ template signature:
+
+<pre class="programlisting">template <typename T, unsigned int Width>
+struct high_bits_mask;
+</pre>
+
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Parameter
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">T</code>
+ 
+ </td>
+<td>
+ 
+ Is an integral type which the mask is to be created over.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">Width</code>
+ 
+ </td>
+<td>
+ 
+ This is the width of the mask in bits.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="high_bits_mask.high_bits_maskbits.interface"></a><h4>
+<a name="id2934690"></a>
+ <a class="link" href="high_bits_maskbits.html#high_bits_mask.high_bits_maskbits.interface">Interface</a>
+ </h4>
+
+ <code class="computeroutput">high_bits_mask</code> Compile time
+ interface. Assume that N is of type <code class="computeroutput">high_bits_mask<int,
+ 10></code>
+ the type supplied here is only for example.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Operation
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::value</code>
+ 
+ </td>
+<td>
+ 
+ Returns the <code class="computeroutput">value</code>
+ associated with <code class="computeroutput">N</code>.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::value_type</code>
+ 
+ </td>
+<td>
+ 
+ Returns <code class="computeroutput">T</code> which is
+ the type associated with <code class="computeroutput">value</code>
+ inside <code class="computeroutput">N</code>.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::type</code>
+ 
+ </td>
+<td>
+ 
+ Returns the current types type.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::width</code>
+ 
+ </td>
+<td>
+ 
+ Returns the integral value associated with the <code class="computeroutput">width</code>
+ template parameter.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">operator T()</code>
+ 
+ </td>
+<td>
+ 
+ Run time support function. All this function does is return the value
+ associated with the type. With the c++0x feature <code class="computeroutput">constexper</code>
+ this function will be made fasters and more effieient.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="high_bits_mask.high_bits_maskbits.examples"></a><h4>
+<a name="id2935027"></a>
+ <a class="link" href="high_bits_maskbits.html#high_bits_mask.high_bits_maskbits.examples">Examples</a>
+ </h4>
+
+ Examples and use cases related to the <code class="computeroutput">high_bits_mask</code>
+ template.
+ 
+
+ Example:
+
+<pre class="programlisting">typedef high_bits_mask<int,4> mask;
+
+// binary for mask::value
+// 1111 0000 0000 0000 0000 0000 0000 0000
+
+int integral_value = 0xc000000c;
+
+// integral_value's binary value
+// 1100 0000 0000 0000 0000 0000 0000 1100
+
+int result = integral_value & mask();
+// binary value of result
+// 1100 0000 0000 0000 0000 0000 0000 0000
+
+</pre>
+
+ 
+
+ The implicit cast operator allows for simplicity, clairity of code. In the
+ above example <code class="computeroutput">mask()</code>
+ could be replaced with <code class="computeroutput">mask::value</code> to
+ achieve the same result. The same applies to all other bitwise operators.
+ 
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2010 Brian Bartman
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../integral_mask/integral_mask.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../low_bits_mask/low_bits_mask.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/index.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/index.html 2010-06-08 15:52:58 EDT (Tue, 08 Jun 2010)
@@ -0,0 +1,209 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Boost.Integer Bits Masks Extension</title>
+<link rel="stylesheet" href="../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="next" href="boost_integer_bits_masks_extension/bit_mask_purpose.html" title="Purpose">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav"><a accesskey="n" href="boost_integer_bits_masks_extension/bit_mask_purpose.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a></div>
+<div class="article">
+<div class="titlepage">
+<div>
+<div><h2 class="title">
+<a name="boost_integer_bits_masks_extension"></a>Boost.Integer Bits Masks Extension</h2></div>
+<div><div class="authorgroup"><div class="author"><h3 class="author">
+Brian Bartman
+</h3></div></div></div>
+<div>Copyright © 2010 Brian Bartman</div>
+<div><div class="legalnotice">
+<a name="id2924026"></a>
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></div>
+</div>
+<hr>
+</div>
+<div class="toc">
+Table of Contents
+<dl>
+<dt><a href="index.html#boost_integer_bits_masks_extension.HeaderSummary"> Header
+ File Summary</a></dt>
+<dt> Purpose</dt>
+<dt> integral_mask type</dt>
+<dt> high_bits_mask</dt>
+<dt> low_bits_mask</dt>
+<dt> bits_mask</dt>
+<dt> Rationale And Motivation</dt>
+</dl>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="boost_integer_bits_masks_extension.HeaderSummary"></a><a class="link" href="index.html#boost_integer_bits_masks_extension.HeaderSummary" title="Header File Summary"> Header
+ File Summary</a>
+</h2></div></div></div>
+
+ The following table contains header files used within the bit masks library
+ extension. For additional information such as full descriptions, tutorials
+ and interface guides please use the table of contents above.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Component
+ 
+ </th>
+<th>
+ 
+ Header
+ 
+ </th>
+<th>
+ 
+ Contence
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">integral_mask</code> type
+ 
+ </td>
+<td>
+ 
+ <code class="literal"><boost/integer/integral_mask.hpp></code>
+ 
+ </td>
+<td>
+ 
+ Header contains <code class="computeroutput">integral_mask</code>
+ template.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">high_bits_mask</code> type
+ 
+ </td>
+<td>
+ 
+ <code class="literal"><boost/integer/high_bits_mask.hpp></code>
+ 
+ </td>
+<td>
+ 
+ Header contains <code class="computeroutput">high_bits_mask</code>
+ template.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">low_bits_mask</code> type
+ 
+ </td>
+<td>
+ 
+ <code class="literal"><boost/integer/low_bits_mask.hpp></code>
+ 
+ </td>
+<td>
+ 
+ Header contains <code class="computeroutput">low_bits_mask</code>
+ template.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">high_bits_mask</code> type
+ and <code class="computeroutput">low_bits_mask</code>
+ type
+ 
+ </td>
+<td>
+ 
+ <code class="literal"><boost/integer/high_low_bits.hpp></code>
+ 
+ </td>
+<td>
+ 
+ Header contains includes for <code class="computeroutput">high_bits_mask</code>
+ and <code class="computeroutput">low_bits_mask</code>.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">bits_mask</code> type and
+ <code class="computeroutput">low_bits_mask</code> type
+ 
+ </td>
+<td>
+ 
+ <code class="literal"><boost/integer/bits_mask.hpp></code>
+ 
+ </td>
+<td>
+ 
+ Header contains <code class="computeroutput">bits_mask</code>
+ template.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">bit_mask_group</code> type
+ 
+ </td>
+<td>
+ 
+ <code class="literal"><boost/integer/bit_mask_group.hpp></code>
+ 
+ </td>
+<td>
+ 
+ Header contains <code class="computeroutput">bit_mask_group</code>
+ meta-function/container.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+
+ 
+
+ 
+
+ 
+
+ 
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left">Last revised: June 08, 2010 at 19:47:44 GMT</td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav"><a accesskey="n" href="boost_integer_bits_masks_extension/bit_mask_purpose.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a></div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/integral_mask/integral_mask.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/integral_mask/integral_mask.html 2010-06-08 15:52:58 EDT (Tue, 08 Jun 2010)
@@ -0,0 +1,226 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>integral_mask type</title>
+<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="prev" href="../boost_integer_bits_masks_extension/bit_mask_purpose.html" title="Purpose">
+<link rel="next" href="../high_bits_mask/high_bits_maskbits.html" title="high_bits_mask">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../boost_integer_bits_masks_extension/bit_mask_purpose.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../high_bits_mask/high_bits_maskbits.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="integral_mask.integral_mask"></a><a class="link" href="integral_mask.html" title="integral_mask type"> integral_mask type</a>
+</h2></div></div></div>
+<a name="integral_mask.integral_mask.description"></a><h4>
+<a name="id2882999"></a>
+ <a class="link" href="integral_mask.html#integral_mask.integral_mask.description">Description</a>
+ </h4>
+
+ The <code class="computeroutput">integral_mask</code> type is the
+ most basic mask type. It is used to abstract all masks back to a simple integral
+ type. This type is used similar to an <code class="computeroutput">integral_constant</code>
+ type from the boost.type_traits library. The <code class="computeroutput">integral_mask</code>
+ template is located in the following header file: <boost/integer/integral_mask.hpp>.
+ 
+<a name="integral_mask.integral_mask.template_signature"></a><h4>
+<a name="id2883060"></a>
+ <a class="link" href="integral_mask.html#integral_mask.integral_mask.template_signature">Template Signature</a>
+ </h4>
+
+ <code class="computeroutput">integral_mask</code> has the following
+ template signature:
+
+<pre class="programlisting">template <typename T, T Value>
+struct integral_mask;
+</pre>
+
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Parameter
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">T</code>
+ 
+ </td>
+<td>
+ 
+ This Parameters specifies the integral type to be associated with
+ the value.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">value</code>
+ 
+ </td>
+<td>
+ 
+ The integral value which is used to represent a mask.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="integral_mask.integral_mask.interface"></a><h4>
+<a name="id2933793"></a>
+ <a class="link" href="integral_mask.html#integral_mask.integral_mask.interface">Interface</a>
+ </h4>
+
+ <code class="computeroutput">Integral_mask</code> Compile time
+ interface. Assume that N is of type <code class="computeroutput">integral_mask<int,
+ 16></code>
+ the type supplied here is only for example.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Operation
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::value</code>
+ 
+ </td>
+<td>
+ 
+ Returns the <code class="computeroutput">value</code>
+ associated with <code class="computeroutput">N</code>
+ (in the current case that is 16).
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::value_type</code>
+ 
+ </td>
+<td>
+ 
+ Returns <code class="computeroutput">T</code> which is
+ the type associated with <code class="computeroutput">value</code>
+ inside <code class="computeroutput">N</code> (in the
+ current case that is int).
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::type</code>
+ 
+ </td>
+<td>
+ 
+ Returns the current types type (using N as an example, <code class="computeroutput">N::type</code> is equivalent to <code class="computeroutput">integral_mask<int,16></code>
+ )
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">operator T()</code>
+ 
+ </td>
+<td>
+ 
+ Run time support function. All this function does is return the value
+ associated with the type. With the c++0x feature <code class="computeroutput">constexper</code>
+ this function will be made fasters and more effieient.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="integral_mask.integral_mask.examples"></a><h4>
+<a name="id2934135"></a>
+ <a class="link" href="integral_mask.html#integral_mask.integral_mask.examples">Examples</a>
+ </h4>
+
+ Examples and use cases related to the <code class="computeroutput">integral_mask</code>
+ template.
+ 
+
+ Example:
+
+<pre class="programlisting">int bits = 255;
+
+typedef integral_mask<int, 16> mask;
+// mask has the folling binary value
+// 0000 0000 0000 0000 0000 0000 0001 0110
+
+// bits has binary value of:
+// 0000 0000 0000 0000 0000 0000 0010 0101
+
+// the following is a bitwise and operation
+// which is done to bits using the integral_mask type
+int new_bits = bits & mask();
+
+// Resulting value of new_bits:
+// 0000 0000 0000 0000 0000 0000 0000 0100
+
+
+</pre>
+
+ The implicit cast operator allows for simplicity, clairity of code. In the
+ above example <code class="computeroutput">mask()</code>
+ could be replaced with <code class="computeroutput">mask::value</code> to
+ achieve the same result. The same applies to all other bitwise operators.
+ 
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2010 Brian Bartman
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../boost_integer_bits_masks_extension/bit_mask_purpose.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../high_bits_mask/high_bits_maskbits.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/low_bits_mask/MASKNAME.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/low_bits_mask/MASKNAME.html 2010-06-08 15:52:58 EDT (Tue, 08 Jun 2010)
@@ -0,0 +1,193 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>MASKNAME</title>
+<link rel="stylesheet" href="..//home/brian/gsoc/boost-trunk/doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="prev" href="../high_bits_mask/high_bits_maskbits.html" title="high_bits_mask">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../high_bits_mask/high_bits_maskbits.html"><img src="..//home/brian/gsoc/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="..//home/brian/gsoc/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="..//home/brian/gsoc/boost-trunk/doc/html/images/home.png" alt="Home"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="low_bits_mask.MASKNAME"></a><a class="link" href="MASKNAME.html" title="MASKNAME"> MASKNAME</a>
+</h2></div></div></div>
+<a name="low_bits_mask.MASKNAME.description"></a><h4>
+<a name="id3265119"></a>
+ <a class="link" href="MASKNAME.html#low_bits_mask.MASKNAME.description">Description</a>
+ </h4>
+<a name="low_bits_mask.MASKNAME.template_signature"></a><h4>
+<a name="id3265137"></a>
+ <a class="link" href="MASKNAME.html#low_bits_mask.MASKNAME.template_signature">Template Signature</a>
+ </h4>
+
+ <code class="computeroutput">TYPENME</code> has the following template
+ signature:
+
+<pre class="programlisting">TEMPLATE SIGNATURE.
+</pre>
+
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Parameter
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ 
+ </td>
+<td>
+ 
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ 
+ </td>
+<td>
+ 
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="low_bits_mask.MASKNAME.interface"></a><h4>
+<a name="id3265252"></a>
+ <a class="link" href="MASKNAME.html#low_bits_mask.MASKNAME.interface">Interface</a>
+ </h4>
+
+ <code class="computeroutput">TYPENAME</code> Compile time interface.
+ Assume that N is of type <code class="computeroutput">N TYPE</code> the type supplied here is only for example.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Operation
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::value</code>
+ 
+ </td>
+<td>
+ 
+ Returns the <code class="computeroutput">value</code>
+ associated with <code class="computeroutput">N</code>.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::value_type</code>
+ 
+ </td>
+<td>
+ 
+ Returns <code class="computeroutput">T</code> which is
+ the type associated with <code class="computeroutput">value</code>
+ inside <code class="computeroutput">N</code>.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::type</code>
+ 
+ </td>
+<td>
+ 
+ Returns the current types type.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">operator T()</code>
+ 
+ </td>
+<td>
+ 
+ Run time support function. All this function does is return the value
+ associated with the type. With the c++0x feature constexper this
+ function will be made fasters and more effieient.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="low_bits_mask.MASKNAME.examples"></a><h4>
+<a name="id3265519"></a>
+ <a class="link" href="MASKNAME.html#low_bits_mask.MASKNAME.examples">Examples</a>
+ </h4>
+
+ Examples and use cases related to the <code class="computeroutput">TYPENAME</code>
+ type.
+ 
+
+ Exaple:
+
+<pre class="programlisting">EXAMPLE
+</pre>
+
+ 
+
+ The implicit cast operator allows for simplicity, clairity of code. In the
+ above example <code class="computeroutput">mask()</code>
+ could be replaced with <code class="computeroutput">mask::value</code> to
+ achieve the same result. The same applies to all other bitwise operators.
+ 
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2010 Brian Bartman
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../high_bits_mask/high_bits_maskbits.html"><img src="..//home/brian/gsoc/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="..//home/brian/gsoc/boost-trunk/doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="..//home/brian/gsoc/boost-trunk/doc/html/images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/low_bits_mask/low_bits_mask.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/low_bits_mask/low_bits_mask.html 2010-06-08 15:52:58 EDT (Tue, 08 Jun 2010)
@@ -0,0 +1,244 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>low_bits_mask</title>
+<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="prev" href="../high_bits_mask/high_bits_maskbits.html" title="high_bits_mask">
+<link rel="next" href="../bits_mask/bits_mask.html" title="bits_mask">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../high_bits_mask/high_bits_maskbits.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../bits_mask/bits_mask.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="low_bits_mask.low_bits_mask"></a><a class="link" href="low_bits_mask.html" title="low_bits_mask"> low_bits_mask</a>
+</h2></div></div></div>
+<a name="low_bits_mask.low_bits_mask.description"></a><h4>
+<a name="id2935250"></a>
+ <a class="link" href="low_bits_mask.html#low_bits_mask.low_bits_mask.description">Description</a>
+ </h4>
+
+ <code class="computeroutput">low_bits_mask</code> creates a mask
+ of bits starting from the right most bit and extending out to the left. The
+ <code class="computeroutput">low_bits_mask</code> is similar to
+ the <code class="computeroutput">high_bits_mask</code> just starts
+ on the right most bit instead of the left most bit. The way <code class="computeroutput">low_bits_mask</code>
+ behaves in the following example:
+ 
+
+
+
+<pre class="programlisting">typedef low_bits_mask<int, 10> mask;
+// mask::value has the following binary value
+// 0000 0000 0000 0000 0000 0011 1111 1111
+</pre>
+
+ The <code class="computeroutput">low_bits_mask</code> template
+ is located in the <boost/integer/low_bits_mask.hpp> header file.
+ 
+<a name="low_bits_mask.low_bits_mask.template_signature"></a><h4>
+<a name="id2935384"></a>
+ <a class="link" href="low_bits_mask.html#low_bits_mask.low_bits_mask.template_signature">Template Signature</a>
+ </h4>
+
+ <code class="computeroutput">low_bits_mask</code> has the following
+ template signature:
+
+<pre class="programlisting">template <typename T, unsigned int Width>
+struct low_bits_mask;
+</pre>
+
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Parameter
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">T</code>
+ 
+ </td>
+<td>
+ 
+ Is an integral type which the mask is to be created over.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">Width</code>
+ 
+ </td>
+<td>
+ 
+ This is the width of the mask in bits.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="low_bits_mask.low_bits_mask.interface"></a><h4>
+<a name="id2935564"></a>
+ <a class="link" href="low_bits_mask.html#low_bits_mask.low_bits_mask.interface">Interface</a>
+ </h4>
+
+ <code class="computeroutput">low_bits_mask</code> Compile time
+ interface. Assume that <code class="computeroutput">N</code> is
+ of type <code class="computeroutput">low_bits_mask<int,10></code> the type supplied here is only for example.
+ 
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ 
+ Operation
+ 
+ </th>
+<th>
+ 
+ Description
+ 
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::value</code>
+ 
+ </td>
+<td>
+ 
+ Returns the <code class="computeroutput">value</code>
+ associated with <code class="computeroutput">N</code>.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::value_type</code>
+ 
+ </td>
+<td>
+ 
+ Returns <code class="computeroutput">T</code> which is
+ the type associated with <code class="computeroutput">value</code>
+ inside <code class="computeroutput">N</code>.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::type</code>
+ 
+ </td>
+<td>
+ 
+ Returns the current types type.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">N::width</code>
+ 
+ </td>
+<td>
+ 
+ Returns the integral value associated with the <code class="computeroutput">width</code>
+ template parameter.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">operator T()</code>
+ 
+ </td>
+<td>
+ 
+ Run time support function. All this function does is return the value
+ associated with the type. With the c++0x feature <code class="computeroutput">constexper</code>
+ this function will be made fasters and more effieient.
+ 
+ </td>
+</tr>
+</tbody>
+</table></div>
+<a name="low_bits_mask.low_bits_mask.examples"></a><h4>
+<a name="id2935908"></a>
+ <a class="link" href="low_bits_mask.html#low_bits_mask.low_bits_mask.examples">Examples</a>
+ </h4>
+
+ Examples and use cases related to the <code class="computeroutput">low_bits_mask</code>
+ template.
+ 
+
+ Example:
+
+<pre class="programlisting">typedef low_bits_mask<int,4> mask;
+
+// binary for mask::value
+// 0000 0000 0000 0000 0000 0000 0000 1111
+
+int integral_value = 0xc000000c;
+
+// integral_value's binary value
+// 1100 0000 0000 0000 0000 0000 0000 1100
+
+int result = integral_value & mask();
+// binary value of result
+// 0000 0000 0000 0000 0000 0000 0000 1100
+</pre>
+
+ 
+
+ The implicit cast operator allows for simplicity, clairity of code. In the
+ above example <code class="computeroutput">mask()</code>
+ could be replaced with <code class="computeroutput">mask::value</code> to
+ achieve the same result. The same applies to all other bitwise operators.
+ 
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2010 Brian Bartman
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../high_bits_mask/high_bits_maskbits.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../bits_mask/bits_mask.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/rationale/rationale.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/rationale/rationale.html 2010-06-08 15:52:58 EDT (Tue, 08 Jun 2010)
@@ -0,0 +1,79 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Rationale And Motivation</title>
+<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="up" href="../index.html" title="Boost.Integer Bits Masks Extension">
+<link rel="prev" href="../bits_mask/bits_mask.html" title="bits_mask">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../bits_mask/bits_mask.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="rationale.rationale"></a><a class="link" href="rationale.html" title="Rationale And Motivation"> Rationale And Motivation</a>
+</h2></div></div></div>
+
+ The motivation and rationale behind the creation a bit masking library stems
+ from the following example:
+
+<pre class="programlisting">struct foo {
+ bool b1:1;
+ bool b2:1;
+ int i1:2;
+ int i2:2;
+};
+</pre>
+
+ The struct <code class="computeroutput">foo</code> is composed
+ of bit fields. This is fine and wouldn't be a big issues accept that there
+ is something which the user can't see that can cause problems with this struct.
+ The size of struct <code class="computeroutput">foo</code> need
+ not be any larger then <code class="computeroutput">char</code>, 1
+ byte, which is the smalles type which can hold it. Now the actual size of
+ <code class="computeroutput">foo</code> is 4 bytes. This can cause
+ havoc if a union was made with this type and a char while the user was thinking
+ that their type is 1 byte in size. So in order to create something which could
+ handle this situation correctly. This library was created to help with the
+ internal management and storage bit fields and non-standardly aligned data.
+ The goal is to provide both masking utilities and commonlly used structures
+ which would be able to correct the size of the structure and provide simple
+ accessors to the data stored within.
+ 
+<a name="rationale.rationale.project_data_structure_motivation_and_rationale"></a><h4>
+<a name="id2937993"></a>
+ <a class="link" href="rationale.html#rationale.rationale.project_data_structure_motivation_and_rationale">Project
+ Data Structure Motivation and Rationale</a>
+ </h4>
+
+ There are several data structures provided which make doing some slightly more
+ complex tasks simple and organized. The structures which the library provides
+ are <code class="computeroutput">bit_mask_group</code>, <code class="computeroutput">bit_mask_tuple</code>, <code class="computeroutput">bit_field_tuple</code>
+ and <code class="computeroutput">pointer_plus_bits</code>.
+ 
+
+ <code class="computeroutput">bit_mask_group</code> is not a container
+ it doesn't store any data however it provides a way of organizing your masks.
+ The structure also provides additional run time support on top of its tuple
+ style interface.
+ 
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2010 Brian Bartman
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../bits_mask/bits_mask.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/standalone_HTML.manifest
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/standalone_HTML.manifest 2010-06-08 15:52:58 EDT (Tue, 08 Jun 2010)
@@ -0,0 +1,7 @@
+index.html
+boost_integer_bits_masks_extension/bit_mask_purpose.html
+integral_mask/integral_mask.html
+high_bits_mask/high_bits_maskbits.html
+low_bits_mask/low_bits_mask.html
+bits_mask/bits_mask.html
+rationale/rationale.html

Date view	Thread view	Subject view	Author view

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