blob: 8b6081fb43eefcadebf3695b89ec09d4d0d833a9 [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: gemm_tuner Namespace 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">19.11</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('namespacegemm__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="#nested-classes">Data Structures</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">gemm_tuner Namespace Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgemm__tuner_1_1_common_gemm_example_options.xhtml">CommonGemmExampleOptions</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Common command line options used to configure the gemm examples. <a href="classgemm__tuner_1_1_common_gemm_example_options.xhtml#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgemm__tuner_1_1_common_gemm_example_params.xhtml">CommonGemmExampleParams</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Structure holding all the common gemm example parameters. <a href="structgemm__tuner_1_1_common_gemm_example_params.xhtml#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ad411bfdd8c7a3e0761292a9b39c8d274"><td class="memItemLeft" align="right" valign="top">::std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegemm__tuner.xhtml#ad411bfdd8c7a3e0761292a9b39c8d274">operator&lt;&lt;</a> (::std::ostream &amp;os, const <a class="el" href="structgemm__tuner_1_1_common_gemm_example_params.xhtml">CommonGemmExampleParams</a> &amp;common_params)</td></tr>
<tr class="memdesc:ad411bfdd8c7a3e0761292a9b39c8d274"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formatted output of the <a class="el" href="structgemm__tuner_1_1_common_gemm_example_params.xhtml" title="Structure holding all the common gemm example parameters.">CommonGemmExampleParams</a> type. <a href="#ad411bfdd8c7a3e0761292a9b39c8d274">More...</a><br /></td></tr>
<tr class="separator:ad411bfdd8c7a3e0761292a9b39c8d274"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a30dd718651ae4079e550cbc20f51f44b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgemm__tuner_1_1_common_gemm_example_params.xhtml">CommonGemmExampleParams</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegemm__tuner.xhtml#a30dd718651ae4079e550cbc20f51f44b">consume_common_gemm_example_parameters</a> (const <a class="el" href="classgemm__tuner_1_1_common_gemm_example_options.xhtml">CommonGemmExampleOptions</a> &amp;options)</td></tr>
<tr class="memdesc:a30dd718651ae4079e550cbc20f51f44b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Consumes the common gemm example options and creates a structure containing all information. <a href="#a30dd718651ae4079e550cbc20f51f44b">More...</a><br /></td></tr>
<tr class="separator:a30dd718651ae4079e550cbc20f51f44b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="a30dd718651ae4079e550cbc20f51f44b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a30dd718651ae4079e550cbc20f51f44b">&#9670;&nbsp;</a></span>consume_common_gemm_example_parameters()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structgemm__tuner_1_1_common_gemm_example_params.xhtml">CommonGemmExampleParams</a> consume_common_gemm_example_parameters </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgemm__tuner_1_1_common_gemm_example_options.xhtml">CommonGemmExampleOptions</a> &amp;&#160;</td>
<td class="paramname"><em>options</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Consumes the common gemm example options and creates a structure containing all information. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">options</td><td>Options to consume</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Structure containing the common gemm example parameters </dd></dl>
<p class="definition">Definition at line <a class="el" href="_common_gemm_example_options_8cpp_source.xhtml#l00054">54</a> of file <a class="el" href="_common_gemm_example_options_8cpp_source.xhtml">CommonGemmExampleOptions.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;{</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; CommonGemmExampleParams common_params;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; common_params.M = options.M-&gt;value();</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; common_params.N = options.N-&gt;value();</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; common_params.K = options.K-&gt;value();</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; common_params.B = options.B-&gt;value();</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keywordflow">return</span> common_params;</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;}</div></div><!-- fragment -->
<p class="reference">References <a class="el" href="_common_gemm_example_options_8h_source.xhtml#l00038">CommonGemmExampleParams::B</a>, <a class="el" href="_common_gemm_example_options_8h_source.xhtml#l00082">CommonGemmExampleOptions::B</a>, <a class="el" href="_common_gemm_example_options_8h_source.xhtml#l00037">CommonGemmExampleParams::K</a>, <a class="el" href="_common_gemm_example_options_8h_source.xhtml#l00081">CommonGemmExampleOptions::K</a>, <a class="el" href="_common_gemm_example_options_8h_source.xhtml#l00035">CommonGemmExampleParams::M</a>, <a class="el" href="_common_gemm_example_options_8h_source.xhtml#l00079">CommonGemmExampleOptions::M</a>, <a class="el" href="_common_gemm_example_options_8h_source.xhtml#l00036">CommonGemmExampleParams::N</a>, <a class="el" href="_common_gemm_example_options_8h_source.xhtml#l00080">CommonGemmExampleOptions::N</a>, and <a class="el" href="_simple_option_8h_source.xhtml#l00112">SimpleOption&lt; T &gt;::value()</a>.</p>
</div>
</div>
<a id="ad411bfdd8c7a3e0761292a9b39c8d274"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad411bfdd8c7a3e0761292a9b39c8d274">&#9670;&nbsp;</a></span>operator&lt;&lt;()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::ostream &amp; operator&lt;&lt; </td>
<td>(</td>
<td class="paramtype">::std::ostream &amp;&#160;</td>
<td class="paramname"><em>os</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structgemm__tuner_1_1_common_gemm_example_params.xhtml">CommonGemmExampleParams</a> &amp;&#160;</td>
<td class="paramname"><em>common_params</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Formatted output of the <a class="el" href="structgemm__tuner_1_1_common_gemm_example_params.xhtml" title="Structure holding all the common gemm example parameters.">CommonGemmExampleParams</a> type. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">os</td><td>Output stream. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">common_params</td><td>Common parameters to output</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Modified output stream. </dd></dl>
<p class="definition">Definition at line <a class="el" href="_common_gemm_example_options_8cpp_source.xhtml#l00031">31</a> of file <a class="el" href="_common_gemm_example_options_8cpp_source.xhtml">CommonGemmExampleOptions.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;{</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; os &lt;&lt; <span class="stringliteral">&quot;M : &quot;</span> &lt;&lt; common_params.M &lt;&lt; std::endl;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; os &lt;&lt; <span class="stringliteral">&quot;N : &quot;</span> &lt;&lt; common_params.N &lt;&lt; std::endl;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; os &lt;&lt; <span class="stringliteral">&quot;K : &quot;</span> &lt;&lt; common_params.K &lt;&lt; std::endl;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; os &lt;&lt; <span class="stringliteral">&quot;B : &quot;</span> &lt;&lt; common_params.B &lt;&lt; std::endl;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keywordflow">return</span> os;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;}</div></div><!-- fragment -->
<p class="reference">References <a class="el" href="_common_gemm_example_options_8h_source.xhtml#l00038">CommonGemmExampleParams::B</a>, <a class="el" href="_common_gemm_example_options_8h_source.xhtml#l00037">CommonGemmExampleParams::K</a>, <a class="el" href="_common_gemm_example_options_8h_source.xhtml#l00035">CommonGemmExampleParams::M</a>, and <a class="el" href="_common_gemm_example_options_8h_source.xhtml#l00036">CommonGemmExampleParams::N</a>.</p>
</div>
</div>
</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="namespacegemm__tuner.xhtml">gemm_tuner</a></li>
<li class="footer">Generated on Thu Nov 28 2019 16:53:21 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>