projects / platform / upstream / armcl.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
arm_compute v18.05
[platform/upstream/armcl.git] / documentation / classarm__compute_1_1_n_e_g_e_m_m_matrix_addition_kernel.xhtml
diff --git a/documentation/classarm__compute_1_1_n_e_g_e_m_m_matrix_addition_kernel.xhtml b/documentation/classarm__compute_1_1_n_e_g_e_m_m_matrix_addition_kernel.xhtml
index 7e0d82a..5a5e408 100644 (file)
--- a/documentation/classarm__compute_1_1_n_e_g_e_m_m_matrix_addition_kernel.xhtml
+++ b/documentation/classarm__compute_1_1_n_e_g_e_m_m_matrix_addition_kernel.xhtml
@@ -6,7 +6,7 @@
 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
 <meta name="generator" content="Doxygen 1.8.11"/>
 <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
-<title>ARM Compute Library: NEGEMMMatrixAdditionKernel Class Reference</title>
+<title>Compute Library: NEGEMMMatrixAdditionKernel Class Reference</title>
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="jquery.js"></script>
 <script type="text/javascript" src="dynsections.js"></script>
@@ -39,8 +39,8 @@
  <tbody>
  <tr style="height: 56px;">
   <td style="padding-left: 0.5em;">
-   <div id="projectname">ARM Compute Library
-   &#160;<span id="projectnumber">17.04</span>
+   <div id="projectname">Compute Library
+   &#160;<span id="projectnumber">18.05</span>
    </div>
   </td>
  </tr>
@@ -55,6 +55,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
   <div id="navrow1" class="tabs">
     <ul class="tablist">
       <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
+      <li><a href="pages.xhtml"><span>Related&#160;Pages</span></a></li>
       <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
       <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
       <li><a href="files.xhtml"><span>Files</span></a></li>
@@ -128,12 +129,15 @@ $(document).ready(function(){initNavTree('classarm__compute_1_1_n_e_g_e_m_m_matr
 <div class="dynheader">
 Collaboration diagram for NEGEMMMatrixAdditionKernel:</div>
 <div class="dyncontent">
-<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>
+<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="222" height="262"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
 </div>
 <center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
 <table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 Public Member Functions</h2></td></tr>
+<tr class="memitem:ab5656bb5b6334bdbe6e606c715872828"><td class="memItemLeft" align="right" valign="top">const char *&#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#ab5656bb5b6334bdbe6e606c715872828">name</a> () const override</td></tr>
+<tr class="memdesc:ab5656bb5b6334bdbe6e606c715872828"><td class="mdescLeft">&#160;</td><td class="mdescRight">Name of the kernel.  <a href="#ab5656bb5b6334bdbe6e606c715872828">More...</a><br /></td></tr>
+<tr class="separator:ab5656bb5b6334bdbe6e606c715872828"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <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>
 <tr class="memdesc:ab2165f92396a03786cf5e499c4d0e62c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#ab2165f92396a03786cf5e499c4d0e62c">More...</a><br /></td></tr>
 <tr class="separator:ab2165f92396a03786cf5e499c4d0e62c"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -149,12 +153,12 @@ Public Member Functions</h2></td></tr>
 <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>
 <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>
 <tr class="separator:adc1be2dee3a4aeeb959cf2ec7aec7657"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a8163692a08f9f6f0c29844a00b1ae934"><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#a8163692a08f9f6f0c29844a00b1ae934">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, const float beta)</td></tr>
-<tr class="memdesc:a8163692a08f9f6f0c29844a00b1ae934"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise the kernel's input and output.  <a href="#a8163692a08f9f6f0c29844a00b1ae934">More...</a><br /></td></tr>
-<tr class="separator:a8163692a08f9f6f0c29844a00b1ae934"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<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_addition_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>
-<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>
-<tr class="separator:a8fd12b95bdde3f93db96bc9b1598db69"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<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>
+<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>
+<tr class="separator:abd3df2f9251266926538e4c020652996"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<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>
+<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>
+<tr class="separator:a112b35dd205c62ea6ed1447ef226da82"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <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>
 <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>
 <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>
@@ -222,6 +226,8 @@ This stage is used to finalize the GEMM result and it is computed if and only if
 
 <p>Constructor. </p>
 
+<p>Referenced by <a class="el" href="_n_e_g_e_m_m_matrix_addition_kernel_8h_source.xhtml#l00044">NEGEMMMatrixAdditionKernel::name()</a>.</p>
+
 </div>
 </div>
 <a class="anchor" id="a0b3c2d43b065aefa8c68e0bc7488794e"></a>
@@ -277,7 +283,7 @@ This stage is used to finalize the GEMM result and it is computed if and only if
 </div>
 </div>
 <h2 class="groupheader">Member Function Documentation</h2>
-<a class="anchor" id="a8163692a08f9f6f0c29844a00b1ae934"></a>
+<a class="anchor" id="abd3df2f9251266926538e4c020652996"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
@@ -296,7 +302,7 @@ This stage is used to finalize the GEMM result and it is computed if and only if
         <tr>
           <td class="paramkey"></td>
           <td></td>
-          <td class="paramtype">const float&#160;</td>
+          <td class="paramtype">float&#160;</td>
           <td class="paramname"><em>beta</em>&#160;</td>
         </tr>
         <tr>
@@ -311,13 +317,47 @@ This stage is used to finalize the GEMM result and it is computed if and only if
 <dl class="section note"><dt>Note</dt><dd>The input and output tensor must have the same dimensions</dd></dl>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>Input tensor (Matrix C). Data types supported: F32, F16. </td></tr>
+    <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>
     <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>
     <tr><td class="paramdir">[in]</td><td class="paramname">beta</td><td>Weight of matrix C </td></tr>
   </table>
   </dd>
 </dl>
 
+<p>Referenced by <a class="el" href="_n_e_g_e_m_m_matrix_addition_kernel_8h_source.xhtml#l00044">NEGEMMMatrixAdditionKernel::name()</a>.</p>
+
+</div>
+</div>
+<a class="anchor" id="ab5656bb5b6334bdbe6e606c715872828"></a>
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">const char* name </td>
+          <td>(</td>
+          <td class="paramname"></td><td>)</td>
+          <td> const</td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+
+<p>Name of the kernel. </p>
+<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classarm__compute_1_1_kernel.xhtml" title="Kernel class. ">Kernel</a> name </dd></dl>
+
+<p>Implements <a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml#a1a30ad8f276a2310571c36239554831a">ICPPKernel</a>.</p>
+
+<p>Definition at line <a class="el" href="_n_e_g_e_m_m_matrix_addition_kernel_8h_source.xhtml#l00044">44</a> of file <a class="el" href="_n_e_g_e_m_m_matrix_addition_kernel_8h_source.xhtml">NEGEMMMatrixAdditionKernel.h</a>.</p>
+
+<p>References <a class="el" href="validation_2_c_l_2_g_e_m_m_8cpp_source.xhtml#l00115">arm_compute::test::validation::beta</a>, <a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_matrix_addition_kernel.xhtml#abd3df2f9251266926538e4c020652996">NEGEMMMatrixAdditionKernel::configure()</a>, <a class="el" href="namespacearm__compute_1_1test_1_1validation.xhtml#a096668313a9a819d54a2e65ec21ff0cc">arm_compute::test::validation::info()</a>, <a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_matrix_addition_kernel.xhtml#ab2165f92396a03786cf5e499c4d0e62c">NEGEMMMatrixAdditionKernel::NEGEMMMatrixAdditionKernel()</a>, <a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_matrix_addition_kernel.xhtml#a7bf4194c21adc060991ddb88ed4c8b60">NEGEMMMatrixAdditionKernel::operator=()</a>, <a class="el" href="classarm__compute_1_1_n_e_g_e_m_m_matrix_addition_kernel.xhtml#a112b35dd205c62ea6ed1447ef226da82">NEGEMMMatrixAdditionKernel::run()</a>, and <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353">IKernel::window()</a>.</p>
+<div class="fragment"><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;    {</div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;        <span class="keywordflow">return</span> <span class="stringliteral">&quot;NEGEMMMatrixAdditionKernel&quot;</span>;</div><div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;    }</div></div><!-- fragment -->
 </div>
 </div>
 <a class="anchor" id="a7bf4194c21adc060991ddb88ed4c8b60"></a>
@@ -344,6 +384,8 @@ This stage is used to finalize the GEMM result and it is computed if and only if
 
 <p>Prevent instances of this class from being copied. </p>
 
+<p>Referenced by <a class="el" href="_n_e_g_e_m_m_matrix_addition_kernel_8h_source.xhtml#l00044">NEGEMMMatrixAdditionKernel::name()</a>.</p>
+
 </div>
 </div>
 <a class="anchor" id="adc1be2dee3a4aeeb959cf2ec7aec7657"></a>
@@ -372,7 +414,7 @@ This stage is used to finalize the GEMM result and it is computed if and only if
 
 </div>
 </div>
-<a class="anchor" id="a8fd12b95bdde3f93db96bc9b1598db69"></a>
+<a class="anchor" id="a112b35dd205c62ea6ed1447ef226da82"></a>
 <div class="memitem">
 <div class="memproto">
 <table class="mlabels">
@@ -383,8 +425,18 @@ This stage is used to finalize the GEMM result and it is computed if and only if
           <td class="memname">void run </td>
           <td>(</td>
           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;&#160;</td>
-          <td class="paramname"><em>window</em></td><td>)</td>
+          <td class="paramname"><em>window</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">const <a class="el" href="structarm__compute_1_1_thread_info.xhtml">ThreadInfo</a> &amp;&#160;</td>
+          <td class="paramname"><em>info</em>&#160;</td>
+        </tr>
+        <tr>
           <td></td>
+          <td>)</td>
+          <td></td><td></td>
         </tr>
       </table>
   </td>
@@ -402,11 +454,14 @@ The width of the window has to be a multiple of num_elems_processed_per_iteratio
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <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>
+    <tr><td class="paramdir">[in]</td><td class="paramname">info</td><td>Info about executing thread and CPU. </td></tr>
   </table>
   </dd>
 </dl>
 
-<p>Implements <a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml#a6f56c8bb44166634652b877d6eb7a9a2">ICPPKernel</a>.</p>
+<p>Implements <a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml#af814ff5e96f40f1cccf809b2b4ee19ef">ICPPKernel</a>.</p>
+
+<p>Referenced by <a class="el" href="_n_e_g_e_m_m_matrix_addition_kernel_8h_source.xhtml#l00044">NEGEMMMatrixAdditionKernel::name()</a>.</p>
 
 </div>
 </div>
@@ -419,7 +474,7 @@ The width of the window has to be a multiple of num_elems_processed_per_iteratio
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <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>
-    <li class="footer">Generated on Wed Apr 12 2017 14:26:06 for ARM Compute Library by
+    <li class="footer">Generated on Wed May 23 2018 11:36:42 for Compute Library by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
   </ul>
Domain: Machine Learning / ML Framework;