documentation/classarm__compute_1_1_i_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: ICLTuner 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.09</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_i_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">ICLTuner Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
 120 </div><!--header-->
 121 <div class="contents">
 122
 123 <p>Basic interface for tuning the OpenCL kernels.
 124  <a href="classarm__compute_1_1_i_c_l_tuner.xhtml#details">More...</a></p>
 125
 126 <p><code>#include &lt;<a class="el" href="_i_c_l_tuner_8h_source.xhtml">ICLTuner.h</a>&gt;</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:a7103799fdecd6abca8fc84efebb3653f"><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>
 131 <tr class="memdesc:a7103799fdecd6abca8fc84efebb3653f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual destructor.  <a href="#a7103799fdecd6abca8fc84efebb3653f">More...</a><br/></td></tr>
 132 <tr class="separator:a7103799fdecd6abca8fc84efebb3653f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 133 <tr class="memitem:aa3e463ed247bccd80278280791943d79"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_tuner.xhtml#aa3e463ed247bccd80278280791943d79">tune_kernel</a> (<a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml">ICLKernel</a> &amp;kernel)=0</td></tr>
 134 <tr class="memdesc:aa3e463ed247bccd80278280791943d79"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tune OpenCL kernel.  <a href="#aa3e463ed247bccd80278280791943d79">More...</a><br/></td></tr>
 135 <tr class="separator:aa3e463ed247bccd80278280791943d79"><td class="memSeparator" colspan="2">&#160;</td></tr>
 136 </table>
 137 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 138 <div class="textblock"><p>Basic interface for tuning the OpenCL kernels. </p>
 139
 140 <p>Definition at line <a class="el" href="_i_c_l_tuner_8h_source.xhtml#l00032">32</a> of file <a class="el" href="_i_c_l_tuner_8h_source.xhtml">ICLTuner.h</a>.</p>
 141 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 142 <a class="anchor" id="a7103799fdecd6abca8fc84efebb3653f"></a>
 143 <div class="memitem">
 144 <div class="memproto">
 145 <table class="mlabels">
 146   <tr>
 147   <td class="mlabels-left">
 148       <table class="memname">
 149         <tr>
 150           <td class="memname">virtual ~<a class="el" href="classarm__compute_1_1_i_c_l_tuner.xhtml">ICLTuner</a> </td>
 151           <td>(</td>
 152           <td class="paramname"></td><td>)</td>
 153           <td></td>
 154         </tr>
 155       </table>
 156   </td>
 157   <td class="mlabels-right">
 158 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span>  </td>
 159   </tr>
 160 </table>
 161 </div><div class="memdoc">
 162
 163 <p>Virtual destructor. </p>
 164
 165 </div>
 166 </div>
 167 <h2 class="groupheader">Member Function Documentation</h2>
 168 <a class="anchor" id="aa3e463ed247bccd80278280791943d79"></a>
 169 <div class="memitem">
 170 <div class="memproto">
 171 <table class="mlabels">
 172   <tr>
 173   <td class="mlabels-left">
 174       <table class="memname">
 175         <tr>
 176           <td class="memname">virtual void tune_kernel </td>
 177           <td>(</td>
 178           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml">ICLKernel</a> &amp;&#160;</td>
 179           <td class="paramname"><em>kernel</em></td><td>)</td>
 180           <td></td>
 181         </tr>
 182       </table>
 183   </td>
 184   <td class="mlabels-right">
 185 <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
 186   </tr>
 187 </table>
 188 </div><div class="memdoc">
 189
 190 <p>Tune OpenCL kernel. </p>
 191 <dl class="params"><dt>Parameters</dt><dd>
 192   <table class="params">
 193     <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>
 194   </table>
 195   </dd>
 196 </dl>
 197
 198 <p>Implemented in <a class="el" href="classarm__compute_1_1_c_l_tuner.xhtml#a3542e1479b9049456d8256d1442df1ac">CLTuner</a>.</p>
 199
 200 </div>
 201 </div>
 202 <hr/>The documentation for this class was generated from the following file:<ul>
 203 <li>arm_compute/runtime/CL/<a class="el" href="_i_c_l_tuner_8h_source.xhtml">ICLTuner.h</a></li>
 204 </ul>
 205 </div><!-- contents -->
 206 </div><!-- doc-content -->
 207 <!-- start footer part -->
 208 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 209   <ul>
 210     <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_tuner.xhtml">ICLTuner</a></li>
 211     <li class="footer">Generated on Thu Sep 28 2017 14:37:58 for Compute Library by
 212     <a href="http://www.doxygen.org/index.html">
 213     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
 214   </ul>
 215 </div>
 216 </body>
 217 </html>