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/_wall_clock_timer_8hpp_source.html b/Documentation/_wall_clock_timer_8hpp_source.html
new file mode 100644
index 0000000..d3a6c28
--- /dev/null
+++ b/Documentation/_wall_clock_timer_8hpp_source.html
@@ -0,0 +1,109 @@
+<!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="viewport" content="width=device-width, initial-scale=1"/>
+<title>ArmNN: src/armnn/WallClockTimer.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>
+<link href="doxygen.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;">
+ <td id="projectalign" style="padding-left: 0.5em;">
+ <div id="projectname">ArmNN
+  <span id="projectnumber">NotReleased</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('_wall_clock_timer_8hpp_source.html','');});
+</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">WallClockTimer.hpp</div> </div>
+</div><!--header-->
+<div class="contents">
+<a href="_wall_clock_timer_8hpp.html">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> </div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> </div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include "<a class="code" href="_instrument_8hpp.html">Instrument.hpp</a>"</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include <chrono></span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include "<a class="code" href="_dll_export_8hpp.html">DllExport.hpp</a>"</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> </div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="keyword">namespace </span><a class="code" href="namespacearmnn.html">armnn</a></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> </div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#if defined(CLOCK_MONOTONIC_RAW) && defined(__unix__)</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#define USE_CLOCK_MONOTONIC_RAW 1</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="_wall_clock_timer_8hpp.html#ae7adfc4258f7ff8ba7d8c3f7c9372a3f"> 18</a></span> <span class="preprocessor">#define USE_CLOCK_MONOTONIC_RAW 0</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#if USE_CLOCK_MONOTONIC_RAW</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">class </span>MonotonicClockRaw</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="keyword">public</span>:</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <span class="keyword">using</span> duration = std::chrono::nanoseconds;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="keyword">using</span> time_point = std::chrono::time_point<MonotonicClockRaw, duration>;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="keyword">static</span> std::chrono::time_point<MonotonicClockRaw, std::chrono::nanoseconds> now() noexcept</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>  timespec ts;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  clock_gettime(CLOCK_MONOTONIC_RAW, &ts);</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keywordflow">return</span> time_point(std::chrono::nanoseconds(ts.tv_sec * 1000000000 + ts.tv_nsec));</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</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="preprocessor">#endif</span></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> <span class="comment">// Implementation of an instrument to measure elapsed wall-clock time in microseconds.</span></div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="classarmnn_1_1_wall_clock_timer.html"> 38</a></span> <span class="keyword">class </span><a class="code" href="classarmnn_1_1_wall_clock_timer.html">WallClockTimer</a> : <span class="keyword">public</span> <a class="code" href="classarmnn_1_1_instrument.html">Instrument</a></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> {</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="comment">// Construct a Wall Clock Timer</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <a class="code" href="classarmnn_1_1_wall_clock_timer.html">WallClockTimer</a>() = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  ~<a class="code" href="classarmnn_1_1_wall_clock_timer.html">WallClockTimer</a>() = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="comment">// Start the Wall clock timer</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordtype">void</span> Start() <span class="keyword">override</span>;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="comment">// Stop the Wall clock timer</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordtype">void</span> Stop() <span class="keyword">override</span>;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="comment">// Get the name of the timer</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* GetName() <span class="keyword">const override</span>;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="comment">// Get the recorded measurements</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  std::vector<Measurement> GetMeasurements() <span class="keyword">const override</span>;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor">#if USE_CLOCK_MONOTONIC_RAW</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">using</span> <a class="code" href="classarmnn_1_1_wall_clock_timer.html#a5416ef5623955b5210ee09ce14d24a58">clock</a> = MonotonicClockRaw;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="classarmnn_1_1_wall_clock_timer.html#a5416ef5623955b5210ee09ce14d24a58"> 60</a></span>  <span class="keyword">using</span> <a class="code" href="classarmnn_1_1_wall_clock_timer.html#a5416ef5623955b5210ee09ce14d24a58">clock</a> = std::chrono::steady_clock;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div><div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="classarmnn_1_1_wall_clock_timer.html#aece42eedfcac1aa046e0dff4763b300a"> 63</a></span>  <a class="code" href="_dll_export_8hpp.html#a935d9ad2f22d42a703b8b31465796137">ARMNN_DLLEXPORT</a> <span class="keyword">static</span> <span class="keyword">const</span> std::string <a class="code" href="classarmnn_1_1_wall_clock_timer.html#aece42eedfcac1aa046e0dff4763b300a">WALL_CLOCK_TIME</a>;</div><div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="classarmnn_1_1_wall_clock_timer.html#aef02e15721d757f07f3812f09fc892d4"> 64</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> std::string <a class="code" href="classarmnn_1_1_wall_clock_timer.html#aef02e15721d757f07f3812f09fc892d4">WALL_CLOCK_TIME_START</a>;</div><div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="classarmnn_1_1_wall_clock_timer.html#abd358345fde773d79e57461c1b062703"> 65</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> std::string <a class="code" href="classarmnn_1_1_wall_clock_timer.html#abd358345fde773d79e57461c1b062703">WALL_CLOCK_TIME_STOP</a>;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  clock::time_point m_Start;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  clock::time_point m_Stop;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> };</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> } <span class="comment">//namespace armnn</span></div><div class="ttc" id="classarmnn_1_1_wall_clock_timer_html_a5416ef5623955b5210ee09ce14d24a58"><div class="ttname"><a href="classarmnn_1_1_wall_clock_timer.html#a5416ef5623955b5210ee09ce14d24a58">armnn::WallClockTimer::clock</a></div><div class="ttdeci">std::chrono::steady_clock clock</div><div class="ttdef"><b>Definition:</b> <a href="_wall_clock_timer_8hpp_source.html#l00060">WallClockTimer.hpp:60</a></div></div>
+<div class="ttc" id="classarmnn_1_1_wall_clock_timer_html_aef02e15721d757f07f3812f09fc892d4"><div class="ttname"><a href="classarmnn_1_1_wall_clock_timer.html#aef02e15721d757f07f3812f09fc892d4">armnn::WallClockTimer::WALL_CLOCK_TIME_START</a></div><div class="ttdeci">static const std::string WALL_CLOCK_TIME_START</div><div class="ttdef"><b>Definition:</b> <a href="_wall_clock_timer_8hpp_source.html#l00064">WallClockTimer.hpp:64</a></div></div>
+<div class="ttc" id="classarmnn_1_1_instrument_html"><div class="ttname"><a href="classarmnn_1_1_instrument.html">armnn::Instrument</a></div><div class="ttdef"><b>Definition:</b> <a href="_instrument_8hpp_source.html#l00051">Instrument.hpp:51</a></div></div>
+<div class="ttc" id="classarmnn_1_1_wall_clock_timer_html"><div class="ttname"><a href="classarmnn_1_1_wall_clock_timer.html">armnn::WallClockTimer</a></div><div class="ttdef"><b>Definition:</b> <a href="_wall_clock_timer_8hpp_source.html#l00038">WallClockTimer.hpp:38</a></div></div>
+<div class="ttc" id="classarmnn_1_1_wall_clock_timer_html_aece42eedfcac1aa046e0dff4763b300a"><div class="ttname"><a href="classarmnn_1_1_wall_clock_timer.html#aece42eedfcac1aa046e0dff4763b300a">armnn::WallClockTimer::WALL_CLOCK_TIME</a></div><div class="ttdeci">static const std::string WALL_CLOCK_TIME</div><div class="ttdef"><b>Definition:</b> <a href="_wall_clock_timer_8hpp_source.html#l00063">WallClockTimer.hpp:63</a></div></div>
+<div class="ttc" id="_instrument_8hpp_html"><div class="ttname"><a href="_instrument_8hpp.html">Instrument.hpp</a></div></div>
+<div class="ttc" id="_dll_export_8hpp_html"><div class="ttname"><a href="_dll_export_8hpp.html">DllExport.hpp</a></div></div>
+<div class="ttc" id="namespacearmnn_html"><div class="ttname"><a href="namespacearmnn.html">armnn</a></div><div class="ttdef"><b>Definition:</b> <a href="_backend_helper_8hpp_source.html#l00011">BackendHelper.hpp:11</a></div></div>
+<div class="ttc" id="_dll_export_8hpp_html_a935d9ad2f22d42a703b8b31465796137"><div class="ttname"><a href="_dll_export_8hpp.html#a935d9ad2f22d42a703b8b31465796137">ARMNN_DLLEXPORT</a></div><div class="ttdeci">#define ARMNN_DLLEXPORT</div><div class="ttdef"><b>Definition:</b> <a href="_dll_export_8hpp_source.html#l00017">DllExport.hpp:17</a></div></div>
+<div class="ttc" id="classarmnn_1_1_wall_clock_timer_html_abd358345fde773d79e57461c1b062703"><div class="ttname"><a href="classarmnn_1_1_wall_clock_timer.html#abd358345fde773d79e57461c1b062703">armnn::WallClockTimer::WALL_CLOCK_TIME_STOP</a></div><div class="ttdeci">static const std::string WALL_CLOCK_TIME_STOP</div><div class="ttdef"><b>Definition:</b> <a href="_wall_clock_timer_8hpp_source.html#l00065">WallClockTimer.hpp:65</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.html">src</a></li><li class="navelem"><a class="el" href="dir_e0a84d05c80a2ef4231141dcbbeac5c8.html">armnn</a></li><li class="navelem"><a class="el" href="_wall_clock_timer_8hpp.html">WallClockTimer.hpp</a></li>
+ <li class="footer">Generated on Fri Mar 13 2020 16:06:55 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>