arm_compute v17.04
[platform/upstream/armcl.git] / documentation / classarm__compute_1_1_n_e_derivative_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: NEDerivativeKernel Class Reference</title>
10 <link href="tabs.css" rel="stylesheet" type="text/css"/>
11 <script type="text/javascript" src="jquery.js"></script>
12 <script type="text/javascript" src="dynsections.js"></script>
13 <link href="navtree.css" rel="stylesheet" type="text/css"/>
14 <script type="text/javascript" src="resize.js"></script>
15 <script type="text/javascript" src="navtreedata.js"></script>
16 <script type="text/javascript" src="navtree.js"></script>
17 <script type="text/javascript">
18   $(document).ready(initResizable);
19   $(window).load(resizeHeight);
20 </script>
21 <link href="search/search.css" rel="stylesheet" type="text/css"/>
22 <script type="text/javascript" src="search/searchdata.js"></script>
23 <script type="text/javascript" src="search/search.js"></script>
24 <script type="text/javascript">
25   $(document).ready(function() { init_search(); });
26 </script>
27 <script type="text/x-mathjax-config">
28   MathJax.Hub.Config({
29     extensions: ["tex2jax.js"],
30     jax: ["input/TeX","output/HTML-CSS"],
31 });
32 </script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
33 <link href="doxygen.css" rel="stylesheet" type="text/css" />
34 </head>
35 <body>
36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
37 <div id="titlearea">
38 <table cellspacing="0" cellpadding="0">
39  <tbody>
40  <tr style="height: 56px;">
41   <td style="padding-left: 0.5em;">
42    <div id="projectname">ARM Compute Library
43    &#160;<span id="projectnumber">17.04</span>
44    </div>
45   </td>
46  </tr>
47  </tbody>
48 </table>
49 </div>
50 <!-- end header part -->
51 <!-- Generated by Doxygen 1.8.11 -->
52 <script type="text/javascript">
53 var searchBox = new SearchBox("searchBox", "search",false,'Search');
54 </script>
55   <div id="navrow1" class="tabs">
56     <ul class="tablist">
57       <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
58       <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
59       <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
60       <li><a href="files.xhtml"><span>Files</span></a></li>
61       <li>
62         <div id="MSearchBox" class="MSearchBoxInactive">
63         <span class="left">
64           <img id="MSearchSelect" src="search/mag_sel.png"
65                onmouseover="return searchBox.OnSearchSelectShow()"
66                onmouseout="return searchBox.OnSearchSelectHide()"
67                alt=""/>
68           <input type="text" id="MSearchField" value="Search" accesskey="S"
69                onfocus="searchBox.OnSearchFieldFocus(true)" 
70                onblur="searchBox.OnSearchFieldFocus(false)" 
71                onkeyup="searchBox.OnSearchFieldChange(event)"/>
72           </span><span class="right">
73             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
74           </span>
75         </div>
76       </li>
77     </ul>
78   </div>
79   <div id="navrow2" class="tabs2">
80     <ul class="tablist">
81       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
82       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
83       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
84       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
85     </ul>
86   </div>
87 </div><!-- top -->
88 <div id="side-nav" class="ui-resizable side-nav-resizable">
89   <div id="nav-tree">
90     <div id="nav-tree-contents">
91       <div id="nav-sync" class="sync"></div>
92     </div>
93   </div>
94   <div id="splitbar" style="-moz-user-select:none;" 
95        class="ui-resizable-handle">
96   </div>
97 </div>
98 <script type="text/javascript">
99 $(document).ready(function(){initNavTree('classarm__compute_1_1_n_e_derivative_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">NEDerivativeKernel Class Reference</div>  </div>
121 </div><!--header-->
122 <div class="contents">
123
124 <p>Interface for the kernel to run the derivative along the X/Y directions on a tensor.  
125  <a href="classarm__compute_1_1_n_e_derivative_kernel.xhtml#details">More...</a></p>
126
127 <p><code>#include &lt;<a class="el" href="_n_e_derivative_kernel_8h_source.xhtml">NEDerivativeKernel.h</a>&gt;</code></p>
128 <div class="dynheader">
129 Collaboration diagram for NEDerivativeKernel:</div>
130 <div class="dyncontent">
131 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_n_e_derivative_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>
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:ac317d66b746c86ea136eb7996c897b22"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_derivative_kernel.xhtml#ac317d66b746c86ea136eb7996c897b22">NEDerivativeKernel</a> ()</td></tr>
138 <tr class="memdesc:ac317d66b746c86ea136eb7996c897b22"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#ac317d66b746c86ea136eb7996c897b22">More...</a><br /></td></tr>
139 <tr class="separator:ac317d66b746c86ea136eb7996c897b22"><td class="memSeparator" colspan="2">&#160;</td></tr>
140 <tr class="memitem:a5671321aaea1731625d5953158a6372f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_derivative_kernel.xhtml#a5671321aaea1731625d5953158a6372f">NEDerivativeKernel</a> (const <a class="el" href="classarm__compute_1_1_n_e_derivative_kernel.xhtml">NEDerivativeKernel</a> &amp;)=delete</td></tr>
141 <tr class="memdesc:a5671321aaea1731625d5953158a6372f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#a5671321aaea1731625d5953158a6372f">More...</a><br /></td></tr>
142 <tr class="separator:a5671321aaea1731625d5953158a6372f"><td class="memSeparator" colspan="2">&#160;</td></tr>
143 <tr class="memitem:a11f5eb3a93c035acdd9fd93f3bed50bd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_n_e_derivative_kernel.xhtml">NEDerivativeKernel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_derivative_kernel.xhtml#a11f5eb3a93c035acdd9fd93f3bed50bd">operator=</a> (const <a class="el" href="classarm__compute_1_1_n_e_derivative_kernel.xhtml">NEDerivativeKernel</a> &amp;)=delete</td></tr>
144 <tr class="memdesc:a11f5eb3a93c035acdd9fd93f3bed50bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#a11f5eb3a93c035acdd9fd93f3bed50bd">More...</a><br /></td></tr>
145 <tr class="separator:a11f5eb3a93c035acdd9fd93f3bed50bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
146 <tr class="memitem:ab2ba54354bba65ac3915b196dfd169ef"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_derivative_kernel.xhtml#ab2ba54354bba65ac3915b196dfd169ef">NEDerivativeKernel</a> (<a class="el" href="classarm__compute_1_1_n_e_derivative_kernel.xhtml">NEDerivativeKernel</a> &amp;&amp;)=default</td></tr>
147 <tr class="memdesc:ab2ba54354bba65ac3915b196dfd169ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#ab2ba54354bba65ac3915b196dfd169ef">More...</a><br /></td></tr>
148 <tr class="separator:ab2ba54354bba65ac3915b196dfd169ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
149 <tr class="memitem:ac23fff6afb2efca3962209a494931591"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_n_e_derivative_kernel.xhtml">NEDerivativeKernel</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_derivative_kernel.xhtml#ac23fff6afb2efca3962209a494931591">operator=</a> (<a class="el" href="classarm__compute_1_1_n_e_derivative_kernel.xhtml">NEDerivativeKernel</a> &amp;&amp;)=default</td></tr>
150 <tr class="memdesc:ac23fff6afb2efca3962209a494931591"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#ac23fff6afb2efca3962209a494931591">More...</a><br /></td></tr>
151 <tr class="separator:ac23fff6afb2efca3962209a494931591"><td class="memSeparator" colspan="2">&#160;</td></tr>
152 <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_derivative_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>
153 <tr class="memdesc:ace7523f9c3073ad82b77e46318a1ea77"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise the kernel's sources, destination and border.  <a href="#ace7523f9c3073ad82b77e46318a1ea77">More...</a><br /></td></tr>
154 <tr class="separator:ace7523f9c3073ad82b77e46318a1ea77"><td class="memSeparator" colspan="2">&#160;</td></tr>
155 <tr class="memitem:a8fd12b95bdde3f93db96bc9b1598db69"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_n_e_derivative_kernel.xhtml#a8fd12b95bdde3f93db96bc9b1598db69">run</a> (const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;<a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353">window</a>) override</td></tr>
156 <tr class="memdesc:a8fd12b95bdde3f93db96bc9b1598db69"><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute the kernel on the passed window.  <a href="#a8fd12b95bdde3f93db96bc9b1598db69">More...</a><br /></td></tr>
157 <tr class="separator:a8fd12b95bdde3f93db96bc9b1598db69"><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_n_e_derivative_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_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>
162 <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>
163 <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>
164 <tr class="separator:a033d17a97e07cea7fe83eefcf23540f6 inherit pub_methods_classarm__compute_1_1_i_c_p_p_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
165 <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>
166 <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>
167 <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>
168 <tr class="separator:a7250cb8cbaa4104a93a2d77155085507 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
169 <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>
170 <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>
171 <tr class="separator:a341b60d15a5e12a5b8f3825194dd3b12 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
172 <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>
173 <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>
174 <tr class="separator:abfab8f0d4928e1081d9f65b77933e24a inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
175 <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>
176 <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>
177 <tr class="separator:a3f5646133956f06348b310ccc3d36353 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2">&#160;</td></tr>
178 </table>
179 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
180 <div class="textblock"><p>Interface for the kernel to run the derivative along the X/Y directions on a tensor. </p>
181
182 <p>Definition at line <a class="el" href="_n_e_derivative_kernel_8h_source.xhtml#l00036">36</a> of file <a class="el" href="_n_e_derivative_kernel_8h_source.xhtml">NEDerivativeKernel.h</a>.</p>
183 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
184 <a class="anchor" id="ac317d66b746c86ea136eb7996c897b22"></a>
185 <div class="memitem">
186 <div class="memproto">
187       <table class="memname">
188         <tr>
189           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_derivative_kernel.xhtml">NEDerivativeKernel</a> </td>
190           <td>(</td>
191           <td class="paramname"></td><td>)</td>
192           <td></td>
193         </tr>
194       </table>
195 </div><div class="memdoc">
196
197 <p>Default constructor. </p>
198
199 </div>
200 </div>
201 <a class="anchor" id="a5671321aaea1731625d5953158a6372f"></a>
202 <div class="memitem">
203 <div class="memproto">
204 <table class="mlabels">
205   <tr>
206   <td class="mlabels-left">
207       <table class="memname">
208         <tr>
209           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_derivative_kernel.xhtml">NEDerivativeKernel</a> </td>
210           <td>(</td>
211           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_n_e_derivative_kernel.xhtml">NEDerivativeKernel</a> &amp;&#160;</td>
212           <td class="paramname"></td><td>)</td>
213           <td></td>
214         </tr>
215       </table>
216   </td>
217   <td class="mlabels-right">
218 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
219   </tr>
220 </table>
221 </div><div class="memdoc">
222
223 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
224
225 </div>
226 </div>
227 <a class="anchor" id="ab2ba54354bba65ac3915b196dfd169ef"></a>
228 <div class="memitem">
229 <div class="memproto">
230 <table class="mlabels">
231   <tr>
232   <td class="mlabels-left">
233       <table class="memname">
234         <tr>
235           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_derivative_kernel.xhtml">NEDerivativeKernel</a> </td>
236           <td>(</td>
237           <td class="paramtype"><a class="el" href="classarm__compute_1_1_n_e_derivative_kernel.xhtml">NEDerivativeKernel</a> &amp;&amp;&#160;</td>
238           <td class="paramname"></td><td>)</td>
239           <td></td>
240         </tr>
241       </table>
242   </td>
243   <td class="mlabels-right">
244 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
245   </tr>
246 </table>
247 </div><div class="memdoc">
248
249 <p>Allow instances of this class to be moved. </p>
250
251 </div>
252 </div>
253 <h2 class="groupheader">Member Function Documentation</h2>
254 <a class="anchor" id="a423f9a45a52983b4de5e2b347f4369c7"></a>
255 <div class="memitem">
256 <div class="memproto">
257 <table class="mlabels">
258   <tr>
259   <td class="mlabels-left">
260       <table class="memname">
261         <tr>
262           <td class="memname"><a class="el" href="structarm__compute_1_1_border_size.xhtml">BorderSize</a> border_size </td>
263           <td>(</td>
264           <td class="paramname"></td><td>)</td>
265           <td> const</td>
266         </tr>
267       </table>
268   </td>
269   <td class="mlabels-right">
270 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
271   </tr>
272 </table>
273 </div><div class="memdoc">
274
275 <p>The size of the border for that kernel. </p>
276 <dl class="section return"><dt>Returns</dt><dd>The width in number of elements of the border. </dd></dl>
277
278 <p>Reimplemented from <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#aa6daa9b04e2035bf007e5e5c3c4396a8">IKernel</a>.</p>
279
280 </div>
281 </div>
282 <a class="anchor" id="ace7523f9c3073ad82b77e46318a1ea77"></a>
283 <div class="memitem">
284 <div class="memproto">
285       <table class="memname">
286         <tr>
287           <td class="memname">void configure </td>
288           <td>(</td>
289           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
290           <td class="paramname"><em>input</em>, </td>
291         </tr>
292         <tr>
293           <td class="paramkey"></td>
294           <td></td>
295           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
296           <td class="paramname"><em>output_x</em>, </td>
297         </tr>
298         <tr>
299           <td class="paramkey"></td>
300           <td></td>
301           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_tensor.xhtml">ITensor</a> *&#160;</td>
302           <td class="paramname"><em>output_y</em>, </td>
303         </tr>
304         <tr>
305           <td class="paramkey"></td>
306           <td></td>
307           <td class="paramtype">bool&#160;</td>
308           <td class="paramname"><em>border_undefined</em>&#160;</td>
309         </tr>
310         <tr>
311           <td></td>
312           <td>)</td>
313           <td></td><td></td>
314         </tr>
315       </table>
316 </div><div class="memdoc">
317
318 <p>Initialise the kernel's sources, destination and border. </p>
319 <dl class="section note"><dt>Note</dt><dd>At least one of output_x or output_y must be set</dd></dl>
320 <dl class="params"><dt>Parameters</dt><dd>
321   <table class="params">
322     <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>Source tensor. Data type supported: U8. </td></tr>
323     <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>
324     <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>
325     <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>
326   </table>
327   </dd>
328 </dl>
329
330 </div>
331 </div>
332 <a class="anchor" id="a11f5eb3a93c035acdd9fd93f3bed50bd"></a>
333 <div class="memitem">
334 <div class="memproto">
335 <table class="mlabels">
336   <tr>
337   <td class="mlabels-left">
338       <table class="memname">
339         <tr>
340           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_derivative_kernel.xhtml">NEDerivativeKernel</a>&amp; operator= </td>
341           <td>(</td>
342           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_n_e_derivative_kernel.xhtml">NEDerivativeKernel</a> &amp;&#160;</td>
343           <td class="paramname"></td><td>)</td>
344           <td></td>
345         </tr>
346       </table>
347   </td>
348   <td class="mlabels-right">
349 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
350   </tr>
351 </table>
352 </div><div class="memdoc">
353
354 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
355
356 </div>
357 </div>
358 <a class="anchor" id="ac23fff6afb2efca3962209a494931591"></a>
359 <div class="memitem">
360 <div class="memproto">
361 <table class="mlabels">
362   <tr>
363   <td class="mlabels-left">
364       <table class="memname">
365         <tr>
366           <td class="memname"><a class="el" href="classarm__compute_1_1_n_e_derivative_kernel.xhtml">NEDerivativeKernel</a>&amp; operator= </td>
367           <td>(</td>
368           <td class="paramtype"><a class="el" href="classarm__compute_1_1_n_e_derivative_kernel.xhtml">NEDerivativeKernel</a> &amp;&amp;&#160;</td>
369           <td class="paramname"></td><td>)</td>
370           <td></td>
371         </tr>
372       </table>
373   </td>
374   <td class="mlabels-right">
375 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
376   </tr>
377 </table>
378 </div><div class="memdoc">
379
380 <p>Allow instances of this class to be moved. </p>
381
382 </div>
383 </div>
384 <a class="anchor" id="a8fd12b95bdde3f93db96bc9b1598db69"></a>
385 <div class="memitem">
386 <div class="memproto">
387 <table class="mlabels">
388   <tr>
389   <td class="mlabels-left">
390       <table class="memname">
391         <tr>
392           <td class="memname">void run </td>
393           <td>(</td>
394           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> &amp;&#160;</td>
395           <td class="paramname"><em>window</em></td><td>)</td>
396           <td></td>
397         </tr>
398       </table>
399   </td>
400   <td class="mlabels-right">
401 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
402   </tr>
403 </table>
404 </div><div class="memdoc">
405
406 <p>Execute the kernel on the passed window. </p>
407 <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>
408 <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>
409 <dd>
410 The width of the window has to be a multiple of num_elems_processed_per_iteration().</dd></dl>
411 <dl class="params"><dt>Parameters</dt><dd>
412   <table class="params">
413     <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>
414   </table>
415   </dd>
416 </dl>
417
418 <p>Implements <a class="el" href="classarm__compute_1_1_i_c_p_p_kernel.xhtml#a6f56c8bb44166634652b877d6eb7a9a2">ICPPKernel</a>.</p>
419
420 </div>
421 </div>
422 <hr/>The documentation for this class was generated from the following file:<ul>
423 <li>arm_compute/core/NEON/kernels/<a class="el" href="_n_e_derivative_kernel_8h_source.xhtml">NEDerivativeKernel.h</a></li>
424 </ul>
425 </div><!-- contents -->
426 </div><!-- doc-content -->
427 <!-- start footer part -->
428 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
429   <ul>
430     <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_derivative_kernel.xhtml">NEDerivativeKernel</a></li>
431     <li class="footer">Generated on Wed Apr 12 2017 14:26:06 for ARM Compute Library by
432     <a href="http://www.doxygen.org/index.html">
433     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
434   </ul>
435 </div>
436 </body>
437 </html>