arm_compute v18.05
[platform/upstream/armcl.git] / documentation / classarm__compute_1_1_c_p_p_detection_window_non_maxima_suppression_kernel.xhtml
index 718a7eb..7c894ce 100644 (file)
@@ -40,7 +40,7 @@
  <tr style="height: 56px;">
   <td style="padding-left: 0.5em;">
    <div id="projectname">Compute Library
-   &#160;<span id="projectnumber">v17.06</span>
+   &#160;<span id="projectnumber">18.05</span>
    </div>
   </td>
  </tr>
@@ -129,12 +129,15 @@ $(document).ready(function(){initNavTree('classarm__compute_1_1_c_p_p_detection_
 <div class="dynheader">
 Collaboration diagram for CPPDetectionWindowNonMaximaSuppressionKernel:</div>
 <div class="dyncontent">
-<div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_c_p_p_detection_window_non_maxima_suppression_kernel__coll__graph.svg" width="234" height="202"><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_c_p_p_detection_window_non_maxima_suppression_kernel__coll__graph.svg" width="243" height="202"><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_c_p_p_detection_window_non_maxima_suppression_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:a8058341d64fa8dd14cac28d6ceea657c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_p_p_detection_window_non_maxima_suppression_kernel.xhtml#a8058341d64fa8dd14cac28d6ceea657c">CPPDetectionWindowNonMaximaSuppressionKernel</a> ()</td></tr>
 <tr class="memdesc:a8058341d64fa8dd14cac28d6ceea657c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#a8058341d64fa8dd14cac28d6ceea657c">More...</a><br /></td></tr>
 <tr class="separator:a8058341d64fa8dd14cac28d6ceea657c"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -153,9 +156,9 @@ Public Member Functions</h2></td></tr>
 <tr class="memitem:ad56ff9909955d92abeabbe43c1a21bd9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_p_p_detection_window_non_maxima_suppression_kernel.xhtml#ad56ff9909955d92abeabbe43c1a21bd9">configure</a> (<a class="el" href="namespacearm__compute.xhtml#a52b3b9de6092ae37321159c4c2f1bf40">IDetectionWindowArray</a> *input_output, float min_distance)</td></tr>
 <tr class="memdesc:ad56ff9909955d92abeabbe43c1a21bd9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise the kernel's input, output and the euclidean minimum distance.  <a href="#ad56ff9909955d92abeabbe43c1a21bd9">More...</a><br /></td></tr>
 <tr class="separator:ad56ff9909955d92abeabbe43c1a21bd9"><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_c_p_p_detection_window_non_maxima_suppression_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:a112b35dd205c62ea6ed1447ef226da82"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_p_p_detection_window_non_maxima_suppression_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="memitem:a4370ae5fda7bd455a171fc8ed4d3f283"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_p_p_detection_window_non_maxima_suppression_kernel.xhtml#a4370ae5fda7bd455a171fc8ed4d3f283">is_parallelisable</a> () const override</td></tr>
 <tr class="memdesc:a4370ae5fda7bd455a171fc8ed4d3f283"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates whether or not the kernel is parallelisable.  <a href="#a4370ae5fda7bd455a171fc8ed4d3f283">More...</a><br /></td></tr>
 <tr class="separator:a4370ae5fda7bd455a171fc8ed4d3f283"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -198,6 +201,8 @@ Public Member Functions</h2></td></tr>
 
 <p>Default constructor. </p>
 
+<p>Referenced by <a class="el" href="_c_p_p_detection_window_non_maxima_suppression_kernel_8h_source.xhtml#l00042">CPPDetectionWindowNonMaximaSuppressionKernel::name()</a>.</p>
+
 </div>
 </div>
 <a class="anchor" id="a88722c520f6e69c0155b0dea15f6c3a4"></a>
@@ -278,7 +283,7 @@ Public Member Functions</h2></td></tr>
 </div><div class="memdoc">
 
 <p>Initialise the kernel's input, output and the euclidean minimum distance. </p>
-<dl class="section attention"><dt>Attention</dt><dd>: If <a class="el" href="namespacearm__compute.xhtml#ab8d2c7efb7643ce8f9e5446dbe1da0b4">CLDetectionWindowArray</a> is passed to the kernel, the map() and unmap() methods <a class="el" href="namespacearm__compute.xhtml#ab8d2c7efb7643ce8f9e5446dbe1da0b4">CLDetectionWindowArray</a> must be called respectively before and after the <a class="el" href="classarm__compute_1_1_c_p_p_detection_window_non_maxima_suppression_kernel.xhtml#a8fd12b95bdde3f93db96bc9b1598db69" title="Execute the kernel on the passed window. ">run()</a> method of <a class="el" href="classarm__compute_1_1_c_p_p_detection_window_non_maxima_suppression_kernel.xhtml">CPPDetectionWindowNonMaximaSuppressionKernel</a></dd></dl>
+<dl class="section attention"><dt>Attention</dt><dd>: If <a class="el" href="namespacearm__compute.xhtml#a52b3b9de6092ae37321159c4c2f1bf40">IDetectionWindowArray</a> is passed to the kernel, the <a class="el" href="namespacearm__compute_1_1utils.xhtml#a9c3303817ba653b5d1e78efb88d02bcf" title="Maps a tensor if needed. ">map()</a> and <a class="el" href="namespacearm__compute_1_1utils.xhtml#a4ff2134cb88cb5a27120cddb98b59774" title="Unmaps a tensor if needed. ">unmap()</a> methods <a class="el" href="namespacearm__compute.xhtml#a52b3b9de6092ae37321159c4c2f1bf40">IDetectionWindowArray</a> must be called respectively before and after the <a class="el" href="classarm__compute_1_1_c_p_p_detection_window_non_maxima_suppression_kernel.xhtml#a112b35dd205c62ea6ed1447ef226da82" title="Execute the kernel on the passed window. ">run()</a> method of <a class="el" href="classarm__compute_1_1_c_p_p_detection_window_non_maxima_suppression_kernel.xhtml">CPPDetectionWindowNonMaximaSuppressionKernel</a></dd></dl>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramdir">[in,out]</td><td class="paramname">input_output</td><td>Input/Output array of <a class="el" href="struct_detection_window.xhtml">DetectionWindow</a> </td></tr>
@@ -287,6 +292,8 @@ Public Member Functions</h2></td></tr>
   </dd>
 </dl>
 
+<p>Referenced by <a class="el" href="_c_p_p_detection_window_non_maxima_suppression_kernel_8h_source.xhtml#l00042">CPPDetectionWindowNonMaximaSuppressionKernel::name()</a>.</p>
+
 </div>
 </div>
 <a class="anchor" id="a4370ae5fda7bd455a171fc8ed4d3f283"></a>
@@ -312,11 +319,45 @@ Public Member Functions</h2></td></tr>
 
 <p>Indicates whether or not the kernel is parallelisable. </p>
 <p>If the kernel is parallelisable then 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> can be split into sub-windows which can then be run in parallel.</p>
-<p>If the kernel is not parallelisable then only 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> can be passed to <a class="el" href="classarm__compute_1_1_c_p_p_detection_window_non_maxima_suppression_kernel.xhtml#a8fd12b95bdde3f93db96bc9b1598db69" title="Execute the kernel on the passed window. ">run()</a></p>
+<p>If the kernel is not parallelisable then only 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> can be passed to <a class="el" href="classarm__compute_1_1_c_p_p_detection_window_non_maxima_suppression_kernel.xhtml#a112b35dd205c62ea6ed1447ef226da82" title="Execute the kernel on the passed window. ">run()</a></p>
 <dl class="section return"><dt>Returns</dt><dd>True if the kernel is parallelisable </dd></dl>
 
 <p>Reimplemented from <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#abfab8f0d4928e1081d9f65b77933e24a">IKernel</a>.</p>
 
+<p>Referenced by <a class="el" href="_c_p_p_detection_window_non_maxima_suppression_kernel_8h_source.xhtml#l00042">CPPDetectionWindowNonMaximaSuppressionKernel::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="_c_p_p_detection_window_non_maxima_suppression_kernel_8h_source.xhtml#l00042">42</a> of file <a class="el" href="_c_p_p_detection_window_non_maxima_suppression_kernel_8h_source.xhtml">CPPDetectionWindowNonMaximaSuppressionKernel.h</a>.</p>
+
+<p>References <a class="el" href="classarm__compute_1_1_c_p_p_detection_window_non_maxima_suppression_kernel.xhtml#ad56ff9909955d92abeabbe43c1a21bd9">CPPDetectionWindowNonMaximaSuppressionKernel::configure()</a>, <a class="el" href="classarm__compute_1_1_c_p_p_detection_window_non_maxima_suppression_kernel.xhtml#a8058341d64fa8dd14cac28d6ceea657c">CPPDetectionWindowNonMaximaSuppressionKernel::CPPDetectionWindowNonMaximaSuppressionKernel()</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_c_p_p_detection_window_non_maxima_suppression_kernel.xhtml#a4370ae5fda7bd455a171fc8ed4d3f283">CPPDetectionWindowNonMaximaSuppressionKernel::is_parallelisable()</a>, <a class="el" href="classarm__compute_1_1_c_p_p_detection_window_non_maxima_suppression_kernel.xhtml#aa5182561cc171d1c74872e91fdb2d7fb">CPPDetectionWindowNonMaximaSuppressionKernel::operator=()</a>, <a class="el" href="classarm__compute_1_1_c_p_p_detection_window_non_maxima_suppression_kernel.xhtml#a112b35dd205c62ea6ed1447ef226da82">CPPDetectionWindowNonMaximaSuppressionKernel::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="l00043"></a><span class="lineno">   43</span>&#160;    {</div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;        <span class="keywordflow">return</span> <span class="stringliteral">&quot;CPPDetectionWindowNonMaximaSuppressionKernel&quot;</span>;</div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;    }</div></div><!-- fragment -->
 </div>
 </div>
 <a class="anchor" id="aa5182561cc171d1c74872e91fdb2d7fb"></a>
@@ -343,6 +384,8 @@ Public Member Functions</h2></td></tr>
 
 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
 
+<p>Referenced by <a class="el" href="_c_p_p_detection_window_non_maxima_suppression_kernel_8h_source.xhtml#l00042">CPPDetectionWindowNonMaximaSuppressionKernel::name()</a>.</p>
+
 </div>
 </div>
 <a class="anchor" id="abc2f7094d5e8e45b4775d302fb43dae2"></a>
@@ -371,7 +414,7 @@ Public Member Functions</h2></td></tr>
 
 </div>
 </div>
-<a class="anchor" id="a8fd12b95bdde3f93db96bc9b1598db69"></a>
+<a class="anchor" id="a112b35dd205c62ea6ed1447ef226da82"></a>
 <div class="memitem">
 <div class="memproto">
 <table class="mlabels">
@@ -382,8 +425,18 @@ Public Member Functions</h2></td></tr>
           <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>
@@ -401,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="_c_p_p_detection_window_non_maxima_suppression_kernel_8h_source.xhtml#l00042">CPPDetectionWindowNonMaximaSuppressionKernel::name()</a>.</p>
 
 </div>
 </div>
@@ -418,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_c_p_p_detection_window_non_maxima_suppression_kernel.xhtml">CPPDetectionWindowNonMaximaSuppressionKernel</a></li>
-    <li class="footer">Generated on Fri Jun 23 2017 15:44:35 for Compute Library by
+    <li class="footer">Generated on Wed May 23 2018 11:36:41 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>