mirror of
https://github.com/boostorg/integer.git
synced 2025-07-29 12:17:13 +02:00
Update docs to match code.
[SVN r58293]
This commit is contained in:
@ -38,6 +38,8 @@
|
|||||||
minimum-width integer types</a></span></dt>
|
minimum-width integer types</a></span></dt>
|
||||||
<dt><span class="section"><a href="cstdint.html#boost_integer.cstdint.greatest_width_integer_types">Greatest-width
|
<dt><span class="section"><a href="cstdint.html#boost_integer.cstdint.greatest_width_integer_types">Greatest-width
|
||||||
integer types</a></span></dt>
|
integer types</a></span></dt>
|
||||||
|
<dt><span class="section"><a href="cstdint.html#boost_integer.cstdint.integer_constant_macros">Integer
|
||||||
|
Constant Macros</a></span></dt>
|
||||||
</dl></div>
|
</dl></div>
|
||||||
<div class="section" lang="en">
|
<div class="section" lang="en">
|
||||||
<div class="titlepage"><div><div><h3 class="title">
|
<div class="titlepage"><div><div><h3 class="title">
|
||||||
@ -210,6 +212,33 @@
|
|||||||
These types are provided for all platforms.
|
These types are provided for all platforms.
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
<div class="section" lang="en">
|
||||||
|
<div class="titlepage"><div><div><h3 class="title">
|
||||||
|
<a name="boost_integer.cstdint.integer_constant_macros"></a><a class="link" href="cstdint.html#boost_integer.cstdint.integer_constant_macros" title="Integer Constant Macros">Integer
|
||||||
|
Constant Macros</a>
|
||||||
|
</h3></div></div></div>
|
||||||
|
<p>
|
||||||
|
The following macros are always defined after inclusion of this header, these
|
||||||
|
allow integer constants of at least the specified width to be declared: INT8_C,
|
||||||
|
UINT8_C, INT16_C, UINT16_C, INT32_C, UINT32_C, INTMAX_C, UINTMAX_C.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
The macros INT64_C and UINT64_C are also defined if the the macro BOOST_NO_INT64_T
|
||||||
|
is not defined.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
The C99 macro __STDC_CONSTANT_MACROS is also defined as an artifact of the
|
||||||
|
implementation.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
For example:
|
||||||
|
</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">cstdint</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
|
||||||
|
|
||||||
|
<span class="comment">// Here the constant 0x1FFFFFFFF has the correct suffix applied:
|
||||||
|
</span><span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">uint64_t</span> <span class="identifier">c</span> <span class="special">=</span> <span class="identifier">INT64_C</span><span class="special">(</span><span class="number">0</span><span class="identifier">x1FFFFFFFF</span><span class="special">);</span>
|
||||||
|
</pre>
|
||||||
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
|
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
|
||||||
<td align="left"></td>
|
<td align="left"></td>
|
||||||
|
@ -26,7 +26,7 @@
|
|||||||
<a name="boost_integer.history"></a><a class="link" href="history.html" title="History"> History</a>
|
<a name="boost_integer.history"></a><a class="link" href="history.html" title="History"> History</a>
|
||||||
</h2></div></div></div>
|
</h2></div></div></div>
|
||||||
<a name="boost_integer.history.1_42_0"></a><h5>
|
<a name="boost_integer.history.1_42_0"></a><h5>
|
||||||
<a name="id768488"></a>
|
<a name="id786079"></a>
|
||||||
<a class="link" href="history.html#boost_integer.history.1_42_0">1.42.0</a>
|
<a class="link" href="history.html#boost_integer.history.1_42_0">1.42.0</a>
|
||||||
</h5>
|
</h5>
|
||||||
<div class="itemizedlist"><ul type="disc">
|
<div class="itemizedlist"><ul type="disc">
|
||||||
@ -55,7 +55,7 @@
|
|||||||
</li>
|
</li>
|
||||||
</ul></div>
|
</ul></div>
|
||||||
<a name="boost_integer.history.1_32_0"></a><h5>
|
<a name="boost_integer.history.1_32_0"></a><h5>
|
||||||
<a name="id768590"></a>
|
<a name="id786181"></a>
|
||||||
<a class="link" href="history.html#boost_integer.history.1_32_0">1.32.0</a>
|
<a class="link" href="history.html#boost_integer.history.1_32_0">1.32.0</a>
|
||||||
</h5>
|
</h5>
|
||||||
<div class="itemizedlist"><ul type="disc"><li>
|
<div class="itemizedlist"><ul type="disc"><li>
|
||||||
|
@ -139,7 +139,7 @@
|
|||||||
<code class="literal">fast</code>. The following table describes each template's criteria.
|
<code class="literal">fast</code>. The following table describes each template's criteria.
|
||||||
</p>
|
</p>
|
||||||
<div class="table">
|
<div class="table">
|
||||||
<a name="id764075"></a><p class="title"><b>Table 1. Criteria for the Sized Type Class Templates</b></p>
|
<a name="id781665"></a><p class="title"><b>Table 1. Criteria for the Sized Type Class Templates</b></p>
|
||||||
<div class="table-contents"><table class="table" summary="Criteria for the Sized Type Class Templates">
|
<div class="table-contents"><table class="table" summary="Criteria for the Sized Type Class Templates">
|
||||||
<colgroup>
|
<colgroup>
|
||||||
<col>
|
<col>
|
||||||
|
@ -105,7 +105,7 @@
|
|||||||
of <code class="literal">high_bit_mask_t</code>.
|
of <code class="literal">high_bit_mask_t</code>.
|
||||||
</p>
|
</p>
|
||||||
<div class="table">
|
<div class="table">
|
||||||
<a name="id765275"></a><p class="title"><b>Table 2. Members of the `boost::high_bit_mask_t` Class Template</b></p>
|
<a name="id782866"></a><p class="title"><b>Table 2. Members of the `boost::high_bit_mask_t` Class Template</b></p>
|
||||||
<div class="table-contents"><table class="table" summary="Members of the `boost::high_bit_mask_t` Class Template">
|
<div class="table-contents"><table class="table" summary="Members of the `boost::high_bit_mask_t` Class Template">
|
||||||
<colgroup>
|
<colgroup>
|
||||||
<col>
|
<col>
|
||||||
@ -204,7 +204,7 @@
|
|||||||
type. The following table describes the members of <code class="literal">low_bits_mask_t</code>.
|
type. The following table describes the members of <code class="literal">low_bits_mask_t</code>.
|
||||||
</p>
|
</p>
|
||||||
<div class="table">
|
<div class="table">
|
||||||
<a name="id765484"></a><p class="title"><b>Table 3. Members of the [^boost::low_bits_mask_t] Class Template</b></p>
|
<a name="id783074"></a><p class="title"><b>Table 3. Members of the [^boost::low_bits_mask_t] Class Template</b></p>
|
||||||
<div class="table-contents"><table class="table" summary="Members of the [^boost::low_bits_mask_t] Class Template">
|
<div class="table-contents"><table class="table" summary="Members of the [^boost::low_bits_mask_t] Class Template">
|
||||||
<colgroup>
|
<colgroup>
|
||||||
<col>
|
<col>
|
||||||
|
@ -40,7 +40,7 @@
|
|||||||
<div><p class="copyright">Copyright © 2001 -2009 Beman Dawes, Daryle Walker, Gennaro Prota,
|
<div><p class="copyright">Copyright © 2001 -2009 Beman Dawes, Daryle Walker, Gennaro Prota,
|
||||||
John Maddock</p></div>
|
John Maddock</p></div>
|
||||||
<div><div class="legalnotice">
|
<div><div class="legalnotice">
|
||||||
<a name="id753741"></a><p>
|
<a name="id771218"></a><p>
|
||||||
Distributed under the Boost Software License, Version 1.0. (See accompanying
|
Distributed under the Boost Software License, Version 1.0. (See accompanying
|
||||||
file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
|
file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
|
||||||
</p>
|
</p>
|
||||||
@ -237,7 +237,7 @@
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
|
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
|
||||||
<td align="left"><p><small>Last revised: November 28, 2009 at 17:06:38 GMT</small></p></td>
|
<td align="left"><p><small>Last revised: December 11, 2009 at 17:54:58 GMT</small></p></td>
|
||||||
<td align="right"><div class="copyright-footer"></div></td>
|
<td align="right"><div class="copyright-footer"></div></td>
|
||||||
</tr></table>
|
</tr></table>
|
||||||
<hr>
|
<hr>
|
||||||
|
@ -188,6 +188,26 @@ The typedef [^uintmax_t] designates an unsigned integer type capable of represen
|
|||||||
These types are provided for all platforms.
|
These types are provided for all platforms.
|
||||||
|
|
||||||
[endsect]
|
[endsect]
|
||||||
|
|
||||||
|
[section Integer Constant Macros]
|
||||||
|
|
||||||
|
The following macros are always defined after inclusion of this header, these allow
|
||||||
|
integer constants of at least the specified width to be declared:
|
||||||
|
INT8_C, UINT8_C, INT16_C, UINT16_C, INT32_C, UINT32_C, INTMAX_C, UINTMAX_C.
|
||||||
|
|
||||||
|
The macros INT64_C and UINT64_C are also defined if the the macro BOOST_NO_INT64_T is not defined.
|
||||||
|
|
||||||
|
The C99 macro __STDC_CONSTANT_MACROS is also defined as an artifact of the implementation.
|
||||||
|
|
||||||
|
For example:
|
||||||
|
|
||||||
|
#include <boost/cstdint.hpp>
|
||||||
|
|
||||||
|
// Here the constant 0x1FFFFFFFF has the correct suffix applied:
|
||||||
|
static const boost::uint64_t c = INT64_C(0x1FFFFFFFF);
|
||||||
|
|
||||||
|
[endsect]
|
||||||
|
|
||||||
[endsect]
|
[endsect]
|
||||||
|
|
||||||
[section:traits Integer Traits]
|
[section:traits Integer Traits]
|
||||||
|
Reference in New Issue
Block a user