documentation/classarm__compute_1_1_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: 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="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_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">Kernel Class Reference</div>  </div>
 121 </div><!--header-->
 122 <div class="contents">
 123
 124 <p><a class="el" href="classarm__compute_1_1_kernel.xhtml" title="Kernel class. ">Kernel</a> class.
 125  <a href="classarm__compute_1_1_kernel.xhtml#details">More...</a></p>
 126
 127 <p><code>#include &lt;<a class="el" href="_c_l_kernel_library_8h_source.xhtml">CLKernelLibrary.h</a>&gt;</code></p>
 128 <table class="memberdecls">
 129 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 130 Public Member Functions</h2></td></tr>
 131 <tr class="memitem:a4d7fb588e6d609d95d8cd491492ed420"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_kernel.xhtml#a4d7fb588e6d609d95d8cd491492ed420">Kernel</a> ()</td></tr>
 132 <tr class="memdesc:a4d7fb588e6d609d95d8cd491492ed420"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default Constructor.  <a href="#a4d7fb588e6d609d95d8cd491492ed420">More...</a><br /></td></tr>
 133 <tr class="separator:a4d7fb588e6d609d95d8cd491492ed420"><td class="memSeparator" colspan="2">&#160;</td></tr>
 134 <tr class="memitem:a83af2718294984c1053223a928164a7b"><td class="memItemLeft" align="right" valign="top">&#160;</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> &amp;)=default</td></tr>
 135 <tr class="memdesc:a83af2718294984c1053223a928164a7b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default Copy Constructor.  <a href="#a83af2718294984c1053223a928164a7b">More...</a><br /></td></tr>
 136 <tr class="separator:a83af2718294984c1053223a928164a7b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 137 <tr class="memitem:a1d1e423ba4b26fdf460aa45bbc4457d1"><td class="memItemLeft" align="right" valign="top">&#160;</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> &amp;&amp;)=default</td></tr>
 138 <tr class="memdesc:a1d1e423ba4b26fdf460aa45bbc4457d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default Move Constructor.  <a href="#a1d1e423ba4b26fdf460aa45bbc4457d1">More...</a><br /></td></tr>
 139 <tr class="separator:a1d1e423ba4b26fdf460aa45bbc4457d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
 140 <tr class="memitem:a9729d318da4230e664a923d7419ddf10"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a> &amp;&#160;</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> &amp;)=default</td></tr>
 141 <tr class="memdesc:a9729d318da4230e664a923d7419ddf10"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default copy assignment operator.  <a href="#a9729d318da4230e664a923d7419ddf10">More...</a><br /></td></tr>
 142 <tr class="separator:a9729d318da4230e664a923d7419ddf10"><td class="memSeparator" colspan="2">&#160;</td></tr>
 143 <tr class="memitem:a22bb0cebcc049eac830795a517212f75"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a> &amp;&#160;</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> &amp;&amp;)=default</td></tr>
 144 <tr class="memdesc:a22bb0cebcc049eac830795a517212f75"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default move assignment operator.  <a href="#a22bb0cebcc049eac830795a517212f75">More...</a><br /></td></tr>
 145 <tr class="separator:a22bb0cebcc049eac830795a517212f75"><td class="memSeparator" colspan="2">&#160;</td></tr>
 146 <tr class="memitem:a8b2bcac315357d36294d68948e51b925"><td class="memItemLeft" align="right" valign="top">&#160;</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 &amp;program)</td></tr>
 147 <tr class="memdesc:a8b2bcac315357d36294d68948e51b925"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a8b2bcac315357d36294d68948e51b925">More...</a><br /></td></tr>
 148 <tr class="separator:a8b2bcac315357d36294d68948e51b925"><td class="memSeparator" colspan="2">&#160;</td></tr>
 149 <tr class="memitem:a37627d5d5bba7f4a8690c71c2ab3cb07"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_kernel.xhtml#a37627d5d5bba7f4a8690c71c2ab3cb07">name</a> () const </td></tr>
 150 <tr class="memdesc:a37627d5d5bba7f4a8690c71c2ab3cb07"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns kernel name.  <a href="#a37627d5d5bba7f4a8690c71c2ab3cb07">More...</a><br /></td></tr>
 151 <tr class="separator:a37627d5d5bba7f4a8690c71c2ab3cb07"><td class="memSeparator" colspan="2">&#160;</td></tr>
 152 <tr class="memitem:ad3a94f90bef30dbf3529c617cb8b2c53"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_kernel.xhtml#ad3a94f90bef30dbf3529c617cb8b2c53">operator cl::Kernel</a> () const </td></tr>
 153 <tr class="memdesc:ad3a94f90bef30dbf3529c617cb8b2c53"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns OpenCL kernel.  <a href="#ad3a94f90bef30dbf3529c617cb8b2c53">More...</a><br /></td></tr>
 154 <tr class="separator:ad3a94f90bef30dbf3529c617cb8b2c53"><td class="memSeparator" colspan="2">&#160;</td></tr>
 155 </table>
 156 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 157 <div class="textblock"><p><a class="el" href="classarm__compute_1_1_kernel.xhtml" title="Kernel class. ">Kernel</a> class. </p>
 158
 159 <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>
 160 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 161 <a class="anchor" id="a4d7fb588e6d609d95d8cd491492ed420"></a>
 162 <div class="memitem">
 163 <div class="memproto">
 164       <table class="memname">
 165         <tr>
 166           <td class="memname"><a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a> </td>
 167           <td>(</td>
 168           <td class="paramname"></td><td>)</td>
 169           <td></td>
 170         </tr>
 171       </table>
 172 </div><div class="memdoc">
 173
 174 <p>Default Constructor. </p>
 175
 176 </div>
 177 </div>
 178 <a class="anchor" id="a83af2718294984c1053223a928164a7b"></a>
 179 <div class="memitem">
 180 <div class="memproto">
 181 <table class="mlabels">
 182   <tr>
 183   <td class="mlabels-left">
 184       <table class="memname">
 185         <tr>
 186           <td class="memname"><a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a> </td>
 187           <td>(</td>
 188           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a> &amp;&#160;</td>
 189           <td class="paramname"></td><td>)</td>
 190           <td></td>
 191         </tr>
 192       </table>
 193   </td>
 194   <td class="mlabels-right">
 195 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 196   </tr>
 197 </table>
 198 </div><div class="memdoc">
 199
 200 <p>Default Copy Constructor. </p>
 201
 202 </div>
 203 </div>
 204 <a class="anchor" id="a1d1e423ba4b26fdf460aa45bbc4457d1"></a>
 205 <div class="memitem">
 206 <div class="memproto">
 207 <table class="mlabels">
 208   <tr>
 209   <td class="mlabels-left">
 210       <table class="memname">
 211         <tr>
 212           <td class="memname"><a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a> </td>
 213           <td>(</td>
 214           <td class="paramtype"><a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a> &amp;&amp;&#160;</td>
 215           <td class="paramname"></td><td>)</td>
 216           <td></td>
 217         </tr>
 218       </table>
 219   </td>
 220   <td class="mlabels-right">
 221 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 222   </tr>
 223 </table>
 224 </div><div class="memdoc">
 225
 226 <p>Default Move Constructor. </p>
 227
 228 </div>
 229 </div>
 230 <a class="anchor" id="a8b2bcac315357d36294d68948e51b925"></a>
 231 <div class="memitem">
 232 <div class="memproto">
 233       <table class="memname">
 234         <tr>
 235           <td class="memname"><a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a> </td>
 236           <td>(</td>
 237           <td class="paramtype">std::string&#160;</td>
 238           <td class="paramname"><em>name</em>, </td>
 239         </tr>
 240         <tr>
 241           <td class="paramkey"></td>
 242           <td></td>
 243           <td class="paramtype">const cl::Program &amp;&#160;</td>
 244           <td class="paramname"><em>program</em>&#160;</td>
 245         </tr>
 246         <tr>
 247           <td></td>
 248           <td>)</td>
 249           <td></td><td></td>
 250         </tr>
 251       </table>
 252 </div><div class="memdoc">
 253
 254 <p>Constructor. </p>
 255 <dl class="params"><dt>Parameters</dt><dd>
 256   <table class="params">
 257     <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>
 258     <tr><td class="paramdir">[in]</td><td class="paramname">program</td><td>Built program. </td></tr>
 259   </table>
 260   </dd>
 261 </dl>
 262
 263 </div>
 264 </div>
 265 <h2 class="groupheader">Member Function Documentation</h2>
 266 <a class="anchor" id="a37627d5d5bba7f4a8690c71c2ab3cb07"></a>
 267 <div class="memitem">
 268 <div class="memproto">
 269 <table class="mlabels">
 270   <tr>
 271   <td class="mlabels-left">
 272       <table class="memname">
 273         <tr>
 274           <td class="memname">std::string name </td>
 275           <td>(</td>
 276           <td class="paramname"></td><td>)</td>
 277           <td> const</td>
 278         </tr>
 279       </table>
 280   </td>
 281   <td class="mlabels-right">
 282 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 283   </tr>
 284 </table>
 285 </div><div class="memdoc">
 286
 287 <p>Returns kernel name. </p>
 288 <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
 290 <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>
 291 <div class="fragment"><div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;    {</div><div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;        <span class="keywordflow">return</span> _name;</div><div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;    }</div></div><!-- fragment -->
 292 </div>
 293 </div>
 294 <a class="anchor" id="ad3a94f90bef30dbf3529c617cb8b2c53"></a>
 295 <div class="memitem">
 296 <div class="memproto">
 297 <table class="mlabels">
 298   <tr>
 299   <td class="mlabels-left">
 300       <table class="memname">
 301         <tr>
 302           <td class="memname">operator cl::Kernel </td>
 303           <td>(</td>
 304           <td class="paramname"></td><td>)</td>
 305           <td> const</td>
 306         </tr>
 307       </table>
 308   </td>
 309   <td class="mlabels-right">
 310 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span>  </td>
 311   </tr>
 312 </table>
 313 </div><div class="memdoc">
 314
 315 <p>Returns OpenCL kernel. </p>
 316 <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>
 317
 318 <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>
 319 <div class="fragment"><div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;    {</div><div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;        <span class="keywordflow">return</span> _kernel;</div><div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;    }</div></div><!-- fragment -->
 320 </div>
 321 </div>
 322 <a class="anchor" id="a9729d318da4230e664a923d7419ddf10"></a>
 323 <div class="memitem">
 324 <div class="memproto">
 325 <table class="mlabels">
 326   <tr>
 327   <td class="mlabels-left">
 328       <table class="memname">
 329         <tr>
 330           <td class="memname"><a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a>&amp; operator= </td>
 331           <td>(</td>
 332           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a> &amp;&#160;</td>
 333           <td class="paramname"></td><td>)</td>
 334           <td></td>
 335         </tr>
 336       </table>
 337   </td>
 338   <td class="mlabels-right">
 339 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 340   </tr>
 341 </table>
 342 </div><div class="memdoc">
 343
 344 <p>Default copy assignment operator. </p>
 345
 346 </div>
 347 </div>
 348 <a class="anchor" id="a22bb0cebcc049eac830795a517212f75"></a>
 349 <div class="memitem">
 350 <div class="memproto">
 351 <table class="mlabels">
 352   <tr>
 353   <td class="mlabels-left">
 354       <table class="memname">
 355         <tr>
 356           <td class="memname"><a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a>&amp; operator= </td>
 357           <td>(</td>
 358           <td class="paramtype"><a class="el" href="classarm__compute_1_1_kernel.xhtml">Kernel</a> &amp;&amp;&#160;</td>
 359           <td class="paramname"></td><td>)</td>
 360           <td></td>
 361         </tr>
 362       </table>
 363   </td>
 364   <td class="mlabels-right">
 365 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
 366   </tr>
 367 </table>
 368 </div><div class="memdoc">
 369
 370 <p>Default move assignment operator. </p>
 371
 372 </div>
 373 </div>
 374 <hr/>The documentation for this class was generated from the following file:<ul>
 375 <li>arm_compute/core/CL/<a class="el" href="_c_l_kernel_library_8h_source.xhtml">CLKernelLibrary.h</a></li>
 376 </ul>
 377 </div><!-- contents -->
 378 </div><!-- doc-content -->
 379 <!-- start footer part -->
 380 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 381   <ul>
 382     <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>
 383     <li class="footer">Generated on Wed Apr 12 2017 14:26:06 for ARM Compute Library by
 384     <a href="http://www.doxygen.org/index.html">
 385     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
 386   </ul>
 387 </div>
 388 </body>
 389 </html>