Files
safe_numerics/doc/html/integer.html
Robert Ramey 63dd89210e Enabled Boost Book syntax highlighting
improved TOC and chunking.  This is complicated by the fact we that we desire different depths.
put copies of boost logo in subdirectories
2016-02-07 14:38:06 -08:00

98 lines
5.0 KiB
HTML

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Integer&lt;T&gt;</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Safe Numerics">
<link rel="up" href="concepts.html" title="Type Requirements">
<link rel="prev" href="numeric.html" title="Numeric&lt;T&gt;">
<link rel="next" href="safe_numeric_concept.html" title="SafeNumeric&lt;T&gt;">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img href="index.html" height="164px" src="pre-boost.jpg" alt="Library Documentation Index"></td>
<td><h2>Safe Numerics</h2></td>
</tr></table>
<div class="spirit-nav">
<a accesskey="p" href="numeric.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="concepts.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="safe_numeric_concept.html"><img src="images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="safe_numerics.integer"></a>Integer&lt;T&gt;</h3></div></div></div>
<div class="toc"><dl>
<dt><span class="section"><a href="integer.html#idm413204195424">Description</a></span></dt>
<dt><span class="section"><a href="integer.html#idm413204188736">Refinement of</a></span></dt>
<dt><span class="section"><a href="integer.html#idm413204186960">Valid Expressions</a></span></dt>
<dt><span class="section"><a href="integer.html#idm413204179056">Header</a></span></dt>
<dt><span class="section"><a href="integer.html#idm413204176896">Models</a></span></dt>
</dl></div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="idm413204195424"></a>Description</h4></div></div></div>
<p>A type is fulls the requirements of an Integer if it has the
properties of a integer.</p>
<p>More specifically, a type T is Integer if there exists
specialization of <code class="computeroutput">std::numeric_limits&lt;T&gt; for which
std::numeric_limits&lt;T&gt;:: is_integer</code> is equal to
<code class="computeroutput">true</code>. See the documentation for standard library class
numeric_limits. The standard library includes such specializations for all
the primitive numeric types. Note that this concept is distinct from the
C++ standard library type traits <code class="computeroutput">is_integral</code> and
<code class="computeroutput">is_arithmetic</code>. These latter fulfill the requirement of the
concept Numeric. But there are types which fulfill this concept for which
<code class="computeroutput">is_arithmetic&lt;T&gt;::value == false</code>. For example see
<code class="computeroutput">safe&lt;int&gt;</code>.</p>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="idm413204188736"></a>Refinement of</h4></div></div></div>
<p><a class="link" href="numeric.html" title="Numeric&lt;T&gt;">Numeric</a></p>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="idm413204186960"></a>Valid Expressions</h4></div></div></div>
<p>In addition to the expressions defined in <a class="link" href="numeric.html" title="Numeric&lt;T&gt;">Numeric</a> the following expressions
must be valid. </p>
<div class="informaltable"><table class="table">
<colgroup>
<col align="left">
<col align="left">
</colgroup>
<thead><tr>
<th align="left">Expression</th>
<th align="left">Return Value</th>
</tr></thead>
<tbody><tr>
<td align="left"><code class="computeroutput">std::numeric_limits&lt;T&gt;
is_integer</code></td>
<td align="left">true</td>
</tr></tbody>
</table></div>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="idm413204179056"></a>Header</h4></div></div></div>
<p><a href="../../include/concept/numeric.hpp" target="_top"><code class="computeroutput">#include
&lt;safe_numerics/include/concepts/numeric.hpp&gt; </code></a></p>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="idm413204176896"></a>Models</h4></div></div></div>
<p><code class="computeroutput">int, safe&lt;int&gt;, safe_unsigned_range&lt;0, 11&gt;,
etc.</code></p>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2012 Robert Ramey<p><a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">Subject to Boost
Software License</a></p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="numeric.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="concepts.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="safe_numeric_concept.html"><img src="images/next.png" alt="Next"></a>
</div>
</body>
</html>