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: CLDerivativeKernel 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.03.1</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_c_l_derivative_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">CLDerivativeKernel Class Reference</div> </div>
122 <div class="contents">
124 <p>Interface for the derivative kernel.
125 <a href="classarm__compute_1_1_c_l_derivative_kernel.xhtml#details">More...</a></p>
127 <p><code>#include <<a class="el" href="_c_l_derivative_kernel_8h_source.xhtml">CLDerivativeKernel.h</a>></code></p>
128 <div class="dynheader">
129 Collaboration diagram for CLDerivativeKernel:</div>
130 <div class="dyncontent">
131 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_c_l_derivative_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>
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:a70712b2131aad30e1abd393799c6fa25"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_derivative_kernel.xhtml#a70712b2131aad30e1abd393799c6fa25">CLDerivativeKernel</a> ()</td></tr>
138 <tr class="memdesc:a70712b2131aad30e1abd393799c6fa25"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a70712b2131aad30e1abd393799c6fa25">More...</a><br /></td></tr>
139 <tr class="separator:a70712b2131aad30e1abd393799c6fa25"><td class="memSeparator" colspan="2"> </td></tr>
140 <tr class="memitem:a772202e263f323ab3f5c6e1066e0e4f9"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_derivative_kernel.xhtml#a772202e263f323ab3f5c6e1066e0e4f9">CLDerivativeKernel</a> (const <a class="el" href="classarm__compute_1_1_c_l_derivative_kernel.xhtml">CLDerivativeKernel</a> &)=delete</td></tr>
141 <tr class="memdesc:a772202e263f323ab3f5c6e1066e0e4f9"><td class="mdescLeft"> </td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers). <a href="#a772202e263f323ab3f5c6e1066e0e4f9">More...</a><br /></td></tr>
142 <tr class="separator:a772202e263f323ab3f5c6e1066e0e4f9"><td class="memSeparator" colspan="2"> </td></tr>
143 <tr class="memitem:a3ef5b9e1c310e83a57980bb4f897283a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_c_l_derivative_kernel.xhtml">CLDerivativeKernel</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_derivative_kernel.xhtml#a3ef5b9e1c310e83a57980bb4f897283a">operator=</a> (const <a class="el" href="classarm__compute_1_1_c_l_derivative_kernel.xhtml">CLDerivativeKernel</a> &)=delete</td></tr>
144 <tr class="memdesc:a3ef5b9e1c310e83a57980bb4f897283a"><td class="mdescLeft"> </td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers). <a href="#a3ef5b9e1c310e83a57980bb4f897283a">More...</a><br /></td></tr>
145 <tr class="separator:a3ef5b9e1c310e83a57980bb4f897283a"><td class="memSeparator" colspan="2"> </td></tr>
146 <tr class="memitem:ac3a2c95536dfbe4ea71e3c1441cd2960"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_derivative_kernel.xhtml#ac3a2c95536dfbe4ea71e3c1441cd2960">CLDerivativeKernel</a> (<a class="el" href="classarm__compute_1_1_c_l_derivative_kernel.xhtml">CLDerivativeKernel</a> &&)=default</td></tr>
147 <tr class="memdesc:ac3a2c95536dfbe4ea71e3c1441cd2960"><td class="mdescLeft"> </td><td class="mdescRight">Allow instances of this class to be moved. <a href="#ac3a2c95536dfbe4ea71e3c1441cd2960">More...</a><br /></td></tr>
148 <tr class="separator:ac3a2c95536dfbe4ea71e3c1441cd2960"><td class="memSeparator" colspan="2"> </td></tr>
149 <tr class="memitem:aceb0191986422c3fcc97f2e9ed9fe15c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_c_l_derivative_kernel.xhtml">CLDerivativeKernel</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_derivative_kernel.xhtml#aceb0191986422c3fcc97f2e9ed9fe15c">operator=</a> (<a class="el" href="classarm__compute_1_1_c_l_derivative_kernel.xhtml">CLDerivativeKernel</a> &&)=default</td></tr>
150 <tr class="memdesc:aceb0191986422c3fcc97f2e9ed9fe15c"><td class="mdescLeft"> </td><td class="mdescRight">Allow instances of this class to be moved. <a href="#aceb0191986422c3fcc97f2e9ed9fe15c">More...</a><br /></td></tr>
151 <tr class="separator:aceb0191986422c3fcc97f2e9ed9fe15c"><td class="memSeparator" colspan="2"> </td></tr>
152 <tr class="memitem:a83d38310c15f7b92264b5403ddd0bbda"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_derivative_kernel.xhtml#a83d38310c15f7b92264b5403ddd0bbda">~CLDerivativeKernel</a> ()=default</td></tr>
153 <tr class="memdesc:a83d38310c15f7b92264b5403ddd0bbda"><td class="mdescLeft"> </td><td class="mdescRight">Default destructor. <a href="#a83d38310c15f7b92264b5403ddd0bbda">More...</a><br /></td></tr>
154 <tr class="separator:a83d38310c15f7b92264b5403ddd0bbda"><td class="memSeparator" colspan="2"> </td></tr>
155 <tr class="memitem:ab24f49526202babfe7df925cd326427b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_derivative_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>
156 <tr class="memdesc:ab24f49526202babfe7df925cd326427b"><td class="mdescLeft"> </td><td class="mdescRight">Initialise the kernel's sources, destination and border. <a href="#ab24f49526202babfe7df925cd326427b">More...</a><br /></td></tr>
157 <tr class="separator:ab24f49526202babfe7df925cd326427b"><td class="memSeparator" colspan="2"> </td></tr>
158 <tr class="memitem:a493987e85723a8000eb26d1f00e2ad0e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_derivative_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">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>, cl::CommandQueue &queue) override</td></tr>
159 <tr class="memdesc:a493987e85723a8000eb26d1f00e2ad0e"><td class="mdescLeft"> </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>
160 <tr class="separator:a493987e85723a8000eb26d1f00e2ad0e"><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_c_l_derivative_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_l_kernel"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_c_l_kernel')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml">ICLKernel</a></td></tr>
165 <tr class="memitem:a6b10e96ce90bf901d17def86b874b019 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml#a6b10e96ce90bf901d17def86b874b019">ICLKernel</a> ()</td></tr>
166 <tr class="memdesc:a6b10e96ce90bf901d17def86b874b019 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a6b10e96ce90bf901d17def86b874b019">More...</a><br /></td></tr>
167 <tr class="separator:a6b10e96ce90bf901d17def86b874b019 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memSeparator" colspan="2"> </td></tr>
168 <tr class="memitem:ae5121015ab09ece4d470f50c7ffe198e inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memItemLeft" align="right" valign="top">cl::Kernel & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml#ae5121015ab09ece4d470f50c7ffe198e">kernel</a> ()</td></tr>
169 <tr class="memdesc:ae5121015ab09ece4d470f50c7ffe198e inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="mdescLeft"> </td><td class="mdescRight">Returns a reference to the OpenCL kernel of this object. <a href="#ae5121015ab09ece4d470f50c7ffe198e">More...</a><br /></td></tr>
170 <tr class="separator:ae5121015ab09ece4d470f50c7ffe198e inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memSeparator" colspan="2"> </td></tr>
171 <tr class="memitem:a479e7043e65dc87de35d374e108510f7 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memItemLeft" align="right" valign="top">void </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 &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> &<a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353">window</a>)</td></tr>
172 <tr class="memdesc:a479e7043e65dc87de35d374e108510f7 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="mdescLeft"> </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>
173 <tr class="separator:a479e7043e65dc87de35d374e108510f7 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memSeparator" colspan="2"> </td></tr>
174 <tr class="memitem:ac74dad3e61f79334f5e73f3c3ac603cb inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memItemLeft" align="right" valign="top">void </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 &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> &<a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353">window</a>)</td></tr>
175 <tr class="memdesc:ac74dad3e61f79334f5e73f3c3ac603cb inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="mdescLeft"> </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>
176 <tr class="separator:ac74dad3e61f79334f5e73f3c3ac603cb inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memSeparator" colspan="2"> </td></tr>
177 <tr class="memitem:a28f5847162f352444c6ac1825d0e99c7 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memItemLeft" align="right" valign="top">void </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 &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> &<a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353">window</a>)</td></tr>
178 <tr class="memdesc:a28f5847162f352444c6ac1825d0e99c7 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="mdescLeft"> </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>
179 <tr class="separator:a28f5847162f352444c6ac1825d0e99c7 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memSeparator" colspan="2"> </td></tr>
180 <tr class="memitem:a770f45838881fc061294e56d64f34386 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memItemLeft" align="right" valign="top">unsigned int </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>
181 <tr class="memdesc:a770f45838881fc061294e56d64f34386 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of arguments enqueued per 1D tensor object. <a href="#a770f45838881fc061294e56d64f34386">More...</a><br /></td></tr>
182 <tr class="separator:a770f45838881fc061294e56d64f34386 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memSeparator" colspan="2"> </td></tr>
183 <tr class="memitem:ac734502531e7f95e25b3bf688a304a59 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memItemLeft" align="right" valign="top">unsigned int </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>
184 <tr class="memdesc:ac734502531e7f95e25b3bf688a304a59 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of arguments enqueued per 2D tensor object. <a href="#ac734502531e7f95e25b3bf688a304a59">More...</a><br /></td></tr>
185 <tr class="separator:ac734502531e7f95e25b3bf688a304a59 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memSeparator" colspan="2"> </td></tr>
186 <tr class="memitem:a4feaae9c860cddfa843d37c953674a22 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memItemLeft" align="right" valign="top">unsigned int </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>
187 <tr class="memdesc:a4feaae9c860cddfa843d37c953674a22 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of arguments enqueued per 3D tensor object. <a href="#a4feaae9c860cddfa843d37c953674a22">More...</a><br /></td></tr>
188 <tr class="separator:a4feaae9c860cddfa843d37c953674a22 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memSeparator" colspan="2"> </td></tr>
189 <tr class="memitem:a50f427a1d9419800972b9e03c4034311 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
190 <tr class="memitem:a50f427a1d9419800972b9e03c4034311 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memTemplItemLeft" align="right" valign="top">void </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 &idx, T value)</td></tr>
191 <tr class="memdesc:a50f427a1d9419800972b9e03c4034311 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="mdescLeft"> </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>
192 <tr class="separator:a50f427a1d9419800972b9e03c4034311 inherit pub_methods_classarm__compute_1_1_i_c_l_kernel"><td class="memSeparator" colspan="2"> </td></tr>
193 <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>
194 <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>
195 <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>
196 <tr class="separator:a7250cb8cbaa4104a93a2d77155085507 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2"> </td></tr>
197 <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>
198 <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>
199 <tr class="separator:a341b60d15a5e12a5b8f3825194dd3b12 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2"> </td></tr>
200 <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>
201 <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>
202 <tr class="separator:abfab8f0d4928e1081d9f65b77933e24a inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2"> </td></tr>
203 <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>
204 <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>
205 <tr class="separator:a3f5646133956f06348b310ccc3d36353 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2"> </td></tr>
207 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
208 <div class="textblock"><p>Interface for the derivative kernel. </p>
210 <p>Definition at line <a class="el" href="_c_l_derivative_kernel_8h_source.xhtml#l00034">34</a> of file <a class="el" href="_c_l_derivative_kernel_8h_source.xhtml">CLDerivativeKernel.h</a>.</p>
211 </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
212 <a class="anchor" id="a70712b2131aad30e1abd393799c6fa25"></a>
213 <div class="memitem">
214 <div class="memproto">
215 <table class="memname">
217 <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_derivative_kernel.xhtml">CLDerivativeKernel</a> </td>
219 <td class="paramname"></td><td>)</td>
223 </div><div class="memdoc">
225 <p>Default constructor. </p>
229 <a class="anchor" id="a772202e263f323ab3f5c6e1066e0e4f9"></a>
230 <div class="memitem">
231 <div class="memproto">
232 <table class="mlabels">
234 <td class="mlabels-left">
235 <table class="memname">
237 <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_derivative_kernel.xhtml">CLDerivativeKernel</a> </td>
239 <td class="paramtype">const <a class="el" href="classarm__compute_1_1_c_l_derivative_kernel.xhtml">CLDerivativeKernel</a> & </td>
240 <td class="paramname"></td><td>)</td>
245 <td class="mlabels-right">
246 <span class="mlabels"><span class="mlabel">delete</span></span> </td>
249 </div><div class="memdoc">
251 <p>Prevent instances of this class from being copied (As this class contains pointers). </p>
255 <a class="anchor" id="ac3a2c95536dfbe4ea71e3c1441cd2960"></a>
256 <div class="memitem">
257 <div class="memproto">
258 <table class="mlabels">
260 <td class="mlabels-left">
261 <table class="memname">
263 <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_derivative_kernel.xhtml">CLDerivativeKernel</a> </td>
265 <td class="paramtype"><a class="el" href="classarm__compute_1_1_c_l_derivative_kernel.xhtml">CLDerivativeKernel</a> && </td>
266 <td class="paramname"></td><td>)</td>
271 <td class="mlabels-right">
272 <span class="mlabels"><span class="mlabel">default</span></span> </td>
275 </div><div class="memdoc">
277 <p>Allow instances of this class to be moved. </p>
281 <a class="anchor" id="a83d38310c15f7b92264b5403ddd0bbda"></a>
282 <div class="memitem">
283 <div class="memproto">
284 <table class="mlabels">
286 <td class="mlabels-left">
287 <table class="memname">
289 <td class="memname">~<a class="el" href="classarm__compute_1_1_c_l_derivative_kernel.xhtml">CLDerivativeKernel</a> </td>
291 <td class="paramname"></td><td>)</td>
296 <td class="mlabels-right">
297 <span class="mlabels"><span class="mlabel">default</span></span> </td>
300 </div><div class="memdoc">
302 <p>Default destructor. </p>
306 <h2 class="groupheader">Member Function Documentation</h2>
307 <a class="anchor" id="a423f9a45a52983b4de5e2b347f4369c7"></a>
308 <div class="memitem">
309 <div class="memproto">
310 <table class="mlabels">
312 <td class="mlabels-left">
313 <table class="memname">
315 <td class="memname"><a class="el" href="structarm__compute_1_1_border_size.xhtml">BorderSize</a> border_size </td>
317 <td class="paramname"></td><td>)</td>
322 <td class="mlabels-right">
323 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
326 </div><div class="memdoc">
328 <p>The size of the border for that kernel. </p>
329 <dl class="section return"><dt>Returns</dt><dd>The width in number of elements of the border. </dd></dl>
331 <p>Reimplemented from <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#aa6daa9b04e2035bf007e5e5c3c4396a8">IKernel</a>.</p>
335 <a class="anchor" id="ab24f49526202babfe7df925cd326427b"></a>
336 <div class="memitem">
337 <div class="memproto">
338 <table class="memname">
340 <td class="memname">void configure </td>
342 <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> * </td>
343 <td class="paramname"><em>input</em>, </td>
346 <td class="paramkey"></td>
348 <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> * </td>
349 <td class="paramname"><em>output_x</em>, </td>
352 <td class="paramkey"></td>
354 <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> * </td>
355 <td class="paramname"><em>output_y</em>, </td>
358 <td class="paramkey"></td>
360 <td class="paramtype">bool </td>
361 <td class="paramname"><em>border_undefined</em> </td>
369 </div><div class="memdoc">
371 <p>Initialise the kernel's sources, destination and border. </p>
372 <dl class="section note"><dt>Note</dt><dd>At least one of output_x or output_y must be set</dd></dl>
373 <dl class="params"><dt>Parameters</dt><dd>
374 <table class="params">
375 <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>Source tensor. Data types supported: U8. </td></tr>
376 <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>
377 <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>
378 <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>
385 <a class="anchor" id="a3ef5b9e1c310e83a57980bb4f897283a"></a>
386 <div class="memitem">
387 <div class="memproto">
388 <table class="mlabels">
390 <td class="mlabels-left">
391 <table class="memname">
393 <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_derivative_kernel.xhtml">CLDerivativeKernel</a>& operator= </td>
395 <td class="paramtype">const <a class="el" href="classarm__compute_1_1_c_l_derivative_kernel.xhtml">CLDerivativeKernel</a> & </td>
396 <td class="paramname"></td><td>)</td>
401 <td class="mlabels-right">
402 <span class="mlabels"><span class="mlabel">delete</span></span> </td>
405 </div><div class="memdoc">
407 <p>Prevent instances of this class from being copied (As this class contains pointers). </p>
411 <a class="anchor" id="aceb0191986422c3fcc97f2e9ed9fe15c"></a>
412 <div class="memitem">
413 <div class="memproto">
414 <table class="mlabels">
416 <td class="mlabels-left">
417 <table class="memname">
419 <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_derivative_kernel.xhtml">CLDerivativeKernel</a>& operator= </td>
421 <td class="paramtype"><a class="el" href="classarm__compute_1_1_c_l_derivative_kernel.xhtml">CLDerivativeKernel</a> && </td>
422 <td class="paramname"></td><td>)</td>
427 <td class="mlabels-right">
428 <span class="mlabels"><span class="mlabel">default</span></span> </td>
431 </div><div class="memdoc">
433 <p>Allow instances of this class to be moved. </p>
437 <a class="anchor" id="a493987e85723a8000eb26d1f00e2ad0e"></a>
438 <div class="memitem">
439 <div class="memproto">
440 <table class="mlabels">
442 <td class="mlabels-left">
443 <table class="memname">
445 <td class="memname">void run </td>
447 <td class="paramtype">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> & </td>
448 <td class="paramname"><em>window</em>, </td>
451 <td class="paramkey"></td>
453 <td class="paramtype">cl::CommandQueue & </td>
454 <td class="paramname"><em>queue</em> </td>
463 <td class="mlabels-right">
464 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
467 </div><div class="memdoc">
469 <p>Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue. </p>
470 <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>
471 <dl class="params"><dt>Parameters</dt><dd>
472 <table class="params">
473 <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>
474 <tr><td class="paramdir">[in,out]</td><td class="paramname">queue</td><td>Command queue on which to enqueue the kernel. </td></tr>
479 <p>Implements <a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml#af6a174d47571f51f199ffc27ecc10f51">ICLKernel</a>.</p>
483 <hr/>The documentation for this class was generated from the following file:<ul>
484 <li>arm_compute/core/CL/kernels/<a class="el" href="_c_l_derivative_kernel_8h_source.xhtml">CLDerivativeKernel.h</a></li>
486 </div><!-- contents -->
487 </div><!-- doc-content -->
488 <!-- start footer part -->
489 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
491 <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_derivative_kernel.xhtml">CLDerivativeKernel</a></li>
492 <li class="footer">Generated on Fri Mar 24 2017 17:23:50 for ARM Compute Library by
493 <a href="http://www.doxygen.org/index.html">
494 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>