arm_compute v17.09
[platform/upstream/armcl.git] / documentation / classarm__compute_1_1_n_e_g_e_m_m_matrix_addition_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.6"/>
8 <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
9 <title>Compute Library: NEGEMMMatrixAdditionKernel 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="navtree.js"></script>
16 <script type="text/javascript">
17   $(document).ready(initResizable);
18   $(window).load(resizeHeight);
19 </script>
20 <link href="search/search.css" rel="stylesheet" type="text/css"/>
21 <script type="text/javascript" src="search/search.js"></script>
22 <script type="text/javascript">
23   $(document).ready(function() { searchBox.OnSelectItem(0); });
24 </script>
25 <script type="text/x-mathjax-config">
26   MathJax.Hub.Config({
27     extensions: ["tex2jax.js"],
28     jax: ["input/TeX","output/HTML-CSS"],
29 });
30 </script><script src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
31 <link href="doxygen.css" rel="stylesheet" type="text/css" />
32 </head>
33 <body>
34 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
35 <div id="titlearea">
36 <table cellspacing="0" cellpadding="0">
37  <tbody>
38  <tr style="height: 56px;">
39   <td style="padding-left: 0.5em;">
40    <div id="projectname">Compute Library
41    &#160;<span id="projectnumber">17.09</span>
42    </div>
43   </td>
44  </tr>
45  </tbody>
46 </table>
47 </div>
48 <!-- end header part -->
49 <!-- Generated by Doxygen 1.8.6 -->
50 <script type="text/javascript">
51 var searchBox = new SearchBox("searchBox", "search",false,'Search');
52 </script>
53   <div id="navrow1" class="tabs">
54     <ul class="tablist">
55       <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
56       <li><a href="pages.xhtml"><span>Related&#160;Pages</span></a></li>
57       <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
58       <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
59       <li><a href="files.xhtml"><span>Files</span></a></li>
60       <li>
61         <div id="MSearchBox" class="MSearchBoxInactive">
62         <span class="left">
63           <img id="MSearchSelect" src="search/mag_sel.png"
64                onmouseover="return searchBox.OnSearchSelectShow()"
65                onmouseout="return searchBox.OnSearchSelectHide()"
66                alt=""/>
67           <input type="text" id="MSearchField" value="Search" accesskey="S"
68                onfocus="searchBox.OnSearchFieldFocus(true)" 
69                onblur="searchBox.OnSearchFieldFocus(false)" 
70                onkeyup="searchBox.OnSearchFieldChange(event)"/>
71           </span><span class="right">
72             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
73           </span>
74         </div>
75       </li>
76     </ul>
77   </div>
78   <div id="navrow2" class="tabs2">
79     <ul class="tablist">
80       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
81       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
82       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
83       <li><a href="functions.xhtml"><span>Data&#160;Fields</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('classarm__compute_1_1_n_e_g_e_m_m_matrix_addition_kernel.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 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Pages</a></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="#pub-methods">Public Member Functions</a>  </div>
118   <div class="headertitle">
119 <div class="title">NEGEMMMatrixAdditionKernel Class Reference</div>  </div>
120 </div><!--header-->
121 <div class="contents">
122
123 <p>NEON kernel to perform the in-place matrix addition between 2 matrices taking into account that the second matrix might be weighted by a scalar value beta:  
124  <a href="classarm__compute_1_1_n_e_g_e_m_m_matrix_addition_kernel.xhtml#details">More...</a></p>
125
126 <p><code>#include &lt;<a class="el" href="_n_e_g_e_m_m_matrix_addition_kernel_8h_source.xhtml">NEGEMMMatrixAdditionKernel.h</a>&gt;</code></p>
127 <div class="dynheader">
128 Collaboration diagram for NEGEMMMatrixAdditionKernel:</div>
129 <div class="dyncontent">
130 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_n_e_g_e_m_m_matrix_addition_kernel__coll__graph.svg" width="214" height="262"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
131 </div>
132 <center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
133 <table class="memberdecls">
134 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
135 Public Member Functions</h2></td></tr>
136 <tr class="memitem:ab2165f92396a03786cf5e499c4d0e62c"><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_addition_kernel.xhtml#ab2165f92396a03786cf5e499c4d0e62c">NEGEMMMatrixAdditionKernel</a> ()</td></tr>
137 <tr class="memdesc:ab2165f92396a03786cf5e499c4d0e62c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#ab2165f92396a03786cf5e499c4d0e62c">More...</a><br/></td></tr>
138 <tr class="separator:ab2165f92396a03786cf5e499c4d0e62c"><td class="memSeparator" colspan="2">&#160;</td></tr>
139 <tr class="memitem:a0b3c2d43b065aefa8c68e0bc7488794e"><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_addition_kernel.xhtml#a0b3c2d43b065aefa8c68e0bc7488794e">NEGEMMMatrixAdditionKernel</a> (const <a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_matrix_addition_kernel.xhtml">NEGEMMMatrixAdditionKernel</a> &amp;)=delete</td></tr>
140 <tr class="memdesc:a0b3c2d43b065aefa8c68e0bc7488794e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied.  <a href="#a0b3c2d43b065aefa8c68e0bc7488794e">More...</a><br/></td></tr>
141 <tr class="separator:a0b3c2d43b065aefa8c68e0bc7488794e"><td class="memSeparator" colspan="2">&#160;</td></tr>
142 <tr class="memitem:a7bf4194c21adc060991ddb88ed4c8b60"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_matrix_addition_kernel.xhtml">NEGEMMMatrixAdditionKernel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_matrix_addition_kernel.xhtml#a7bf4194c21adc060991ddb88ed4c8b60">operator=</a> (const <a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_matrix_addition_kernel.xhtml">NEGEMMMatrixAdditionKernel</a> &amp;)=delete</td></tr>
143 <tr class="memdesc:a7bf4194c21adc060991ddb88ed4c8b60"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied.  <a href="#a7bf4194c21adc060991ddb88ed4c8b60">More...</a><br/></td></tr>
144 <tr class="separator:a7bf4194c21adc060991ddb88ed4c8b60"><td class="memSeparator" colspan="2">&#160;</td></tr>
145 <tr class="memitem:aa1e494c2f7b81dfb35b3ec69adffd225"><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_addition_kernel.xhtml#aa1e494c2f7b81dfb35b3ec69adffd225">NEGEMMMatrixAdditionKernel</a> (<a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_matrix_addition_kernel.xhtml">NEGEMMMatrixAdditionKernel</a> &amp;&amp;)=default</td></tr>
146 <tr class="memdesc:aa1e494c2f7b81dfb35b3ec69adffd225"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#aa1e494c2f7b81dfb35b3ec69adffd225">More...</a><br/></td></tr>
147 <tr class="separator:aa1e494c2f7b81dfb35b3ec69adffd225"><td class="memSeparator" colspan="2">&#160;</td></tr>
148 <tr class="memitem:adc1be2dee3a4aeeb959cf2ec7aec7657"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_matrix_addition_kernel.xhtml">NEGEMMMatrixAdditionKernel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_matrix_addition_kernel.xhtml#adc1be2dee3a4aeeb959cf2ec7aec7657">operator=</a> (<a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_matrix_addition_kernel.xhtml">NEGEMMMatrixAdditionKernel</a> &amp;&amp;)=default</td></tr>
149 <tr class="memdesc:adc1be2dee3a4aeeb959cf2ec7aec7657"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#adc1be2dee3a4aeeb959cf2ec7aec7657">More...</a><br/></td></tr>
150 <tr class="separator:adc1be2dee3a4aeeb959cf2ec7aec7657"><td class="memSeparator" colspan="2">&#160;</td></tr>
151 <tr class="memitem:abd3df2f9251266926538e4c020652996"><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_addition_kernel.xhtml#abd3df2f9251266926538e4c020652996">configure</a> (const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *input, <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *output, float beta)</td></tr>
152 <tr class="memdesc:abd3df2f9251266926538e4c020652996"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise the kernel's input and output.  <a href="#abd3df2f9251266926538e4c020652996">More...</a><br/></td></tr>
153 <tr class="separator:abd3df2f9251266926538e4c020652996"><td class="memSeparator" colspan="2">&#160;</td></tr>
154 <tr class="memitem:a112b35dd205c62ea6ed1447ef226da82"><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_addition_kernel.xhtml#a112b35dd205c62ea6ed1447ef226da82">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>, const <a class="el" href="structarm__compute_1_1_thread_info.xhtml">ThreadInfo</a> &amp;info) override</td></tr>
155 <tr class="memdesc:a112b35dd205c62ea6ed1447ef226da82"><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute the kernel on the passed window.  <a href="#a112b35dd205c62ea6ed1447ef226da82">More...</a><br/></td></tr>
156 <tr class="separator:a112b35dd205c62ea6ed1447ef226da82"><td class="memSeparator" colspan="2">&#160;</td></tr>
157 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_c_p_p_simple_kernel"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_c_p_p_simple_kernel')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_c_p_p_simple_kernel.xhtml">ICPPSimpleKernel</a></td></tr>
158 <tr class="memitem:a3f46900690da1aee8ff395133f853cb4 inherit pub_methods_classarm__compute_1_1_i_c_p_p_simple_kernel"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_p_p_simple_kernel.xhtml#a3f46900690da1aee8ff395133f853cb4">ICPPSimpleKernel</a> ()</td></tr>
159 <tr class="memdesc:a3f46900690da1aee8ff395133f853cb4 inherit pub_methods_classarm__compute_1_1_i_c_p_p_simple_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a3f46900690da1aee8ff395133f853cb4">More...</a><br/></td></tr>
160 <tr class="separator:a3f46900690da1aee8ff395133f853cb4 inherit pub_methods_classarm__compute_1_1_i_c_p_p_simple_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
161 <tr class="memitem:ad6c492d85c9a5f91cf905defb626db4f inherit pub_methods_classarm__compute_1_1_i_c_p_p_simple_kernel"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_p_p_simple_kernel.xhtml#ad6c492d85c9a5f91cf905defb626db4f">ICPPSimpleKernel</a> (const <a class="el" href="classarm__compute_1_1_i_c_p_p_simple_kernel.xhtml">ICPPSimpleKernel</a> &amp;)=delete</td></tr>
162 <tr class="memdesc:ad6c492d85c9a5f91cf905defb626db4f inherit pub_methods_classarm__compute_1_1_i_c_p_p_simple_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#ad6c492d85c9a5f91cf905defb626db4f">More...</a><br/></td></tr>
163 <tr class="separator:ad6c492d85c9a5f91cf905defb626db4f inherit pub_methods_classarm__compute_1_1_i_c_p_p_simple_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
164 <tr class="memitem:a4a631f6a74572e47d958c4c314406000 inherit pub_methods_classarm__compute_1_1_i_c_p_p_simple_kernel"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_i_c_p_p_simple_kernel.xhtml">ICPPSimpleKernel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_p_p_simple_kernel.xhtml#a4a631f6a74572e47d958c4c314406000">operator=</a> (const <a class="el" href="classarm__compute_1_1_i_c_p_p_simple_kernel.xhtml">ICPPSimpleKernel</a> &amp;)=delete</td></tr>
165 <tr class="memdesc:a4a631f6a74572e47d958c4c314406000 inherit pub_methods_classarm__compute_1_1_i_c_p_p_simple_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#a4a631f6a74572e47d958c4c314406000">More...</a><br/></td></tr>
166 <tr class="separator:a4a631f6a74572e47d958c4c314406000 inherit pub_methods_classarm__compute_1_1_i_c_p_p_simple_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
167 <tr class="memitem:a7a40bf323d5fa5e88fb2f6581c43af0c inherit pub_methods_classarm__compute_1_1_i_c_p_p_simple_kernel"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_p_p_simple_kernel.xhtml#a7a40bf323d5fa5e88fb2f6581c43af0c">ICPPSimpleKernel</a> (<a class="el" href="classarm__compute_1_1_i_c_p_p_simple_kernel.xhtml">ICPPSimpleKernel</a> &amp;&amp;)=default</td></tr>
168 <tr class="memdesc:a7a40bf323d5fa5e88fb2f6581c43af0c inherit pub_methods_classarm__compute_1_1_i_c_p_p_simple_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#a7a40bf323d5fa5e88fb2f6581c43af0c">More...</a><br/></td></tr>
169 <tr class="separator:a7a40bf323d5fa5e88fb2f6581c43af0c inherit pub_methods_classarm__compute_1_1_i_c_p_p_simple_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
170 <tr class="memitem:ac0f362034a917ae5fdb8506ab0f1e036 inherit pub_methods_classarm__compute_1_1_i_c_p_p_simple_kernel"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_i_c_p_p_simple_kernel.xhtml">ICPPSimpleKernel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_p_p_simple_kernel.xhtml#ac0f362034a917ae5fdb8506ab0f1e036">operator=</a> (<a class="el" href="classarm__compute_1_1_i_c_p_p_simple_kernel.xhtml">ICPPSimpleKernel</a> &amp;&amp;)=default</td></tr>
171 <tr class="memdesc:ac0f362034a917ae5fdb8506ab0f1e036 inherit pub_methods_classarm__compute_1_1_i_c_p_p_simple_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#ac0f362034a917ae5fdb8506ab0f1e036">More...</a><br/></td></tr>
172 <tr class="separator:ac0f362034a917ae5fdb8506ab0f1e036 inherit pub_methods_classarm__compute_1_1_i_c_p_p_simple_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
173 <tr class="memitem:a819c40bc2449e5c47178bb34680256b8 inherit pub_methods_classarm__compute_1_1_i_c_p_p_simple_kernel"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_p_p_simple_kernel.xhtml#a819c40bc2449e5c47178bb34680256b8">~ICPPSimpleKernel</a> ()=default</td></tr>
174 <tr class="memdesc:a819c40bc2449e5c47178bb34680256b8 inherit pub_methods_classarm__compute_1_1_i_c_p_p_simple_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor.  <a href="#a819c40bc2449e5c47178bb34680256b8">More...</a><br/></td></tr>
175 <tr class="separator:a819c40bc2449e5c47178bb34680256b8 inherit pub_methods_classarm__compute_1_1_i_c_p_p_simple_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
176 <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>
177 <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>
178 <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>
179 <tr class="separator:a033d17a97e07cea7fe83eefcf23540f6 inherit pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
180 <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>
181 <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>
182 <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>
183 <tr class="separator:a7250cb8cbaa4104a93a2d77155085507 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
184 <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>
185 <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>
186 <tr class="separator:a341b60d15a5e12a5b8f3825194dd3b12 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
187 <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>
188 <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>
189 <tr class="separator:abfab8f0d4928e1081d9f65b77933e24a inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
190 <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>
191 <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>
192 <tr class="separator:aa6daa9b04e2035bf007e5e5c3c4396a8 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
193 <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>
194 <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>
195 <tr class="separator:a3f5646133956f06348b310ccc3d36353 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
196 </table>
197 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
198 <div class="textblock"><p>NEON kernel to perform the in-place matrix addition between 2 matrices taking into account that the second matrix might be weighted by a scalar value beta: </p>
199 <dl class="section note"><dt>Note</dt><dd>[ MTX_OUT = MTX_0 + beta * MTX_1 ] with MTX_0 and MTX_1 of the same size</dd>
200 <dd>
201 This stage is used to finalize the GEMM result and it is computed if and only if beta != 0.0. In case this kernel is used for finalizing GEMM result, we have:<ul>
202 <li>MTX_0 = A * B * alpha, where MTX_0 is the output of <a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_matrix_multiply_kernel.xhtml">NEGEMMMatrixMultiplyKernel</a></li>
203 <li>MTX_1 = C </li>
204 </ul>
205 </dd></dl>
206
207 <p>Definition at line <a class="el" href="_n_e_g_e_m_m_matrix_addition_kernel_8h_source.xhtml#l00041">41</a> of file <a class="el" href="_n_e_g_e_m_m_matrix_addition_kernel_8h_source.xhtml">NEGEMMMatrixAdditionKernel.h</a>.</p>
208 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
209 <a class="anchor" id="ab2165f92396a03786cf5e499c4d0e62c"></a>
210 <div class="memitem">
211 <div class="memproto">
212       <table class="memname">
213         <tr>
214           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_matrix_addition_kernel.xhtml">NEGEMMMatrixAdditionKernel</a> </td>
215           <td>(</td>
216           <td class="paramname"></td><td>)</td>
217           <td></td>
218         </tr>
219       </table>
220 </div><div class="memdoc">
221
222 <p>Constructor. </p>
223
224 </div>
225 </div>
226 <a class="anchor" id="a0b3c2d43b065aefa8c68e0bc7488794e"></a>
227 <div class="memitem">
228 <div class="memproto">
229 <table class="mlabels">
230   <tr>
231   <td class="mlabels-left">
232       <table class="memname">
233         <tr>
234           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_matrix_addition_kernel.xhtml">NEGEMMMatrixAdditionKernel</a> </td>
235           <td>(</td>
236           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_matrix_addition_kernel.xhtml">NEGEMMMatrixAdditionKernel</a> &amp;&#160;</td>
237           <td class="paramname"></td><td>)</td>
238           <td></td>
239         </tr>
240       </table>
241   </td>
242   <td class="mlabels-right">
243 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
244   </tr>
245 </table>
246 </div><div class="memdoc">
247
248 <p>Prevent instances of this class from being copied. </p>
249
250 </div>
251 </div>
252 <a class="anchor" id="aa1e494c2f7b81dfb35b3ec69adffd225"></a>
253 <div class="memitem">
254 <div class="memproto">
255 <table class="mlabels">
256   <tr>
257   <td class="mlabels-left">
258       <table class="memname">
259         <tr>
260           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_matrix_addition_kernel.xhtml">NEGEMMMatrixAdditionKernel</a> </td>
261           <td>(</td>
262           <td class="paramtype"><a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_matrix_addition_kernel.xhtml">NEGEMMMatrixAdditionKernel</a> &amp;&amp;&#160;</td>
263           <td class="paramname"></td><td>)</td>
264           <td></td>
265         </tr>
266       </table>
267   </td>
268   <td class="mlabels-right">
269 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
270   </tr>
271 </table>
272 </div><div class="memdoc">
273
274 <p>Allow instances of this class to be moved. </p>
275
276 </div>
277 </div>
278 <h2 class="groupheader">Member Function Documentation</h2>
279 <a class="anchor" id="abd3df2f9251266926538e4c020652996"></a>
280 <div class="memitem">
281 <div class="memproto">
282       <table class="memname">
283         <tr>
284           <td class="memname">void configure </td>
285           <td>(</td>
286           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
287           <td class="paramname"><em>input</em>, </td>
288         </tr>
289         <tr>
290           <td class="paramkey"></td>
291           <td></td>
292           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
293           <td class="paramname"><em>output</em>, </td>
294         </tr>
295         <tr>
296           <td class="paramkey"></td>
297           <td></td>
298           <td class="paramtype">float&#160;</td>
299           <td class="paramname"><em>beta</em>&#160;</td>
300         </tr>
301         <tr>
302           <td></td>
303           <td>)</td>
304           <td></td><td></td>
305         </tr>
306       </table>
307 </div><div class="memdoc">
308
309 <p>Initialise the kernel's input and output. </p>
310 <dl class="section note"><dt>Note</dt><dd>The input and output tensor must have the same dimensions</dd></dl>
311 <dl class="params"><dt>Parameters</dt><dd>
312   <table class="params">
313     <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>Input tensor (Matrix C). Data types supported: QS8/QS16/F16/F32 </td></tr>
314     <tr><td class="paramdir">[in,out]</td><td class="paramname">output</td><td>Output tensor. If this kernel is used to finalize the GEMM result, output contains the result obtained by the kernel <a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_matrix_multiply_kernel.xhtml">NEGEMMMatrixMultiplyKernel</a>. Data type supported: the same as <code>input</code>. </td></tr>
315     <tr><td class="paramdir">[in]</td><td class="paramname">beta</td><td>Weight of matrix C </td></tr>
316   </table>
317   </dd>
318 </dl>
319
320 </div>
321 </div>
322 <a class="anchor" id="a7bf4194c21adc060991ddb88ed4c8b60"></a>
323 <div class="memitem">
324 <div class="memproto">
325 <table class="mlabels">
326   <tr>
327   <td class="mlabels-left">
328       <table class="memname">
329         <tr>
330           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_matrix_addition_kernel.xhtml">NEGEMMMatrixAdditionKernel</a>&amp; operator= </td>
331           <td>(</td>
332           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_matrix_addition_kernel.xhtml">NEGEMMMatrixAdditionKernel</a> &amp;&#160;</td>
333           <td class="paramname"></td><td>)</td>
334           <td></td>
335         </tr>
336       </table>
337   </td>
338   <td class="mlabels-right">
339 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
340   </tr>
341 </table>
342 </div><div class="memdoc">
343
344 <p>Prevent instances of this class from being copied. </p>
345
346 </div>
347 </div>
348 <a class="anchor" id="adc1be2dee3a4aeeb959cf2ec7aec7657"></a>
349 <div class="memitem">
350 <div class="memproto">
351 <table class="mlabels">
352   <tr>
353   <td class="mlabels-left">
354       <table class="memname">
355         <tr>
356           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_matrix_addition_kernel.xhtml">NEGEMMMatrixAdditionKernel</a>&amp; operator= </td>
357           <td>(</td>
358           <td class="paramtype"><a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_matrix_addition_kernel.xhtml">NEGEMMMatrixAdditionKernel</a> &amp;&amp;&#160;</td>
359           <td class="paramname"></td><td>)</td>
360           <td></td>
361         </tr>
362       </table>
363   </td>
364   <td class="mlabels-right">
365 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
366   </tr>
367 </table>
368 </div><div class="memdoc">
369
370 <p>Allow instances of this class to be moved. </p>
371
372 </div>
373 </div>
374 <a class="anchor" id="a112b35dd205c62ea6ed1447ef226da82"></a>
375 <div class="memitem">
376 <div class="memproto">
377 <table class="mlabels">
378   <tr>
379   <td class="mlabels-left">
380       <table class="memname">
381         <tr>
382           <td class="memname">void run </td>
383           <td>(</td>
384           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;&#160;</td>
385           <td class="paramname"><em>window</em>, </td>
386         </tr>
387         <tr>
388           <td class="paramkey"></td>
389           <td></td>
390           <td class="paramtype">const <a class="el" href="structarm__compute_1_1_thread_info.xhtml">ThreadInfo</a> &amp;&#160;</td>
391           <td class="paramname"><em>info</em>&#160;</td>
392         </tr>
393         <tr>
394           <td></td>
395           <td>)</td>
396           <td></td><td></td>
397         </tr>
398       </table>
399   </td>
400   <td class="mlabels-right">
401 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
402   </tr>
403 </table>
404 </div><div class="memdoc">
405
406 <p>Execute the kernel on the passed window. </p>
407 <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>
408 <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>
409 <dd>
410 The width of the window has to be a multiple of num_elems_processed_per_iteration().</dd></dl>
411 <dl class="params"><dt>Parameters</dt><dd>
412   <table class="params">
413     <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>
414     <tr><td class="paramdir">[in]</td><td class="paramname">info</td><td>Info about executing thread and CPU. </td></tr>
415   </table>
416   </dd>
417 </dl>
418
419 <p>Implements <a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml#af814ff5e96f40f1cccf809b2b4ee19ef">ICPPKernel</a>.</p>
420
421 </div>
422 </div>
423 <hr/>The documentation for this class was generated from the following file:<ul>
424 <li>arm_compute/core/NEON/kernels/<a class="el" href="_n_e_g_e_m_m_matrix_addition_kernel_8h_source.xhtml">NEGEMMMatrixAdditionKernel.h</a></li>
425 </ul>
426 </div><!-- contents -->
427 </div><!-- doc-content -->
428 <!-- start footer part -->
429 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
430   <ul>
431     <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_addition_kernel.xhtml">NEGEMMMatrixAdditionKernel</a></li>
432     <li class="footer">Generated on Thu Sep 28 2017 14:37:56 for Compute Library by
433     <a href="http://www.doxygen.org/index.html">
434     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
435   </ul>
436 </div>
437 </body>
438 </html>