diff options
Diffstat (limited to '21.02/classarmnn_1_1_i_profiler.xhtml')
| -rw-r--r-- | 21.02/classarmnn_1_1_i_profiler.xhtml | 364 |
1 files changed, 364 insertions, 0 deletions
diff --git a/21.02/classarmnn_1_1_i_profiler.xhtml b/21.02/classarmnn_1_1_i_profiler.xhtml new file mode 100644 index 0000000000..6bf29698c5 --- /dev/null +++ b/21.02/classarmnn_1_1_i_profiler.xhtml @@ -0,0 +1,364 @@ +<!-- Copyright (c) 2020 ARM Limited. --> +<!-- --> +<!-- SPDX-License-Identifier: MIT --> +<!-- --> +<!-- HTML header for doxygen 1.8.13--> +<!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="robots" content="NOINDEX, NOFOLLOW" /> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>ArmNN: IProfiler Class Reference</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> +<script type="text/x-mathjax-config"> + MathJax.Hub.Config({ + extensions: ["tex2jax.js"], + jax: ["input/TeX","output/HTML-CSS"], +}); +</script><script type="text/javascript" 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> +<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;"> + <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 10rem; margin-top: .5rem; margin-left 10px"/> + <td style="padding-left: 0.5em;"> + <div id="projectname"> +  <span id="projectnumber">21.02</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('classarmnn_1_1_i_profiler.xhtml','');}); +</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="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="#friends">Friends</a> | +<a href="classarmnn_1_1_i_profiler-members.xhtml">List of all members</a> </div> + <div class="headertitle"> +<div class="title">IProfiler Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p><code>#include <<a class="el" href="_i_profiler_8hpp_source.xhtml">IProfiler.hpp</a>></code></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr class="memitem:af556ae358458c476f8594b3bbb28d712"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_profiler.xhtml#af556ae358458c476f8594b3bbb28d712">EnableProfiling</a> (bool enableProfiling)</td></tr> +<tr class="memdesc:af556ae358458c476f8594b3bbb28d712"><td class="mdescLeft"> </td><td class="mdescRight">Enables/disables profiling for this profiler. <a href="#af556ae358458c476f8594b3bbb28d712">More...</a><br /></td></tr> +<tr class="separator:af556ae358458c476f8594b3bbb28d712"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa5a25e3cf143724a9460c4aa9c47841b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_profiler.xhtml#aa5a25e3cf143724a9460c4aa9c47841b">IsProfilingEnabled</a> ()</td></tr> +<tr class="memdesc:aa5a25e3cf143724a9460c4aa9c47841b"><td class="mdescLeft"> </td><td class="mdescRight">Checks whether profiling is enabled. <a href="#aa5a25e3cf143724a9460c4aa9c47841b">More...</a><br /></td></tr> +<tr class="separator:aa5a25e3cf143724a9460c4aa9c47841b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac9f22844fb2e329ffd193f2d9a8ce336"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_profiler.xhtml#ac9f22844fb2e329ffd193f2d9a8ce336">AnalyzeEventsAndWriteResults</a> (std::ostream &outStream) const</td></tr> +<tr class="memdesc:ac9f22844fb2e329ffd193f2d9a8ce336"><td class="mdescLeft"> </td><td class="mdescRight">Analyzes the tracked events and writes the results to the given output stream. <a href="#ac9f22844fb2e329ffd193f2d9a8ce336">More...</a><br /></td></tr> +<tr class="separator:ac9f22844fb2e329ffd193f2d9a8ce336"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a038bb767bbc6abc0ee0d9b509616b896"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_profiler.xhtml#a038bb767bbc6abc0ee0d9b509616b896">Print</a> (std::ostream &outStream) const</td></tr> +<tr class="memdesc:a038bb767bbc6abc0ee0d9b509616b896"><td class="mdescLeft"> </td><td class="mdescRight">Print stats for events in JSON Format to the given output stream. <a href="#a038bb767bbc6abc0ee0d9b509616b896">More...</a><br /></td></tr> +<tr class="separator:a038bb767bbc6abc0ee0d9b509616b896"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3e96ca374a63bd8547fe68a5d9809df7"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_profiler.xhtml#a3e96ca374a63bd8547fe68a5d9809df7">~IProfiler</a> ()</td></tr> +<tr class="separator:a3e96ca374a63bd8547fe68a5d9809df7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac1f916bbd576830b5c35c9987581f301"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_profiler.xhtml#ac1f916bbd576830b5c35c9987581f301">IProfiler</a> ()</td></tr> +<tr class="separator:ac1f916bbd576830b5c35c9987581f301"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a> +Friends</h2></td></tr> +<tr class="memitem:a07324741b1a460634a1d58935d77de4c"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_profiler.xhtml#a07324741b1a460634a1d58935d77de4c">ScopedProfilingEvent</a></td></tr> +<tr class="separator:a07324741b1a460634a1d58935d77de4c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a64f137d035aca340f3b5624acd5bdc9a"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_profiler.xhtml#a64f137d035aca340f3b5624acd5bdc9a">GetProfilerEventSequenceSize</a> (<a class="el" href="classarmnn_1_1_i_profiler.xhtml">armnn::IProfiler</a> *profiler)</td></tr> +<tr class="separator:a64f137d035aca340f3b5624acd5bdc9a"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"> +<p class="definition">Definition at line <a class="el" href="_i_profiler_8hpp_source.xhtml#l00019">19</a> of file <a class="el" href="_i_profiler_8hpp_source.xhtml">IProfiler.hpp</a>.</p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="a3e96ca374a63bd8547fe68a5d9809df7"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a3e96ca374a63bd8547fe68a5d9809df7">◆ </a></span>~IProfiler()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">~<a class="el" href="classarmnn_1_1_i_profiler.xhtml">IProfiler</a> </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">default</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p class="reference">Referenced by <a class="el" href="_profiling_8cpp_source.xhtml#l00522">IProfiler::Print()</a>.</p> + +</div> +</div> +<a id="ac1f916bbd576830b5c35c9987581f301"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ac1f916bbd576830b5c35c9987581f301">◆ </a></span>IProfiler()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classarmnn_1_1_i_profiler.xhtml">IProfiler</a> </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_profiling_8cpp_source.xhtml#l00535">535</a> of file <a class="el" href="_profiling_8cpp_source.xhtml">Profiling.cpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00535"></a><span class="lineno"> 535</span> : pProfilerImpl(<span class="keyword">new</span> ProfilerImpl()) {};</div></div><!-- fragment --> +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a id="ac9f22844fb2e329ffd193f2d9a8ce336"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ac9f22844fb2e329ffd193f2d9a8ce336">◆ </a></span>AnalyzeEventsAndWriteResults()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void AnalyzeEventsAndWriteResults </td> + <td>(</td> + <td class="paramtype">std::ostream & </td> + <td class="paramname"><em>outStream</em></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Analyzes the tracked events and writes the results to the given output stream. </p> +<p>Please refer to the configuration variables in <a class="el" href="_profiling_8cpp.xhtml">Profiling.cpp</a> to customize the information written. </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[out]</td><td class="paramname">outStream</td><td>The stream where to write the profiling results to. </td></tr> + </table> + </dd> +</dl> + +<p class="definition">Definition at line <a class="el" href="_profiling_8cpp_source.xhtml#l00517">517</a> of file <a class="el" href="_profiling_8cpp_source.xhtml">Profiling.cpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00518"></a><span class="lineno"> 518</span> {</div><div class="line"><a name="l00519"></a><span class="lineno"> 519</span>  pProfilerImpl->AnalyzeEventsAndWriteResults(outStream);</div><div class="line"><a name="l00520"></a><span class="lineno"> 520</span> }</div></div><!-- fragment --> +</div> +</div> +<a id="af556ae358458c476f8594b3bbb28d712"></a> +<h2 class="memtitle"><span class="permalink"><a href="#af556ae358458c476f8594b3bbb28d712">◆ </a></span>EnableProfiling()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EnableProfiling </td> + <td>(</td> + <td class="paramtype">bool </td> + <td class="paramname"><em>enableProfiling</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Enables/disables profiling for this profiler. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">enableProfiling</td><td>A flag that indicates whether profiling should be enabled or not. </td></tr> + </table> + </dd> +</dl> + +<p class="definition">Definition at line <a class="el" href="_profiling_8cpp_source.xhtml#l00507">507</a> of file <a class="el" href="_profiling_8cpp_source.xhtml">Profiling.cpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00508"></a><span class="lineno"> 508</span> {</div><div class="line"><a name="l00509"></a><span class="lineno"> 509</span>  pProfilerImpl->EnableProfiling(enableProfiling);</div><div class="line"><a name="l00510"></a><span class="lineno"> 510</span> }</div></div><!-- fragment --> +</div> +</div> +<a id="aa5a25e3cf143724a9460c4aa9c47841b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aa5a25e3cf143724a9460c4aa9c47841b">◆ </a></span>IsProfilingEnabled()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool IsProfilingEnabled </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Checks whether profiling is enabled. </p> +<p>Profiling is disabled by default. </p><dl class="section return"><dt>Returns</dt><dd>true if profiling is enabled, false otherwise. </dd></dl> + +<p class="definition">Definition at line <a class="el" href="_profiling_8cpp_source.xhtml#l00512">512</a> of file <a class="el" href="_profiling_8cpp_source.xhtml">Profiling.cpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00513"></a><span class="lineno"> 513</span> {</div><div class="line"><a name="l00514"></a><span class="lineno"> 514</span>  <span class="keywordflow">return</span> pProfilerImpl->IsProfilingEnabled();</div><div class="line"><a name="l00515"></a><span class="lineno"> 515</span> }</div></div><!-- fragment --> +</div> +</div> +<a id="a038bb767bbc6abc0ee0d9b509616b896"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a038bb767bbc6abc0ee0d9b509616b896">◆ </a></span>Print()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void Print </td> + <td>(</td> + <td class="paramtype">std::ostream & </td> + <td class="paramname"><em>outStream</em></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Print stats for events in JSON Format to the given output stream. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[out]</td><td class="paramname">outStream</td><td>The stream where to write the profiling results to. </td></tr> + </table> + </dd> +</dl> + +<p class="definition">Definition at line <a class="el" href="_profiling_8cpp_source.xhtml#l00522">522</a> of file <a class="el" href="_profiling_8cpp_source.xhtml">Profiling.cpp</a>.</p> + +<p class="reference">References <a class="el" href="classarmnn_1_1_i_profiler.xhtml#a3e96ca374a63bd8547fe68a5d9809df7">IProfiler::~IProfiler()</a>.</p> + +<p class="reference">Referenced by <a class="el" href="_cl_fallback_tests_8cpp_source.xhtml#l00014">BOOST_AUTO_TEST_CASE()</a>.</p> +<div class="fragment"><div class="line"><a name="l00523"></a><span class="lineno"> 523</span> {</div><div class="line"><a name="l00524"></a><span class="lineno"> 524</span>  pProfilerImpl->Print(outStream);</div><div class="line"><a name="l00525"></a><span class="lineno"> 525</span> }</div></div><!-- fragment --> +</div> +</div> +<h2 class="groupheader">Friends And Related Function Documentation</h2> +<a id="a64f137d035aca340f3b5624acd5bdc9a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a64f137d035aca340f3b5624acd5bdc9a">◆ </a></span>GetProfilerEventSequenceSize</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">size_t GetProfilerEventSequenceSize </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classarmnn_1_1_i_profiler.xhtml">armnn::IProfiler</a> * </td> + <td class="paramname"><em>profiler</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">friend</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_profiler_tests_8cpp_source.xhtml#l00022">22</a> of file <a class="el" href="_profiler_tests_8cpp_source.xhtml">ProfilerTests.cpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> {</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <span class="keywordflow">if</span> (!profiler)</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  {</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="keywordflow">return</span> <span class="keyword">static_cast<</span><span class="keywordtype">size_t</span><span class="keyword">></span>(-1);</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  }</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="keywordflow">return</span> profiler->pProfilerImpl->m_EventSequence.size();</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> }</div></div><!-- fragment --> +</div> +</div> +<a id="a07324741b1a460634a1d58935d77de4c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a07324741b1a460634a1d58935d77de4c">◆ </a></span>ScopedProfilingEvent</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">friend class <a class="el" href="classarmnn_1_1_scoped_profiling_event.xhtml">ScopedProfilingEvent</a></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">friend</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_i_profiler_8hpp_source.xhtml#l00049">49</a> of file <a class="el" href="_i_profiler_8hpp_source.xhtml">IProfiler.hpp</a>.</p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li>include/armnn/<a class="el" href="_i_profiler_8hpp_source.xhtml">IProfiler.hpp</a></li> +<li>src/armnn/<a class="el" href="_profiling_8cpp_source.xhtml">Profiling.cpp</a></li> +</ul> +</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="namespacearmnn.xhtml">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_i_profiler.xhtml">IProfiler</a></li> + <li class="footer">Generated on Thu Feb 25 2021 17:27: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> + </ul> +</div> +</body> +</html> |