documentation/classarm__compute_1_1_c_l_convolution_rectangle_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: CLConvolutionRectangleKernel 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_c_l_convolution_rectangle_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">CLConvolutionRectangleKernel Class Reference</div>  </div>
 121 </div><!--header-->
 122 <div class="contents">
 123
 124 <p><a class="el" href="classarm__compute_1_1_kernel.xhtml" title="Kernel class. ">Kernel</a> for the running convolution on a rectangle matrix.
 125  <a href="classarm__compute_1_1_c_l_convolution_rectangle_kernel.xhtml#details">More...</a></p>
 126
 127 <p><code>#include &lt;<a class="el" href="_c_l_convolution_kernel_8h_source.xhtml">CLConvolutionKernel.h</a>&gt;</code></p>
 128 <div class="dynheader">
 129 Collaboration diagram for CLConvolutionRectangleKernel:</div>
 130 <div class="dyncontent">
 131 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_c_l_convolution_rectangle_kernel__coll__graph.svg" width="215" 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:a2146854d485039a04e73bb6254ae788b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_convolution_rectangle_kernel.xhtml#a2146854d485039a04e73bb6254ae788b">CLConvolutionRectangleKernel</a> ()</td></tr>
 138 <tr class="memdesc:a2146854d485039a04e73bb6254ae788b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#a2146854d485039a04e73bb6254ae788b">More...</a><br /></td></tr>
 139 <tr class="separator:a2146854d485039a04e73bb6254ae788b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 140 <tr class="memitem:a4075f3040a87951071878e672bab27dd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_convolution_rectangle_kernel.xhtml#a4075f3040a87951071878e672bab27dd">CLConvolutionRectangleKernel</a> (const <a class="el" href="classarm__compute_1_1_c_l_convolution_rectangle_kernel.xhtml">CLConvolutionRectangleKernel</a> &amp;)=delete</td></tr>
 141 <tr class="memdesc:a4075f3040a87951071878e672bab27dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#a4075f3040a87951071878e672bab27dd">More...</a><br /></td></tr>
 142 <tr class="separator:a4075f3040a87951071878e672bab27dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
 143 <tr class="memitem:afce1f7a8135ce82d5e12342bb05f8448"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_c_l_convolution_rectangle_kernel.xhtml">CLConvolutionRectangleKernel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_convolution_rectangle_kernel.xhtml#afce1f7a8135ce82d5e12342bb05f8448">operator=</a> (const <a class="el" href="classarm__compute_1_1_c_l_convolution_rectangle_kernel.xhtml">CLConvolutionRectangleKernel</a> &amp;)=delete</td></tr>
 144 <tr class="memdesc:afce1f7a8135ce82d5e12342bb05f8448"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#afce1f7a8135ce82d5e12342bb05f8448">More...</a><br /></td></tr>
 145 <tr class="separator:afce1f7a8135ce82d5e12342bb05f8448"><td class="memSeparator" colspan="2">&#160;</td></tr>
 146 <tr class="memitem:a40c8a145562e3a8a4aa332a5ee17d4c9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_convolution_rectangle_kernel.xhtml#a40c8a145562e3a8a4aa332a5ee17d4c9">CLConvolutionRectangleKernel</a> (<a class="el" href="classarm__compute_1_1_c_l_convolution_rectangle_kernel.xhtml">CLConvolutionRectangleKernel</a> &amp;&amp;)=default</td></tr>
 147 <tr class="memdesc:a40c8a145562e3a8a4aa332a5ee17d4c9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#a40c8a145562e3a8a4aa332a5ee17d4c9">More...</a><br /></td></tr>
 148 <tr class="separator:a40c8a145562e3a8a4aa332a5ee17d4c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 149 <tr class="memitem:ac746b3604d6b86789f4c817e095f9147"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_c_l_convolution_rectangle_kernel.xhtml">CLConvolutionRectangleKernel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_convolution_rectangle_kernel.xhtml#ac746b3604d6b86789f4c817e095f9147">operator=</a> (<a class="el" href="classarm__compute_1_1_c_l_convolution_rectangle_kernel.xhtml">CLConvolutionRectangleKernel</a> &amp;&amp;)=default</td></tr>
 150 <tr class="memdesc:ac746b3604d6b86789f4c817e095f9147"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#ac746b3604d6b86789f4c817e095f9147">More...</a><br /></td></tr>
 151 <tr class="separator:ac746b3604d6b86789f4c817e095f9147"><td class="memSeparator" colspan="2">&#160;</td></tr>
 152 <tr class="memitem:abcf9df2e9d1da8abf27ca1678951673f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_convolution_rectangle_kernel.xhtml#abcf9df2e9d1da8abf27ca1678951673f">configure</a> (const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *input, <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *output, const int16_t *conv, uint32_t width, uint32_t height, uint32_t scale, bool border_undefined)</td></tr>
 153 <tr class="memdesc:abcf9df2e9d1da8abf27ca1678951673f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise the kernel's input, output and border mode.  <a href="#abcf9df2e9d1da8abf27ca1678951673f">More...</a><br /></td></tr>
 154 <tr class="separator:abcf9df2e9d1da8abf27ca1678951673f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 155 <tr class="memitem:a493987e85723a8000eb26d1f00e2ad0e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_convolution_rectangle_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">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>, cl::CommandQueue &amp;queue) override</td></tr>
 156 <tr class="memdesc:a493987e85723a8000eb26d1f00e2ad0e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue.  <a href="#a493987e85723a8000eb26d1f00e2ad0e">More...</a><br /></td></tr>
 157 <tr class="separator:a493987e85723a8000eb26d1f00e2ad0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 158 <tr class="memitem:a423f9a45a52983b4de5e2b347f4369c7"><td class="memItemLeft" align="right" valign="top"><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_c_l_convolution_rectangle_kernel.xhtml#a423f9a45a52983b4de5e2b347f4369c7">border_size</a> () const override</td></tr>
 159 <tr class="memdesc:a423f9a45a52983b4de5e2b347f4369c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">The size of the border for that kernel.  <a href="#a423f9a45a52983b4de5e2b347f4369c7">More...</a><br /></td></tr>
 160 <tr class="separator:a423f9a45a52983b4de5e2b347f4369c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 161 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_c_l_kernel"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_c_l_kernel')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml">ICLKernel</a></td></tr>
 162 <tr class="memitem:a6b10e96ce90bf901d17def86b874b019 inherit pub_methods_classarm__compute_1_1_i_c_l_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_l_kernel.xhtml#a6b10e96ce90bf901d17def86b874b019">ICLKernel</a> ()</td></tr>
 163 <tr class="memdesc:a6b10e96ce90bf901d17def86b874b019 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a6b10e96ce90bf901d17def86b874b019">More...</a><br /></td></tr>
 164 <tr class="separator:a6b10e96ce90bf901d17def86b874b019 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 165 <tr class="memitem:ae5121015ab09ece4d470f50c7ffe198e inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memItemLeft" align="right" valign="top">cl::Kernel &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml#ae5121015ab09ece4d470f50c7ffe198e">kernel</a> ()</td></tr>
 166 <tr class="memdesc:ae5121015ab09ece4d470f50c7ffe198e inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a reference to the OpenCL kernel of this object.  <a href="#ae5121015ab09ece4d470f50c7ffe198e">More...</a><br /></td></tr>
 167 <tr class="separator:ae5121015ab09ece4d470f50c7ffe198e inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 168 <tr class="memitem:a479e7043e65dc87de35d374e108510f7 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml#a479e7043e65dc87de35d374e108510f7">add_1D_tensor_argument</a> (unsigned int &amp;idx, const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *tensor, 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>)</td></tr>
 169 <tr class="memdesc:a479e7043e65dc87de35d374e108510f7 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add the passed 1D tensor's parameters to the object's kernel's arguments starting from the index idx.  <a href="#a479e7043e65dc87de35d374e108510f7">More...</a><br /></td></tr>
 170 <tr class="separator:a479e7043e65dc87de35d374e108510f7 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 171 <tr class="memitem:ac74dad3e61f79334f5e73f3c3ac603cb inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml#ac74dad3e61f79334f5e73f3c3ac603cb">add_2D_tensor_argument</a> (unsigned int &amp;idx, const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *tensor, 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>)</td></tr>
 172 <tr class="memdesc:ac74dad3e61f79334f5e73f3c3ac603cb inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add the passed 2D tensor's parameters to the object's kernel's arguments starting from the index idx.  <a href="#ac74dad3e61f79334f5e73f3c3ac603cb">More...</a><br /></td></tr>
 173 <tr class="separator:ac74dad3e61f79334f5e73f3c3ac603cb inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 174 <tr class="memitem:a28f5847162f352444c6ac1825d0e99c7 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml#a28f5847162f352444c6ac1825d0e99c7">add_3D_tensor_argument</a> (unsigned int &amp;idx, const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *tensor, 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>)</td></tr>
 175 <tr class="memdesc:a28f5847162f352444c6ac1825d0e99c7 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add the passed 3D tensor's parameters to the object's kernel's arguments starting from the index idx.  <a href="#a28f5847162f352444c6ac1825d0e99c7">More...</a><br /></td></tr>
 176 <tr class="separator:a28f5847162f352444c6ac1825d0e99c7 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 177 <tr class="memitem:a770f45838881fc061294e56d64f34386 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml#a770f45838881fc061294e56d64f34386">num_arguments_per_1D_tensor</a> () const </td></tr>
 178 <tr class="memdesc:a770f45838881fc061294e56d64f34386 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of arguments enqueued per 1D tensor object.  <a href="#a770f45838881fc061294e56d64f34386">More...</a><br /></td></tr>
 179 <tr class="separator:a770f45838881fc061294e56d64f34386 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 180 <tr class="memitem:ac734502531e7f95e25b3bf688a304a59 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml#ac734502531e7f95e25b3bf688a304a59">num_arguments_per_2D_tensor</a> () const </td></tr>
 181 <tr class="memdesc:ac734502531e7f95e25b3bf688a304a59 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of arguments enqueued per 2D tensor object.  <a href="#ac734502531e7f95e25b3bf688a304a59">More...</a><br /></td></tr>
 182 <tr class="separator:ac734502531e7f95e25b3bf688a304a59 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 183 <tr class="memitem:a4feaae9c860cddfa843d37c953674a22 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml#a4feaae9c860cddfa843d37c953674a22">num_arguments_per_3D_tensor</a> () const </td></tr>
 184 <tr class="memdesc:a4feaae9c860cddfa843d37c953674a22 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of arguments enqueued per 3D tensor object.  <a href="#a4feaae9c860cddfa843d37c953674a22">More...</a><br /></td></tr>
 185 <tr class="separator:a4feaae9c860cddfa843d37c953674a22 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 186 <tr class="memitem:a50f427a1d9419800972b9e03c4034311 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
 187 <tr class="memitem:a50f427a1d9419800972b9e03c4034311 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml#a50f427a1d9419800972b9e03c4034311">add_argument</a> (unsigned int &amp;idx, T value)</td></tr>
 188 <tr class="memdesc:a50f427a1d9419800972b9e03c4034311 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add the passed parameters to the object's kernel's arguments starting from the index idx.  <a href="#a50f427a1d9419800972b9e03c4034311">More...</a><br /></td></tr>
 189 <tr class="separator:a50f427a1d9419800972b9e03c4034311 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 190 <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>
 191 <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>
 192 <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>
 193 <tr class="separator:a7250cb8cbaa4104a93a2d77155085507 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 194 <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>
 195 <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>
 196 <tr class="separator:a341b60d15a5e12a5b8f3825194dd3b12 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 197 <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>
 198 <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>
 199 <tr class="separator:abfab8f0d4928e1081d9f65b77933e24a inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 200 <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>
 201 <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>
 202 <tr class="separator:a3f5646133956f06348b310ccc3d36353 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 203 </table>
 204 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 205 <div class="textblock"><p><a class="el" href="classarm__compute_1_1_kernel.xhtml" title="Kernel class. ">Kernel</a> for the running convolution on a rectangle matrix. </p>
 206 <dl class="section note"><dt>Note</dt><dd>Supports combinations of 3,5,7 and 9. </dd></dl>
 207
 208 <p>Definition at line <a class="el" href="_c_l_convolution_kernel_8h_source.xhtml#l00147">147</a> of file <a class="el" href="_c_l_convolution_kernel_8h_source.xhtml">CLConvolutionKernel.h</a>.</p>
 209 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 210 <a class="anchor" id="a2146854d485039a04e73bb6254ae788b"></a>
 211 <div class="memitem">
 212 <div class="memproto">
 213       <table class="memname">
 214         <tr>
 215           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_convolution_rectangle_kernel.xhtml">CLConvolutionRectangleKernel</a> </td>
 216           <td>(</td>
 217           <td class="paramname"></td><td>)</td>
 218           <td></td>
 219         </tr>
 220       </table>
 221 </div><div class="memdoc">
 222
 223 <p>Default constructor. </p>
 224
 225 </div>
 226 </div>
 227 <a class="anchor" id="a4075f3040a87951071878e672bab27dd"></a>
 228 <div class="memitem">
 229 <div class="memproto">
 230 <table class="mlabels">
 231   <tr>
 232   <td class="mlabels-left">
 233       <table class="memname">
 234         <tr>
 235           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_convolution_rectangle_kernel.xhtml">CLConvolutionRectangleKernel</a> </td>
 236           <td>(</td>
 237           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_c_l_convolution_rectangle_kernel.xhtml">CLConvolutionRectangleKernel</a> &amp;&#160;</td>
 238           <td class="paramname"></td><td>)</td>
 239           <td></td>
 240         </tr>
 241       </table>
 242   </td>
 243   <td class="mlabels-right">
 244 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
 245   </tr>
 246 </table>
 247 </div><div class="memdoc">
 248
 249 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
 250
 251 </div>
 252 </div>
 253 <a class="anchor" id="a40c8a145562e3a8a4aa332a5ee17d4c9"></a>
 254 <div class="memitem">
 255 <div class="memproto">
 256 <table class="mlabels">
 257   <tr>
 258   <td class="mlabels-left">
 259       <table class="memname">
 260         <tr>
 261           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_convolution_rectangle_kernel.xhtml">CLConvolutionRectangleKernel</a> </td>
 262           <td>(</td>
 263           <td class="paramtype"><a class="el" href="classarm__compute_1_1_c_l_convolution_rectangle_kernel.xhtml">CLConvolutionRectangleKernel</a> &amp;&amp;&#160;</td>
 264           <td class="paramname"></td><td>)</td>
 265           <td></td>
 266         </tr>
 267       </table>
 268   </td>
 269   <td class="mlabels-right">
 270 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 271   </tr>
 272 </table>
 273 </div><div class="memdoc">
 274
 275 <p>Allow instances of this class to be moved. </p>
 276
 277 </div>
 278 </div>
 279 <h2 class="groupheader">Member Function Documentation</h2>
 280 <a class="anchor" id="a423f9a45a52983b4de5e2b347f4369c7"></a>
 281 <div class="memitem">
 282 <div class="memproto">
 283 <table class="mlabels">
 284   <tr>
 285   <td class="mlabels-left">
 286       <table class="memname">
 287         <tr>
 288           <td class="memname"><a class="el" href="structarm__compute_1_1_border_size.xhtml">BorderSize</a> border_size </td>
 289           <td>(</td>
 290           <td class="paramname"></td><td>)</td>
 291           <td> const</td>
 292         </tr>
 293       </table>
 294   </td>
 295   <td class="mlabels-right">
 296 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 297   </tr>
 298 </table>
 299 </div><div class="memdoc">
 300
 301 <p>The size of the border for that kernel. </p>
 302 <dl class="section return"><dt>Returns</dt><dd>The width in number of elements of the border. </dd></dl>
 303
 304 <p>Reimplemented from <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#aa6daa9b04e2035bf007e5e5c3c4396a8">IKernel</a>.</p>
 305
 306 </div>
 307 </div>
 308 <a class="anchor" id="abcf9df2e9d1da8abf27ca1678951673f"></a>
 309 <div class="memitem">
 310 <div class="memproto">
 311       <table class="memname">
 312         <tr>
 313           <td class="memname">void configure </td>
 314           <td>(</td>
 315           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *&#160;</td>
 316           <td class="paramname"><em>input</em>, </td>
 317         </tr>
 318         <tr>
 319           <td class="paramkey"></td>
 320           <td></td>
 321           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *&#160;</td>
 322           <td class="paramname"><em>output</em>, </td>
 323         </tr>
 324         <tr>
 325           <td class="paramkey"></td>
 326           <td></td>
 327           <td class="paramtype">const int16_t *&#160;</td>
 328           <td class="paramname"><em>conv</em>, </td>
 329         </tr>
 330         <tr>
 331           <td class="paramkey"></td>
 332           <td></td>
 333           <td class="paramtype">uint32_t&#160;</td>
 334           <td class="paramname"><em>width</em>, </td>
 335         </tr>
 336         <tr>
 337           <td class="paramkey"></td>
 338           <td></td>
 339           <td class="paramtype">uint32_t&#160;</td>
 340           <td class="paramname"><em>height</em>, </td>
 341         </tr>
 342         <tr>
 343           <td class="paramkey"></td>
 344           <td></td>
 345           <td class="paramtype">uint32_t&#160;</td>
 346           <td class="paramname"><em>scale</em>, </td>
 347         </tr>
 348         <tr>
 349           <td class="paramkey"></td>
 350           <td></td>
 351           <td class="paramtype">bool&#160;</td>
 352           <td class="paramname"><em>border_undefined</em>&#160;</td>
 353         </tr>
 354         <tr>
 355           <td></td>
 356           <td>)</td>
 357           <td></td><td></td>
 358         </tr>
 359       </table>
 360 </div><div class="memdoc">
 361
 362 <p>Initialise the kernel's input, output and border mode. </p>
 363 <dl class="params"><dt>Parameters</dt><dd>
 364   <table class="params">
 365     <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>Source tensor. Data types supported: U8. </td></tr>
 366     <tr><td class="paramdir">[out]</td><td class="paramname">output</td><td>Destination tensor, Data types supported: U8, S16. </td></tr>
 367     <tr><td class="paramdir">[in]</td><td class="paramname">conv</td><td>Convolution matrix to apply to the input tensor. </td></tr>
 368     <tr><td class="paramdir">[in]</td><td class="paramname">width</td><td>Width of convolution matrix (Number of columns) </td></tr>
 369     <tr><td class="paramdir">[in]</td><td class="paramname">height</td><td>Height of convolution matrix (Number of rows) </td></tr>
 370     <tr><td class="paramdir">[in]</td><td class="paramname">scale</td><td>Scale of the convolution matrix. If 0 is passed, it will be set to the sum of the coefficients of the convolution or 1 if they add up to 0. </td></tr>
 371     <tr><td class="paramdir">[in]</td><td class="paramname">border_undefined</td><td>True if the border mode is undefined. False if it's replicate or constant. </td></tr>
 372   </table>
 373   </dd>
 374 </dl>
 375
 376 </div>
 377 </div>
 378 <a class="anchor" id="afce1f7a8135ce82d5e12342bb05f8448"></a>
 379 <div class="memitem">
 380 <div class="memproto">
 381 <table class="mlabels">
 382   <tr>
 383   <td class="mlabels-left">
 384       <table class="memname">
 385         <tr>
 386           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_convolution_rectangle_kernel.xhtml">CLConvolutionRectangleKernel</a>&amp; operator= </td>
 387           <td>(</td>
 388           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_c_l_convolution_rectangle_kernel.xhtml">CLConvolutionRectangleKernel</a> &amp;&#160;</td>
 389           <td class="paramname"></td><td>)</td>
 390           <td></td>
 391         </tr>
 392       </table>
 393   </td>
 394   <td class="mlabels-right">
 395 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
 396   </tr>
 397 </table>
 398 </div><div class="memdoc">
 399
 400 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
 401
 402 </div>
 403 </div>
 404 <a class="anchor" id="ac746b3604d6b86789f4c817e095f9147"></a>
 405 <div class="memitem">
 406 <div class="memproto">
 407 <table class="mlabels">
 408   <tr>
 409   <td class="mlabels-left">
 410       <table class="memname">
 411         <tr>
 412           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_convolution_rectangle_kernel.xhtml">CLConvolutionRectangleKernel</a>&amp; operator= </td>
 413           <td>(</td>
 414           <td class="paramtype"><a class="el" href="classarm__compute_1_1_c_l_convolution_rectangle_kernel.xhtml">CLConvolutionRectangleKernel</a> &amp;&amp;&#160;</td>
 415           <td class="paramname"></td><td>)</td>
 416           <td></td>
 417         </tr>
 418       </table>
 419   </td>
 420   <td class="mlabels-right">
 421 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 422   </tr>
 423 </table>
 424 </div><div class="memdoc">
 425
 426 <p>Allow instances of this class to be moved. </p>
 427
 428 </div>
 429 </div>
 430 <a class="anchor" id="a493987e85723a8000eb26d1f00e2ad0e"></a>
 431 <div class="memitem">
 432 <div class="memproto">
 433 <table class="mlabels">
 434   <tr>
 435   <td class="mlabels-left">
 436       <table class="memname">
 437         <tr>
 438           <td class="memname">void run </td>
 439           <td>(</td>
 440           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;&#160;</td>
 441           <td class="paramname"><em>window</em>, </td>
 442         </tr>
 443         <tr>
 444           <td class="paramkey"></td>
 445           <td></td>
 446           <td class="paramtype">cl::CommandQueue &amp;&#160;</td>
 447           <td class="paramname"><em>queue</em>&#160;</td>
 448         </tr>
 449         <tr>
 450           <td></td>
 451           <td>)</td>
 452           <td></td><td></td>
 453         </tr>
 454       </table>
 455   </td>
 456   <td class="mlabels-right">
 457 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 458   </tr>
 459 </table>
 460 </div><div class="memdoc">
 461
 462 <p>Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue. </p>
 463 <dl class="section note"><dt>Note</dt><dd>The queue is <em>not</em> flushed by this method, and therefore the kernel will not have been executed by the time this method returns.</dd></dl>
 464 <dl class="params"><dt>Parameters</dt><dd>
 465   <table class="params">
 466     <tr><td class="paramdir">[in]</td><td class="paramname">window</td><td>Region on which to execute the kernel. (Must be a valid 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>
 467     <tr><td class="paramdir">[in,out]</td><td class="paramname">queue</td><td>Command queue on which to enqueue the kernel. </td></tr>
 468   </table>
 469   </dd>
 470 </dl>
 471
 472 <p>Implements <a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml#af6a174d47571f51f199ffc27ecc10f51">ICLKernel</a>.</p>
 473
 474 </div>
 475 </div>
 476 <hr/>The documentation for this class was generated from the following file:<ul>
 477 <li>arm_compute/core/CL/kernels/<a class="el" href="_c_l_convolution_kernel_8h_source.xhtml">CLConvolutionKernel.h</a></li>
 478 </ul>
 479 </div><!-- contents -->
 480 </div><!-- doc-content -->
 481 <!-- start footer part -->
 482 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 483   <ul>
 484     <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_l_convolution_rectangle_kernel.xhtml">CLConvolutionRectangleKernel</a></li>
 485     <li class="footer">Generated on Wed Apr 12 2017 14:26:05 for ARM Compute Library by
 486     <a href="http://www.doxygen.org/index.html">
 487     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
 488   </ul>
 489 </div>
 490 </body>
 491 </html>