Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r63698 - in sandbox/SOC/2010/bit_masks/lib/integer/doc/html: bits_mask/masks integral_mask/masks
From: bbartmanboost_at_[hidden]
Date: 2010-07-06 10:43:09

Author: bbartman
Date: 2010-07-06 10:43:07 EDT (Tue, 06 Jul 2010)
New Revision: 63698
URL: http://svn.boost.org/trac/boost/changeset/63698

Log:
working on fixing my documentation so that everything gets added to the correct place and I make sure that there are no dead links
Added:
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/bits_mask/masks/
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/bits_mask/masks/bits_mask.html (contents, props changed)
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/integral_mask/masks/
   sandbox/SOC/2010/bit_masks/lib/integer/doc/html/integral_mask/masks/integral_mask.html (contents, props changed)

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/bits_mask/masks/bits_mask.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/bits_mask/masks/bits_mask.html 2010-07-06 10:43:07 EDT (Tue, 06 Jul 2010)
@@ -0,0 +1,426 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>bits_mask</title>
+<link rel="stylesheet" href="../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="Chapter 1. Boost.Integer Bits Masks Extension">
+<link rel="up" href="../../boost_integer_bits_masks_extension/masks.html" title="Masks">
+<link rel="prev" href="../../low_bits_mask/masks/low_bits_mask.html" title="low_bits_mask">
+<link rel="next" href="../../bitfield_tuple/bitfield_tuple.html" title="bitfield_tuple">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../../low_bits_mask/masks/low_bits_mask.html"><img src="../..//home/brian/gsoc/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_integer_bits_masks_extension/masks.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="../../bitfield_tuple/bitfield_tuple.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><h3 class="title">
+<a name="bits_mask.masks.bits_mask"></a><a class="link" href="bits_mask.html" title="bits_mask"> bits_mask</a>
+</h3></div></div></div>
+<a name="bits_mask.masks.bits_mask.description"></a><h4>
+<a name="id2855611"></a>
+ <a class="link" href="bits_mask.html#bits_mask.masks.bits_mask.description">Description</a>
+ </h4>
+
+ The <code class="computeroutput">bits_mask</code> template provides
+ an extention to the <code class="computeroutput">low_bits_mask</code>
+ template, by incorporating an <code class="computeroutput">Offset</code>
+ with the template. The <code class="computeroutput">offest</code>
+ is always relative to the right most bit, or bit 0. For a basic view of how
+ <code class="computeroutput">bits_mask</code> works consider
+ the following examples:
+ 
+
+
+
+<pre class="programlisting">typedef bits_mask<int, 10, 3> mask;
+// mask::value has the following binary value
+// 0000 0000 0000 0000 0001 1100 0000 0000
+</pre>
+
+ For simplicity there is a defualt parameter for <code class="computeroutput">Width</code>
+ giving it a value of <code class="computeroutput">1</code>. This
+ makes writing of normally left or right shift masks simple and staticly checkable.
+ For example,
+ 
+
+
+
+<pre class="programlisting">// If one would need to create a mask for checking the 11th bit within an
+// integer it can be done simple with the following mask
+typedef bits_mask<int,11> mask;
+// this creates a mask at the 11th bit within an integer.
+</pre>
+
+ 
+
+ The <code class="computeroutput">bits_mask</code> template is
+ located in the <boost/integer/bits_mask.hpp> header file.
+ 
+<a name="bits_mask.masks.bits_mask.template_signature"></a><h4>
+<a name="id2855854"></a>
+ <a class="link" href="bits_mask.html#bits_mask.masks.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.masks.bits_mask.interface"></a><h4>
+<a name="id2856102"></a>
+ <a class="link" href="bits_mask.html#bits_mask.masks.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.masks.bits_mask.preconditions"></a><h4>
+<a name="id2856466"></a>
+ <a class="link" href="bits_mask.html#bits_mask.masks.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.masks.bits_mask.examples"></a><h4>
+<a name="id2856788"></a>
+ <a class="link" href="bits_mask.html#bits_mask.masks.bits_mask.examples">Examples</a>
+ </h4>
+
+ Examples and use cases related to the <code class="computeroutput">bits_mask</code>
+ template.
+ 
+
+ Example:
+ 
+
+ Single bit mask using the default parameter for width.
+
+<pre class="programlisting">typedef bits_mask< int, 0 > mask;
+// mask in this case has the following value
+// 0000 0000 0000 0000 0000 0000 0000 0001
+
+int some_bit_value = 0xdeadbeef;
+
+// now testing to see if the zero bit is set in some_bit_value
+if(some_bit_value & mask() ) {
+ ...
+ true case
+ ...
+} else {
+ ...
+ false case
+ ...
+}
+</pre>
+
+ 
+
+ Here is another case where the <code class="computeroutput">bits_mask</code>
+ template is used used similar to a bit field. The goal in this case would
+ be to extract a single value from within an integral storage type, which
+ may be storing one or more values.
+ 
+
+
+
+<pre class="programlisting">typedef bits_mask<int,10,3> mask;
+// binary value of mask
+// 0000 0000 0000 0000 0001 1111 1111 1000
+
+// this will then be used to retrieve a value within an integer.
+int some_bit_value = 0xdeadbeef;
+// binary value of some_bit_value
+// 1101 1110 1010 1011 1011 1110 1110 1111
+
+// now to extract the value from within some_bit_value
+int new_int_value = ( some_bit_value & mask() ) >> mask::offset;
+
+// basic operations taking place.
+// 1101 1110 1010 1011 1011 1110 1110 1111 <- some_bit_value
+// 0000 0000 0000 0000 0001 1111 1111 1000 <- mask::value
+
+// preforming bitwise and operator.
+
+// 0000 0000 0000 0000 0001 1110 1110 1000 <- result of bitwise and operator
+// preform right shift operation.
+// 0000 0000 0000 0000 0000 0011 1101 1101 <- value of new_int_value.
+</pre>
+
+ 
+
+ The implicit cast operator allows for simplicity, 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/masks/low_bits_mask.html"><img src="../..//home/brian/gsoc/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_integer_bits_masks_extension/masks.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="../../bitfield_tuple/bitfield_tuple.html"><img src="../..//home/brian/gsoc/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>

Added: sandbox/SOC/2010/bit_masks/lib/integer/doc/html/integral_mask/masks/integral_mask.html
==============================================================================
--- (empty file)
+++ sandbox/SOC/2010/bit_masks/lib/integer/doc/html/integral_mask/masks/integral_mask.html 2010-07-06 10:43:07 EDT (Tue, 06 Jul 2010)
@@ -0,0 +1,227 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>integral_mask type</title>
+<link rel="stylesheet" href="../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="Chapter 1. Boost.Integer Bits Masks Extension">
+<link rel="up" href="../../boost_integer_bits_masks_extension/masks.html" title="Masks">
+<link rel="prev" href="../../boost_integer_bits_masks_extension/masks/bit_mask_purpose.html" title="Purpose">
+<link rel="next" href="../../high_bits_mask/masks/high_bits_maskbits.html" title="high_bits_mask">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../../boost_integer_bits_masks_extension/masks/bit_mask_purpose.html"><img src="../..//home/brian/gsoc/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_integer_bits_masks_extension/masks.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="../../high_bits_mask/masks/high_bits_maskbits.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><h3 class="title">
+<a name="integral_mask.masks.integral_mask"></a><a class="link" href="integral_mask.html" title="integral_mask type"> integral_mask type</a>
+</h3></div></div></div>
+<a name="integral_mask.masks.integral_mask.description"></a><h4>
+<a name="id2802487"></a>
+ <a class="link" href="integral_mask.html#integral_mask.masks.integral_mask.description">Description</a>
+ </h4>
+
+ The <code class="computeroutput">integral_mask</code> type is
+ the most basic mask type. It is used to abstract all masks back to a simple
+ integral type. This type is used similar to an <code class="computeroutput">integral_constant</code>
+ type from the boost.type_traits library. The <code class="computeroutput">integral_mask</code>
+ template is located in the following header file: <boost/integer/integral_mask.hpp>.
+ 
+<a name="integral_mask.masks.integral_mask.template_signature"></a><h4>
+<a name="id2802546"></a>
+ <a class="link" href="integral_mask.html#integral_mask.masks.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.masks.integral_mask.interface"></a><h4>
+<a name="id2853261"></a>
+ <a class="link" href="integral_mask.html#integral_mask.masks.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.masks.integral_mask.examples"></a><h4>
+<a name="id2853605"></a>
+ <a class="link" href="integral_mask.html#integral_mask.masks.integral_mask.examples">Examples</a>
+ </h4>
+
+ Examples and use cases related to the <code class="computeroutput">integral_mask</code>
+ template.
+ 
+
+ Example:
+
+<pre class="programlisting">int bits = 255;
+
+typedef integral_mask<int, 16> mask;
+// mask has the folling binary value
+// 0000 0000 0000 0000 0000 0000 0001 0110
+
+// bits has binary value of:
+// 0000 0000 0000 0000 0000 0000 0010 0101
+
+// the following is a bitwise and operation
+// which is done to bits using the integral_mask type
+int new_bits = bits & mask();
+
+// Resulting value of new_bits:
+// 0000 0000 0000 0000 0000 0000 0000 0100
+
+
+</pre>
+
+ The implicit cast operator allows for simplicity, clairity of code. In the
+ above example <code class="computeroutput">mask()</code>
+ could be replaced with <code class="computeroutput">mask::value</code>
+ to achieve the same result. The same applies to all other bitwise operators.
+ 
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2010 Brian Bartman
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../../boost_integer_bits_masks_extension/masks/bit_mask_purpose.html"><img src="../..//home/brian/gsoc/boost-trunk/doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_integer_bits_masks_extension/masks.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="../../high_bits_mask/masks/high_bits_maskbits.html"><img src="../..//home/brian/gsoc/boost-trunk/doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</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