documentation/classarm__compute_1_1_c_l_tuner.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.6"/>
   8 <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
   9 <title>Compute Library: CLTuner 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);
  19 </script>
  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); });
  24 </script>
  25 <script type="text/x-mathjax-config">
  26   MathJax.Hub.Config({
  27     extensions: ["tex2jax.js"],
  28     jax: ["input/TeX","output/HTML-CSS"],
  29 });
  30 </script><script src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
  31 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  32 </head>
  33 <body>
  34 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  35 <div id="titlearea">
  36 <table cellspacing="0" cellpadding="0">
  37  <tbody>
  38  <tr style="height: 56px;">
  39   <td style="padding-left: 0.5em;">
  40    <div id="projectname">Compute Library
  41    &#160;<span id="projectnumber">17.10</span>
  42    </div>
  43   </td>
  44  </tr>
  45  </tbody>
  46 </table>
  47 </div>
  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');
  52 </script>
  53   <div id="navrow1" class="tabs">
  54     <ul class="tablist">
  55       <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
  56       <li><a href="pages.xhtml"><span>Related&#160;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&#160;Structures</span></a></li>
  59       <li><a href="files.xhtml"><span>Files</span></a></li>
  60       <li>
  61         <div id="MSearchBox" class="MSearchBoxInactive">
  62         <span class="left">
  63           <img id="MSearchSelect" src="search/mag_sel.png"
  64                onmouseover="return searchBox.OnSearchSelectShow()"
  65                onmouseout="return searchBox.OnSearchSelectHide()"
  66                alt=""/>
  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>
  73           </span>
  74         </div>
  75       </li>
  76     </ul>
  77   </div>
  78   <div id="navrow2" class="tabs2">
  79     <ul class="tablist">
  80       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
  81       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
  82       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
  83       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
  84     </ul>
  85   </div>
  86 </div><!-- top -->
  87 <div id="side-nav" class="ui-resizable side-nav-resizable">
  88   <div id="nav-tree">
  89     <div id="nav-tree-contents">
  90       <div id="nav-sync" class="sync"></div>
  91     </div>
  92   </div>
  93   <div id="splitbar" style="-moz-user-select:none;"
  94        class="ui-resizable-handle">
  95   </div>
  96 </div>
  97 <script type="text/javascript">
  98 $(document).ready(function(){initNavTree('classarm__compute_1_1_c_l_tuner.xhtml','');});
  99 </script>
 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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Pages</a></div>
 107
 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">
 112 </iframe>
 113 </div>
 114
 115 <div class="header">
 116   <div class="summary">
 117 <a href="#pub-methods">Public Member Functions</a>  </div>
 118   <div class="headertitle">
 119 <div class="title">CLTuner Class Reference</div>  </div>
 120 </div><!--header-->
 121 <div class="contents">
 122
 123 <p>Basic implementation of the OpenCL tuner interface.
 124  <a href="classarm__compute_1_1_c_l_tuner.xhtml#details">More...</a></p>
 125
 126 <p><code>#include &lt;<a class="el" href="_c_l_tuner_8h_source.xhtml">CLTuner.h</a>&gt;</code></p>
 127 <div class="dynheader">
 128 Collaboration diagram for CLTuner:</div>
 129 <div class="dyncontent">
 130 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_c_l_tuner__coll__graph.svg" width="87" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
 131 </div>
 132 <center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
 133 <table class="memberdecls">
 134 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 135 Public Member Functions</h2></td></tr>
 136 <tr class="memitem:a7bb33096cd45bb983899ddf84f51c579"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_tuner.xhtml#a7bb33096cd45bb983899ddf84f51c579">CLTuner</a> ()</td></tr>
 137 <tr class="memdesc:a7bb33096cd45bb983899ddf84f51c579"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a7bb33096cd45bb983899ddf84f51c579">More...</a><br/></td></tr>
 138 <tr class="separator:a7bb33096cd45bb983899ddf84f51c579"><td class="memSeparator" colspan="2">&#160;</td></tr>
 139 <tr class="memitem:a577ac5b9d244bdf031905faaf08b968c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_tuner.xhtml#a577ac5b9d244bdf031905faaf08b968c">~CLTuner</a> ()=default</td></tr>
 140 <tr class="memdesc:a577ac5b9d244bdf031905faaf08b968c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#a577ac5b9d244bdf031905faaf08b968c">More...</a><br/></td></tr>
 141 <tr class="separator:a577ac5b9d244bdf031905faaf08b968c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 142 <tr class="memitem:aaf692ee51358d05ca65755a92591f815"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_tuner.xhtml#aaf692ee51358d05ca65755a92591f815">import_lws_table</a> (const std::unordered_map&lt; std::string, cl::NDRange &gt; &amp;lws_table)</td></tr>
 143 <tr class="memdesc:aaf692ee51358d05ca65755a92591f815"><td class="mdescLeft">&#160;</td><td class="mdescRight">Import LWS table.  <a href="#aaf692ee51358d05ca65755a92591f815">More...</a><br/></td></tr>
 144 <tr class="separator:aaf692ee51358d05ca65755a92591f815"><td class="memSeparator" colspan="2">&#160;</td></tr>
 145 <tr class="memitem:adc1bcaa09c238a061fee596d4631aaab"><td class="memItemLeft" align="right" valign="top">const std::unordered_map<br class="typebreak"/>
 146 &lt; std::string, cl::NDRange &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_tuner.xhtml#adc1bcaa09c238a061fee596d4631aaab">export_lws_table</a> ()</td></tr>
 147 <tr class="memdesc:adc1bcaa09c238a061fee596d4631aaab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Export LWS table.  <a href="#adc1bcaa09c238a061fee596d4631aaab">More...</a><br/></td></tr>
 148 <tr class="separator:adc1bcaa09c238a061fee596d4631aaab"><td class="memSeparator" colspan="2">&#160;</td></tr>
 149 <tr class="memitem:a3542e1479b9049456d8256d1442df1ac"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_tuner.xhtml#a3542e1479b9049456d8256d1442df1ac">tune_kernel</a> (<a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml">ICLKernel</a> &amp;kernel) override</td></tr>
 150 <tr class="memdesc:a3542e1479b9049456d8256d1442df1ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tune OpenCL kernel.  <a href="#a3542e1479b9049456d8256d1442df1ac">More...</a><br/></td></tr>
 151 <tr class="separator:a3542e1479b9049456d8256d1442df1ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
 152 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_c_l_tuner"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_c_l_tuner')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_c_l_tuner.xhtml">ICLTuner</a></td></tr>
 153 <tr class="memitem:a7103799fdecd6abca8fc84efebb3653f inherit pub_methods_classarm__compute_1_1_i_c_l_tuner"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_tuner.xhtml#a7103799fdecd6abca8fc84efebb3653f">~ICLTuner</a> ()=default</td></tr>
 154 <tr class="memdesc:a7103799fdecd6abca8fc84efebb3653f inherit pub_methods_classarm__compute_1_1_i_c_l_tuner"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual destructor.  <a href="#a7103799fdecd6abca8fc84efebb3653f">More...</a><br/></td></tr>
 155 <tr class="separator:a7103799fdecd6abca8fc84efebb3653f inherit pub_methods_classarm__compute_1_1_i_c_l_tuner"><td class="memSeparator" colspan="2">&#160;</td></tr>
 156 </table>
 157 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 158 <div class="textblock"><p>Basic implementation of the OpenCL tuner interface. </p>
 159
 160 <p>Definition at line <a class="el" href="_c_l_tuner_8h_source.xhtml#l00037">37</a> of file <a class="el" href="_c_l_tuner_8h_source.xhtml">CLTuner.h</a>.</p>
 161 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 162 <a class="anchor" id="a7bb33096cd45bb983899ddf84f51c579"></a>
 163 <div class="memitem">
 164 <div class="memproto">
 165       <table class="memname">
 166         <tr>
 167           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_tuner.xhtml">CLTuner</a> </td>
 168           <td>(</td>
 169           <td class="paramname"></td><td>)</td>
 170           <td></td>
 171         </tr>
 172       </table>
 173 </div><div class="memdoc">
 174
 175 <p>Constructor. </p>
 176
 177 </div>
 178 </div>
 179 <a class="anchor" id="a577ac5b9d244bdf031905faaf08b968c"></a>
 180 <div class="memitem">
 181 <div class="memproto">
 182 <table class="mlabels">
 183   <tr>
 184   <td class="mlabels-left">
 185       <table class="memname">
 186         <tr>
 187           <td class="memname">~<a class="el" href="classarm__compute_1_1_c_l_tuner.xhtml">CLTuner</a> </td>
 188           <td>(</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>Destructor. </p>
 201
 202 </div>
 203 </div>
 204 <h2 class="groupheader">Member Function Documentation</h2>
 205 <a class="anchor" id="adc1bcaa09c238a061fee596d4631aaab"></a>
 206 <div class="memitem">
 207 <div class="memproto">
 208       <table class="memname">
 209         <tr>
 210           <td class="memname">const std::unordered_map&lt;std::string, cl::NDRange&gt;&amp; export_lws_table </td>
 211           <td>(</td>
 212           <td class="paramname"></td><td>)</td>
 213           <td></td>
 214         </tr>
 215       </table>
 216 </div><div class="memdoc">
 217
 218 <p>Export LWS table. </p>
 219 <p>return The lws table as unordered_map container </p>
 220
 221 </div>
 222 </div>
 223 <a class="anchor" id="aaf692ee51358d05ca65755a92591f815"></a>
 224 <div class="memitem">
 225 <div class="memproto">
 226       <table class="memname">
 227         <tr>
 228           <td class="memname">void import_lws_table </td>
 229           <td>(</td>
 230           <td class="paramtype">const std::unordered_map&lt; std::string, cl::NDRange &gt; &amp;&#160;</td>
 231           <td class="paramname"><em>lws_table</em></td><td>)</td>
 232           <td></td>
 233         </tr>
 234       </table>
 235 </div><div class="memdoc">
 236
 237 <p>Import LWS table. </p>
 238 <dl class="params"><dt>Parameters</dt><dd>
 239   <table class="params">
 240     <tr><td class="paramdir">[in]</td><td class="paramname">lws_table</td><td>The unordered_map container to import </td></tr>
 241   </table>
 242   </dd>
 243 </dl>
 244
 245 </div>
 246 </div>
 247 <a class="anchor" id="a3542e1479b9049456d8256d1442df1ac"></a>
 248 <div class="memitem">
 249 <div class="memproto">
 250 <table class="mlabels">
 251   <tr>
 252   <td class="mlabels-left">
 253       <table class="memname">
 254         <tr>
 255           <td class="memname">void tune_kernel </td>
 256           <td>(</td>
 257           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml">ICLKernel</a> &amp;&#160;</td>
 258           <td class="paramname"><em>kernel</em></td><td>)</td>
 259           <td></td>
 260         </tr>
 261       </table>
 262   </td>
 263   <td class="mlabels-right">
 264 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
 265   </tr>
 266 </table>
 267 </div><div class="memdoc">
 268
 269 <p>Tune OpenCL kernel. </p>
 270 <dl class="params"><dt>Parameters</dt><dd>
 271   <table class="params">
 272     <tr><td class="paramdir">[in]</td><td class="paramname">kernel</td><td><a class="el" href="classarm__compute_1_1_kernel.xhtml" title="Kernel class. ">Kernel</a> to tune </td></tr>
 273   </table>
 274   </dd>
 275 </dl>
 276
 277 <p>Implements <a class="el" href="classarm__compute_1_1_i_c_l_tuner.xhtml#aa3e463ed247bccd80278280791943d79">ICLTuner</a>.</p>
 278
 279 </div>
 280 </div>
 281 <hr/>The documentation for this class was generated from the following file:<ul>
 282 <li>arm_compute/runtime/CL/<a class="el" href="_c_l_tuner_8h_source.xhtml">CLTuner.h</a></li>
 283 </ul>
 284 </div><!-- contents -->
 285 </div><!-- doc-content -->
 286 <!-- start footer part -->
 287 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 288   <ul>
 289     <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_tuner.xhtml">CLTuner</a></li>
 290     <li class="footer">Generated on Thu Oct 12 2017 14:26:37 for Compute Library by
 291     <a href="http://www.doxygen.org/index.html">
 292     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
 293   </ul>
 294 </div>
 295 </body>
 296 </html>