Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ComputeLibrary / 7f09cf7dfba61aad6d6d588b1b096f56bafaad5e / . / documentation / namespacegemm__tuner.xhtml
blob: 2968576f6f29fcfa362984788d9c78522bc7cc64 [file] [log] [blame]
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]1<!-- HTML header for doxygen 1.8.15-->
2<!-- Remember to use version doxygen 1.8.15 +-->
3<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml">
5<head>
6<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
7<meta http-equiv="X-UA-Compatible" content="IE=9"/>
8<meta name="generator" content="Doxygen 1.8.15"/>
9<meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
10<title>Compute Library: gemm_tuner Namespace Reference</title>
11<link href="tabs.css" rel="stylesheet" type="text/css"/>
12<script type="text/javascript" src="jquery.js"></script>
13<script type="text/javascript" src="dynsections.js"></script>
14<link href="navtree.css" rel="stylesheet" type="text/css"/>
15<script type="text/javascript" src="resize.js"></script>
16<script type="text/javascript" src="navtreedata.js"></script>
17<script type="text/javascript" src="navtree.js"></script>
18<script type="text/javascript">
19/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
20 $(document).ready(initResizable);
21/* @license-end */</script>
22<link href="search/search.css" rel="stylesheet" type="text/css"/>
23<script type="text/javascript" src="search/searchdata.js"></script>
24<script type="text/javascript" src="search/search.js"></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 type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
31<link href="doxygen.css" rel="stylesheet" type="text/css" />
32<link href="stylesheet.css" rel="stylesheet" type="text/css"/>
33</head>
34<body>
35<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
36<div id="titlearea">
37<table cellspacing="0" cellpadding="0">
38 <tbody>
39 <tr style="height: 56px;">
40 <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"/>
41 <td style="padding-left: 0.5em;">
42 <div id="projectname">
Jenkins7f09cf72020-01-22 18:08:16 +0000[diff] [blame^]43 &#160;<span id="projectnumber">19.11.1</span>
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]44 </div>
45 </td>
46 </tr>
47 </tbody>
48</table>
49</div>
50<!-- end header part -->
51<!-- Generated by Doxygen 1.8.15 -->
52<script type="text/javascript">
53/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
54var searchBox = new SearchBox("searchBox", "search",false,'Search');
55/* @license-end */
56</script>
57<script type="text/javascript" src="menudata.js"></script>
58<script type="text/javascript" src="menu.js"></script>
59<script type="text/javascript">
60/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
61$(function() {
62 initMenu('',true,false,'search.php','Search');
63 $(document).ready(function() { init_search(); });
64});
65/* @license-end */</script>
66<div id="main-nav"></div>
67</div><!-- top -->
68<div id="side-nav" class="ui-resizable side-nav-resizable">
69 <div id="nav-tree">
70 <div id="nav-tree-contents">
71 <div id="nav-sync" class="sync"></div>
72 </div>
73 </div>
74 <div id="splitbar" style="-moz-user-select:none;"
75 class="ui-resizable-handle">
76 </div>
77</div>
78<script type="text/javascript">
79/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
80$(document).ready(function(){initNavTree('namespacegemm__tuner.xhtml','');});
81/* @license-end */
82</script>
83<div id="doc-content">
84<!-- window showing the filter options -->
85<div id="MSearchSelectWindow"
86 onmouseover="return searchBox.OnSearchSelectShow()"
87 onmouseout="return searchBox.OnSearchSelectHide()"
88 onkeydown="return searchBox.OnSearchSelectKey(event)">
89</div>
90
91<!-- iframe showing the search results (closed by default) -->
92<div id="MSearchResultsWindow">
93<iframe src="javascript:void(0)" frameborder="0"
94 name="MSearchResults" id="MSearchResults">
95</iframe>
96</div>
97
98<div class="header">
99 <div class="summary">
100<a href="#nested-classes">Data Structures</a> &#124;
101<a href="#func-members">Functions</a> </div>
102 <div class="headertitle">
103<div class="title">gemm_tuner Namespace Reference</div> </div>
104</div><!--header-->
105<div class="contents">
106<table class="memberdecls">
107<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
108Data Structures</h2></td></tr>
109<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>
110<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>
111<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
112<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>
113<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>
114<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
115</table><table class="memberdecls">
116<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
117Functions</h2></td></tr>
118<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>
119<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>
120<tr class="separator:ad411bfdd8c7a3e0761292a9b39c8d274"><td class="memSeparator" colspan="2">&#160;</td></tr>
121<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>
122<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>
123<tr class="separator:a30dd718651ae4079e550cbc20f51f44b"><td class="memSeparator" colspan="2">&#160;</td></tr>
124</table>
125<h2 class="groupheader">Function Documentation</h2>
126<a id="a30dd718651ae4079e550cbc20f51f44b"></a>
127<h2 class="memtitle"><span class="permalink"><a href="#a30dd718651ae4079e550cbc20f51f44b">&#9670;&nbsp;</a></span>consume_common_gemm_example_parameters()</h2>
128
129<div class="memitem">
130<div class="memproto">
131 <table class="memname">
132 <tr>
133 <td class="memname"><a class="el" href="structgemm__tuner_1_1_common_gemm_example_params.xhtml">CommonGemmExampleParams</a> consume_common_gemm_example_parameters </td>
134 <td>(</td>
135 <td class="paramtype">const <a class="el" href="classgemm__tuner_1_1_common_gemm_example_options.xhtml">CommonGemmExampleOptions</a> &amp;&#160;</td>
136 <td class="paramname"><em>options</em></td><td>)</td>
137 <td></td>
138 </tr>
139 </table>
140</div><div class="memdoc">
141
142<p>Consumes the common gemm example options and creates a structure containing all information. </p>
143<dl class="params"><dt>Parameters</dt><dd>
144 <table class="params">
145 <tr><td class="paramdir">[in]</td><td class="paramname">options</td><td>Options to consume</td></tr>
146 </table>
147 </dd>
148</dl>
149<dl class="section return"><dt>Returns</dt><dd>Structure containing the common gemm example parameters </dd></dl>
150
151<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>
152<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 -->
153<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>
154
155</div>
156</div>
157<a id="ad411bfdd8c7a3e0761292a9b39c8d274"></a>
158<h2 class="memtitle"><span class="permalink"><a href="#ad411bfdd8c7a3e0761292a9b39c8d274">&#9670;&nbsp;</a></span>operator&lt;&lt;()</h2>
159
160<div class="memitem">
161<div class="memproto">
162 <table class="memname">
163 <tr>
164 <td class="memname">std::ostream &amp; operator&lt;&lt; </td>
165 <td>(</td>
166 <td class="paramtype">::std::ostream &amp;&#160;</td>
167 <td class="paramname"><em>os</em>, </td>
168 </tr>
169 <tr>
170 <td class="paramkey"></td>
171 <td></td>
172 <td class="paramtype">const <a class="el" href="structgemm__tuner_1_1_common_gemm_example_params.xhtml">CommonGemmExampleParams</a> &amp;&#160;</td>
173 <td class="paramname"><em>common_params</em>&#160;</td>
174 </tr>
175 <tr>
176 <td></td>
177 <td>)</td>
178 <td></td><td></td>
179 </tr>
180 </table>
181</div><div class="memdoc">
182
183<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>
184<dl class="params"><dt>Parameters</dt><dd>
185 <table class="params">
186 <tr><td class="paramdir">[out]</td><td class="paramname">os</td><td>Output stream. </td></tr>
187 <tr><td class="paramdir">[in]</td><td class="paramname">common_params</td><td>Common parameters to output</td></tr>
188 </table>
189 </dd>
190</dl>
191<dl class="section return"><dt>Returns</dt><dd>Modified output stream. </dd></dl>
192
193<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>
194<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 -->
195<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>
196
197</div>
198</div>
199</div><!-- contents -->
200</div><!-- doc-content -->
201<!-- start footer part -->
202<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
203 <ul>
204 <li class="navelem"><a class="el" href="namespacegemm__tuner.xhtml">gemm_tuner</a></li>
Jenkins7f09cf72020-01-22 18:08:16 +0000[diff] [blame^]205 <li class="footer">Generated on Wed Jan 22 2020 18:08:01 for Compute Library by
Jenkins0e205f72019-11-28 16:53:35 +0000[diff] [blame]206 <a href="http://www.doxygen.org/index.html">
207 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
208 </ul>
209</div>
210</body>
211</html>