Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / 753560b55dbf6656389b95efc8d4df07ac43cc9a / . / Documentation / structarmnn_1_1_q_asymm_s8_quantization_scheme.html
blob: 3f8e8b898b8cd373b2a9dcb9b36cf058f3841c9e [file] [log] [blame]
Ryan OSheade36e4a2020-03-13 16:26:19 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6<meta name="generator" content="Doxygen 1.8.13"/>
7<meta name="viewport" content="width=device-width, initial-scale=1"/>
8<title>ArmNN: QAsymmS8QuantizationScheme Struct Reference</title>
9<link href="tabs.css" rel="stylesheet" type="text/css"/>
10<script type="text/javascript" src="jquery.js"></script>
11<script type="text/javascript" src="dynsections.js"></script>
12<link href="navtree.css" rel="stylesheet" type="text/css"/>
13<script type="text/javascript" src="resize.js"></script>
14<script type="text/javascript" src="navtreedata.js"></script>
15<script type="text/javascript" src="navtree.js"></script>
16<script type="text/javascript">
17 $(document).ready(initResizable);
18</script>
19<link href="search/search.css" rel="stylesheet" type="text/css"/>
20<script type="text/javascript" src="search/searchdata.js"></script>
21<script type="text/javascript" src="search/search.js"></script>
22<link href="doxygen.css" rel="stylesheet" type="text/css" />
23</head>
24<body>
25<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
26<div id="titlearea">
27<table cellspacing="0" cellpadding="0">
28 <tbody>
29 <tr style="height: 56px;">
30 <td id="projectalign" style="padding-left: 0.5em;">
31 <div id="projectname">ArmNN
32 &#160;<span id="projectnumber">NotReleased</span>
33 </div>
34 </td>
35 </tr>
36 </tbody>
37</table>
38</div>
39<!-- end header part -->
40<!-- Generated by Doxygen 1.8.13 -->
41<script type="text/javascript">
42var searchBox = new SearchBox("searchBox", "search",false,'Search');
43</script>
44<script type="text/javascript" src="menudata.js"></script>
45<script type="text/javascript" src="menu.js"></script>
46<script type="text/javascript">
47$(function() {
48 initMenu('',true,false,'search.php','Search');
49 $(document).ready(function() { init_search(); });
50});
51</script>
52<div id="main-nav"></div>
53</div><!-- top -->
54<div id="side-nav" class="ui-resizable side-nav-resizable">
55 <div id="nav-tree">
56 <div id="nav-tree-contents">
57 <div id="nav-sync" class="sync"></div>
58 </div>
59 </div>
60 <div id="splitbar" style="-moz-user-select:none;"
61 class="ui-resizable-handle">
62 </div>
63</div>
64<script type="text/javascript">
65$(document).ready(function(){initNavTree('structarmnn_1_1_q_asymm_s8_quantization_scheme.html','');});
66</script>
67<div id="doc-content">
68<!-- window showing the filter options -->
69<div id="MSearchSelectWindow"
70 onmouseover="return searchBox.OnSearchSelectShow()"
71 onmouseout="return searchBox.OnSearchSelectHide()"
72 onkeydown="return searchBox.OnSearchSelectKey(event)">
73</div>
74
75<!-- iframe showing the search results (closed by default) -->
76<div id="MSearchResultsWindow">
77<iframe src="javascript:void(0)" frameborder="0"
78 name="MSearchResults" id="MSearchResults">
79</iframe>
80</div>
81
82<div class="header">
83 <div class="summary">
84<a href="#pub-methods">Public Member Functions</a> &#124;
85<a href="structarmnn_1_1_q_asymm_s8_quantization_scheme-members.html">List of all members</a> </div>
86 <div class="headertitle">
87<div class="title">QAsymmS8QuantizationScheme Struct Reference</div> </div>
88</div><!--header-->
89<div class="contents">
90
91<p><code>#include &lt;<a class="el" href="_network_quantization_scheme_8hpp_source.html">NetworkQuantizationScheme.hpp</a>&gt;</code></p>
92<div class="dynheader">
93Inheritance diagram for QAsymmS8QuantizationScheme:</div>
94<div class="dyncontent">
95 <div class="center">
96 <img src="structarmnn_1_1_q_asymm_s8_quantization_scheme.png" usemap="#QAsymmS8QuantizationScheme_map" alt=""/>
97 <map id="QAsymmS8QuantizationScheme_map" name="QAsymmS8QuantizationScheme_map">
98<area href="structarmnn_1_1_i_quantization_scheme.html" alt="IQuantizationScheme" shape="rect" coords="0,0,192,24"/>
99</map>
100 </div></div>
101<table class="memberdecls">
102<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
103Public Member Functions</h2></td></tr>
104<tr class="memitem:a9fb07d8d7554a1502e732b8afa92040a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacearmnn.html#a9b8e5a95f8c061bbbcdb036915dcb61a">OffsetScalePair</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_q_asymm_s8_quantization_scheme.html#a9fb07d8d7554a1502e732b8afa92040a">ComputeScheme</a> (double min, double max) const override</td></tr>
105<tr class="separator:a9fb07d8d7554a1502e732b8afa92040a"><td class="memSeparator" colspan="2">&#160;</td></tr>
106<tr class="memitem:a1046eb36ff708a1b84f9a6bf0103fbc7"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_q_asymm_s8_quantization_scheme.html#a1046eb36ff708a1b84f9a6bf0103fbc7">NumBits</a> () const override</td></tr>
107<tr class="separator:a1046eb36ff708a1b84f9a6bf0103fbc7"><td class="memSeparator" colspan="2">&#160;</td></tr>
108<tr class="memitem:a57d67416d97cb7138e43656b43feb797"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacearmnn.html#ad8ed01ff3ff33333d8e19db4d2818bb6">DataType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_q_asymm_s8_quantization_scheme.html#a57d67416d97cb7138e43656b43feb797">GetDataType</a> () const override</td></tr>
109<tr class="separator:a57d67416d97cb7138e43656b43feb797"><td class="memSeparator" colspan="2">&#160;</td></tr>
110<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="-"/>&#160;Public Member Functions inherited from <a class="el" href="structarmnn_1_1_i_quantization_scheme.html">IQuantizationScheme</a></td></tr>
111<tr class="memitem:ac7ce71800ca0ebb1222958717a834c9a inherit pub_methods_structarmnn_1_1_i_quantization_scheme"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_i_quantization_scheme.html#ac7ce71800ca0ebb1222958717a834c9a">~IQuantizationScheme</a> ()</td></tr>
112<tr class="separator:ac7ce71800ca0ebb1222958717a834c9a inherit pub_methods_structarmnn_1_1_i_quantization_scheme"><td class="memSeparator" colspan="2">&#160;</td></tr>
113</table>
114<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
115<div class="textblock">
116<p class="definition">Definition at line <a class="el" href="_network_quantization_scheme_8hpp_source.html#l00064">64</a> of file <a class="el" href="_network_quantization_scheme_8hpp_source.html">NetworkQuantizationScheme.hpp</a>.</p>
117</div><h2 class="groupheader">Member Function Documentation</h2>
118<a id="a9fb07d8d7554a1502e732b8afa92040a"></a>
119<h2 class="memtitle"><span class="permalink"><a href="#a9fb07d8d7554a1502e732b8afa92040a">&#9670;&nbsp;</a></span>ComputeScheme()</h2>
120
121<div class="memitem">
122<div class="memproto">
123<table class="mlabels">
124 <tr>
125 <td class="mlabels-left">
126 <table class="memname">
127 <tr>
128 <td class="memname"><a class="el" href="namespacearmnn.html#a9b8e5a95f8c061bbbcdb036915dcb61a">OffsetScalePair</a> ComputeScheme </td>
129 <td>(</td>
130 <td class="paramtype">double&#160;</td>
131 <td class="paramname"><em>min</em>, </td>
132 </tr>
133 <tr>
134 <td class="paramkey"></td>
135 <td></td>
136 <td class="paramtype">double&#160;</td>
137 <td class="paramname"><em>max</em>&#160;</td>
138 </tr>
139 <tr>
140 <td></td>
141 <td>)</td>
142 <td></td><td> const</td>
143 </tr>
144 </table>
145 </td>
146 <td class="mlabels-right">
147<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
148 </tr>
149</table>
150</div><div class="memdoc">
151
152<p>Implements <a class="el" href="structarmnn_1_1_i_quantization_scheme.html#a6a5561395e9693f02258b49dfcc009b4">IQuantizationScheme</a>.</p>
153
154<p class="definition">Definition at line <a class="el" href="_network_quantization_scheme_8hpp_source.html#l00066">66</a> of file <a class="el" href="_network_quantization_scheme_8hpp_source.html">NetworkQuantizationScheme.hpp</a>.</p>
155
156<p class="reference">References <a class="el" href="structarmnn_1_1_i_quantization_scheme.html#a7ebe7ca1c6100440fcc130217f43561b">IQuantizationScheme::NumBits()</a>.</p>
157<div class="fragment"><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; {</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keywordflow">if</span> (min &gt; max)</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; {</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="keywordflow">throw</span> InvalidArgumentException(<span class="stringliteral">&quot;min &gt; max will result in invalid quantization.&quot;</span>);</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; }</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="keywordtype">double</span> highest = (1 &lt;&lt; <a class="code" href="structarmnn_1_1_q_asymm_s8_quantization_scheme.html#a1046eb36ff708a1b84f9a6bf0103fbc7">NumBits</a>()) - 1;</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; min = std::min(0.0, min); <span class="comment">// min &lt;= 0.0</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; max = std::max(0.0, max); <span class="comment">// max &gt;= 0.0</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="comment">// To avoid dividing by zero when quantizing a zero filled tensor</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="keywordflow">if</span> (min == 0.0 &amp;&amp; max == 0.0)</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; {</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; max = 1.0;</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; }</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; <span class="comment">// Assumes quantization range [0-255]</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="keywordtype">double</span> scale = (max-min) / highest ;</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <span class="keywordtype">double</span> offset = - min / scale;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="comment">//Clamp 0 to Highest</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; offset = std::max(0.0, std::min(highest, offset));</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <span class="comment">//-128 on offset to cast to signed range</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <span class="keywordflow">return</span> std::make_pair(static_cast&lt;float&gt;(scale), static_cast&lt;int&gt;(std::round(offset)-128));</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; }</div><div class="ttc" id="structarmnn_1_1_q_asymm_s8_quantization_scheme_html_a1046eb36ff708a1b84f9a6bf0103fbc7"><div class="ttname"><a href="structarmnn_1_1_q_asymm_s8_quantization_scheme.html#a1046eb36ff708a1b84f9a6bf0103fbc7">armnn::QAsymmS8QuantizationScheme::NumBits</a></div><div class="ttdeci">int NumBits() const override</div><div class="ttdef"><b>Definition:</b> <a href="_network_quantization_scheme_8hpp_source.html#l00095">NetworkQuantizationScheme.hpp:95</a></div></div>
158</div><!-- fragment -->
159</div>
160</div>
161<a id="a57d67416d97cb7138e43656b43feb797"></a>
162<h2 class="memtitle"><span class="permalink"><a href="#a57d67416d97cb7138e43656b43feb797">&#9670;&nbsp;</a></span>GetDataType()</h2>
163
164<div class="memitem">
165<div class="memproto">
166<table class="mlabels">
167 <tr>
168 <td class="mlabels-left">
169 <table class="memname">
170 <tr>
171 <td class="memname"><a class="el" href="namespacearmnn.html#ad8ed01ff3ff33333d8e19db4d2818bb6">DataType</a> GetDataType </td>
172 <td>(</td>
173 <td class="paramname"></td><td>)</td>
174 <td> const</td>
175 </tr>
176 </table>
177 </td>
178 <td class="mlabels-right">
179<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
180 </tr>
181</table>
182</div><div class="memdoc">
183
184<p>Implements <a class="el" href="structarmnn_1_1_i_quantization_scheme.html#ad23181f9f8fcc85758f62c49fc7ca23f">IQuantizationScheme</a>.</p>
185
186<p class="definition">Definition at line <a class="el" href="_network_quantization_scheme_8hpp_source.html#l00097">97</a> of file <a class="el" href="_network_quantization_scheme_8hpp_source.html">NetworkQuantizationScheme.hpp</a>.</p>
187
188<p class="reference">References <a class="el" href="namespacearmnn.html#ad8ed01ff3ff33333d8e19db4d2818bb6a9d02ea768c081d4bdb2b7cab0b3f510d">armnn::QAsymmS8</a>.</p>
189<div class="fragment"><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;{ <span class="keywordflow">return</span> <a class="code" href="namespacearmnn.html#ad8ed01ff3ff33333d8e19db4d2818bb6a9d02ea768c081d4bdb2b7cab0b3f510d">DataType::QAsymmS8</a>; }</div><div class="ttc" id="namespacearmnn_html_ad8ed01ff3ff33333d8e19db4d2818bb6a9d02ea768c081d4bdb2b7cab0b3f510d"><div class="ttname"><a href="namespacearmnn.html#ad8ed01ff3ff33333d8e19db4d2818bb6a9d02ea768c081d4bdb2b7cab0b3f510d">armnn::DataType::QAsymmS8</a></div></div>
190</div><!-- fragment -->
191</div>
192</div>
193<a id="a1046eb36ff708a1b84f9a6bf0103fbc7"></a>
194<h2 class="memtitle"><span class="permalink"><a href="#a1046eb36ff708a1b84f9a6bf0103fbc7">&#9670;&nbsp;</a></span>NumBits()</h2>
195
196<div class="memitem">
197<div class="memproto">
198<table class="mlabels">
199 <tr>
200 <td class="mlabels-left">
201 <table class="memname">
202 <tr>
203 <td class="memname">int NumBits </td>
204 <td>(</td>
205 <td class="paramname"></td><td>)</td>
206 <td> const</td>
207 </tr>
208 </table>
209 </td>
210 <td class="mlabels-right">
211<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
212 </tr>
213</table>
214</div><div class="memdoc">
215
216<p>Implements <a class="el" href="structarmnn_1_1_i_quantization_scheme.html#a7ebe7ca1c6100440fcc130217f43561b">IQuantizationScheme</a>.</p>
217
218<p class="definition">Definition at line <a class="el" href="_network_quantization_scheme_8hpp_source.html#l00095">95</a> of file <a class="el" href="_network_quantization_scheme_8hpp_source.html">NetworkQuantizationScheme.hpp</a>.</p>
219<div class="fragment"><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;{ <span class="keywordflow">return</span> 8; }</div></div><!-- fragment -->
220</div>
221</div>
222<hr/>The documentation for this struct was generated from the following file:<ul>
223<li>src/armnn/<a class="el" href="_network_quantization_scheme_8hpp_source.html">NetworkQuantizationScheme.hpp</a></li>
224</ul>
225</div><!-- contents -->
226</div><!-- doc-content -->
227<!-- start footer part -->
228<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
229 <ul>
230 <li class="navelem"><a class="el" href="namespacearmnn.html">armnn</a></li><li class="navelem"><a class="el" href="structarmnn_1_1_q_asymm_s8_quantization_scheme.html">QAsymmS8QuantizationScheme</a></li>
231 <li class="footer">Generated on Fri Mar 13 2020 16:07:04 for ArmNN by
232 <a href="http://www.doxygen.org/index.html">
233 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
234 </ul>
235</div>
236</body>
237</html>