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_i_profiler.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_i_profiler.html')
-rw-r--r-- | Documentation/classarmnn_1_1_i_profiler.html | 296 |
1 files changed, 296 insertions, 0 deletions
diff --git a/Documentation/classarmnn_1_1_i_profiler.html b/Documentation/classarmnn_1_1_i_profiler.html new file mode 100644 index 0000000000..4c237a078b --- /dev/null +++ b/Documentation/classarmnn_1_1_i_profiler.html @@ -0,0 +1,296 @@ +<!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: 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> +<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_i_profiler.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-methods">Public Member Functions</a> | +<a href="#pro-methods">Protected Member Functions</a> | +<a href="classarmnn_1_1_i_profiler-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">IProfiler Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> +</div><!--header--> +<div class="contents"> + +<p><code>#include <<a class="el" href="_i_profiler_8hpp_source.html">IProfiler.hpp</a>></code></p> +<div class="dynheader"> +Inheritance diagram for IProfiler:</div> +<div class="dyncontent"> + <div class="center"> + <img src="classarmnn_1_1_i_profiler.png" usemap="#IProfiler_map" alt=""/> + <map id="IProfiler_map" name="IProfiler_map"> +<area href="classarmnn_1_1_profiler.html" alt="Profiler" shape="rect" coords="0,56,57,80"/> +</map> + </div></div> +<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:a769cdf670bd7cda3cda29dd40fbdebf4"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_profiler.html#a769cdf670bd7cda3cda29dd40fbdebf4">EnableProfiling</a> (bool enableProfiling)=0</td></tr> +<tr class="separator:a769cdf670bd7cda3cda29dd40fbdebf4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a1ebebad65df6718dc07aeab66550d0a7"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_profiler.html#a1ebebad65df6718dc07aeab66550d0a7">IsProfilingEnabled</a> ()=0</td></tr> +<tr class="separator:a1ebebad65df6718dc07aeab66550d0a7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aea4e445e340cb3a7fbb51465cf029724"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_profiler.html#aea4e445e340cb3a7fbb51465cf029724">AnalyzeEventsAndWriteResults</a> (std::ostream &outStream) const =0</td></tr> +<tr class="separator:aea4e445e340cb3a7fbb51465cf029724"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa369a934075a340fe59b7c9f481f9a57"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_profiler.html#aa369a934075a340fe59b7c9f481f9a57">Print</a> (std::ostream &outStream) const =0</td></tr> +<tr class="separator:aa369a934075a340fe59b7c9f481f9a57"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> +Protected Member Functions</h2></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.html#a3e96ca374a63bd8547fe68a5d9809df7">~IProfiler</a> ()</td></tr> +<tr class="separator:a3e96ca374a63bd8547fe68a5d9809df7"><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.html#l00013">13</a> of file <a class="el" href="_i_profiler_8hpp_source.html">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.html">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">inline</span><span class="mlabel">protected</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_i_profiler_8hpp_source.html#l00035">35</a> of file <a class="el" href="_i_profiler_8hpp_source.html">IProfiler.hpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> {}</div></div><!-- fragment --> +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a id="aea4e445e340cb3a7fbb51465cf029724"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aea4e445e340cb3a7fbb51465cf029724">◆ </a></span>AnalyzeEventsAndWriteResults()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual 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> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>Analyzes the tracked events and writes the results to the given output stream. Please refer to the configuration variables in <a class="el" href="_profiling_8cpp.html">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>Implemented in <a class="el" href="classarmnn_1_1_profiler.html#aeb61437c18e4bc111811428aec0e3ae9">Profiler</a>.</p> + +</div> +</div> +<a id="a769cdf670bd7cda3cda29dd40fbdebf4"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a769cdf670bd7cda3cda29dd40fbdebf4">◆ </a></span>EnableProfiling()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual void EnableProfiling </td> + <td>(</td> + <td class="paramtype">bool </td> + <td class="paramname"><em>enableProfiling</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </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>Implemented in <a class="el" href="classarmnn_1_1_profiler.html#a537b76b2a9f7fbcb538eabe994e424e0">Profiler</a>.</p> + +</div> +</div> +<a id="a1ebebad65df6718dc07aeab66550d0a7"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a1ebebad65df6718dc07aeab66550d0a7">◆ </a></span>IsProfilingEnabled()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual bool IsProfilingEnabled </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>Checks whether profiling is enabled. Profiling is disabled by default. </p><dl class="section return"><dt>Returns</dt><dd>true if profiling is enabled, false otherwise. </dd></dl> + +<p>Implemented in <a class="el" href="classarmnn_1_1_profiler.html#ad5ac843dd60a0ff7d4ab327f43fb88a5">Profiler</a>.</p> + +</div> +</div> +<a id="aa369a934075a340fe59b7c9f481f9a57"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aa369a934075a340fe59b7c9f481f9a57">◆ </a></span>Print()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual 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> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </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>Implemented in <a class="el" href="classarmnn_1_1_profiler.html#a352a82f3a338acf06a20d290f605c489">Profiler</a>.</p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>include/armnn/<a class="el" href="_i_profiler_8hpp_source.html">IProfiler.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_i_profiler.html">IProfiler</a></li> + <li class="footer">Generated on Fri Mar 13 2020 16:07:03 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> |