Nikhil Raj | 03c7ff3 | 2023-08-22 12:00:04 +0100 | [diff] [blame] | 1 | <!-- HTML header for doxygen 1.8.17--> |
| 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 3 | <html xmlns="http://www.w3.org/1999/xhtml"> |
| 4 | <head> |
| 5 | <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| 6 | <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| 7 | <meta name="generator" content="Doxygen 1.8.17"/> |
| 8 | <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| 9 | <title>Arm NN: QuantizedMultiplierSmallerThanOne Struct Reference</title> |
| 10 | <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| 11 | <script type="text/javascript" src="jquery.js"></script> |
| 12 | <script type="text/javascript" src="dynsections.js"></script> |
| 13 | <link href="navtree.css" rel="stylesheet" type="text/css"/> |
| 14 | <script type="text/javascript" src="resize.js"></script> |
| 15 | <script type="text/javascript" src="navtreedata.js"></script> |
| 16 | <script type="text/javascript" src="navtree.js"></script> |
| 17 | <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| 18 | <script type="text/javascript" src="search/searchdata.js"></script> |
| 19 | <script type="text/javascript" src="search/search.js"></script> |
| 20 | <script type="text/x-mathjax-config"> |
| 21 | MathJax.Hub.Config({ |
| 22 | extensions: ["tex2jax.js"], |
| 23 | jax: ["input/TeX","output/HTML-CSS"], |
| 24 | }); |
| 25 | </script> |
| 26 | <script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script> |
| 27 | <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| 28 | <link href="customdoxygen.css" rel="stylesheet" type="text/css"/> |
| 29 | </head> |
| 30 | <body> |
| 31 | <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| 32 | <div id="titlearea"> |
| 33 | <table cellspacing="0" cellpadding="0"> |
| 34 | <tbody> |
| 35 | <tr style="height: 56px;"> |
| 36 | <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 15rem; margin-top: .5rem; margin-left 13px"/> |
| 37 | <td id="projectalign" style="padding-left: 0.9em;"> |
| 38 | <div id="projectname"> |
Nikhil Raj | 1dc83fe | 2024-05-16 09:47:51 +0100 | [diff] [blame^] | 39 |  <span id="projectnumber">24.05</span> |
Nikhil Raj | 03c7ff3 | 2023-08-22 12:00:04 +0100 | [diff] [blame] | 40 | </div> |
| 41 | </td> |
| 42 | </tr> |
| 43 | </tbody> |
| 44 | </table> |
| 45 | </div> |
| 46 | <!-- end header part --> |
| 47 | <!-- Generated by Doxygen 1.8.17 --> |
| 48 | <script type="text/javascript"> |
| 49 | /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| 50 | var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| 51 | /* @license-end */ |
| 52 | </script> |
| 53 | <script type="text/javascript" src="menudata.js"></script> |
| 54 | <script type="text/javascript" src="menu.js"></script> |
| 55 | <script type="text/javascript"> |
| 56 | /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| 57 | $(function() { |
| 58 | initMenu('',true,false,'search.php','Search'); |
| 59 | $(document).ready(function() { init_search(); }); |
| 60 | }); |
| 61 | /* @license-end */</script> |
| 62 | <div id="main-nav"></div> |
| 63 | </div><!-- top --> |
| 64 | <div id="side-nav" class="ui-resizable side-nav-resizable"> |
| 65 | <div id="nav-tree"> |
| 66 | <div id="nav-tree-contents"> |
| 67 | <div id="nav-sync" class="sync"></div> |
| 68 | </div> |
| 69 | </div> |
| 70 | <div id="splitbar" style="-moz-user-select:none;" |
| 71 | class="ui-resizable-handle"> |
| 72 | </div> |
| 73 | </div> |
| 74 | <script type="text/javascript"> |
| 75 | /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| 76 | $(document).ready(function(){initNavTree('structarmnn_1_1_quantized_multiplier_smaller_than_one.html',''); initResizable(); }); |
| 77 | /* @license-end */ |
| 78 | </script> |
| 79 | <div id="doc-content"> |
| 80 | <!-- window showing the filter options --> |
| 81 | <div id="MSearchSelectWindow" |
| 82 | onmouseover="return searchBox.OnSearchSelectShow()" |
| 83 | onmouseout="return searchBox.OnSearchSelectHide()" |
| 84 | onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| 85 | </div> |
| 86 | |
| 87 | <!-- iframe showing the search results (closed by default) --> |
| 88 | <div id="MSearchResultsWindow"> |
| 89 | <iframe src="javascript:void(0)" frameborder="0" |
| 90 | name="MSearchResults" id="MSearchResults"> |
| 91 | </iframe> |
| 92 | </div> |
| 93 | |
| 94 | <div class="header"> |
| 95 | <div class="summary"> |
| 96 | <a href="#pub-methods">Public Member Functions</a> | |
| 97 | <a href="structarmnn_1_1_quantized_multiplier_smaller_than_one-members.html">List of all members</a> </div> |
| 98 | <div class="headertitle"> |
| 99 | <div class="title">QuantizedMultiplierSmallerThanOne Struct Reference</div> </div> |
| 100 | </div><!--header--> |
| 101 | <div class="contents"> |
| 102 | |
| 103 | <p>Performs multiplication of an integer with a multiplier which is less than one, using quantized integer arithmetic which is consistent with AndroidNN's CPU executor. |
| 104 | <a href="structarmnn_1_1_quantized_multiplier_smaller_than_one.html#details">More...</a></p> |
| 105 | |
| 106 | <p><code>#include <<a class="el" href="_conv_impl_8hpp_source.html">ConvImpl.hpp</a>></code></p> |
| 107 | <table class="memberdecls"> |
| 108 | <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| 109 | Public Member Functions</h2></td></tr> |
| 110 | <tr class="memitem:a1ec4f749fbbdacbe2cc7e8895d5b65ed"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_quantized_multiplier_smaller_than_one.html#a1ec4f749fbbdacbe2cc7e8895d5b65ed">QuantizedMultiplierSmallerThanOne</a> (float multiplier)</td></tr> |
| 111 | <tr class="memdesc:a1ec4f749fbbdacbe2cc7e8895d5b65ed"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a <a class="el" href="structarmnn_1_1_quantized_multiplier_smaller_than_one.html" title="Performs multiplication of an integer with a multiplier which is less than one, using quantized integ...">QuantizedMultiplierSmallerThanOne</a> which will multiply by the given multiplier. <a href="structarmnn_1_1_quantized_multiplier_smaller_than_one.html#a1ec4f749fbbdacbe2cc7e8895d5b65ed">More...</a><br /></td></tr> |
| 112 | <tr class="separator:a1ec4f749fbbdacbe2cc7e8895d5b65ed"><td class="memSeparator" colspan="2"> </td></tr> |
| 113 | <tr class="memitem:ac04834893e568dfea4642ecb575faed8"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_quantized_multiplier_smaller_than_one.html#ac04834893e568dfea4642ecb575faed8">operator*</a> (int32_t rhs) const</td></tr> |
| 114 | <tr class="memdesc:ac04834893e568dfea4642ecb575faed8"><td class="mdescLeft"> </td><td class="mdescRight">The implementation of this function is adapted from Android NN's MultiplyByQuantizedMultiplierSmallerThanOne(). <a href="structarmnn_1_1_quantized_multiplier_smaller_than_one.html#ac04834893e568dfea4642ecb575faed8">More...</a><br /></td></tr> |
| 115 | <tr class="separator:ac04834893e568dfea4642ecb575faed8"><td class="memSeparator" colspan="2"> </td></tr> |
| 116 | </table> |
| 117 | <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| 118 | <div class="textblock"><p>Performs multiplication of an integer with a multiplier which is less than one, using quantized integer arithmetic which is consistent with AndroidNN's CPU executor. </p> |
| 119 | |
| 120 | <p class="definition">Definition at line <a class="el" href="_conv_impl_8hpp_source.html#l00026">26</a> of file <a class="el" href="_conv_impl_8hpp_source.html">ConvImpl.hpp</a>.</p> |
| 121 | </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| 122 | <a id="a1ec4f749fbbdacbe2cc7e8895d5b65ed"></a> |
| 123 | <h2 class="memtitle"><span class="permalink"><a href="#a1ec4f749fbbdacbe2cc7e8895d5b65ed">◆ </a></span>QuantizedMultiplierSmallerThanOne()</h2> |
| 124 | |
| 125 | <div class="memitem"> |
| 126 | <div class="memproto"> |
| 127 | <table class="memname"> |
| 128 | <tr> |
| 129 | <td class="memname"><a class="el" href="structarmnn_1_1_quantized_multiplier_smaller_than_one.html">QuantizedMultiplierSmallerThanOne</a> </td> |
| 130 | <td>(</td> |
| 131 | <td class="paramtype">float </td> |
| 132 | <td class="paramname"><em>multiplier</em></td><td>)</td> |
| 133 | <td></td> |
| 134 | </tr> |
| 135 | </table> |
| 136 | </div><div class="memdoc"> |
| 137 | |
| 138 | <p>Constructs a <a class="el" href="structarmnn_1_1_quantized_multiplier_smaller_than_one.html" title="Performs multiplication of an integer with a multiplier which is less than one, using quantized integ...">QuantizedMultiplierSmallerThanOne</a> which will multiply by the given multiplier. </p> |
| 139 | <p>This stores the appropriate integer quantities (derived from the given multiplier) for later use. The implementation of this function is adapted from Android NN's QuantizeMultiplierSmallerThanOne(). </p> |
| 140 | |
Nikhil Raj | 1dc83fe | 2024-05-16 09:47:51 +0100 | [diff] [blame^] | 141 | <p class="definition">Definition at line <a class="el" href="_conv_impl_8cpp_source.html#l00014">14</a> of file <a class="el" href="_conv_impl_8cpp_source.html">ConvImpl.cpp</a>.</p> |
| 142 | <div class="fragment"><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> {</div> |
| 143 | <div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  <a class="code" href="_exceptions_8hpp.html#a5b0cd1f24b12298894d6367f186ea6dc">ARMNN_THROW_INVALIDARG_MSG_IF_FALSE</a>(multiplier >= 0.0f && multiplier < 1.0f,</div> |
| 144 | <div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  <span class="stringliteral">"QuantizedMultiplierSmallerThanOne: multiplier must be between 0.0f and 1.0f."</span>);</div> |
| 145 | <div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  <span class="keywordflow">if</span> (multiplier == 0.0f)</div> |
| 146 | <div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  {</div> |
| 147 | <div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  m_Multiplier = 0;</div> |
| 148 | <div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  m_RightShift = 0;</div> |
| 149 | <div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  }</div> |
| 150 | <div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <span class="keywordflow">else</span></div> |
| 151 | <div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  {</div> |
| 152 | <div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <span class="keyword">const</span> <span class="keywordtype">double</span> q = std::frexp(multiplier, &m_RightShift);</div> |
| 153 | <div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  m_RightShift = -m_RightShift;</div> |
| 154 | <div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  int64_t qFixed = <span class="keyword">static_cast<</span>int64_t<span class="keyword">></span>(::round(q * (1ll << 31)));</div> |
| 155 | <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="keywordflow">if</span> (qFixed == (1ll << 31))</div> |
| 156 | <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  {</div> |
| 157 | <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  qFixed /= 2;</div> |
| 158 | <div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  --m_RightShift;</div> |
| 159 | <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  }</div> |
| 160 | <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  m_Multiplier = <span class="keyword">static_cast<</span>int32_t<span class="keyword">></span>(qFixed);</div> |
| 161 | <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  }</div> |
| 162 | <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> }</div> |
Nikhil Raj | 03c7ff3 | 2023-08-22 12:00:04 +0100 | [diff] [blame] | 163 | </div><!-- fragment --> |
Nikhil Raj | 1dc83fe | 2024-05-16 09:47:51 +0100 | [diff] [blame^] | 164 | <p class="reference">References <a class="el" href="_exceptions_8hpp_source.html#l00210">ARMNN_THROW_INVALIDARG_MSG_IF_FALSE</a>.</p> |
Nikhil Raj | 03c7ff3 | 2023-08-22 12:00:04 +0100 | [diff] [blame] | 165 | |
| 166 | </div> |
| 167 | </div> |
| 168 | <h2 class="groupheader">Member Function Documentation</h2> |
| 169 | <a id="ac04834893e568dfea4642ecb575faed8"></a> |
| 170 | <h2 class="memtitle"><span class="permalink"><a href="#ac04834893e568dfea4642ecb575faed8">◆ </a></span>operator*()</h2> |
| 171 | |
| 172 | <div class="memitem"> |
| 173 | <div class="memproto"> |
| 174 | <table class="memname"> |
| 175 | <tr> |
| 176 | <td class="memname">int32_t operator* </td> |
| 177 | <td>(</td> |
| 178 | <td class="paramtype">int32_t </td> |
| 179 | <td class="paramname"><em>rhs</em></td><td>)</td> |
| 180 | <td> const</td> |
| 181 | </tr> |
| 182 | </table> |
| 183 | </div><div class="memdoc"> |
| 184 | |
| 185 | <p>The implementation of this function is adapted from Android NN's MultiplyByQuantizedMultiplierSmallerThanOne(). </p> |
| 186 | |
Nikhil Raj | 1dc83fe | 2024-05-16 09:47:51 +0100 | [diff] [blame^] | 187 | <p class="definition">Definition at line <a class="el" href="_conv_impl_8cpp_source.html#l00037">37</a> of file <a class="el" href="_conv_impl_8cpp_source.html">ConvImpl.cpp</a>.</p> |
| 188 | <div class="fragment"><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> {</div> |
| 189 | <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  int32_t x = SaturatingRoundingDoublingHighMul(rhs, m_Multiplier);</div> |
| 190 | <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordflow">return</span> RoundingDivideByPOT(x, m_RightShift);</div> |
| 191 | <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> }</div> |
Nikhil Raj | 03c7ff3 | 2023-08-22 12:00:04 +0100 | [diff] [blame] | 192 | </div><!-- fragment --> |
| 193 | </div> |
| 194 | </div> |
| 195 | <hr/>The documentation for this struct was generated from the following files:<ul> |
| 196 | <li>src/backends/reference/workloads/<a class="el" href="_conv_impl_8hpp_source.html">ConvImpl.hpp</a></li> |
| 197 | <li>src/backends/reference/workloads/<a class="el" href="_conv_impl_8cpp_source.html">ConvImpl.cpp</a></li> |
| 198 | </ul> |
| 199 | </div><!-- contents --> |
| 200 | </div><!-- doc-content --> |
Nikhil Raj | 1dc83fe | 2024-05-16 09:47:51 +0100 | [diff] [blame^] | 201 | <div class="ttc" id="a_exceptions_8hpp_html_a5b0cd1f24b12298894d6367f186ea6dc"><div class="ttname"><a href="_exceptions_8hpp.html#a5b0cd1f24b12298894d6367f186ea6dc">ARMNN_THROW_INVALIDARG_MSG_IF_FALSE</a></div><div class="ttdeci">#define ARMNN_THROW_INVALIDARG_MSG_IF_FALSE(_cond, _str)</div><div class="ttdef"><b>Definition:</b> <a href="_exceptions_8hpp_source.html#l00210">Exceptions.hpp:210</a></div></div> |
Nikhil Raj | 03c7ff3 | 2023-08-22 12:00:04 +0100 | [diff] [blame] | 202 | <!-- start footer part --> |
| 203 | <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
| 204 | <ul> |
| 205 | <li class="navelem"><a class="el" href="namespacearmnn.html">armnn</a></li><li class="navelem"><a class="el" href="structarmnn_1_1_quantized_multiplier_smaller_than_one.html">QuantizedMultiplierSmallerThanOne</a></li> |
Nikhil Raj | 1dc83fe | 2024-05-16 09:47:51 +0100 | [diff] [blame^] | 206 | <li class="footer">Generated on Thu May 16 2024 09:31:58 for Arm NN by |
Nikhil Raj | 03c7ff3 | 2023-08-22 12:00:04 +0100 | [diff] [blame] | 207 | <a href="http://www.doxygen.org/index.html"> |
| 208 | <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li> |
| 209 | </ul> |
| 210 | </div> |
| 211 | </body> |
| 212 | </html> |