documentation/classarm__compute_1_1_n_e_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>Compute Library: NEScharr3x3Kernel 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">Compute Library
  43    &#160;<span id="projectnumber">18.01</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="pages.xhtml"><span>Related&#160;Pages</span></a></li>
  59       <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
  60       <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  61       <li><a href="files.xhtml"><span>Files</span></a></li>
  62       <li>
  63         <div id="MSearchBox" class="MSearchBoxInactive">
  64         <span class="left">
  65           <img id="MSearchSelect" src="search/mag_sel.png"
  66                onmouseover="return searchBox.OnSearchSelectShow()"
  67                onmouseout="return searchBox.OnSearchSelectHide()"
  68                alt=""/>
  69           <input type="text" id="MSearchField" value="Search" accesskey="S"
  70                onfocus="searchBox.OnSearchFieldFocus(true)"
  71                onblur="searchBox.OnSearchFieldFocus(false)"
  72                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  73           </span><span class="right">
  74             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  75           </span>
  76         </div>
  77       </li>
  78     </ul>
  79   </div>
  80   <div id="navrow2" class="tabs2">
  81     <ul class="tablist">
  82       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  83       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
  84       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
  85       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
  86     </ul>
  87   </div>
  88 </div><!-- top -->
  89 <div id="side-nav" class="ui-resizable side-nav-resizable">
  90   <div id="nav-tree">
  91     <div id="nav-tree-contents">
  92       <div id="nav-sync" class="sync"></div>
  93     </div>
  94   </div>
  95   <div id="splitbar" style="-moz-user-select:none;"
  96        class="ui-resizable-handle">
  97   </div>
  98 </div>
  99 <script type="text/javascript">
 100 $(document).ready(function(){initNavTree('classarm__compute_1_1_n_e_scharr3x3_kernel.xhtml','');});
 101 </script>
 102 <div id="doc-content">
 103 <!-- window showing the filter options -->
 104 <div id="MSearchSelectWindow"
 105      onmouseover="return searchBox.OnSearchSelectShow()"
 106      onmouseout="return searchBox.OnSearchSelectHide()"
 107      onkeydown="return searchBox.OnSearchSelectKey(event)">
 108 </div>
 109
 110 <!-- iframe showing the search results (closed by default) -->
 111 <div id="MSearchResultsWindow">
 112 <iframe src="javascript:void(0)" frameborder="0"
 113         name="MSearchResults" id="MSearchResults">
 114 </iframe>
 115 </div>
 116
 117 <div class="header">
 118   <div class="summary">
 119 <a href="#pub-methods">Public Member Functions</a>  </div>
 120   <div class="headertitle">
 121 <div class="title">NEScharr3x3Kernel Class Reference</div>  </div>
 122 </div><!--header-->
 123 <div class="contents">
 124
 125 <p>Interface for the kernel to run a 3x3 Scharr filter on a tensor.
 126  <a href="classarm__compute_1_1_n_e_scharr3x3_kernel.xhtml#details">More...</a></p>
 127
 128 <p><code>#include &lt;<a class="el" href="_n_e_scharr3x3_kernel_8h_source.xhtml">NEScharr3x3Kernel.h</a>&gt;</code></p>
 129 <div class="dynheader">
 130 Collaboration diagram for NEScharr3x3Kernel:</div>
 131 <div class="dyncontent">
 132 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_n_e_scharr3x3_kernel__coll__graph.svg" width="155" height="187"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
 133 </div>
 134 <center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
 135 <table class="memberdecls">
 136 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 137 Public Member Functions</h2></td></tr>
 138 <tr class="memitem:a625e12a0c7ab061154b39f47a4a11309"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_scharr3x3_kernel.xhtml#a625e12a0c7ab061154b39f47a4a11309">NEScharr3x3Kernel</a> ()</td></tr>
 139 <tr class="memdesc:a625e12a0c7ab061154b39f47a4a11309"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#a625e12a0c7ab061154b39f47a4a11309">More...</a><br /></td></tr>
 140 <tr class="separator:a625e12a0c7ab061154b39f47a4a11309"><td class="memSeparator" colspan="2">&#160;</td></tr>
 141 <tr class="memitem:aa92e67ceef8ce3ddbee234f9f3a28220"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_scharr3x3_kernel.xhtml#aa92e67ceef8ce3ddbee234f9f3a28220">NEScharr3x3Kernel</a> (const <a class="el" href="classarm__compute_1_1_n_e_scharr3x3_kernel.xhtml">NEScharr3x3Kernel</a> &amp;)=delete</td></tr>
 142 <tr class="memdesc:aa92e67ceef8ce3ddbee234f9f3a28220"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#aa92e67ceef8ce3ddbee234f9f3a28220">More...</a><br /></td></tr>
 143 <tr class="separator:aa92e67ceef8ce3ddbee234f9f3a28220"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <tr class="memitem:a9e56daa4acb0848264206cbcabd71fb6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_n_e_scharr3x3_kernel.xhtml">NEScharr3x3Kernel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_scharr3x3_kernel.xhtml#a9e56daa4acb0848264206cbcabd71fb6">operator=</a> (const <a class="el" href="classarm__compute_1_1_n_e_scharr3x3_kernel.xhtml">NEScharr3x3Kernel</a> &amp;)=delete</td></tr>
 145 <tr class="memdesc:a9e56daa4acb0848264206cbcabd71fb6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#a9e56daa4acb0848264206cbcabd71fb6">More...</a><br /></td></tr>
 146 <tr class="separator:a9e56daa4acb0848264206cbcabd71fb6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <tr class="memitem:aafe178454cd5eadaf3e80e39e46b3b45"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_scharr3x3_kernel.xhtml#aafe178454cd5eadaf3e80e39e46b3b45">NEScharr3x3Kernel</a> (<a class="el" href="classarm__compute_1_1_n_e_scharr3x3_kernel.xhtml">NEScharr3x3Kernel</a> &amp;&amp;)=default</td></tr>
 148 <tr class="memdesc:aafe178454cd5eadaf3e80e39e46b3b45"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#aafe178454cd5eadaf3e80e39e46b3b45">More...</a><br /></td></tr>
 149 <tr class="separator:aafe178454cd5eadaf3e80e39e46b3b45"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 <tr class="memitem:aa4a99a8888c2b726eb11026235e1df4b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_n_e_scharr3x3_kernel.xhtml">NEScharr3x3Kernel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_scharr3x3_kernel.xhtml#aa4a99a8888c2b726eb11026235e1df4b">operator=</a> (<a class="el" href="classarm__compute_1_1_n_e_scharr3x3_kernel.xhtml">NEScharr3x3Kernel</a> &amp;&amp;)=default</td></tr>
 151 <tr class="memdesc:aa4a99a8888c2b726eb11026235e1df4b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#aa4a99a8888c2b726eb11026235e1df4b">More...</a><br /></td></tr>
 152 <tr class="separator:aa4a99a8888c2b726eb11026235e1df4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 153 <tr class="memitem:a40d29ef4a881c7f54f2c5ac7e59500fb"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_scharr3x3_kernel.xhtml#a40d29ef4a881c7f54f2c5ac7e59500fb">~NEScharr3x3Kernel</a> ()=default</td></tr>
 154 <tr class="memdesc:a40d29ef4a881c7f54f2c5ac7e59500fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor.  <a href="#a40d29ef4a881c7f54f2c5ac7e59500fb">More...</a><br /></td></tr>
 155 <tr class="separator:a40d29ef4a881c7f54f2c5ac7e59500fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 156 <tr class="memitem:ace7523f9c3073ad82b77e46318a1ea77"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_scharr3x3_kernel.xhtml#ace7523f9c3073ad82b77e46318a1ea77">configure</a> (const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *input, <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *output_x, <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *output_y, bool border_undefined)</td></tr>
 157 <tr class="memdesc:ace7523f9c3073ad82b77e46318a1ea77"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise the kernel's source, destination and border.  <a href="#ace7523f9c3073ad82b77e46318a1ea77">More...</a><br /></td></tr>
 158 <tr class="separator:ace7523f9c3073ad82b77e46318a1ea77"><td class="memSeparator" colspan="2">&#160;</td></tr>
 159 <tr class="memitem:a112b35dd205c62ea6ed1447ef226da82"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_scharr3x3_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>
 160 <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>
 161 <tr class="separator:a112b35dd205c62ea6ed1447ef226da82"><td class="memSeparator" colspan="2">&#160;</td></tr>
 162 <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_n_e_scharr3x3_kernel.xhtml#a423f9a45a52983b4de5e2b347f4369c7">border_size</a> () const override</td></tr>
 163 <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>
 164 <tr class="separator:a423f9a45a52983b4de5e2b347f4369c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 165 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_c_p_p_kernel')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml">ICPPKernel</a></td></tr>
 166 <tr class="memitem:a033d17a97e07cea7fe83eefcf23540f6 inherit pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml#a033d17a97e07cea7fe83eefcf23540f6">~ICPPKernel</a> ()=default</td></tr>
 167 <tr class="memdesc:a033d17a97e07cea7fe83eefcf23540f6 inherit pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor.  <a href="#a033d17a97e07cea7fe83eefcf23540f6">More...</a><br /></td></tr>
 168 <tr class="separator:a033d17a97e07cea7fe83eefcf23540f6 inherit pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 169 <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>
 170 <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>
 171 <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>
 172 <tr class="separator:a7250cb8cbaa4104a93a2d77155085507 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 173 <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>
 174 <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>
 175 <tr class="separator:a341b60d15a5e12a5b8f3825194dd3b12 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 176 <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>
 177 <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>
 178 <tr class="separator:abfab8f0d4928e1081d9f65b77933e24a inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 179 <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>
 180 <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>
 181 <tr class="separator:a3f5646133956f06348b310ccc3d36353 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
 182 </table>
 183 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 184 <div class="textblock"><p>Interface for the kernel to run a 3x3 Scharr filter on a tensor. </p>
 185 <p class="formulaDsp">
 186 \[ \mathbf{G}_x=\begin{vmatrix} -3 &amp; 0 &amp; +3\\ -10&amp; 0 &amp; +10\\ -3 &amp; 0 &amp; +3 \end{vmatrix} \]
 187 </p>
 188
 189 <p>Definition at line <a class="el" href="_n_e_scharr3x3_kernel_8h_source.xhtml#l00043">43</a> of file <a class="el" href="_n_e_scharr3x3_kernel_8h_source.xhtml">NEScharr3x3Kernel.h</a>.</p>
 190 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 191 <a class="anchor" id="a625e12a0c7ab061154b39f47a4a11309"></a>
 192 <div class="memitem">
 193 <div class="memproto">
 194       <table class="memname">
 195         <tr>
 196           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_scharr3x3_kernel.xhtml">NEScharr3x3Kernel</a> </td>
 197           <td>(</td>
 198           <td class="paramname"></td><td>)</td>
 199           <td></td>
 200         </tr>
 201       </table>
 202 </div><div class="memdoc">
 203
 204 <p>Default constructor. </p>
 205
 206 </div>
 207 </div>
 208 <a class="anchor" id="aa92e67ceef8ce3ddbee234f9f3a28220"></a>
 209 <div class="memitem">
 210 <div class="memproto">
 211 <table class="mlabels">
 212   <tr>
 213   <td class="mlabels-left">
 214       <table class="memname">
 215         <tr>
 216           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_scharr3x3_kernel.xhtml">NEScharr3x3Kernel</a> </td>
 217           <td>(</td>
 218           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_n_e_scharr3x3_kernel.xhtml">NEScharr3x3Kernel</a> &amp;&#160;</td>
 219           <td class="paramname"></td><td>)</td>
 220           <td></td>
 221         </tr>
 222       </table>
 223   </td>
 224   <td class="mlabels-right">
 225 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
 226   </tr>
 227 </table>
 228 </div><div class="memdoc">
 229
 230 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
 231
 232 </div>
 233 </div>
 234 <a class="anchor" id="aafe178454cd5eadaf3e80e39e46b3b45"></a>
 235 <div class="memitem">
 236 <div class="memproto">
 237 <table class="mlabels">
 238   <tr>
 239   <td class="mlabels-left">
 240       <table class="memname">
 241         <tr>
 242           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_scharr3x3_kernel.xhtml">NEScharr3x3Kernel</a> </td>
 243           <td>(</td>
 244           <td class="paramtype"><a class="el" href="classarm__compute_1_1_n_e_scharr3x3_kernel.xhtml">NEScharr3x3Kernel</a> &amp;&amp;&#160;</td>
 245           <td class="paramname"></td><td>)</td>
 246           <td></td>
 247         </tr>
 248       </table>
 249   </td>
 250   <td class="mlabels-right">
 251 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 252   </tr>
 253 </table>
 254 </div><div class="memdoc">
 255
 256 <p>Allow instances of this class to be moved. </p>
 257
 258 </div>
 259 </div>
 260 <a class="anchor" id="a40d29ef4a881c7f54f2c5ac7e59500fb"></a>
 261 <div class="memitem">
 262 <div class="memproto">
 263 <table class="mlabels">
 264   <tr>
 265   <td class="mlabels-left">
 266       <table class="memname">
 267         <tr>
 268           <td class="memname">~<a class="el" href="classarm__compute_1_1_n_e_scharr3x3_kernel.xhtml">NEScharr3x3Kernel</a> </td>
 269           <td>(</td>
 270           <td class="paramname"></td><td>)</td>
 271           <td></td>
 272         </tr>
 273       </table>
 274   </td>
 275   <td class="mlabels-right">
 276 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 277   </tr>
 278 </table>
 279 </div><div class="memdoc">
 280
 281 <p>Default destructor. </p>
 282
 283 </div>
 284 </div>
 285 <h2 class="groupheader">Member Function Documentation</h2>
 286 <a class="anchor" id="a423f9a45a52983b4de5e2b347f4369c7"></a>
 287 <div class="memitem">
 288 <div class="memproto">
 289 <table class="mlabels">
 290   <tr>
 291   <td class="mlabels-left">
 292       <table class="memname">
 293         <tr>
 294           <td class="memname"><a class="el" href="structarm__compute_1_1_border_size.xhtml">BorderSize</a> border_size </td>
 295           <td>(</td>
 296           <td class="paramname"></td><td>)</td>
 297           <td> const</td>
 298         </tr>
 299       </table>
 300   </td>
 301   <td class="mlabels-right">
 302 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 303   </tr>
 304 </table>
 305 </div><div class="memdoc">
 306
 307 <p>The size of the border for that kernel. </p>
 308 <dl class="section return"><dt>Returns</dt><dd>The width in number of elements of the border. </dd></dl>
 309
 310 <p>Reimplemented from <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#aa6daa9b04e2035bf007e5e5c3c4396a8">IKernel</a>.</p>
 311
 312 </div>
 313 </div>
 314 <a class="anchor" id="ace7523f9c3073ad82b77e46318a1ea77"></a>
 315 <div class="memitem">
 316 <div class="memproto">
 317       <table class="memname">
 318         <tr>
 319           <td class="memname">void configure </td>
 320           <td>(</td>
 321           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
 322           <td class="paramname"><em>input</em>, </td>
 323         </tr>
 324         <tr>
 325           <td class="paramkey"></td>
 326           <td></td>
 327           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
 328           <td class="paramname"><em>output_x</em>, </td>
 329         </tr>
 330         <tr>
 331           <td class="paramkey"></td>
 332           <td></td>
 333           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
 334           <td class="paramname"><em>output_y</em>, </td>
 335         </tr>
 336         <tr>
 337           <td class="paramkey"></td>
 338           <td></td>
 339           <td class="paramtype">bool&#160;</td>
 340           <td class="paramname"><em>border_undefined</em>&#160;</td>
 341         </tr>
 342         <tr>
 343           <td></td>
 344           <td>)</td>
 345           <td></td><td></td>
 346         </tr>
 347       </table>
 348 </div><div class="memdoc">
 349
 350 <p>Initialise the kernel's source, destination and border. </p>
 351 <dl class="section note"><dt>Note</dt><dd>At least one of output_x or output_y must be set.</dd></dl>
 352 <dl class="params"><dt>Parameters</dt><dd>
 353   <table class="params">
 354     <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>Source tensor. Data type supported: U8. </td></tr>
 355     <tr><td class="paramdir">[out]</td><td class="paramname">output_x</td><td>(Optional) Destination tensor for the X gradient. Data type supported: S16. </td></tr>
 356     <tr><td class="paramdir">[out]</td><td class="paramname">output_y</td><td>(Optional) Destination tensor for the Y gradient. Data type supported: S16. </td></tr>
 357     <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>
 358   </table>
 359   </dd>
 360 </dl>
 361
 362 </div>
 363 </div>
 364 <a class="anchor" id="a9e56daa4acb0848264206cbcabd71fb6"></a>
 365 <div class="memitem">
 366 <div class="memproto">
 367 <table class="mlabels">
 368   <tr>
 369   <td class="mlabels-left">
 370       <table class="memname">
 371         <tr>
 372           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_scharr3x3_kernel.xhtml">NEScharr3x3Kernel</a>&amp; operator= </td>
 373           <td>(</td>
 374           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_n_e_scharr3x3_kernel.xhtml">NEScharr3x3Kernel</a> &amp;&#160;</td>
 375           <td class="paramname"></td><td>)</td>
 376           <td></td>
 377         </tr>
 378       </table>
 379   </td>
 380   <td class="mlabels-right">
 381 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
 382   </tr>
 383 </table>
 384 </div><div class="memdoc">
 385
 386 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
 387
 388 </div>
 389 </div>
 390 <a class="anchor" id="aa4a99a8888c2b726eb11026235e1df4b"></a>
 391 <div class="memitem">
 392 <div class="memproto">
 393 <table class="mlabels">
 394   <tr>
 395   <td class="mlabels-left">
 396       <table class="memname">
 397         <tr>
 398           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_scharr3x3_kernel.xhtml">NEScharr3x3Kernel</a>&amp; operator= </td>
 399           <td>(</td>
 400           <td class="paramtype"><a class="el" href="classarm__compute_1_1_n_e_scharr3x3_kernel.xhtml">NEScharr3x3Kernel</a> &amp;&amp;&#160;</td>
 401           <td class="paramname"></td><td>)</td>
 402           <td></td>
 403         </tr>
 404       </table>
 405   </td>
 406   <td class="mlabels-right">
 407 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 408   </tr>
 409 </table>
 410 </div><div class="memdoc">
 411
 412 <p>Allow instances of this class to be moved. </p>
 413
 414 </div>
 415 </div>
 416 <a class="anchor" id="a112b35dd205c62ea6ed1447ef226da82"></a>
 417 <div class="memitem">
 418 <div class="memproto">
 419 <table class="mlabels">
 420   <tr>
 421   <td class="mlabels-left">
 422       <table class="memname">
 423         <tr>
 424           <td class="memname">void run </td>
 425           <td>(</td>
 426           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;&#160;</td>
 427           <td class="paramname"><em>window</em>, </td>
 428         </tr>
 429         <tr>
 430           <td class="paramkey"></td>
 431           <td></td>
 432           <td class="paramtype">const <a class="el" href="structarm__compute_1_1_thread_info.xhtml">ThreadInfo</a> &amp;&#160;</td>
 433           <td class="paramname"><em>info</em>&#160;</td>
 434         </tr>
 435         <tr>
 436           <td></td>
 437           <td>)</td>
 438           <td></td><td></td>
 439         </tr>
 440       </table>
 441   </td>
 442   <td class="mlabels-right">
 443 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 444   </tr>
 445 </table>
 446 </div><div class="memdoc">
 447
 448 <p>Execute the kernel on the passed window. </p>
 449 <dl class="section warning"><dt>Warning</dt><dd>If <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#abfab8f0d4928e1081d9f65b77933e24a" title="Indicates whether or not the kernel is parallelisable. ">is_parallelisable()</a> returns false then the passed window must be equal to <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353" title="The maximum window the kernel can be executed on. ">window()</a></dd></dl>
 450 <dl class="section note"><dt>Note</dt><dd>The window has to be a region within the window returned by the <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353" title="The maximum window the kernel can be executed on. ">window()</a> method</dd>
 451 <dd>
 452 The width of the window has to be a multiple of num_elems_processed_per_iteration().</dd></dl>
 453 <dl class="params"><dt>Parameters</dt><dd>
 454   <table class="params">
 455     <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>
 456     <tr><td class="paramdir">[in]</td><td class="paramname">info</td><td>Info about executing thread and CPU. </td></tr>
 457   </table>
 458   </dd>
 459 </dl>
 460
 461 <p>Implements <a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml#af814ff5e96f40f1cccf809b2b4ee19ef">ICPPKernel</a>.</p>
 462
 463 </div>
 464 </div>
 465 <hr/>The documentation for this class was generated from the following file:<ul>
 466 <li>arm_compute/core/NEON/kernels/<a class="el" href="_n_e_scharr3x3_kernel_8h_source.xhtml">NEScharr3x3Kernel.h</a></li>
 467 </ul>
 468 </div><!-- contents -->
 469 </div><!-- doc-content -->
 470 <!-- start footer part -->
 471 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 472   <ul>
 473     <li class="navelem"><a class="el" href="namespacearm__compute.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="classarm__compute_1_1_n_e_scharr3x3_kernel.xhtml">NEScharr3x3Kernel</a></li>
 474     <li class="footer">Generated on Wed Jan 24 2018 14:30:46 for Compute Library by
 475     <a href="http://www.doxygen.org/index.html">
 476     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
 477   </ul>
 478 </div>
 479 </body>
 480 </html>