documentation/classarm__compute_1_1_c_l_scharr3x3_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: CLScharr3x3Kernel 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.03.1</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_scharr3x3_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">CLScharr3x3Kernel Class Reference</div>  </div>
 121 </div><!--header-->
 122 <div class="contents">
 123
 124 <p>Interface for the kernel to run a 3x3 Scharr filter on a tensor.
 125  <a href="classarm__compute_1_1_c_l_scharr3x3_kernel.xhtml#details">More...</a></p>
 126
 127 <p><code>#include &lt;<a class="el" href="_c_l_scharr3x3_kernel_8h_source.xhtml">CLScharr3x3Kernel.h</a>&gt;</code></p>
 128 <div class="dynheader">
 129 Collaboration diagram for CLScharr3x3Kernel:</div>
 130 <div class="dyncontent">
 131 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_c_l_scharr3x3_kernel__coll__graph.svg" width="146" 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:aca3036ac865b6a36d00babf0c0e37f5b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_scharr3x3_kernel.xhtml#aca3036ac865b6a36d00babf0c0e37f5b">CLScharr3x3Kernel</a> ()</td></tr>
 138 <tr class="memdesc:aca3036ac865b6a36d00babf0c0e37f5b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor: initialize all the pointers to nullptr and parameters to zero.  <a href="#aca3036ac865b6a36d00babf0c0e37f5b">More...</a><br /></td></tr>
 139 <tr class="separator:aca3036ac865b6a36d00babf0c0e37f5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 140 <tr class="memitem:aa07a61f15f6269f45e19489a95c9224d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_scharr3x3_kernel.xhtml#aa07a61f15f6269f45e19489a95c9224d">CLScharr3x3Kernel</a> (const <a class="el" href="classarm__compute_1_1_c_l_scharr3x3_kernel.xhtml">CLScharr3x3Kernel</a> &amp;)=delete</td></tr>
 141 <tr class="memdesc:aa07a61f15f6269f45e19489a95c9224d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers).  <a href="#aa07a61f15f6269f45e19489a95c9224d">More...</a><br /></td></tr>
 142 <tr class="separator:aa07a61f15f6269f45e19489a95c9224d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 143 <tr class="memitem:af2d37653c2c381ce8c52df533490f2c5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_c_l_scharr3x3_kernel.xhtml">CLScharr3x3Kernel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_scharr3x3_kernel.xhtml#af2d37653c2c381ce8c52df533490f2c5">operator=</a> (const <a class="el" href="classarm__compute_1_1_c_l_scharr3x3_kernel.xhtml">CLScharr3x3Kernel</a> &amp;)=delete</td></tr>
 144 <tr class="memdesc:af2d37653c2c381ce8c52df533490f2c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers).  <a href="#af2d37653c2c381ce8c52df533490f2c5">More...</a><br /></td></tr>
 145 <tr class="separator:af2d37653c2c381ce8c52df533490f2c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 146 <tr class="memitem:abce0bd975f2f2ea4b70aedd72685edc1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_scharr3x3_kernel.xhtml#abce0bd975f2f2ea4b70aedd72685edc1">CLScharr3x3Kernel</a> (<a class="el" href="classarm__compute_1_1_c_l_scharr3x3_kernel.xhtml">CLScharr3x3Kernel</a> &amp;&amp;)=default</td></tr>
 147 <tr class="memdesc:abce0bd975f2f2ea4b70aedd72685edc1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#abce0bd975f2f2ea4b70aedd72685edc1">More...</a><br /></td></tr>
 148 <tr class="separator:abce0bd975f2f2ea4b70aedd72685edc1"><td class="memSeparator" colspan="2">&#160;</td></tr>
 149 <tr class="memitem:a2f87eef8bcf07faa1c31afe31c26e2cd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_c_l_scharr3x3_kernel.xhtml">CLScharr3x3Kernel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_scharr3x3_kernel.xhtml#a2f87eef8bcf07faa1c31afe31c26e2cd">operator=</a> (<a class="el" href="classarm__compute_1_1_c_l_scharr3x3_kernel.xhtml">CLScharr3x3Kernel</a> &amp;&amp;)=default</td></tr>
 150 <tr class="memdesc:a2f87eef8bcf07faa1c31afe31c26e2cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#a2f87eef8bcf07faa1c31afe31c26e2cd">More...</a><br /></td></tr>
 151 <tr class="separator:a2f87eef8bcf07faa1c31afe31c26e2cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
 152 <tr class="memitem:ab24f49526202babfe7df925cd326427b"><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_scharr3x3_kernel.xhtml#ab24f49526202babfe7df925cd326427b">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_x, <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *output_y, bool border_undefined)</td></tr>
 153 <tr class="memdesc:ab24f49526202babfe7df925cd326427b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise the kernel's source, destination and border.  <a href="#ab24f49526202babfe7df925cd326427b">More...</a><br /></td></tr>
 154 <tr class="separator:ab24f49526202babfe7df925cd326427b"><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_scharr3x3_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_scharr3x3_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>Interface for the kernel to run a 3x3 Scharr filter on a tensor. </p>
 206 <p class="formulaDsp">
 207 \[ \mathbf{G}_x=\begin{vmatrix} -3 &amp; 0 &amp; +3\\ -10&amp; 0 &amp; +10\\ -3 &amp; 0 &amp; +3 \end{vmatrix} \]
 208 </p>
 209  <p class="formulaDsp">
 210 \[ \mathbf{G}_y=\begin{vmatrix} -3 &amp; -10 &amp; -3\\ 0 &amp; 0 &amp; 0\\ +3 &amp; +10 &amp; +3 \end{vmatrix} \]
 211 </p>
 212
 213 <p>Definition at line <a class="el" href="_c_l_scharr3x3_kernel_8h_source.xhtml#l00050">50</a> of file <a class="el" href="_c_l_scharr3x3_kernel_8h_source.xhtml">CLScharr3x3Kernel.h</a>.</p>
 214 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 215 <a class="anchor" id="aca3036ac865b6a36d00babf0c0e37f5b"></a>
 216 <div class="memitem">
 217 <div class="memproto">
 218       <table class="memname">
 219         <tr>
 220           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_scharr3x3_kernel.xhtml">CLScharr3x3Kernel</a> </td>
 221           <td>(</td>
 222           <td class="paramname"></td><td>)</td>
 223           <td></td>
 224         </tr>
 225       </table>
 226 </div><div class="memdoc">
 227
 228 <p>Default constructor: initialize all the pointers to nullptr and parameters to zero. </p>
 229
 230 </div>
 231 </div>
 232 <a class="anchor" id="aa07a61f15f6269f45e19489a95c9224d"></a>
 233 <div class="memitem">
 234 <div class="memproto">
 235 <table class="mlabels">
 236   <tr>
 237   <td class="mlabels-left">
 238       <table class="memname">
 239         <tr>
 240           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_scharr3x3_kernel.xhtml">CLScharr3x3Kernel</a> </td>
 241           <td>(</td>
 242           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_c_l_scharr3x3_kernel.xhtml">CLScharr3x3Kernel</a> &amp;&#160;</td>
 243           <td class="paramname"></td><td>)</td>
 244           <td></td>
 245         </tr>
 246       </table>
 247   </td>
 248   <td class="mlabels-right">
 249 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
 250   </tr>
 251 </table>
 252 </div><div class="memdoc">
 253
 254 <p>Prevent instances of this class from being copied (As this class contains pointers). </p>
 255
 256 </div>
 257 </div>
 258 <a class="anchor" id="abce0bd975f2f2ea4b70aedd72685edc1"></a>
 259 <div class="memitem">
 260 <div class="memproto">
 261 <table class="mlabels">
 262   <tr>
 263   <td class="mlabels-left">
 264       <table class="memname">
 265         <tr>
 266           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_scharr3x3_kernel.xhtml">CLScharr3x3Kernel</a> </td>
 267           <td>(</td>
 268           <td class="paramtype"><a class="el" href="classarm__compute_1_1_c_l_scharr3x3_kernel.xhtml">CLScharr3x3Kernel</a> &amp;&amp;&#160;</td>
 269           <td class="paramname"></td><td>)</td>
 270           <td></td>
 271         </tr>
 272       </table>
 273   </td>
 274   <td class="mlabels-right">
 275 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 276   </tr>
 277 </table>
 278 </div><div class="memdoc">
 279
 280 <p>Allow instances of this class to be moved. </p>
 281
 282 </div>
 283 </div>
 284 <h2 class="groupheader">Member Function Documentation</h2>
 285 <a class="anchor" id="a423f9a45a52983b4de5e2b347f4369c7"></a>
 286 <div class="memitem">
 287 <div class="memproto">
 288 <table class="mlabels">
 289   <tr>
 290   <td class="mlabels-left">
 291       <table class="memname">
 292         <tr>
 293           <td class="memname"><a class="el" href="structarm__compute_1_1_border_size.xhtml">BorderSize</a> border_size </td>
 294           <td>(</td>
 295           <td class="paramname"></td><td>)</td>
 296           <td> const</td>
 297         </tr>
 298       </table>
 299   </td>
 300   <td class="mlabels-right">
 301 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 302   </tr>
 303 </table>
 304 </div><div class="memdoc">
 305
 306 <p>The size of the border for that kernel. </p>
 307 <dl class="section return"><dt>Returns</dt><dd>The width in number of elements of the border. </dd></dl>
 308
 309 <p>Reimplemented from <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#aa6daa9b04e2035bf007e5e5c3c4396a8">IKernel</a>.</p>
 310
 311 </div>
 312 </div>
 313 <a class="anchor" id="ab24f49526202babfe7df925cd326427b"></a>
 314 <div class="memitem">
 315 <div class="memproto">
 316       <table class="memname">
 317         <tr>
 318           <td class="memname">void configure </td>
 319           <td>(</td>
 320           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *&#160;</td>
 321           <td class="paramname"><em>input</em>, </td>
 322         </tr>
 323         <tr>
 324           <td class="paramkey"></td>
 325           <td></td>
 326           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *&#160;</td>
 327           <td class="paramname"><em>output_x</em>, </td>
 328         </tr>
 329         <tr>
 330           <td class="paramkey"></td>
 331           <td></td>
 332           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> *&#160;</td>
 333           <td class="paramname"><em>output_y</em>, </td>
 334         </tr>
 335         <tr>
 336           <td class="paramkey"></td>
 337           <td></td>
 338           <td class="paramtype">bool&#160;</td>
 339           <td class="paramname"><em>border_undefined</em>&#160;</td>
 340         </tr>
 341         <tr>
 342           <td></td>
 343           <td>)</td>
 344           <td></td><td></td>
 345         </tr>
 346       </table>
 347 </div><div class="memdoc">
 348
 349 <p>Initialise the kernel's source, destination and border. </p>
 350 <dl class="section note"><dt>Note</dt><dd>At least one of output_x or output_y must be set.</dd></dl>
 351 <dl class="params"><dt>Parameters</dt><dd>
 352   <table class="params">
 353     <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>Source tensor. Data types supported: U8. </td></tr>
 354     <tr><td class="paramdir">[out]</td><td class="paramname">output_x</td><td>(Optional) Destination tensor for the X gradient, Data types supported: S16. </td></tr>
 355     <tr><td class="paramdir">[out]</td><td class="paramname">output_y</td><td>(Optional) Destination tensor for the Y gradient, Data types supported: S16. </td></tr>
 356     <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>
 357   </table>
 358   </dd>
 359 </dl>
 360
 361 </div>
 362 </div>
 363 <a class="anchor" id="af2d37653c2c381ce8c52df533490f2c5"></a>
 364 <div class="memitem">
 365 <div class="memproto">
 366 <table class="mlabels">
 367   <tr>
 368   <td class="mlabels-left">
 369       <table class="memname">
 370         <tr>
 371           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_scharr3x3_kernel.xhtml">CLScharr3x3Kernel</a>&amp; operator= </td>
 372           <td>(</td>
 373           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_c_l_scharr3x3_kernel.xhtml">CLScharr3x3Kernel</a> &amp;&#160;</td>
 374           <td class="paramname"></td><td>)</td>
 375           <td></td>
 376         </tr>
 377       </table>
 378   </td>
 379   <td class="mlabels-right">
 380 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
 381   </tr>
 382 </table>
 383 </div><div class="memdoc">
 384
 385 <p>Prevent instances of this class from being copied (As this class contains pointers). </p>
 386
 387 </div>
 388 </div>
 389 <a class="anchor" id="a2f87eef8bcf07faa1c31afe31c26e2cd"></a>
 390 <div class="memitem">
 391 <div class="memproto">
 392 <table class="mlabels">
 393   <tr>
 394   <td class="mlabels-left">
 395       <table class="memname">
 396         <tr>
 397           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_scharr3x3_kernel.xhtml">CLScharr3x3Kernel</a>&amp; operator= </td>
 398           <td>(</td>
 399           <td class="paramtype"><a class="el" href="classarm__compute_1_1_c_l_scharr3x3_kernel.xhtml">CLScharr3x3Kernel</a> &amp;&amp;&#160;</td>
 400           <td class="paramname"></td><td>)</td>
 401           <td></td>
 402         </tr>
 403       </table>
 404   </td>
 405   <td class="mlabels-right">
 406 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 407   </tr>
 408 </table>
 409 </div><div class="memdoc">
 410
 411 <p>Allow instances of this class to be moved. </p>
 412
 413 </div>
 414 </div>
 415 <a class="anchor" id="a493987e85723a8000eb26d1f00e2ad0e"></a>
 416 <div class="memitem">
 417 <div class="memproto">
 418 <table class="mlabels">
 419   <tr>
 420   <td class="mlabels-left">
 421       <table class="memname">
 422         <tr>
 423           <td class="memname">void run </td>
 424           <td>(</td>
 425           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;&#160;</td>
 426           <td class="paramname"><em>window</em>, </td>
 427         </tr>
 428         <tr>
 429           <td class="paramkey"></td>
 430           <td></td>
 431           <td class="paramtype">cl::CommandQueue &amp;&#160;</td>
 432           <td class="paramname"><em>queue</em>&#160;</td>
 433         </tr>
 434         <tr>
 435           <td></td>
 436           <td>)</td>
 437           <td></td><td></td>
 438         </tr>
 439       </table>
 440   </td>
 441   <td class="mlabels-right">
 442 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 443   </tr>
 444 </table>
 445 </div><div class="memdoc">
 446
 447 <p>Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue. </p>
 448 <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>
 449 <dl class="params"><dt>Parameters</dt><dd>
 450   <table class="params">
 451     <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>
 452     <tr><td class="paramdir">[in,out]</td><td class="paramname">queue</td><td>Command queue on which to enqueue the kernel. </td></tr>
 453   </table>
 454   </dd>
 455 </dl>
 456
 457 <p>Implements <a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml#af6a174d47571f51f199ffc27ecc10f51">ICLKernel</a>.</p>
 458
 459 </div>
 460 </div>
 461 <hr/>The documentation for this class was generated from the following file:<ul>
 462 <li>arm_compute/core/CL/kernels/<a class="el" href="_c_l_scharr3x3_kernel_8h_source.xhtml">CLScharr3x3Kernel.h</a></li>
 463 </ul>
 464 </div><!-- contents -->
 465 </div><!-- doc-content -->
 466 <!-- start footer part -->
 467 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 468   <ul>
 469     <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_scharr3x3_kernel.xhtml">CLScharr3x3Kernel</a></li>
 470     <li class="footer">Generated on Fri Mar 24 2017 17:23:50 for ARM Compute Library by
 471     <a href="http://www.doxygen.org/index.html">
 472     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
 473   </ul>
 474 </div>
 475 </body>
 476 </html>