Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r63550 - in sandbox/SOC/2010/bit_masks: boost/integer/details/bft lib/integer/doc/bft_doc lib/integer/doc/bft_doc/reference/fusion_extension_reference lib/integer/doc/bft_doc/users_guide lib/integer/doc/html lib/integer/doc/html/bitfield_tuple lib/integer/doc/html/bits_mask lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/_bitfield_tuple__class_reference lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/_bitfield_tuple__macro_reference lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started lib/integer/doc/html/high_bits_mask lib/integer/doc/html/integral_mask lib/integer/doc/html/low_bits_mask lib/integer/doc/html/rationale
From: bbartmanboost_at_[hidden]
Date: 2010-07-03 13:54:05

Author: bbartman
Date: 2010-07-03 13:54:01 EDT (Sat, 03 Jul 2010)
New Revision: 63550
URL: http://svn.boost.org/trac/boost/changeset/63550

Log:
finished work on my tutorial section of my documentation now working towards completing the fusion section of my documentation
Added:
   sandbox/SOC/2010/bit_masks/lib/integer/doc/bft_doc/reference/fusion_extension_reference/
Text files modified:
   sandbox/SOC/2010/bit_masks/boost/integer/details/bft/template_expansion_macros.hpp | 4
   sandbox/SOC/2010/bit_masks/lib/integer/doc/bft_doc/users_guide.qbk | 2
   sandbox/SOC/2010/bit_masks/lib/integer/doc/bft_doc/users_guide/tutorial.qbk | 149 +++++++++++++++++++++++
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/bitfield_tuple/bitfield_tuple.html | 1
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/bits_mask/bits_mask.html | 10
   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 | 28 ++--
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/_bitfield_tuple__class_reference/_struct_bit_align_.html | 8
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/_bitfield_tuple__class_reference/_struct_filler_.html | 8
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/_bitfield_tuple__class_reference/_struct_flag_.html | 8
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/_bitfield_tuple__class_reference/_struct_member_.html | 8
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/reference/_bitfield_tuple__class_reference/_struct_storage_.html | 8
   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 | 2
   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 | 2
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide.html | 1
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/external_resources.html | 6
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/getting_started/dependencies.html | 12
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/boost_integer_bits_masks_extension/bitfield_tuple/users_guide/tutorial.html | 258 +++++++++++++++++++++++++++++++++++++++
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/high_bits_mask/high_bits_maskbits.html | 8
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/index.html | 5
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/integral_mask/integral_mask.html | 8
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/low_bits_mask/low_bits_mask.html | 8
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/rationale/rationale.html | 2
   22 files changed, 470 insertions(+), 76 deletions(-)

Modified: sandbox/SOC/2010/bit_masks/boost/integer/details/bft/template_expansion_macros.hpp
==============================================================================
--- sandbox/SOC/2010/bit_masks/boost/integer/details/bft/template_expansion_macros.hpp (original)
+++ sandbox/SOC/2010/bit_masks/boost/integer/details/bft/template_expansion_macros.hpp 2010-07-03 13:54:01 EDT (Sat, 03 Jul 2010)
@@ -136,8 +136,4 @@
#define BOOST_BFT_SPECILIZATION_PARAM_LIST() \
BOOST_BFT_PARAMETER_LIST()

-
-
-
-
#endif

Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/bft_doc/users_guide.qbk
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/bft_doc/users_guide.qbk (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/bft_doc/users_guide.qbk 2010-07-03 13:54:01 EDT (Sat, 03 Jul 2010)
@@ -9,7 +9,7 @@

[include users_guide/getting_started.qbk]
[include users_guide/tutorial.qbk]
-[include users_guide/examples.qbk]
+[/ include users_guide/examples.qbk]
[include users_guide/external_resources.qbk]
[include users_guide/glossary.qbk]
[endsect]

Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/bft_doc/users_guide/tutorial.qbk
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/bft_doc/users_guide/tutorial.qbk (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/bft_doc/users_guide/tutorial.qbk 2010-07-03 13:54:01 EDT (Sat, 03 Jul 2010)
@@ -7,4 +7,153 @@
[section Tutorial]
In this section I will walk you through step by step process about how to
create a `bitfield_tuple` and all of the different functionalities it provides.
+
+
+[h5 Part 1: The Basics]
+The `bitfield_tuple` template is included into your project including the
+following header:
+``
+#include <boost/integer/bitfield_tuple.hpp>
+``
+After the file is included you're ready to begin creating a `bitfield_tuple`.
+Here is a `struct` that, contains bitfields, that is going to be used to
+model an instance of the bitfield tuple after.
+``
+struct foo {
+ bool flag_1:1;
+ bool flag_2:1;
+ int int_1:2;
+ int int_2:2;
+};
+``
+In the next example a `bitfield_tuple` type is made to model `struct foo`'s behavior
+but reduce its storage from 4 bytes to one.
+``
+using namespace boost;
+// names used to mimic the names in struct foo.
+struct flag_1;
+struct flag_2;
+struct int_1;
+struct int_2;
+
+
+typedef bitfield_tuple<
+ storage<char>,
+ member<bool,flag_1,1>,
+ member<bool, flag_2,1>,
+ member<int, int_1,2>,
+ member<int, int_2,2>
+> bitfield_tuple_foo;
+``
+The above example may look a little confusing at first but when broken down it's
+made to be as simple as possible. `storage<char>` specifies to the
+`bitfield_tuple` template that the type which is going to be used for storage is
+a `char` type(this can be any integral type). The `member` templates read just
+like the bitfields within `struct foo`, so type, name, width in bits.
+`member<int, int_1,2>` specifies a bitfield which is of type `int`, has the name
+`int_1`, and a width of 2 bits.
+
+[h4 Part 2: Using the tuple]
+
+Here is an example of the `bitfield_tuple` accessor function. `bitfield_tuple`
+uses the similar accessor function as boost.tuple, there are two main differences
+between the accessor funciton's for `bitfield_tuple` and boost.tuple. The first
+difference is that `bitfield_tuple` doesn't return a real reference, it instead
+returns a proxy to the bitfeild that it represents. Second, the names specified
+in the above example are not just for show, they are actually used to name the
+type within the a bitfield_tuple and can be used to access them in the same
+fashion as the index relative get function.
+
+[note `get` index accessor function. The index for accessing member of
+`bitfield_tuple` is relative to the number of `members` specified inside of the
+`bitfield_tuple`'s template parameters. Other types supplied to the
+`bitfield_tuple` and not counted for the index. For instance, in the above
+example the type `storage<char>` does not effect the index of any of the members
+after it. ]
+
+
+The following example shows the two different ways that the `get` member
+funciton can be used to retrieve data from within a `bitfield_tuple` by either
+using a name or an index.
+``
+#include <boost/integer/bitfield_tuple.hpp>
+#include <iostream>
+
+using namespace boost;
+// names used to mimic the names in struct foo.
+struct flag_1;
+struct flag_2;
+struct int_1;
+struct int_2;
+
+
+typedef bitfield_tuple<
+ storage<char>,
+ member<bool,flag_1,1>,
+ member<bool, flag_2,1>,
+ member<int, int_1,2>,
+ member<int, int_2,2>
+> bitfield_tuple_foo;
+
+int main() {
+ bitfield_tuple_foo foo;
+ foo.get<flag_1>() = true; // returns the proxy to the boolean member at flag_1
+ if(foo.get<0>() ){ // get<0>() gets the member at index 0 which is the same as flag_1
+ std::cout << "flag_1 is true"<< std::endl;
+ }
+}
+``
+
+[h5 Part 3: Slightly More Advanced]
+There are ways to simplify the `bitfield_tuple_foo`'s template declaration.
+This part of the tutorial covers the additional functionalities provided by the
+`bitfield_tuple` which can be used to simplify the creation of more complex
+`bitfield_tuple`.
+
+
+
+The different templates that can be used within a `bitfield_tuple`'s template
+decalaration.
+[table
+ [
+ [Signature][Brief Description]
+ ]
+ [
+ [`filler<std::size_t>`][ Padding in bits that can be used to seperate bitfield.]
+ ]
+ [
+ [`bit_align<std::size_t>`][ Sets the offset of the first bit of the next
+bitfield supplied to a multiple of the integer supplied. ]
+ ]
+ [
+ [`flag<typename>`][ Makes a single bit width boolean `member` with a name
+supplied to as the parameter. ]
+ ]
+ [
+ [`member<typename, typename, std::size_t>`][ Used for specifying a
+member where the first parameter is the type being stored, the second is the name
+and the third is the width in bits.]
+ ]
+ [
+ [`storage<typename>`][ The type specified in this parameter is used as
+the storage. This parameter is optional and it doesn't matter where in the template
+you put it.]
+ ]
+]
+[tip Read the documentation under the class reference section for additional
+information about the templates used to create the `bitfield_tuple` type.]
+
+
+[h5 Part 4: Fusion Sequence extension]
+The `bitfield_tuple` 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 `bitfield_tuple` internally stores its fields as an associative
+array. This allows the `bitfield_tuple` to provide both index based as well as
+named `get` functions. For full documentataion of how to use boost.fusion see
+the boost.fusion documentation. For the boost.fusion features supported by
+the `bitfield_tuple` see the fusion extension documentation located in the
+reference section of the documentation.
+
+
+
[endsect]

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-07-03 13:54:01 EDT (Sat, 03 Jul 2010)
@@ -38,7 +38,6 @@
<dt><span class="section">Testing</span></dt>
</dl></dd>
<dt><span class="section">Tutorial</span></dt>
-<dt><span class="section">Example</span></dt>
<dt><span class="section"><a href="../boost_integer_bits_masks_extension/bitfield_tuple/users_guide/external_resources.html">External
Resources</a></span></dt>
<dt><span class="section">Glossary</span></dt>

Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/bits_mask/bits_mask.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/bits_mask/bits_mask.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/bits_mask/bits_mask.html 2010-07-03 13:54:01 EDT (Sat, 03 Jul 2010)
@@ -20,7 +20,7 @@
<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="id3208248"></a>
+<a name="id3255625"></a>
       <a class="link" href="bits_mask.html#bits_mask.bits_mask.description">Description</a>
     </h4>
<p>
@@ -60,7 +60,7 @@
       in the <boost/integer/bits_mask.hpp> header file.
     </p>
<a name="bits_mask.bits_mask.template_signature"></a><h4>
-<a name="id3208488"></a>
+<a name="id3255865"></a>
       <a class="link" href="bits_mask.html#bits_mask.bits_mask.template_signature">Template Signature</a>
     </h4>
<p>
@@ -130,7 +130,7 @@
</tbody>
</table></div>
<a name="bits_mask.bits_mask.interface"></a><h4>
-<a name="id3208736"></a>
+<a name="id3256113"></a>
       <a class="link" href="bits_mask.html#bits_mask.bits_mask.interface">Interface</a>
     </h4>
<p>
@@ -237,7 +237,7 @@
</tbody>
</table></div>
<a name="bits_mask.bits_mask.preconditions"></a><h4>
-<a name="id3209099"></a>
+<a name="id3256476"></a>
       <a class="link" href="bits_mask.html#bits_mask.bits_mask.preconditions">Preconditions</a>
     </h4>
<p>
@@ -336,7 +336,7 @@
</tbody>
</table></div>
<a name="bits_mask.bits_mask.examples"></a><h4>
-<a name="id3209419"></a>
+<a name="id3256796"></a>
       <a class="link" href="bits_mask.html#bits_mask.bits_mask.examples">Examples</a>
     </h4>
<p>

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-07-03 13:54:01 EDT (Sat, 03 Jul 2010)
@@ -20,7 +20,7 @@
<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="id3212544"></a>
+<a name="id3261704"></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="id3212607"></a>
+<a name="id3261767"></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="id3212763"></a>
+<a name="id3261923"></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="id3212880"></a>
+<a name="id3262040"></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,7 +88,7 @@
<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="id3212990"></a>
+<a name="id3262150"></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>
@@ -102,7 +102,7 @@
             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="id3213079"></a>
+<a name="id3262239"></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,7 +184,7 @@
</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="id3213407"></a>
+<a name="id3262567"></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>
@@ -262,7 +262,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="id3213659"></a>
+<a name="id3262819"></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 +331,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="id3213913"></a>
+<a name="id3263073"></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 +415,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="id3214137"></a>
+<a name="id3263297"></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 +503,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="id3214395"></a>
+<a name="id3263555"></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 +591,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="id3214646"></a>
+<a name="id3263806"></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,7 +675,7 @@
</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="id3214888"></a>
+<a name="id3264048"></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>
@@ -783,7 +783,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="id3215342"></a>
+<a name="id3264539"></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>

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-07-03 13:54:01 EDT (Sat, 03 Jul 2010)
@@ -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="id3218443"></a>
+<a name="id3267788"></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>

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-07-03 13:54:01 EDT (Sat, 03 Jul 2010)
@@ -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="id3218164"></a>
+<a name="id3267509"></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>

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-07-03 13:54:01 EDT (Sat, 03 Jul 2010)
@@ -31,7 +31,6 @@
<dt><span class="section">Testing</span></dt>
</dl></dd>
<dt><span class="section">Tutorial</span></dt>
-<dt><span class="section">Example</span></dt>
<dt><span class="section"><a href="users_guide/external_resources.html">External
Resources</a></span></dt>
<dt><span class="section">Glossary</span></dt>

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-07-03 13:54:01 EDT (Sat, 03 Jul 2010)
@@ -6,14 +6,14 @@
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Chapter 1. Boost.Integer Bits Masks Extension">
<link rel="up" href="../users_guide.html" title="Users Guide">
-<link rel="prev" href="example.html" title="Example">
+<link rel="prev" href="tutorial.html" title="Tutorial">
<link rel="next" href="glossary.html" title="Glossary">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="example.html"><img src="../../..//home/brian/gsoc/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../users_guide.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><a accesskey="n" href="glossary.html"><img src="../../..//home/brian/gsoc/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="tutorial.html"><img src="../../..//home/brian/gsoc/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../users_guide.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><a accesskey="n" href="glossary.html"><img src="../../..//home/brian/gsoc/boost-trunk/doc/html/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="example.html"><img src="../../..//home/brian/gsoc/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../users_guide.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><a accesskey="n" href="glossary.html"><img src="../../..//home/brian/gsoc/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="tutorial.html"><img src="../../..//home/brian/gsoc/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../users_guide.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><a accesskey="n" href="glossary.html"><img src="../../..//home/brian/gsoc/boost-trunk/doc/html/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-07-03 13:54:01 EDT (Sat, 03 Jul 2010)
@@ -45,7 +45,7 @@
             </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="id3211392"></a>
+<a name="id3258769"></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>
@@ -68,7 +68,7 @@
</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="id3211479"></a>
+<a name="id3258856"></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>
           </h6>
@@ -210,7 +210,7 @@
</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="id3211792"></a>
+<a name="id3259169"></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>
@@ -297,7 +297,7 @@
</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="id3212090"></a>
+<a name="id3259468"></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>
@@ -335,7 +335,7 @@
</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="id3212193"></a>
+<a name="id3259570"></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>
@@ -347,7 +347,7 @@
                 </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="id3212231"></a>
+<a name="id3259608"></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>
           </h6>

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-07-03 13:54:01 EDT (Sat, 03 Jul 2010)
@@ -7,13 +7,13 @@
<link rel="home" href="../../../index.html" title="Chapter 1. Boost.Integer Bits Masks Extension">
<link rel="up" href="../users_guide.html" title="Users Guide">
<link rel="prev" href="getting_started/testing.html" title="Testing">
-<link rel="next" href="example.html" title="Example">
+<link rel="next" href="external_resources.html" title="External Resources">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="getting_started/testing.html"><img src="../../..//home/brian/gsoc/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../users_guide.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><a accesskey="n" href="example.html"><img src="../../..//home/brian/gsoc/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="getting_started/testing.html"><img src="../../..//home/brian/gsoc/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../users_guide.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><a accesskey="n" href="external_resources.html"><img src="../../..//home/brian/gsoc/boost-trunk/doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
@@ -24,6 +24,258 @@
           to create a <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>
           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="id3259740"></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>
+<p>
+ The <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code> template
+ is included into your project including the following header:
+</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>
+</pre>
+<p>
+ After the file is included you're ready to begin creating a <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>. Here is a <code class="computeroutput"><span class="keyword">struct</span></code> that, contains bitfields, that is
+ going to be used to model an instance of the bitfield tuple after.
+</p>
+<pre class="programlisting"><span class="keyword">struct</span> <span class="identifier">foo</span> <span class="special">{</span>
+ <span class="keyword">bool</span> <span class="identifier">flag_1</span><span class="special">:</span><span class="number">1</span><span class="special">;</span>
+ <span class="keyword">bool</span> <span class="identifier">flag_2</span><span class="special">:</span><span class="number">1</span><span class="special">;</span>
+ <span class="keyword">int</span> <span class="identifier">int_1</span><span class="special">:</span><span class="number">2</span><span class="special">;</span>
+ <span class="keyword">int</span> <span class="identifier">int_2</span><span class="special">:</span><span class="number">2</span><span class="special">;</span>
+<span class="special">};</span>
+</pre>
+<p>
+ In the next example a <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>
+ type is made to model <code class="computeroutput"><span class="keyword">struct</span> <span class="identifier">foo</span></code>'s behavior but reduce its storage
+ from 4 bytes to one.
+</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="comment">// names used to mimic the names in struct foo.
+</span><span class="keyword">struct</span> <span class="identifier">flag_1</span><span class="special">;</span>
+<span class="keyword">struct</span> <span class="identifier">flag_2</span><span class="special">;</span>
+<span class="keyword">struct</span> <span class="identifier">int_1</span><span class="special">;</span>
+<span class="keyword">struct</span> <span class="identifier">int_2</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">char</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">flag_1</span><span class="special">,</span><span class="number">1</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">flag_2</span><span class="special">,</span><span class="number">1</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">int_1</span><span class="special">,</span><span class="number">2</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">int_2</span><span class="special">,</span><span class="number">2</span><span class="special">></span>
+<span class="special">></span> <span class="identifier">bitfield_tuple_foo</span><span class="special">;</span>
+</pre>
+<p>
+ The above example may look a little confusing at first but when broken
+ down it's made to be as simple as possible. <code class="computeroutput"><span class="identifier">storage</span><span class="special"><</span><span class="keyword">char</span><span class="special">></span></code> specifies to the <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>
+ template that the type which is going to be used for storage is a <code class="computeroutput"><span class="keyword">char</span></code> type(this can be any integral type).
+ The <code class="computeroutput"><span class="identifier">member</span></code> templates read
+ just like the bitfields within <code class="computeroutput"><span class="keyword">struct</span>
+ <span class="identifier">foo</span></code>, so type, name, width in
+ bits. <code class="computeroutput"><span class="identifier">member</span><span class="special"><</span><span class="keyword">int</span><span class="special">,</span> <span class="identifier">int_1</span><span class="special">,</span><span class="number">2</span><span class="special">></span></code>
+ specifies a bitfield which is of type <code class="computeroutput"><span class="keyword">int</span></code>,
+ has the name <code class="computeroutput"><span class="identifier">int_1</span></code>, and
+ 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="id3260390"></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>
+<p>
+ Here is an example of the <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>
+ accessor function. <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>
+ uses the similar accessor function as boost.tuple, there are two main differences
+ between the accessor funciton's for <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>
+ and boost.tuple. The first difference is that <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>
+ doesn't return a real reference, it instead returns a proxy to the bitfeild
+ that it represents. Second, the names specified in the above example are
+ not just for show, they are actually used to name the type within the a
+ bitfield_tuple and can be used to access them in the same fashion as the
+ index relative get function.
+ </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/gsoc/boost-trunk/doc/html/images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td align="left" valign="top"><p>
+ <code class="computeroutput"><span class="identifier">get</span></code> index accessor function.
+ The index for accessing member of <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>
+ is relative to the number of <code class="computeroutput"><span class="identifier">members</span></code>
+ specified inside of the <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>'s
+ template parameters. Other types supplied to the <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>
+ and not counted for the index. For instance, in the above example the
+ type <code class="computeroutput"><span class="identifier">storage</span><span class="special"><</span><span class="keyword">char</span><span class="special">></span></code>
+ does not effect the index of any of the members after it.
+ </p></td></tr>
+</table></div>
+<p>
+ The following example shows the two different ways that the <code class="computeroutput"><span class="identifier">get</span></code> member funciton can be used to retrieve
+ data from within a <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>
+ by either using a name or an index.
+</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="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">;</span>
+<span class="comment">// names used to mimic the names in struct foo.
+</span><span class="keyword">struct</span> <span class="identifier">flag_1</span><span class="special">;</span>
+<span class="keyword">struct</span> <span class="identifier">flag_2</span><span class="special">;</span>
+<span class="keyword">struct</span> <span class="identifier">int_1</span><span class="special">;</span>
+<span class="keyword">struct</span> <span class="identifier">int_2</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">char</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">flag_1</span><span class="special">,</span><span class="number">1</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">flag_2</span><span class="special">,</span><span class="number">1</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">int_1</span><span class="special">,</span><span class="number">2</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">int_2</span><span class="special">,</span><span class="number">2</span><span class="special">></span>
+<span class="special">></span> <span class="identifier">bitfield_tuple_foo</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">bitfield_tuple_foo</span> <span class="identifier">foo</span><span class="special">;</span>
+ <span class="identifier">foo</span><span class="special">.</span><span class="identifier">get</span><span class="special"><</span><span class="identifier">flag_1</span><span class="special">>()</span> <span class="special">=</span> <span class="keyword">true</span><span class="special">;</span> <span class="comment">// returns the proxy to the boolean member at flag_1
+</span> <span class="keyword">if</span><span class="special">(</span><span class="identifier">foo</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="comment">// get<0>() gets the member at index 0 which is the same as flag_1
+</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special"><<</span> <span class="string">"flag_1 is true"</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>
+</pre>
+<p>
+ </p>
+<a name="boost_integer_bits_masks_extension.bitfield_tuple.users_guide.tutorial.part_3__slightly_more_advanced"></a><h6>
+<a name="id3261094"></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>
+<p>
+ There are ways to simplify the <code class="computeroutput"><span class="identifier">bitfield_tuple_foo</span></code>'s
+ template declaration. This part of the tutorial covers the additional functionalities
+ provided by the <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>
+ which can be used to simplify the creation of more complex <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>.
+ </p>
+<p>
+ The different templates that can be used within a <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>'s
+ template decalaration.
+ </p>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ Signature
+ </p>
+ </th>
+<th>
+ <p>
+ Brief Description
+ </p>
+ </th>
+</tr></thead>
+<tbody>
+<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>
+ </p>
+ </td>
+<td>
+ <p>
+ Padding in bits that can be used to seperate 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>
+ </p>
+ </td>
+<td>
+ <p>
+ Sets the offset of the first bit of the next bitfield supplied
+ to a multiple of the integer supplied.
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">flag</span><span class="special"><</span><span class="keyword">typename</span><span class="special">></span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ Makes a single bit width boolean <code class="computeroutput"><span class="identifier">member</span></code>
+ with a name supplied to as the parameter.
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">member</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="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">></span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ Used for specifying a member where the first parameter is the
+ type being stored, the second is the name and the third is the
+ width in bits.
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">storage</span><span class="special"><</span><span class="keyword">typename</span><span class="special">></span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ The type specified in this parameter is used as the storage.
+ This parameter is optional and it doesn't matter where in the
+ template you put it.
+ </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/gsoc/boost-trunk/doc/html/images/tip.png"></td>
+<th align="left">Tip</th>
+</tr>
+<tr><td align="left" valign="top"><p>
+ Read the documentation under the class reference section for additional
+ information about the templates used to create the <code class="computeroutput"><span class="identifier">bitfield_tuple</span></code>
+ type.
+ </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="id3261473"></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
+ <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
+ documentation located in the reference section of the documentation.
+ </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
@@ -35,7 +287,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="getting_started/testing.html"><img src="../../..//home/brian/gsoc/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../users_guide.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><a accesskey="n" href="example.html"><img src="../../..//home/brian/gsoc/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="getting_started/testing.html"><img src="../../..//home/brian/gsoc/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../users_guide.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><a accesskey="n" href="external_resources.html"><img src="../../..//home/brian/gsoc/boost-trunk/doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>

Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/high_bits_mask/high_bits_maskbits.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/high_bits_mask/high_bits_maskbits.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/high_bits_mask/high_bits_maskbits.html 2010-07-03 13:54:01 EDT (Sat, 03 Jul 2010)
@@ -20,7 +20,7 @@
<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="id3206490"></a>
+<a name="id3253867"></a>
       <a class="link" href="high_bits_maskbits.html#high_bits_mask.high_bits_maskbits.description">Description</a>
     </h4>
<p>
@@ -39,7 +39,7 @@
<p>
     </p>
<a name="high_bits_mask.high_bits_maskbits.template_signature"></a><h4>
-<a name="id3206626"></a>
+<a name="id3254003"></a>
       <a class="link" href="high_bits_maskbits.html#high_bits_mask.high_bits_maskbits.template_signature">Template
       Signature</a>
     </h4>
@@ -97,7 +97,7 @@
</tbody>
</table></div>
<a name="high_bits_mask.high_bits_maskbits.interface"></a><h4>
-<a name="id3206808"></a>
+<a name="id3254185"></a>
       <a class="link" href="high_bits_maskbits.html#high_bits_mask.high_bits_maskbits.interface">Interface</a>
     </h4>
<p>
@@ -193,7 +193,7 @@
</tbody>
</table></div>
<a name="high_bits_mask.high_bits_maskbits.examples"></a><h4>
-<a name="id3207144"></a>
+<a name="id3254521"></a>
       <a class="link" href="high_bits_maskbits.html#high_bits_mask.high_bits_maskbits.examples">Examples</a>
     </h4>
<p>

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-07-03 13:54:01 EDT (Sat, 03 Jul 2010)
@@ -20,7 +20,7 @@
</h3></div></div>
<div><p class="copyright">Copyright © 2010 Brian Bartman</p></div>
<div><div class="legalnotice">
-<a name="id3156477"></a><p>
+<a name="id3203854"></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>
@@ -56,7 +56,6 @@
<dt><span class="section">Testing</span></dt>
</dl></dd>
<dt><span class="section">Tutorial</span></dt>
-<dt><span class="section">Example</span></dt>
<dt><span class="section"><a href="boost_integer_bits_masks_extension/bitfield_tuple/users_guide/external_resources.html">External
         Resources</a></span></dt>
<dt><span class="section">Glossary</span></dt>
@@ -116,7 +115,7 @@
   </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: July 03, 2010 at 16:47:29 GMT</small></p></td>
+<td align="left"><p><small>Last revised: July 03, 2010 at 17:49:27 GMT</small></p></td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>

Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/integral_mask/integral_mask.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/integral_mask/integral_mask.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/integral_mask/integral_mask.html 2010-07-03 13:54:01 EDT (Sat, 03 Jul 2010)
@@ -20,7 +20,7 @@
<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="id3155131"></a>
+<a name="id3202508"></a>
       <a class="link" href="integral_mask.html#integral_mask.integral_mask.description">Description</a>
     </h4>
<p>
@@ -31,7 +31,7 @@
       template is located in the following header file: <boost/integer/integral_mask.hpp>.
     </p>
<a name="integral_mask.integral_mask.template_signature"></a><h4>
-<a name="id3155191"></a>
+<a name="id3202568"></a>
       <a class="link" href="integral_mask.html#integral_mask.integral_mask.template_signature">Template Signature</a>
     </h4>
<p>
@@ -89,7 +89,7 @@
</tbody>
</table></div>
<a name="integral_mask.integral_mask.interface"></a><h4>
-<a name="id3205907"></a>
+<a name="id3253284"></a>
       <a class="link" href="integral_mask.html#integral_mask.integral_mask.interface">Interface</a>
     </h4>
<p>
@@ -175,7 +175,7 @@
</tbody>
</table></div>
<a name="integral_mask.integral_mask.examples"></a><h4>
-<a name="id3206249"></a>
+<a name="id3253626"></a>
       <a class="link" href="integral_mask.html#integral_mask.integral_mask.examples">Examples</a>
     </h4>
<p>

Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/low_bits_mask/low_bits_mask.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/low_bits_mask/low_bits_mask.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/low_bits_mask/low_bits_mask.html 2010-07-03 13:54:01 EDT (Sat, 03 Jul 2010)
@@ -20,7 +20,7 @@
<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="id3207367"></a>
+<a name="id3254744"></a>
       <a class="link" href="low_bits_mask.html#low_bits_mask.low_bits_mask.description">Description</a>
     </h4>
<p>
@@ -43,7 +43,7 @@
       is located in the <boost/integer/low_bits_mask.hpp> header file.
     </p>
<a name="low_bits_mask.low_bits_mask.template_signature"></a><h4>
-<a name="id3207501"></a>
+<a name="id3254878"></a>
       <a class="link" href="low_bits_mask.html#low_bits_mask.low_bits_mask.template_signature">Template Signature</a>
     </h4>
<p>
@@ -100,7 +100,7 @@
</tbody>
</table></div>
<a name="low_bits_mask.low_bits_mask.interface"></a><h4>
-<a name="id3207681"></a>
+<a name="id3255058"></a>
       <a class="link" href="low_bits_mask.html#low_bits_mask.low_bits_mask.interface">Interface</a>
     </h4>
<p>
@@ -195,7 +195,7 @@
</tbody>
</table></div>
<a name="low_bits_mask.low_bits_mask.examples"></a><h4>
-<a name="id3208025"></a>
+<a name="id3255402"></a>
       <a class="link" href="low_bits_mask.html#low_bits_mask.low_bits_mask.examples">Examples</a>
     </h4>
<p>

Modified: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/rationale/rationale.html
==============================================================================
--- sandbox/SOC/2010/bit_masks/lib/integer/doc/html/rationale/rationale.html (original)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/rationale/rationale.html 2010-07-03 13:54:01 EDT (Sat, 03 Jul 2010)
@@ -46,7 +46,7 @@
       accessors to the data stored within.
     </p>
<a name="rationale.rationale.project_data_structure_motivation_and_rationale"></a><h4>
-<a name="id3220046"></a>
+<a name="id3269391"></a>
       <a class="link" href="rationale.html#rationale.rationale.project_data_structure_motivation_and_rationale">Project
       Data Structure Motivation and Rationale</a>
     </h4>

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