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">
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: 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);
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(); });
27 <script type="text/x-mathjax-config">
29 extensions: ["tex2jax.js"],
30 jax: ["input/TeX","output/HTML-CSS"],
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" />
36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
38 <table cellspacing="0" cellpadding="0">
40 <tr style="height: 56px;">
41 <td style="padding-left: 0.5em;">
42 <div id="projectname">ARM Compute Library
43  <span id="projectnumber">17.04</span>
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');
55 <div id="navrow1" class="tabs">
57 <li><a href="index.xhtml"><span>Main 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 Structures</span></a></li>
60 <li><a href="files.xhtml"><span>Files</span></a></li>
62 <div id="MSearchBox" class="MSearchBoxInactive">
64 <img id="MSearchSelect" src="search/mag_sel.png"
65 onmouseover="return searchBox.OnSearchSelectShow()"
66 onmouseout="return searchBox.OnSearchSelectHide()"
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>
79 <div id="navrow2" class="tabs2">
81 <li><a href="annotated.xhtml"><span>Data Structures</span></a></li>
82 <li><a href="classes.xhtml"><span>Data Structure Index</span></a></li>
83 <li><a href="inherits.xhtml"><span>Class Hierarchy</span></a></li>
84 <li><a href="functions.xhtml"><span>Data Fields</span></a></li>
88 <div id="side-nav" class="ui-resizable side-nav-resizable">
90 <div id="nav-tree-contents">
91 <div id="nav-sync" class="sync"></div>
94 <div id="splitbar" style="-moz-user-select:none;"
95 class="ui-resizable-handle">
98 <script type="text/javascript">
99 $(document).ready(function(){initNavTree('classarm__compute_1_1_n_e_scharr3x3_kernel.xhtml','');});
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)">
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">
117 <div class="summary">
118 <a href="#pub-methods">Public Member Functions</a> </div>
119 <div class="headertitle">
120 <div class="title">NEScharr3x3Kernel Class Reference</div> </div>
122 <div class="contents">
124 <p>Interface for the kernel to run a 3x3 Scharr filter on a tensor.
125 <a href="classarm__compute_1_1_n_e_scharr3x3_kernel.xhtml#details">More...</a></p>
127 <p><code>#include <<a class="el" href="_n_e_scharr3x3_kernel_8h_source.xhtml">NEScharr3x3Kernel.h</a>></code></p>
128 <div class="dynheader">
129 Collaboration diagram for NEScharr3x3Kernel:</div>
130 <div class="dyncontent">
131 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_n_e_scharr3x3_kernel__coll__graph.svg" width="148" height="187"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
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:a625e12a0c7ab061154b39f47a4a11309"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_scharr3x3_kernel.xhtml#a625e12a0c7ab061154b39f47a4a11309">NEScharr3x3Kernel</a> ()</td></tr>
138 <tr class="memdesc:a625e12a0c7ab061154b39f47a4a11309"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a625e12a0c7ab061154b39f47a4a11309">More...</a><br /></td></tr>
139 <tr class="separator:a625e12a0c7ab061154b39f47a4a11309"><td class="memSeparator" colspan="2"> </td></tr>
140 <tr class="memitem:aa92e67ceef8ce3ddbee234f9f3a28220"><td class="memItemLeft" align="right" valign="top"> </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> &)=delete</td></tr>
141 <tr class="memdesc:aa92e67ceef8ce3ddbee234f9f3a28220"><td class="mdescLeft"> </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>
142 <tr class="separator:aa92e67ceef8ce3ddbee234f9f3a28220"><td class="memSeparator" colspan="2"> </td></tr>
143 <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> & </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> &)=delete</td></tr>
144 <tr class="memdesc:a9e56daa4acb0848264206cbcabd71fb6"><td class="mdescLeft"> </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>
145 <tr class="separator:a9e56daa4acb0848264206cbcabd71fb6"><td class="memSeparator" colspan="2"> </td></tr>
146 <tr class="memitem:aafe178454cd5eadaf3e80e39e46b3b45"><td class="memItemLeft" align="right" valign="top"> </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> &&)=default</td></tr>
147 <tr class="memdesc:aafe178454cd5eadaf3e80e39e46b3b45"><td class="mdescLeft"> </td><td class="mdescRight">Allow instances of this class to be moved. <a href="#aafe178454cd5eadaf3e80e39e46b3b45">More...</a><br /></td></tr>
148 <tr class="separator:aafe178454cd5eadaf3e80e39e46b3b45"><td class="memSeparator" colspan="2"> </td></tr>
149 <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> & </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> &&)=default</td></tr>
150 <tr class="memdesc:aa4a99a8888c2b726eb11026235e1df4b"><td class="mdescLeft"> </td><td class="mdescRight">Allow instances of this class to be moved. <a href="#aa4a99a8888c2b726eb11026235e1df4b">More...</a><br /></td></tr>
151 <tr class="separator:aa4a99a8888c2b726eb11026235e1df4b"><td class="memSeparator" colspan="2"> </td></tr>
152 <tr class="memitem:a40d29ef4a881c7f54f2c5ac7e59500fb"><td class="memItemLeft" align="right" valign="top"> </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>
153 <tr class="memdesc:a40d29ef4a881c7f54f2c5ac7e59500fb"><td class="mdescLeft"> </td><td class="mdescRight">Default destructor. <a href="#a40d29ef4a881c7f54f2c5ac7e59500fb">More...</a><br /></td></tr>
154 <tr class="separator:a40d29ef4a881c7f54f2c5ac7e59500fb"><td class="memSeparator" colspan="2"> </td></tr>
155 <tr class="memitem:ace7523f9c3073ad82b77e46318a1ea77"><td class="memItemLeft" align="right" valign="top">void </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>
156 <tr class="memdesc:ace7523f9c3073ad82b77e46318a1ea77"><td class="mdescLeft"> </td><td class="mdescRight">Initialise the kernel's source, destination and border. <a href="#ace7523f9c3073ad82b77e46318a1ea77">More...</a><br /></td></tr>
157 <tr class="separator:ace7523f9c3073ad82b77e46318a1ea77"><td class="memSeparator" colspan="2"> </td></tr>
158 <tr class="memitem:a8fd12b95bdde3f93db96bc9b1598db69"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_scharr3x3_kernel.xhtml#a8fd12b95bdde3f93db96bc9b1598db69">run</a> (const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &<a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353">window</a>) override</td></tr>
159 <tr class="memdesc:a8fd12b95bdde3f93db96bc9b1598db69"><td class="mdescLeft"> </td><td class="mdescRight">Execute the kernel on the passed window. <a href="#a8fd12b95bdde3f93db96bc9b1598db69">More...</a><br /></td></tr>
160 <tr class="separator:a8fd12b95bdde3f93db96bc9b1598db69"><td class="memSeparator" colspan="2"> </td></tr>
161 <tr class="memitem:a423f9a45a52983b4de5e2b347f4369c7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structarm__compute_1_1_border_size.xhtml">BorderSize</a> </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>
162 <tr class="memdesc:a423f9a45a52983b4de5e2b347f4369c7"><td class="mdescLeft"> </td><td class="mdescRight">The size of the border for that kernel. <a href="#a423f9a45a52983b4de5e2b347f4369c7">More...</a><br /></td></tr>
163 <tr class="separator:a423f9a45a52983b4de5e2b347f4369c7"><td class="memSeparator" colspan="2"> </td></tr>
164 <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="-"/> Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml">ICPPKernel</a></td></tr>
165 <tr class="memitem:a033d17a97e07cea7fe83eefcf23540f6 inherit pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td class="memItemLeft" align="right" valign="top">virtual </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>
166 <tr class="memdesc:a033d17a97e07cea7fe83eefcf23540f6 inherit pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td class="mdescLeft"> </td><td class="mdescRight">Default destructor. <a href="#a033d17a97e07cea7fe83eefcf23540f6">More...</a><br /></td></tr>
167 <tr class="separator:a033d17a97e07cea7fe83eefcf23540f6 inherit pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td class="memSeparator" colspan="2"> </td></tr>
168 <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="-"/> Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_kernel.xhtml">IKernel</a></td></tr>
169 <tr class="memitem:a7250cb8cbaa4104a93a2d77155085507 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a7250cb8cbaa4104a93a2d77155085507">IKernel</a> ()</td></tr>
170 <tr class="memdesc:a7250cb8cbaa4104a93a2d77155085507 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a7250cb8cbaa4104a93a2d77155085507">More...</a><br /></td></tr>
171 <tr class="separator:a7250cb8cbaa4104a93a2d77155085507 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2"> </td></tr>
172 <tr class="memitem:a341b60d15a5e12a5b8f3825194dd3b12 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a341b60d15a5e12a5b8f3825194dd3b12">~IKernel</a> ()=default</td></tr>
173 <tr class="memdesc:a341b60d15a5e12a5b8f3825194dd3b12 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a341b60d15a5e12a5b8f3825194dd3b12">More...</a><br /></td></tr>
174 <tr class="separator:a341b60d15a5e12a5b8f3825194dd3b12 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2"> </td></tr>
175 <tr class="memitem:abfab8f0d4928e1081d9f65b77933e24a inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_kernel.xhtml#abfab8f0d4928e1081d9f65b77933e24a">is_parallelisable</a> () const </td></tr>
176 <tr class="memdesc:abfab8f0d4928e1081d9f65b77933e24a inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="mdescLeft"> </td><td class="mdescRight">Indicates whether or not the kernel is parallelisable. <a href="#abfab8f0d4928e1081d9f65b77933e24a">More...</a><br /></td></tr>
177 <tr class="separator:abfab8f0d4928e1081d9f65b77933e24a inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2"> </td></tr>
178 <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> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353">window</a> () const </td></tr>
179 <tr class="memdesc:a3f5646133956f06348b310ccc3d36353 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="mdescLeft"> </td><td class="mdescRight">The maximum window the kernel can be executed on. <a href="#a3f5646133956f06348b310ccc3d36353">More...</a><br /></td></tr>
180 <tr class="separator:a3f5646133956f06348b310ccc3d36353 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2"> </td></tr>
182 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
183 <div class="textblock"><p>Interface for the kernel to run a 3x3 Scharr filter on a tensor. </p>
184 <p class="formulaDsp">
185 \[ \mathbf{G}_x=\begin{vmatrix} -3 & 0 & +3\\ -10& 0 & +10\\ -3 & 0 & +3 \end{vmatrix} \]
188 <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>
189 </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
190 <a class="anchor" id="a625e12a0c7ab061154b39f47a4a11309"></a>
191 <div class="memitem">
192 <div class="memproto">
193 <table class="memname">
195 <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_scharr3x3_kernel.xhtml">NEScharr3x3Kernel</a> </td>
197 <td class="paramname"></td><td>)</td>
201 </div><div class="memdoc">
203 <p>Default constructor. </p>
207 <a class="anchor" id="aa92e67ceef8ce3ddbee234f9f3a28220"></a>
208 <div class="memitem">
209 <div class="memproto">
210 <table class="mlabels">
212 <td class="mlabels-left">
213 <table class="memname">
215 <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_scharr3x3_kernel.xhtml">NEScharr3x3Kernel</a> </td>
217 <td class="paramtype">const <a class="el" href="classarm__compute_1_1_n_e_scharr3x3_kernel.xhtml">NEScharr3x3Kernel</a> & </td>
218 <td class="paramname"></td><td>)</td>
223 <td class="mlabels-right">
224 <span class="mlabels"><span class="mlabel">delete</span></span> </td>
227 </div><div class="memdoc">
229 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
233 <a class="anchor" id="aafe178454cd5eadaf3e80e39e46b3b45"></a>
234 <div class="memitem">
235 <div class="memproto">
236 <table class="mlabels">
238 <td class="mlabels-left">
239 <table class="memname">
241 <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_scharr3x3_kernel.xhtml">NEScharr3x3Kernel</a> </td>
243 <td class="paramtype"><a class="el" href="classarm__compute_1_1_n_e_scharr3x3_kernel.xhtml">NEScharr3x3Kernel</a> && </td>
244 <td class="paramname"></td><td>)</td>
249 <td class="mlabels-right">
250 <span class="mlabels"><span class="mlabel">default</span></span> </td>
253 </div><div class="memdoc">
255 <p>Allow instances of this class to be moved. </p>
259 <a class="anchor" id="a40d29ef4a881c7f54f2c5ac7e59500fb"></a>
260 <div class="memitem">
261 <div class="memproto">
262 <table class="mlabels">
264 <td class="mlabels-left">
265 <table class="memname">
267 <td class="memname">~<a class="el" href="classarm__compute_1_1_n_e_scharr3x3_kernel.xhtml">NEScharr3x3Kernel</a> </td>
269 <td class="paramname"></td><td>)</td>
274 <td class="mlabels-right">
275 <span class="mlabels"><span class="mlabel">default</span></span> </td>
278 </div><div class="memdoc">
280 <p>Default destructor. </p>
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">
290 <td class="mlabels-left">
291 <table class="memname">
293 <td class="memname"><a class="el" href="structarm__compute_1_1_border_size.xhtml">BorderSize</a> border_size </td>
295 <td class="paramname"></td><td>)</td>
300 <td class="mlabels-right">
301 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
304 </div><div class="memdoc">
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>
309 <p>Reimplemented from <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#aa6daa9b04e2035bf007e5e5c3c4396a8">IKernel</a>.</p>
313 <a class="anchor" id="ace7523f9c3073ad82b77e46318a1ea77"></a>
314 <div class="memitem">
315 <div class="memproto">
316 <table class="memname">
318 <td class="memname">void configure </td>
320 <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> * </td>
321 <td class="paramname"><em>input</em>, </td>
324 <td class="paramkey"></td>
326 <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> * </td>
327 <td class="paramname"><em>output_x</em>, </td>
330 <td class="paramkey"></td>
332 <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> * </td>
333 <td class="paramname"><em>output_y</em>, </td>
336 <td class="paramkey"></td>
338 <td class="paramtype">bool </td>
339 <td class="paramname"><em>border_undefined</em> </td>
347 </div><div class="memdoc">
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 type 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 type 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 type 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>
363 <a class="anchor" id="a9e56daa4acb0848264206cbcabd71fb6"></a>
364 <div class="memitem">
365 <div class="memproto">
366 <table class="mlabels">
368 <td class="mlabels-left">
369 <table class="memname">
371 <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_scharr3x3_kernel.xhtml">NEScharr3x3Kernel</a>& operator= </td>
373 <td class="paramtype">const <a class="el" href="classarm__compute_1_1_n_e_scharr3x3_kernel.xhtml">NEScharr3x3Kernel</a> & </td>
374 <td class="paramname"></td><td>)</td>
379 <td class="mlabels-right">
380 <span class="mlabels"><span class="mlabel">delete</span></span> </td>
383 </div><div class="memdoc">
385 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
389 <a class="anchor" id="aa4a99a8888c2b726eb11026235e1df4b"></a>
390 <div class="memitem">
391 <div class="memproto">
392 <table class="mlabels">
394 <td class="mlabels-left">
395 <table class="memname">
397 <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_scharr3x3_kernel.xhtml">NEScharr3x3Kernel</a>& operator= </td>
399 <td class="paramtype"><a class="el" href="classarm__compute_1_1_n_e_scharr3x3_kernel.xhtml">NEScharr3x3Kernel</a> && </td>
400 <td class="paramname"></td><td>)</td>
405 <td class="mlabels-right">
406 <span class="mlabels"><span class="mlabel">default</span></span> </td>
409 </div><div class="memdoc">
411 <p>Allow instances of this class to be moved. </p>
415 <a class="anchor" id="a8fd12b95bdde3f93db96bc9b1598db69"></a>
416 <div class="memitem">
417 <div class="memproto">
418 <table class="mlabels">
420 <td class="mlabels-left">
421 <table class="memname">
423 <td class="memname">void run </td>
425 <td class="paramtype">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> & </td>
426 <td class="paramname"><em>window</em></td><td>)</td>
431 <td class="mlabels-right">
432 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
435 </div><div class="memdoc">
437 <p>Execute the kernel on the passed window. </p>
438 <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>
439 <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>
441 The width of the window has to be a multiple of num_elems_processed_per_iteration().</dd></dl>
442 <dl class="params"><dt>Parameters</dt><dd>
443 <table class="params">
444 <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>
449 <p>Implements <a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml#a6f56c8bb44166634652b877d6eb7a9a2">ICPPKernel</a>.</p>
453 <hr/>The documentation for this class was generated from the following file:<ul>
454 <li>arm_compute/core/NEON/kernels/<a class="el" href="_n_e_scharr3x3_kernel_8h_source.xhtml">NEScharr3x3Kernel.h</a></li>
456 </div><!-- contents -->
457 </div><!-- doc-content -->
458 <!-- start footer part -->
459 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
461 <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>
462 <li class="footer">Generated on Wed Apr 12 2017 14:26:06 for ARM Compute Library by
463 <a href="http://www.doxygen.org/index.html">
464 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>