blob: 63f672fd7ed31c96d42b3c4761ade8adf3cf7354 [file] [log] [blame]
<!-- HTML header for doxygen 1.8.15-->
<!-- Remember to use version doxygen 1.8.15 +-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
<title>Compute Library: ICLTuner Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="stylesheet.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<img alt="Compute Library" src="https://raw.githubusercontent.com/ARM-software/ComputeLibrary/gh-pages/ACL_logo.png" style="max-width: 100%;margin-top: 15px;margin-left: 10px"/>
<td style="padding-left: 0.5em;">
<div id="projectname">
&#160;<span id="projectnumber">20.02.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classarm__compute_1_1_i_c_l_tuner.xhtml','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">ICLTuner Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Basic interface for tuning the OpenCL kernels.
<a href="classarm__compute_1_1_i_c_l_tuner.xhtml#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_i_c_l_tuner_8h_source.xhtml">ICLTuner.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<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>
<tr class="memdesc:a7103799fdecd6abca8fc84efebb3653f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual destructor. <a href="#a7103799fdecd6abca8fc84efebb3653f">More...</a><br /></td></tr>
<tr class="separator:a7103799fdecd6abca8fc84efebb3653f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a384fdc1bc38a4fc6e79af675cc4aa8e3"><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#a384fdc1bc38a4fc6e79af675cc4aa8e3">tune_kernel_static</a> (<a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml">ICLKernel</a> &amp;kernel)=0</td></tr>
<tr class="memdesc:a384fdc1bc38a4fc6e79af675cc4aa8e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tune OpenCL kernel statically. <a href="#a384fdc1bc38a4fc6e79af675cc4aa8e3">More...</a><br /></td></tr>
<tr class="separator:a384fdc1bc38a4fc6e79af675cc4aa8e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae12d76ff3471c1f73c62b7c65addc1ec"><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#ae12d76ff3471c1f73c62b7c65addc1ec">tune_kernel_dynamic</a> (<a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml">ICLKernel</a> &amp;kernel)=0</td></tr>
<tr class="memdesc:ae12d76ff3471c1f73c62b7c65addc1ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tune OpenCL kernel dynamically. <a href="#ae12d76ff3471c1f73c62b7c65addc1ec">More...</a><br /></td></tr>
<tr class="separator:ae12d76ff3471c1f73c62b7c65addc1ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Basic interface for tuning the OpenCL kernels. </p>
<p class="definition">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>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a7103799fdecd6abca8fc84efebb3653f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7103799fdecd6abca8fc84efebb3653f">&#9670;&nbsp;</a></span>~ICLTuner()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual ~<a class="el" href="classarm__compute_1_1_i_c_l_tuner.xhtml">ICLTuner</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Virtual destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ae12d76ff3471c1f73c62b7c65addc1ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae12d76ff3471c1f73c62b7c65addc1ec">&#9670;&nbsp;</a></span>tune_kernel_dynamic()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void tune_kernel_dynamic </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml">ICLKernel</a> &amp;&#160;</td>
<td class="paramname"><em>kernel</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Tune OpenCL kernel dynamically. </p>
<dl class="section note"><dt>Note</dt><dd>Tuning requires memory to be available on all kernel tensors and objects in order to be performed</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<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>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classarm__compute_1_1_c_l_tuner.xhtml#af073b532560e2105dd22d381f5888ce7">CLTuner</a>, <a class="el" href="classarm__compute_1_1tuners_1_1_bifrost_tuner.xhtml#af073b532560e2105dd22d381f5888ce7">BifrostTuner</a>, and <a class="el" href="classarm__compute_1_1tuners_1_1_midgard_tuner.xhtml#af073b532560e2105dd22d381f5888ce7">MidgardTuner</a>.</p>
<p class="reference">Referenced by <a class="el" href="_c_l_scheduler_8cpp_source.xhtml#l00154">CLScheduler::enqueue()</a>.</p>
</div>
</div>
<a id="a384fdc1bc38a4fc6e79af675cc4aa8e3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a384fdc1bc38a4fc6e79af675cc4aa8e3">&#9670;&nbsp;</a></span>tune_kernel_static()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void tune_kernel_static </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classarm__compute_1_1_i_c_l_kernel.xhtml">ICLKernel</a> &amp;&#160;</td>
<td class="paramname"><em>kernel</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Tune OpenCL kernel statically. </p>
<dl class="section note"><dt>Note</dt><dd>Tuning is performed using only kernel and tensor metadata, thus can be performed when memory is not available</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<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>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classarm__compute_1_1_c_l_tuner.xhtml#a52f755d664bbdcb9346cdf5cc4a7e958">CLTuner</a>, <a class="el" href="classarm__compute_1_1tuners_1_1_bifrost_tuner.xhtml#a52f755d664bbdcb9346cdf5cc4a7e958">BifrostTuner</a>, and <a class="el" href="classarm__compute_1_1tuners_1_1_midgard_tuner.xhtml#a52f755d664bbdcb9346cdf5cc4a7e958">MidgardTuner</a>.</p>
<p class="reference">Referenced by <a class="el" href="_c_l_scheduler_8cpp_source.xhtml#l00079">CLScheduler::tune_kernel_static()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>arm_compute/runtime/CL/<a class="el" href="_i_c_l_tuner_8h_source.xhtml">ICLTuner.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<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>
<li class="footer">Generated on Thu Mar 5 2020 16:07:14 for Compute Library by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
</ul>
</div>
</body>
</html>