Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r63930 - in sandbox/SOC/2010/bits_and_ints: boost/integer libs/integer/doc libs/integer/doc/html libs/integer/doc/html/boost_integer
From: muriloufg_at_[hidden]
Date: 2010-07-12 17:13:06

Author: murilov
Date: 2010-07-12 17:13:05 EDT (Mon, 12 Jul 2010)
New Revision: 63930
URL: http://svn.boost.org/trac/boost/changeset/63930

Log:
Working on doc
Text files modified:
   sandbox/SOC/2010/bits_and_ints/boost/integer/is_integral_constant.hpp | 2
   sandbox/SOC/2010/bits_and_ints/libs/integer/doc/bits_and_ints.qbk | 35 +++++++++++++++++++
   sandbox/SOC/2010/bits_and_ints/libs/integer/doc/html/boost_integer/bits_and_ints.html | 71 +++++++++++++++++++++++++++++++++++++++
   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
   5 files changed, 109 insertions(+), 5 deletions(-)

Modified: sandbox/SOC/2010/bits_and_ints/boost/integer/is_integral_constant.hpp
==============================================================================
--- sandbox/SOC/2010/bits_and_ints/boost/integer/is_integral_constant.hpp (original)
+++ sandbox/SOC/2010/bits_and_ints/boost/integer/is_integral_constant.hpp 2010-07-12 17:13:05 EDT (Mon, 12 Jul 2010)
@@ -21,7 +21,7 @@
namespace boost {

/*
- * is_integral_constant<T> checks if T is or not an integral_constant
+ * is_integral_constant<T> verifies if T is or not an integral_constant
*/

namespace mpl {

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-12 17:13:05 EDT (Mon, 12 Jul 2010)
@@ -592,6 +592,41 @@

[endsect]

+[section Swap without a temporary ]
+The header file [@../../../../boost/integer/swap.hpp <boost/integer/swap.hpp>] defines `swap`
+function wich swaps 2 integral values without using a temporary variable.
+
+[section Synopsis]
+
+ template <typename T>
+ inline void swap(T& x, T& y);
+
+[endsect]
+
+*[*Requires: ] `T` must be an integral type.
+
+*[*Returns: ] Nothing. `x` will have the value of `y` and `y` will have the `x` value.
+
+[endsect]
+
+[section MPL `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<>`.
+
+[section Synopsis]
+
+ template <typename IC>
+ struct is_integral_constant { ``['implementation-defined]`` };
+
+[endsect]
+
+*[*Results: ]
+ * If `IC` is a `mpl::integral_c<>` type, `is_integral_constant<IC>` will inherit from `mpl::true_`
+ * If `IC` is not a `mpl::integral_c<>` type, `is_integral_constant<IC>` will inherit from `mpl::false_`
+
+[endsect]
+
+
[section:bit_utils Binary Utilities]
The header [@../../../../boost/integer/bit_utils.hpp <boost/integer/bit_utils.hpp>] cotains some metafunctions to handle binary data.
All the metafunctions have an member varible named `value` where will be the result.

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-12 17:13:05 EDT (Mon, 12 Jul 2010)
@@ -50,6 +50,11 @@
       Least Common Multiple </a></span></dt>
<dt><span class="section"><a href="bits_and_ints.html#boost_integer.bits_and_ints.mpl_greatest_common_divisor_">MPL
       Greatest Common Divisor </a></span></dt>
+<dt><span class="section"><a href="bits_and_ints.html#boost_integer.bits_and_ints.swap_without_a_temporary_">Swap
+ without a temporary </a></span></dt>
+<dt><span class="section"><a href="bits_and_ints.html#boost_integer.bits_and_ints.mpl__is_integral_constant____metafunction_">MPL
+ <code class="computeroutput"><span class="identifier">is_integral_constant</span><span class="special"><></span></code>
+ metafunction </a></span></dt>
<dt><span class="section"> Binary Utilities</span></dt>
</dl></div>
<div class="section" title="Overview">
@@ -1319,6 +1324,70 @@
         </li>
</ul></div>
</div>
+<div class="section" title="Swap without a temporary">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_integer.bits_and_ints.swap_without_a_temporary_"></a><a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.swap_without_a_temporary_" title="Swap without a temporary">Swap
+ without a temporary </a>
+</h3></div></div></div>
+<div class="toc"><dl><dt><span class="section">Synopsis</span></dt></dl></div>
+<p>
+ The header file <boost/integer/swap.hpp>
+ defines <code class="computeroutput"><span class="identifier">swap</span></code> function wich
+ swaps 2 integral values without using a temporary variable.
+ </p>
+<div class="section" title="Synopsis">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_integer.bits_and_ints.swap_without_a_temporary_.synopsis"></a><a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.swap_without_a_temporary_.synopsis" title="Synopsis">Synopsis</a>
+</h4></div></div></div>
+<pre class="programlisting"><span class="keyword">template</span> <span class="special"><</span><span class="keyword">typename</span> <span class="identifier">T</span><span class="special">></span>
+<span class="keyword">inline</span> <span class="keyword">void</span> <span class="identifier">swap</span><span class="special">(</span><span class="identifier">T</span><span class="special">&</span> <span class="identifier">x</span><span class="special">,</span> <span class="identifier">T</span><span class="special">&</span> <span class="identifier">y</span><span class="special">);</span>
+</pre>
+</div>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc">
+<li class="listitem">
+<span class="bold"><strong>Requires: </strong></span><code class="computeroutput"><span class="identifier">T</span></code>
+ must be an integral type.
+ </li>
+<li class="listitem">
+<span class="bold"><strong>Returns: </strong></span> Nothing. <code class="computeroutput"><span class="identifier">x</span></code>
+ will have the value of <code class="computeroutput"><span class="identifier">y</span></code>
+ and <code class="computeroutput"><span class="identifier">y</span></code> will have the <code class="computeroutput"><span class="identifier">x</span></code> value.
+ </li>
+</ul></div>
+</div>
+<div class="section" title="MPL is_integral_constant<> metafunction">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="boost_integer.bits_and_ints.mpl__is_integral_constant____metafunction_"></a><a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.mpl__is_integral_constant____metafunction_" title="MPL is_integral_constant<> metafunction">MPL
+ <code class="computeroutput"><span class="identifier">is_integral_constant</span><span class="special"><></span></code>
+ metafunction </a>
+</h3></div></div></div>
+<div class="toc"><dl><dt><span class="section">Synopsis</span></dt></dl></div>
+<p>
+ The header file <boost/integer/is_integral_constant.hpp>
+ defines <code class="computeroutput"><span class="identifier">is_integral_constant</span><span class="special"><></span></code> static metafunction wich verifies
+ if an given template parameter is or not a <code class="computeroutput"><span class="identifier">mpl</span><span class="special">::</span><span class="identifier">integral_c</span><span class="special"><></span></code>.
+ </p>
+<div class="section" title="Synopsis">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="boost_integer.bits_and_ints.mpl__is_integral_constant____metafunction_.synopsis"></a><a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.mpl__is_integral_constant____metafunction_.synopsis" title="Synopsis">Synopsis</a>
+</h4></div></div></div>
+<pre class="programlisting"><span class="keyword">template</span> <span class="special"><</span><span class="keyword">typename</span> <span class="identifier">IC</span><span class="special">></span>
+<span class="keyword">struct</span> <span class="identifier">is_integral_constant</span> <span class="special">{</span> <span class="emphasis"><em>implementation-defined</em></span> <span class="special">};</span>
+</pre>
+</div>
+<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
+<span class="bold"><strong>Results: </strong></span><div class="itemizedlist"><ul class="itemizedlist" type="circle">
+<li class="listitem">
+ If <code class="computeroutput"><span class="identifier">IC</span></code> is a <code class="computeroutput"><span class="identifier">mpl</span><span class="special">::</span><span class="identifier">integral_c</span><span class="special"><></span></code>
+ type, <code class="computeroutput"><span class="identifier">is_integral_constant</span><span class="special"><</span><span class="identifier">IC</span><span class="special">></span></code> will inherit from <code class="computeroutput"><span class="identifier">mpl</span><span class="special">::</span><span class="identifier">true_</span></code>
+</li>
+<li class="listitem">
+ If <code class="computeroutput"><span class="identifier">IC</span></code> is not a <code class="computeroutput"><span class="identifier">mpl</span><span class="special">::</span><span class="identifier">integral_c</span><span class="special"><></span></code>
+ type, <code class="computeroutput"><span class="identifier">is_integral_constant</span><span class="special"><</span><span class="identifier">IC</span><span class="special">></span></code> will inherit from <code class="computeroutput"><span class="identifier">mpl</span><span class="special">::</span><span class="identifier">false_</span></code>
+</li>
+</ul></div>
+</li></ul></div>
+</div>
<div class="section" title="Binary Utilities">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_integer.bits_and_ints.bit_utils"></a><a class="link" href="bits_and_ints.html#boost_integer.bits_and_ints.bit_utils" title="Binary Utilities"> Binary Utilities</a>
@@ -1386,7 +1455,7 @@

<span class="special">}</span> <span class="comment">// mpl
</span>
-<span class="comment">// Runtime verion
+<span class="comment">// Runtime version
</span><span class="keyword">template</span> <span class="special"><</span><span class="keyword">typename</span> <span class="identifier">T</span><span class="special">></span>
<span class="keyword">inline</span> <span class="identifier">T</span> <span class="identifier">set_bit</span><span class="special">(</span><span class="identifier">T</span> <span class="identifier">data</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">char</span> <span class="identifier">pos</span><span class="special">);</span>

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-12 17:13:05 EDT (Mon, 12 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="id36200658"></a>
+<a name="id36201172"></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="id36200778"></a>
+<a name="id36201292"></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-12 17:13:05 EDT (Mon, 12 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"><p><small>Last revised: July 12, 2010 at 20:50:00 GMT</small></p></td>
+<td align="left"><p><small>Last revised: July 12, 2010 at 21:09:34 GMT</small></p></td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>

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