Changeset 63930


Ignore:
Timestamp:
Jul 12, 2010, 9:13:05 PM (8 years ago)
Author:
murilov
Message:

Working on doc

Location:
sandbox/SOC/2010/bits_and_ints
Files:
5 edited

Legend:

Unmodified
Added
Removed
  • sandbox/SOC/2010/bits_and_ints/boost/integer/is_integral_constant.hpp

    r63820 r63930  
    2222
    2323/*
    24  *      is_integral_constant<T> checks if T is or not an integral_constant
     24 *      is_integral_constant<T> verifies if T is or not an integral_constant
    2525 */
    2626
  • sandbox/SOC/2010/bits_and_ints/libs/integer/doc/bits_and_ints.qbk

    r63929 r63930  
    592592
    593593[endsect]
     594
     595[section Swap without a temporary ]
     596The header file [@../../../../boost/integer/swap.hpp <boost/integer/swap.hpp>] defines `swap`
     597function wich swaps 2 integral values without using a temporary variable.
     598
     599[section Synopsis]
     600
     601        template <typename T>
     602        inline void swap(T& x, T& y);
     603       
     604[endsect]
     605
     606*[*Requires: ] `T` must be an integral type.
     607
     608*[*Returns: ] Nothing. `x` will have the value of `y` and `y` will have the `x` value.
     609
     610[endsect]
     611
     612[section MPL `is_integral_constant<>` metafunction ]
     613The header file [@../../../../boost/integer/is_integral_constant.hpp <boost/integer/is_integral_constant.hpp>] defines
     614`is_integral_constant<>` static metafunction wich verifies if an given template parameter is or not a `mpl::integral_c<>`.
     615
     616[section Synopsis]
     617
     618        template <typename IC>
     619        struct is_integral_constant { ``['implementation-defined]`` };
     620       
     621[endsect]
     622
     623*[*Results: ]
     624        * If `IC` is a `mpl::integral_c<>` type, `is_integral_constant<IC>` will inherit from `mpl::true_`
     625        * If `IC` is not a `mpl::integral_c<>` type, `is_integral_constant<IC>` will inherit from `mpl::false_`
     626
     627[endsect]
     628
    594629
    595630[section:bit_utils Binary Utilities]
  • sandbox/SOC/2010/bits_and_ints/libs/integer/doc/html/boost_integer/bits_and_ints.html

    r63929 r63930  
    5151<dt><span class="section"><a href="bits_and_ints.html#boost_integer.bits_and_ints.mpl_greatest_common_divisor_">MPL
    5252      Greatest Common Divisor </a></span></dt>
     53<dt><span class="section"><a href="bits_and_ints.html#boost_integer.bits_and_ints.swap_without_a_temporary_">Swap
     54      without a temporary </a></span></dt>
     55<dt><span class="section"><a href="bits_and_ints.html#boost_integer.bits_and_ints.mpl__is_integral_constant____metafunction_">MPL
     56      <code class="computeroutput"><span class="identifier">is_integral_constant</span><span class="special">&lt;&gt;</span></code>
     57      metafunction </a></span></dt>
    5358<dt><span class="section"><a href="bits_and_ints.html#boost_integer.bits_and_ints.bit_utils"> Binary Utilities</a></span></dt>
    5459</dl></div>
     
    13191324        </li>
    13201325</ul></div>
     1326</div>
     1327<div class="section" title="Swap without a temporary">
     1328<div class="titlepage"><div><div><h3 class="title">
     1329<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
     1330      without a temporary </a>
     1331</h3></div></div></div>
     1332<div class="toc"><dl><dt><span class="section"><a href="bits_and_ints.html#boost_integer.bits_and_ints.swap_without_a_temporary_.synopsis">Synopsis</a></span></dt></dl></div>
     1333<p>
     1334        The header file <a href="../../../../../boost/integer/swap.hpp" target="_top">&lt;boost/integer/swap.hpp&gt;</a>
     1335        defines <code class="computeroutput"><span class="identifier">swap</span></code> function wich
     1336        swaps 2 integral values without using a temporary variable.
     1337      </p>
     1338<div class="section" title="Synopsis">
     1339<div class="titlepage"><div><div><h4 class="title">
     1340<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>
     1341</h4></div></div></div>
     1342<pre class="programlisting"><span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">T</span><span class="special">&gt;</span>
     1343<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">&amp;</span> <span class="identifier">x</span><span class="special">,</span> <span class="identifier">T</span><span class="special">&amp;</span> <span class="identifier">y</span><span class="special">);</span>
     1344</pre>
     1345</div>
     1346<div class="itemizedlist"><ul class="itemizedlist" type="disc">
     1347<li class="listitem">
     1348<span class="bold"><strong>Requires: </strong></span><code class="computeroutput"><span class="identifier">T</span></code>
     1349          must be an integral type.
     1350        </li>
     1351<li class="listitem">
     1352<span class="bold"><strong>Returns: </strong></span> Nothing. <code class="computeroutput"><span class="identifier">x</span></code>
     1353          will have the value of <code class="computeroutput"><span class="identifier">y</span></code>
     1354          and <code class="computeroutput"><span class="identifier">y</span></code> will have the <code class="computeroutput"><span class="identifier">x</span></code> value.
     1355        </li>
     1356</ul></div>
     1357</div>
     1358<div class="section" title="MPL is_integral_constant&lt;&gt; metafunction">
     1359<div class="titlepage"><div><div><h3 class="title">
     1360<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&lt;&gt; metafunction">MPL
     1361      <code class="computeroutput"><span class="identifier">is_integral_constant</span><span class="special">&lt;&gt;</span></code>
     1362      metafunction </a>
     1363</h3></div></div></div>
     1364<div class="toc"><dl><dt><span class="section"><a href="bits_and_ints.html#boost_integer.bits_and_ints.mpl__is_integral_constant____metafunction_.synopsis">Synopsis</a></span></dt></dl></div>
     1365<p>
     1366        The header file <a href="../../../../../boost/integer/is_integral_constant.hpp" target="_top">&lt;boost/integer/is_integral_constant.hpp&gt;</a>
     1367        defines <code class="computeroutput"><span class="identifier">is_integral_constant</span><span class="special">&lt;&gt;</span></code> static metafunction wich verifies
     1368        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">&lt;&gt;</span></code>.
     1369      </p>
     1370<div class="section" title="Synopsis">
     1371<div class="titlepage"><div><div><h4 class="title">
     1372<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>
     1373</h4></div></div></div>
     1374<pre class="programlisting"><span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">IC</span><span class="special">&gt;</span>
     1375<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>
     1376</pre>
     1377</div>
     1378<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
     1379<span class="bold"><strong>Results: </strong></span><div class="itemizedlist"><ul class="itemizedlist" type="circle">
     1380<li class="listitem">
     1381              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">&lt;&gt;</span></code>
     1382              type, <code class="computeroutput"><span class="identifier">is_integral_constant</span><span class="special">&lt;</span><span class="identifier">IC</span><span class="special">&gt;</span></code> will inherit from <code class="computeroutput"><span class="identifier">mpl</span><span class="special">::</span><span class="identifier">true_</span></code>
     1383</li>
     1384<li class="listitem">
     1385              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">&lt;&gt;</span></code>
     1386              type, <code class="computeroutput"><span class="identifier">is_integral_constant</span><span class="special">&lt;</span><span class="identifier">IC</span><span class="special">&gt;</span></code> will inherit from <code class="computeroutput"><span class="identifier">mpl</span><span class="special">::</span><span class="identifier">false_</span></code>
     1387</li>
     1388</ul></div>
     1389</li></ul></div>
    13211390</div>
    13221391<div class="section" title="Binary Utilities">
     
    13871456<span class="special">}</span> <span class="comment">// mpl
    13881457</span>
    1389 <span class="comment">// Runtime verion
     1458<span class="comment">// Runtime version
    13901459</span><span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">T</span><span class="special">&gt;</span>
    13911460<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>
  • sandbox/SOC/2010/bits_and_ints/libs/integer/doc/html/boost_integer/history.html

    r63929 r63930  
    2727</h2></div></div></div>
    2828<a name="boost_integer.history.1_42_0"></a><h5>
    29 <a name="id36200658"></a>
     29<a name="id36201172"></a>
    3030      <a class="link" href="history.html#boost_integer.history.1_42_0">1.42.0</a>
    3131    </h5>
     
    5656</ul></div>
    5757<a name="boost_integer.history.1_32_0"></a><h5>
    58 <a name="id36200778"></a>
     58<a name="id36201292"></a>
    5959      <a class="link" href="history.html#boost_integer.history.1_32_0">1.32.0</a>
    6060    </h5>
  • sandbox/SOC/2010/bits_and_ints/libs/integer/doc/html/index.html

    r63929 r63930  
    256256</div>
    257257<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
    258 <td align="left"><p><small>Last revised: July 12, 2010 at 20:50:00 GMT</small></p></td>
     258<td align="left"><p><small>Last revised: July 12, 2010 at 21:09:34 GMT</small></p></td>
    259259<td align="right"><div class="copyright-footer"></div></td>
    260260</tr></table>
Note: See TracChangeset for help on using the changeset viewer.