Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r64020 - in sandbox/SOC/2010/bits_and_ints/libs/integer/doc: . html html/boost_integer
From: muriloufg_at_[hidden]
Date: 2010-07-14 15:50:32

Next message: vicente.botet_at_[hidden]: "[Boost-commit] svn:boost r64021 - sandbox/bitfield/boost/integer"
Previous message: muriloufg_at_[hidden]: "[Boost-commit] svn:boost r64019 - sandbox/SOC/2010/bits_and_ints/libs/integer/doc"

Author: murilov
Date: 2010-07-14 15:50:31 EDT (Wed, 14 Jul 2010)
New Revision: 64020
URL: http://svn.boost.org/trac/boost/changeset/64020

Log:
Added the ilog2 function documentation.
Text files modified:
   sandbox/SOC/2010/bits_and_ints/libs/integer/doc/bits_and_ints.qbk | 21 +
   sandbox/SOC/2010/bits_and_ints/libs/integer/doc/html/boost_integer/bits_and_ints.html | 411 ++++++++++++++++++++-------------------
   sandbox/SOC/2010/bits_and_ints/libs/integer/doc/html/boost_integer/history.html | 4
   sandbox/SOC/2010/bits_and_ints/libs/integer/doc/html/index.html | 2
   4 files changed, 230 insertions(+), 208 deletions(-)

Modified: sandbox/SOC/2010/bits_and_ints/libs/integer/doc/bits_and_ints.qbk
==============================================================================
--- sandbox/SOC/2010/bits_and_ints/libs/integer/doc/bits_and_ints.qbk (original)
+++ sandbox/SOC/2010/bits_and_ints/libs/integer/doc/bits_and_ints.qbk 2010-07-14 15:50:31 EDT (Wed, 14 Jul 2010)
@@ -1,7 +1,9 @@
[section:bits_and_ints Bits and Ints]

[section Overview]
-The intent of this library is to extend Boost.Integer with fast integer algorithms and utilities. This library can be included via [@../../../../boost/integer/bits_and_ints.hpp <boost/integer/bits_and_ints.hpp>].
+The intent of this library is to extend Boost.Integer with fast integer algorithms and utilities.
+The motivation for this library is to provide integer algorithms and utilities optimized by doing binary manipulations so that it uses less CPU cycles, memory access and conditional branches. This library contains some classical integer algorithms such as population count, reversing bits, sign extension and bit interleaving.
+This library can be included via [@../../../../boost/integer/bits_and_ints.hpp <boost/integer/bits_and_ints.hpp>].
[endsect]

[section Absolute Value in Compile-Time ]
@@ -380,6 +382,23 @@

[endsect]

+[section Integer Logarithm Base 2 (ilog2 function) ]
+The header file [@../../../../boost/integer/ilog2.hpp <boost/integer/ilog2.hpp>] defines `ilog2`
+function wich calculates the logarithm in base two of a given integral value.
+
+[section Synopsis]
+
+ template <typename T>
+ inline T ilog2(T value);
+
+[endsect]
+
+*[*Remarks: ] If `value` is 0, the result is [*undefined].
+*[*Requires: ] `T` to be an integral type.
+*[*Returns: ] The integer logarithm in base 2 of `value` rounded down.
+
+[endsect]
+
[section `is_integral_constant<>` metafunction ]
The header file [@../../../../boost/integer/is_integral_constant.hpp <boost/integer/is_integral_constant.hpp>] defines
`is_integral_constant<>` static metafunction wich verifies if an given template parameter is or not a `mpl::integral_c<>`.

Modified: sandbox/SOC/2010/bits_and_ints/libs/integer/doc/html/boost_integer/bits_and_ints.html
==============================================================================
--- sandbox/SOC/2010/bits_and_ints/libs/integer/doc/html/boost_integer/bits_and_ints.html (original)
+++ sandbox/SOC/2010/bits_and_ints/libs/integer/doc/html/boost_integer/bits_and_ints.html 2010-07-14 15:50:31 EDT (Wed, 14 Jul 2010)
@@ -41,6 +41,8 @@
 Trailing Zeros</a></dt>
<dt><a href="bits_and_ints.html#boost_integer.bits_and_ints.greatest_common_divisor_">Greatest
 Common Divisor </a></dt>
+<dt><a href="bits_and_ints.html#boost_integer.bits_and_ints.integer_logarithm_base_2__ilog2_function__">Integer
+ Logarithm Base 2 (ilog2 function) </a></dt>
<dt><a href="bits_and_ints.html#boost_integer.bits_and_ints._is_integral_constant____metafunction_"><code class="computeroutput">is_integral_constant<></code>
 metafunction </a></dt>
<dt><a href="bits_and_ints.html#boost_integer.bits_and_ints.least_common_multiple_">Least
@@ -64,7 +66,11 @@
</h3></div></div></div>

 The intent of this library is to extend Boost.Integer with fast integer algorithms
- and utilities. This library can be included via <boost/integer/bits_and_ints.hpp>.
+ and utilities. The motivation for this library is to provide integer algorithms
+ and utilities optimized by doing binary manipulations so that it uses less
+ CPU cycles, memory access and conditional branches. This library contains
+ some classical integer algorithms such as population count, reversing bits,
+ sign extension and bit interleaving. This library can be included via <boost/integer/bits_and_ints.hpp>.
 
</div>
<div class="section" title="Absolute Value in Compile-Time">
@@ -325,7 +331,7 @@
</li>
<li class="listitem">Example:</li>
</ul></div>
-<pre class="programlisting">BOOST_STATIC_ASSERT((flip_bit<int, 10, 2>::value == 14));
+<pre class="programlisting">BOOST_STATIC_ASSERT((flip_bit<int, 10, 2>::value == 14 ));
</pre>
</div>
<div class="section" title="Runtime version">
@@ -432,10 +438,10 @@
<div class="toc"><dl>
<dt><a href="bits_and_ints.html#boost_integer.bits_and_ints.bit_reversal.non_member_function__bit_reversal_">Non-Member
 Function <code class="computeroutput">bit_reversal</code></a></dt>
-<dt><a href="bits_and_ints.html#boost_integer.bits_and_ints.bit_reversal.template_class__static_bit_reversal___">Template
- Class <code class="computeroutput">static_bit_reversal<></code></a></dt>
<dt><a href="bits_and_ints.html#boost_integer.bits_and_ints.bit_reversal.template_class__mpl__bit_reversal___">Template
 Class <code class="computeroutput">mpl::bit_reversal<></code></a></dt>
+<dt><a href="bits_and_ints.html#boost_integer.bits_and_ints.bit_reversal.template_class__static_bit_reversal___">Template
+ Class <code class="computeroutput">static_bit_reversal<></code></a></dt>
<dt>Examples</dt>
</dl></div>

@@ -497,20 +503,18 @@
 </li>
</ul></div>
</div>
-<div class="section" title="Template Class static_bit_reversal<>">
+<div class="section" title="Template Class mpl::bit_reversal<>">
<div class="titlepage"><div><div><h4 class="title">
-<a name="boost_integer.bits_and_ints.bit_reversal.template_class__static_bit_reversal___"></a><a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.bit_reversal.template_class__static_bit_reversal___" title="Template Class static_bit_reversal<>">Template
- Class <code class="computeroutput">static_bit_reversal<></code></a>
+<a name="boost_integer.bits_and_ints.bit_reversal.template_class__mpl__bit_reversal___"></a><a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.bit_reversal.template_class__mpl__bit_reversal___" title="Template Class mpl::bit_reversal<>">Template
+ Class <code class="computeroutput">mpl::bit_reversal<></code></a>
</h4></div></div></div>

- The compile-time version can be included via <boost/integer/static_bit_reversal.hpp>.
+ The MPL version can be included via <boost/integer/static_bit_reversal.hpp>.
 The result will be in <code class="computeroutput">value</code>
 member.
 
-<pre class="programlisting">template <typename T, T Value>
-struct static_bit_reversal {
- static const T value = implementation-defined;
-};
+<pre class="programlisting">template <typename IC>
+struct mpl::bit_reversal : mpl::integral_c<typename IC::value_type, implementation-defined> {};
</pre>
<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">Template Parameters</li></ul></div>
<div class="informaltable"><table class="table">
@@ -530,52 +534,38 @@
 
 </th>
</tr></thead>
-<tbody>
-<tr>
-<td>
- 
- <code class="computeroutput">T</code>
- 
- </td>
-<td>
- 
- The data type.
- 
- </td>
-</tr>
-<tr>
+<tbody><tr>
<td>
 
- <code class="computeroutput">Value</code>
+ <code class="computeroutput">IC</code>
 
 </td>
<td>
 
- The data to be reversed.
+ A <code class="computeroutput">mpl::integral_c<></code>
+ type wich holds an integral constant to be reversed.
 
 </td>
-</tr>
-</tbody>
+</tr></tbody>
</table></div>
<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
-Requires: <code class="computeroutput">T</code>
- must be an integral type.
+Requires: <code class="computeroutput">IC</code>
+ must be an <code class="computeroutput">mpl::integral_c<></code>
+ type.
 </li></ul></div>
</div>
-<div class="section" title="Template Class mpl::bit_reversal<>">
+<div class="section" title="Template Class static_bit_reversal<>">
<div class="titlepage"><div><div><h4 class="title">
-<a name="boost_integer.bits_and_ints.bit_reversal.template_class__mpl__bit_reversal___"></a><a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.bit_reversal.template_class__mpl__bit_reversal___" title="Template Class mpl::bit_reversal<>">Template
- Class <code class="computeroutput">mpl::bit_reversal<></code></a>
+<a name="boost_integer.bits_and_ints.bit_reversal.template_class__static_bit_reversal___"></a><a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.bit_reversal.template_class__static_bit_reversal___" title="Template Class static_bit_reversal<>">Template
+ Class <code class="computeroutput">static_bit_reversal<></code></a>
</h4></div></div></div>

- The MPL version can be included via <boost/integer/static_bit_reversal.hpp>.
+ The compile-time version can be included via <boost/integer/static_bit_reversal.hpp>.
 The result will be in <code class="computeroutput">value</code>
 member.
 
-<pre class="programlisting">template <typename IC>
-struct mpl::bit_reversal {
- static const T value = implementation-defined;
-};
+<pre class="programlisting">template <typename T, T Value>
+struct static_bit_reversal : mpl::bit_reversal< mpl::integral_c<T, Value> > {};
</pre>
<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">Template Parameters</li></ul></div>
<div class="informaltable"><table class="table">
@@ -595,24 +585,36 @@
 
 </th>
</tr></thead>
-<tbody><tr>
+<tbody>
+<tr>
<td>
 
- <code class="computeroutput">IC</code>
+ <code class="computeroutput">T</code>
 
 </td>
<td>
 
- A <code class="computeroutput">mpl::integral_c<></code>
- type wich holds an integral constant to be reversed.
+ The data type.
 
 </td>
-</tr></tbody>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">Value</code>
+ 
+ </td>
+<td>
+ 
+ The data to be reversed.
+ 
+ </td>
+</tr>
+</tbody>
</table></div>
<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
-Requires: <code class="computeroutput">IC</code>
- must be an <code class="computeroutput">mpl::integral_c<></code>
- type.
+Requires: <code class="computeroutput">T</code>
+ must be an integral type.
 </li></ul></div>
</div>
<div class="section" title="Examples">
@@ -626,14 +628,8 @@

int main()
{
- // data = 0101 0101
- uint8_t data = 0x55;
-
- uint8_t result = boost::bit_reversal(data);
-
- // will print 0xaa (1010 1010)
- std::cout << std::hex << result << std::endl; // -1
-}
+ BOOST_ASSERT((boost::bit_reversal(0x55) == 0xAA));
+}
</pre>
</li>
<li class="listitem">
@@ -641,12 +637,8 @@
#include <iostream>

int main()
-{
- // 0x30A5 == 0011 0000 1010 0101
- uint16_t result = boost::static_sign_extend<uint16_t, 0x30A5>::value;
-
- // will print 0x5A0B
- std::cout << std::hex << result << std::endl;
+{
+ BOOST_STATIC_ASSERT((boost::static_bit_reversal<uint16_t, 0x30A5>::value == 0xA50C));
}
</pre>
</li>
@@ -670,10 +662,10 @@
T clear_least_bit_set(T value);

template <typename IC>
-struct mpl::clear_least_bit_set { static const typename IC::value_type value = implementation-defined; };
+struct mpl::clear_least_bit_set mpl::integral_c<typename IC::value_type, implementation-defined> {};

template <typename T, T Value>
-struct static_clear_least_bit_set { static const T value = implementation-defined; };
+struct static_clear_least_bit_set : mpl::clear_least_bit_set< mpl::integral_c<T, Value> > {};
</pre>
</div>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
@@ -738,10 +730,10 @@
<pre class="programlisting">int count_trailing_zeros(uintmax_t value);

template <typename IC>
-struct mpl::count_trailing_zeros { static const int value = implementation-defined; };
+struct mpl::count_trailing_zeros : mpl::integral_c<typename IC::value_type, implementation-defined> {};

template <uintmax_t Value>
-struct static_count_trailing_zeros { static const int value = implementation-defined; };
+struct static_count_trailing_zeros : mpl::count_trailing_zeros< mpl::integral_c<uintmax_t, Value> > {};
</pre>
</div>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
@@ -777,7 +769,7 @@
<a name="boost_integer.bits_and_ints.greatest_common_divisor_.synopsis"></a><a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.greatest_common_divisor_.synopsis" title="Synopsis">Synopsis</a>
</h4></div></div></div>
<pre class="programlisting">template <typename ICT1, typename ICT2>
-struct mpl::gcd { static const uintmax_t value = implementation-defined; };
+struct mpl::gcd : mpl::integral_c<typename ICT1::value_type, implementation-defined> {};
</pre>
</div>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
@@ -793,6 +785,40 @@
 </li>
</ul></div>
</div>
+<div class="section" title="Integer Logarithm Base 2 (ilog2 function)">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_integer.bits_and_ints.integer_logarithm_base_2__ilog2_function__"></a><a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.integer_logarithm_base_2__ilog2_function__" title="Integer Logarithm Base 2 (ilog2 function)">Integer
+ Logarithm Base 2 (ilog2 function) </a>
+</h3></div></div></div>
+<div class="toc"><dl><dt>Synopsis</dt></dl></div>
+
+ The header file <boost/integer/ilog2.hpp>
+ defines <code class="computeroutput">ilog2</code> function wich
+ calculates the logarithm in base two of a given integral value.
+ 
+<div class="section" title="Synopsis">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_integer.bits_and_ints.integer_logarithm_base_2__ilog2_function__.synopsis"></a><a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.integer_logarithm_base_2__ilog2_function__.synopsis" title="Synopsis">Synopsis</a>
+</h4></div></div></div>
+<pre class="programlisting">template <typename T>
+inline T ilog2(T value);
+</pre>
+</div>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+Remarks: If <code class="computeroutput">value</code>
+ is 0, the result is undefined.
+ </li>
+<li class="listitem">
+Requires: <code class="computeroutput">T</code>
+ to be an integral type.
+ </li>
+<li class="listitem">
+Returns: The integer logarithm in base
+ 2 of <code class="computeroutput">value</code> rounded down.
+ </li>
+</ul></div>
+</div>
<div class="section" title="is_integral_constant<> metafunction">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_integer.bits_and_ints._is_integral_constant____metafunction_"></a><a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints._is_integral_constant____metafunction_" title="is_integral_constant<> metafunction"><code class="computeroutput">is_integral_constant<></code>
@@ -809,7 +835,7 @@
<a name="boost_integer.bits_and_ints._is_integral_constant____metafunction_.synopsis"></a><a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints._is_integral_constant____metafunction_.synopsis" title="Synopsis">Synopsis</a>
</h4></div></div></div>
<pre class="programlisting">template <typename IC>
-struct is_integral_constant { implementation-defined };
+struct is_integral_constant : and_<implementation-defined> {};
</pre>
</div>
<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
@@ -843,7 +869,7 @@
<a name="boost_integer.bits_and_ints.least_common_multiple_.synopsis"></a><a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.least_common_multiple_.synopsis" title="Synopsis">Synopsis</a>
</h4></div></div></div>
<pre class="programlisting">template <typename ICT1, typename ICT2>
-struct mpl::lcm { static const uintmax_t value = implementation-defined; };
+struct mpl::lcm : integral_c<typename ICT1::value_type, implementation-defined> {};
</pre>
</div>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
@@ -880,7 +906,7 @@
struct static_pop_count { static const int value = implementation-defined; };

template <typename IC>
-struct pop_count { static const int value = implementation-defined; };
+struct mpl::pop_count : mpl::integral_c<typename IC::value_type, static_pop_count<IC::value>::value> {};
</pre>
</div>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
@@ -961,10 +987,10 @@
T safe_avg(T x, T y);

template <typename ICT1, typename ICT2>
-struct mpl::safe_avg { static const int value = implementation-defined; };
+struct mpl::safe_avg : mpl::integral_c<typename ICT1::value_type, implementation-defined> {};

template <typename T, T Value1, T Value2>
-struct static_safe_avg { static const int value = implementation-defined; };
+struct static_safe_avg : mpl::safe_avg< T, mpl::integral_c<T, Value1>, mpl::integral_c<T, Value1> > {};
</pre>
</div>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
@@ -986,10 +1012,10 @@
<div class="toc"><dl>
<dt><a href="bits_and_ints.html#boost_integer.bits_and_ints.same_sign.non_member_function__same_sign_">Non-Member
 Function <code class="computeroutput">same_sign</code></a></dt>
-<dt><a href="bits_and_ints.html#boost_integer.bits_and_ints.same_sign.template_class__static_same_sign___">Template
- Class <code class="computeroutput">static_same_sign<></code></a></dt>
<dt><a href="bits_and_ints.html#boost_integer.bits_and_ints.same_sign.template_class__mpl__same_sign___">Template
 Class <code class="computeroutput">mpl::same_sign<></code></a></dt>
+<dt><a href="bits_and_ints.html#boost_integer.bits_and_ints.same_sign.template_class__static_same_sign___">Template
+ Class <code class="computeroutput">static_same_sign<></code></a></dt>
<dt>Examples</dt>
</dl></div>

@@ -1052,21 +1078,18 @@
 </li>
</ul></div>
</div>
-<div class="section" title="Template Class static_same_sign<>">
+<div class="section" title="Template Class mpl::same_sign<>">
<div class="titlepage"><div><div><h4 class="title">
-<a name="boost_integer.bits_and_ints.same_sign.template_class__static_same_sign___"></a><a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.same_sign.template_class__static_same_sign___" title="Template Class static_same_sign<>">Template
- Class <code class="computeroutput">static_same_sign<></code></a>
+<a name="boost_integer.bits_and_ints.same_sign.template_class__mpl__same_sign___"></a><a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.same_sign.template_class__mpl__same_sign___" title="Template Class mpl::same_sign<>">Template
+ Class <code class="computeroutput">mpl::same_sign<></code></a>
</h4></div></div></div>

- The compile-time version can be included via <boost/integer/static_same_sign.hpp>.
+ The MPL version can be included via <boost/integer/static_same_sign.hpp>.
 The result will be in <code class="computeroutput">value</code>
 member.
 
-<pre class="programlisting">template <typename T, T Value1, T Value2>
-struct static_same_sign
-{
- static const bool value = implementation-defined;
-};
+<pre class="programlisting">template <typename IC1, typename IC2>
+struct mpl::same_sign : mpl::bool_<implementation-defined> {};
</pre>
<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">Template Parameters:</li></ul></div>
<div class="informaltable"><table class="table">
@@ -1086,53 +1109,38 @@
 
 </th>
</tr></thead>
-<tbody>
-<tr>
-<td>
- 
- <code class="computeroutput">T</code>
- 
- </td>
-<td>
- 
- The data type.
- 
- </td>
-</tr>
-<tr>
+<tbody><tr>
<td>
 
- <code class="computeroutput">Value1</code>, <code class="computeroutput">Value2</code>
+ <code class="computeroutput">IC1</code>, <code class="computeroutput">IC2</code>
 
 </td>
<td>
 
- The two integral values to be compared.
+ The two <code class="computeroutput">mpl::integral_c<></code>
+ to be compared.
 
 </td>
-</tr>
-</tbody>
+</tr></tbody>
</table></div>
<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
-Requires: <code class="computeroutput">T</code>
- must be an integral type.
+Requires: <code class="computeroutput">IC1</code>
+ and <code class="computeroutput">IC2</code> must be <code class="computeroutput">mpl::integral_c<></code>
+ types.
 </li></ul></div>
</div>
-<div class="section" title="Template Class mpl::same_sign<>">
+<div class="section" title="Template Class static_same_sign<>">
<div class="titlepage"><div><div><h4 class="title">
-<a name="boost_integer.bits_and_ints.same_sign.template_class__mpl__same_sign___"></a><a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.same_sign.template_class__mpl__same_sign___" title="Template Class mpl::same_sign<>">Template
- Class <code class="computeroutput">mpl::same_sign<></code></a>
+<a name="boost_integer.bits_and_ints.same_sign.template_class__static_same_sign___"></a><a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.same_sign.template_class__static_same_sign___" title="Template Class static_same_sign<>">Template
+ Class <code class="computeroutput">static_same_sign<></code></a>
</h4></div></div></div>

- The MPL version can be included via <boost/integer/static_same_sign.hpp>.
+ The compile-time version can be included via <boost/integer/static_same_sign.hpp>.
 The result will be in <code class="computeroutput">value</code>
 member.
 
-<pre class="programlisting">template <typename IC1, typename IC2>
-struct mpl::same_sign
-{
- static const bool value = implementation-defined;
-};
+<pre class="programlisting">template <typename T, T Value1, T Value2>
+struct static_same_sign : mpl::same_sign< mpl::integral_c<T, Value1>, mpl::integral_c<T, Value2> > {};
</pre>
<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">Template Parameters:</li></ul></div>
<div class="informaltable"><table class="table">
@@ -1152,24 +1160,36 @@
 
 </th>
</tr></thead>
-<tbody><tr>
+<tbody>
+<tr>
<td>
 
- <code class="computeroutput">IC1</code>, <code class="computeroutput">IC2</code>
+ <code class="computeroutput">T</code>
 
 </td>
<td>
 
- The two <code class="computeroutput">mpl::integral_c<></code>
- to be compared.
+ The data type.
 
 </td>
-</tr></tbody>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">Value1</code>, <code class="computeroutput">Value2</code>
+ 
+ </td>
+<td>
+ 
+ The two integral values to be compared.
+ 
+ </td>
+</tr>
+</tbody>
</table></div>
<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
-Requires: <code class="computeroutput">IC1</code>
- and <code class="computeroutput">IC2</code> must be <code class="computeroutput">mpl::integral_c<></code>
- types.
+Requires: <code class="computeroutput">T</code>
+ must be an integral type.
 </li></ul></div>
</div>
<div class="section" title="Examples">
@@ -1185,12 +1205,10 @@
{
 int first = -1, second = -2, third = 1;

- bool result = boost::same_sign(first, second);
- std::cout << result << std::endl; // true
-
- result = boost::same_sign(first, third);
- std::cout << result << std::endl; // false
-}
+ BOOST_ASSERT((boost::same_sign(first, second) == true));
+ BOOST_ASSERT((boost::same_sign(first, third) == false));
+ BOOST_ASSERT((boost::same_sign(0, 1) == false));
+}
</pre>
</li>
<li class="listitem">Compile-time version:</li>
@@ -1203,12 +1221,10 @@

int main()
{
- bool result = boost::static_same_sign<int, 2, 10>::value;
- std::cout << result << std::endl; //true
-
- result = boost::static_same_sign<int, 10, -2>::value;
- std::cout << result << std::endl; // false
-}
+ BOOST_STATIC_ASSERT((boost::static_same_sign<int, 2, 10>::value));
+ BOOST_STATIC_ASSERT((!boost::static_same_sign<int, 10, -2>::value));
+ BOOST_STATIC_ASSERT((!boost::static_same_sign<int, 1, 0>::value));
+}
</pre>

 
@@ -1221,10 +1237,10 @@
<div class="toc"><dl>
<dt><a href="bits_and_ints.html#boost_integer.bits_and_ints.sign_extend.non_member_function_template__sign_extend_">Non-Member
 Function Template <code class="computeroutput">sign_extend</code></a></dt>
-<dt><a href="bits_and_ints.html#boost_integer.bits_and_ints.sign_extend.template_class__static_sign_extend___">Template
- Class <code class="computeroutput">static_sign_extend<></code></a></dt>
<dt><a href="bits_and_ints.html#boost_integer.bits_and_ints.sign_extend.template_class__mpl__sign_extend___">Template
 Class <code class="computeroutput">mpl::sign_extend<></code></a></dt>
+<dt><a href="bits_and_ints.html#boost_integer.bits_and_ints.sign_extend.template_class__static_sign_extend___">Template
+ Class <code class="computeroutput">static_sign_extend<></code></a></dt>
<dt>Examples</dt>
</dl></div>

@@ -1307,28 +1323,25 @@
 sign-extended to <code class="computeroutput">sizeof(T)</code> bytes.
 </li></ul></div>
</div>
-<div class="section" title="Template Class static_sign_extend<>">
+<div class="section" title="Template Class mpl::sign_extend<>">
<div class="titlepage"><div><div><h4 class="title">
-<a name="boost_integer.bits_and_ints.sign_extend.template_class__static_sign_extend___"></a><a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.sign_extend.template_class__static_sign_extend___" title="Template Class static_sign_extend<>">Template
- Class <code class="computeroutput">static_sign_extend<></code></a>
+<a name="boost_integer.bits_and_ints.sign_extend.template_class__mpl__sign_extend___"></a><a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.sign_extend.template_class__mpl__sign_extend___" title="Template Class mpl::sign_extend<>">Template
+ Class <code class="computeroutput">mpl::sign_extend<></code></a>
</h4></div></div></div>

- The compile-time version can be included via <boost/integer/static_sign_extend.hpp>.
+ The MPL version can be included via <boost/integer/static_sign_extend.hpp>.
 The result will be in <code class="computeroutput">value</code>
 member.
 
-<pre class="programlisting">template<typename T, T Value, std::size_t Bits>
-struct static_sign_extend
-{
- static const T value = implementation-defined;
-};
+<pre class="programlisting">template<typename IC, std::size_t Bits>
+struct mpl::sign_extend : mpl::integral_c<typename IC::value_type, implementation-defined> {};
</pre>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
-Requires: <code class="computeroutput">Bits</code>
- must be smaller than the size, in bits, of <code class="computeroutput">T</code>
- and <code class="computeroutput">T</code> must be an integral
- type.
+Requires: <code class="computeroutput">IC</code>
+ must a <code class="computeroutput">mpl::integral_c<></code>
+ type. <code class="computeroutput">Bits</code> must be smaller
+ than the size in bits of <code class="computeroutput">IC::value_type</code>.
 </li>
<li class="listitem">Template Parameters:</li>
</ul></div>
@@ -1353,24 +1366,13 @@
<tr>
<td>
 
- <code class="computeroutput">T</code>
- 
- </td>
-<td>
- 
- The data type.
- 
- </td>
-</tr>
-<tr>
-<td>
- 
- <code class="computeroutput">Value</code>
+ <code class="computeroutput">IC</code>
 
 </td>
<td>
 
- The data to be extended.
+ A <code class="computeroutput">mpl::integral_c<></code>
+ type.
 
 </td>
</tr>
@@ -1389,28 +1391,25 @@
</tbody>
</table></div>
</div>
-<div class="section" title="Template Class mpl::sign_extend<>">
+<div class="section" title="Template Class static_sign_extend<>">
<div class="titlepage"><div><div><h4 class="title">
-<a name="boost_integer.bits_and_ints.sign_extend.template_class__mpl__sign_extend___"></a><a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.sign_extend.template_class__mpl__sign_extend___" title="Template Class mpl::sign_extend<>">Template
- Class <code class="computeroutput">mpl::sign_extend<></code></a>
+<a name="boost_integer.bits_and_ints.sign_extend.template_class__static_sign_extend___"></a><a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.sign_extend.template_class__static_sign_extend___" title="Template Class static_sign_extend<>">Template
+ Class <code class="computeroutput">static_sign_extend<></code></a>
</h4></div></div></div>

- The MPL version can be included via <boost/integer/static_sign_extend.hpp>.
+ The compile-time version can be included via <boost/integer/static_sign_extend.hpp>.
 The result will be in <code class="computeroutput">value</code>
 member.
 
-<pre class="programlisting">template<typename IC, std::size_t Bits>
-struct mpl::sign_extend
-{
- static const T value = implementation-defined;
-};
+<pre class="programlisting">template<typename T, T Value, std::size_t Bits>
+struct static_sign_extend : mpl::sign_extend< mpl::integral_c<T, Value>, Bits> {};
</pre>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
-Requires: <code class="computeroutput">IC</code>
- must a <code class="computeroutput">mpl::integral_c<></code>
- type. <code class="computeroutput">Bits</code> must be smaller
- than the size in bits of <code class="computeroutput">IC::value_type</code>.
+Requires: <code class="computeroutput">Bits</code>
+ must be smaller than the size, in bits, of <code class="computeroutput">T</code>
+ and <code class="computeroutput">T</code> must be an integral
+ type.
 </li>
<li class="listitem">Template Parameters:</li>
</ul></div>
@@ -1435,13 +1434,24 @@
<tr>
<td>
 
- <code class="computeroutput">IC</code>
+ <code class="computeroutput">T</code>
 
 </td>
<td>
 
- A <code class="computeroutput">mpl::integral_c<></code>
- type.
+ The data type.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">Value</code>
+ 
+ </td>
+<td>
+ 
+ The data to be extended.
 
 </td>
</tr>
@@ -1474,10 +1484,8 @@
 // data is represented in 24-bits
 int data = 0xFFFFFF; // -1 in 24-bits

- int result = boost::sign_extend(data, 24);
-
- std::cout << result << std::endl; // -1
-}
+ BOOST_ASSERT((boost::sign_extend(data, 24) == -1));
+}
</pre>
</li>
<li class="listitem">
@@ -1487,10 +1495,8 @@
int main()
{
 // 0xFFFFF is -1 in 20-bits
- int result = boost::static_sign_extend<int, 0xFFFFF, 20>::value;
-
- std::cout << result << std::endl; // -1
-}
+ BOOST_STATIC_ASSERT((boost::static_sign_extend<int, 0xFFFFF, 20>::value == -1));
+}
</pre>
</li>
</ul></div>
@@ -1626,10 +1632,10 @@
 The compile-time versions can be included via <boost/integer/static_sign.hpp>.
 
<pre class="programlisting">template <typename IC>
-struct mpl::sign { static const int value = implementation-defined; };
+struct mpl::sign : mpl::integral_c<int, implementation-defined> {};

template <template T, T Value>
-struct static_same_sign { static const int value = implementation-defined; };
+struct static_same_sign : mpl::sign< mpl::integral_c<T, Value> > {};
</pre>
<div class="informaltable"><table class="table">
<colgroup>
@@ -1710,15 +1716,12 @@
{
 int first = -100, second = 340, third = 0;

- int result = boost::sign(first);
- std::cout << result << std::endl; // -1
-
- result = boost::sign(second);
- std::cout << result << std::endl; // 1
-
- result = boost::sign(third);
- std::cout << result << std::endl; // 0
-}
+ BOOST_ASSERT((boost::sign(first) == -1));
+
+ BOOST_ASSERT((boost::sign(second) == 1));
+
+ BOOST_ASSERT((boost::sign(third) == 0));
+}
</pre>

 
@@ -1731,16 +1734,16 @@
</h3></div></div></div>
<div class="toc"><dl><dt>Synopsis</dt></dl></div>

- The header file <boost/integer/swap.hpp>
- defines <code class="computeroutput">swap</code> function wich
- swaps 2 integral values without using a temporary variable.
+ The header file <boost/integer/swap_in_place.hpp>
+ defines <code class="computeroutput">swap_in_place</code> function
+ wich swaps 2 integral values without using a temporary variable.
 
<div class="section" title="Synopsis">
<div class="titlepage"><div><div><h4 class="title">
<a name="boost_integer.bits_and_ints.swap_without_a_temporary__in_place__.synopsis"></a><a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.swap_without_a_temporary__in_place__.synopsis" title="Synopsis">Synopsis</a>
</h4></div></div></div>
<pre class="programlisting">template <typename T>
-inline void swap(T& x, T& y);
+inline void swap_in_place(T& x, T& y);
</pre>
</div>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
@@ -1781,11 +1784,11 @@
<pre class="programlisting">template <typename T>
T isign(T x, T y);

-template <typename T, T Value1, T Value2>
-struct static_isign { static const T value = implementation-defined; };
-
template <typename IC1, typename IC2>
-struct mpl::isign { static const typename IC1::value_type value = implementation-defined; };
+struct mpl::isign mpl::integral_c<typename IC1::value_type, implementation-defined> {};
+
+template <typename T, T Value1, T Value2>
+struct static_isign : mpl::isign< mpl::integral_c<T, Value1>, mpl::integral_c<T, Value2> > {};
</pre>
</div>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">

Modified: sandbox/SOC/2010/bits_and_ints/libs/integer/doc/html/boost_integer/history.html
==============================================================================
--- sandbox/SOC/2010/bits_and_ints/libs/integer/doc/html/boost_integer/history.html (original)
+++ sandbox/SOC/2010/bits_and_ints/libs/integer/doc/html/boost_integer/history.html 2010-07-14 15:50:31 EDT (Wed, 14 Jul 2010)
@@ -26,7 +26,7 @@
<a name="boost_integer.history"></a><a class="link" href="history.html" title="History"> History</a>
</h2></div></div></div>
<a name="boost_integer.history.1_42_0"></a><h5>
-<a name="id36202315"></a>
+<a name="id36202477"></a>
 <a class="link" href="history.html#boost_integer.history.1_42_0">1.42.0</a>
 </h5>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
@@ -55,7 +55,7 @@
 </li>
</ul></div>
<a name="boost_integer.history.1_32_0"></a><h5>
-<a name="id36202435"></a>
+<a name="id36202597"></a>
 <a class="link" href="history.html#boost_integer.history.1_32_0">1.32.0</a>
 </h5>
<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">

Modified: sandbox/SOC/2010/bits_and_ints/libs/integer/doc/html/index.html
==============================================================================
--- sandbox/SOC/2010/bits_and_ints/libs/integer/doc/html/index.html (original)
+++ sandbox/SOC/2010/bits_and_ints/libs/integer/doc/html/index.html 2010-07-14 15:50:31 EDT (Wed, 14 Jul 2010)
@@ -255,7 +255,7 @@
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left">Last revised: July 14, 2010 at 19:01:54 GMT</td>
+<td align="left">Last revised: July 14, 2010 at 19:47:00 GMT</td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>

Next message: vicente.botet_at_[hidden]: "[Boost-commit] svn:boost r64021 - sandbox/bitfield/boost/integer"
Previous message: muriloufg_at_[hidden]: "[Boost-commit] svn:boost r64019 - sandbox/SOC/2010/bits_and_ints/libs/integer/doc"

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