Documentation/_instrument_tests_8cpp.xhtml

   1 <!-- Copyright (c) 2020 ARM Limited. -->
   2 <!--                                 -->
   3 <!-- SPDX-License-Identifier: MIT    -->
   4 <!--                                 -->
   5 <!-- HTML header for doxygen 1.8.13-->
   6 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   7 <html xmlns="http://www.w3.org/1999/xhtml">
   8 <head>
   9 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  10 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  11 <meta name="generator" content="Doxygen 1.8.13"/>
  12 <meta name="robots" content="NOINDEX, NOFOLLOW" />
  13 <meta name="viewport" content="width=device-width, initial-scale=1"/>
  14 <title>ArmNN: src/armnn/test/InstrumentTests.cpp File Reference</title>
  15 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  16 <script type="text/javascript" src="jquery.js"></script>
  17 <script type="text/javascript" src="dynsections.js"></script>
  18 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  19 <script type="text/javascript" src="resize.js"></script>
  20 <script type="text/javascript" src="navtreedata.js"></script>
  21 <script type="text/javascript" src="navtree.js"></script>
  22 <script type="text/javascript">
  23   $(document).ready(initResizable);
  24 </script>
  25 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  26 <script type="text/javascript" src="search/searchdata.js"></script>
  27 <script type="text/javascript" src="search/search.js"></script>
  28 <script type="text/x-mathjax-config">
  29   MathJax.Hub.Config({
  30     extensions: ["tex2jax.js"],
  31     jax: ["input/TeX","output/HTML-CSS"],
  32 });
  33 </script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
  34 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  35 <link href="stylesheet.css" rel="stylesheet" type="text/css"/>
  36 </head>
  37 <body>
  38 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  39 <div id="titlearea">
  40 <table cellspacing="0" cellpadding="0">
  41  <tbody>
  42  <tr style="height: 56px;">
  43   <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 10rem; margin-top: .5rem; margin-left 10px"/>
  44   <td style="padding-left: 0.5em;">
  45    <div id="projectname">
  46    &#160;<span id="projectnumber">20.02</span>
  47    </div>
  48   </td>
  49  </tr>
  50  </tbody>
  51 </table>
  52 </div>
  53 <!-- end header part -->
  54 <!-- Generated by Doxygen 1.8.13 -->
  55 <script type="text/javascript">
  56 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  57 </script>
  58 <script type="text/javascript" src="menudata.js"></script>
  59 <script type="text/javascript" src="menu.js"></script>
  60 <script type="text/javascript">
  61 $(function() {
  62   initMenu('',true,false,'search.php','Search');
  63   $(document).ready(function() { init_search(); });
  64 });
  65 </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 $(document).ready(function(){initNavTree('_instrument_tests_8cpp.xhtml','');});
  80 </script>
  81 <div id="doc-content">
  82 <!-- window showing the filter options -->
  83 <div id="MSearchSelectWindow"
  84      onmouseover="return searchBox.OnSearchSelectShow()"
  85      onmouseout="return searchBox.OnSearchSelectHide()"
  86      onkeydown="return searchBox.OnSearchSelectKey(event)">
  87 </div>
  88
  89 <!-- iframe showing the search results (closed by default) -->
  90 <div id="MSearchResultsWindow">
  91 <iframe src="javascript:void(0)" frameborder="0"
  92         name="MSearchResults" id="MSearchResults">
  93 </iframe>
  94 </div>
  95
  96 <div class="header">
  97   <div class="summary">
  98 <a href="#func-members">Functions</a>  </div>
  99   <div class="headertitle">
 100 <div class="title">InstrumentTests.cpp File Reference</div>  </div>
 101 </div><!--header-->
 102 <div class="contents">
 103 <div class="textblock"><code>#include &lt;boost/test/unit_test.hpp&gt;</code><br />
 104 <code>#include &quot;<a class="el" href="_wall_clock_timer_8hpp_source.xhtml">WallClockTimer.hpp</a>&quot;</code><br />
 105 <code>#include &lt;chrono&gt;</code><br />
 106 <code>#include &lt;thread&gt;</code><br />
 107 </div>
 108 <p><a href="_instrument_tests_8cpp_source.xhtml">Go to the source code of this file.</a></p>
 109 <table class="memberdecls">
 110 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
 111 Functions</h2></td></tr>
 112 <tr class="memitem:a060599abd87e14ade2f802d7224d6b79"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_instrument_tests_8cpp.xhtml#a060599abd87e14ade2f802d7224d6b79">BOOST_AUTO_TEST_CASE</a> (WallClockTimerInMicroseconds)</td></tr>
 113 <tr class="separator:a060599abd87e14ade2f802d7224d6b79"><td class="memSeparator" colspan="2">&#160;</td></tr>
 114 <tr class="memitem:aa5116e7bb7b52e1a91aa573f4f2744b4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_instrument_tests_8cpp.xhtml#aa5116e7bb7b52e1a91aa573f4f2744b4">BOOST_AUTO_TEST_CASE</a> (WallClockTimerInNanoseconds)</td></tr>
 115 <tr class="separator:aa5116e7bb7b52e1a91aa573f4f2744b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 116 </table>
 117 <h2 class="groupheader">Function Documentation</h2>
 118 <a id="a060599abd87e14ade2f802d7224d6b79"></a>
 119 <h2 class="memtitle"><span class="permalink"><a href="#a060599abd87e14ade2f802d7224d6b79">&#9670;&nbsp;</a></span>BOOST_AUTO_TEST_CASE() <span class="overload">[1/2]</span></h2>
 120
 121 <div class="memitem">
 122 <div class="memproto">
 123       <table class="memname">
 124         <tr>
 125           <td class="memname">BOOST_AUTO_TEST_CASE </td>
 126           <td>(</td>
 127           <td class="paramtype">WallClockTimerInMicroseconds&#160;</td>
 128           <td class="paramname"></td><td>)</td>
 129           <td></td>
 130         </tr>
 131       </table>
 132 </div><div class="memdoc">
 133
 134 <p class="definition">Definition at line <a class="el" href="_instrument_tests_8cpp_source.xhtml#l00016">16</a> of file <a class="el" href="_instrument_tests_8cpp_source.xhtml">InstrumentTests.cpp</a>.</p>
 135
 136 <p class="reference">References <a class="el" href="_wall_clock_timer_8cpp_source.xhtml#l00030">WallClockTimer::GetMeasurements()</a>, <a class="el" href="_wall_clock_timer_8cpp_source.xhtml#l00015">WallClockTimer::GetName()</a>, <a class="el" href="_wall_clock_timer_8cpp_source.xhtml#l00020">WallClockTimer::Start()</a>, <a class="el" href="_wall_clock_timer_8cpp_source.xhtml#l00025">WallClockTimer::Stop()</a>, and <a class="el" href="_wall_clock_timer_8hpp_source.xhtml#l00063">WallClockTimer::WALL_CLOCK_TIME</a>.</p>
 137 <div class="fragment"><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;{</div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;    <a class="code" href="classarmnn_1_1_wall_clock_timer.xhtml">WallClockTimer</a> wallClockTimer;</div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;</div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;    BOOST_CHECK_EQUAL(wallClockTimer.<a class="code" href="classarmnn_1_1_wall_clock_timer.xhtml#ad47edad463024345ce1409153c259215">GetName</a>(), <span class="stringliteral">&quot;WallClockTimer&quot;</span>);</div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;</div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;    <span class="comment">// start the timer</span></div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;    wallClockTimer.<a class="code" href="classarmnn_1_1_wall_clock_timer.xhtml#a156f3866ca69d98b4d9e6e1c1b3ec7da">Start</a>();</div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;    <span class="comment">// wait for 10 microseconds</span></div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;    std::this_thread::sleep_for(std::chrono::microseconds(10));</div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;</div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;   <span class="comment">// stop the timer</span></div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;    wallClockTimer.<a class="code" href="classarmnn_1_1_wall_clock_timer.xhtml#a634c58de2126b4a4e6a2a093e60e1290">Stop</a>();</div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;</div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;    BOOST_CHECK_EQUAL(wallClockTimer.<a class="code" href="classarmnn_1_1_wall_clock_timer.xhtml#a86ea36032637c02c045f2d433036a203">GetMeasurements</a>().front().m_Name, WallClockTimer::WALL_CLOCK_TIME);</div><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;    <span class="comment">// check that WallClockTimer measurement should be &gt;= 10 microseconds</span></div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;    BOOST_CHECK_GE(wallClockTimer.<a class="code" href="classarmnn_1_1_wall_clock_timer.xhtml#a86ea36032637c02c045f2d433036a203">GetMeasurements</a>().front().m_Value, std::chrono::microseconds(10).count());</div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;}</div><div class="ttc" id="classarmnn_1_1_wall_clock_timer_xhtml"><div class="ttname"><a href="classarmnn_1_1_wall_clock_timer.xhtml">armnn::WallClockTimer</a></div><div class="ttdef"><b>Definition:</b> <a href="_wall_clock_timer_8hpp_source.xhtml#l00038">WallClockTimer.hpp:38</a></div></div>
 138 <div class="ttc" id="classarmnn_1_1_wall_clock_timer_xhtml_a156f3866ca69d98b4d9e6e1c1b3ec7da"><div class="ttname"><a href="classarmnn_1_1_wall_clock_timer.xhtml#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.xhtml#l00020">WallClockTimer.cpp:20</a></div></div>
 139 <div class="ttc" id="classarmnn_1_1_wall_clock_timer_xhtml_ad47edad463024345ce1409153c259215"><div class="ttname"><a href="classarmnn_1_1_wall_clock_timer.xhtml#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.xhtml#l00015">WallClockTimer.cpp:15</a></div></div>
 140 <div class="ttc" id="classarmnn_1_1_wall_clock_timer_xhtml_a634c58de2126b4a4e6a2a093e60e1290"><div class="ttname"><a href="classarmnn_1_1_wall_clock_timer.xhtml#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.xhtml#l00025">WallClockTimer.cpp:25</a></div></div>
 141 <div class="ttc" id="classarmnn_1_1_wall_clock_timer_xhtml_a86ea36032637c02c045f2d433036a203"><div class="ttname"><a href="classarmnn_1_1_wall_clock_timer.xhtml#a86ea36032637c02c045f2d433036a203">armnn::WallClockTimer::GetMeasurements</a></div><div class="ttdeci">std::vector&lt; Measurement &gt; GetMeasurements() const override</div><div class="ttdef"><b>Definition:</b> <a href="_wall_clock_timer_8cpp_source.xhtml#l00030">WallClockTimer.cpp:30</a></div></div>
 142 </div><!-- fragment -->
 143 </div>
 144 </div>
 145 <a id="aa5116e7bb7b52e1a91aa573f4f2744b4"></a>
 146 <h2 class="memtitle"><span class="permalink"><a href="#aa5116e7bb7b52e1a91aa573f4f2744b4">&#9670;&nbsp;</a></span>BOOST_AUTO_TEST_CASE() <span class="overload">[2/2]</span></h2>
 147
 148 <div class="memitem">
 149 <div class="memproto">
 150       <table class="memname">
 151         <tr>
 152           <td class="memname">BOOST_AUTO_TEST_CASE </td>
 153           <td>(</td>
 154           <td class="paramtype">WallClockTimerInNanoseconds&#160;</td>
 155           <td class="paramname"></td><td>)</td>
 156           <td></td>
 157         </tr>
 158       </table>
 159 </div><div class="memdoc">
 160
 161 <p class="definition">Definition at line <a class="el" href="_instrument_tests_8cpp_source.xhtml#l00037">37</a> of file <a class="el" href="_instrument_tests_8cpp_source.xhtml">InstrumentTests.cpp</a>.</p>
 162
 163 <p class="reference">References <a class="el" href="_profiler_tests_8cpp.xhtml#af7f71af5c6c124222dd1c42c5df892f4">BOOST_AUTO_TEST_SUITE_END()</a>, <a class="el" href="_wall_clock_timer_8cpp_source.xhtml#l00030">WallClockTimer::GetMeasurements()</a>, <a class="el" href="_wall_clock_timer_8cpp_source.xhtml#l00015">WallClockTimer::GetName()</a>, <a class="el" href="_wall_clock_timer_8cpp_source.xhtml#l00020">WallClockTimer::Start()</a>, <a class="el" href="_wall_clock_timer_8cpp_source.xhtml#l00025">WallClockTimer::Stop()</a>, and <a class="el" href="_wall_clock_timer_8hpp_source.xhtml#l00063">WallClockTimer::WALL_CLOCK_TIME</a>.</p>
 164 <div class="fragment"><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;{</div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;    <a class="code" href="classarmnn_1_1_wall_clock_timer.xhtml">WallClockTimer</a> wallClockTimer;</div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;</div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;    BOOST_CHECK_EQUAL(wallClockTimer.<a class="code" href="classarmnn_1_1_wall_clock_timer.xhtml#ad47edad463024345ce1409153c259215">GetName</a>(), <span class="stringliteral">&quot;WallClockTimer&quot;</span>);</div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;</div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;    <span class="comment">// start the timer</span></div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;    wallClockTimer.<a class="code" href="classarmnn_1_1_wall_clock_timer.xhtml#a156f3866ca69d98b4d9e6e1c1b3ec7da">Start</a>();</div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;</div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;    <span class="comment">// wait for 500 nanoseconds - 0.5 microseconds</span></div><div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;    std::this_thread::sleep_for(std::chrono::nanoseconds(500));</div><div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;</div><div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;    <span class="comment">// stop the timer</span></div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;    wallClockTimer.<a class="code" href="classarmnn_1_1_wall_clock_timer.xhtml#a634c58de2126b4a4e6a2a093e60e1290">Stop</a>();</div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;</div><div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;    BOOST_CHECK_EQUAL(wallClockTimer.<a class="code" href="classarmnn_1_1_wall_clock_timer.xhtml#a86ea36032637c02c045f2d433036a203">GetMeasurements</a>().front().m_Name, WallClockTimer::WALL_CLOCK_TIME);</div><div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;</div><div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;    <span class="comment">// delta is 0.5 microseconds</span></div><div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;    <span class="keyword">const</span> <span class="keyword">auto</span> delta =</div><div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;        std::chrono::duration_cast&lt;std::chrono::duration&lt;double, std::micro&gt;&gt;(std::chrono::nanoseconds(500));</div><div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;</div><div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;    <span class="comment">// check that WallClockTimer measurement should be &gt;= 0.5 microseconds</span></div><div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;    BOOST_CHECK_GE(wallClockTimer.<a class="code" href="classarmnn_1_1_wall_clock_timer.xhtml#a86ea36032637c02c045f2d433036a203">GetMeasurements</a>().front().m_Value, delta.count());</div><div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;}</div><div class="ttc" id="classarmnn_1_1_wall_clock_timer_xhtml"><div class="ttname"><a href="classarmnn_1_1_wall_clock_timer.xhtml">armnn::WallClockTimer</a></div><div class="ttdef"><b>Definition:</b> <a href="_wall_clock_timer_8hpp_source.xhtml#l00038">WallClockTimer.hpp:38</a></div></div>
 165 <div class="ttc" id="classarmnn_1_1_wall_clock_timer_xhtml_a156f3866ca69d98b4d9e6e1c1b3ec7da"><div class="ttname"><a href="classarmnn_1_1_wall_clock_timer.xhtml#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.xhtml#l00020">WallClockTimer.cpp:20</a></div></div>
 166 <div class="ttc" id="classarmnn_1_1_wall_clock_timer_xhtml_ad47edad463024345ce1409153c259215"><div class="ttname"><a href="classarmnn_1_1_wall_clock_timer.xhtml#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.xhtml#l00015">WallClockTimer.cpp:15</a></div></div>
 167 <div class="ttc" id="classarmnn_1_1_wall_clock_timer_xhtml_a634c58de2126b4a4e6a2a093e60e1290"><div class="ttname"><a href="classarmnn_1_1_wall_clock_timer.xhtml#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.xhtml#l00025">WallClockTimer.cpp:25</a></div></div>
 168 <div class="ttc" id="classarmnn_1_1_wall_clock_timer_xhtml_a86ea36032637c02c045f2d433036a203"><div class="ttname"><a href="classarmnn_1_1_wall_clock_timer.xhtml#a86ea36032637c02c045f2d433036a203">armnn::WallClockTimer::GetMeasurements</a></div><div class="ttdeci">std::vector&lt; Measurement &gt; GetMeasurements() const override</div><div class="ttdef"><b>Definition:</b> <a href="_wall_clock_timer_8cpp_source.xhtml#l00030">WallClockTimer.cpp:30</a></div></div>
 169 </div><!-- fragment -->
 170 </div>
 171 </div>
 172 </div><!-- contents -->
 173 </div><!-- doc-content -->
 174 <!-- start footer part -->
 175 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 176   <ul>
 177     <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.xhtml">src</a></li><li class="navelem"><a class="el" href="dir_e0a84d05c80a2ef4231141dcbbeac5c8.xhtml">armnn</a></li><li class="navelem"><a class="el" href="dir_9d86fd1fbecbedf5bdb69c7e7235fe5f.xhtml">test</a></li><li class="navelem"><a class="el" href="_instrument_tests_8cpp.xhtml">InstrumentTests.cpp</a></li>
 178     <li class="footer">Generated on Fri Mar 13 2020 16:09:13 for ArmNN by
 179     <a href="http://www.doxygen.org/index.html">
 180     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
 181   </ul>
 182 </div>
 183 </body>
 184 </html>