aboutsummaryrefslogtreecommitdiff
path: root/21.02/structarmnn_1_1_q_asymm_u8_quantization_scheme.xhtml
blob: a059f9a954d592362b7acad9481706c5577e6ecc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
<!-- Copyright (c) 2020 ARM Limited. -->
<!--                                 -->
<!-- SPDX-License-Identifier: MIT    -->
<!--                                 -->
<!-- HTML header for doxygen 1.8.13-->
<!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.13"/>
<meta name="robots" content="NOINDEX, NOFOLLOW" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ArmNN: QAsymmU8QuantizationScheme Struct Reference</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">
  $(document).ready(initResizable);
</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" 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="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 10rem; margin-top: .5rem; margin-left 10px"/>
  <td style="padding-left: 0.5em;">
   <div id="projectname">
   &#160;<span id="projectnumber">21.02</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</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">
$(document).ready(function(){initNavTree('structarmnn_1_1_q_asymm_u8_quantization_scheme.xhtml','');});
</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="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="structarmnn_1_1_q_asymm_u8_quantization_scheme-members.xhtml">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">QAsymmU8QuantizationScheme Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="_network_quantization_scheme_8hpp_source.xhtml">NetworkQuantizationScheme.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for QAsymmU8QuantizationScheme:</div>
<div class="dyncontent">
 <div class="center">
  <img src="structarmnn_1_1_q_asymm_u8_quantization_scheme.png" usemap="#QAsymmU8QuantizationScheme_map" alt=""/>
  <map id="QAsymmU8QuantizationScheme_map" name="QAsymmU8QuantizationScheme_map">
<area href="structarmnn_1_1_i_quantization_scheme.xhtml" alt="IQuantizationScheme" shape="rect" coords="0,0,192,24"/>
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a9fb07d8d7554a1502e732b8afa92040a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacearmnn.xhtml#a9b8e5a95f8c061bbbcdb036915dcb61a">OffsetScalePair</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_q_asymm_u8_quantization_scheme.xhtml#a9fb07d8d7554a1502e732b8afa92040a">ComputeScheme</a> (double min, double max) const override</td></tr>
<tr class="separator:a9fb07d8d7554a1502e732b8afa92040a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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_u8_quantization_scheme.xhtml#a1046eb36ff708a1b84f9a6bf0103fbc7">NumBits</a> () const override</td></tr>
<tr class="separator:a1046eb36ff708a1b84f9a6bf0103fbc7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a57d67416d97cb7138e43656b43feb797"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacearmnn.xhtml#ad8ed01ff3ff33333d8e19db4d2818bb6">DataType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarmnn_1_1_q_asymm_u8_quantization_scheme.xhtml#a57d67416d97cb7138e43656b43feb797">GetDataType</a> () const override</td></tr>
<tr class="separator:a57d67416d97cb7138e43656b43feb797"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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.xhtml">IQuantizationScheme</a></td></tr>
<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.xhtml#ac7ce71800ca0ebb1222958717a834c9a">~IQuantizationScheme</a> ()</td></tr>
<tr class="separator:ac7ce71800ca0ebb1222958717a834c9a inherit pub_methods_structarmnn_1_1_i_quantization_scheme"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="_network_quantization_scheme_8hpp_source.xhtml#l00029">29</a> of file <a class="el" href="_network_quantization_scheme_8hpp_source.xhtml">NetworkQuantizationScheme.hpp</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a9fb07d8d7554a1502e732b8afa92040a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9fb07d8d7554a1502e732b8afa92040a">&#9670;&nbsp;</a></span>ComputeScheme()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespacearmnn.xhtml#a9b8e5a95f8c061bbbcdb036915dcb61a">OffsetScalePair</a> ComputeScheme </td>
          <td>(</td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>min</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&#160;</td>
          <td class="paramname"><em>max</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Implements <a class="el" href="structarmnn_1_1_i_quantization_scheme.xhtml#a6a5561395e9693f02258b49dfcc009b4">IQuantizationScheme</a>.</p>

<p class="definition">Definition at line <a class="el" href="_network_quantization_scheme_8hpp_source.xhtml#l00031">31</a> of file <a class="el" href="_network_quantization_scheme_8hpp_source.xhtml">NetworkQuantizationScheme.hpp</a>.</p>

<p class="reference">References <a class="el" href="structarmnn_1_1_i_quantization_scheme.xhtml#a7ebe7ca1c6100440fcc130217f43561b">IQuantizationScheme::NumBits()</a>.</p>

<p class="reference">Referenced by <a class="el" href="_network_quantizer_utils_8hpp_source.xhtml#l00023">armnn::QuantizeConstant()</a>.</p>
<div class="fragment"><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;    {</div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;        <span class="keywordflow">if</span> (min &gt; max)</div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;        {</div><div class="line"><a name="l00035"></a><span class="lineno">   35</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="l00036"></a><span class="lineno">   36</span>&#160;        }</div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;</div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;        <span class="keywordtype">double</span> highest = (1 &lt;&lt; <a class="code" href="structarmnn_1_1_q_asymm_u8_quantization_scheme.xhtml#a1046eb36ff708a1b84f9a6bf0103fbc7">NumBits</a>()) - 1;</div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;</div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;        min = std::min(0.0, min); <span class="comment">// min &lt;= 0.0</span></div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;        max = std::max(0.0, max); <span class="comment">// max &gt;= 0.0</span></div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;</div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;        <span class="comment">// To avoid dividing by zero when quantizing a zero filled tensor</span></div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;        <span class="keywordflow">if</span> (min == 0.0 &amp;&amp; max == 0.0)</div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;        {</div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;            max = 1.0;</div><div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;        }</div><div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;</div><div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;        <span class="comment">// Assumes quantization range [0-highest]</span></div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;        <span class="keywordtype">double</span> scale = (max-min) / highest;</div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;        <span class="keywordtype">double</span> offset = -min / scale;</div><div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;</div><div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;        <span class="comment">// Clamp offset [0-highest]</span></div><div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;        offset = std::max(0.0, std::min(highest, offset));</div><div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;</div><div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;        <span class="keywordflow">return</span> std::make_pair(static_cast&lt;float&gt;(scale), static_cast&lt;int&gt;(std::round(offset)));</div><div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;    }</div><div class="ttc" id="structarmnn_1_1_q_asymm_u8_quantization_scheme_xhtml_a1046eb36ff708a1b84f9a6bf0103fbc7"><div class="ttname"><a href="structarmnn_1_1_q_asymm_u8_quantization_scheme.xhtml#a1046eb36ff708a1b84f9a6bf0103fbc7">armnn::QAsymmU8QuantizationScheme::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#l00059">NetworkQuantizationScheme.hpp:59</a></div></div>
</div><!-- fragment -->
</div>
</div>
<a id="a57d67416d97cb7138e43656b43feb797"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a57d67416d97cb7138e43656b43feb797">&#9670;&nbsp;</a></span>GetDataType()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespacearmnn.xhtml#ad8ed01ff3ff33333d8e19db4d2818bb6">DataType</a> GetDataType </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Implements <a class="el" href="structarmnn_1_1_i_quantization_scheme.xhtml#ad23181f9f8fcc85758f62c49fc7ca23f">IQuantizationScheme</a>.</p>

<p class="definition">Definition at line <a class="el" href="_network_quantization_scheme_8hpp_source.xhtml#l00061">61</a> of file <a class="el" href="_network_quantization_scheme_8hpp_source.xhtml">NetworkQuantizationScheme.hpp</a>.</p>

<p class="reference">References <a class="el" href="namespacearmnn.xhtml#ad8ed01ff3ff33333d8e19db4d2818bb6a0a3f57c876f5a230244c38e1453a8a6e">armnn::QAsymmU8</a>.</p>
<div class="fragment"><div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;{ <span class="keywordflow">return</span> <a class="code" href="namespacearmnn.xhtml#ad8ed01ff3ff33333d8e19db4d2818bb6a0a3f57c876f5a230244c38e1453a8a6e">DataType::QAsymmU8</a>; }</div><div class="ttc" id="namespacearmnn_xhtml_ad8ed01ff3ff33333d8e19db4d2818bb6a0a3f57c876f5a230244c38e1453a8a6e"><div class="ttname"><a href="namespacearmnn.xhtml#ad8ed01ff3ff33333d8e19db4d2818bb6a0a3f57c876f5a230244c38e1453a8a6e">armnn::DataType::QAsymmU8</a></div></div>
</div><!-- fragment -->
</div>
</div>
<a id="a1046eb36ff708a1b84f9a6bf0103fbc7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1046eb36ff708a1b84f9a6bf0103fbc7">&#9670;&nbsp;</a></span>NumBits()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int NumBits </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Implements <a class="el" href="structarmnn_1_1_i_quantization_scheme.xhtml#a7ebe7ca1c6100440fcc130217f43561b">IQuantizationScheme</a>.</p>

<p class="definition">Definition at line <a class="el" href="_network_quantization_scheme_8hpp_source.xhtml#l00059">59</a> of file <a class="el" href="_network_quantization_scheme_8hpp_source.xhtml">NetworkQuantizationScheme.hpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;{ <span class="keywordflow">return</span> 8; }</div></div><!-- fragment -->
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/armnn/<a class="el" href="_network_quantization_scheme_8hpp_source.xhtml">NetworkQuantizationScheme.hpp</a></li>
</ul>
</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="namespacearmnn.xhtml">armnn</a></li><li class="navelem"><a class="el" href="structarmnn_1_1_q_asymm_u8_quantization_scheme.xhtml">QAsymmU8QuantizationScheme</a></li>
    <li class="footer">Generated on Thu Feb 25 2021 17:28:00 for ArmNN by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>