Ryan OShea | de36e4a | 2020-03-13 16:26:19 +0000 | [diff] [blame] | 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 2 | <html xmlns="http://www.w3.org/1999/xhtml"> |
| 3 | <head> |
| 4 | <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| 5 | <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| 6 | <meta name="generator" content="Doxygen 1.8.13"/> |
| 7 | <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| 8 | <title>ArmNN: src/armnn/Instrument.hpp Source File</title> |
| 9 | <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| 10 | <script type="text/javascript" src="jquery.js"></script> |
| 11 | <script type="text/javascript" src="dynsections.js"></script> |
| 12 | <link href="navtree.css" rel="stylesheet" type="text/css"/> |
| 13 | <script type="text/javascript" src="resize.js"></script> |
| 14 | <script type="text/javascript" src="navtreedata.js"></script> |
| 15 | <script type="text/javascript" src="navtree.js"></script> |
| 16 | <script type="text/javascript"> |
| 17 | $(document).ready(initResizable); |
| 18 | </script> |
| 19 | <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| 20 | <script type="text/javascript" src="search/searchdata.js"></script> |
| 21 | <script type="text/javascript" src="search/search.js"></script> |
| 22 | <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| 23 | </head> |
| 24 | <body> |
| 25 | <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| 26 | <div id="titlearea"> |
| 27 | <table cellspacing="0" cellpadding="0"> |
| 28 | <tbody> |
| 29 | <tr style="height: 56px;"> |
| 30 | <td id="projectalign" style="padding-left: 0.5em;"> |
| 31 | <div id="projectname">ArmNN |
| 32 |  <span id="projectnumber">NotReleased</span> |
| 33 | </div> |
| 34 | </td> |
| 35 | </tr> |
| 36 | </tbody> |
| 37 | </table> |
| 38 | </div> |
| 39 | <!-- end header part --> |
| 40 | <!-- Generated by Doxygen 1.8.13 --> |
| 41 | <script type="text/javascript"> |
| 42 | var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| 43 | </script> |
| 44 | <script type="text/javascript" src="menudata.js"></script> |
| 45 | <script type="text/javascript" src="menu.js"></script> |
| 46 | <script type="text/javascript"> |
| 47 | $(function() { |
| 48 | initMenu('',true,false,'search.php','Search'); |
| 49 | $(document).ready(function() { init_search(); }); |
| 50 | }); |
| 51 | </script> |
| 52 | <div id="main-nav"></div> |
| 53 | </div><!-- top --> |
| 54 | <div id="side-nav" class="ui-resizable side-nav-resizable"> |
| 55 | <div id="nav-tree"> |
| 56 | <div id="nav-tree-contents"> |
| 57 | <div id="nav-sync" class="sync"></div> |
| 58 | </div> |
| 59 | </div> |
| 60 | <div id="splitbar" style="-moz-user-select:none;" |
| 61 | class="ui-resizable-handle"> |
| 62 | </div> |
| 63 | </div> |
| 64 | <script type="text/javascript"> |
| 65 | $(document).ready(function(){initNavTree('_instrument_8hpp_source.html','');}); |
| 66 | </script> |
| 67 | <div id="doc-content"> |
| 68 | <!-- window showing the filter options --> |
| 69 | <div id="MSearchSelectWindow" |
| 70 | onmouseover="return searchBox.OnSearchSelectShow()" |
| 71 | onmouseout="return searchBox.OnSearchSelectHide()" |
| 72 | onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| 73 | </div> |
| 74 | |
| 75 | <!-- iframe showing the search results (closed by default) --> |
| 76 | <div id="MSearchResultsWindow"> |
| 77 | <iframe src="javascript:void(0)" frameborder="0" |
| 78 | name="MSearchResults" id="MSearchResults"> |
| 79 | </iframe> |
| 80 | </div> |
| 81 | |
| 82 | <div class="header"> |
| 83 | <div class="headertitle"> |
| 84 | <div class="title">Instrument.hpp</div> </div> |
| 85 | </div><!--header--> |
| 86 | <div class="contents"> |
| 87 | <a href="_instrument_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 <string></span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include <vector></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.html">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"><a class="line" href="structarmnn_1_1_measurement.html"> 14</a></span> <span class="keyword">struct </span><a class="code" href="structarmnn_1_1_measurement.html">Measurement</a></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> {</div><div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="structarmnn_1_1_measurement.html#abceb2331ad056e3c5ad27894199a49ed"> 16</a></span>  <span class="keyword">enum</span> <a class="code" href="structarmnn_1_1_measurement.html#abceb2331ad056e3c5ad27894199a49ed">Unit</a></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  {</div><div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="structarmnn_1_1_measurement.html#abceb2331ad056e3c5ad27894199a49edac04d6fce03ff6dfde82088100ad3f3d7"> 18</a></span>  <a class="code" href="structarmnn_1_1_measurement.html#abceb2331ad056e3c5ad27894199a49edac04d6fce03ff6dfde82088100ad3f3d7">TIME_NS</a>,</div><div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="structarmnn_1_1_measurement.html#abceb2331ad056e3c5ad27894199a49edaef96c3935bbc898edd62723ad8cb00ea"> 19</a></span>  <a class="code" href="structarmnn_1_1_measurement.html#abceb2331ad056e3c5ad27894199a49edaef96c3935bbc898edd62723ad8cb00ea">TIME_US</a>,</div><div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="structarmnn_1_1_measurement.html#abceb2331ad056e3c5ad27894199a49edab2234de0b81a6c02ab51dcfc63065bca"> 20</a></span>  <a class="code" href="structarmnn_1_1_measurement.html#abceb2331ad056e3c5ad27894199a49edab2234de0b81a6c02ab51dcfc63065bca">TIME_MS</a>,</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> </div><div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="structarmnn_1_1_measurement.html#ab28eb76bc26abd263cad9dc2d1d17816"> 23</a></span>  <span class="keyword">inline</span> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="structarmnn_1_1_measurement.html#ab28eb76bc26abd263cad9dc2d1d17816">ToString</a>(<a class="code" href="structarmnn_1_1_measurement.html#abceb2331ad056e3c5ad27894199a49ed">Unit</a> unit)</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="keywordflow">switch</span> (unit)</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  {</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="keywordflow">case</span> <a class="code" href="structarmnn_1_1_measurement.html#abceb2331ad056e3c5ad27894199a49edac04d6fce03ff6dfde82088100ad3f3d7">TIME_NS</a>: <span class="keywordflow">return</span> <span class="stringliteral">"ns"</span>;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="keywordflow">case</span> <a class="code" href="structarmnn_1_1_measurement.html#abceb2331ad056e3c5ad27894199a49edaef96c3935bbc898edd62723ad8cb00ea">TIME_US</a>: <span class="keywordflow">return</span> <span class="stringliteral">"us"</span>;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="keywordflow">case</span> <a class="code" href="structarmnn_1_1_measurement.html#abceb2331ad056e3c5ad27894199a49edab2234de0b81a6c02ab51dcfc63065bca">TIME_MS</a>: <span class="keywordflow">return</span> <span class="stringliteral">"ms"</span>;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keywordflow">default</span>: <span class="keywordflow">return</span> <span class="stringliteral">""</span>;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  }</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> </div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="structarmnn_1_1_measurement.html#a78e6023cb54a56d22efb3af4bc1e7880"> 34</a></span>  <a class="code" href="structarmnn_1_1_measurement.html#a78e6023cb54a56d22efb3af4bc1e7880">Measurement</a>(<span class="keyword">const</span> std::string& name, <span class="keywordtype">double</span> value, <a class="code" href="structarmnn_1_1_measurement.html#abceb2331ad056e3c5ad27894199a49ed">Unit</a> unit)</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  : <a class="code" href="structarmnn_1_1_measurement.html#ab13844df5477a9ab8f13069e3d8abad6">m_Name</a>(name)</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  , <a class="code" href="structarmnn_1_1_measurement.html#ac2b559d9ddbdc9bf665c30eece9f426e">m_Value</a>(value)</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  , <a class="code" href="structarmnn_1_1_measurement.html#ad38344c3d8a2840586bccc4cae0dc56d">m_Unit</a>(unit)</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>  <a class="code" href="structarmnn_1_1_measurement.html">Measurement</a>(<span class="keyword">const</span> <a class="code" href="structarmnn_1_1_measurement.html">Measurement</a>&) = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <a class="code" href="structarmnn_1_1_measurement.html#a5a0442afe9c1fe421251293c52d82e55">~Measurement</a>() = <span class="keywordflow">default</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="structarmnn_1_1_measurement.html#ab13844df5477a9ab8f13069e3d8abad6"> 42</a></span>  std::string <a class="code" href="structarmnn_1_1_measurement.html#ab13844df5477a9ab8f13069e3d8abad6">m_Name</a>;</div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="structarmnn_1_1_measurement.html#ac2b559d9ddbdc9bf665c30eece9f426e"> 43</a></span>  <span class="keywordtype">double</span> <a class="code" href="structarmnn_1_1_measurement.html#ac2b559d9ddbdc9bf665c30eece9f426e">m_Value</a>;</div><div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="structarmnn_1_1_measurement.html#ad38344c3d8a2840586bccc4cae0dc56d"> 44</a></span>  <a class="code" href="structarmnn_1_1_measurement.html#abceb2331ad056e3c5ad27894199a49ed">Unit</a> <a class="code" href="structarmnn_1_1_measurement.html#ad38344c3d8a2840586bccc4cae0dc56d">m_Unit</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="keyword">private</span>:</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="comment">// please don't default construct, otherwise Units will be wrong</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <a class="code" href="structarmnn_1_1_measurement.html">Measurement</a>() = <span class="keyword">delete</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"> 50</span> </div><div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="classarmnn_1_1_instrument.html"> 51</a></span> <span class="keyword">class </span><a class="code" href="classarmnn_1_1_instrument.html">Instrument</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"> 53</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="classarmnn_1_1_instrument.html#a37a2de9b867820a7ab15b8dc8d62b153"> 54</a></span>  <span class="keyword">virtual</span> <a class="code" href="classarmnn_1_1_instrument.html#a37a2de9b867820a7ab15b8dc8d62b153">~Instrument</a>() {}</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="keyword">virtual</span> <span class="keywordtype">void</span> Start() = 0;</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="keyword">virtual</span> <span class="keywordtype">void</span> Stop() = 0;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">virtual</span> std::vector<Measurement> GetMeasurements() <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* GetName() <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> };</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> } <span class="comment">//namespace armnn</span></div><div class="ttc" id="structarmnn_1_1_measurement_html"><div class="ttname"><a href="structarmnn_1_1_measurement.html">armnn::Measurement</a></div><div class="ttdef"><b>Definition:</b> <a href="_instrument_8hpp_source.html#l00014">Instrument.hpp:14</a></div></div> |
| 88 | <div class="ttc" id="structarmnn_1_1_measurement_html_abceb2331ad056e3c5ad27894199a49edab2234de0b81a6c02ab51dcfc63065bca"><div class="ttname"><a href="structarmnn_1_1_measurement.html#abceb2331ad056e3c5ad27894199a49edab2234de0b81a6c02ab51dcfc63065bca">armnn::Measurement::TIME_MS</a></div><div class="ttdef"><b>Definition:</b> <a href="_instrument_8hpp_source.html#l00020">Instrument.hpp:20</a></div></div> |
| 89 | <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> |
| 90 | <div class="ttc" id="structarmnn_1_1_measurement_html_a5a0442afe9c1fe421251293c52d82e55"><div class="ttname"><a href="structarmnn_1_1_measurement.html#a5a0442afe9c1fe421251293c52d82e55">armnn::Measurement::~Measurement</a></div><div class="ttdeci">~Measurement()=default</div></div> |
| 91 | <div class="ttc" id="structarmnn_1_1_measurement_html_a78e6023cb54a56d22efb3af4bc1e7880"><div class="ttname"><a href="structarmnn_1_1_measurement.html#a78e6023cb54a56d22efb3af4bc1e7880">armnn::Measurement::Measurement</a></div><div class="ttdeci">Measurement(const std::string &name, double value, Unit unit)</div><div class="ttdef"><b>Definition:</b> <a href="_instrument_8hpp_source.html#l00034">Instrument.hpp:34</a></div></div> |
| 92 | <div class="ttc" id="structarmnn_1_1_measurement_html_ad38344c3d8a2840586bccc4cae0dc56d"><div class="ttname"><a href="structarmnn_1_1_measurement.html#ad38344c3d8a2840586bccc4cae0dc56d">armnn::Measurement::m_Unit</a></div><div class="ttdeci">Unit m_Unit</div><div class="ttdef"><b>Definition:</b> <a href="_instrument_8hpp_source.html#l00044">Instrument.hpp:44</a></div></div> |
| 93 | <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> |
| 94 | <div class="ttc" id="structarmnn_1_1_measurement_html_ac2b559d9ddbdc9bf665c30eece9f426e"><div class="ttname"><a href="structarmnn_1_1_measurement.html#ac2b559d9ddbdc9bf665c30eece9f426e">armnn::Measurement::m_Value</a></div><div class="ttdeci">double m_Value</div><div class="ttdef"><b>Definition:</b> <a href="_instrument_8hpp_source.html#l00043">Instrument.hpp:43</a></div></div> |
| 95 | <div class="ttc" id="structarmnn_1_1_measurement_html_ab13844df5477a9ab8f13069e3d8abad6"><div class="ttname"><a href="structarmnn_1_1_measurement.html#ab13844df5477a9ab8f13069e3d8abad6">armnn::Measurement::m_Name</a></div><div class="ttdeci">std::string m_Name</div><div class="ttdef"><b>Definition:</b> <a href="_instrument_8hpp_source.html#l00042">Instrument.hpp:42</a></div></div> |
| 96 | <div class="ttc" id="structarmnn_1_1_measurement_html_abceb2331ad056e3c5ad27894199a49edaef96c3935bbc898edd62723ad8cb00ea"><div class="ttname"><a href="structarmnn_1_1_measurement.html#abceb2331ad056e3c5ad27894199a49edaef96c3935bbc898edd62723ad8cb00ea">armnn::Measurement::TIME_US</a></div><div class="ttdef"><b>Definition:</b> <a href="_instrument_8hpp_source.html#l00019">Instrument.hpp:19</a></div></div> |
| 97 | <div class="ttc" id="structarmnn_1_1_measurement_html_abceb2331ad056e3c5ad27894199a49ed"><div class="ttname"><a href="structarmnn_1_1_measurement.html#abceb2331ad056e3c5ad27894199a49ed">armnn::Measurement::Unit</a></div><div class="ttdeci">Unit</div><div class="ttdef"><b>Definition:</b> <a href="_instrument_8hpp_source.html#l00016">Instrument.hpp:16</a></div></div> |
| 98 | <div class="ttc" id="classarmnn_1_1_instrument_html_a37a2de9b867820a7ab15b8dc8d62b153"><div class="ttname"><a href="classarmnn_1_1_instrument.html#a37a2de9b867820a7ab15b8dc8d62b153">armnn::Instrument::~Instrument</a></div><div class="ttdeci">virtual ~Instrument()</div><div class="ttdef"><b>Definition:</b> <a href="_instrument_8hpp_source.html#l00054">Instrument.hpp:54</a></div></div> |
| 99 | <div class="ttc" id="structarmnn_1_1_measurement_html_ab28eb76bc26abd263cad9dc2d1d17816"><div class="ttname"><a href="structarmnn_1_1_measurement.html#ab28eb76bc26abd263cad9dc2d1d17816">armnn::Measurement::ToString</a></div><div class="ttdeci">static const char * ToString(Unit unit)</div><div class="ttdef"><b>Definition:</b> <a href="_instrument_8hpp_source.html#l00023">Instrument.hpp:23</a></div></div> |
| 100 | <div class="ttc" id="structarmnn_1_1_measurement_html_abceb2331ad056e3c5ad27894199a49edac04d6fce03ff6dfde82088100ad3f3d7"><div class="ttname"><a href="structarmnn_1_1_measurement.html#abceb2331ad056e3c5ad27894199a49edac04d6fce03ff6dfde82088100ad3f3d7">armnn::Measurement::TIME_NS</a></div><div class="ttdef"><b>Definition:</b> <a href="_instrument_8hpp_source.html#l00018">Instrument.hpp:18</a></div></div> |
| 101 | </div><!-- fragment --></div><!-- contents --> |
| 102 | </div><!-- doc-content --> |
| 103 | <!-- start footer part --> |
| 104 | <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
| 105 | <ul> |
| 106 | <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="_instrument_8hpp.html">Instrument.hpp</a></li> |
| 107 | <li class="footer">Generated on Fri Mar 13 2020 16:06:54 for ArmNN by |
| 108 | <a href="http://www.doxygen.org/index.html"> |
| 109 | <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> |
| 110 | </ul> |
| 111 | </div> |
| 112 | </body> |
| 113 | </html> |