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_1profiling_1_1_i_backend_profiling.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_1profiling_1_1_i_backend_profiling.html')
-rw-r--r-- | Documentation/classarmnn_1_1profiling_1_1_i_backend_profiling.html | 360 |
1 files changed, 360 insertions, 0 deletions
diff --git a/Documentation/classarmnn_1_1profiling_1_1_i_backend_profiling.html b/Documentation/classarmnn_1_1profiling_1_1_i_backend_profiling.html new file mode 100644 index 0000000000..22a2b96ef1 --- /dev/null +++ b/Documentation/classarmnn_1_1profiling_1_1_i_backend_profiling.html @@ -0,0 +1,360 @@ +<!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: IBackendProfiling 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_1profiling_1_1_i_backend_profiling.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="classarmnn_1_1profiling_1_1_i_backend_profiling-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">IBackendProfiling 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_backend_profiling_8hpp_source.html">IBackendProfiling.hpp</a>></code></p> +<div class="dynheader"> +Inheritance diagram for IBackendProfiling:</div> +<div class="dyncontent"> + <div class="center"> + <img src="classarmnn_1_1profiling_1_1_i_backend_profiling.png" usemap="#IBackendProfiling_map" alt=""/> + <map id="IBackendProfiling_map" name="IBackendProfiling_map"> +<area href="classarmnn_1_1profiling_1_1_backend_profiling.html" alt="BackendProfiling" shape="rect" coords="0,56,111,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:a1179976118abc3d6765a5b2fea4be35c"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_backend_profiling.html#a1179976118abc3d6765a5b2fea4be35c">~IBackendProfiling</a> ()</td></tr> +<tr class="separator:a1179976118abc3d6765a5b2fea4be35c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3af5b700b06e401119749bd3a80bacf0"><td class="memItemLeft" align="right" valign="top">virtual std::unique_ptr< <a class="el" href="classarmnn_1_1profiling_1_1_i_register_backend_counters.html">IRegisterBackendCounters</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_backend_profiling.html#a3af5b700b06e401119749bd3a80bacf0">GetCounterRegistrationInterface</a> (uint16_t currentMaxGlobalCounterID)=0</td></tr> +<tr class="separator:a3af5b700b06e401119749bd3a80bacf0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af3bab90857bb0cd2363f654cdd257e34"><td class="memItemLeft" align="right" valign="top">virtual std::unique_ptr< <a class="el" href="classarmnn_1_1profiling_1_1_i_send_timeline_packet.html">ISendTimelinePacket</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_backend_profiling.html#af3bab90857bb0cd2363f654cdd257e34">GetSendTimelinePacket</a> ()=0</td></tr> +<tr class="separator:af3bab90857bb0cd2363f654cdd257e34"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9b9e803df01765cbfe9c9148fe757db5"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_guid_generator.html">IProfilingGuidGenerator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_backend_profiling.html#a9b9e803df01765cbfe9c9148fe757db5">GetProfilingGuidGenerator</a> ()=0</td></tr> +<tr class="separator:a9b9e803df01765cbfe9c9148fe757db5"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a691685749cd1a917b8e6e9cb1afcc045"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_backend_profiling.html#a691685749cd1a917b8e6e9cb1afcc045">ReportCounters</a> (const std::vector< <a class="el" href="structarmnn_1_1profiling_1_1_timestamp.html">Timestamp</a> > &counterValues)=0</td></tr> +<tr class="separator:a691685749cd1a917b8e6e9cb1afcc045"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab159fe93b4a4357f55b55920e03b9af6"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structarmnn_1_1profiling_1_1_counter_status.html">CounterStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_backend_profiling.html#ab159fe93b4a4357f55b55920e03b9af6">GetCounterStatus</a> (uint16_t backendCounterId)=0</td></tr> +<tr class="separator:ab159fe93b4a4357f55b55920e03b9af6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a33b3b8d541860022fe9edecfee7284d6"><td class="memItemLeft" align="right" valign="top">virtual std::vector< <a class="el" href="structarmnn_1_1profiling_1_1_counter_status.html">CounterStatus</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_backend_profiling.html#a33b3b8d541860022fe9edecfee7284d6">GetActiveCounters</a> ()=0</td></tr> +<tr class="separator:a33b3b8d541860022fe9edecfee7284d6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a93ee1c2509b9db845936a291b575dd17"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1profiling_1_1_i_backend_profiling.html#a93ee1c2509b9db845936a291b575dd17">IsProfilingEnabled</a> () const =0</td></tr> +<tr class="separator:a93ee1c2509b9db845936a291b575dd17"><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_backend_profiling_8hpp_source.html#l00079">79</a> of file <a class="el" href="_i_backend_profiling_8hpp_source.html">IBackendProfiling.hpp</a>.</p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="a1179976118abc3d6765a5b2fea4be35c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a1179976118abc3d6765a5b2fea4be35c">◆ </a></span>~IBackendProfiling()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual ~<a class="el" href="classarmnn_1_1profiling_1_1_i_backend_profiling.html">IBackendProfiling</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">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_i_backend_profiling_8hpp_source.html#l00082">82</a> of file <a class="el" href="_i_backend_profiling_8hpp_source.html">IBackendProfiling.hpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  {}</div></div><!-- fragment --> +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a id="a33b3b8d541860022fe9edecfee7284d6"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a33b3b8d541860022fe9edecfee7284d6">◆ </a></span>GetActiveCounters()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual std::vector<<a class="el" href="structarmnn_1_1profiling_1_1_counter_status.html">CounterStatus</a>> GetActiveCounters </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>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_backend_profiling.html#a54b66ce39aa9a413d8d68f6e2569af45">BackendProfiling</a>.</p> + +</div> +</div> +<a id="a3af5b700b06e401119749bd3a80bacf0"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a3af5b700b06e401119749bd3a80bacf0">◆ </a></span>GetCounterRegistrationInterface()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual std::unique_ptr<<a class="el" href="classarmnn_1_1profiling_1_1_i_register_backend_counters.html">IRegisterBackendCounters</a>> GetCounterRegistrationInterface </td> + <td>(</td> + <td class="paramtype">uint16_t </td> + <td class="paramname"><em>currentMaxGlobalCounterID</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>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_backend_profiling.html#a0ac323cf9d8c03c718065cd775bc2a48">BackendProfiling</a>.</p> + +</div> +</div> +<a id="ab159fe93b4a4357f55b55920e03b9af6"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ab159fe93b4a4357f55b55920e03b9af6">◆ </a></span>GetCounterStatus()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="structarmnn_1_1profiling_1_1_counter_status.html">CounterStatus</a> GetCounterStatus </td> + <td>(</td> + <td class="paramtype">uint16_t </td> + <td class="paramname"><em>backendCounterId</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>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_backend_profiling.html#a23d09d59f5da5d396a89c9543204dce3">BackendProfiling</a>.</p> + +</div> +</div> +<a id="a9b9e803df01765cbfe9c9148fe757db5"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a9b9e803df01765cbfe9c9148fe757db5">◆ </a></span>GetProfilingGuidGenerator()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="classarmnn_1_1profiling_1_1_i_profiling_guid_generator.html">IProfilingGuidGenerator</a>& GetProfilingGuidGenerator </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>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_backend_profiling.html#a281672bed6fd49540270725a3eea867b">BackendProfiling</a>.</p> + +</div> +</div> +<a id="af3bab90857bb0cd2363f654cdd257e34"></a> +<h2 class="memtitle"><span class="permalink"><a href="#af3bab90857bb0cd2363f654cdd257e34">◆ </a></span>GetSendTimelinePacket()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual std::unique_ptr<<a class="el" href="classarmnn_1_1profiling_1_1_i_send_timeline_packet.html">ISendTimelinePacket</a>> GetSendTimelinePacket </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>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_backend_profiling.html#a24eb027ca494ee70c27e6322494325d8">BackendProfiling</a>.</p> + +</div> +</div> +<a id="a93ee1c2509b9db845936a291b575dd17"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a93ee1c2509b9db845936a291b575dd17">◆ </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> 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>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_backend_profiling.html#a70db5b1cdd0d22c1fa912c6e8b9089ce">BackendProfiling</a>.</p> + +</div> +</div> +<a id="a691685749cd1a917b8e6e9cb1afcc045"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a691685749cd1a917b8e6e9cb1afcc045">◆ </a></span>ReportCounters()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual void ReportCounters </td> + <td>(</td> + <td class="paramtype">const std::vector< <a class="el" href="structarmnn_1_1profiling_1_1_timestamp.html">Timestamp</a> > & </td> + <td class="paramname"><em>counterValues</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>Implemented in <a class="el" href="classarmnn_1_1profiling_1_1_backend_profiling.html#aa51df0c342290615803a99525816e3e3">BackendProfiling</a>.</p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>include/armnn/backends/profiling/<a class="el" href="_i_backend_profiling_8hpp_source.html">IBackendProfiling.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="namespacearmnn_1_1profiling.html">profiling</a></li><li class="navelem"><a class="el" href="classarmnn_1_1profiling_1_1_i_backend_profiling.html">IBackendProfiling</a></li> + <li class="footer">Generated on Fri Mar 13 2020 16:07:06 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> |