| <!-- HTML header for doxygen 1.8.15--> |
| <!-- Remember to use version doxygen 1.8.15 +--> |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.15"/> |
| <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines --> |
| <title>Compute Library: arm_compute/core/utils/math/SafeOps.h Source File</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="navtree.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="resize.js"></script> |
| <script type="text/javascript" src="navtreedata.js"></script> |
| <script type="text/javascript" src="navtree.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(initResizable); |
| /* @license-end */</script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <script type="text/x-mathjax-config"> |
| MathJax.Hub.Config({ |
| extensions: ["tex2jax.js"], |
| jax: ["input/TeX","output/HTML-CSS"], |
| }); |
| </script><script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| <link href="stylesheet.css" rel="stylesheet" type="text/css"/> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <img alt="Compute Library" src="https://raw.githubusercontent.com/ARM-software/ComputeLibrary/gh-pages/ACL_logo.png" style="max-width: 100%;margin-top: 15px;margin-left: 10px"/> |
| <td style="padding-left: 0.5em;"> |
| <div id="projectname"> |
|  <span id="projectnumber">20.02.1</span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.15 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</script> |
| <div id="main-nav"></div> |
| </div><!-- top --> |
| <div id="side-nav" class="ui-resizable side-nav-resizable"> |
| <div id="nav-tree"> |
| <div id="nav-tree-contents"> |
| <div id="nav-sync" class="sync"></div> |
| </div> |
| </div> |
| <div id="splitbar" style="-moz-user-select:none;" |
| class="ui-resizable-handle"> |
| </div> |
| </div> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function(){initNavTree('_safe_ops_8h_source.xhtml','');}); |
| /* @license-end */ |
| </script> |
| <div id="doc-content"> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">SafeOps.h</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="_safe_ops_8h.xhtml">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (c) 2019 ARM Limited.</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * SPDX-License-Identifier: MIT</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> *</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a copy</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * of this software and associated documentation files (the "Software"), to</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * deal in the Software without restriction, including without limitation the</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * sell copies of the Software, and to permit persons to whom the Software is</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * furnished to do so, subject to the following conditions:</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> *</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * The above copyright notice and this permission notice shall be included in all</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * copies or substantial portions of the Software.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> *</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * SOFTWARE.</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> */</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#ifndef ARM_COMPUTE_UTILS_MATH_SAFE_OPS</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#define ARM_COMPUTE_UTILS_MATH_SAFE_OPS</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "<a class="code" href="_error_8h.xhtml">arm_compute/core/Error.h</a>"</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "<a class="code" href="_requires_8h.xhtml">arm_compute/core/utils/misc/Requires.h</a>"</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">namespace </span><a class="code" href="namespacearm__compute.xhtml">arm_compute</a></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> {</div><div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="namespacearm__compute_1_1utils.xhtml"> 32</a></span> <span class="keyword">namespace </span>utils</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> {</div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="namespacearm__compute_1_1utils_1_1math.xhtml"> 34</a></span> <span class="keyword">namespace </span>math</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> {<span class="comment"></span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">/** Safe integer addition between two integers. In case of an overflow</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> * the numeric max limit is return. In case of an underflow numeric max</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> * limit is return.</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> *</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> * @tparam T Integer types to add</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> *</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> * @param[in] val_a First value to add</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> * @param[in] val_b Second value to add</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> *</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> * @return The addition result</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> */</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="keyword">template</span> <<span class="keyword">typename</span> T, REQUIRES_TA(std::is_<span class="keywordtype">int</span>egral<T>::value)></div><div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="namespacearm__compute_1_1utils_1_1math.xhtml#a788ba6c7989a35e2979dd0b315e8711f"> 48</a></span> T <a class="code" href="namespacearm__compute_1_1utils_1_1math.xhtml#a788ba6c7989a35e2979dd0b315e8711f">safe_integer_add</a>(T val_a, T val_b)</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> {</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  T result = 0;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordflow">if</span>((val_b > 0) && (val_a > std::numeric_limits<T>::max() - val_b))</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  {</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  result = std::numeric_limits<T>::max();</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  }</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordflow">else</span> <span class="keywordflow">if</span>((val_b < 0) && (val_a < std::numeric_limits<T>::min() - val_b))</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  {</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  result = std::numeric_limits<T>::min();</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  }</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordflow">else</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  {</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  result = val_a + val_b;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  }</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordflow">return</span> result;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> }</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"></span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment">/** Safe integer subtraction between two integers. In case of an overflow</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> * the numeric max limit is return. In case of an underflow numeric max</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> * limit is return.</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> *</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> * @tparam T Integer types to subtract</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> *</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> * @param[in] val_a Value to subtract from</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> * @param[in] val_b Value to subtract</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> *</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> * @return The subtraction result</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> */</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="keyword">template</span> <<span class="keyword">typename</span> T, REQUIRES_TA(std::is_<span class="keywordtype">int</span>egral<T>::value)></div><div class="line"><a name="l00080"></a><span class="lineno"><a class="line" href="namespacearm__compute_1_1utils_1_1math.xhtml#a1e0ef3d630d8020cfa7e09ffada9bec4"> 80</a></span> T <a class="code" href="namespacearm__compute_1_1utils_1_1math.xhtml#a1e0ef3d630d8020cfa7e09ffada9bec4">safe_integer_sub</a>(T val_a, T val_b)</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> {</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  T result = 0;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordflow">if</span>((val_b < 0) && (val_a > std::numeric_limits<T>::max() + val_b))</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  {</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  result = std::numeric_limits<T>::max();</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  }</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordflow">else</span> <span class="keywordflow">if</span>((val_b > 0) && (val_a < std::numeric_limits<T>::min() + val_b))</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  {</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  result = std::numeric_limits<T>::min();</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  }</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keywordflow">else</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  {</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  result = val_a - val_b;</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  }</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordflow">return</span> result;</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> }</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"></span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment">/** Safe integer multiplication between two integers. In case of an overflow</span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> * the numeric max limit is return. In case of an underflow numeric max</span></div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> * limit is return.</span></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> *</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> * @tparam T Integer types to multiply</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> *</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> * @param[in] val_a First value to multiply</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> * @param[in] val_b Second value to multiply</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> *</span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> * @return The multiplication result</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> */</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="keyword">template</span> <<span class="keyword">typename</span> T, REQUIRES_TA(std::is_<span class="keywordtype">int</span>egral<T>::value)></div><div class="line"><a name="l00112"></a><span class="lineno"><a class="line" href="namespacearm__compute_1_1utils_1_1math.xhtml#a3e89b90d50a678e88d7821c5a3ad8326"> 112</a></span> T <a class="code" href="namespacearm__compute_1_1utils_1_1math.xhtml#a3e89b90d50a678e88d7821c5a3ad8326">safe_integer_mul</a>(T val_a, T val_b)</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> {</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  T result = 0;</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> </div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keywordflow">if</span>(val_a > 0)</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  {</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keywordflow">if</span>((val_b > 0) && (val_a > (std::numeric_limits<T>::max() / val_b)))</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  {</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  result = std::numeric_limits<T>::max();</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  }</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keywordflow">else</span> <span class="keywordflow">if</span>(val_b < (std::numeric_limits<T>::min() / val_a))</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  {</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  result = std::numeric_limits<T>::min();</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  }</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keywordflow">else</span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  {</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  result = val_a * val_b;</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  }</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  }</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <span class="keywordflow">else</span></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  {</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <span class="keywordflow">if</span>((val_b > 0) && (val_a < (std::numeric_limits<T>::min() / val_b)))</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  {</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  result = std::numeric_limits<T>::max();</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  }</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="keywordflow">else</span> <span class="keywordflow">if</span>((val_a != 0) && (val_b < (std::numeric_limits<T>::max() / val_a)))</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  {</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  result = std::numeric_limits<T>::min();</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  }</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <span class="keywordflow">else</span></div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  {</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  result = val_a * val_b;</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  }</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  }</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> </div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  <span class="keywordflow">return</span> result;</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> }</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"></span></div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment">/** Safe integer division between two integers. In case of an overflow</span></div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"> * the numeric max limit is return. In case of an underflow numeric max</span></div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment"> * limit is return.</span></div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment"> *</span></div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment"> * @tparam T Integer types to divide</span></div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment"> *</span></div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"> * @param[in] val_a Dividend value</span></div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"> * @param[in] val_b Divisor value</span></div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment"> *</span></div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment"> * @return The quotient</span></div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="comment"> */</span></div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="keyword">template</span> <<span class="keyword">typename</span> T, REQUIRES_TA(std::is_<span class="keywordtype">int</span>egral<T>::value)></div><div class="line"><a name="l00162"></a><span class="lineno"><a class="line" href="namespacearm__compute_1_1utils_1_1math.xhtml#a51d1b0d5c48f48b9605a760e1963b940"> 162</a></span> T <a class="code" href="namespacearm__compute_1_1utils_1_1math.xhtml#a51d1b0d5c48f48b9605a760e1963b940">safe_integer_div</a>(T val_a, T val_b)</div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> {</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  T result = 0;</div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> </div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  <span class="keywordflow">if</span>((val_b == 0) || ((val_a == std::numeric_limits<T>::min()) && (val_b == -1)))</div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  {</div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  result = std::numeric_limits<T>::min();</div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  }</div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  <span class="keywordflow">else</span></div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  {</div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  result = val_a / val_b;</div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  }</div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span> </div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  <span class="keywordflow">return</span> result;</div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span> }</div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span> } <span class="comment">// namespace cast</span></div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span> } <span class="comment">// namespace utils</span></div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span> } <span class="comment">// namespace arm_compute</span></div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="preprocessor">#endif </span><span class="comment">/* ARM_COMPUTE_UTILS_MATH_SAFE_OPS */</span><span class="preprocessor"></span></div><div class="ttc" id="namespacearm__compute_1_1utils_1_1math_xhtml_a51d1b0d5c48f48b9605a760e1963b940"><div class="ttname"><a href="namespacearm__compute_1_1utils_1_1math.xhtml#a51d1b0d5c48f48b9605a760e1963b940">arm_compute::utils::math::safe_integer_div</a></div><div class="ttdeci">T safe_integer_div(T val_a, T val_b)</div><div class="ttdoc">Safe integer division between two integers.</div><div class="ttdef"><b>Definition:</b> <a href="_safe_ops_8h_source.xhtml#l00162">SafeOps.h:162</a></div></div> |
| <div class="ttc" id="namespacearm__compute_xhtml"><div class="ttname"><a href="namespacearm__compute.xhtml">arm_compute</a></div><div class="ttdoc">Copyright (c) 2017-2020 ARM Limited.</div><div class="ttdef"><b>Definition:</b> <a href="00__introduction_8dox_source.xhtml#l00024">00_introduction.dox:24</a></div></div> |
| <div class="ttc" id="_requires_8h_xhtml"><div class="ttname"><a href="_requires_8h.xhtml">Requires.h</a></div></div> |
| <div class="ttc" id="namespacearm__compute_1_1utils_1_1math_xhtml_a3e89b90d50a678e88d7821c5a3ad8326"><div class="ttname"><a href="namespacearm__compute_1_1utils_1_1math.xhtml#a3e89b90d50a678e88d7821c5a3ad8326">arm_compute::utils::math::safe_integer_mul</a></div><div class="ttdeci">T safe_integer_mul(T val_a, T val_b)</div><div class="ttdoc">Safe integer multiplication between two integers.</div><div class="ttdef"><b>Definition:</b> <a href="_safe_ops_8h_source.xhtml#l00112">SafeOps.h:112</a></div></div> |
| <div class="ttc" id="_error_8h_xhtml"><div class="ttname"><a href="_error_8h.xhtml">Error.h</a></div></div> |
| <div class="ttc" id="namespacearm__compute_1_1utils_1_1math_xhtml_a1e0ef3d630d8020cfa7e09ffada9bec4"><div class="ttname"><a href="namespacearm__compute_1_1utils_1_1math.xhtml#a1e0ef3d630d8020cfa7e09ffada9bec4">arm_compute::utils::math::safe_integer_sub</a></div><div class="ttdeci">T safe_integer_sub(T val_a, T val_b)</div><div class="ttdoc">Safe integer subtraction between two integers.</div><div class="ttdef"><b>Definition:</b> <a href="_safe_ops_8h_source.xhtml#l00080">SafeOps.h:80</a></div></div> |
| <div class="ttc" id="namespacearm__compute_1_1utils_1_1math_xhtml_a788ba6c7989a35e2979dd0b315e8711f"><div class="ttname"><a href="namespacearm__compute_1_1utils_1_1math.xhtml#a788ba6c7989a35e2979dd0b315e8711f">arm_compute::utils::math::safe_integer_add</a></div><div class="ttdeci">T safe_integer_add(T val_a, T val_b)</div><div class="ttdoc">Safe integer addition between two integers.</div><div class="ttdef"><b>Definition:</b> <a href="_safe_ops_8h_source.xhtml#l00048">SafeOps.h:48</a></div></div> |
| </div><!-- fragment --></div><!-- contents --> |
| </div><!-- doc-content --> |
| <!-- start footer part --> |
| <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
| <ul> |
| <li class="navelem"><a class="el" href="dir_214608ef36d61442cb2b0c1c4e9a7def.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="dir_1fb090f0c6070330bfaccc4236d3ca0d.xhtml">core</a></li><li class="navelem"><a class="el" href="dir_7b0825b7536eda12b63e5d87347b1c7d.xhtml">utils</a></li><li class="navelem"><a class="el" href="dir_2169426e9e5fde76cfc45accd25ddc6f.xhtml">math</a></li><li class="navelem"><a class="el" href="_safe_ops_8h.xhtml">SafeOps.h</a></li> |
| <li class="footer">Generated on Thu Mar 5 2020 16:06:55 for Compute Library by |
| <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li> |
| </ul> |
| </div> |
| </body> |
| </html> |
