documentation/classarm__compute_1_1_g_c_g_e_m_m.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: GCGEMM 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);
  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.03</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><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
  60       <li class="current"><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="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  83       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
  84       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
  85       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
  86     </ul>
  87   </div>
  88 </div><!-- top -->
  89 <div id="side-nav" class="ui-resizable side-nav-resizable">
  90   <div id="nav-tree">
  91     <div id="nav-tree-contents">
  92       <div id="nav-sync" class="sync"></div>
  93     </div>
  94   </div>
  95   <div id="splitbar" style="-moz-user-select:none;"
  96        class="ui-resizable-handle">
  97   </div>
  98 </div>
  99 <script type="text/javascript">
 100 $(document).ready(function(){initNavTree('classarm__compute_1_1_g_c_g_e_m_m.xhtml','');});
 101 </script>
 102 <div id="doc-content">
 103 <!-- window showing the filter options -->
 104 <div id="MSearchSelectWindow"
 105      onmouseover="return searchBox.OnSearchSelectShow()"
 106      onmouseout="return searchBox.OnSearchSelectHide()"
 107      onkeydown="return searchBox.OnSearchSelectKey(event)">
 108 </div>
 109
 110 <!-- iframe showing the search results (closed by default) -->
 111 <div id="MSearchResultsWindow">
 112 <iframe src="javascript:void(0)" frameborder="0"
 113         name="MSearchResults" id="MSearchResults">
 114 </iframe>
 115 </div>
 116
 117 <div class="header">
 118   <div class="summary">
 119 <a href="#pub-methods">Public Member Functions</a>  </div>
 120   <div class="headertitle">
 121 <div class="title">GCGEMM Class Reference</div>  </div>
 122 </div><!--header-->
 123 <div class="contents">
 124
 125 <p>Basic function to execute GEMM on OpenGLES Compute.
 126  <a href="classarm__compute_1_1_g_c_g_e_m_m.xhtml#details">More...</a></p>
 127
 128 <p><code>#include &lt;<a class="el" href="_g_c_g_e_m_m_8h_source.xhtml">GCGEMM.h</a>&gt;</code></p>
 129 <div class="dynheader">
 130 Collaboration diagram for GCGEMM:</div>
 131 <div class="dyncontent">
 132 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_g_c_g_e_m_m__coll__graph.svg" width="92" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
 133 </div>
 134 <center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
 135 <table class="memberdecls">
 136 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 137 Public Member Functions</h2></td></tr>
 138 <tr class="memitem:a436c89a6209d7de142e7e5eabb9debd1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_g_c_g_e_m_m.xhtml#a436c89a6209d7de142e7e5eabb9debd1">GCGEMM</a> ()</td></tr>
 139 <tr class="memdesc:a436c89a6209d7de142e7e5eabb9debd1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#a436c89a6209d7de142e7e5eabb9debd1">More...</a><br /></td></tr>
 140 <tr class="separator:a436c89a6209d7de142e7e5eabb9debd1"><td class="memSeparator" colspan="2">&#160;</td></tr>
 141 <tr class="memitem:a8184f9bf2e8f4fdc16cfe7812e229d95"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_g_c_g_e_m_m.xhtml#a8184f9bf2e8f4fdc16cfe7812e229d95">configure</a> (const <a class="el" href="classarm__compute_1_1_i_g_c_tensor.xhtml">IGCTensor</a> *a, const <a class="el" href="classarm__compute_1_1_i_g_c_tensor.xhtml">IGCTensor</a> *b, const <a class="el" href="classarm__compute_1_1_i_g_c_tensor.xhtml">IGCTensor</a> *c, <a class="el" href="classarm__compute_1_1_i_g_c_tensor.xhtml">IGCTensor</a> *output, float alpha, float beta, const <a class="el" href="classarm__compute_1_1_g_e_m_m_info.xhtml">GEMMInfo</a> &amp;gemm_info=<a class="el" href="classarm__compute_1_1_g_e_m_m_info.xhtml">GEMMInfo</a>())</td></tr>
 142 <tr class="memdesc:a8184f9bf2e8f4fdc16cfe7812e229d95"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise the kernel's inputs and output.  <a href="#a8184f9bf2e8f4fdc16cfe7812e229d95">More...</a><br /></td></tr>
 143 <tr class="separator:a8184f9bf2e8f4fdc16cfe7812e229d95"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <tr class="memitem:ad1717410afd0be936c6213a63c8005fb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_g_c_g_e_m_m.xhtml#ad1717410afd0be936c6213a63c8005fb">run</a> () override</td></tr>
 145 <tr class="memdesc:ad1717410afd0be936c6213a63c8005fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Run the kernels contained in the function.  <a href="#ad1717410afd0be936c6213a63c8005fb">More...</a><br /></td></tr>
 146 <tr class="separator:ad1717410afd0be936c6213a63c8005fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <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="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_function.xhtml">IFunction</a></td></tr>
 148 <tr class="memitem:ab921ecc3f3f6ae2b4bd61f3e1998d8c4 inherit pub_methods_classarm__compute_1_1_i_function"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_function.xhtml#ab921ecc3f3f6ae2b4bd61f3e1998d8c4">~IFunction</a> ()=default</td></tr>
 149 <tr class="memdesc:ab921ecc3f3f6ae2b4bd61f3e1998d8c4 inherit pub_methods_classarm__compute_1_1_i_function"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#ab921ecc3f3f6ae2b4bd61f3e1998d8c4">More...</a><br /></td></tr>
 150 <tr class="separator:ab921ecc3f3f6ae2b4bd61f3e1998d8c4 inherit pub_methods_classarm__compute_1_1_i_function"><td class="memSeparator" colspan="2">&#160;</td></tr>
 151 </table>
 152 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 153 <div class="textblock"><p>Basic function to execute GEMM on OpenGLES Compute. </p>
 154 <p>This function calls the following kernels:</p>
 155 <ol type="1">
 156 <li><a class="el" href="classarm__compute_1_1_g_c_g_e_m_m_interleave4x4_kernel.xhtml">GCGEMMInterleave4x4Kernel</a> (if the output tensor is a matrix)</li>
 157 <li><a class="el" href="classarm__compute_1_1_g_c_g_e_m_m_transpose1x_w_kernel.xhtml">GCGEMMTranspose1xWKernel</a> (if the output tensor is a matrix)</li>
 158 <li><a class="el" href="classarm__compute_1_1_g_c_g_e_m_m_matrix_multiply_kernel.xhtml">GCGEMMMatrixMultiplyKernel</a></li>
 159 <li><a class="el" href="classarm__compute_1_1_g_c_g_e_m_m_matrix_addition_kernel.xhtml">GCGEMMMatrixAdditionKernel</a> (if c != nullptr and beta != 0.0) </li>
 160 </ol>
 161
 162 <p>Definition at line <a class="el" href="_g_c_g_e_m_m_8h_source.xhtml#l00047">47</a> of file <a class="el" href="_g_c_g_e_m_m_8h_source.xhtml">GCGEMM.h</a>.</p>
 163 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 164 <a class="anchor" id="a436c89a6209d7de142e7e5eabb9debd1"></a>
 165 <div class="memitem">
 166 <div class="memproto">
 167       <table class="memname">
 168         <tr>
 169           <td class="memname"><a class="el" href="classarm__compute_1_1_g_c_g_e_m_m.xhtml">GCGEMM</a> </td>
 170           <td>(</td>
 171           <td class="paramname"></td><td>)</td>
 172           <td></td>
 173         </tr>
 174       </table>
 175 </div><div class="memdoc">
 176
 177 <p>Default constructor. </p>
 178
 179 </div>
 180 </div>
 181 <h2 class="groupheader">Member Function Documentation</h2>
 182 <a class="anchor" id="a8184f9bf2e8f4fdc16cfe7812e229d95"></a>
 183 <div class="memitem">
 184 <div class="memproto">
 185       <table class="memname">
 186         <tr>
 187           <td class="memname">void configure </td>
 188           <td>(</td>
 189           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_g_c_tensor.xhtml">IGCTensor</a> *&#160;</td>
 190           <td class="paramname"><em>a</em>, </td>
 191         </tr>
 192         <tr>
 193           <td class="paramkey"></td>
 194           <td></td>
 195           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_g_c_tensor.xhtml">IGCTensor</a> *&#160;</td>
 196           <td class="paramname"><em>b</em>, </td>
 197         </tr>
 198         <tr>
 199           <td class="paramkey"></td>
 200           <td></td>
 201           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_g_c_tensor.xhtml">IGCTensor</a> *&#160;</td>
 202           <td class="paramname"><em>c</em>, </td>
 203         </tr>
 204         <tr>
 205           <td class="paramkey"></td>
 206           <td></td>
 207           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_g_c_tensor.xhtml">IGCTensor</a> *&#160;</td>
 208           <td class="paramname"><em>output</em>, </td>
 209         </tr>
 210         <tr>
 211           <td class="paramkey"></td>
 212           <td></td>
 213           <td class="paramtype">float&#160;</td>
 214           <td class="paramname"><em>alpha</em>, </td>
 215         </tr>
 216         <tr>
 217           <td class="paramkey"></td>
 218           <td></td>
 219           <td class="paramtype">float&#160;</td>
 220           <td class="paramname"><em>beta</em>, </td>
 221         </tr>
 222         <tr>
 223           <td class="paramkey"></td>
 224           <td></td>
 225           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_g_e_m_m_info.xhtml">GEMMInfo</a> &amp;&#160;</td>
 226           <td class="paramname"><em>gemm_info</em> = <code><a class="el" href="classarm__compute_1_1_g_e_m_m_info.xhtml">GEMMInfo</a>()</code>&#160;</td>
 227         </tr>
 228         <tr>
 229           <td></td>
 230           <td>)</td>
 231           <td></td><td></td>
 232         </tr>
 233       </table>
 234 </div><div class="memdoc">
 235
 236 <p>Initialise the kernel's inputs and output. </p>
 237 <dl class="section note"><dt>Note</dt><dd>GEMM: General Matrix Multiply - [alpha * A * B + beta * C].</dd>
 238 <dd>
 239 All tensors must have the same data type.</dd>
 240 <dd>
 241 Whilst the first input tensor can be a vector, the second input tensor must be at least a matrix</dd></dl>
 242 <dl class="params"><dt>Parameters</dt><dd>
 243   <table class="params">
 244     <tr><td class="paramdir">[in]</td><td class="paramname">a</td><td>First input tensor (Matrix or <a class="el" href="struct_vector.xhtml" title="Structure to hold Vector information. ">Vector</a> A). Data types supported: F32 </td></tr>
 245     <tr><td class="paramdir">[in]</td><td class="paramname">b</td><td>Second input tensor (Matrix B). Data type supported: same as <code>a</code>. </td></tr>
 246     <tr><td class="paramdir">[in]</td><td class="paramname">c</td><td>Third input tensor (Matrix C). It can be a nullptr if just the multiplication between <code>a</code> and <code>b</code> is needed. Data type supported: same as <code>a</code>. </td></tr>
 247     <tr><td class="paramdir">[out]</td><td class="paramname">output</td><td>Output tensor. Data type supported: same as <code>a</code> </td></tr>
 248     <tr><td class="paramdir">[in]</td><td class="paramname">alpha</td><td>Weight of the matrix product </td></tr>
 249     <tr><td class="paramdir">[in]</td><td class="paramname">beta</td><td>Weight of matrix C </td></tr>
 250     <tr><td class="paramdir">[in]</td><td class="paramname">gemm_info</td><td>(Optional) Specifies if the matrix A and/or matrix B have been reshaped and if the reshape of matrix B should happen only for the first run </td></tr>
 251   </table>
 252   </dd>
 253 </dl>
 254
 255 </div>
 256 </div>
 257 <a class="anchor" id="ad1717410afd0be936c6213a63c8005fb"></a>
 258 <div class="memitem">
 259 <div class="memproto">
 260 <table class="mlabels">
 261   <tr>
 262   <td class="mlabels-left">
 263       <table class="memname">
 264         <tr>
 265           <td class="memname">void run </td>
 266           <td>(</td>
 267           <td class="paramname"></td><td>)</td>
 268           <td></td>
 269         </tr>
 270       </table>
 271   </td>
 272   <td class="mlabels-right">
 273 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 274   </tr>
 275 </table>
 276 </div><div class="memdoc">
 277
 278 <p>Run the kernels contained in the function. </p>
 279 <p>For NEON kernels:</p><ul>
 280 <li>Multi-threading is used for the kernels which are parallelisable.</li>
 281 <li>By default std::thread::hardware_concurrency() threads are used.</li>
 282 </ul>
 283 <dl class="section note"><dt>Note</dt><dd><a class="el" href="classarm__compute_1_1_c_p_p_scheduler.xhtml#ae64eebaa07f4d2da6cc2ba538c3cb095">CPPScheduler::set_num_threads()</a> can be used to manually set the number of threads</dd></dl>
 284 <p>For OpenCL kernels:</p><ul>
 285 <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>
 286 <li>The queue is then flushed.</li>
 287 </ul>
 288 <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>
 289
 290 <p>Implements <a class="el" href="classarm__compute_1_1_i_function.xhtml#a18954417d3124a8095783ea13dc6d00b">IFunction</a>.</p>
 291
 292 </div>
 293 </div>
 294 <hr/>The documentation for this class was generated from the following file:<ul>
 295 <li>arm_compute/runtime/GLES_COMPUTE/functions/<a class="el" href="_g_c_g_e_m_m_8h_source.xhtml">GCGEMM.h</a></li>
 296 </ul>
 297 </div><!-- contents -->
 298 </div><!-- doc-content -->
 299 <!-- start footer part -->
 300 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 301   <ul>
 302     <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_g_c_g_e_m_m.xhtml">GCGEMM</a></li>
 303     <li class="footer">Generated on Fri Mar 2 2018 12:37:58 for Compute Library by
 304     <a href="http://www.doxygen.org/index.html">
 305     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
 306   </ul>
 307 </div>
 308 </body>
 309 </html>