documentation/classarm__compute_1_1_n_e_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>ARM Compute Library: NEGEMM 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">ARM Compute Library
  43    &#160;<span id="projectnumber">17.03.1</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="namespaces.xhtml"><span>Namespaces</span></a></li>
  59       <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  60       <li><a href="files.xhtml"><span>Files</span></a></li>
  61       <li>
  62         <div id="MSearchBox" class="MSearchBoxInactive">
  63         <span class="left">
  64           <img id="MSearchSelect" src="search/mag_sel.png"
  65                onmouseover="return searchBox.OnSearchSelectShow()"
  66                onmouseout="return searchBox.OnSearchSelectHide()"
  67                alt=""/>
  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>
  74           </span>
  75         </div>
  76       </li>
  77     </ul>
  78   </div>
  79   <div id="navrow2" class="tabs2">
  80     <ul class="tablist">
  81       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  82       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
  83       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
  84       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
  85     </ul>
  86   </div>
  87 </div><!-- top -->
  88 <div id="side-nav" class="ui-resizable side-nav-resizable">
  89   <div id="nav-tree">
  90     <div id="nav-tree-contents">
  91       <div id="nav-sync" class="sync"></div>
  92     </div>
  93   </div>
  94   <div id="splitbar" style="-moz-user-select:none;"
  95        class="ui-resizable-handle">
  96   </div>
  97 </div>
  98 <script type="text/javascript">
  99 $(document).ready(function(){initNavTree('classarm__compute_1_1_n_e_g_e_m_m.xhtml','');});
 100 </script>
 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)">
 107 </div>
 108
 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">
 113 </iframe>
 114 </div>
 115
 116 <div class="header">
 117   <div class="summary">
 118 <a href="#pub-methods">Public Member Functions</a>  </div>
 119   <div class="headertitle">
 120 <div class="title">NEGEMM Class Reference</div>  </div>
 121 </div><!--header-->
 122 <div class="contents">
 123
 124 <p>Basic function to execute GEMM on NEON.
 125  <a href="classarm__compute_1_1_n_e_g_e_m_m.xhtml#details">More...</a></p>
 126
 127 <p><code>#include &lt;<a class="el" href="_n_e_g_e_m_m_8h_source.xhtml">NEGEMM.h</a>&gt;</code></p>
 128 <div class="dynheader">
 129 Collaboration diagram for NEGEMM:</div>
 130 <div class="dyncontent">
 131 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_n_e_g_e_m_m__coll__graph.svg" width="94" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
 132 </div>
 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:a7e368127dca3cd00895300376bdbaf85"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_g_e_m_m.xhtml#a7e368127dca3cd00895300376bdbaf85">NEGEMM</a> ()</td></tr>
 138 <tr class="memdesc:a7e368127dca3cd00895300376bdbaf85"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a7e368127dca3cd00895300376bdbaf85">More...</a><br /></td></tr>
 139 <tr class="separator:a7e368127dca3cd00895300376bdbaf85"><td class="memSeparator" colspan="2">&#160;</td></tr>
 140 <tr class="memitem:a6454174e85d317a6e95844049d4daf6f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_g_e_m_m.xhtml#a6454174e85d317a6e95844049d4daf6f">configure</a> (const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *a, const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *b, const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *c, <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *d, float alpha, float beta)</td></tr>
 141 <tr class="memdesc:a6454174e85d317a6e95844049d4daf6f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise the kernel's inputs, output.  <a href="#a6454174e85d317a6e95844049d4daf6f">More...</a><br /></td></tr>
 142 <tr class="separator:a6454174e85d317a6e95844049d4daf6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 143 <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_n_e_g_e_m_m.xhtml#ad1717410afd0be936c6213a63c8005fb">run</a> () override</td></tr>
 144 <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>
 145 <tr class="separator:ad1717410afd0be936c6213a63c8005fb"><td class="memSeparator" colspan="2">&#160;</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="-"/>&#160;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&#160;</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">&#160;</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">&#160;</td></tr>
 150 </table>
 151 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 152 <div class="textblock"><p>Basic function to execute GEMM on NEON. </p>
 153 <p>This function calls the following NEON kernels:</p>
 154 <ol type="1">
 155 <li><a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_interleave4x4_kernel.xhtml">NEGEMMInterleave4x4Kernel</a> (if the output tensor is a matrix)</li>
 156 <li><a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_transpose1x_w_kernel.xhtml">NEGEMMTranspose1xWKernel</a> (if the output tensor is a matrix)</li>
 157 <li><a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_matrix_multiply_kernel.xhtml">NEGEMMMatrixMultiplyKernel</a></li>
 158 <li><a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_matrix_addition_kernel.xhtml">NEGEMMMatrixAdditionKernel</a> (if c != nullptr and beta != 0.0) </li>
 159 </ol>
 160
 161 <p>Definition at line <a class="el" href="_n_e_g_e_m_m_8h_source.xhtml#l00045">45</a> of file <a class="el" href="_n_e_g_e_m_m_8h_source.xhtml">NEGEMM.h</a>.</p>
 162 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 163 <a class="anchor" id="a7e368127dca3cd00895300376bdbaf85"></a>
 164 <div class="memitem">
 165 <div class="memproto">
 166       <table class="memname">
 167         <tr>
 168           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_g_e_m_m.xhtml">NEGEMM</a> </td>
 169           <td>(</td>
 170           <td class="paramname"></td><td>)</td>
 171           <td></td>
 172         </tr>
 173       </table>
 174 </div><div class="memdoc">
 175
 176 <p>Constructor. </p>
 177
 178 </div>
 179 </div>
 180 <h2 class="groupheader">Member Function Documentation</h2>
 181 <a class="anchor" id="a6454174e85d317a6e95844049d4daf6f"></a>
 182 <div class="memitem">
 183 <div class="memproto">
 184       <table class="memname">
 185         <tr>
 186           <td class="memname">void configure </td>
 187           <td>(</td>
 188           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
 189           <td class="paramname"><em>a</em>, </td>
 190         </tr>
 191         <tr>
 192           <td class="paramkey"></td>
 193           <td></td>
 194           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
 195           <td class="paramname"><em>b</em>, </td>
 196         </tr>
 197         <tr>
 198           <td class="paramkey"></td>
 199           <td></td>
 200           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
 201           <td class="paramname"><em>c</em>, </td>
 202         </tr>
 203         <tr>
 204           <td class="paramkey"></td>
 205           <td></td>
 206           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
 207           <td class="paramname"><em>d</em>, </td>
 208         </tr>
 209         <tr>
 210           <td class="paramkey"></td>
 211           <td></td>
 212           <td class="paramtype">float&#160;</td>
 213           <td class="paramname"><em>alpha</em>, </td>
 214         </tr>
 215         <tr>
 216           <td class="paramkey"></td>
 217           <td></td>
 218           <td class="paramtype">float&#160;</td>
 219           <td class="paramname"><em>beta</em>&#160;</td>
 220         </tr>
 221         <tr>
 222           <td></td>
 223           <td>)</td>
 224           <td></td><td></td>
 225         </tr>
 226       </table>
 227 </div><div class="memdoc">
 228
 229 <p>Initialise the kernel's inputs, output. </p>
 230 <dl class="section note"><dt>Note</dt><dd>GEMM: General Matrix Multiply - [alpha * A * B + beta * C]. </dd>
 231 <dd>
 232 GEMM: The tensors a, b, c, d must have the same data type. All are either F32 or F16. You should not mix data types when calling this function.</dd></dl>
 233 <dl class="params"><dt>Parameters</dt><dd>
 234   <table class="params">
 235     <tr><td class="paramdir">[in]</td><td class="paramname">a</td><td>First input tensor (Matrix A or <a class="el" href="struct_vector.xhtml" title="Structure to hold Vector information. ">Vector</a> A). Data type supported: F32, F16. </td></tr>
 236     <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>
 237     <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>
 238     <tr><td class="paramdir">[out]</td><td class="paramname">d</td><td>Output tensor. Data type supported: same as <code>a</code> </td></tr>
 239     <tr><td class="paramdir">[in]</td><td class="paramname">alpha</td><td>Weight of the matrix product </td></tr>
 240     <tr><td class="paramdir">[in]</td><td class="paramname">beta</td><td>Weight of matrix C </td></tr>
 241   </table>
 242   </dd>
 243 </dl>
 244
 245 </div>
 246 </div>
 247 <a class="anchor" id="ad1717410afd0be936c6213a63c8005fb"></a>
 248 <div class="memitem">
 249 <div class="memproto">
 250 <table class="mlabels">
 251   <tr>
 252   <td class="mlabels-left">
 253       <table class="memname">
 254         <tr>
 255           <td class="memname">void run </td>
 256           <td>(</td>
 257           <td class="paramname"></td><td>)</td>
 258           <td></td>
 259         </tr>
 260       </table>
 261   </td>
 262   <td class="mlabels-right">
 263 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 264   </tr>
 265 </table>
 266 </div><div class="memdoc">
 267
 268 <p>Run the kernels contained in the function. </p>
 269 <p>For NEON kernels:</p><ul>
 270 <li>Multi-threading is used for the kernels which are parallelisable.</li>
 271 <li>By default std::thread::hardware_concurrency() threads are used.</li>
 272 </ul>
 273 <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>
 274 <p>For OpenCL kernels:</p><ul>
 275 <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>
 276 <li>The queue is then flushed.</li>
 277 </ul>
 278 <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>
 279
 280 <p>Implements <a class="el" href="classarm__compute_1_1_i_function.xhtml#a18954417d3124a8095783ea13dc6d00b">IFunction</a>.</p>
 281
 282 </div>
 283 </div>
 284 <hr/>The documentation for this class was generated from the following file:<ul>
 285 <li>arm_compute/runtime/NEON/functions/<a class="el" href="_n_e_g_e_m_m_8h_source.xhtml">NEGEMM.h</a></li>
 286 </ul>
 287 </div><!-- contents -->
 288 </div><!-- doc-content -->
 289 <!-- start footer part -->
 290 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 291   <ul>
 292     <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_n_e_g_e_m_m.xhtml">NEGEMM</a></li>
 293     <li class="footer">Generated on Fri Mar 24 2017 17:23:51 for ARM Compute Library by
 294     <a href="http://www.doxygen.org/index.html">
 295     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
 296   </ul>
 297 </div>
 298 </body>
 299 </html>