diff options
| author | Ryan OShea <Ryan.OShea2@arm.com> | 2020-03-13 16:26:19 +0000 |
|---|---|---|
| committer | Ryan OShea <Ryan.OShea2@arm.com> | 2020-03-13 16:26:19 +0000 |
| commit | de36e4a9c299028e792c3a5bd99ad0816d806077 (patch) | |
| tree | 6c71d89db68da1033bb422253cee2970580ed692 /Documentation/classarmnn_1_1_scoped_profiling_event.html | |
| parent | 78b26f024641e763c7252198339c83bad8c0982f (diff) | |
| download | armnn-de36e4a9c299028e792c3a5bd99ad0816d806077.tar.gz | |
IVGCVSW-3726 Upload ArmNN Doxygen files
* Upload current ArmNN Doxygen files
Signed-off-by: Ryan OShea <Ryan.OShea2@arm.com>
Change-Id: I8989ed16ee40a99a4495b100bd009cf3e24a7285
Diffstat (limited to 'Documentation/classarmnn_1_1_scoped_profiling_event.html')
| -rw-r--r-- | Documentation/classarmnn_1_1_scoped_profiling_event.html | 218 |
1 files changed, 218 insertions, 0 deletions
diff --git a/Documentation/classarmnn_1_1_scoped_profiling_event.html b/Documentation/classarmnn_1_1_scoped_profiling_event.html new file mode 100644 index 0000000000..f00096cf65 --- /dev/null +++ b/Documentation/classarmnn_1_1_scoped_profiling_event.html @@ -0,0 +1,218 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.13"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>ArmNN: ScopedProfilingEvent 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> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">ArmNN +  <span id="projectnumber">NotReleased</span> + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.13 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +</script> +<div id="main-nav"></div> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +$(document).ready(function(){initNavTree('classarmnn_1_1_scoped_profiling_event.html','');}); +</script> +<div id="doc-content"> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div class="header"> + <div class="summary"> +<a href="#pub-types">Public Types</a> | +<a href="#pub-methods">Public Member Functions</a> | +<a href="classarmnn_1_1_scoped_profiling_event-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">ScopedProfilingEvent Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p><code>#include <<a class="el" href="_profiling_8hpp_source.html">Profiling.hpp</a>></code></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> +Public Types</h2></td></tr> +<tr class="memitem:a70926d23f3aef7e657a9057a7badb014"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_scoped_profiling_event.html#a70926d23f3aef7e657a9057a7badb014">InstrumentPtr</a> = std::unique_ptr< <a class="el" href="classarmnn_1_1_instrument.html">Instrument</a> ></td></tr> +<tr class="separator:a70926d23f3aef7e657a9057a7badb014"><td class="memSeparator" colspan="2"> </td></tr> +</table><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:ac7608b3f327d278d885252b6b808ed82"><td class="memTemplParams" colspan="2">template<typename... Args> </td></tr> +<tr class="memitem:ac7608b3f327d278d885252b6b808ed82"><td class="memTemplItemLeft" align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_scoped_profiling_event.html#ac7608b3f327d278d885252b6b808ed82">ScopedProfilingEvent</a> (const <a class="el" href="classarmnn_1_1_backend_id.html">BackendId</a> &backendId, const std::string &name, Args... args)</td></tr> +<tr class="separator:ac7608b3f327d278d885252b6b808ed82"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa4f6b27d8649f796fba223997c3a9087"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_scoped_profiling_event.html#aa4f6b27d8649f796fba223997c3a9087">~ScopedProfilingEvent</a> ()</td></tr> +<tr class="separator:aa4f6b27d8649f796fba223997c3a9087"><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="_profiling_8hpp_source.html#l00113">113</a> of file <a class="el" href="_profiling_8hpp_source.html">Profiling.hpp</a>.</p> +</div><h2 class="groupheader">Member Typedef Documentation</h2> +<a id="a70926d23f3aef7e657a9057a7badb014"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a70926d23f3aef7e657a9057a7badb014">◆ </a></span>InstrumentPtr</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">using <a class="el" href="classarmnn_1_1_scoped_profiling_event.html#a70926d23f3aef7e657a9057a7badb014">InstrumentPtr</a> = std::unique_ptr<<a class="el" href="classarmnn_1_1_instrument.html">Instrument</a>></td> + </tr> + </table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_profiling_8hpp_source.html#l00116">116</a> of file <a class="el" href="_profiling_8hpp_source.html">Profiling.hpp</a>.</p> + +</div> +</div> +<h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="ac7608b3f327d278d885252b6b808ed82"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ac7608b3f327d278d885252b6b808ed82">◆ </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"><a class="el" href="classarmnn_1_1_scoped_profiling_event.html">ScopedProfilingEvent</a> </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classarmnn_1_1_backend_id.html">BackendId</a> & </td> + <td class="paramname"><em>backendId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">Args... </td> + <td class="paramname"><em>args</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_profiling_8hpp_source.html#l00119">119</a> of file <a class="el" href="_profiling_8hpp_source.html">Profiling.hpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  : m_Event(<span class="keyword">nullptr</span>)</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  , m_Profiler(<a class="code" href="classarmnn_1_1_profiler_manager.html#a93857080c2523bf3395e7aa7e6024d5c">ProfilerManager::GetInstance</a>().GetProfiler())</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  {</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="keywordflow">if</span> (m_Profiler && m_Profiler-><a class="code" href="classarmnn_1_1_profiler.html#ad5ac843dd60a0ff7d4ab327f43fb88a5">IsProfilingEnabled</a>())</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  {</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  std::vector<InstrumentPtr> instruments(0);</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  instruments.reserve(<span class="keyword">sizeof</span>...(args)); <span class="comment">//One allocation</span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  ConstructNextInVector(instruments, args...);</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  m_Event = m_Profiler-><a class="code" href="classarmnn_1_1_profiler.html#abaf660a136b904fbcbd0c374fea38cd0">BeginEvent</a>(backendId, name, std::move(instruments));</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  }</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  }</div><div class="ttc" id="classarmnn_1_1_profiler_html_abaf660a136b904fbcbd0c374fea38cd0"><div class="ttname"><a href="classarmnn_1_1_profiler.html#abaf660a136b904fbcbd0c374fea38cd0">armnn::Profiler::BeginEvent</a></div><div class="ttdeci">Event * BeginEvent(const BackendId &backendId, const std::string &name, std::vector< InstrumentPtr > &&instruments)</div><div class="ttdef"><b>Definition:</b> <a href="_profiling_8cpp_source.html#l00200">Profiling.cpp:200</a></div></div> +<div class="ttc" id="classarmnn_1_1_profiler_manager_html_a93857080c2523bf3395e7aa7e6024d5c"><div class="ttname"><a href="classarmnn_1_1_profiler_manager.html#a93857080c2523bf3395e7aa7e6024d5c">armnn::ProfilerManager::GetInstance</a></div><div class="ttdeci">static ProfilerManager & GetInstance()</div><div class="ttdef"><b>Definition:</b> <a href="_profiling_8cpp_source.html#l00486">Profiling.cpp:486</a></div></div> +<div class="ttc" id="classarmnn_1_1_profiler_html_ad5ac843dd60a0ff7d4ab327f43fb88a5"><div class="ttname"><a href="classarmnn_1_1_profiler.html#ad5ac843dd60a0ff7d4ab327f43fb88a5">armnn::Profiler::IsProfilingEnabled</a></div><div class="ttdeci">bool IsProfilingEnabled() override</div><div class="ttdef"><b>Definition:</b> <a href="_profiling_8cpp_source.html#l00190">Profiling.cpp:190</a></div></div> +</div><!-- fragment --> +</div> +</div> +<a id="aa4f6b27d8649f796fba223997c3a9087"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aa4f6b27d8649f796fba223997c3a9087">◆ </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">~<a class="el" href="classarmnn_1_1_scoped_profiling_event.html">ScopedProfilingEvent</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">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_profiling_8hpp_source.html#l00132">132</a> of file <a class="el" href="_profiling_8hpp_source.html">Profiling.hpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  {</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <span class="keywordflow">if</span> (m_Profiler && m_Event)</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  {</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  m_Profiler-><a class="code" href="classarmnn_1_1_profiler.html#a8ed16398e69bb7b0625e3cf4a279b1f3">EndEvent</a>(m_Event);</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  }</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  }</div><div class="ttc" id="classarmnn_1_1_profiler_html_a8ed16398e69bb7b0625e3cf4a279b1f3"><div class="ttname"><a href="classarmnn_1_1_profiler.html#a8ed16398e69bb7b0625e3cf4a279b1f3">armnn::Profiler::EndEvent</a></div><div class="ttdeci">void EndEvent(Event *event)</div><div class="ttdef"><b>Definition:</b> <a href="_profiling_8cpp_source.html#l00217">Profiling.cpp:217</a></div></div> +</div><!-- fragment --> +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>src/armnn/<a class="el" href="_profiling_8hpp_source.html">Profiling.hpp</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.html">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_scoped_profiling_event.html">ScopedProfilingEvent</a></li> + <li class="footer">Generated on Fri Mar 13 2020 16:07:05 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> |