diff options
author | David Monahan <david.monahan@arm.com> | 2023-03-22 16:48:58 +0000 |
---|---|---|
committer | David Monahan <david.monahan@arm.com> | 2023-03-22 16:48:58 +0000 |
commit | ae050524109f1ce827962665436ef7430f2ac479 (patch) | |
tree | a087fe0c77570971dd7979f2757426c24e91afc7 /23.02/_instrument_8hpp_source.xhtml | |
parent | 8d2ca734165a068478df7cffa46185680b05cd20 (diff) | |
download | armnn-ae050524109f1ce827962665436ef7430f2ac479.tar.gz |
IVGCVSW-7255 Update Doxygen Documentation and publish on GitHub.
* Updating Doxygen documentation for 23.02 release.
Signed-off-by: David Monahan <david.monahan@arm.com>
Change-Id: I545574ff7664b4595d2fe6a91a3c35d2ad55df82
Diffstat (limited to '23.02/_instrument_8hpp_source.xhtml')
-rw-r--r-- | 23.02/_instrument_8hpp_source.xhtml | 125 |
1 files changed, 100 insertions, 25 deletions
diff --git a/23.02/_instrument_8hpp_source.xhtml b/23.02/_instrument_8hpp_source.xhtml index dc42c1c4c0..8ef89882aa 100644 --- a/23.02/_instrument_8hpp_source.xhtml +++ b/23.02/_instrument_8hpp_source.xhtml @@ -8,7 +8,7 @@ <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="generator" content="Doxygen 1.8.17"/> <meta name="robots" content="NOINDEX, NOFOLLOW" /> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>ArmNN: src/armnn/Instrument.hpp Source File</title> @@ -19,9 +19,6 @@ <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> @@ -30,7 +27,8 @@ extensions: ["tex2jax.js"], jax: ["input/TeX","output/HTML-CSS"], }); -</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script> +</script> +<script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> <link href="stylesheet.css" rel="stylesheet" type="text/css"/> </head> @@ -51,18 +49,21 @@ </table> </div> <!-- end header part --> -<!-- Generated by Doxygen 1.8.13 --> +<!-- Generated by Doxygen 1.8.17 --> <script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ var searchBox = new SearchBox("searchBox", "search",false,'Search'); +/* @license-end */ </script> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('',true,false,'search.php','Search'); $(document).ready(function() { init_search(); }); }); -</script> +/* @license-end */</script> <div id="main-nav"></div> </div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> @@ -76,7 +77,9 @@ $(function() { </div> </div> <script type="text/javascript"> -$(document).ready(function(){initNavTree('_instrument_8hpp_source.xhtml','');}); +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(document).ready(function(){initNavTree('_instrument_8hpp_source.xhtml',''); initResizable(); }); +/* @license-end */ </script> <div id="doc-content"> <!-- window showing the filter options --> @@ -98,30 +101,102 @@ $(document).ready(function(){initNavTree('_instrument_8hpp_source.xhtml','');}); <div class="title">Instrument.hpp</div> </div> </div><!--header--> <div class="contents"> -<a href="_instrument_8hpp.xhtml">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.xhtml">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.xhtml"> 14</a></span> <span class="keyword">struct </span><a class="code" href="structarmnn_1_1_measurement.xhtml">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.xhtml#abceb2331ad056e3c5ad27894199a49ed"> 16</a></span>  <span class="keyword">enum</span> <a class="code" href="structarmnn_1_1_measurement.xhtml#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.xhtml#abceb2331ad056e3c5ad27894199a49edac04d6fce03ff6dfde82088100ad3f3d7"> 18</a></span>  <a class="code" href="structarmnn_1_1_measurement.xhtml#abceb2331ad056e3c5ad27894199a49edac04d6fce03ff6dfde82088100ad3f3d7">TIME_NS</a>,</div><div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="structarmnn_1_1_measurement.xhtml#abceb2331ad056e3c5ad27894199a49edaef96c3935bbc898edd62723ad8cb00ea"> 19</a></span>  <a class="code" href="structarmnn_1_1_measurement.xhtml#abceb2331ad056e3c5ad27894199a49edaef96c3935bbc898edd62723ad8cb00ea">TIME_US</a>,</div><div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="structarmnn_1_1_measurement.xhtml#abceb2331ad056e3c5ad27894199a49edab2234de0b81a6c02ab51dcfc63065bca"> 20</a></span>  <a class="code" href="structarmnn_1_1_measurement.xhtml#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.xhtml#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.xhtml#ab28eb76bc26abd263cad9dc2d1d17816">ToString</a>(<a class="code" href="structarmnn_1_1_measurement.xhtml#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.xhtml#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.xhtml#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.xhtml#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.xhtml#a78e6023cb54a56d22efb3af4bc1e7880"> 34</a></span>  <a class="code" href="structarmnn_1_1_measurement.xhtml#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.xhtml#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.xhtml#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.xhtml#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.xhtml#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.xhtml">Measurement</a>(<span class="keyword">const</span> <a class="code" href="structarmnn_1_1_measurement.xhtml">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.xhtml#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.xhtml#ab13844df5477a9ab8f13069e3d8abad6"> 42</a></span>  std::string <a class="code" href="structarmnn_1_1_measurement.xhtml#ab13844df5477a9ab8f13069e3d8abad6">m_Name</a>;</div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="structarmnn_1_1_measurement.xhtml#ac2b559d9ddbdc9bf665c30eece9f426e"> 43</a></span>  <span class="keywordtype">double</span> <a class="code" href="structarmnn_1_1_measurement.xhtml#ac2b559d9ddbdc9bf665c30eece9f426e">m_Value</a>;</div><div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="structarmnn_1_1_measurement.xhtml#ad38344c3d8a2840586bccc4cae0dc56d"> 44</a></span>  <a class="code" href="structarmnn_1_1_measurement.xhtml#abceb2331ad056e3c5ad27894199a49ed">Unit</a> <a class="code" href="structarmnn_1_1_measurement.xhtml#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.xhtml">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.xhtml"> 51</a></span> <span class="keyword">class </span><a class="code" href="classarmnn_1_1_instrument.xhtml">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.xhtml#a37a2de9b867820a7ab15b8dc8d62b153"> 54</a></span>  <span class="keyword">virtual</span> <a class="code" href="classarmnn_1_1_instrument.xhtml#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"><a class="line" href="classarmnn_1_1_instrument.xhtml#af86639ebdd7db055ee07c3d924d4c0ff"> 64</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classarmnn_1_1_instrument.xhtml#af86639ebdd7db055ee07c3d924d4c0ff">HasKernelMeasurements</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">false</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> };</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> } <span class="comment">//namespace armnn</span></div><div class="ttc" id="structarmnn_1_1_measurement_xhtml_ad38344c3d8a2840586bccc4cae0dc56d"><div class="ttname"><a href="structarmnn_1_1_measurement.xhtml#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.xhtml#l00044">Instrument.hpp:44</a></div></div> -<div class="ttc" id="structarmnn_1_1_measurement_xhtml_abceb2331ad056e3c5ad27894199a49ed"><div class="ttname"><a href="structarmnn_1_1_measurement.xhtml#abceb2331ad056e3c5ad27894199a49ed">armnn::Measurement::Unit</a></div><div class="ttdeci">Unit</div><div class="ttdef"><b>Definition:</b> <a href="_instrument_8hpp_source.xhtml#l00016">Instrument.hpp:16</a></div></div> -<div class="ttc" id="structarmnn_1_1_measurement_xhtml_ab28eb76bc26abd263cad9dc2d1d17816"><div class="ttname"><a href="structarmnn_1_1_measurement.xhtml#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.xhtml#l00023">Instrument.hpp:23</a></div></div> -<div class="ttc" id="structarmnn_1_1_measurement_xhtml_ab13844df5477a9ab8f13069e3d8abad6"><div class="ttname"><a href="structarmnn_1_1_measurement.xhtml#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.xhtml#l00042">Instrument.hpp:42</a></div></div> -<div class="ttc" id="structarmnn_1_1_measurement_xhtml"><div class="ttname"><a href="structarmnn_1_1_measurement.xhtml">armnn::Measurement</a></div><div class="ttdef"><b>Definition:</b> <a href="_instrument_8hpp_source.xhtml#l00014">Instrument.hpp:14</a></div></div> -<div class="ttc" id="namespacearmnn_xhtml"><div class="ttname"><a href="namespacearmnn.xhtml">armnn</a></div><div class="ttdoc">Copyright (c) 2021 ARM Limited and Contributors. </div><div class="ttdef"><b>Definition:</b> <a href="01__00__quick__start_8dox_source.xhtml#l00006">01_00_quick_start.dox:6</a></div></div> -<div class="ttc" id="structarmnn_1_1_measurement_xhtml_abceb2331ad056e3c5ad27894199a49edac04d6fce03ff6dfde82088100ad3f3d7"><div class="ttname"><a href="structarmnn_1_1_measurement.xhtml#abceb2331ad056e3c5ad27894199a49edac04d6fce03ff6dfde82088100ad3f3d7">armnn::Measurement::TIME_NS</a></div><div class="ttdef"><b>Definition:</b> <a href="_instrument_8hpp_source.xhtml#l00018">Instrument.hpp:18</a></div></div> -<div class="ttc" id="structarmnn_1_1_measurement_xhtml_a78e6023cb54a56d22efb3af4bc1e7880"><div class="ttname"><a href="structarmnn_1_1_measurement.xhtml#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.xhtml#l00034">Instrument.hpp:34</a></div></div> -<div class="ttc" id="structarmnn_1_1_measurement_xhtml_abceb2331ad056e3c5ad27894199a49edab2234de0b81a6c02ab51dcfc63065bca"><div class="ttname"><a href="structarmnn_1_1_measurement.xhtml#abceb2331ad056e3c5ad27894199a49edab2234de0b81a6c02ab51dcfc63065bca">armnn::Measurement::TIME_MS</a></div><div class="ttdef"><b>Definition:</b> <a href="_instrument_8hpp_source.xhtml#l00020">Instrument.hpp:20</a></div></div> -<div class="ttc" id="classarmnn_1_1_instrument_xhtml_a37a2de9b867820a7ab15b8dc8d62b153"><div class="ttname"><a href="classarmnn_1_1_instrument.xhtml#a37a2de9b867820a7ab15b8dc8d62b153">armnn::Instrument::~Instrument</a></div><div class="ttdeci">virtual ~Instrument()</div><div class="ttdef"><b>Definition:</b> <a href="_instrument_8hpp_source.xhtml#l00054">Instrument.hpp:54</a></div></div> -<div class="ttc" id="structarmnn_1_1_measurement_xhtml_a5a0442afe9c1fe421251293c52d82e55"><div class="ttname"><a href="structarmnn_1_1_measurement.xhtml#a5a0442afe9c1fe421251293c52d82e55">armnn::Measurement::~Measurement</a></div><div class="ttdeci">~Measurement()=default</div></div> -<div class="ttc" id="structarmnn_1_1_measurement_xhtml_ac2b559d9ddbdc9bf665c30eece9f426e"><div class="ttname"><a href="structarmnn_1_1_measurement.xhtml#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.xhtml#l00043">Instrument.hpp:43</a></div></div> -<div class="ttc" id="structarmnn_1_1_measurement_xhtml_abceb2331ad056e3c5ad27894199a49edaef96c3935bbc898edd62723ad8cb00ea"><div class="ttname"><a href="structarmnn_1_1_measurement.xhtml#abceb2331ad056e3c5ad27894199a49edaef96c3935bbc898edd62723ad8cb00ea">armnn::Measurement::TIME_US</a></div><div class="ttdef"><b>Definition:</b> <a href="_instrument_8hpp_source.xhtml#l00019">Instrument.hpp:19</a></div></div> -<div class="ttc" id="classarmnn_1_1_instrument_xhtml_af86639ebdd7db055ee07c3d924d4c0ff"><div class="ttname"><a href="classarmnn_1_1_instrument.xhtml#af86639ebdd7db055ee07c3d924d4c0ff">armnn::Instrument::HasKernelMeasurements</a></div><div class="ttdeci">virtual bool HasKernelMeasurements() const</div><div class="ttdef"><b>Definition:</b> <a href="_instrument_8hpp_source.xhtml#l00064">Instrument.hpp:64</a></div></div> -<div class="ttc" id="classarmnn_1_1_instrument_xhtml"><div class="ttname"><a href="classarmnn_1_1_instrument.xhtml">armnn::Instrument</a></div><div class="ttdef"><b>Definition:</b> <a href="_instrument_8hpp_source.xhtml#l00051">Instrument.hpp:51</a></div></div> +<a href="_instrument_8hpp.xhtml">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.xhtml">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.xhtml"> 14</a></span> <span class="keyword">struct </span><a class="code" href="structarmnn_1_1_measurement.xhtml">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.xhtml#abceb2331ad056e3c5ad27894199a49ed"> 16</a></span>  <span class="keyword">enum</span> <a class="code" href="structarmnn_1_1_measurement.xhtml#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.xhtml#abceb2331ad056e3c5ad27894199a49edac04d6fce03ff6dfde82088100ad3f3d7"> 18</a></span>  <a class="code" href="structarmnn_1_1_measurement.xhtml#abceb2331ad056e3c5ad27894199a49edac04d6fce03ff6dfde82088100ad3f3d7">TIME_NS</a>,</div> +<div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="structarmnn_1_1_measurement.xhtml#abceb2331ad056e3c5ad27894199a49edaef96c3935bbc898edd62723ad8cb00ea"> 19</a></span>  <a class="code" href="structarmnn_1_1_measurement.xhtml#abceb2331ad056e3c5ad27894199a49edaef96c3935bbc898edd62723ad8cb00ea">TIME_US</a>,</div> +<div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="structarmnn_1_1_measurement.xhtml#abceb2331ad056e3c5ad27894199a49edab2234de0b81a6c02ab51dcfc63065bca"> 20</a></span>  <a class="code" href="structarmnn_1_1_measurement.xhtml#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.xhtml#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.xhtml#ab28eb76bc26abd263cad9dc2d1d17816">ToString</a>(<a class="code" href="structarmnn_1_1_measurement.xhtml#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.xhtml#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.xhtml#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.xhtml#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.xhtml#a78e6023cb54a56d22efb3af4bc1e7880"> 34</a></span>  <a class="code" href="structarmnn_1_1_measurement.xhtml#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.xhtml#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.xhtml#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.xhtml#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.xhtml#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.xhtml">Measurement</a>(<span class="keyword">const</span> <a class="code" href="structarmnn_1_1_measurement.xhtml">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.xhtml#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.xhtml#ab13844df5477a9ab8f13069e3d8abad6"> 42</a></span>  std::string <a class="code" href="structarmnn_1_1_measurement.xhtml#ab13844df5477a9ab8f13069e3d8abad6">m_Name</a>;</div> +<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="structarmnn_1_1_measurement.xhtml#ac2b559d9ddbdc9bf665c30eece9f426e"> 43</a></span>  <span class="keywordtype">double</span> <a class="code" href="structarmnn_1_1_measurement.xhtml#ac2b559d9ddbdc9bf665c30eece9f426e">m_Value</a>;</div> +<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="structarmnn_1_1_measurement.xhtml#ad38344c3d8a2840586bccc4cae0dc56d"> 44</a></span>  <a class="code" href="structarmnn_1_1_measurement.xhtml#abceb2331ad056e3c5ad27894199a49ed">Unit</a> <a class="code" href="structarmnn_1_1_measurement.xhtml#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.xhtml">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.xhtml"> 51</a></span> <span class="keyword">class </span><a class="code" href="classarmnn_1_1_instrument.xhtml">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.xhtml#a37a2de9b867820a7ab15b8dc8d62b153"> 54</a></span>  <span class="keyword">virtual</span> <a class="code" href="classarmnn_1_1_instrument.xhtml#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> <a class="code" href="classarmnn_1_1_instrument.xhtml#a63ce9b9c6710c0dae98f88d6c602313a">Start</a>() = 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> <a class="code" href="classarmnn_1_1_instrument.xhtml#a4d7bebcc22c1b09cf961b83bf84033b6">Stop</a>() = 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> <a class="code" href="classarmnn_1_1_instrument.xhtml#a4055fcf05306a7478db7e192cf1e679d">GetMeasurements</a>() <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>* <a class="code" href="classarmnn_1_1_instrument.xhtml#afcc1c3a20bd2860e0ddd21674389246f">GetName</a>() <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"><a class="line" href="classarmnn_1_1_instrument.xhtml#af86639ebdd7db055ee07c3d924d4c0ff"> 64</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classarmnn_1_1_instrument.xhtml#af86639ebdd7db055ee07c3d924d4c0ff">HasKernelMeasurements</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">false</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> };</div> +<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  </div> +<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> } <span class="comment">//namespace armnn</span></div> </div><!-- fragment --></div><!-- contents --> </div><!-- doc-content --> +<div class="ttc" id="aclassarmnn_1_1_instrument_xhtml"><div class="ttname"><a href="classarmnn_1_1_instrument.xhtml">armnn::Instrument</a></div><div class="ttdef"><b>Definition:</b> <a href="_instrument_8hpp_source.xhtml#l00051">Instrument.hpp:51</a></div></div> +<div class="ttc" id="aclassarmnn_1_1_instrument_xhtml_a4055fcf05306a7478db7e192cf1e679d"><div class="ttname"><a href="classarmnn_1_1_instrument.xhtml#a4055fcf05306a7478db7e192cf1e679d">armnn::Instrument::GetMeasurements</a></div><div class="ttdeci">virtual std::vector< Measurement > GetMeasurements() const =0</div></div> +<div class="ttc" id="astructarmnn_1_1_measurement_xhtml_abceb2331ad056e3c5ad27894199a49edaef96c3935bbc898edd62723ad8cb00ea"><div class="ttname"><a href="structarmnn_1_1_measurement.xhtml#abceb2331ad056e3c5ad27894199a49edaef96c3935bbc898edd62723ad8cb00ea">armnn::Measurement::TIME_US</a></div><div class="ttdeci">@ TIME_US</div><div class="ttdef"><b>Definition:</b> <a href="_instrument_8hpp_source.xhtml#l00019">Instrument.hpp:19</a></div></div> +<div class="ttc" id="astructarmnn_1_1_measurement_xhtml_a5a0442afe9c1fe421251293c52d82e55"><div class="ttname"><a href="structarmnn_1_1_measurement.xhtml#a5a0442afe9c1fe421251293c52d82e55">armnn::Measurement::~Measurement</a></div><div class="ttdeci">~Measurement()=default</div></div> +<div class="ttc" id="aclassarmnn_1_1_instrument_xhtml_a63ce9b9c6710c0dae98f88d6c602313a"><div class="ttname"><a href="classarmnn_1_1_instrument.xhtml#a63ce9b9c6710c0dae98f88d6c602313a">armnn::Instrument::Start</a></div><div class="ttdeci">virtual void Start()=0</div></div> +<div class="ttc" id="astructarmnn_1_1_measurement_xhtml_ad38344c3d8a2840586bccc4cae0dc56d"><div class="ttname"><a href="structarmnn_1_1_measurement.xhtml#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.xhtml#l00044">Instrument.hpp:44</a></div></div> +<div class="ttc" id="astructarmnn_1_1_measurement_xhtml_abceb2331ad056e3c5ad27894199a49edab2234de0b81a6c02ab51dcfc63065bca"><div class="ttname"><a href="structarmnn_1_1_measurement.xhtml#abceb2331ad056e3c5ad27894199a49edab2234de0b81a6c02ab51dcfc63065bca">armnn::Measurement::TIME_MS</a></div><div class="ttdeci">@ TIME_MS</div><div class="ttdef"><b>Definition:</b> <a href="_instrument_8hpp_source.xhtml#l00020">Instrument.hpp:20</a></div></div> +<div class="ttc" id="anamespacearmnn_xhtml"><div class="ttname"><a href="namespacearmnn.xhtml">armnn</a></div><div class="ttdoc">Copyright (c) 2021 ARM Limited and Contributors.</div><div class="ttdef"><b>Definition:</b> <a href="01__00__quick__start_8dox_source.xhtml#l00006">01_00_quick_start.dox:6</a></div></div> +<div class="ttc" id="astructarmnn_1_1_measurement_xhtml_a78e6023cb54a56d22efb3af4bc1e7880"><div class="ttname"><a href="structarmnn_1_1_measurement.xhtml#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.xhtml#l00034">Instrument.hpp:34</a></div></div> +<div class="ttc" id="astructarmnn_1_1_measurement_xhtml_abceb2331ad056e3c5ad27894199a49edac04d6fce03ff6dfde82088100ad3f3d7"><div class="ttname"><a href="structarmnn_1_1_measurement.xhtml#abceb2331ad056e3c5ad27894199a49edac04d6fce03ff6dfde82088100ad3f3d7">armnn::Measurement::TIME_NS</a></div><div class="ttdeci">@ TIME_NS</div><div class="ttdef"><b>Definition:</b> <a href="_instrument_8hpp_source.xhtml#l00018">Instrument.hpp:18</a></div></div> +<div class="ttc" id="astructarmnn_1_1_measurement_xhtml_ab13844df5477a9ab8f13069e3d8abad6"><div class="ttname"><a href="structarmnn_1_1_measurement.xhtml#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.xhtml#l00042">Instrument.hpp:42</a></div></div> +<div class="ttc" id="astructarmnn_1_1_measurement_xhtml_ab28eb76bc26abd263cad9dc2d1d17816"><div class="ttname"><a href="structarmnn_1_1_measurement.xhtml#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.xhtml#l00023">Instrument.hpp:23</a></div></div> +<div class="ttc" id="aclassarmnn_1_1_instrument_xhtml_afcc1c3a20bd2860e0ddd21674389246f"><div class="ttname"><a href="classarmnn_1_1_instrument.xhtml#afcc1c3a20bd2860e0ddd21674389246f">armnn::Instrument::GetName</a></div><div class="ttdeci">virtual const char * GetName() const =0</div></div> +<div class="ttc" id="aclassarmnn_1_1_instrument_xhtml_af86639ebdd7db055ee07c3d924d4c0ff"><div class="ttname"><a href="classarmnn_1_1_instrument.xhtml#af86639ebdd7db055ee07c3d924d4c0ff">armnn::Instrument::HasKernelMeasurements</a></div><div class="ttdeci">virtual bool HasKernelMeasurements() const</div><div class="ttdef"><b>Definition:</b> <a href="_instrument_8hpp_source.xhtml#l00064">Instrument.hpp:64</a></div></div> +<div class="ttc" id="astructarmnn_1_1_measurement_xhtml_abceb2331ad056e3c5ad27894199a49ed"><div class="ttname"><a href="structarmnn_1_1_measurement.xhtml#abceb2331ad056e3c5ad27894199a49ed">armnn::Measurement::Unit</a></div><div class="ttdeci">Unit</div><div class="ttdef"><b>Definition:</b> <a href="_instrument_8hpp_source.xhtml#l00016">Instrument.hpp:16</a></div></div> +<div class="ttc" id="aclassarmnn_1_1_instrument_xhtml_a37a2de9b867820a7ab15b8dc8d62b153"><div class="ttname"><a href="classarmnn_1_1_instrument.xhtml#a37a2de9b867820a7ab15b8dc8d62b153">armnn::Instrument::~Instrument</a></div><div class="ttdeci">virtual ~Instrument()</div><div class="ttdef"><b>Definition:</b> <a href="_instrument_8hpp_source.xhtml#l00054">Instrument.hpp:54</a></div></div> +<div class="ttc" id="aclassarmnn_1_1_instrument_xhtml_a4d7bebcc22c1b09cf961b83bf84033b6"><div class="ttname"><a href="classarmnn_1_1_instrument.xhtml#a4d7bebcc22c1b09cf961b83bf84033b6">armnn::Instrument::Stop</a></div><div class="ttdeci">virtual void Stop()=0</div></div> +<div class="ttc" id="astructarmnn_1_1_measurement_xhtml_ac2b559d9ddbdc9bf665c30eece9f426e"><div class="ttname"><a href="structarmnn_1_1_measurement.xhtml#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.xhtml#l00043">Instrument.hpp:43</a></div></div> +<div class="ttc" id="astructarmnn_1_1_measurement_xhtml"><div class="ttname"><a href="structarmnn_1_1_measurement.xhtml">armnn::Measurement</a></div><div class="ttdef"><b>Definition:</b> <a href="_instrument_8hpp_source.xhtml#l00014">Instrument.hpp:14</a></div></div> <!-- 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.xhtml">src</a></li><li class="navelem"><a class="el" href="dir_e0a84d05c80a2ef4231141dcbbeac5c8.xhtml">armnn</a></li><li class="navelem"><a class="el" href="_instrument_8hpp.xhtml">Instrument.hpp</a></li> - <li class="footer">Generated on Fri Feb 24 2023 10:24:24 for ArmNN by + <li class="footer">Generated on Wed Mar 22 2023 15:52: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> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li> </ul> </div> </body> |