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">
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>ARM Compute Library: CLGEMMLowp Class 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);
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(); });
27 <script type="text/x-mathjax-config">
29 extensions: ["tex2jax.js"],
30 jax: ["input/TeX","output/HTML-CSS"],
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" />
36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
38 <table cellspacing="0" cellpadding="0">
40 <tr style="height: 56px;">
41 <td style="padding-left: 0.5em;">
42 <div id="projectname">ARM Compute Library
43  <span id="projectnumber">17.04</span>
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');
55 <div id="navrow1" class="tabs">
57 <li><a href="index.xhtml"><span>Main Page</span></a></li>
58 <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
59 <li class="current"><a href="annotated.xhtml"><span>Data Structures</span></a></li>
60 <li><a href="files.xhtml"><span>Files</span></a></li>
62 <div id="MSearchBox" class="MSearchBoxInactive">
64 <img id="MSearchSelect" src="search/mag_sel.png"
65 onmouseover="return searchBox.OnSearchSelectShow()"
66 onmouseout="return searchBox.OnSearchSelectHide()"
68 <input type="text" id="MSearchField" value="Search" accesskey="S"
69 onfocus="searchBox.OnSearchFieldFocus(true)"
70 onblur="searchBox.OnSearchFieldFocus(false)"
71 onkeyup="searchBox.OnSearchFieldChange(event)"/>
72 </span><span class="right">
73 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
79 <div id="navrow2" class="tabs2">
81 <li><a href="annotated.xhtml"><span>Data Structures</span></a></li>
82 <li><a href="classes.xhtml"><span>Data Structure Index</span></a></li>
83 <li><a href="inherits.xhtml"><span>Class Hierarchy</span></a></li>
84 <li><a href="functions.xhtml"><span>Data Fields</span></a></li>
88 <div id="side-nav" class="ui-resizable side-nav-resizable">
90 <div id="nav-tree-contents">
91 <div id="nav-sync" class="sync"></div>
94 <div id="splitbar" style="-moz-user-select:none;"
95 class="ui-resizable-handle">
98 <script type="text/javascript">
99 $(document).ready(function(){initNavTree('classarm__compute_1_1_c_l_g_e_m_m_lowp.xhtml','');});
101 <div id="doc-content">
102 <!-- window showing the filter options -->
103 <div id="MSearchSelectWindow"
104 onmouseover="return searchBox.OnSearchSelectShow()"
105 onmouseout="return searchBox.OnSearchSelectHide()"
106 onkeydown="return searchBox.OnSearchSelectKey(event)">
109 <!-- iframe showing the search results (closed by default) -->
110 <div id="MSearchResultsWindow">
111 <iframe src="javascript:void(0)" frameborder="0"
112 name="MSearchResults" id="MSearchResults">
117 <div class="summary">
118 <a href="#pub-methods">Public Member Functions</a> </div>
119 <div class="headertitle">
120 <div class="title">CLGEMMLowp Class Reference</div> </div>
122 <div class="contents">
124 <p>Basic function to execute GEMMLowp on OpenCL.
125 <a href="classarm__compute_1_1_c_l_g_e_m_m_lowp.xhtml#details">More...</a></p>
127 <p><code>#include <<a class="el" href="_c_l_g_e_m_m_lowp_8h_source.xhtml">CLGEMMLowp.h</a>></code></p>
128 <div class="dynheader">
129 Collaboration diagram for CLGEMMLowp:</div>
130 <div class="dyncontent">
131 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_c_l_g_e_m_m_lowp__coll__graph.svg" width="122" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
133 <center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
134 <table class="memberdecls">
135 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
136 Public Member Functions</h2></td></tr>
137 <tr class="memitem:aac051c3731008575fe02d576e0bbca11"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_g_e_m_m_lowp.xhtml#aac051c3731008575fe02d576e0bbca11">CLGEMMLowp</a> ()</td></tr>
138 <tr class="memdesc:aac051c3731008575fe02d576e0bbca11"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#aac051c3731008575fe02d576e0bbca11">More...</a><br /></td></tr>
139 <tr class="separator:aac051c3731008575fe02d576e0bbca11"><td class="memSeparator" colspan="2"> </td></tr>
140 <tr class="memitem:a2300a95117613686ccf15b45f0f2ac79"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_g_e_m_m_lowp.xhtml#a2300a95117613686ccf15b45f0f2ac79">configure</a> (const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *a, const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *b, <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *output, int32_t a_offset, int32_t b_offset, int32_t output_offset, int32_t output_mult_int, int32_t shift)</td></tr>
141 <tr class="memdesc:a2300a95117613686ccf15b45f0f2ac79"><td class="mdescLeft"> </td><td class="mdescRight">Initialise the kernel's inputs, output. <a href="#a2300a95117613686ccf15b45f0f2ac79">More...</a><br /></td></tr>
142 <tr class="separator:a2300a95117613686ccf15b45f0f2ac79"><td class="memSeparator" colspan="2"> </td></tr>
143 <tr class="memitem:ad1717410afd0be936c6213a63c8005fb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_g_e_m_m_lowp.xhtml#ad1717410afd0be936c6213a63c8005fb">run</a> () override</td></tr>
144 <tr class="memdesc:ad1717410afd0be936c6213a63c8005fb"><td class="mdescLeft"> </td><td class="mdescRight">Run the kernels contained in the function. <a href="#ad1717410afd0be936c6213a63c8005fb">More...</a><br /></td></tr>
145 <tr class="separator:ad1717410afd0be936c6213a63c8005fb"><td class="memSeparator" colspan="2"> </td></tr>
146 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_function"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_function')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_function.xhtml">IFunction</a></td></tr>
147 <tr class="memitem:ab921ecc3f3f6ae2b4bd61f3e1998d8c4 inherit pub_methods_classarm__compute_1_1_i_function"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_function.xhtml#ab921ecc3f3f6ae2b4bd61f3e1998d8c4">~IFunction</a> ()=default</td></tr>
148 <tr class="memdesc:ab921ecc3f3f6ae2b4bd61f3e1998d8c4 inherit pub_methods_classarm__compute_1_1_i_function"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ab921ecc3f3f6ae2b4bd61f3e1998d8c4">More...</a><br /></td></tr>
149 <tr class="separator:ab921ecc3f3f6ae2b4bd61f3e1998d8c4 inherit pub_methods_classarm__compute_1_1_i_function"><td class="memSeparator" colspan="2"> </td></tr>
151 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
152 <div class="textblock"><p>Basic function to execute GEMMLowp on OpenCL. </p>
153 <p>This function calls the following OpenCL kernels:</p>
155 <li><a class="el" href="classarm__compute_1_1_c_l_g_e_m_m_interleave4x4_kernel.xhtml">CLGEMMInterleave4x4Kernel</a></li>
156 <li><a class="el" href="classarm__compute_1_1_c_l_g_e_m_m_transpose1x_w_kernel.xhtml">CLGEMMTranspose1xWKernel</a></li>
157 <li><a class="el" href="classarm__compute_1_1_c_l_g_e_m_m_lowp_matrix_multiply_kernel.xhtml">CLGEMMLowpMatrixMultiplyKernel</a> </li>
160 <p>Definition at line <a class="el" href="_c_l_g_e_m_m_lowp_8h_source.xhtml#l00046">46</a> of file <a class="el" href="_c_l_g_e_m_m_lowp_8h_source.xhtml">CLGEMMLowp.h</a>.</p>
161 </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
162 <a class="anchor" id="aac051c3731008575fe02d576e0bbca11"></a>
163 <div class="memitem">
164 <div class="memproto">
165 <table class="memname">
167 <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_g_e_m_m_lowp.xhtml">CLGEMMLowp</a> </td>
169 <td class="paramname"></td><td>)</td>
173 </div><div class="memdoc">
179 <h2 class="groupheader">Member Function Documentation</h2>
180 <a class="anchor" id="a2300a95117613686ccf15b45f0f2ac79"></a>
181 <div class="memitem">
182 <div class="memproto">
183 <table class="memname">
185 <td class="memname">void configure </td>
187 <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> * </td>
188 <td class="paramname"><em>a</em>, </td>
191 <td class="paramkey"></td>
193 <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> * </td>
194 <td class="paramname"><em>b</em>, </td>
197 <td class="paramkey"></td>
199 <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> * </td>
200 <td class="paramname"><em>output</em>, </td>
203 <td class="paramkey"></td>
205 <td class="paramtype">int32_t </td>
206 <td class="paramname"><em>a_offset</em>, </td>
209 <td class="paramkey"></td>
211 <td class="paramtype">int32_t </td>
212 <td class="paramname"><em>b_offset</em>, </td>
215 <td class="paramkey"></td>
217 <td class="paramtype">int32_t </td>
218 <td class="paramname"><em>output_offset</em>, </td>
221 <td class="paramkey"></td>
223 <td class="paramtype">int32_t </td>
224 <td class="paramname"><em>output_mult_int</em>, </td>
227 <td class="paramkey"></td>
229 <td class="paramtype">int32_t </td>
230 <td class="paramname"><em>shift</em> </td>
238 </div><div class="memdoc">
240 <p>Initialise the kernel's inputs, output. </p>
241 <dl class="section note"><dt>Note</dt><dd>GEMM_LOWP: low precision matrix multiply kernel This kernel performs the following computation:</dd></dl>
243 <li>Convert a values from uint8 to int32 and add a_offset to each of them.</li>
244 <li>Convert b values from uint8 to int32 and add b_offset to each of them.</li>
245 <li>Compute the int32 matrix product of the resulting a * b.</li>
246 <li>Add output_offset to each entry of the result.</li>
247 <li>Multiply each entry of the result and round to the nearest integer</li>
248 <li>Clamp the resulting int32 values to the [0..255] range and cast to uint8.</li>
250 <dl class="params"><dt>Parameters</dt><dd>
251 <table class="params">
252 <tr><td class="paramdir">[in]</td><td class="paramname">a</td><td>First input tensor (Matrix A). Data types supported: U8. </td></tr>
253 <tr><td class="paramdir">[in]</td><td class="paramname">b</td><td>Second input tensor (Matrix B). Data types supported: same as <code>a</code>. </td></tr>
254 <tr><td class="paramdir">[out]</td><td class="paramname">output</td><td>Output tensor. Data types supported: same as <code>a</code>. </td></tr>
255 <tr><td class="paramdir">[in]</td><td class="paramname">a_offset</td><td>Offset to be added to each element of the matrix A. </td></tr>
256 <tr><td class="paramdir">[in]</td><td class="paramname">b_offset</td><td>Offset to be added to each element of the matrix B. </td></tr>
257 <tr><td class="paramdir">[in]</td><td class="paramname">output_offset</td><td>Offset to be added to each element of the output matrix </td></tr>
258 <tr><td class="paramdir">[in]</td><td class="paramname">output_mult_int</td><td>Multiplied with each element of the output matrix </td></tr>
259 <tr><td class="paramdir">[in]</td><td class="paramname">shift</td><td>Number of bits to shift right the result. </td></tr>
266 <a class="anchor" id="ad1717410afd0be936c6213a63c8005fb"></a>
267 <div class="memitem">
268 <div class="memproto">
269 <table class="mlabels">
271 <td class="mlabels-left">
272 <table class="memname">
274 <td class="memname">void run </td>
276 <td class="paramname"></td><td>)</td>
281 <td class="mlabels-right">
282 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
285 </div><div class="memdoc">
287 <p>Run the kernels contained in the function. </p>
288 <p>For NEON kernels:</p><ul>
289 <li>Multi-threading is used for the kernels which are parallelisable.</li>
290 <li>By default std::thread::hardware_concurrency() threads are used.</li>
292 <dl class="section note"><dt>Note</dt><dd><a class="el" href="classarm__compute_1_1_c_p_p_scheduler.xhtml#ae9dc1846ff1612778bbac85d46344aef">CPPScheduler::force_number_of_threads()</a> can be used to manually set the number of threads</dd></dl>
293 <p>For OpenCL kernels:</p><ul>
294 <li>All the kernels are enqueued on the queue associated with <a class="el" href="classarm__compute_1_1_c_l_scheduler.xhtml" title="Provides global access to a CL context and command queue. ">CLScheduler</a>.</li>
295 <li>The queue is then flushed.</li>
297 <dl class="section note"><dt>Note</dt><dd>The function will not block until the kernels are executed. It is the user's responsibility to wait. </dd></dl>
299 <p>Implements <a class="el" href="classarm__compute_1_1_i_function.xhtml#a18954417d3124a8095783ea13dc6d00b">IFunction</a>.</p>
303 <hr/>The documentation for this class was generated from the following file:<ul>
304 <li>arm_compute/runtime/CL/functions/<a class="el" href="_c_l_g_e_m_m_lowp_8h_source.xhtml">CLGEMMLowp.h</a></li>
306 </div><!-- contents -->
307 </div><!-- doc-content -->
308 <!-- start footer part -->
309 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
311 <li class="navelem"><a class="el" href="namespacearm__compute.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="classarm__compute_1_1_c_l_g_e_m_m_lowp.xhtml">CLGEMMLowp</a></li>
312 <li class="footer">Generated on Wed Apr 12 2017 14:26:05 for ARM Compute Library by
313 <a href="http://www.doxygen.org/index.html">
314 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>