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: ICLKernel 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_i_c_l_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">ICLKernel Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
122 <div class="contents">
124 <p>Common interface for all the OpenCL kernels.
125 <a href="classarm__compute_1_1_i_c_l_kernel.xhtml#details">More...</a></p>
127 <p><code>#include <<a class="el" href="_i_c_l_kernel_8h_source.xhtml">ICLKernel.h</a>></code></p>
128 <div class="dynheader">
129 Collaboration diagram for ICLKernel:</div>
130 <div class="dyncontent">
131 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_i_c_l_kernel__coll__graph.svg" width="91" height="112"><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:a6b10e96ce90bf901d17def86b874b019"><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>
138 <tr class="memdesc:a6b10e96ce90bf901d17def86b874b019"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a6b10e96ce90bf901d17def86b874b019">More...</a><br /></td></tr>
139 <tr class="separator:a6b10e96ce90bf901d17def86b874b019"><td class="memSeparator" colspan="2"> </td></tr>
140 <tr class="memitem:ae5121015ab09ece4d470f50c7ffe198e"><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>
141 <tr class="memdesc:ae5121015ab09ece4d470f50c7ffe198e"><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>
142 <tr class="separator:ae5121015ab09ece4d470f50c7ffe198e"><td class="memSeparator" colspan="2"> </td></tr>
143 <tr class="memitem:a479e7043e65dc87de35d374e108510f7"><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>
144 <tr class="memdesc:a479e7043e65dc87de35d374e108510f7"><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>
145 <tr class="separator:a479e7043e65dc87de35d374e108510f7"><td class="memSeparator" colspan="2"> </td></tr>
146 <tr class="memitem:ac74dad3e61f79334f5e73f3c3ac603cb"><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>
147 <tr class="memdesc:ac74dad3e61f79334f5e73f3c3ac603cb"><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>
148 <tr class="separator:ac74dad3e61f79334f5e73f3c3ac603cb"><td class="memSeparator" colspan="2"> </td></tr>
149 <tr class="memitem:a28f5847162f352444c6ac1825d0e99c7"><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>
150 <tr class="memdesc:a28f5847162f352444c6ac1825d0e99c7"><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>
151 <tr class="separator:a28f5847162f352444c6ac1825d0e99c7"><td class="memSeparator" colspan="2"> </td></tr>
152 <tr class="memitem:a770f45838881fc061294e56d64f34386"><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>
153 <tr class="memdesc:a770f45838881fc061294e56d64f34386"><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>
154 <tr class="separator:a770f45838881fc061294e56d64f34386"><td class="memSeparator" colspan="2"> </td></tr>
155 <tr class="memitem:ac734502531e7f95e25b3bf688a304a59"><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>
156 <tr class="memdesc:ac734502531e7f95e25b3bf688a304a59"><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>
157 <tr class="separator:ac734502531e7f95e25b3bf688a304a59"><td class="memSeparator" colspan="2"> </td></tr>
158 <tr class="memitem:a4feaae9c860cddfa843d37c953674a22"><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>
159 <tr class="memdesc:a4feaae9c860cddfa843d37c953674a22"><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>
160 <tr class="separator:a4feaae9c860cddfa843d37c953674a22"><td class="memSeparator" colspan="2"> </td></tr>
161 <tr class="memitem:af6a174d47571f51f199ffc27ecc10f51"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml#af6a174d47571f51f199ffc27ecc10f51">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)=0</td></tr>
162 <tr class="memdesc:af6a174d47571f51f199ffc27ecc10f51"><td class="mdescLeft"> </td><td class="mdescRight">Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue. <a href="#af6a174d47571f51f199ffc27ecc10f51">More...</a><br /></td></tr>
163 <tr class="separator:af6a174d47571f51f199ffc27ecc10f51"><td class="memSeparator" colspan="2"> </td></tr>
164 <tr class="memitem:a50f427a1d9419800972b9e03c4034311"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
165 <tr class="memitem:a50f427a1d9419800972b9e03c4034311"><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>
166 <tr class="memdesc:a50f427a1d9419800972b9e03c4034311"><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>
167 <tr class="separator:a50f427a1d9419800972b9e03c4034311"><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:aa6daa9b04e2035bf007e5e5c3c4396a8 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memItemLeft" align="right" valign="top">virtual <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_i_kernel.xhtml#aa6daa9b04e2035bf007e5e5c3c4396a8">border_size</a> () const </td></tr>
179 <tr class="memdesc:aa6daa9b04e2035bf007e5e5c3c4396a8 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="mdescLeft"> </td><td class="mdescRight">The size of the border for that kernel. <a href="#aa6daa9b04e2035bf007e5e5c3c4396a8">More...</a><br /></td></tr>
180 <tr class="separator:aa6daa9b04e2035bf007e5e5c3c4396a8 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2"> </td></tr>
181 <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>
182 <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>
183 <tr class="separator:a3f5646133956f06348b310ccc3d36353 inherit pub_methods_classarm__compute_1_1_i_kernel"><td class="memSeparator" colspan="2"> </td></tr>
185 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
186 <div class="textblock"><p>Common interface for all the OpenCL kernels. </p>
188 <p>Definition at line <a class="el" href="_i_c_l_kernel_8h_source.xhtml#l00036">36</a> of file <a class="el" href="_i_c_l_kernel_8h_source.xhtml">ICLKernel.h</a>.</p>
189 </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
190 <a class="anchor" id="a6b10e96ce90bf901d17def86b874b019"></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_i_c_l_kernel.xhtml">ICLKernel</a> </td>
197 <td class="paramname"></td><td>)</td>
201 </div><div class="memdoc">
207 <h2 class="groupheader">Member Function Documentation</h2>
208 <a class="anchor" id="a479e7043e65dc87de35d374e108510f7"></a>
209 <div class="memitem">
210 <div class="memproto">
211 <table class="memname">
213 <td class="memname">void add_1D_tensor_argument </td>
215 <td class="paramtype">unsigned int & </td>
216 <td class="paramname"><em>idx</em>, </td>
219 <td class="paramkey"></td>
221 <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> * </td>
222 <td class="paramname"><em>tensor</em>, </td>
225 <td class="paramkey"></td>
227 <td class="paramtype">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> & </td>
228 <td class="paramname"><em>window</em> </td>
236 </div><div class="memdoc">
238 <p>Add the passed 1D tensor's parameters to the object's kernel's arguments starting from the index idx. </p>
239 <dl class="params"><dt>Parameters</dt><dd>
240 <table class="params">
241 <tr><td class="paramdir">[in,out]</td><td class="paramname">idx</td><td>Index at which to start adding the tensor's arguments. Will be incremented by the number of kernel arguments set. </td></tr>
242 <tr><td class="paramdir">[in]</td><td class="paramname">tensor</td><td><a class="el" href="classarm__compute_1_1_tensor.xhtml" title="Basic implementation of the tensor interface. ">Tensor</a> to set as an argument of the object's kernel. </td></tr>
243 <tr><td class="paramdir">[in]</td><td class="paramname">window</td><td><a class="el" href="classarm__compute_1_1_window.xhtml" title="Describe a multidimensional execution window. ">Window</a> the kernel will be executed on. </td></tr>
250 <a class="anchor" id="ac74dad3e61f79334f5e73f3c3ac603cb"></a>
251 <div class="memitem">
252 <div class="memproto">
253 <table class="memname">
255 <td class="memname">void add_2D_tensor_argument </td>
257 <td class="paramtype">unsigned int & </td>
258 <td class="paramname"><em>idx</em>, </td>
261 <td class="paramkey"></td>
263 <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> * </td>
264 <td class="paramname"><em>tensor</em>, </td>
267 <td class="paramkey"></td>
269 <td class="paramtype">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> & </td>
270 <td class="paramname"><em>window</em> </td>
278 </div><div class="memdoc">
280 <p>Add the passed 2D tensor's parameters to the object's kernel's arguments starting from the index idx. </p>
281 <dl class="params"><dt>Parameters</dt><dd>
282 <table class="params">
283 <tr><td class="paramdir">[in,out]</td><td class="paramname">idx</td><td>Index at which to start adding the tensor's arguments. Will be incremented by the number of kernel arguments set. </td></tr>
284 <tr><td class="paramdir">[in]</td><td class="paramname">tensor</td><td><a class="el" href="classarm__compute_1_1_tensor.xhtml" title="Basic implementation of the tensor interface. ">Tensor</a> to set as an argument of the object's kernel. </td></tr>
285 <tr><td class="paramdir">[in]</td><td class="paramname">window</td><td><a class="el" href="classarm__compute_1_1_window.xhtml" title="Describe a multidimensional execution window. ">Window</a> the kernel will be executed on. </td></tr>
292 <a class="anchor" id="a28f5847162f352444c6ac1825d0e99c7"></a>
293 <div class="memitem">
294 <div class="memproto">
295 <table class="memname">
297 <td class="memname">void add_3D_tensor_argument </td>
299 <td class="paramtype">unsigned int & </td>
300 <td class="paramname"><em>idx</em>, </td>
303 <td class="paramkey"></td>
305 <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_c_l_tensor.xhtml">ICLTensor</a> * </td>
306 <td class="paramname"><em>tensor</em>, </td>
309 <td class="paramkey"></td>
311 <td class="paramtype">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> & </td>
312 <td class="paramname"><em>window</em> </td>
320 </div><div class="memdoc">
322 <p>Add the passed 3D tensor's parameters to the object's kernel's arguments starting from the index idx. </p>
323 <dl class="params"><dt>Parameters</dt><dd>
324 <table class="params">
325 <tr><td class="paramdir">[in,out]</td><td class="paramname">idx</td><td>Index at which to start adding the tensor's arguments. Will be incremented by the number of kernel arguments set. </td></tr>
326 <tr><td class="paramdir">[in]</td><td class="paramname">tensor</td><td><a class="el" href="classarm__compute_1_1_tensor.xhtml" title="Basic implementation of the tensor interface. ">Tensor</a> to set as an argument of the object's kernel. </td></tr>
327 <tr><td class="paramdir">[in]</td><td class="paramname">window</td><td><a class="el" href="classarm__compute_1_1_window.xhtml" title="Describe a multidimensional execution window. ">Window</a> the kernel will be executed on. </td></tr>
334 <a class="anchor" id="a50f427a1d9419800972b9e03c4034311"></a>
335 <div class="memitem">
336 <div class="memproto">
337 <table class="mlabels">
339 <td class="mlabels-left">
340 <table class="memname">
342 <td class="memname">void add_argument </td>
344 <td class="paramtype">unsigned int & </td>
345 <td class="paramname"><em>idx</em>, </td>
348 <td class="paramkey"></td>
350 <td class="paramtype">T </td>
351 <td class="paramname"><em>value</em> </td>
360 <td class="mlabels-right">
361 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
364 </div><div class="memdoc">
366 <p>Add the passed parameters to the object's kernel's arguments starting from the index idx. </p>
367 <dl class="params"><dt>Parameters</dt><dd>
368 <table class="params">
369 <tr><td class="paramdir">[in,out]</td><td class="paramname">idx</td><td>Index at which to start adding the arguments. Will be incremented by the number of kernel arguments set. </td></tr>
370 <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>Value to set as an argument of the object's kernel. </td></tr>
375 <p>Definition at line <a class="el" href="_i_c_l_kernel_8h_source.xhtml#l00096">96</a> of file <a class="el" href="_i_c_l_kernel_8h_source.xhtml">ICLKernel.h</a>.</p>
377 <p>References <a class="el" href="namespacearm__compute.xhtml#a22af22ebac966b76e8553127064201a2">arm_compute::enqueue()</a>, <a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml#ae5121015ab09ece4d470f50c7ffe198e">ICLKernel::kernel()</a>, and <a class="el" href="classarm__compute_1_1_i_kernel.xhtml#a3f5646133956f06348b310ccc3d36353">IKernel::window()</a>.</p>
378 <div class="fragment"><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  {</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  _kernel.setArg(idx++, value);</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  }</div></div><!-- fragment -->
381 <a class="anchor" id="ae5121015ab09ece4d470f50c7ffe198e"></a>
382 <div class="memitem">
383 <div class="memproto">
384 <table class="memname">
386 <td class="memname">cl::Kernel& kernel </td>
388 <td class="paramname"></td><td>)</td>
392 </div><div class="memdoc">
394 <p>Returns a reference to the OpenCL kernel of this object. </p>
395 <dl class="section return"><dt>Returns</dt><dd>A reference to the OpenCL kernel of this object. </dd></dl>
397 <p>Referenced by <a class="el" href="_i_c_l_kernel_8h_source.xhtml#l00096">ICLKernel::add_argument()</a>.</p>
401 <a class="anchor" id="a770f45838881fc061294e56d64f34386"></a>
402 <div class="memitem">
403 <div class="memproto">
404 <table class="memname">
406 <td class="memname">unsigned int num_arguments_per_1D_tensor </td>
408 <td class="paramname"></td><td>)</td>
412 </div><div class="memdoc">
414 <p>Returns the number of arguments enqueued per 1D tensor object. </p>
415 <dl class="section return"><dt>Returns</dt><dd>The number of arguments enqueues per 1D tensor object. </dd></dl>
419 <a class="anchor" id="ac734502531e7f95e25b3bf688a304a59"></a>
420 <div class="memitem">
421 <div class="memproto">
422 <table class="memname">
424 <td class="memname">unsigned int num_arguments_per_2D_tensor </td>
426 <td class="paramname"></td><td>)</td>
430 </div><div class="memdoc">
432 <p>Returns the number of arguments enqueued per 2D tensor object. </p>
433 <dl class="section return"><dt>Returns</dt><dd>The number of arguments enqueues per 2D tensor object. </dd></dl>
437 <a class="anchor" id="a4feaae9c860cddfa843d37c953674a22"></a>
438 <div class="memitem">
439 <div class="memproto">
440 <table class="memname">
442 <td class="memname">unsigned int num_arguments_per_3D_tensor </td>
444 <td class="paramname"></td><td>)</td>
448 </div><div class="memdoc">
450 <p>Returns the number of arguments enqueued per 3D tensor object. </p>
451 <dl class="section return"><dt>Returns</dt><dd>The number of arguments enqueues per 3D tensor object. </dd></dl>
455 <a class="anchor" id="af6a174d47571f51f199ffc27ecc10f51"></a>
456 <div class="memitem">
457 <div class="memproto">
458 <table class="mlabels">
460 <td class="mlabels-left">
461 <table class="memname">
463 <td class="memname">virtual void run </td>
465 <td class="paramtype">const <a class="el" href="classarm__compute_1_1_window.xhtml">Window</a> & </td>
466 <td class="paramname"><em>window</em>, </td>
469 <td class="paramkey"></td>
471 <td class="paramtype">cl::CommandQueue & </td>
472 <td class="paramname"><em>queue</em> </td>
481 <td class="mlabels-right">
482 <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
485 </div><div class="memdoc">
487 <p>Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue. </p>
488 <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>
489 <dl class="params"><dt>Parameters</dt><dd>
490 <table class="params">
491 <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>
492 <tr><td class="paramdir">[in,out]</td><td class="paramname">queue</td><td>Command queue on which to enqueue the kernel. </td></tr>
497 <p>Implemented in <a class="el" href="classarm__compute_1_1_c_l_l_k_tracker_stage1_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLLKTrackerStage1Kernel</a>, <a class="el" href="classarm__compute_1_1_c_l_convolution_rectangle_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLConvolutionRectangleKernel</a>, <a class="el" href="classarm__compute_1_1_c_l_l_k_tracker_stage0_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLLKTrackerStage0Kernel</a>, <a class="el" href="classarm__compute_1_1_c_l_edge_trace_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLEdgeTraceKernel</a>, <a class="el" href="classarm__compute_1_1_c_l_copy_to_array_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLCopyToArrayKernel</a>, <a class="el" href="classarm__compute_1_1_c_l_l_k_tracker_finalize_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLLKTrackerFinalizeKernel</a>, <a class="el" href="classarm__compute_1_1_c_l_sobel5x5_vert_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLSobel5x5VertKernel</a>, <a class="el" href="classarm__compute_1_1_c_l_sobel7x7_vert_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLSobel7x7VertKernel</a>, <a class="el" href="classarm__compute_1_1_c_l_logits1_d_norm_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLLogits1DNormKernel</a>, <a class="el" href="classarm__compute_1_1_c_l_min_max_location_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLMinMaxLocationKernel</a>, <a class="el" href="classarm__compute_1_1_c_l_edge_non_max_suppression_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLEdgeNonMaxSuppressionKernel</a>, <a class="el" href="classarm__compute_1_1_c_l_gaussian_pyramid_vert_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLGaussianPyramidVertKernel</a>, <a class="el" href="classarm__compute_1_1_c_l_histogram_border_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLHistogramBorderKernel</a>, <a class="el" href="classarm__compute_1_1_c_l_l_k_tracker_init_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLLKTrackerInitKernel</a>, <a class="el" href="classarm__compute_1_1_c_l_im2_col_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLIm2ColKernel</a>, <a class="el" href="classarm__compute_1_1_c_l_color_convert_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLColorConvertKernel</a>, <a class="el" href="classarm__compute_1_1_c_l_convolution_layer_weights_reshape_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLConvolutionLayerWeightsReshapeKernel</a>, <a class="el" href="classarm__compute_1_1_c_l_col2_im_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLCol2ImKernel</a>, <a class="el" href="classarm__compute_1_1_c_l_scharr3x3_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLScharr3x3Kernel</a>, <a class="el" href="classarm__compute_1_1_c_l_channel_combine_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLChannelCombineKernel</a>, <a class="el" href="classarm__compute_1_1_c_l_g_e_m_m_interleave4x4_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLGEMMInterleave4x4Kernel</a>, <a class="el" href="classarm__compute_1_1_c_l_g_e_m_m_lowp_matrix_multiply_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLGEMMLowpMatrixMultiplyKernel</a>, <a class="el" href="classarm__compute_1_1_c_l_harris_score_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLHarrisScoreKernel</a>, <a class="el" href="classarm__compute_1_1_c_l_fast_corners_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLFastCornersKernel</a>, <a class="el" href="classarm__compute_1_1_c_l_channel_extract_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLChannelExtractKernel</a>, <a class="el" href="classarm__compute_1_1_c_l_fill_border_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLFillBorderKernel</a>, <a class="el" href="classarm__compute_1_1_c_l_logits1_d_shift_exp_sum_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLLogits1DShiftExpSumKernel</a>, <a class="el" href="classarm__compute_1_1_c_l_integral_image_vert_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLIntegralImageVertKernel</a>, <a class="el" href="classarm__compute_1_1_c_l_arithmetic_subtraction_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLArithmeticSubtractionKernel</a>, <a class="el" href="classarm__compute_1_1_c_l_g_e_m_m_matrix_multiply_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLGEMMMatrixMultiplyKernel</a>, <a class="el" href="classarm__compute_1_1_c_l_magnitude_phase_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLMagnitudePhaseKernel</a>, <a class="el" href="classarm__compute_1_1_c_l_arithmetic_addition_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLArithmeticAdditionKernel</a>, <a class="el" href="classarm__compute_1_1_c_l_mean_std_dev_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLMeanStdDevKernel</a>, <a class="el" href="classarm__compute_1_1_c_l_pixel_wise_multiplication_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLPixelWiseMultiplicationKernel</a>, <a class="el" href="classarm__compute_1_1_c_l_absolute_difference_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLAbsoluteDifferenceKernel</a>, <a class="el" href="classarm__compute_1_1_c_l_g_e_m_m_matrix_addition_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLGEMMMatrixAdditionKernel</a>, <a class="el" href="classarm__compute_1_1_c_l_sobel5x5_hor_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLSobel5x5HorKernel</a>, <a class="el" href="classarm__compute_1_1_c_l_sobel7x7_hor_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLSobel7x7HorKernel</a>, <a class="el" href="classarm__compute_1_1_c_l_derivative_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLDerivativeKernel</a>, <a class="el" href="classarm__compute_1_1_c_l_normalization_layer_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLNormalizationLayerKernel</a>, <a class="el" href="classarm__compute_1_1_c_l_sobel3x3_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLSobel3x3Kernel</a>, <a class="el" href="classarm__compute_1_1_c_l_bitwise_and_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLBitwiseAndKernel</a>, <a class="el" href="classarm__compute_1_1_c_l_bitwise_or_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLBitwiseOrKernel</a>, <a class="el" href="classarm__compute_1_1_c_l_bitwise_xor_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLBitwiseXorKernel</a>, <a class="el" href="classarm__compute_1_1_c_l_min_max_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLMinMaxKernel</a>, <a class="el" href="classarm__compute_1_1_c_l_remap_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLRemapKernel</a>, <a class="el" href="classarm__compute_1_1_c_l_gradient_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLGradientKernel</a>, <a class="el" href="classarm__compute_1_1_c_l_gaussian_pyramid_hor_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLGaussianPyramidHorKernel</a>, <a class="el" href="classarm__compute_1_1_c_l_histogram_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLHistogramKernel</a>, <a class="el" href="classarm__compute_1_1_c_l_pooling_layer_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLPoolingLayerKernel</a>, <a class="el" href="classarm__compute_1_1_c_l_g_e_m_m_matrix_accumulate_biases_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">CLGEMMMatrixAccumulateBiasesKernel</a>, <a class="el" href="classarm__compute_1_1_i_c_l_simple3_d_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">ICLSimple3DKernel</a>, and <a class="el" href="classarm__compute_1_1_i_c_l_simple2_d_kernel.xhtml#a493987e85723a8000eb26d1f00e2ad0e">ICLSimple2DKernel</a>.</p>
501 <hr/>The documentation for this class was generated from the following file:<ul>
502 <li>arm_compute/core/CL/<a class="el" href="_i_c_l_kernel_8h_source.xhtml">ICLKernel.h</a></li>
504 </div><!-- contents -->
505 </div><!-- doc-content -->
506 <!-- start footer part -->
507 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
509 <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_i_c_l_kernel.xhtml">ICLKernel</a></li>
510 <li class="footer">Generated on Wed Apr 12 2017 14:26:06 for ARM Compute Library by
511 <a href="http://www.doxygen.org/index.html">
512 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>