arm_compute v18.05
[platform/upstream/armcl.git] / documentation / namespacearm__compute_1_1quantization.xhtml
1 <!-- HTML header for doxygen 1.8.9.1-->
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.11"/>
8 <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
9 <title>Compute Library: arm_compute::quantization Namespace 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 <script type="text/javascript">
18   $(document).ready(initResizable);
19   $(window).load(resizeHeight);
20 </script>
21 <link href="search/search.css" rel="stylesheet" type="text/css"/>
22 <script type="text/javascript" src="search/searchdata.js"></script>
23 <script type="text/javascript" src="search/search.js"></script>
24 <script type="text/javascript">
25   $(document).ready(function() { init_search(); });
26 </script>
27 <script type="text/x-mathjax-config">
28   MathJax.Hub.Config({
29     extensions: ["tex2jax.js"],
30     jax: ["input/TeX","output/HTML-CSS"],
31 });
32 </script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
33 <link href="doxygen.css" rel="stylesheet" type="text/css" />
34 </head>
35 <body>
36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
37 <div id="titlearea">
38 <table cellspacing="0" cellpadding="0">
39  <tbody>
40  <tr style="height: 56px;">
41   <td style="padding-left: 0.5em;">
42    <div id="projectname">Compute Library
43    &#160;<span id="projectnumber">18.05</span>
44    </div>
45   </td>
46  </tr>
47  </tbody>
48 </table>
49 </div>
50 <!-- end header part -->
51 <!-- Generated by Doxygen 1.8.11 -->
52 <script type="text/javascript">
53 var searchBox = new SearchBox("searchBox", "search",false,'Search');
54 </script>
55   <div id="navrow1" class="tabs">
56     <ul class="tablist">
57       <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
58       <li><a href="pages.xhtml"><span>Related&#160;Pages</span></a></li>
59       <li class="current"><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
60       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
61       <li><a href="files.xhtml"><span>Files</span></a></li>
62       <li>
63         <div id="MSearchBox" class="MSearchBoxInactive">
64         <span class="left">
65           <img id="MSearchSelect" src="search/mag_sel.png"
66                onmouseover="return searchBox.OnSearchSelectShow()"
67                onmouseout="return searchBox.OnSearchSelectHide()"
68                alt=""/>
69           <input type="text" id="MSearchField" value="Search" accesskey="S"
70                onfocus="searchBox.OnSearchFieldFocus(true)" 
71                onblur="searchBox.OnSearchFieldFocus(false)" 
72                onkeyup="searchBox.OnSearchFieldChange(event)"/>
73           </span><span class="right">
74             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
75           </span>
76         </div>
77       </li>
78     </ul>
79   </div>
80   <div id="navrow2" class="tabs2">
81     <ul class="tablist">
82       <li><a href="namespaces.xhtml"><span>Namespace&#160;List</span></a></li>
83       <li><a href="namespacemembers.xhtml"><span>Namespace&#160;Members</span></a></li>
84     </ul>
85   </div>
86 </div><!-- top -->
87 <div id="side-nav" class="ui-resizable side-nav-resizable">
88   <div id="nav-tree">
89     <div id="nav-tree-contents">
90       <div id="nav-sync" class="sync"></div>
91     </div>
92   </div>
93   <div id="splitbar" style="-moz-user-select:none;" 
94        class="ui-resizable-handle">
95   </div>
96 </div>
97 <script type="text/javascript">
98 $(document).ready(function(){initNavTree('namespacearm__compute_1_1quantization.xhtml','');});
99 </script>
100 <div id="doc-content">
101 <!-- window showing the filter options -->
102 <div id="MSearchSelectWindow"
103      onmouseover="return searchBox.OnSearchSelectShow()"
104      onmouseout="return searchBox.OnSearchSelectHide()"
105      onkeydown="return searchBox.OnSearchSelectKey(event)">
106 </div>
107
108 <!-- iframe showing the search results (closed by default) -->
109 <div id="MSearchResultsWindow">
110 <iframe src="javascript:void(0)" frameborder="0" 
111         name="MSearchResults" id="MSearchResults">
112 </iframe>
113 </div>
114
115 <div class="header">
116   <div class="summary">
117 <a href="#func-members">Functions</a>  </div>
118   <div class="headertitle">
119 <div class="title">arm_compute::quantization Namespace Reference</div>  </div>
120 </div><!--header-->
121 <div class="contents">
122 <table class="memberdecls">
123 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
124 Functions</h2></td></tr>
125 <tr class="memitem:aa7bd9c3a3bcfe392c90d78e29429db26"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_status.xhtml">arm_compute::Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1quantization.xhtml#aa7bd9c3a3bcfe392c90d78e29429db26">calculate_quantized_multiplier_less_than_one</a> (double multiplier, int *quant_multiplier, int *right_shift)</td></tr>
126 <tr class="memdesc:aa7bd9c3a3bcfe392c90d78e29429db26"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate quantized representation of multiplier with value less than one.  <a href="#aa7bd9c3a3bcfe392c90d78e29429db26">More...</a><br /></td></tr>
127 <tr class="separator:aa7bd9c3a3bcfe392c90d78e29429db26"><td class="memSeparator" colspan="2">&#160;</td></tr>
128 <tr class="memitem:acfe5b1b47d01260aaea899a37e63de0d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_status.xhtml">arm_compute::Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearm__compute_1_1quantization.xhtml#acfe5b1b47d01260aaea899a37e63de0d">calculate_quantized_multiplier_greater_than_one</a> (double multiplier, int *quantized_multiplier, int *left_shift)</td></tr>
129 <tr class="memdesc:acfe5b1b47d01260aaea899a37e63de0d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate quantized representation of multiplier having value greater than one.  <a href="#acfe5b1b47d01260aaea899a37e63de0d">More...</a><br /></td></tr>
130 <tr class="separator:acfe5b1b47d01260aaea899a37e63de0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
131 </table>
132 <h2 class="groupheader">Function Documentation</h2>
133 <a class="anchor" id="acfe5b1b47d01260aaea899a37e63de0d"></a>
134 <div class="memitem">
135 <div class="memproto">
136       <table class="memname">
137         <tr>
138           <td class="memname"><a class="el" href="classarm__compute_1_1_status.xhtml">arm_compute::Status</a> arm_compute::quantization::calculate_quantized_multiplier_greater_than_one </td>
139           <td>(</td>
140           <td class="paramtype">double&#160;</td>
141           <td class="paramname"><em>multiplier</em>, </td>
142         </tr>
143         <tr>
144           <td class="paramkey"></td>
145           <td></td>
146           <td class="paramtype">int *&#160;</td>
147           <td class="paramname"><em>quantized_multiplier</em>, </td>
148         </tr>
149         <tr>
150           <td class="paramkey"></td>
151           <td></td>
152           <td class="paramtype">int *&#160;</td>
153           <td class="paramname"><em>left_shift</em>&#160;</td>
154         </tr>
155         <tr>
156           <td></td>
157           <td>)</td>
158           <td></td><td></td>
159         </tr>
160       </table>
161 </div><div class="memdoc">
162
163 <p>Calculate quantized representation of multiplier having value greater than one. </p>
164 <dl class="params"><dt>Parameters</dt><dd>
165   <table class="params">
166     <tr><td class="paramdir">[in]</td><td class="paramname">multiplier</td><td>Real multiplier. </td></tr>
167     <tr><td class="paramdir">[out]</td><td class="paramname">quantized_multiplier</td><td>Integer multiplier. </td></tr>
168     <tr><td class="paramdir">[out]</td><td class="paramname">left_shift</td><td>Left bit shift.</td></tr>
169   </table>
170   </dd>
171 </dl>
172 <dl class="section return"><dt>Returns</dt><dd>a status </dd></dl>
173
174 </div>
175 </div>
176 <a class="anchor" id="aa7bd9c3a3bcfe392c90d78e29429db26"></a>
177 <div class="memitem">
178 <div class="memproto">
179       <table class="memname">
180         <tr>
181           <td class="memname"><a class="el" href="classarm__compute_1_1_status.xhtml">arm_compute::Status</a> arm_compute::quantization::calculate_quantized_multiplier_less_than_one </td>
182           <td>(</td>
183           <td class="paramtype">double&#160;</td>
184           <td class="paramname"><em>multiplier</em>, </td>
185         </tr>
186         <tr>
187           <td class="paramkey"></td>
188           <td></td>
189           <td class="paramtype">int *&#160;</td>
190           <td class="paramname"><em>quant_multiplier</em>, </td>
191         </tr>
192         <tr>
193           <td class="paramkey"></td>
194           <td></td>
195           <td class="paramtype">int *&#160;</td>
196           <td class="paramname"><em>right_shift</em>&#160;</td>
197         </tr>
198         <tr>
199           <td></td>
200           <td>)</td>
201           <td></td><td></td>
202         </tr>
203       </table>
204 </div><div class="memdoc">
205
206 <p>Calculate quantized representation of multiplier with value less than one. </p>
207 <dl class="params"><dt>Parameters</dt><dd>
208   <table class="params">
209     <tr><td class="paramdir">[in]</td><td class="paramname">multiplier</td><td>Real multiplier. </td></tr>
210     <tr><td class="paramdir">[out]</td><td class="paramname">quant_multiplier</td><td>Integer multiplier. </td></tr>
211     <tr><td class="paramdir">[out]</td><td class="paramname">right_shift</td><td>Right bit shift.</td></tr>
212   </table>
213   </dd>
214 </dl>
215 <dl class="section return"><dt>Returns</dt><dd>a status </dd></dl>
216
217 <p>Referenced by <a class="el" href="_convolution3d_8h_source.xhtml#l00154">arm_compute::test::convolution_3d::detail::convolution3d()</a>, and <a class="el" href="validation_2reference_2_depthwise_convolution_layer_8cpp_source.xhtml#l00122">arm_compute::test::validation::reference::depthwise_convolution()</a>.</p>
218
219 </div>
220 </div>
221 </div><!-- contents -->
222 </div><!-- doc-content -->
223 <!-- start footer part -->
224 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
225   <ul>
226     <li class="navelem"><a class="el" href="namespacearm__compute.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="namespacearm__compute_1_1quantization.xhtml">quantization</a></li>
227     <li class="footer">Generated on Wed May 23 2018 11:36:43 for Compute Library by
228     <a href="http://www.doxygen.org/index.html">
229     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
230   </ul>
231 </div>
232 </body>
233 </html>