Ryan OShea | de36e4a | 2020-03-13 16:26:19 +0000 | [diff] [blame] | 1 | <!-- Copyright (c) 2020 ARM Limited. --> |
| 2 | <!-- --> |
| 3 | <!-- SPDX-License-Identifier: MIT --> |
| 4 | <!-- --> |
| 5 | <!-- HTML header for doxygen 1.8.13--> |
| 6 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 7 | <html xmlns="http://www.w3.org/1999/xhtml"> |
| 8 | <head> |
| 9 | <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| 10 | <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| 11 | <meta name="generator" content="Doxygen 1.8.13"/> |
| 12 | <meta name="robots" content="NOINDEX, NOFOLLOW" /> |
| 13 | <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| 14 | <title>ArmNN: QSymmS8QuantizationScheme Struct Reference</title> |
| 15 | <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| 16 | <script type="text/javascript" src="jquery.js"></script> |
| 17 | <script type="text/javascript" src="dynsections.js"></script> |
| 18 | <link href="navtree.css" rel="stylesheet" type="text/css"/> |
| 19 | <script type="text/javascript" src="resize.js"></script> |
| 20 | <script type="text/javascript" src="navtreedata.js"></script> |
| 21 | <script type="text/javascript" src="navtree.js"></script> |
| 22 | <script type="text/javascript"> |
| 23 | $(document).ready(initResizable); |
| 24 | </script> |
| 25 | <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| 26 | <script type="text/javascript" src="search/searchdata.js"></script> |
| 27 | <script type="text/javascript" src="search/search.js"></script> |
| 28 | <script type="text/x-mathjax-config"> |
| 29 | MathJax.Hub.Config({ |
| 30 | extensions: ["tex2jax.js"], |
| 31 | jax: ["input/TeX","output/HTML-CSS"], |
| 32 | }); |
| 33 | </script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script> |
| 34 | <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| 35 | <link href="stylesheet.css" rel="stylesheet" type="text/css"/> |
| 36 | </head> |
| 37 | <body> |
| 38 | <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| 39 | <div id="titlearea"> |
| 40 | <table cellspacing="0" cellpadding="0"> |
| 41 | <tbody> |
| 42 | <tr style="height: 56px;"> |
| 43 | <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 10rem; margin-top: .5rem; margin-left 10px"/> |
| 44 | <td style="padding-left: 0.5em;"> |
| 45 | <div id="projectname"> |
| 46 |  <span id="projectnumber">20.02</span> |
| 47 | </div> |
| 48 | </td> |
| 49 | </tr> |
| 50 | </tbody> |
| 51 | </table> |
| 52 | </div> |
| 53 | <!-- end header part --> |
| 54 | <!-- Generated by Doxygen 1.8.13 --> |
| 55 | <script type="text/javascript"> |
| 56 | var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| 57 | </script> |
| 58 | <script type="text/javascript" src="menudata.js"></script> |
| 59 | <script type="text/javascript" src="menu.js"></script> |
| 60 | <script type="text/javascript"> |
| 61 | $(function() { |
| 62 | initMenu('',true,false,'search.php','Search'); |
| 63 | $(document).ready(function() { init_search(); }); |
| 64 | }); |
| 65 | </script> |
| 66 | <div id="main-nav"></div> |
| 67 | </div><!-- top --> |
| 68 | <div id="side-nav" class="ui-resizable side-nav-resizable"> |
| 69 | <div id="nav-tree"> |
| 70 | <div id="nav-tree-contents"> |
| 71 | <div id="nav-sync" class="sync"></div> |
| 72 | </div> |
| 73 | </div> |
| 74 | <div id="splitbar" style="-moz-user-select:none;" |
| 75 | class="ui-resizable-handle"> |
| 76 | </div> |
| 77 | </div> |
| 78 | <script type="text/javascript"> |
| 79 | $(document).ready(function(){initNavTree('structarmnn_1_1_q_symm_s8_quantization_scheme.xhtml','');}); |
| 80 | </script> |
| 81 | <div id="doc-content"> |
| 82 | <!-- window showing the filter options --> |
| 83 | <div id="MSearchSelectWindow" |
| 84 | onmouseover="return searchBox.OnSearchSelectShow()" |
| 85 | onmouseout="return searchBox.OnSearchSelectHide()" |
| 86 | onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| 87 | </div> |
| 88 | |
| 89 | <!-- iframe showing the search results (closed by default) --> |
| 90 | <div id="MSearchResultsWindow"> |
| 91 | <iframe src="javascript:void(0)" frameborder="0" |
| 92 | name="MSearchResults" id="MSearchResults"> |
| 93 | </iframe> |
| 94 | </div> |
| 95 | |
| 96 | <div class="header"> |
| 97 | <div class="summary"> |
| 98 | <a href="#pub-methods">Public Member Functions</a> | |
| 99 | <a href="structarmnn_1_1_q_symm_s8_quantization_scheme-members.xhtml">List of all members</a> </div> |
| 100 | <div class="headertitle"> |
| 101 | <div class="title">QSymmS8QuantizationScheme Struct Reference</div> </div> |
| 102 | </div><!--header--> |
| 103 | <div class="contents"> |
| 104 | |
| 105 | <p><code>#include <<a class="el" href="_network_quantization_scheme_8hpp_source.xhtml">NetworkQuantizationScheme.hpp</a>></code></p> |
| 106 | <div class="dynheader"> |
| 107 | Inheritance diagram for QSymmS8QuantizationScheme:</div> |
| 108 | <div class="dyncontent"> |
| 109 | <div class="center"> |
| 110 | <img src="structarmnn_1_1_q_symm_s8_quantization_scheme.png" usemap="#QSymmS8QuantizationScheme_map" alt=""/> |
| 111 | <map id="QSymmS8QuantizationScheme_map" name="QSymmS8QuantizationScheme_map"> |
| 112 | <area href="structarmnn_1_1_i_quantization_scheme.xhtml" alt="IQuantizationScheme" shape="rect" coords="0,0,185,24"/> |
| 113 | </map> |
| 114 | </div></div> |
| 115 | <table class="memberdecls"> |
| 116 | <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| 117 | Public Member Functions</h2></td></tr> |
| 118 | <tr class="memitem:a9fb07d8d7554a1502e732b8afa92040a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacearmnn.xhtml#a9b8e5a95f8c061bbbcdb036915dcb61a">OffsetScalePair</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_q_symm_s8_quantization_scheme.xhtml#a9fb07d8d7554a1502e732b8afa92040a">ComputeScheme</a> (double min, double max) const override</td></tr> |
| 119 | <tr class="separator:a9fb07d8d7554a1502e732b8afa92040a"><td class="memSeparator" colspan="2"> </td></tr> |
| 120 | <tr class="memitem:a1046eb36ff708a1b84f9a6bf0103fbc7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_q_symm_s8_quantization_scheme.xhtml#a1046eb36ff708a1b84f9a6bf0103fbc7">NumBits</a> () const override</td></tr> |
| 121 | <tr class="separator:a1046eb36ff708a1b84f9a6bf0103fbc7"><td class="memSeparator" colspan="2"> </td></tr> |
| 122 | <tr class="memitem:a57d67416d97cb7138e43656b43feb797"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacearmnn.xhtml#ad8ed01ff3ff33333d8e19db4d2818bb6">DataType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_q_symm_s8_quantization_scheme.xhtml#a57d67416d97cb7138e43656b43feb797">GetDataType</a> () const override</td></tr> |
| 123 | <tr class="separator:a57d67416d97cb7138e43656b43feb797"><td class="memSeparator" colspan="2"> </td></tr> |
| 124 | <tr class="inherit_header pub_methods_structarmnn_1_1_i_quantization_scheme"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structarmnn_1_1_i_quantization_scheme')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="structarmnn_1_1_i_quantization_scheme.xhtml">IQuantizationScheme</a></td></tr> |
| 125 | <tr class="memitem:ac7ce71800ca0ebb1222958717a834c9a inherit pub_methods_structarmnn_1_1_i_quantization_scheme"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_i_quantization_scheme.xhtml#ac7ce71800ca0ebb1222958717a834c9a">~IQuantizationScheme</a> ()</td></tr> |
| 126 | <tr class="separator:ac7ce71800ca0ebb1222958717a834c9a inherit pub_methods_structarmnn_1_1_i_quantization_scheme"><td class="memSeparator" colspan="2"> </td></tr> |
| 127 | </table> |
| 128 | <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| 129 | <div class="textblock"> |
| 130 | <p class="definition">Definition at line <a class="el" href="_network_quantization_scheme_8hpp_source.xhtml#l00100">100</a> of file <a class="el" href="_network_quantization_scheme_8hpp_source.xhtml">NetworkQuantizationScheme.hpp</a>.</p> |
| 131 | </div><h2 class="groupheader">Member Function Documentation</h2> |
| 132 | <a id="a9fb07d8d7554a1502e732b8afa92040a"></a> |
| 133 | <h2 class="memtitle"><span class="permalink"><a href="#a9fb07d8d7554a1502e732b8afa92040a">◆ </a></span>ComputeScheme()</h2> |
| 134 | |
| 135 | <div class="memitem"> |
| 136 | <div class="memproto"> |
| 137 | <table class="mlabels"> |
| 138 | <tr> |
| 139 | <td class="mlabels-left"> |
| 140 | <table class="memname"> |
| 141 | <tr> |
| 142 | <td class="memname"><a class="el" href="namespacearmnn.xhtml#a9b8e5a95f8c061bbbcdb036915dcb61a">OffsetScalePair</a> ComputeScheme </td> |
| 143 | <td>(</td> |
| 144 | <td class="paramtype">double </td> |
| 145 | <td class="paramname"><em>min</em>, </td> |
| 146 | </tr> |
| 147 | <tr> |
| 148 | <td class="paramkey"></td> |
| 149 | <td></td> |
| 150 | <td class="paramtype">double </td> |
| 151 | <td class="paramname"><em>max</em> </td> |
| 152 | </tr> |
| 153 | <tr> |
| 154 | <td></td> |
| 155 | <td>)</td> |
| 156 | <td></td><td> const</td> |
| 157 | </tr> |
| 158 | </table> |
| 159 | </td> |
| 160 | <td class="mlabels-right"> |
| 161 | <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> |
| 162 | </tr> |
| 163 | </table> |
| 164 | </div><div class="memdoc"> |
| 165 | |
| 166 | <p>Implements <a class="el" href="structarmnn_1_1_i_quantization_scheme.xhtml#a6a5561395e9693f02258b49dfcc009b4">IQuantizationScheme</a>.</p> |
| 167 | |
| 168 | <p class="definition">Definition at line <a class="el" href="_network_quantization_scheme_8hpp_source.xhtml#l00102">102</a> of file <a class="el" href="_network_quantization_scheme_8hpp_source.xhtml">NetworkQuantizationScheme.hpp</a>.</p> |
| 169 | |
| 170 | <p class="reference">References <a class="el" href="structarmnn_1_1_i_quantization_scheme.xhtml#a7ebe7ca1c6100440fcc130217f43561b">IQuantizationScheme::NumBits()</a>.</p> |
| 171 | <div class="fragment"><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  {</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keywordflow">if</span> (min > max)</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  {</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keywordflow">throw</span> InvalidArgumentException(<span class="stringliteral">"min > max will result in invalid quantization."</span>);</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  }</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> </div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="comment">// To avoid dividing by zero when quantizing a zero filled tensor</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keywordflow">if</span> (min == 0.0 && max == 0.0)</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  {</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  max = 1.0;</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> </div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keywordtype">double</span> highest = (1 << (<a class="code" href="structarmnn_1_1_q_symm_s8_quantization_scheme.xhtml#a1046eb36ff708a1b84f9a6bf0103fbc7">NumBits</a>()-1)) - 1; <span class="comment">// (numbits-1) accounts for the sign bit</span></div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keywordtype">double</span> extent = std::max(std::abs(min), std::abs(max));</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keywordtype">double</span> scale = extent / highest;</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>  <span class="keywordflow">return</span> std::make_pair(static_cast<float>(scale), 0);</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  }</div><div class="ttc" id="structarmnn_1_1_q_symm_s8_quantization_scheme_xhtml_a1046eb36ff708a1b84f9a6bf0103fbc7"><div class="ttname"><a href="structarmnn_1_1_q_symm_s8_quantization_scheme.xhtml#a1046eb36ff708a1b84f9a6bf0103fbc7">armnn::QSymmS8QuantizationScheme::NumBits</a></div><div class="ttdeci">int NumBits() const override</div><div class="ttdef"><b>Definition:</b> <a href="_network_quantization_scheme_8hpp_source.xhtml#l00123">NetworkQuantizationScheme.hpp:123</a></div></div> |
| 172 | </div><!-- fragment --> |
| 173 | </div> |
| 174 | </div> |
| 175 | <a id="a57d67416d97cb7138e43656b43feb797"></a> |
| 176 | <h2 class="memtitle"><span class="permalink"><a href="#a57d67416d97cb7138e43656b43feb797">◆ </a></span>GetDataType()</h2> |
| 177 | |
| 178 | <div class="memitem"> |
| 179 | <div class="memproto"> |
| 180 | <table class="mlabels"> |
| 181 | <tr> |
| 182 | <td class="mlabels-left"> |
| 183 | <table class="memname"> |
| 184 | <tr> |
| 185 | <td class="memname"><a class="el" href="namespacearmnn.xhtml#ad8ed01ff3ff33333d8e19db4d2818bb6">DataType</a> GetDataType </td> |
| 186 | <td>(</td> |
| 187 | <td class="paramname"></td><td>)</td> |
| 188 | <td> const</td> |
| 189 | </tr> |
| 190 | </table> |
| 191 | </td> |
| 192 | <td class="mlabels-right"> |
| 193 | <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> |
| 194 | </tr> |
| 195 | </table> |
| 196 | </div><div class="memdoc"> |
| 197 | |
| 198 | <p>Implements <a class="el" href="structarmnn_1_1_i_quantization_scheme.xhtml#ad23181f9f8fcc85758f62c49fc7ca23f">IQuantizationScheme</a>.</p> |
| 199 | |
| 200 | <p class="definition">Definition at line <a class="el" href="_network_quantization_scheme_8hpp_source.xhtml#l00125">125</a> of file <a class="el" href="_network_quantization_scheme_8hpp_source.xhtml">NetworkQuantizationScheme.hpp</a>.</p> |
| 201 | |
| 202 | <p class="reference">References <a class="el" href="namespacearmnn.xhtml#ad8ed01ff3ff33333d8e19db4d2818bb6a9945327825b115e93a3b89f4302e76db">armnn::QSymmS8</a>.</p> |
| 203 | <div class="fragment"><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> { <span class="keywordflow">return</span> <a class="code" href="namespacearmnn.xhtml#ad8ed01ff3ff33333d8e19db4d2818bb6a9945327825b115e93a3b89f4302e76db">DataType::QSymmS8</a>; }</div><div class="ttc" id="namespacearmnn_xhtml_ad8ed01ff3ff33333d8e19db4d2818bb6a9945327825b115e93a3b89f4302e76db"><div class="ttname"><a href="namespacearmnn.xhtml#ad8ed01ff3ff33333d8e19db4d2818bb6a9945327825b115e93a3b89f4302e76db">armnn::DataType::QSymmS8</a></div></div> |
| 204 | </div><!-- fragment --> |
| 205 | </div> |
| 206 | </div> |
| 207 | <a id="a1046eb36ff708a1b84f9a6bf0103fbc7"></a> |
| 208 | <h2 class="memtitle"><span class="permalink"><a href="#a1046eb36ff708a1b84f9a6bf0103fbc7">◆ </a></span>NumBits()</h2> |
| 209 | |
| 210 | <div class="memitem"> |
| 211 | <div class="memproto"> |
| 212 | <table class="mlabels"> |
| 213 | <tr> |
| 214 | <td class="mlabels-left"> |
| 215 | <table class="memname"> |
| 216 | <tr> |
| 217 | <td class="memname">int NumBits </td> |
| 218 | <td>(</td> |
| 219 | <td class="paramname"></td><td>)</td> |
| 220 | <td> const</td> |
| 221 | </tr> |
| 222 | </table> |
| 223 | </td> |
| 224 | <td class="mlabels-right"> |
| 225 | <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> |
| 226 | </tr> |
| 227 | </table> |
| 228 | </div><div class="memdoc"> |
| 229 | |
| 230 | <p>Implements <a class="el" href="structarmnn_1_1_i_quantization_scheme.xhtml#a7ebe7ca1c6100440fcc130217f43561b">IQuantizationScheme</a>.</p> |
| 231 | |
| 232 | <p class="definition">Definition at line <a class="el" href="_network_quantization_scheme_8hpp_source.xhtml#l00123">123</a> of file <a class="el" href="_network_quantization_scheme_8hpp_source.xhtml">NetworkQuantizationScheme.hpp</a>.</p> |
| 233 | <div class="fragment"><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> { <span class="keywordflow">return</span> 8; }</div></div><!-- fragment --> |
| 234 | </div> |
| 235 | </div> |
| 236 | <hr/>The documentation for this struct was generated from the following file:<ul> |
| 237 | <li>src/armnn/<a class="el" href="_network_quantization_scheme_8hpp_source.xhtml">NetworkQuantizationScheme.hpp</a></li> |
| 238 | </ul> |
| 239 | </div><!-- contents --> |
| 240 | </div><!-- doc-content --> |
| 241 | <!-- start footer part --> |
| 242 | <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
| 243 | <ul> |
| 244 | <li class="navelem"><a class="el" href="namespacearmnn.xhtml">armnn</a></li><li class="navelem"><a class="el" href="structarmnn_1_1_q_symm_s8_quantization_scheme.xhtml">QSymmS8QuantizationScheme</a></li> |
| 245 | <li class="footer">Generated on Fri Mar 13 2020 16:09:19 for ArmNN by |
| 246 | <a href="http://www.doxygen.org/index.html"> |
| 247 | <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> |
| 248 | </ul> |
| 249 | </div> |
| 250 | </body> |
| 251 | </html> |