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.6"/>
8 <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
9 <title>Compute Library: Kernel 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="navtree.js"></script>
16 <script type="text/javascript">
17 $(document).ready(initResizable);
18 $(window).load(resizeHeight);
20 <link href="search/search.css" rel="stylesheet" type="text/css"/>
21 <script type="text/javascript" src="search/search.js"></script>
22 <script type="text/javascript">
23 $(document).ready(function() { searchBox.OnSelectItem(0); });
25 <script type="text/x-mathjax-config">
27 extensions: ["tex2jax.js"],
28 jax: ["input/TeX","output/HTML-CSS"],
30 </script><script src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
31 <link href="doxygen.css" rel="stylesheet" type="text/css" />
34 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
36 <table cellspacing="0" cellpadding="0">
38 <tr style="height: 56px;">
39 <td style="padding-left: 0.5em;">
40 <div id="projectname">Compute Library
41  <span id="projectnumber">17.10</span>
48 <!-- end header part -->
49 <!-- Generated by Doxygen 1.8.6 -->
50 <script type="text/javascript">
51 var searchBox = new SearchBox("searchBox", "search",false,'Search');
53 <div id="navrow1" class="tabs">
55 <li><a href="index.xhtml"><span>Main Page</span></a></li>
56 <li><a href="pages.xhtml"><span>Related Pages</span></a></li>
57 <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
58 <li class="current"><a href="annotated.xhtml"><span>Data Structures</span></a></li>
59 <li><a href="files.xhtml"><span>Files</span></a></li>
61 <div id="MSearchBox" class="MSearchBoxInactive">
63 <img id="MSearchSelect" src="search/mag_sel.png"
64 onmouseover="return searchBox.OnSearchSelectShow()"
65 onmouseout="return searchBox.OnSearchSelectHide()"
67 <input type="text" id="MSearchField" value="Search" accesskey="S"
68 onfocus="searchBox.OnSearchFieldFocus(true)"
69 onblur="searchBox.OnSearchFieldFocus(false)"
70 onkeyup="searchBox.OnSearchFieldChange(event)"/>
71 </span><span class="right">
72 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
78 <div id="navrow2" class="tabs2">
80 <li><a href="annotated.xhtml"><span>Data Structures</span></a></li>
81 <li><a href="classes.xhtml"><span>Data Structure Index</span></a></li>
82 <li><a href="inherits.xhtml"><span>Class Hierarchy</span></a></li>
83 <li><a href="functions.xhtml"><span>Data Fields</span></a></li>
87 <div id="side-nav" class="ui-resizable side-nav-resizable">
89 <div id="nav-tree-contents">
90 <div id="nav-sync" class="sync"></div>
93 <div id="splitbar" style="-moz-user-select:none;"
94 class="ui-resizable-handle">
97 <script type="text/javascript">
98 $(document).ready(function(){initNavTree('classarm__compute_1_1_kernel.xhtml','');});
100 <div id="doc-content">
101 <!-- window showing the filter options -->
102 <div id="MSearchSelectWindow"
103 onmouseover="return searchBox.OnSearchSelectShow()"
104 onmouseout="return searchBox.OnSearchSelectHide()"
105 onkeydown="return searchBox.OnSearchSelectKey(event)">
106 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Pages</a></div>
108 <!-- iframe showing the search results (closed by default) -->
109 <div id="MSearchResultsWindow">
110 <iframe src="javascript:void(0)" frameborder="0"
111 name="MSearchResults" id="MSearchResults">
116 <div class="summary">
117 <a href="#pub-methods">Public Member Functions</a> </div>
118 <div class="headertitle">
119 <div class="title">Kernel Class Reference</div> </div>
121 <div class="contents">
123 <p><a class="el" href="classarm__compute_1_1_kernel.xhtml" title="Kernel class. ">Kernel</a> class.
124 <a href="classarm__compute_1_1_kernel.xhtml#details">More...</a></p>
126 <p><code>#include <<a class="el" href="_c_l_kernel_library_8h_source.xhtml">CLKernelLibrary.h</a>></code></p>
127 <table class="memberdecls">
128 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
129 Public Member Functions</h2></td></tr>
130 <tr class="memitem:a4d7fb588e6d609d95d8cd491492ed420"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_kernel.xhtml#a4d7fb588e6d609d95d8cd491492ed420">Kernel</a> ()</td></tr>
131 <tr class="memdesc:a4d7fb588e6d609d95d8cd491492ed420"><td class="mdescLeft"> </td><td class="mdescRight">Default Constructor. <a href="#a4d7fb588e6d609d95d8cd491492ed420">More...</a><br/></td></tr>
132 <tr class="separator:a4d7fb588e6d609d95d8cd491492ed420"><td class="memSeparator" colspan="2"> </td></tr>
133 <tr class="memitem:a83af2718294984c1053223a928164a7b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_kernel.xhtml#a83af2718294984c1053223a928164a7b">Kernel</a> (const <a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a> &)=default</td></tr>
134 <tr class="memdesc:a83af2718294984c1053223a928164a7b"><td class="mdescLeft"> </td><td class="mdescRight">Default Copy Constructor. <a href="#a83af2718294984c1053223a928164a7b">More...</a><br/></td></tr>
135 <tr class="separator:a83af2718294984c1053223a928164a7b"><td class="memSeparator" colspan="2"> </td></tr>
136 <tr class="memitem:a1d1e423ba4b26fdf460aa45bbc4457d1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_kernel.xhtml#a1d1e423ba4b26fdf460aa45bbc4457d1">Kernel</a> (<a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a> &&)=default</td></tr>
137 <tr class="memdesc:a1d1e423ba4b26fdf460aa45bbc4457d1"><td class="mdescLeft"> </td><td class="mdescRight">Default Move Constructor. <a href="#a1d1e423ba4b26fdf460aa45bbc4457d1">More...</a><br/></td></tr>
138 <tr class="separator:a1d1e423ba4b26fdf460aa45bbc4457d1"><td class="memSeparator" colspan="2"> </td></tr>
139 <tr class="memitem:a9729d318da4230e664a923d7419ddf10"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_kernel.xhtml#a9729d318da4230e664a923d7419ddf10">operator=</a> (const <a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a> &)=default</td></tr>
140 <tr class="memdesc:a9729d318da4230e664a923d7419ddf10"><td class="mdescLeft"> </td><td class="mdescRight">Default copy assignment operator. <a href="#a9729d318da4230e664a923d7419ddf10">More...</a><br/></td></tr>
141 <tr class="separator:a9729d318da4230e664a923d7419ddf10"><td class="memSeparator" colspan="2"> </td></tr>
142 <tr class="memitem:a22bb0cebcc049eac830795a517212f75"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_kernel.xhtml#a22bb0cebcc049eac830795a517212f75">operator=</a> (<a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a> &&)=default</td></tr>
143 <tr class="memdesc:a22bb0cebcc049eac830795a517212f75"><td class="mdescLeft"> </td><td class="mdescRight">Default move assignment operator. <a href="#a22bb0cebcc049eac830795a517212f75">More...</a><br/></td></tr>
144 <tr class="separator:a22bb0cebcc049eac830795a517212f75"><td class="memSeparator" colspan="2"> </td></tr>
145 <tr class="memitem:a8b2bcac315357d36294d68948e51b925"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_kernel.xhtml#a8b2bcac315357d36294d68948e51b925">Kernel</a> (std::string <a class="el" href="classarm__compute_1_1_kernel.xhtml#a37627d5d5bba7f4a8690c71c2ab3cb07">name</a>, const cl::Program &program)</td></tr>
146 <tr class="memdesc:a8b2bcac315357d36294d68948e51b925"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a8b2bcac315357d36294d68948e51b925">More...</a><br/></td></tr>
147 <tr class="separator:a8b2bcac315357d36294d68948e51b925"><td class="memSeparator" colspan="2"> </td></tr>
148 <tr class="memitem:a37627d5d5bba7f4a8690c71c2ab3cb07"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_kernel.xhtml#a37627d5d5bba7f4a8690c71c2ab3cb07">name</a> () const </td></tr>
149 <tr class="memdesc:a37627d5d5bba7f4a8690c71c2ab3cb07"><td class="mdescLeft"> </td><td class="mdescRight">Returns kernel name. <a href="#a37627d5d5bba7f4a8690c71c2ab3cb07">More...</a><br/></td></tr>
150 <tr class="separator:a37627d5d5bba7f4a8690c71c2ab3cb07"><td class="memSeparator" colspan="2"> </td></tr>
151 <tr class="memitem:ad3a94f90bef30dbf3529c617cb8b2c53"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_kernel.xhtml#ad3a94f90bef30dbf3529c617cb8b2c53">operator cl::Kernel</a> () const </td></tr>
152 <tr class="memdesc:ad3a94f90bef30dbf3529c617cb8b2c53"><td class="mdescLeft"> </td><td class="mdescRight">Returns OpenCL kernel. <a href="#ad3a94f90bef30dbf3529c617cb8b2c53">More...</a><br/></td></tr>
153 <tr class="separator:ad3a94f90bef30dbf3529c617cb8b2c53"><td class="memSeparator" colspan="2"> </td></tr>
155 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
156 <div class="textblock"><p><a class="el" href="classarm__compute_1_1_kernel.xhtml" title="Kernel class. ">Kernel</a> class. </p>
158 <p>Definition at line <a class="el" href="_c_l_kernel_library_8h_source.xhtml#l00098">98</a> of file <a class="el" href="_c_l_kernel_library_8h_source.xhtml">CLKernelLibrary.h</a>.</p>
159 </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
160 <a class="anchor" id="a4d7fb588e6d609d95d8cd491492ed420"></a>
161 <div class="memitem">
162 <div class="memproto">
163 <table class="memname">
165 <td class="memname"><a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a> </td>
167 <td class="paramname"></td><td>)</td>
171 </div><div class="memdoc">
173 <p>Default Constructor. </p>
177 <a class="anchor" id="a83af2718294984c1053223a928164a7b"></a>
178 <div class="memitem">
179 <div class="memproto">
180 <table class="mlabels">
182 <td class="mlabels-left">
183 <table class="memname">
185 <td class="memname"><a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a> </td>
187 <td class="paramtype">const <a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a> & </td>
188 <td class="paramname"></td><td>)</td>
193 <td class="mlabels-right">
194 <span class="mlabels"><span class="mlabel">default</span></span> </td>
197 </div><div class="memdoc">
199 <p>Default Copy Constructor. </p>
203 <a class="anchor" id="a1d1e423ba4b26fdf460aa45bbc4457d1"></a>
204 <div class="memitem">
205 <div class="memproto">
206 <table class="mlabels">
208 <td class="mlabels-left">
209 <table class="memname">
211 <td class="memname"><a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a> </td>
213 <td class="paramtype"><a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a> && </td>
214 <td class="paramname"></td><td>)</td>
219 <td class="mlabels-right">
220 <span class="mlabels"><span class="mlabel">default</span></span> </td>
223 </div><div class="memdoc">
225 <p>Default Move Constructor. </p>
229 <a class="anchor" id="a8b2bcac315357d36294d68948e51b925"></a>
230 <div class="memitem">
231 <div class="memproto">
232 <table class="memname">
234 <td class="memname"><a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a> </td>
236 <td class="paramtype">std::string </td>
237 <td class="paramname"><em>name</em>, </td>
240 <td class="paramkey"></td>
242 <td class="paramtype">const cl::Program & </td>
243 <td class="paramname"><em>program</em> </td>
251 </div><div class="memdoc">
254 <dl class="params"><dt>Parameters</dt><dd>
255 <table class="params">
256 <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td><a class="el" href="classarm__compute_1_1_kernel.xhtml" title="Kernel class. ">Kernel</a> name. </td></tr>
257 <tr><td class="paramdir">[in]</td><td class="paramname">program</td><td>Built program. </td></tr>
264 <h2 class="groupheader">Member Function Documentation</h2>
265 <a class="anchor" id="a37627d5d5bba7f4a8690c71c2ab3cb07"></a>
266 <div class="memitem">
267 <div class="memproto">
268 <table class="mlabels">
270 <td class="mlabels-left">
271 <table class="memname">
273 <td class="memname">std::string name </td>
275 <td class="paramname"></td><td>)</td>
280 <td class="mlabels-right">
281 <span class="mlabels"><span class="mlabel">inline</span></span> </td>
284 </div><div class="memdoc">
286 <p>Returns kernel name. </p>
287 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="classarm__compute_1_1_kernel.xhtml" title="Kernel class. ">Kernel</a>'s name. </dd></dl>
289 <p>Definition at line <a class="el" href="_c_l_kernel_library_8h_source.xhtml#l00121">121</a> of file <a class="el" href="_c_l_kernel_library_8h_source.xhtml">CLKernelLibrary.h</a>.</p>
290 <div class="fragment"><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  {</div>
291 <div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="keywordflow">return</span> _name;</div>
292 <div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  }</div>
293 </div><!-- fragment -->
296 <a class="anchor" id="ad3a94f90bef30dbf3529c617cb8b2c53"></a>
297 <div class="memitem">
298 <div class="memproto">
299 <table class="mlabels">
301 <td class="mlabels-left">
302 <table class="memname">
304 <td class="memname">operator cl::Kernel </td>
306 <td class="paramname"></td><td>)</td>
311 <td class="mlabels-right">
312 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
315 </div><div class="memdoc">
317 <p>Returns OpenCL kernel. </p>
318 <dl class="section return"><dt>Returns</dt><dd>OpenCL <a class="el" href="classarm__compute_1_1_kernel.xhtml" title="Kernel class. ">Kernel</a>. </dd></dl>
320 <p>Definition at line <a class="el" href="_c_l_kernel_library_8h_source.xhtml#l00129">129</a> of file <a class="el" href="_c_l_kernel_library_8h_source.xhtml">CLKernelLibrary.h</a>.</p>
321 <div class="fragment"><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  {</div>
322 <div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <span class="keywordflow">return</span> _kernel;</div>
323 <div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  }</div>
324 </div><!-- fragment -->
327 <a class="anchor" id="a9729d318da4230e664a923d7419ddf10"></a>
328 <div class="memitem">
329 <div class="memproto">
330 <table class="mlabels">
332 <td class="mlabels-left">
333 <table class="memname">
335 <td class="memname"><a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a>& operator= </td>
337 <td class="paramtype">const <a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a> & </td>
338 <td class="paramname"></td><td>)</td>
343 <td class="mlabels-right">
344 <span class="mlabels"><span class="mlabel">default</span></span> </td>
347 </div><div class="memdoc">
349 <p>Default copy assignment operator. </p>
353 <a class="anchor" id="a22bb0cebcc049eac830795a517212f75"></a>
354 <div class="memitem">
355 <div class="memproto">
356 <table class="mlabels">
358 <td class="mlabels-left">
359 <table class="memname">
361 <td class="memname"><a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a>& operator= </td>
363 <td class="paramtype"><a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a> && </td>
364 <td class="paramname"></td><td>)</td>
369 <td class="mlabels-right">
370 <span class="mlabels"><span class="mlabel">default</span></span> </td>
373 </div><div class="memdoc">
375 <p>Default move assignment operator. </p>
379 <hr/>The documentation for this class was generated from the following file:<ul>
380 <li>arm_compute/core/CL/<a class="el" href="_c_l_kernel_library_8h_source.xhtml">CLKernelLibrary.h</a></li>
382 </div><!-- contents -->
383 </div><!-- doc-content -->
384 <!-- start footer part -->
385 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
387 <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_kernel.xhtml">Kernel</a></li>
388 <li class="footer">Generated on Thu Oct 12 2017 14:26:36 for Compute Library by
389 <a href="http://www.doxygen.org/index.html">
390 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>