boost/safe_numerics
2
0
Fork 0
mirror of https://github.com/boostorg/safe_numerics.git synced 2026-02-23 16:02:13 +00:00
Code Issues Projects Releases Wiki Activity
Files
bb54d2bf8fd07baae18fbb0c245bf19709d3516e
safe_numerics/doc/boostbook/interval.xml
Robert Ramey 1bc0b94e65 changes to implement the following: 
a) made trap_exception work
b) updated manual and examples to show how to use library to eliminate runtime penalty
c) added in safe_literal
d) made corrections of various types
2015-12-21 23:14:06 -08:00

334 lines
8.7 KiB
XML
Raw Blame History

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE section PUBLIC "-//Boost//DTD BoostBook XML V1.1//EN"
"http://www.boost.org/tools/boostbook/dtd/boostbook.dtd">
<section id="safe_numerics.interval">
<title>interval&lt;typename R&gt;</title>
<section>
<title>Description</title>
<para>A closed arithmetic interval represented by a pair of elements of
type R.</para>
</section>
<section>
<title>Template Parameters</title>
<para>R must model the type requirements <link
linkend="safe_numerics.numeric">Numeric</link></para>
</section>
<section>
<title>Notation</title>
<informaltable>
<tgroup cols="2">
<colspec align="left" colwidth="1*"/>
<colspec align="left" colwidth="4*"/>
<thead>
<row>
<entry align="left">Symbol</entry>
<entry align="left">Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><code>I</code></entry>
<entry>An interval type</entry>
</row>
<row>
<entry><code>i, j</code></entry>
<entry>An interval</entry>
</row>
<row>
<entry><code>R, T</code></entry>
<entry>Numeric types which can be used to make an interval</entry>
</row>
<row>
<entry><code>l, u</code></entry>
<entry>lower and upper Numeric limits of an interval</entry>
</row>
<row>
<entry><code>C</code></entry>
<entry>checked_result&lt;interval&lt;R&gt;&gt;</entry>
</row>
<row>
<entry><code>os</code></entry>
<entry>std::basic_ostream&lt;Char, CharT&gt;</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</section>
<section>
<title>Associated Types</title>
<informaltable>
<tgroup cols="2">
<colspec align="left" colwidth="1*"/>
<colspec align="left" colwidth="4*"/>
<tbody>
<row>
<entry><link
linkend="safenumerics.checked_result"><code>checked_result</code></link></entry>
<entry>holds either the result of an operation or information as
to why it failed</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</section>
<section>
<title>Valid Expressions</title>
<para>Note that all expressions are constexpr .</para>
<para><informaltable>
<tgroup cols="3">
<colspec align="left" colwidth="1*"/>
<colspec align="left" colwidth="1*"/>
<colspec align="left" colwidth="3*"/>
<thead>
<row>
<entry align="left">Expression</entry>
<entry>Return Type</entry>
<entry>Semantics</entry>
</row>
</thead>
<tbody>
<row>
<entry><code>interval&lt;R&gt;(l, u)</code></entry>
<entry><code>interval&lt;R&gt;</code></entry>
<entry>construct a new interval from a pair of limits</entry>
</row>
<row>
<entry><code>interval&lt;R&gt;(p)</code></entry>
<entry><code>interval&lt;R&gt;</code></entry>
<entry>construct a new interval from a pair of limits</entry>
</row>
<row>
<entry><code>interval&lt;R&gt;(i)</code></entry>
<entry><code>interval&lt;R&gt;</code></entry>
<entry>copy constructor</entry>
</row>
<row>
<entry><code>i.includes(j)</code></entry>
<entry><code>bool</code></entry>
<entry>return true if interval i includes interval j</entry>
</row>
<row>
<entry><code>i.includes(t)</code></entry>
<entry><code>bool</code></entry>
<entry>return true if interval i includes value t</entry>
</row>
<row>
<entry><code>add&lt;R&gt;(i, j)</code></entry>
<entry><code>C</code></entry>
<entry>add two intervals and return the result</entry>
</row>
<row>
<entry><code>subtract&lt;R&gt;(i, j)</code></entry>
<entry><code>C</code></entry>
<entry>subtract two intervals and return the result</entry>
</row>
<row>
<entry><code>multiply&lt;R&gt;(i, j)</code></entry>
<entry><code>C</code></entry>
<entry>multiply two intervals and return the result</entry>
</row>
<row>
<entry><code>divide_nz&lt;R&gt;(i, j)</code></entry>
<entry><code>C</code></entry>
<entry>divide one interval by another excluding the value zero
and return the result</entry>
</row>
<row>
<entry><code>divide&lt;R&gt;(i, j)</code></entry>
<entry><code>C</code></entry>
<entry>divide one interval by another and return the
result</entry>
</row>
<row>
<entry><code>modulus_nz&lt;R&gt;(i, j)</code></entry>
<entry><code>C</code></entry>
<entry>calculate modulus of one interval by another excluding
the value zero and return the result</entry>
</row>
<row>
<entry><code>modulus&lt;R&gt;(i, j)</code></entry>
<entry><code>C</code></entry>
<entry>calculate modulus of one interval by another and return
the result</entry>
</row>
<row>
<entry><code>left_shift&lt;R&gt;(i, j)</code></entry>
<entry><code>C</code></entry>
<entry>calculate the range that would result from shifting one
interval by another</entry>
</row>
<row>
<entry><code>right_shift&lt;R&gt;(i, j)</code></entry>
<entry><code>C</code></entry>
<entry>calculate the range that would result from shifting one
interval by another</entry>
</row>
<row>
<entry><code>t &lt; u</code></entry>
<entry><code>boost::logic::tribool</code></entry>
<entry>true if every element in t is less than every element in
u</entry>
</row>
<row>
<entry><code>t &gt; u</code></entry>
<entry><code>boost::logic::tribool</code></entry>
<entry>true if every element in t is greater than every element
in u</entry>
</row>
<row>
<entry><code>t &lt;= u</code></entry>
<entry><code>boost::logic::tribool</code></entry>
<entry>true if every element in t is less than or equal to every
element in u</entry>
</row>
<row>
<entry><code>t &gt;= u</code></entry>
<entry><code>boost::logic::tribool</code></entry>
<entry>true if every element in t is greater than or equal to
every element in u</entry>
</row>
<row>
<entry><code>t == u</code></entry>
<entry><code>bool</code></entry>
<entry>true if limits are equal</entry>
</row>
<row>
<entry><code>t != u</code></entry>
<entry><code>bool</code></entry>
<entry>true if limits are not equal</entry>
</row>
<row>
<entry><code>os &lt;&lt; i</code></entry>
<entry><code>os &amp;</code></entry>
<entry>print interval to output stream</entry>
</row>
</tbody>
</tgroup>
</informaltable></para>
</section>
<section>
<title>Header</title>
<para><code>#include "interval.hpp"</code></para>
</section>
<section>
<title>Example of use</title>
<programlisting>#include &lt;iostream&gt;
#include &lt;cstdint&gt;
#include &lt;cassert&gt;
#include &lt;boost/numeric/interval.hpp&gt;
int main(){
std::cout &lt;&lt; "test1" &lt;&lt; std::endl;
interval&lt;std::int16_t&gt; x = {-64, 63};
std::cout &lt;&lt; "x = " &lt;&lt; x &lt;&lt; std::endl;
interval&lt;std::int16_t&gt; y(-128, 126);
std::cout &lt;&lt; "y = " &lt;&lt; y &lt;&lt; std::endl;
assert(static_cast&lt;interval&lt;std::int16_t&gt;&gt;(add&lt;std::int16_t&gt;(x,x)) == y);
std::cout &lt;&lt; "x + x =" &lt;&lt; add&lt;std::int16_t&gt;(x, x) &lt;&lt; std::endl;
std::cout &lt;&lt; "x - x = " &lt;&lt; subtract&lt;std::int16_t&gt;(x, x) &lt;&lt; std::endl;
return 0;
}</programlisting>
</section>
</section>
Reference in New Issue View Git Blame Copy Permalink