checked_arithmetic.html 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
  4. <title>Checked Arithmetic</title>
  5. <link rel="stylesheet" href="boostbook.css" type="text/css">
  6. <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
  7. <link rel="home" href="index.html" title="Safe Numerics">
  8. <link rel="up" href="library_implementation.html" title="Library Implementation">
  9. <link rel="prev" href="checked_result.html" title="checked_result&lt;R&gt;">
  10. <link rel="next" href="interval.html" title="interval&lt;R&gt;">
  11. </head>
  12. <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13. <table cellpadding="2" width="100%"><tr>
  14. <td valign="top"><img href="index.html" height="164px" src="pre-boost.jpg" alt="Library Documentation Index"></td>
  15. <td><h2>Safe Numerics</h2></td>
  16. </tr></table>
  17. <div class="spirit-nav">
  18. <a accesskey="p" href="checked_result.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="library_implementation.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="interval.html"><img src="images/next.png" alt="Next"></a>
  19. </div>
  20. <div class="section">
  21. <div class="titlepage"><div><div><h3 class="title">
  22. <a name="safe_numerics.checked_arithmetic"></a>Checked Arithmetic</h3></div></div></div>
  23. <div class="toc"><dl class="toc">
  24. <dt><span class="section"><a href="checked_arithmetic.html#idm130202409440">Description</a></span></dt>
  25. <dt><span class="section"><a href="checked_arithmetic.html#idm130202408112">Type requirements</a></span></dt>
  26. <dt><span class="section"><a href="checked_arithmetic.html#idm130202406112">Complexity</a></span></dt>
  27. <dt><span class="section"><a href="checked_arithmetic.html#idm130202404960">Example of use</a></span></dt>
  28. <dt><span class="section"><a href="checked_arithmetic.html#idm130202387696">Notes</a></span></dt>
  29. <dt><span class="section"><a href="checked_arithmetic.html#idm130202386128">Synopsis</a></span></dt>
  30. <dt><span class="section"><a href="checked_arithmetic.html#idm130202157712">See Also</a></span></dt>
  31. <dt><span class="section"><a href="checked_arithmetic.html#idm130202155984">Header</a></span></dt>
  32. </dl></div>
  33. <div class="section">
  34. <div class="titlepage"><div><div><h4 class="title">
  35. <a name="idm130202409440"></a>Description</h4></div></div></div>
  36. <p>Perform binary operations on arithmetic types. Return either a valid
  37. result or an error code. Under no circumstances should an incorrect result
  38. be returned.</p>
  39. </div>
  40. <div class="section">
  41. <div class="titlepage"><div><div><h4 class="title">
  42. <a name="idm130202408112"></a>Type requirements</h4></div></div></div>
  43. <p>All template parameters of the functions must model <a class="link" href="integer.html" title="Integer&lt;T&gt;">Numeric</a> type requirements.</p>
  44. </div>
  45. <div class="section">
  46. <div class="titlepage"><div><div><h4 class="title">
  47. <a name="idm130202406112"></a>Complexity</h4></div></div></div>
  48. <p>Each function performs one and only one arithmetic operation.</p>
  49. </div>
  50. <div class="section">
  51. <div class="titlepage"><div><div><h4 class="title">
  52. <a name="idm130202404960"></a>Example of use</h4></div></div></div>
  53. <pre class="programlisting"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">numeric</span><span class="special">/</span><span class="identifier">safe_numerics</span><span class="special">/</span><span class="identifier">checked_default</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
  54. <span class="identifier">checked_result</span><span class="special">&lt;</span><span class="keyword">int</span><span class="special">&gt;</span> <span class="identifier">r</span> <span class="special">=</span> <span class="identifier">checked</span><span class="special">::</span><span class="identifier">multiply</span><span class="special">&lt;</span><span class="keyword">int</span><span class="special">&gt;</span><span class="special">(</span><span class="number">24</span><span class="special">,</span> <span class="number">42</span><span class="special">)</span><span class="special">;</span>
  55. </pre>
  56. </div>
  57. <div class="section">
  58. <div class="titlepage"><div><div><h4 class="title">
  59. <a name="idm130202387696"></a>Notes</h4></div></div></div>
  60. <p>Some compilers have command line switches (e.g. -ftrapv) which
  61. enable special behavior such that erroneous integer operations are
  62. detected at run time. The library has been implemented in such a way that
  63. these facilities are not used. It's possible they might be helpful in
  64. particular environment. These could be be exploited by re-implementing
  65. some functions in this library.</p>
  66. </div>
  67. <div class="section">
  68. <div class="titlepage"><div><div><h4 class="title">
  69. <a name="idm130202386128"></a>Synopsis</h4></div></div></div>
  70. <pre class="programlisting"><span class="comment">// safe casting on primitive types</span>
  71. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">T</span><span class="special">&gt;</span>
  72. <span class="identifier">checked_result</span><span class="special">&lt;</span><span class="identifier">R</span><span class="special">&gt;</span> <span class="keyword">constexpr</span> <span class="identifier">checked</span><span class="special">::</span><span class="identifier">cast</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&amp;</span> <span class="identifier">t</span><span class="special">)</span><span class="special">;</span>
  73. <span class="comment">// safe addition on primitive types</span>
  74. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span>
  75. <span class="identifier">checked_result</span><span class="special">&lt;</span><span class="identifier">R</span><span class="special">&gt;</span> <span class="keyword">constexpr</span> <span class="identifier">checked</span><span class="special">::</span><span class="identifier">add</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">R</span> <span class="special">&amp;</span> <span class="identifier">t</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">R</span> <span class="special">&amp;</span> <span class="identifier">u</span><span class="special">)</span><span class="special">;</span>
  76. <span class="comment">// safe subtraction on primitive types</span>
  77. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span>
  78. <span class="identifier">checked_result</span><span class="special">&lt;</span><span class="identifier">R</span><span class="special">&gt;</span> <span class="keyword">constexpr</span> <span class="identifier">checked</span><span class="special">::</span><span class="identifier">subtract</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">R</span> <span class="special">&amp;</span> <span class="identifier">t</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">R</span> <span class="special">&amp;</span> <span class="identifier">u</span><span class="special">)</span><span class="special">;</span>
  79. <span class="comment">// safe multiplication on primitive types</span>
  80. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span>
  81. <span class="identifier">checked_result</span><span class="special">&lt;</span><span class="identifier">R</span><span class="special">&gt;</span> <span class="keyword">constexpr</span> <span class="identifier">checked</span><span class="special">::</span><span class="identifier">multiply</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">R</span> <span class="special">&amp;</span> <span class="identifier">t</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">R</span> <span class="special">&amp;</span> <span class="identifier">u</span><span class="special">)</span><span class="special">;</span>
  82. <span class="comment">// safe division on primitive types</span>
  83. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span>
  84. <span class="identifier">checked_result</span><span class="special">&lt;</span><span class="identifier">R</span><span class="special">&gt;</span> <span class="keyword">constexpr</span> <span class="identifier">checked</span><span class="special">::</span><span class="identifier">divide</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">R</span> <span class="special">&amp;</span> <span class="identifier">t</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">R</span> <span class="special">&amp;</span> <span class="identifier">u</span><span class="special">)</span><span class="special">;</span>
  85. <span class="comment">// safe modulus on primitive types</span>
  86. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span>
  87. <span class="identifier">checked_result</span><span class="special">&lt;</span><span class="identifier">R</span><span class="special">&gt;</span> <span class="keyword">constexpr</span> <span class="identifier">checked</span><span class="special">::</span><span class="identifier">modulus</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">R</span> <span class="special">&amp;</span> <span class="identifier">t</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">R</span> <span class="special">&amp;</span> <span class="identifier">u</span><span class="special">)</span><span class="special">;</span>
  88. <span class="comment">// safe less than predicate on primitive types</span>
  89. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span>
  90. <span class="keyword">bool</span> <span class="keyword">constexpr</span> <span class="identifier">checked</span><span class="special">::</span><span class="identifier">less_than</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">R</span> <span class="special">&amp;</span> <span class="identifier">t</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">R</span> <span class="special">&amp;</span> <span class="identifier">u</span><span class="special">)</span><span class="special">;</span>
  91. <span class="comment">// safe greater_than_equal predicate on primitive types</span>
  92. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span>
  93. <span class="keyword">bool</span> <span class="keyword">constexpr</span> <span class="identifier">checked</span><span class="special">::</span><span class="identifier">greater_than_equal</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">R</span> <span class="special">&amp;</span> <span class="identifier">t</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">R</span> <span class="special">&amp;</span> <span class="identifier">u</span><span class="special">)</span><span class="special">;</span>
  94. <span class="comment">// safe greater_than predicate on primitive types</span>
  95. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span>
  96. <span class="keyword">bool</span> <span class="keyword">constexpr</span> <span class="identifier">checked</span><span class="special">::</span><span class="identifier">greater_than</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">R</span> <span class="special">&amp;</span> <span class="identifier">t</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">R</span> <span class="special">&amp;</span> <span class="identifier">u</span><span class="special">)</span><span class="special">;</span>
  97. <span class="comment">// safe less_than_equal predicate on primitive types</span>
  98. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span>
  99. <span class="keyword">bool</span> <span class="keyword">constexpr</span> <span class="identifier">checked</span><span class="special">::</span><span class="identifier">less_than_equal</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">R</span> <span class="special">&amp;</span> <span class="identifier">t</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">R</span> <span class="special">&amp;</span> <span class="identifier">u</span><span class="special">)</span><span class="special">;</span>
  100. <span class="comment">// safe equal predicate on primitive types</span>
  101. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span>
  102. <span class="keyword">bool</span> <span class="keyword">constexpr</span> <span class="identifier">checked</span><span class="special">::</span><span class="identifier">equal</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">R</span> <span class="special">&amp;</span> <span class="identifier">t</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">R</span> <span class="special">&amp;</span> <span class="identifier">u</span><span class="special">)</span><span class="special">;</span>
  103. <span class="comment">// left shift</span>
  104. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span>
  105. <span class="identifier">checked_result</span><span class="special">&lt;</span><span class="identifier">R</span><span class="special">&gt;</span> <span class="keyword">constexpr</span> <span class="identifier">checked</span><span class="special">::</span><span class="identifier">left_shift</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">R</span> <span class="special">&amp;</span> <span class="identifier">t</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">R</span> <span class="special">&amp;</span> <span class="identifier">u</span><span class="special">)</span><span class="special">;</span>
  106. <span class="comment">// right shift</span>
  107. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span>
  108. <span class="identifier">checked_result</span><span class="special">&lt;</span><span class="identifier">R</span><span class="special">&gt;</span> <span class="keyword">constexpr</span> <span class="identifier">checked</span><span class="special">::</span><span class="identifier">right_shift</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">R</span> <span class="special">&amp;</span> <span class="identifier">t</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">R</span> <span class="special">&amp;</span> <span class="identifier">u</span><span class="special">)</span><span class="special">;</span>
  109. <span class="comment">// bitwise operations</span>
  110. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span>
  111. <span class="identifier">checked_result</span><span class="special">&lt;</span><span class="identifier">R</span><span class="special">&gt;</span> <span class="keyword">constexpr</span> <span class="identifier">checked</span><span class="special">::</span><span class="identifier">bitwise_or</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">R</span> <span class="special">&amp;</span> <span class="identifier">t</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">R</span> <span class="special">&amp;</span> <span class="identifier">u</span><span class="special">)</span><span class="special">;</span>
  112. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span>
  113. <span class="identifier">checked_result</span><span class="special">&lt;</span><span class="identifier">R</span><span class="special">&gt;</span> <span class="keyword">constexpr</span> <span class="identifier">checked</span><span class="special">::</span><span class="identifier">bitwise_and</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">R</span> <span class="special">&amp;</span> <span class="identifier">t</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">R</span> <span class="special">&amp;</span> <span class="identifier">u</span><span class="special">)</span><span class="special">;</span>
  114. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span>
  115. <span class="identifier">checked_result</span><span class="special">&lt;</span><span class="identifier">R</span><span class="special">&gt;</span> <span class="keyword">constexpr</span> <span class="identifier">checked</span><span class="special">::</span><span class="identifier">bitwise_xor</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">R</span> <span class="special">&amp;</span> <span class="identifier">t</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">R</span> <span class="special">&amp;</span> <span class="identifier">u</span><span class="special">)</span><span class="special">;</span>
  116. </pre>
  117. </div>
  118. <div class="section">
  119. <div class="titlepage"><div><div><h4 class="title">
  120. <a name="idm130202157712"></a>See Also</h4></div></div></div>
  121. <p><a class="link" href="checked_result.html" title="checked_result&lt;R&gt;">checked_result&lt;R&gt;</a></p>
  122. </div>
  123. <div class="section">
  124. <div class="titlepage"><div><div><h4 class="title">
  125. <a name="idm130202155984"></a>Header</h4></div></div></div>
  126. <p><a href="../../include/checked.hpp" target="_top"><code class="computeroutput">#include
  127. &lt;boost/numeric/safe_numerics/checked_default.hpp&gt;
  128. </code></a></p>
  129. <p><a href="../../include/checked_integer.hpp" target="_top"><code class="computeroutput">#include
  130. &lt;boost/numeric/safe_numerics/checked_integer.hpp&gt;
  131. </code></a></p>
  132. <p><a href="../../include/checked.hpp" target="_top"><code class="computeroutput"></code></a><a href="../../include/checked_float.hpp" target="_top"><code class="computeroutput">#include
  133. &lt;boost/numeric/safe_numerics/checked_float.hpp&gt;
  134. </code></a></p>
  135. </div>
  136. </div>
  137. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  138. <td align="left"></td>
  139. <td align="right"><div class="copyright-footer">Copyright &#169; 2012-2018 Robert Ramey<p><a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">Subject to Boost
  140. Software License</a></p>
  141. </div></td>
  142. </tr></table>
  143. <hr>
  144. <div class="spirit-nav">
  145. <a accesskey="p" href="checked_result.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="library_implementation.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="interval.html"><img src="images/next.png" alt="Next"></a>
  146. </div>
  147. </body>
  148. </html>