Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ComputeLibrary / dbdab85d6e0f96d3361a9e30310367d89953466c / . / documentation / _profiler_8h_source.xhtml
blob: 3acf3554cce43208352fd067e1d49ce0b92c1bec [file] [log] [blame]
Anthony Barbierdbdab852017-06-23 15:42:00 +0100[diff] [blame^]1<!-- 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"/>
7<meta name="generator" content="Doxygen 1.8.11"/>
8<meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
9<title>Compute Library: tests/benchmark/Profiler.h Source File</title>
10<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>
15<script type="text/javascript" src="navtreedata.js"></script>
16<script type="text/javascript" src="navtree.js"></script>
17<script type="text/javascript">
18 $(document).ready(initResizable);
19 $(window).load(resizeHeight);
20</script>
21<link href="search/search.css" rel="stylesheet" type="text/css"/>
22<script type="text/javascript" src="search/searchdata.js"></script>
23<script type="text/javascript" src="search/search.js"></script>
24<script type="text/javascript">
25 $(document).ready(function() { init_search(); });
26</script>
27<script type="text/x-mathjax-config">
28 MathJax.Hub.Config({
29 extensions: ["tex2jax.js"],
30 jax: ["input/TeX","output/HTML-CSS"],
31});
32</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
33<link href="doxygen.css" rel="stylesheet" type="text/css" />
34</head>
35<body>
36<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
37<div id="titlearea">
38<table cellspacing="0" cellpadding="0">
39 <tbody>
40 <tr style="height: 56px;">
41 <td style="padding-left: 0.5em;">
42 <div id="projectname">Compute Library
43 &#160;<span id="projectnumber">v17.06</span>
44 </div>
45 </td>
46 </tr>
47 </tbody>
48</table>
49</div>
50<!-- end header part -->
51<!-- Generated by Doxygen 1.8.11 -->
52<script type="text/javascript">
53var searchBox = new SearchBox("searchBox", "search",false,'Search');
54</script>
55 <div id="navrow1" class="tabs">
56 <ul class="tablist">
57 <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
58 <li><a href="pages.xhtml"><span>Related&#160;Pages</span></a></li>
59 <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
60 <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
61 <li class="current"><a href="files.xhtml"><span>Files</span></a></li>
62 <li>
63 <div id="MSearchBox" class="MSearchBoxInactive">
64 <span class="left">
65 <img id="MSearchSelect" src="search/mag_sel.png"
66 onmouseover="return searchBox.OnSearchSelectShow()"
67 onmouseout="return searchBox.OnSearchSelectHide()"
68 alt=""/>
69 <input type="text" id="MSearchField" value="Search" accesskey="S"
70 onfocus="searchBox.OnSearchFieldFocus(true)"
71 onblur="searchBox.OnSearchFieldFocus(false)"
72 onkeyup="searchBox.OnSearchFieldChange(event)"/>
73 </span><span class="right">
74 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
75 </span>
76 </div>
77 </li>
78 </ul>
79 </div>
80 <div id="navrow2" class="tabs2">
81 <ul class="tablist">
82 <li><a href="files.xhtml"><span>File&#160;List</span></a></li>
83 <li><a href="globals.xhtml"><span>Globals</span></a></li>
84 </ul>
85 </div>
86</div><!-- top -->
87<div id="side-nav" class="ui-resizable side-nav-resizable">
88 <div id="nav-tree">
89 <div id="nav-tree-contents">
90 <div id="nav-sync" class="sync"></div>
91 </div>
92 </div>
93 <div id="splitbar" style="-moz-user-select:none;"
94 class="ui-resizable-handle">
95 </div>
96</div>
97<script type="text/javascript">
98$(document).ready(function(){initNavTree('_profiler_8h_source.xhtml','');});
99</script>
100<div id="doc-content">
101<!-- window showing the filter options -->
102<div id="MSearchSelectWindow"
103 onmouseover="return searchBox.OnSearchSelectShow()"
104 onmouseout="return searchBox.OnSearchSelectHide()"
105 onkeydown="return searchBox.OnSearchSelectKey(event)">
106</div>
107
108<!-- iframe showing the search results (closed by default) -->
109<div id="MSearchResultsWindow">
110<iframe src="javascript:void(0)" frameborder="0"
111 name="MSearchResults" id="MSearchResults">
112</iframe>
113</div>
114
115<div class="header">
116 <div class="headertitle">
117<div class="title">Profiler.h</div> </div>
118</div><!--header-->
119<div class="contents">
120<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 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_BENCHMARK_PROFILER_H__</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#define __ARM_COMPUTE_TEST_BENCHMARK_PROFILER_H__</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">Instrument.h</a>&quot;</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#include &quot;benchmark/benchmark_api.h&quot;</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="preprocessor">#include &lt;map&gt;</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="preprocessor">#include &lt;memory&gt;</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacearm__compute.xhtml">arm_compute</a></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;{</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="keyword">namespace </span>test</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;{</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="keyword">namespace </span>benchmark</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="classarm__compute_1_1test_1_1benchmark_1_1_profiler.xhtml"> 42</a></span>&#160;<span class="keyword">class </span><a class="code" href="classarm__compute_1_1test_1_1benchmark_1_1_profiler.xhtml">Profiler</a></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;{</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="classarm__compute_1_1test_1_1benchmark_1_1_profiler.xhtml#ab9ddc98666376697dd8845d4eef4f77d"> 46</a></span>&#160; <span class="keyword">using</span> <a class="code" href="classarm__compute_1_1test_1_1benchmark_1_1_profiler.xhtml#ab9ddc98666376697dd8845d4eef4f77d">MeasurementsMap</a> = std::map&lt;std::string, std::vector&lt;double&gt;&gt;;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classarm__compute_1_1test_1_1benchmark_1_1_profiler.xhtml#afb11c32e4053f95d69d90aa4c9ee4cf9">add</a>(<span class="keyword">const</span> std::shared_ptr&lt;Instrument&gt; &amp;instrument);</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</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_1benchmark_1_1_profiler.xhtml#a60de64d75454385b23995437f1d72669">start</a>();</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classarm__compute_1_1test_1_1benchmark_1_1_profiler.xhtml#a8c528baf37154d347366083f0f816846">stop</a>();</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</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_1benchmark_1_1_profiler.xhtml#a2740d2aac8e38e66b5cdfe8a15efbb92">submit</a>(::benchmark::State &amp;<a class="code" href="benchmark_2_c_l_2_activation_layer_8cpp.xhtml#a7ff4fc3bbf305206c6f2b97d4e6681a0">state</a>);</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keyword">const</span> <a class="code" href="classarm__compute_1_1test_1_1benchmark_1_1_profiler.xhtml#ab9ddc98666376697dd8845d4eef4f77d">MeasurementsMap</a> &amp;<a class="code" href="classarm__compute_1_1test_1_1benchmark_1_1_profiler.xhtml#a89d7c3c7bab828a9e87e23b269935ee4">measurements</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; std::vector&lt;std::shared_ptr&lt;Instrument&gt;&gt; _instruments{};</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <a class="code" href="classarm__compute_1_1test_1_1benchmark_1_1_profiler.xhtml#ab9ddc98666376697dd8845d4eef4f77d">MeasurementsMap</a> _measurements{};</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;};</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;} <span class="comment">// namespace benchmark</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;} <span class="comment">// namespace test</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;} <span class="comment">// namespace arm_compute</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="classarm__compute_1_1test_1_1benchmark_1_1_profiler_xhtml_ab9ddc98666376697dd8845d4eef4f77d"><div class="ttname"><a href="classarm__compute_1_1test_1_1benchmark_1_1_profiler.xhtml#ab9ddc98666376697dd8845d4eef4f77d">arm_compute::test::benchmark::Profiler::MeasurementsMap</a></div><div class="ttdeci">std::map&lt; std::string, std::vector&lt; double &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#l00046">Profiler.h:46</a></div></div>
121<div class="ttc" id="classarm__compute_1_1test_1_1benchmark_1_1_profiler_xhtml_a8c528baf37154d347366083f0f816846"><div class="ttname"><a href="classarm__compute_1_1test_1_1benchmark_1_1_profiler.xhtml#a8c528baf37154d347366083f0f816846">arm_compute::test::benchmark::Profiler::stop</a></div><div class="ttdeci">void stop()</div><div class="ttdoc">Stop all added instruments. </div><div class="ttdef"><b>Definition:</b> <a href="_profiler_8cpp_source.xhtml#l00048">Profiler.cpp:48</a></div></div>
122<div class="ttc" id="namespacearm__compute_xhtml"><div class="ttname"><a href="namespacearm__compute.xhtml">arm_compute</a></div><div class="ttdef"><b>Definition:</b> <a href="01__library_8dox_source.xhtml#l00001">01_library.dox:1</a></div></div>
123<div class="ttc" id="benchmark_2_c_l_2_activation_layer_8cpp_xhtml_a7ff4fc3bbf305206c6f2b97d4e6681a0"><div class="ttname"><a href="benchmark_2_c_l_2_activation_layer_8cpp.xhtml#a7ff4fc3bbf305206c6f2b97d4e6681a0">state</a></div><div class="ttdeci">::benchmark::State &amp; state</div><div class="ttdef"><b>Definition:</b> <a href="benchmark_2_c_l_2_activation_layer_8cpp_source.xhtml#l00057">ActivationLayer.cpp:57</a></div></div>
124<div class="ttc" id="classarm__compute_1_1test_1_1benchmark_1_1_profiler_xhtml"><div class="ttname"><a href="classarm__compute_1_1test_1_1benchmark_1_1_profiler.xhtml">arm_compute::test::benchmark::Profiler</a></div><div class="ttdef"><b>Definition:</b> <a href="_profiler_8h_source.xhtml#l00042">Profiler.h:42</a></div></div>
125<div class="ttc" id="classarm__compute_1_1test_1_1benchmark_1_1_profiler_xhtml_afb11c32e4053f95d69d90aa4c9ee4cf9"><div class="ttname"><a href="classarm__compute_1_1test_1_1benchmark_1_1_profiler.xhtml#afb11c32e4053f95d69d90aa4c9ee4cf9">arm_compute::test::benchmark::Profiler::add</a></div><div class="ttdeci">void add(const std::shared_ptr&lt; Instrument &gt; &amp;instrument)</div><div class="ttdoc">Add instrument to the performance montior. </div><div class="ttdef"><b>Definition:</b> <a href="_profiler_8cpp_source.xhtml#l00035">Profiler.cpp:35</a></div></div>
126<div class="ttc" id="classarm__compute_1_1test_1_1benchmark_1_1_profiler_xhtml_a2740d2aac8e38e66b5cdfe8a15efbb92"><div class="ttname"><a href="classarm__compute_1_1test_1_1benchmark_1_1_profiler.xhtml#a2740d2aac8e38e66b5cdfe8a15efbb92">arm_compute::test::benchmark::Profiler::submit</a></div><div class="ttdeci">void submit(::benchmark::State &amp;state)</div><div class="ttdoc">Commit all measured values to the current active test. </div><div class="ttdef"><b>Definition:</b> <a href="_profiler_8cpp_source.xhtml#l00061">Profiler.cpp:61</a></div></div>
127<div class="ttc" id="classarm__compute_1_1test_1_1benchmark_1_1_profiler_xhtml_a89d7c3c7bab828a9e87e23b269935ee4"><div class="ttname"><a href="classarm__compute_1_1test_1_1benchmark_1_1_profiler.xhtml#a89d7c3c7bab828a9e87e23b269935ee4">arm_compute::test::benchmark::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#l00081">Profiler.cpp:81</a></div></div>
128<div class="ttc" id="_instrument_8h_xhtml"><div class="ttname"><a href="_instrument_8h.xhtml">Instrument.h</a></div></div>
129<div class="ttc" id="classarm__compute_1_1test_1_1benchmark_1_1_profiler_xhtml_a60de64d75454385b23995437f1d72669"><div class="ttname"><a href="classarm__compute_1_1test_1_1benchmark_1_1_profiler.xhtml#a60de64d75454385b23995437f1d72669">arm_compute::test::benchmark::Profiler::start</a></div><div class="ttdeci">void start()</div><div class="ttdoc">Start all added instruments to measure performance. </div><div class="ttdef"><b>Definition:</b> <a href="_profiler_8cpp_source.xhtml#l00040">Profiler.cpp:40</a></div></div>
130</div><!-- fragment --></div><!-- contents -->
131</div><!-- doc-content -->
132<!-- start footer part -->
133<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
134 <ul>
135 <li class="navelem"><a class="el" href="dir_59425e443f801f1f2fd8bbe4959a3ccf.xhtml">tests</a></li><li class="navelem"><a class="el" href="dir_4f2df8950dc650bf7cf9176fae02facc.xhtml">benchmark</a></li><li class="navelem"><a class="el" href="_profiler_8h.xhtml">Profiler.h</a></li>
136 <li class="footer">Generated on Fri Jun 23 2017 15:44:33 for Compute Library by
137 <a href="http://www.doxygen.org/index.html">
138 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
139 </ul>
140</div>
141</body>
142</html>