blob: e0a5c27aca5d910355d03bfe29178c2a7fc65059 [file] [log] [blame]
<!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/Instrument.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
&#160;<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_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">Instrument.hpp</div> </div>
</div><!--header-->
<div class="contents">
<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>&#160;<span class="comment">//</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// Copyright © 2017 Arm Ltd. All rights reserved.</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// SPDX-License-Identifier: MIT</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;</div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<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>&#160;{</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;</div><div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="structarmnn_1_1_measurement.html"> 14</a></span>&#160;<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>&#160;{</div><div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="structarmnn_1_1_measurement.html#abceb2331ad056e3c5ad27894199a49ed"> 16</a></span>&#160; <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>&#160; {</div><div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="structarmnn_1_1_measurement.html#abceb2331ad056e3c5ad27894199a49edac04d6fce03ff6dfde82088100ad3f3d7"> 18</a></span>&#160; <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>&#160; <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>&#160; <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>&#160; };</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="structarmnn_1_1_measurement.html#ab28eb76bc26abd263cad9dc2d1d17816"> 23</a></span>&#160; <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>&#160; {</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="keywordflow">switch</span> (unit)</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; {</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <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">&quot;ns&quot;</span>;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <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">&quot;us&quot;</span>;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <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">&quot;ms&quot;</span>;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keywordflow">default</span>: <span class="keywordflow">return</span> <span class="stringliteral">&quot;&quot;</span>;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; }</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;</div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="structarmnn_1_1_measurement.html#a78e6023cb54a56d22efb3af4bc1e7880"> 34</a></span>&#160; <a class="code" href="structarmnn_1_1_measurement.html#a78e6023cb54a56d22efb3af4bc1e7880">Measurement</a>(<span class="keyword">const</span> std::string&amp; 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>&#160; : <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>&#160; , <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>&#160; , <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>&#160; {}</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <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>&amp;) = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <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>&#160;</div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="structarmnn_1_1_measurement.html#ab13844df5477a9ab8f13069e3d8abad6"> 42</a></span>&#160; 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>&#160; <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>&#160; <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>&#160;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="comment">// please don&#39;t default construct, otherwise Units will be wrong</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <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>&#160;};</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;</div><div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="classarmnn_1_1_instrument.html"> 51</a></span>&#160;<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>&#160;{</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;<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>&#160; <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>&#160;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <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>&#160;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <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>&#160;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keyword">virtual</span> std::vector&lt;Measurement&gt; GetMeasurements() <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <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>&#160;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;};</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;} <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>
<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>
<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="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>
<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 &amp;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>
<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>
<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="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>
<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>
<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>
<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>
<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>
<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>
<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>
</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="_instrument_8hpp.html">Instrument.hpp</a></li>
<li class="footer">Generated on Fri Mar 13 2020 16:06:54 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>