arm_compute v17.04
[platform/upstream/armcl.git] / documentation / classarm__compute_1_1_n_e_g_e_m_m_matrix_multiply_kernel.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: NEGEMMMatrixMultiplyKernel 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.04</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_matrix_multiply_kernel.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">NEGEMMMatrixMultiplyKernel Class Reference</div>  </div>
121 </div><!--header-->
122 <div class="contents">
123
124 <p>NEON kernel to multiply two input matrices "A" and "B".  
125  <a href="classarm__compute_1_1_n_e_g_e_m_m_matrix_multiply_kernel.xhtml#details">More...</a></p>
126
127 <p><code>#include &lt;<a class="el" href="_n_e_g_e_m_m_matrix_multiply_kernel_8h_source.xhtml">NEGEMMMatrixMultiplyKernel.h</a>&gt;</code></p>
128 <div class="dynheader">
129 Collaboration diagram for NEGEMMMatrixMultiplyKernel:</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_matrix_multiply_kernel__coll__graph.svg" width="211" height="187"><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:aeef5692e383060fe73ee1eb989b96ad4"><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_matrix_multiply_kernel.xhtml#aeef5692e383060fe73ee1eb989b96ad4">NEGEMMMatrixMultiplyKernel</a> ()</td></tr>
138 <tr class="memdesc:aeef5692e383060fe73ee1eb989b96ad4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#aeef5692e383060fe73ee1eb989b96ad4">More...</a><br /></td></tr>
139 <tr class="separator:aeef5692e383060fe73ee1eb989b96ad4"><td class="memSeparator" colspan="2">&#160;</td></tr>
140 <tr class="memitem:a3ebc015a791e361baa4ce95ed05c7359"><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_matrix_multiply_kernel.xhtml#a3ebc015a791e361baa4ce95ed05c7359">NEGEMMMatrixMultiplyKernel</a> (const <a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_matrix_multiply_kernel.xhtml">NEGEMMMatrixMultiplyKernel</a> &amp;)=delete</td></tr>
141 <tr class="memdesc:a3ebc015a791e361baa4ce95ed05c7359"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#a3ebc015a791e361baa4ce95ed05c7359">More...</a><br /></td></tr>
142 <tr class="separator:a3ebc015a791e361baa4ce95ed05c7359"><td class="memSeparator" colspan="2">&#160;</td></tr>
143 <tr class="memitem:a7374bb3f1d0e7e9cd4ba2c33f03fe24d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_matrix_multiply_kernel.xhtml">NEGEMMMatrixMultiplyKernel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_matrix_multiply_kernel.xhtml#a7374bb3f1d0e7e9cd4ba2c33f03fe24d">operator=</a> (const <a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_matrix_multiply_kernel.xhtml">NEGEMMMatrixMultiplyKernel</a> &amp;)=delete</td></tr>
144 <tr class="memdesc:a7374bb3f1d0e7e9cd4ba2c33f03fe24d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#a7374bb3f1d0e7e9cd4ba2c33f03fe24d">More...</a><br /></td></tr>
145 <tr class="separator:a7374bb3f1d0e7e9cd4ba2c33f03fe24d"><td class="memSeparator" colspan="2">&#160;</td></tr>
146 <tr class="memitem:a24f041a22aab638f430bfd66897b5f54"><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_matrix_multiply_kernel.xhtml#a24f041a22aab638f430bfd66897b5f54">NEGEMMMatrixMultiplyKernel</a> (<a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_matrix_multiply_kernel.xhtml">NEGEMMMatrixMultiplyKernel</a> &amp;&amp;)=default</td></tr>
147 <tr class="memdesc:a24f041a22aab638f430bfd66897b5f54"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#a24f041a22aab638f430bfd66897b5f54">More...</a><br /></td></tr>
148 <tr class="separator:a24f041a22aab638f430bfd66897b5f54"><td class="memSeparator" colspan="2">&#160;</td></tr>
149 <tr class="memitem:a864371293368156a359430d90ebb7670"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_matrix_multiply_kernel.xhtml">NEGEMMMatrixMultiplyKernel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_matrix_multiply_kernel.xhtml#a864371293368156a359430d90ebb7670">operator=</a> (<a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_matrix_multiply_kernel.xhtml">NEGEMMMatrixMultiplyKernel</a> &amp;&amp;)=default</td></tr>
150 <tr class="memdesc:a864371293368156a359430d90ebb7670"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#a864371293368156a359430d90ebb7670">More...</a><br /></td></tr>
151 <tr class="separator:a864371293368156a359430d90ebb7670"><td class="memSeparator" colspan="2">&#160;</td></tr>
152 <tr class="memitem:aa4bb0bcb5a16fedf6b9474c6fa11e7e1"><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_matrix_multiply_kernel.xhtml#aa4bb0bcb5a16fedf6b9474c6fa11e7e1">configure</a> (const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *input0, const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *input1, <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *output, float alpha)</td></tr>
153 <tr class="memdesc:aa4bb0bcb5a16fedf6b9474c6fa11e7e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise the kernel's input and output.  <a href="#aa4bb0bcb5a16fedf6b9474c6fa11e7e1">More...</a><br /></td></tr>
154 <tr class="separator:aa4bb0bcb5a16fedf6b9474c6fa11e7e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
155 <tr class="memitem:a8fd12b95bdde3f93db96bc9b1598db69"><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_matrix_multiply_kernel.xhtml#a8fd12b95bdde3f93db96bc9b1598db69">run</a> (const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;<a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353">window</a>) override</td></tr>
156 <tr class="memdesc:a8fd12b95bdde3f93db96bc9b1598db69"><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute the kernel on the passed window.  <a href="#a8fd12b95bdde3f93db96bc9b1598db69">More...</a><br /></td></tr>
157 <tr class="separator:a8fd12b95bdde3f93db96bc9b1598db69"><td class="memSeparator" colspan="2">&#160;</td></tr>
158 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_c_p_p_kernel')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml">ICPPKernel</a></td></tr>
159 <tr class="memitem:a033d17a97e07cea7fe83eefcf23540f6 inherit pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml#a033d17a97e07cea7fe83eefcf23540f6">~ICPPKernel</a> ()=default</td></tr>
160 <tr class="memdesc:a033d17a97e07cea7fe83eefcf23540f6 inherit pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor.  <a href="#a033d17a97e07cea7fe83eefcf23540f6">More...</a><br /></td></tr>
161 <tr class="separator:a033d17a97e07cea7fe83eefcf23540f6 inherit pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
162 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_kernel"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_kernel')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_kernel.xhtml">IKernel</a></td></tr>
163 <tr class="memitem:a7250cb8cbaa4104a93a2d77155085507 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a7250cb8cbaa4104a93a2d77155085507">IKernel</a> ()</td></tr>
164 <tr class="memdesc:a7250cb8cbaa4104a93a2d77155085507 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a7250cb8cbaa4104a93a2d77155085507">More...</a><br /></td></tr>
165 <tr class="separator:a7250cb8cbaa4104a93a2d77155085507 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
166 <tr class="memitem:a341b60d15a5e12a5b8f3825194dd3b12 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a341b60d15a5e12a5b8f3825194dd3b12">~IKernel</a> ()=default</td></tr>
167 <tr class="memdesc:a341b60d15a5e12a5b8f3825194dd3b12 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#a341b60d15a5e12a5b8f3825194dd3b12">More...</a><br /></td></tr>
168 <tr class="separator:a341b60d15a5e12a5b8f3825194dd3b12 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
169 <tr class="memitem:abfab8f0d4928e1081d9f65b77933e24a inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_kernel.xhtml#abfab8f0d4928e1081d9f65b77933e24a">is_parallelisable</a> () const </td></tr>
170 <tr class="memdesc:abfab8f0d4928e1081d9f65b77933e24a inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates whether or not the kernel is parallelisable.  <a href="#abfab8f0d4928e1081d9f65b77933e24a">More...</a><br /></td></tr>
171 <tr class="separator:abfab8f0d4928e1081d9f65b77933e24a inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
172 <tr class="memitem:aa6daa9b04e2035bf007e5e5c3c4396a8 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structarm__compute_1_1_border_size.xhtml">BorderSize</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_kernel.xhtml#aa6daa9b04e2035bf007e5e5c3c4396a8">border_size</a> () const </td></tr>
173 <tr class="memdesc:aa6daa9b04e2035bf007e5e5c3c4396a8 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">The size of the border for that kernel.  <a href="#aa6daa9b04e2035bf007e5e5c3c4396a8">More...</a><br /></td></tr>
174 <tr class="separator:aa6daa9b04e2035bf007e5e5c3c4396a8 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
175 <tr class="memitem:a3f5646133956f06348b310ccc3d36353 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353">window</a> () const </td></tr>
176 <tr class="memdesc:a3f5646133956f06348b310ccc3d36353 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">The maximum window the kernel can be executed on.  <a href="#a3f5646133956f06348b310ccc3d36353">More...</a><br /></td></tr>
177 <tr class="separator:a3f5646133956f06348b310ccc3d36353 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
178 </table>
179 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
180 <div class="textblock"><p>NEON kernel to multiply two input matrices "A" and "B". </p>
181 <p>All elements of the output matrix/vector will be multiplied by alpha after the matrix multiplication</p>
182 <dl class="section note"><dt>Note</dt><dd>If the output tensor is a matrix, the implementation assumes that the input tensors <code>input0</code> and <code>input1</code> are both matrices and reshaped respectively with <a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_interleave4x4_kernel.xhtml">NEGEMMInterleave4x4Kernel</a>" and <a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_transpose1x_w_kernel.xhtml">NEGEMMTranspose1xWKernel</a> </dd>
183 <dd>
184 If the output tensor is a vector and the data type is F32, the implementation assumes that the first input tensor <code>input0</code> is a vector and the second input tensor <code>input1</code> a matrix. The implementation also assumes that both tensors have not been reshaped </dd></dl>
185
186 <p>Definition at line <a class="el" href="_n_e_g_e_m_m_matrix_multiply_kernel_8h_source.xhtml#l00039">39</a> of file <a class="el" href="_n_e_g_e_m_m_matrix_multiply_kernel_8h_source.xhtml">NEGEMMMatrixMultiplyKernel.h</a>.</p>
187 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
188 <a class="anchor" id="aeef5692e383060fe73ee1eb989b96ad4"></a>
189 <div class="memitem">
190 <div class="memproto">
191       <table class="memname">
192         <tr>
193           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_matrix_multiply_kernel.xhtml">NEGEMMMatrixMultiplyKernel</a> </td>
194           <td>(</td>
195           <td class="paramname"></td><td>)</td>
196           <td></td>
197         </tr>
198       </table>
199 </div><div class="memdoc">
200
201 <p>Constructor. </p>
202
203 </div>
204 </div>
205 <a class="anchor" id="a3ebc015a791e361baa4ce95ed05c7359"></a>
206 <div class="memitem">
207 <div class="memproto">
208 <table class="mlabels">
209   <tr>
210   <td class="mlabels-left">
211       <table class="memname">
212         <tr>
213           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_matrix_multiply_kernel.xhtml">NEGEMMMatrixMultiplyKernel</a> </td>
214           <td>(</td>
215           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_matrix_multiply_kernel.xhtml">NEGEMMMatrixMultiplyKernel</a> &amp;&#160;</td>
216           <td class="paramname"></td><td>)</td>
217           <td></td>
218         </tr>
219       </table>
220   </td>
221   <td class="mlabels-right">
222 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
223   </tr>
224 </table>
225 </div><div class="memdoc">
226
227 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
228
229 </div>
230 </div>
231 <a class="anchor" id="a24f041a22aab638f430bfd66897b5f54"></a>
232 <div class="memitem">
233 <div class="memproto">
234 <table class="mlabels">
235   <tr>
236   <td class="mlabels-left">
237       <table class="memname">
238         <tr>
239           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_matrix_multiply_kernel.xhtml">NEGEMMMatrixMultiplyKernel</a> </td>
240           <td>(</td>
241           <td class="paramtype"><a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_matrix_multiply_kernel.xhtml">NEGEMMMatrixMultiplyKernel</a> &amp;&amp;&#160;</td>
242           <td class="paramname"></td><td>)</td>
243           <td></td>
244         </tr>
245       </table>
246   </td>
247   <td class="mlabels-right">
248 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
249   </tr>
250 </table>
251 </div><div class="memdoc">
252
253 <p>Allow instances of this class to be moved. </p>
254
255 </div>
256 </div>
257 <h2 class="groupheader">Member Function Documentation</h2>
258 <a class="anchor" id="aa4bb0bcb5a16fedf6b9474c6fa11e7e1"></a>
259 <div class="memitem">
260 <div class="memproto">
261       <table class="memname">
262         <tr>
263           <td class="memname">void configure </td>
264           <td>(</td>
265           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
266           <td class="paramname"><em>input0</em>, </td>
267         </tr>
268         <tr>
269           <td class="paramkey"></td>
270           <td></td>
271           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
272           <td class="paramname"><em>input1</em>, </td>
273         </tr>
274         <tr>
275           <td class="paramkey"></td>
276           <td></td>
277           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
278           <td class="paramname"><em>output</em>, </td>
279         </tr>
280         <tr>
281           <td class="paramkey"></td>
282           <td></td>
283           <td class="paramtype">float&#160;</td>
284           <td class="paramname"><em>alpha</em>&#160;</td>
285         </tr>
286         <tr>
287           <td></td>
288           <td>)</td>
289           <td></td><td></td>
290         </tr>
291       </table>
292 </div><div class="memdoc">
293
294 <p>Initialise the kernel's input and output. </p>
295 <dl class="section note"><dt>Note</dt><dd>If the output tensor is a matrix, the input matrices <code>input0</code> and <code>input1</code> should be the output of the kernels: <a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_interleave4x4_kernel.xhtml">NEGEMMInterleave4x4Kernel</a> and <a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_transpose1x_w_kernel.xhtml">NEGEMMTranspose1xWKernel</a> These two kernels change the layout of the original matrices to be more cache-friendly.</dd></dl>
296 <dl class="params"><dt>Parameters</dt><dd>
297   <table class="params">
298     <tr><td class="paramdir">[in]</td><td class="paramname">input0</td><td>Input tensor containing the interleaved Matrix A or the vector A. Data types supported: F32, F16. </td></tr>
299     <tr><td class="paramdir">[in]</td><td class="paramname">input1</td><td>Input tensor containing the transposed Matrix B if the first input tensor A is not a vector. If the output tensor is a vector, input1 must contain the matrix B not reshaped. Data type supported: same as <code>input0</code> </td></tr>
300     <tr><td class="paramdir">[out]</td><td class="paramname">output</td><td>Output tensor to store the result of matrix multiplication. Data type supported: same as <code>input0</code>. </td></tr>
301     <tr><td class="paramdir">[in]</td><td class="paramname">alpha</td><td>Weight of the matrix product </td></tr>
302   </table>
303   </dd>
304 </dl>
305
306 </div>
307 </div>
308 <a class="anchor" id="a7374bb3f1d0e7e9cd4ba2c33f03fe24d"></a>
309 <div class="memitem">
310 <div class="memproto">
311 <table class="mlabels">
312   <tr>
313   <td class="mlabels-left">
314       <table class="memname">
315         <tr>
316           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_matrix_multiply_kernel.xhtml">NEGEMMMatrixMultiplyKernel</a>&amp; operator= </td>
317           <td>(</td>
318           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_matrix_multiply_kernel.xhtml">NEGEMMMatrixMultiplyKernel</a> &amp;&#160;</td>
319           <td class="paramname"></td><td>)</td>
320           <td></td>
321         </tr>
322       </table>
323   </td>
324   <td class="mlabels-right">
325 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
326   </tr>
327 </table>
328 </div><div class="memdoc">
329
330 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
331
332 </div>
333 </div>
334 <a class="anchor" id="a864371293368156a359430d90ebb7670"></a>
335 <div class="memitem">
336 <div class="memproto">
337 <table class="mlabels">
338   <tr>
339   <td class="mlabels-left">
340       <table class="memname">
341         <tr>
342           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_matrix_multiply_kernel.xhtml">NEGEMMMatrixMultiplyKernel</a>&amp; operator= </td>
343           <td>(</td>
344           <td class="paramtype"><a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_matrix_multiply_kernel.xhtml">NEGEMMMatrixMultiplyKernel</a> &amp;&amp;&#160;</td>
345           <td class="paramname"></td><td>)</td>
346           <td></td>
347         </tr>
348       </table>
349   </td>
350   <td class="mlabels-right">
351 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
352   </tr>
353 </table>
354 </div><div class="memdoc">
355
356 <p>Allow instances of this class to be moved. </p>
357
358 </div>
359 </div>
360 <a class="anchor" id="a8fd12b95bdde3f93db96bc9b1598db69"></a>
361 <div class="memitem">
362 <div class="memproto">
363 <table class="mlabels">
364   <tr>
365   <td class="mlabels-left">
366       <table class="memname">
367         <tr>
368           <td class="memname">void run </td>
369           <td>(</td>
370           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;&#160;</td>
371           <td class="paramname"><em>window</em></td><td>)</td>
372           <td></td>
373         </tr>
374       </table>
375   </td>
376   <td class="mlabels-right">
377 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
378   </tr>
379 </table>
380 </div><div class="memdoc">
381
382 <p>Execute the kernel on the passed window. </p>
383 <dl class="section warning"><dt>Warning</dt><dd>If <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#abfab8f0d4928e1081d9f65b77933e24a" title="Indicates whether or not the kernel is parallelisable. ">is_parallelisable()</a> returns false then the passed window must be equal to <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353" title="The maximum window the kernel can be executed on. ">window()</a></dd></dl>
384 <dl class="section note"><dt>Note</dt><dd>The window has to be a region within the window returned by the <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353" title="The maximum window the kernel can be executed on. ">window()</a> method</dd>
385 <dd>
386 The width of the window has to be a multiple of num_elems_processed_per_iteration().</dd></dl>
387 <dl class="params"><dt>Parameters</dt><dd>
388   <table class="params">
389     <tr><td class="paramdir">[in]</td><td class="paramname">window</td><td>Region on which to execute the kernel. (Must be a region of the window returned by <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353" title="The maximum window the kernel can be executed on. ">window()</a>) </td></tr>
390   </table>
391   </dd>
392 </dl>
393
394 <p>Implements <a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml#a6f56c8bb44166634652b877d6eb7a9a2">ICPPKernel</a>.</p>
395
396 </div>
397 </div>
398 <hr/>The documentation for this class was generated from the following file:<ul>
399 <li>arm_compute/core/NEON/kernels/<a class="el" href="_n_e_g_e_m_m_matrix_multiply_kernel_8h_source.xhtml">NEGEMMMatrixMultiplyKernel.h</a></li>
400 </ul>
401 </div><!-- contents -->
402 </div><!-- doc-content -->
403 <!-- start footer part -->
404 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
405   <ul>
406     <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_matrix_multiply_kernel.xhtml">NEGEMMMatrixMultiplyKernel</a></li>
407     <li class="footer">Generated on Wed Apr 12 2017 14:26:06 for ARM Compute Library by
408     <a href="http://www.doxygen.org/index.html">
409     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
410   </ul>
411 </div>
412 </body>
413 </html>