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/_instrument_tests_8cpp.html b/Documentation/_instrument_tests_8cpp.html
new file mode 100644
index 0000000..9a20a8e
--- /dev/null
+++ b/Documentation/_instrument_tests_8cpp.html
@@ -0,0 +1,170 @@
+<!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/test/InstrumentTests.cpp File 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">
+ $(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('_instrument_tests_8cpp.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="summary">
+<a href="#func-members">Functions</a> </div>
+ <div class="headertitle">
+<div class="title">InstrumentTests.cpp File Reference</div> </div>
+</div><!--header-->
+<div class="contents">
+<div class="textblock"><code>#include <boost/test/unit_test.hpp></code><br />
+<code>#include "<a class="el" href="_wall_clock_timer_8hpp_source.html">WallClockTimer.hpp</a>"</code><br />
+<code>#include <chrono></code><br />
+<code>#include <thread></code><br />
+</div>
+<p><a href="_instrument_tests_8cpp_source.html">Go to the source code of this file.</a></p>
+<table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
+Functions</h2></td></tr>
+<tr class="memitem:a060599abd87e14ade2f802d7224d6b79"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="_instrument_tests_8cpp.html#a060599abd87e14ade2f802d7224d6b79">BOOST_AUTO_TEST_CASE</a> (WallClockTimerInMicroseconds)</td></tr>
+<tr class="separator:a060599abd87e14ade2f802d7224d6b79"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:aa5116e7bb7b52e1a91aa573f4f2744b4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="_instrument_tests_8cpp.html#aa5116e7bb7b52e1a91aa573f4f2744b4">BOOST_AUTO_TEST_CASE</a> (WallClockTimerInNanoseconds)</td></tr>
+<tr class="separator:aa5116e7bb7b52e1a91aa573f4f2744b4"><td class="memSeparator" colspan="2"> </td></tr>
+</table>
+<h2 class="groupheader">Function Documentation</h2>
+<a id="a060599abd87e14ade2f802d7224d6b79"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a060599abd87e14ade2f802d7224d6b79">◆ </a></span>BOOST_AUTO_TEST_CASE() <span class="overload">[1/2]</span></h2>
+
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">BOOST_AUTO_TEST_CASE </td>
+ <td>(</td>
+ <td class="paramtype">WallClockTimerInMicroseconds </td>
+ <td class="paramname"></td><td>)</td>
+ <td></td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="_instrument_tests_8cpp_source.html#l00016">16</a> of file <a class="el" href="_instrument_tests_8cpp_source.html">InstrumentTests.cpp</a>.</p>
+
+<p class="reference">References <a class="el" href="_wall_clock_timer_8cpp_source.html#l00030">WallClockTimer::GetMeasurements()</a>, <a class="el" href="_wall_clock_timer_8cpp_source.html#l00015">WallClockTimer::GetName()</a>, <a class="el" href="_wall_clock_timer_8cpp_source.html#l00020">WallClockTimer::Start()</a>, <a class="el" href="_wall_clock_timer_8cpp_source.html#l00025">WallClockTimer::Stop()</a>, and <a class="el" href="_wall_clock_timer_8hpp_source.html#l00063">WallClockTimer::WALL_CLOCK_TIME</a>.</p>
+<div class="fragment"><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> {</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  <a class="code" href="classarmnn_1_1_wall_clock_timer.html">WallClockTimer</a> wallClockTimer;</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  BOOST_CHECK_EQUAL(wallClockTimer.<a class="code" href="classarmnn_1_1_wall_clock_timer.html#ad47edad463024345ce1409153c259215">GetName</a>(), <span class="stringliteral">"WallClockTimer"</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="comment">// start the timer</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  wallClockTimer.<a class="code" href="classarmnn_1_1_wall_clock_timer.html#a156f3866ca69d98b4d9e6e1c1b3ec7da">Start</a>();</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <span class="comment">// wait for 10 microseconds</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  std::this_thread::sleep_for(std::chrono::microseconds(10));</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="comment">// stop the timer</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  wallClockTimer.<a class="code" href="classarmnn_1_1_wall_clock_timer.html#a634c58de2126b4a4e6a2a093e60e1290">Stop</a>();</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  BOOST_CHECK_EQUAL(wallClockTimer.<a class="code" href="classarmnn_1_1_wall_clock_timer.html#a86ea36032637c02c045f2d433036a203">GetMeasurements</a>().front().m_Name, WallClockTimer::WALL_CLOCK_TIME);</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="comment">// check that WallClockTimer measurement should be >= 10 microseconds</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  BOOST_CHECK_GE(wallClockTimer.<a class="code" href="classarmnn_1_1_wall_clock_timer.html#a86ea36032637c02c045f2d433036a203">GetMeasurements</a>().front().m_Value, std::chrono::microseconds(10).count());</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> }</div><div class="ttc" id="classarmnn_1_1_wall_clock_timer_html_a634c58de2126b4a4e6a2a093e60e1290"><div class="ttname"><a href="classarmnn_1_1_wall_clock_timer.html#a634c58de2126b4a4e6a2a093e60e1290">armnn::WallClockTimer::Stop</a></div><div class="ttdeci">void Stop() override</div><div class="ttdef"><b>Definition:</b> <a href="_wall_clock_timer_8cpp_source.html#l00025">WallClockTimer.cpp:25</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_a156f3866ca69d98b4d9e6e1c1b3ec7da"><div class="ttname"><a href="classarmnn_1_1_wall_clock_timer.html#a156f3866ca69d98b4d9e6e1c1b3ec7da">armnn::WallClockTimer::Start</a></div><div class="ttdeci">void Start() override</div><div class="ttdef"><b>Definition:</b> <a href="_wall_clock_timer_8cpp_source.html#l00020">WallClockTimer.cpp:20</a></div></div>
+<div class="ttc" id="classarmnn_1_1_wall_clock_timer_html_a86ea36032637c02c045f2d433036a203"><div class="ttname"><a href="classarmnn_1_1_wall_clock_timer.html#a86ea36032637c02c045f2d433036a203">armnn::WallClockTimer::GetMeasurements</a></div><div class="ttdeci">std::vector< Measurement > GetMeasurements() const override</div><div class="ttdef"><b>Definition:</b> <a href="_wall_clock_timer_8cpp_source.html#l00030">WallClockTimer.cpp:30</a></div></div>
+<div class="ttc" id="classarmnn_1_1_wall_clock_timer_html_ad47edad463024345ce1409153c259215"><div class="ttname"><a href="classarmnn_1_1_wall_clock_timer.html#ad47edad463024345ce1409153c259215">armnn::WallClockTimer::GetName</a></div><div class="ttdeci">const char * GetName() const override</div><div class="ttdef"><b>Definition:</b> <a href="_wall_clock_timer_8cpp_source.html#l00015">WallClockTimer.cpp:15</a></div></div>
+</div><!-- fragment -->
+</div>
+</div>
+<a id="aa5116e7bb7b52e1a91aa573f4f2744b4"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aa5116e7bb7b52e1a91aa573f4f2744b4">◆ </a></span>BOOST_AUTO_TEST_CASE() <span class="overload">[2/2]</span></h2>
+
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">BOOST_AUTO_TEST_CASE </td>
+ <td>(</td>
+ <td class="paramtype">WallClockTimerInNanoseconds </td>
+ <td class="paramname"></td><td>)</td>
+ <td></td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="_instrument_tests_8cpp_source.html#l00037">37</a> of file <a class="el" href="_instrument_tests_8cpp_source.html">InstrumentTests.cpp</a>.</p>
+
+<p class="reference">References <a class="el" href="_profiler_tests_8cpp.html#af7f71af5c6c124222dd1c42c5df892f4">BOOST_AUTO_TEST_SUITE_END()</a>, <a class="el" href="_wall_clock_timer_8cpp_source.html#l00030">WallClockTimer::GetMeasurements()</a>, <a class="el" href="_wall_clock_timer_8cpp_source.html#l00015">WallClockTimer::GetName()</a>, <a class="el" href="_wall_clock_timer_8cpp_source.html#l00020">WallClockTimer::Start()</a>, <a class="el" href="_wall_clock_timer_8cpp_source.html#l00025">WallClockTimer::Stop()</a>, and <a class="el" href="_wall_clock_timer_8hpp_source.html#l00063">WallClockTimer::WALL_CLOCK_TIME</a>.</p>
+<div class="fragment"><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>  <a class="code" href="classarmnn_1_1_wall_clock_timer.html">WallClockTimer</a> wallClockTimer;</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>  BOOST_CHECK_EQUAL(wallClockTimer.<a class="code" href="classarmnn_1_1_wall_clock_timer.html#ad47edad463024345ce1409153c259215">GetName</a>(), <span class="stringliteral">"WallClockTimer"</span>);</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="comment">// start the timer</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  wallClockTimer.<a class="code" href="classarmnn_1_1_wall_clock_timer.html#a156f3866ca69d98b4d9e6e1c1b3ec7da">Start</a>();</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="comment">// wait for 500 nanoseconds - 0.5 microseconds</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  std::this_thread::sleep_for(std::chrono::nanoseconds(500));</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="comment">// stop the timer</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  wallClockTimer.<a class="code" href="classarmnn_1_1_wall_clock_timer.html#a634c58de2126b4a4e6a2a093e60e1290">Stop</a>();</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  BOOST_CHECK_EQUAL(wallClockTimer.<a class="code" href="classarmnn_1_1_wall_clock_timer.html#a86ea36032637c02c045f2d433036a203">GetMeasurements</a>().front().m_Name, WallClockTimer::WALL_CLOCK_TIME);</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">// delta is 0.5 microseconds</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">const</span> <span class="keyword">auto</span> delta =</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  std::chrono::duration_cast<std::chrono::duration<double, std::micro>>(std::chrono::nanoseconds(500));</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="comment">// check that WallClockTimer measurement should be >= 0.5 microseconds</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  BOOST_CHECK_GE(wallClockTimer.<a class="code" href="classarmnn_1_1_wall_clock_timer.html#a86ea36032637c02c045f2d433036a203">GetMeasurements</a>().front().m_Value, delta.count());</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> }</div><div class="ttc" id="classarmnn_1_1_wall_clock_timer_html_a634c58de2126b4a4e6a2a093e60e1290"><div class="ttname"><a href="classarmnn_1_1_wall_clock_timer.html#a634c58de2126b4a4e6a2a093e60e1290">armnn::WallClockTimer::Stop</a></div><div class="ttdeci">void Stop() override</div><div class="ttdef"><b>Definition:</b> <a href="_wall_clock_timer_8cpp_source.html#l00025">WallClockTimer.cpp:25</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_a156f3866ca69d98b4d9e6e1c1b3ec7da"><div class="ttname"><a href="classarmnn_1_1_wall_clock_timer.html#a156f3866ca69d98b4d9e6e1c1b3ec7da">armnn::WallClockTimer::Start</a></div><div class="ttdeci">void Start() override</div><div class="ttdef"><b>Definition:</b> <a href="_wall_clock_timer_8cpp_source.html#l00020">WallClockTimer.cpp:20</a></div></div>
+<div class="ttc" id="classarmnn_1_1_wall_clock_timer_html_a86ea36032637c02c045f2d433036a203"><div class="ttname"><a href="classarmnn_1_1_wall_clock_timer.html#a86ea36032637c02c045f2d433036a203">armnn::WallClockTimer::GetMeasurements</a></div><div class="ttdeci">std::vector< Measurement > GetMeasurements() const override</div><div class="ttdef"><b>Definition:</b> <a href="_wall_clock_timer_8cpp_source.html#l00030">WallClockTimer.cpp:30</a></div></div>
+<div class="ttc" id="classarmnn_1_1_wall_clock_timer_html_ad47edad463024345ce1409153c259215"><div class="ttname"><a href="classarmnn_1_1_wall_clock_timer.html#ad47edad463024345ce1409153c259215">armnn::WallClockTimer::GetName</a></div><div class="ttdeci">const char * GetName() const override</div><div class="ttdef"><b>Definition:</b> <a href="_wall_clock_timer_8cpp_source.html#l00015">WallClockTimer.cpp:15</a></div></div>
+</div><!-- fragment -->
+</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="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="dir_9d86fd1fbecbedf5bdb69c7e7235fe5f.html">test</a></li><li class="navelem"><a class="el" href="_instrument_tests_8cpp.html">InstrumentTests.cpp</a></li>
+ <li class="footer">Generated on Fri Mar 13 2020 16:06:59 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>