blob: 435e8971875754d934e74d2ee86ed7b79f24f4a6 [file] [log] [blame]
Anthony Barbierdbdab852017-06-23 15:42:00 +01001<!-- HTML header for doxygen 1.8.9.1-->
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml">
4<head>
5<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6<meta http-equiv="X-UA-Compatible" content="IE=9"/>
Jenkinsb9abeae2018-11-22 11:58:08 +00007<meta name="generator" content="Doxygen 1.8.13"/>
Anthony Barbierdbdab852017-06-23 15:42:00 +01008<meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
Kaizen8938bd32017-09-28 14:38:23 +01009<title>Compute Library: tests/framework/Profiler.h Source File</title>
Anthony Barbierdbdab852017-06-23 15:42:00 +010010<link href="tabs.css" rel="stylesheet" type="text/css"/>
11<script type="text/javascript" src="jquery.js"></script>
12<script type="text/javascript" src="dynsections.js"></script>
13<link href="navtree.css" rel="stylesheet" type="text/css"/>
14<script type="text/javascript" src="resize.js"></script>
Anthony Barbier8140e1e2017-12-14 23:48:46 +000015<script type="text/javascript" src="navtreedata.js"></script>
Anthony Barbierdbdab852017-06-23 15:42:00 +010016<script type="text/javascript" src="navtree.js"></script>
17<script type="text/javascript">
18 $(document).ready(initResizable);
Anthony Barbierdbdab852017-06-23 15:42:00 +010019</script>
20<link href="search/search.css" rel="stylesheet" type="text/css"/>
Anthony Barbier8140e1e2017-12-14 23:48:46 +000021<script type="text/javascript" src="search/searchdata.js"></script>
Anthony Barbierdbdab852017-06-23 15:42:00 +010022<script type="text/javascript" src="search/search.js"></script>
Anthony Barbierdbdab852017-06-23 15:42:00 +010023<script type="text/x-mathjax-config">
24 MathJax.Hub.Config({
25 extensions: ["tex2jax.js"],
26 jax: ["input/TeX","output/HTML-CSS"],
27});
Anthony Barbier8140e1e2017-12-14 23:48:46 +000028</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
Anthony Barbierdbdab852017-06-23 15:42:00 +010029<link href="doxygen.css" rel="stylesheet" type="text/css" />
30</head>
31<body>
32<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
33<div id="titlearea">
34<table cellspacing="0" cellpadding="0">
35 <tbody>
36 <tr style="height: 56px;">
37 <td style="padding-left: 0.5em;">
38 <div id="projectname">Compute Library
Jenkinsb9abeae2018-11-22 11:58:08 +000039 &#160;<span id="projectnumber">18.11</span>
Anthony Barbierdbdab852017-06-23 15:42:00 +010040 </div>
41 </td>
42 </tr>
43 </tbody>
44</table>
45</div>
46<!-- end header part -->
Jenkinsb9abeae2018-11-22 11:58:08 +000047<!-- Generated by Doxygen 1.8.13 -->
Anthony Barbierdbdab852017-06-23 15:42:00 +010048<script type="text/javascript">
49var searchBox = new SearchBox("searchBox", "search",false,'Search');
50</script>
Jenkinsb9abeae2018-11-22 11:58:08 +000051<script type="text/javascript" src="menudata.js"></script>
52<script type="text/javascript" src="menu.js"></script>
53<script type="text/javascript">
54$(function() {
55 initMenu('',true,false,'search.php','Search');
56 $(document).ready(function() { init_search(); });
57});
58</script>
59<div id="main-nav"></div>
Anthony Barbierdbdab852017-06-23 15:42:00 +010060</div><!-- top -->
61<div id="side-nav" class="ui-resizable side-nav-resizable">
62 <div id="nav-tree">
63 <div id="nav-tree-contents">
64 <div id="nav-sync" class="sync"></div>
65 </div>
66 </div>
67 <div id="splitbar" style="-moz-user-select:none;"
68 class="ui-resizable-handle">
69 </div>
70</div>
71<script type="text/javascript">
72$(document).ready(function(){initNavTree('_profiler_8h_source.xhtml','');});
73</script>
74<div id="doc-content">
75<!-- window showing the filter options -->
76<div id="MSearchSelectWindow"
77 onmouseover="return searchBox.OnSearchSelectShow()"
78 onmouseout="return searchBox.OnSearchSelectHide()"
79 onkeydown="return searchBox.OnSearchSelectKey(event)">
Anthony Barbier8140e1e2017-12-14 23:48:46 +000080</div>
Anthony Barbierdbdab852017-06-23 15:42:00 +010081
82<!-- iframe showing the search results (closed by default) -->
83<div id="MSearchResultsWindow">
84<iframe src="javascript:void(0)" frameborder="0"
85 name="MSearchResults" id="MSearchResults">
86</iframe>
87</div>
88
89<div class="header">
90 <div class="headertitle">
91<div class="title">Profiler.h</div> </div>
92</div><!--header-->
93<div class="contents">
Jenkinsb9abeae2018-11-22 11:58:08 +000094<a href="_profiler_8h.xhtml">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 (c) 2017-2018 ARM Limited.</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * SPDX-License-Identifier: MIT</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a copy</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * of this software and associated documentation files (the &quot;Software&quot;), to</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * deal in the Software without restriction, including without limitation the</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * sell copies of the Software, and to permit persons to whom the Software is</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * furnished to do so, subject to the following conditions:</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * The above copyright notice and this permission notice shall be included in all</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * copies or substantial portions of the Software.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> * THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment"> * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="comment"> * SOFTWARE.</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#ifndef ARM_COMPUTE_TEST_PROFILER</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#define ARM_COMPUTE_TEST_PROFILER</span></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="preprocessor">#include &quot;<a class="code" href="_instrument_8h.xhtml">instruments/Instrument.h</a>&quot;</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_measurement_8h.xhtml">instruments/Measurement.h</a>&quot;</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor">#include &lt;map&gt;</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="preprocessor">#include &lt;memory&gt;</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacearm__compute.xhtml">arm_compute</a></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;{</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="keyword">namespace </span>test</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;<span class="keyword">namespace </span>framework</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;{</div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classarm__compute_1_1test_1_1framework_1_1_profiler.xhtml"> 45</a></span>&#160;<span class="keyword">class </span><a class="code" href="classarm__compute_1_1test_1_1framework_1_1_profiler.xhtml">Profiler</a></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;{</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="classarm__compute_1_1test_1_1framework_1_1_profiler.xhtml#a06c89e23a39ce6f2e8e8a1de5bb7002a"> 49</a></span>&#160; <span class="keyword">using</span> <a class="code" href="classarm__compute_1_1test_1_1framework_1_1_profiler.xhtml#a06c89e23a39ce6f2e8e8a1de5bb7002a">MeasurementsMap</a> = std::map&lt;std::string, std::vector&lt;Measurement&gt;&gt;;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classarm__compute_1_1test_1_1framework_1_1_profiler.xhtml#a9a2cd15d64a87642898d68b060a5afa9">add</a>(std::unique_ptr&lt;Instrument&gt; instrument);</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classarm__compute_1_1test_1_1framework_1_1_profiler.xhtml#a4b454bbf54829d209850a8efa639b942">test_start</a>();</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classarm__compute_1_1test_1_1framework_1_1_profiler.xhtml#a60de64d75454385b23995437f1d72669">start</a>();</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classarm__compute_1_1test_1_1framework_1_1_profiler.xhtml#a8c528baf37154d347366083f0f816846">stop</a>();</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classarm__compute_1_1test_1_1framework_1_1_profiler.xhtml#a19091d72dfe50cd8474566e912701e8c">test_stop</a>();</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="keyword">const</span> <a class="code" href="classarm__compute_1_1test_1_1framework_1_1_profiler.xhtml#a06c89e23a39ce6f2e8e8a1de5bb7002a">MeasurementsMap</a> &amp;<a class="code" href="classarm__compute_1_1test_1_1framework_1_1_profiler.xhtml#ad548fafce1d10263d6d02fa8df934167">measurements</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; std::vector&lt;std::unique_ptr&lt;Instrument&gt;&gt; _instruments{};</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <a class="code" href="classarm__compute_1_1test_1_1framework_1_1_profiler.xhtml#a06c89e23a39ce6f2e8e8a1de5bb7002a">MeasurementsMap</a> _measurements{};</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;};</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;} <span class="comment">// namespace framework</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;} <span class="comment">// namespace test</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;} <span class="comment">// namespace arm_compute</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* ARM_COMPUTE_TEST_PROFILER */</span><span class="preprocessor"></span></div><div class="ttc" id="classarm__compute_1_1test_1_1framework_1_1_profiler_xhtml_a9a2cd15d64a87642898d68b060a5afa9"><div class="ttname"><a href="classarm__compute_1_1test_1_1framework_1_1_profiler.xhtml#a9a2cd15d64a87642898d68b060a5afa9">arm_compute::test::framework::Profiler::add</a></div><div class="ttdeci">void add(std::unique_ptr&lt; Instrument &gt; instrument)</div><div class="ttdoc">Add instrument to the performance monitor. </div><div class="ttdef"><b>Definition:</b> <a href="_profiler_8cpp_source.xhtml#l00035">Profiler.cpp:35</a></div></div>
Kaizen8938bd32017-09-28 14:38:23 +010095<div class="ttc" id="_measurement_8h_xhtml"><div class="ttname"><a href="_measurement_8h.xhtml">Measurement.h</a></div></div>
96<div class="ttc" id="classarm__compute_1_1test_1_1framework_1_1_profiler_xhtml"><div class="ttname"><a href="classarm__compute_1_1test_1_1framework_1_1_profiler.xhtml">arm_compute::test::framework::Profiler</a></div><div class="ttdoc">Profiler class to collect benchmark numbers. </div><div class="ttdef"><b>Definition:</b> <a href="_profiler_8h_source.xhtml#l00045">Profiler.h:45</a></div></div>
Jenkinsb3a371b2018-05-23 11:36:53 +010097<div class="ttc" id="classarm__compute_1_1test_1_1framework_1_1_profiler_xhtml_a19091d72dfe50cd8474566e912701e8c"><div class="ttname"><a href="classarm__compute_1_1test_1_1framework_1_1_profiler.xhtml#a19091d72dfe50cd8474566e912701e8c">arm_compute::test::framework::Profiler::test_stop</a></div><div class="ttdeci">void test_stop()</div><div class="ttdoc">Call test_stop() on all the added instruments. </div><div class="ttdef"><b>Definition:</b> <a href="_profiler_8cpp_source.xhtml#l00071">Profiler.cpp:71</a></div></div>
Jenkinsb9abeae2018-11-22 11:58:08 +000098<div class="ttc" id="namespacearm__compute_xhtml"><div class="ttname"><a href="namespacearm__compute.xhtml">arm_compute</a></div><div class="ttdoc">Copyright (c) 2017-2018 ARM Limited. </div><div class="ttdef"><b>Definition:</b> <a href="00__introduction_8dox_source.xhtml#l00024">00_introduction.dox:24</a></div></div>
99<div class="ttc" id="classarm__compute_1_1test_1_1framework_1_1_profiler_xhtml_a06c89e23a39ce6f2e8e8a1de5bb7002a"><div class="ttname"><a href="classarm__compute_1_1test_1_1framework_1_1_profiler.xhtml#a06c89e23a39ce6f2e8e8a1de5bb7002a">arm_compute::test::framework::Profiler::MeasurementsMap</a></div><div class="ttdeci">std::map&lt; std::string, std::vector&lt; Measurement &gt; &gt; MeasurementsMap</div><div class="ttdoc">Mapping from instrument ids to their measurements. </div><div class="ttdef"><b>Definition:</b> <a href="_profiler_8h_source.xhtml#l00049">Profiler.h:49</a></div></div>
100<div class="ttc" id="classarm__compute_1_1test_1_1framework_1_1_profiler_xhtml_ad548fafce1d10263d6d02fa8df934167"><div class="ttname"><a href="classarm__compute_1_1test_1_1framework_1_1_profiler.xhtml#ad548fafce1d10263d6d02fa8df934167">arm_compute::test::framework::Profiler::measurements</a></div><div class="ttdeci">const MeasurementsMap &amp; measurements() const</div><div class="ttdoc">Return measurements for all instruments. </div><div class="ttdef"><b>Definition:</b> <a href="_profiler_8cpp_source.xhtml#l00087">Profiler.cpp:87</a></div></div>
Jenkinsb3a371b2018-05-23 11:36:53 +0100101<div class="ttc" id="classarm__compute_1_1test_1_1framework_1_1_profiler_xhtml_a60de64d75454385b23995437f1d72669"><div class="ttname"><a href="classarm__compute_1_1test_1_1framework_1_1_profiler.xhtml#a60de64d75454385b23995437f1d72669">arm_compute::test::framework::Profiler::start</a></div><div class="ttdeci">void start()</div><div class="ttdoc">Call start() on all the added instruments. </div><div class="ttdef"><b>Definition:</b> <a href="_profiler_8cpp_source.xhtml#l00048">Profiler.cpp:48</a></div></div>
102<div class="ttc" id="classarm__compute_1_1test_1_1framework_1_1_profiler_xhtml_a8c528baf37154d347366083f0f816846"><div class="ttname"><a href="classarm__compute_1_1test_1_1framework_1_1_profiler.xhtml#a8c528baf37154d347366083f0f816846">arm_compute::test::framework::Profiler::stop</a></div><div class="ttdeci">void stop()</div><div class="ttdoc">Call stop() on all the added instruments. </div><div class="ttdef"><b>Definition:</b> <a href="_profiler_8cpp_source.xhtml#l00056">Profiler.cpp:56</a></div></div>
103<div class="ttc" id="classarm__compute_1_1test_1_1framework_1_1_profiler_xhtml_a4b454bbf54829d209850a8efa639b942"><div class="ttname"><a href="classarm__compute_1_1test_1_1framework_1_1_profiler.xhtml#a4b454bbf54829d209850a8efa639b942">arm_compute::test::framework::Profiler::test_start</a></div><div class="ttdeci">void test_start()</div><div class="ttdoc">Call test_start() on all the added instruments. </div><div class="ttdef"><b>Definition:</b> <a href="_profiler_8cpp_source.xhtml#l00040">Profiler.cpp:40</a></div></div>
Anthony Barbierdbdab852017-06-23 15:42:00 +0100104<div class="ttc" id="_instrument_8h_xhtml"><div class="ttname"><a href="_instrument_8h.xhtml">Instrument.h</a></div></div>
Anthony Barbierdbdab852017-06-23 15:42:00 +0100105</div><!-- fragment --></div><!-- contents -->
106</div><!-- doc-content -->
107<!-- start footer part -->
108<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
109 <ul>
Anthony Barbier8140e1e2017-12-14 23:48:46 +0000110 <li class="navelem"><a class="el" href="dir_59425e443f801f1f2fd8bbe4959a3ccf.xhtml">tests</a></li><li class="navelem"><a class="el" href="dir_9e71e2da941d3cafc4d98a9f6ae3de4f.xhtml">framework</a></li><li class="navelem"><a class="el" href="_profiler_8h.xhtml">Profiler.h</a></li>
Jenkinsb9abeae2018-11-22 11:58:08 +0000111 <li class="footer">Generated on Thu Nov 22 2018 11:57:42 for Compute Library by
Anthony Barbierdbdab852017-06-23 15:42:00 +0100112 <a href="http://www.doxygen.org/index.html">
Jenkinsb9abeae2018-11-22 11:58:08 +0000113 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
Anthony Barbierdbdab852017-06-23 15:42:00 +0100114 </ul>
115</div>
116</body>
117</html>