mirror of
https://github.com/boostorg/safe_numerics.git
synced 2026-02-09 11:22:23 +00:00
189 lines
8.7 KiB
HTML
189 lines
8.7 KiB
HTML
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
|
|
<title>safe_signed_range<MIN, MAX, PP, EP> and safe_unsigned_range<MIN, MAX, PP, EP></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="types.html" title="Types">
|
|
<link rel="prev" href="safe.html" title="safe<T, PP = boost::numeric::native, EP = boost::numeric::throw_exception>">
|
|
<link rel="next" href="promotion_policies.html" title="Promotion Policies">
|
|
</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="safe.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="types.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="promotion_policies.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.safe_unsigned_range"></a>safe_signed_range<MIN, MAX, PP, EP> and
|
|
safe_unsigned_range<MIN, MAX, PP, EP></h3></div></div></div>
|
|
<div class="toc"><dl>
|
|
<dt><span class="section"><a href="safe_unsigned_range.html#idm241517164016">Description</a></span></dt>
|
|
<dt><span class="section"><a href="safe_unsigned_range.html#idm241517161056">Notation</a></span></dt>
|
|
<dt><span class="section"><a href="safe_unsigned_range.html#idm241517153728">Associated Types</a></span></dt>
|
|
<dt><span class="section"><a href="safe_unsigned_range.html#idm241517146640">Template Parameters</a></span></dt>
|
|
<dt><span class="section"><a href="safe_unsigned_range.html#idm241517126224">Model of</a></span></dt>
|
|
<dt><span class="section"><a href="safe_unsigned_range.html#idm241517123632">Valid Expressions</a></span></dt>
|
|
<dt><span class="section"><a href="safe_unsigned_range.html#idm241517121344">Header</a></span></dt>
|
|
<dt><span class="section"><a href="safe_unsigned_range.html#idm241517119248">Example of use</a></span></dt>
|
|
</dl></div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h4 class="title">
|
|
<a name="idm241517164016"></a>Description</h4></div></div></div>
|
|
<p>This type holds a signed or unsigned integer in the closed range
|
|
[MIN, MAX]. A <code class="computeroutput">safe_signed_range<MIN, MAX, PP, EP></code> or
|
|
<code class="computeroutput">safe_unsigned_range<MIN, MAX, PP, EP></code> can be used
|
|
anywhere an arithmetic type is permitted. Any expression which uses either
|
|
of these types is guarenteed to return an arithmetically correct value or
|
|
trap in some way.</p>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h4 class="title">
|
|
<a name="idm241517161056"></a>Notation</h4></div></div></div>
|
|
<div class="informaltable"><table class="table">
|
|
<colgroup>
|
|
<col align="left">
|
|
<col align="left">
|
|
</colgroup>
|
|
<thead><tr>
|
|
<th align="left">Symbol</th>
|
|
<th align="left">Description</th>
|
|
</tr></thead>
|
|
<tbody><tr>
|
|
<td align="left"><code class="computeroutput">MIN, MAX</code></td>
|
|
<td align="left">Minimum and maximum values that the range can
|
|
represent.</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h4 class="title">
|
|
<a name="idm241517153728"></a>Associated Types</h4></div></div></div>
|
|
<div class="informaltable"><table class="table">
|
|
<colgroup>
|
|
<col align="left">
|
|
<col align="left">
|
|
</colgroup>
|
|
<tbody>
|
|
<tr>
|
|
<td align="left"><code class="computeroutput">PP</code></td>
|
|
<td align="left">Promotion Pollicy. A type which specifes the result type of
|
|
an expression using safe types.</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="left"><code class="computeroutput">EP</code></td>
|
|
<td align="left">Exception Policy. A type containing members which are
|
|
called when a correct result cannot be returned</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h4 class="title">
|
|
<a name="idm241517146640"></a>Template Parameters</h4></div></div></div>
|
|
<div class="informaltable"><table class="table">
|
|
<colgroup>
|
|
<col align="left">
|
|
<col align="left">
|
|
<col align="left">
|
|
</colgroup>
|
|
<thead><tr>
|
|
<th align="left">Parameter</th>
|
|
<th align="left">Requirements</th>
|
|
<th align="left">Description</th>
|
|
</tr></thead>
|
|
<tbody>
|
|
<tr>
|
|
<td align="left"><code class="computeroutput">MIN</code></td>
|
|
<td align="left">must be non-integer literal</td>
|
|
<td align="left">The minimum non-negative integer value that this type may
|
|
hold</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="left"><code class="computeroutput">MAX</code></td>
|
|
<td align="left">must be a non-negative literal</td>
|
|
<td align="left">The maximum non-negative integer value that this type may
|
|
hold</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="left"> </td>
|
|
<td align="left">MIN <= MAX</td>
|
|
<td align="left">must be a valid closed range</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="left"><code class="computeroutput">PP</code></td>
|
|
<td align="left"><a class="link" href="numeric.html" title="Numeric<T>"><a class="link" href="promotion_policy.html" title="PromotionPolicy<PP>">PromotionPolicy<PP></a></a></td>
|
|
<td align="left"><p>Default value is <a class="link" href="promotion_policy.html#safe_numerics.promotion_policy.models.native">boost::numeric::native</a></p></td>
|
|
</tr>
|
|
<tr>
|
|
<td align="left"><code class="computeroutput">EP</code></td>
|
|
<td align="left"><a class="link" href="numeric.html" title="Numeric<T>"><a class="link" href="exception_policy.html" title="ExceptionPolicy<EP>">Exception
|
|
Policy<EP></a></a></td>
|
|
<td align="left"><p>Default value is <a class="link" href="exception_policy.html#safe_numerics.exception_policy.models.thow_exception">boost::numeric::throw_exception</a></p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h4 class="title">
|
|
<a name="idm241517126224"></a>Model of</h4></div></div></div>
|
|
<p><a class="link" href="numeric.html" title="Numeric<T>">Integer</a></p>
|
|
<p><a class="link" href="safe_numeric_concept.html" title="SafeNumeric<T>">SafeNumeric</a></p>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h4 class="title">
|
|
<a name="idm241517123632"></a>Valid Expressions</h4></div></div></div>
|
|
<p>Implements all expressions and only those expressions defined by the
|
|
<a class="link" href="safe_numeric_concept.html" title="SafeNumeric<T>">SafeNumeric</a> type
|
|
requirements. This, the result type of such an expression will be another
|
|
safe type. The actual type of the result of such an expression will depend
|
|
upon the specific promotion policy template parameter.</p>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h4 class="title">
|
|
<a name="idm241517121344"></a>Header</h4></div></div></div>
|
|
<p><code class="filename"><a href="../../include/safe_range.hpp" target="_top">#include
|
|
<safe/numeric/safe_range.hpp></a></code></p>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h4 class="title">
|
|
<a name="idm241517119248"></a>Example of use</h4></div></div></div>
|
|
<pre class="programlisting">#include <safe/numeric/safe_range.hpp>
|
|
|
|
void f(){
|
|
using namespace boost::numeric;
|
|
safe_unsigned_range<7, 24> i
|
|
// since the range is included in [0,255], the underlying type of i
|
|
// will be an unsigned char.
|
|
i = 0; // throws out_of_range exception
|
|
i = 9; // ok
|
|
i *= 9; // throws out_of_range exception
|
|
i = -1; // throws out_of_range exception
|
|
std::uint8_t j = 4;
|
|
auto k = i + j;
|
|
|
|
// the range of i is [7, 24] and the range of j is [0,255]
|
|
// if either or both types are safe types, the result is a safe type
|
|
// determined by promotion policy. With the default native promotion policy
|
|
// k will be safe<unsigned int>
|
|
static_assert(std::is_same<decltype(k), safe<unsigned int>);
|
|
}</pre>
|
|
</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 © 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="safe.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="types.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="promotion_policies.html"><img src="images/next.png" alt="Next"></a>
|
|
</div>
|
|
</body>
|
|
</html>
|