[ceph.git] / ceph / src / boost / libs / integer / doc / html / index.html

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Boost.Integer</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Boost.Integer">
<link rel="next" href="boost_integer/traits.html" title="Integer Traits">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav"><a accesskey="n" href="boost_integer/traits.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a></div>
<div class="article">
<div class="titlepage">
<div>
<div><h2 class="title">
<a name="boost_integer"></a>Boost.Integer</h2></div>
<div><div class="authorgroup">
<div class="author"><h3 class="author">
<span class="firstname">Beman</span> <span class="surname">Dawes</span>
</h3></div>
<div class="author"><h3 class="author">
<span class="firstname">Daryle</span> <span class="surname">Walker</span>
</h3></div>
<div class="author"><h3 class="author">
<span class="firstname">Gennaro</span> <span class="surname">Prota</span>
</h3></div>
<div class="author"><h3 class="author">
<span class="firstname">John</span> <span class="surname">Maddock</span>
</h3></div>
</div></div>
<div><p class="copyright">Copyright &#169; 2001-2009 Beman
      Dawes, Daryle Walker, Gennaro Prota, John Maddock</p></div>
<div><div class="legalnotice">
<a name="boost_integer.legal"></a><p>
        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>)
      </p>
</div></div>
</div>
<hr>
</div>
<div class="toc">
<p><b>Table of Contents</b></p>
<dl class="toc">
<dt><span class="section"><a href="index.html#boost_integer.overview">Overview</a></span></dt>
<dt><span class="section"><a href="boost_integer/traits.html">Integer Traits</a></span></dt>
<dt><span class="section"><a href="boost_integer/integer.html">Integer Type Selection</a></span></dt>
<dt><span class="section"><a href="boost_integer/mask.html">Integer Masks</a></span></dt>
<dt><span class="section"><a href="boost_integer/log2.html">Compile Time log2 Calculation</a></span></dt>
<dt><span class="section"><a href="boost_integer/minmax.html">Compile time min/max calculation</a></span></dt>
<dt><span class="section"><a href="boost_integer/history.html">History</a></span></dt>
<dt><span class="section"><a href="boost_integer/cstdint.html">Removed from library: Standard Integer
    Types</a></span></dt>
</dl>
</div>
<div class="section">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="boost_integer.overview"></a><a class="link" href="index.html#boost_integer.overview" title="Overview">Overview</a>
</h2></div></div></div>
<p>
      Boost.Integer provides integer type support, particularly helpful in generic
      programming. It provides the means to select an integer type based upon its
      properties, like the number of bits or the maximum supported value, as well
      as compile-time bit mask selection. There is a derivative of std::numeric_limits
      that provides integral constant expressions for <code class="computeroutput"><span class="identifier">min</span></code>
      and <code class="computeroutput"><span class="identifier">max</span></code>. Finally, it provides
      two compile-time algorithms: determining the highest power of two in a compile-time
      value; and computing min and max of constant expressions.
    </p>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
              <p>
                Component
              </p>
            </th>
<th>
              <p>
                Header
              </p>
            </th>
<th>
              <p>
                Purpose
              </p>
            </th>
</tr></thead>
<tbody>
<tr>
<td>
              <p>
                Forward Declarations.
              </p>
            </td>
<td>
              <p>
                <code class="literal"><a href="../../../../boost/integer_fwd.hpp" target="_top">&lt;boost/integer_fwd.hpp&gt;</a></code>
              </p>
            </td>
<td>
              <p>
                Forward declarations of classes and class templates - for use when
                just the name of a class is needed.
              </p>
            </td>
</tr>
<tr>
<td>
              <p>
                <a class="link" href="boost_integer/traits.html" title="Integer Traits">Integer Traits</a>.
              </p>
            </td>
<td>
              <p>
                <code class="literal"><a href="../../../../boost/integer_traits.hpp" target="_top">&lt;boost/integer_traits.hpp&gt;</a></code>
              </p>
            </td>
<td>
              <p>
                Class template <code class="literal">boost::integer_traits</code>, derives
                from <code class="literal">std::numeric_limits</code> and adds <code class="literal">const_min</code>
                and <code class="literal">const_max</code> members.
              </p>
            </td>
</tr>
<tr>
<td>
              <p>
                <a class="link" href="boost_integer/integer.html" title="Integer Type Selection">Integer Type Selection</a>.
              </p>
            </td>
<td>
              <p>
                <code class="literal"><a href="../../../../boost/integer.hpp" target="_top">&lt;boost/integer.hpp&gt;</a></code>
              </p>
            </td>
<td>
              <p>
                Templates for integer type selection based on properties such as
                maximum value or number of bits: Use to select the type of an integer
                when some property such as maximum value or number of bits is known.
                Useful for generic programming.
              </p>
            </td>
</tr>
<tr>
<td>
              <p>
                <a class="link" href="boost_integer/mask.html" title="Integer Masks">Integer Masks</a>.
              </p>
            </td>
<td>
              <p>
                <code class="literal"><a href="../../../../boost/integer/integer_mask.hpp" target="_top">&lt;boost/integer/integer_mask.hpp&gt;</a></code>
              </p>
            </td>
<td>
              <p>
                Templates for the selection of integer masks, single or lowest group,
                based on the number of bits: Use to select a particular mask when
                the bit position(s) are based on a compile-time variable. Useful
                for generic programming.
              </p>
            </td>
</tr>
<tr>
<td>
              <p>
                <a class="link" href="boost_integer/log2.html" title="Compile Time log2 Calculation">Compile time log2 Calculation</a>.
              </p>
            </td>
<td>
              <p>
                <code class="literal"><a href="../../../../boost/integer/static_log2.hpp" target="_top">&lt;boost/integer/static_log2.hpp&gt;</a></code>
              </p>
            </td>
<td>
              <p>
                Template for finding the highest power of two in a number: Use to
                find the bit-size/range based on a maximum value. Useful for generic
                programming.
              </p>
            </td>
</tr>
<tr>
<td>
              <p>
                <a class="link" href="boost_integer/minmax.html" title="Compile time min/max calculation">Compile time min/max calculation</a>.
              </p>
            </td>
<td>
              <p>
                <code class="literal"><a href="../../../../boost/integer/static_min_max.hpp" target="_top">&lt;boost/integer/static_min_max.hpp&gt;</a></code>
              </p>
            </td>
<td>
              <p>
                Templates for finding the extrema of two numbers: Use to find a bound
                based on a minimum or maximum value. Useful for generic programming.
              </p>
            </td>
</tr>
</tbody>
</table></div>
</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: June 01, 2014 at 19:57:36 GMT</small></p></td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>
<div class="spirit-nav"><a accesskey="n" href="boost_integer/traits.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a></div>
</body>
</html>
Commit	Line	Data
7c673cae FG	1	<html>
	2	<head>
	3	<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
	4	<title>Boost.Integer</title>
	5	<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
	6	<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
	7	<link rel="home" href="index.html" title="Boost.Integer">
	8	<link rel="next" href="boost_integer/traits.html" title="Integer Traits">
	9	</head>
	10	<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
	11	<table cellpadding="2" width="100%"><tr>
	12	<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
	13	<td align="center"><a href="../../../../index.html">Home</a></td>
	14	<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
	15	<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
	16	<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
	17	<td align="center"><a href="../../../../more/index.htm">More</a></td>
	18	</tr></table>
	19	<hr>
	20	<div class="spirit-nav"><a accesskey="n" href="boost_integer/traits.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a></div>
	21	<div class="article">
	22	<div class="titlepage">
	23	<div>
	24	<div><h2 class="title">
	25	<a name="boost_integer"></a>Boost.Integer</h2></div>
	26	<div><div class="authorgroup">
	27	<div class="author"><h3 class="author">
	28	<span class="firstname">Beman</span> <span class="surname">Dawes</span>
	29	</h3></div>
	30	<div class="author"><h3 class="author">
	31	<span class="firstname">Daryle</span> <span class="surname">Walker</span>
	32	</h3></div>
	33	<div class="author"><h3 class="author">
	34	<span class="firstname">Gennaro</span> <span class="surname">Prota</span>
	35	</h3></div>
	36	<div class="author"><h3 class="author">
	37	<span class="firstname">John</span> <span class="surname">Maddock</span>
	38	</h3></div>
	39	</div></div>
	40	<div><p class="copyright">Copyright © 2001-2009 Beman
	41	Dawes, Daryle Walker, Gennaro Prota, John Maddock</p></div>
	42	<div><div class="legalnotice">
	43	<a name="boost_integer.legal"></a><p>
	44	Distributed under the Boost Software License, Version 1.0. (See accompanying
	45	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>)
	46	</p>
	47	</div></div>
	48	</div>
	49	<hr>
	50	</div>
	51	<div class="toc">
	52	<p><b>Table of Contents</b></p>
	53	<dl class="toc">
	54	<dt><span class="section"><a href="index.html#boost_integer.overview">Overview</a></span></dt>
	55	<dt><span class="section"><a href="boost_integer/traits.html">Integer Traits</a></span></dt>
	56	<dt><span class="section"><a href="boost_integer/integer.html">Integer Type Selection</a></span></dt>
	57	<dt><span class="section"><a href="boost_integer/mask.html">Integer Masks</a></span></dt>
	58	<dt><span class="section"><a href="boost_integer/log2.html">Compile Time log2 Calculation</a></span></dt>
	59	<dt><span class="section"><a href="boost_integer/minmax.html">Compile time min/max calculation</a></span></dt>
	60	<dt><span class="section"><a href="boost_integer/history.html">History</a></span></dt>
	61	<dt><span class="section"><a href="boost_integer/cstdint.html">Removed from library: Standard Integer
	62	Types</a></span></dt>
	63	</dl>
	64	</div>
65	<div class="section">
66	<div class="titlepage"><div><div><h2 class="title" style="clear: both">
67	<a name="boost_integer.overview"></a><a class="link" href="index.html#boost_integer.overview" title="Overview">Overview</a>
68	</h2></div></div></div>
69	<p>
70	Boost.Integer provides integer type support, particularly helpful in generic
71	programming. It provides the means to select an integer type based upon its
72	properties, like the number of bits or the maximum supported value, as well
73	as compile-time bit mask selection. There is a derivative of std::numeric_limits
74	that provides integral constant expressions for <code class="computeroutput"><span class="identifier">min</span></code>
75	and <code class="computeroutput"><span class="identifier">max</span></code>. Finally, it provides
76	two compile-time algorithms: determining the highest power of two in a compile-time
77	value; and computing min and max of constant expressions.
78	</p>
79	<div class="informaltable"><table class="table">
80	<colgroup>
81	<col>
82	<col>
83	<col>
84	</colgroup>
85	<thead><tr>
86	<th>
87	<p>
88	Component
89	</p>
90	</th>
91	<th>
92	<p>
93	Header
94	</p>
95	</th>
96	<th>
97	<p>
98	Purpose
99	</p>
100	</th>
101	</tr></thead>
102	<tbody>
103	<tr>
104	<td>
105	<p>
106	Forward Declarations.
107	</p>
108	</td>
109	<td>
110	<p>
111	<code class="literal"><a href="../../../../boost/integer_fwd.hpp" target="_top"><boost/integer_fwd.hpp></a></code>
112	</p>
113	</td>
114	<td>
115	<p>
116	Forward declarations of classes and class templates - for use when
117	just the name of a class is needed.
118	</p>
119	</td>
120	</tr>
121	<tr>
122	<td>
123	<p>
124	<a class="link" href="boost_integer/traits.html" title="Integer Traits">Integer Traits</a>.
125	</p>
126	</td>
127	<td>
128	<p>
129	<code class="literal"><a href="../../../../boost/integer_traits.hpp" target="_top"><boost/integer_traits.hpp></a></code>
130	</p>
131	</td>
132	<td>
133	<p>
134	Class template <code class="literal">boost::integer_traits</code>, derives
135	from <code class="literal">std::numeric_limits</code> and adds <code class="literal">const_min</code>
136	and <code class="literal">const_max</code> members.
137	</p>
138	</td>
139	</tr>
140	<tr>
141	<td>
142	<p>
143	<a class="link" href="boost_integer/integer.html" title="Integer Type Selection">Integer Type Selection</a>.
144	</p>
145	</td>
146	<td>
147	<p>
148	<code class="literal"><a href="../../../../boost/integer.hpp" target="_top"><boost/integer.hpp></a></code>
149	</p>
150	</td>
151	<td>
152	<p>
153	Templates for integer type selection based on properties such as
154	maximum value or number of bits: Use to select the type of an integer
155	when some property such as maximum value or number of bits is known.
156	Useful for generic programming.
157	</p>
158	</td>
159	</tr>
160	<tr>
161	<td>
162	<p>
163	<a class="link" href="boost_integer/mask.html" title="Integer Masks">Integer Masks</a>.
164	</p>
165	</td>
166	<td>
167	<p>
168	<code class="literal"><a href="../../../../boost/integer/integer_mask.hpp" target="_top"><boost/integer/integer_mask.hpp></a></code>
169	</p>
170	</td>
171	<td>
172	<p>
173	Templates for the selection of integer masks, single or lowest group,
174	based on the number of bits: Use to select a particular mask when
175	the bit position(s) are based on a compile-time variable. Useful
176	for generic programming.
177	</p>
178	</td>
179	</tr>
180	<tr>
181	<td>
182	<p>
183	<a class="link" href="boost_integer/log2.html" title="Compile Time log2 Calculation">Compile time log2 Calculation</a>.
184	</p>
185	</td>
186	<td>
187	<p>
188	<code class="literal"><a href="../../../../boost/integer/static_log2.hpp" target="_top"><boost/integer/static_log2.hpp></a></code>
189	</p>
190	</td>
191	<td>
192	<p>
193	Template for finding the highest power of two in a number: Use to
194	find the bit-size/range based on a maximum value. Useful for generic
195	programming.
196	</p>
197	</td>
198	</tr>
199	<tr>
200	<td>
201	<p>
202	<a class="link" href="boost_integer/minmax.html" title="Compile time min/max calculation">Compile time min/max calculation</a>.
203	</p>
204	</td>
205	<td>
206	<p>
207	<code class="literal"><a href="../../../../boost/integer/static_min_max.hpp" target="_top"><boost/integer/static_min_max.hpp></a></code>
208	</p>
209	</td>
210	<td>
211	<p>
212	Templates for finding the extrema of two numbers: Use to find a bound
213	based on a minimum or maximum value. Useful for generic programming.
214	</p>
215	</td>
216	</tr>
217	</tbody>
218	</table></div>
219	</div>
220	</div>
221	<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
222	<td align="left"><p><small>Last revised: June 01, 2014 at 19:57:36 GMT</small></p></td>
223	<td align="right"><div class="copyright-footer"></div></td>
224	</tr></table>
225	<hr>
226	<div class="spirit-nav"><a accesskey="n" href="boost_integer/traits.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a></div>
227	</body>
228	</html>