IVGCVSW-3726 Upload ArmNN Doxygen files
* Upload current ArmNN Doxygen files
Signed-off-by: Ryan OShea <Ryan.OShea2@arm.com>
Change-Id: I8989ed16ee40a99a4495b100bd009cf3e24a7285
diff --git a/Documentation/_cl_context_control_8hpp_source.xhtml b/Documentation/_cl_context_control_8hpp_source.xhtml
new file mode 100644
index 0000000..ed0ac59
--- /dev/null
+++ b/Documentation/_cl_context_control_8hpp_source.xhtml
@@ -0,0 +1,129 @@
+<!-- Copyright (c) 2020 ARM Limited. -->
+<!-- -->
+<!-- SPDX-License-Identifier: MIT -->
+<!-- -->
+<!-- HTML header for doxygen 1.8.13-->
+<!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.13"/>
+<meta name="robots" content="NOINDEX, NOFOLLOW" />
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<title>ArmNN: src/backends/cl/ClContextControl.hpp Source File</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">
+ $(document).ready(initResizable);
+</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" 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="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 10rem; margin-top: .5rem; margin-left 10px"/>
+ <td style="padding-left: 0.5em;">
+ <div id="projectname">
+  <span id="projectnumber">20.02</span>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- Generated by Doxygen 1.8.13 -->
+<script type="text/javascript">
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+</script>
+<script type="text/javascript" src="menudata.js"></script>
+<script type="text/javascript" src="menu.js"></script>
+<script type="text/javascript">
+$(function() {
+ initMenu('',true,false,'search.php','Search');
+ $(document).ready(function() { init_search(); });
+});
+</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">
+$(document).ready(function(){initNavTree('_cl_context_control_8hpp_source.xhtml','');});
+</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="headertitle">
+<div class="title">ClContextControl.hpp</div> </div>
+</div><!--header-->
+<div class="contents">
+<a href="_cl_context_control_8hpp.xhtml">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// Copyright © 2017 Arm Ltd. All rights reserved.</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// SPDX-License-Identifier: MIT</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">//</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> </div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include "<a class="code" href="_i_runtime_8hpp.xhtml">armnn/IRuntime.hpp</a>"</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include <arm_compute/runtime/CL/CLTuner.h></span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="keyword">namespace </span><a class="code" href="namespacearmnn.xhtml">armnn</a></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> {</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> </div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// ARM Compute OpenCL context control.</span></div><div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="classarmnn_1_1_cl_context_control.xhtml"> 15</a></span> <span class="keyword">class </span><a class="code" href="classarmnn_1_1_cl_context_control.xhtml">ClContextControl</a></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> {</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  <a class="code" href="classarmnn_1_1_cl_context_control.xhtml#a9bcfa10ff6150c7210b9b0e5deffc203">ClContextControl</a>(arm_compute::CLTuner* = <span class="keyword">nullptr</span>,</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  <span class="keywordtype">bool</span> profilingEnabled = <span class="keyword">false</span>);</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  <span class="keyword">virtual</span> <a class="code" href="classarmnn_1_1_cl_context_control.xhtml#a9d4f5387dafdafbb86aac00586c58a79">~ClContextControl</a>();</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1_cl_context_control.xhtml#a80ef362b80b514620da9fd8f6a3ba518">LoadOpenClRuntime</a>();</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="comment">// Users should call this (after freeing all of the cl::Context objects they use)</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="comment">// to release the cached memory used by the compute library.</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1_cl_context_control.xhtml#a48f639543a69fe342fec2021b9dfd1d4">UnloadOpenClRuntime</a>();</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="comment">// Clear the CL cache, without losing the tuned parameter settings.</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1_cl_context_control.xhtml#a8f6d5a750a23d418fee0210de4e85c13">ClearClCache</a>();</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keywordtype">void</span> DoLoadOpenClRuntime(<span class="keywordtype">bool</span> updateTunedParameters);</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  arm_compute::CLTuner* m_Tuner;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordtype">bool</span> m_ProfilingEnabled;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> };</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="classarmnn_1_1_cl_tuned_parameters.xhtml"> 42</a></span> <span class="keyword">class </span><a class="code" href="classarmnn_1_1_cl_tuned_parameters.xhtml">ClTunedParameters</a> : <span class="keyword">public</span> <a class="code" href="classarmnn_1_1_i_gpu_acc_tuned_parameters.xhtml">IGpuAccTunedParameters</a></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> {</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <a class="code" href="classarmnn_1_1_cl_tuned_parameters.xhtml">ClTunedParameters</a>(<a class="code" href="classarmnn_1_1_i_gpu_acc_tuned_parameters.xhtml#a46c8a310cf4c094f8c80e1cb8dc1f911">armnn::IGpuAccTunedParameters::Mode</a> mode, <a class="code" href="classarmnn_1_1_i_gpu_acc_tuned_parameters.xhtml#a707090747256af276c389e0cf1cb0a9a">armnn::IGpuAccTunedParameters::TuningLevel</a> tuningLevel);</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> Load(<span class="keyword">const</span> <span class="keywordtype">char</span>* filename);</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> Save(<span class="keyword">const</span> <span class="keywordtype">char</span>* filename) <span class="keyword">const</span>;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="classarmnn_1_1_cl_tuned_parameters.xhtml#a22f392e24a1f2155875e3063a7491e4d"> 50</a></span>  <a class="code" href="classarmnn_1_1_i_gpu_acc_tuned_parameters.xhtml#a46c8a310cf4c094f8c80e1cb8dc1f911">Mode</a> <a class="code" href="classarmnn_1_1_cl_tuned_parameters.xhtml#a22f392e24a1f2155875e3063a7491e4d">m_Mode</a>;</div><div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="classarmnn_1_1_cl_tuned_parameters.xhtml#ab277b661f23f9ff45b28027f47a126ef"> 51</a></span>  <a class="code" href="namespacearmnn.xhtml#a707090747256af276c389e0cf1cb0a9a">TuningLevel</a> <a class="code" href="classarmnn_1_1_cl_tuned_parameters.xhtml#ab277b661f23f9ff45b28027f47a126ef">m_TuningLevel</a>;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="classarmnn_1_1_cl_tuned_parameters.xhtml#af6747d9aa587bd8b4ded70fbdcbe1d4a"> 53</a></span>  arm_compute::CLTuner <a class="code" href="classarmnn_1_1_cl_tuned_parameters.xhtml#af6747d9aa587bd8b4ded70fbdcbe1d4a">m_Tuner</a>;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> };</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> } <span class="comment">// namespace armnn</span></div><div class="ttc" id="classarmnn_1_1_cl_context_control_xhtml"><div class="ttname"><a href="classarmnn_1_1_cl_context_control.xhtml">armnn::ClContextControl</a></div><div class="ttdef"><b>Definition:</b> <a href="_cl_context_control_8hpp_source.xhtml#l00015">ClContextControl.hpp:15</a></div></div>
+<div class="ttc" id="classarmnn_1_1_cl_context_control_xhtml_a9bcfa10ff6150c7210b9b0e5deffc203"><div class="ttname"><a href="classarmnn_1_1_cl_context_control.xhtml#a9bcfa10ff6150c7210b9b0e5deffc203">armnn::ClContextControl::ClContextControl</a></div><div class="ttdeci">ClContextControl(arm_compute::CLTuner *=nullptr, bool profilingEnabled=false)</div><div class="ttdef"><b>Definition:</b> <a href="_cl_context_control_8cpp_source.xhtml#l00031">ClContextControl.cpp:31</a></div></div>
+<div class="ttc" id="_i_runtime_8hpp_xhtml"><div class="ttname"><a href="_i_runtime_8hpp.xhtml">IRuntime.hpp</a></div></div>
+<div class="ttc" id="namespacearmnn_xhtml"><div class="ttname"><a href="namespacearmnn.xhtml">armnn</a></div><div class="ttdoc">Copyright (c) 2020 ARM Limited. </div><div class="ttdef"><b>Definition:</b> <a href="00__introduction_8dox_source.xhtml#l00025">00_introduction.dox:25</a></div></div>
+<div class="ttc" id="classarmnn_1_1_i_gpu_acc_tuned_parameters_xhtml_a46c8a310cf4c094f8c80e1cb8dc1f911"><div class="ttname"><a href="classarmnn_1_1_i_gpu_acc_tuned_parameters.xhtml#a46c8a310cf4c094f8c80e1cb8dc1f911">armnn::IGpuAccTunedParameters::Mode</a></div><div class="ttdeci">Mode</div><div class="ttdef"><b>Definition:</b> <a href="_i_runtime_8hpp_source.xhtml#l00186">IRuntime.hpp:186</a></div></div>
+<div class="ttc" id="classarmnn_1_1_cl_context_control_xhtml_a8f6d5a750a23d418fee0210de4e85c13"><div class="ttname"><a href="classarmnn_1_1_cl_context_control.xhtml#a8f6d5a750a23d418fee0210de4e85c13">armnn::ClContextControl::ClearClCache</a></div><div class="ttdeci">void ClearClCache()</div><div class="ttdef"><b>Definition:</b> <a href="_cl_context_control_8cpp_source.xhtml#l00163">ClContextControl.cpp:163</a></div></div>
+<div class="ttc" id="namespacearmnn_xhtml_a707090747256af276c389e0cf1cb0a9a"><div class="ttname"><a href="namespacearmnn.xhtml#a707090747256af276c389e0cf1cb0a9a">armnn::TuningLevel</a></div><div class="ttdeci">TuningLevel</div><div class="ttdef"><b>Definition:</b> <a href="_cl_backend_context_8cpp_source.xhtml#l00069">ClBackendContext.cpp:69</a></div></div>
+<div class="ttc" id="classarmnn_1_1_i_gpu_acc_tuned_parameters_xhtml_a707090747256af276c389e0cf1cb0a9a"><div class="ttname"><a href="classarmnn_1_1_i_gpu_acc_tuned_parameters.xhtml#a707090747256af276c389e0cf1cb0a9a">armnn::IGpuAccTunedParameters::TuningLevel</a></div><div class="ttdeci">TuningLevel</div><div class="ttdef"><b>Definition:</b> <a href="_i_runtime_8hpp_source.xhtml#l00192">IRuntime.hpp:192</a></div></div>
+<div class="ttc" id="classarmnn_1_1_cl_context_control_xhtml_a9d4f5387dafdafbb86aac00586c58a79"><div class="ttname"><a href="classarmnn_1_1_cl_context_control.xhtml#a9d4f5387dafdafbb86aac00586c58a79">armnn::ClContextControl::~ClContextControl</a></div><div class="ttdeci">virtual ~ClContextControl()</div><div class="ttdef"><b>Definition:</b> <a href="_cl_context_control_8cpp_source.xhtml#l00072">ClContextControl.cpp:72</a></div></div>
+<div class="ttc" id="classarmnn_1_1_cl_tuned_parameters_xhtml"><div class="ttname"><a href="classarmnn_1_1_cl_tuned_parameters.xhtml">armnn::ClTunedParameters</a></div><div class="ttdef"><b>Definition:</b> <a href="_cl_context_control_8hpp_source.xhtml#l00042">ClContextControl.hpp:42</a></div></div>
+<div class="ttc" id="classarmnn_1_1_cl_tuned_parameters_xhtml_af6747d9aa587bd8b4ded70fbdcbe1d4a"><div class="ttname"><a href="classarmnn_1_1_cl_tuned_parameters.xhtml#af6747d9aa587bd8b4ded70fbdcbe1d4a">armnn::ClTunedParameters::m_Tuner</a></div><div class="ttdeci">arm_compute::CLTuner m_Tuner</div><div class="ttdef"><b>Definition:</b> <a href="_cl_context_control_8hpp_source.xhtml#l00053">ClContextControl.hpp:53</a></div></div>
+<div class="ttc" id="classarmnn_1_1_i_gpu_acc_tuned_parameters_xhtml"><div class="ttname"><a href="classarmnn_1_1_i_gpu_acc_tuned_parameters.xhtml">armnn::IGpuAccTunedParameters</a></div><div class="ttdoc">Manages a set of GpuAcc parameters which have been tuned for maximum performance. ...</div><div class="ttdef"><b>Definition:</b> <a href="_i_runtime_8hpp_source.xhtml#l00183">IRuntime.hpp:183</a></div></div>
+<div class="ttc" id="classarmnn_1_1_cl_context_control_xhtml_a80ef362b80b514620da9fd8f6a3ba518"><div class="ttname"><a href="classarmnn_1_1_cl_context_control.xhtml#a80ef362b80b514620da9fd8f6a3ba518">armnn::ClContextControl::LoadOpenClRuntime</a></div><div class="ttdeci">void LoadOpenClRuntime()</div><div class="ttdef"><b>Definition:</b> <a href="_cl_context_control_8cpp_source.xhtml#l00091">ClContextControl.cpp:91</a></div></div>
+<div class="ttc" id="classarmnn_1_1_cl_tuned_parameters_xhtml_ab277b661f23f9ff45b28027f47a126ef"><div class="ttname"><a href="classarmnn_1_1_cl_tuned_parameters.xhtml#ab277b661f23f9ff45b28027f47a126ef">armnn::ClTunedParameters::m_TuningLevel</a></div><div class="ttdeci">TuningLevel m_TuningLevel</div><div class="ttdef"><b>Definition:</b> <a href="_cl_context_control_8hpp_source.xhtml#l00051">ClContextControl.hpp:51</a></div></div>
+<div class="ttc" id="classarmnn_1_1_cl_context_control_xhtml_a48f639543a69fe342fec2021b9dfd1d4"><div class="ttname"><a href="classarmnn_1_1_cl_context_control.xhtml#a48f639543a69fe342fec2021b9dfd1d4">armnn::ClContextControl::UnloadOpenClRuntime</a></div><div class="ttdeci">void UnloadOpenClRuntime()</div><div class="ttdef"><b>Definition:</b> <a href="_cl_context_control_8cpp_source.xhtml#l00096">ClContextControl.cpp:96</a></div></div>
+<div class="ttc" id="classarmnn_1_1_cl_tuned_parameters_xhtml_a22f392e24a1f2155875e3063a7491e4d"><div class="ttname"><a href="classarmnn_1_1_cl_tuned_parameters.xhtml#a22f392e24a1f2155875e3063a7491e4d">armnn::ClTunedParameters::m_Mode</a></div><div class="ttdeci">Mode m_Mode</div><div class="ttdef"><b>Definition:</b> <a href="_cl_context_control_8hpp_source.xhtml#l00050">ClContextControl.hpp:50</a></div></div>
+</div><!-- fragment --></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="dir_68267d1309a1af8e8297ef4c3efbcdba.xhtml">src</a></li><li class="navelem"><a class="el" href="dir_0f3cdec46afbc61a1ded8e1687c9c9a0.xhtml">backends</a></li><li class="navelem"><a class="el" href="dir_1ad86c6d39ab715a831555571b9e98a5.xhtml">cl</a></li><li class="navelem"><a class="el" href="_cl_context_control_8hpp.xhtml">ClContextControl.hpp</a></li>
+ <li class="footer">Generated on Fri Mar 13 2020 16:09:11 for ArmNN by
+ <a href="http://www.doxygen.org/index.html">
+ <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
+ </ul>
+</div>
+</body>
+</html>