diff options
author | Nikhil Raj <nikhil.raj@arm.com> | 2023-02-24 10:28:19 +0000 |
---|---|---|
committer | Nikhil Raj <nikhil.raj@arm.com> | 2023-02-24 10:28:19 +0000 |
commit | 8d2ca734165a068478df7cffa46185680b05cd20 (patch) | |
tree | 0433a7e6b007fe4639334c4438e58e9872a34b20 /23.02/namespacearm_1_1pipe.xhtml | |
parent | cb0630959aeae05bc2ae9f6d80cf5f5983a8fb77 (diff) | |
download | armnn-8d2ca734165a068478df7cffa46185680b05cd20.tar.gz |
Update Doxygen docu for 23.02
Signed-off-by: Nikhil Raj <nikhil.raj@arm.com>
Change-Id: Ie6c19a27d50fefab2796b2b5875374e81f5bf971
Diffstat (limited to '23.02/namespacearm_1_1pipe.xhtml')
-rw-r--r-- | 23.02/namespacearm_1_1pipe.xhtml | 177 |
1 files changed, 177 insertions, 0 deletions
diff --git a/23.02/namespacearm_1_1pipe.xhtml b/23.02/namespacearm_1_1pipe.xhtml new file mode 100644 index 0000000000..efabeef492 --- /dev/null +++ b/23.02/namespacearm_1_1pipe.xhtml @@ -0,0 +1,177 @@ +<!-- 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: arm::pipe Namespace 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">23.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('namespacearm_1_1pipe.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="#typedef-members">Typedefs</a> | +<a href="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">arm::pipe Namespace Reference</div> </div> +</div><!--header--> +<div class="contents"> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> +Typedefs</h2></td></tr> +<tr class="memitem:a96b0827ffefa36d7ec2b4ac34a922d12"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearm_1_1pipe.xhtml#a96b0827ffefa36d7ec2b4ac34a922d12">ILocalPacketHandlerSharedPtr</a> = std::shared_ptr< ILocalPacketHandler ></td></tr> +<tr class="separator:a96b0827ffefa36d7ec2b4ac34a922d12"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions</h2></td></tr> +<tr class="memitem:aedd5bf7f3d6df99a1b42e7826c5b380b"><td class="memItemLeft" align="right" valign="top">ProfilingOptions </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearm_1_1pipe.xhtml#aedd5bf7f3d6df99a1b42e7826c5b380b">ConvertExternalProfilingOptions</a> (const <a class="el" href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.xhtml">armnn::IRuntime::CreationOptions::ExternalProfilingOptions</a> &options)</td></tr> +<tr class="separator:aedd5bf7f3d6df99a1b42e7826c5b380b"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<h2 class="groupheader">Typedef Documentation</h2> +<a id="a96b0827ffefa36d7ec2b4ac34a922d12"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a96b0827ffefa36d7ec2b4ac34a922d12">◆ </a></span>ILocalPacketHandlerSharedPtr</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">using <a class="el" href="namespacearm_1_1pipe.xhtml#a96b0827ffefa36d7ec2b4ac34a922d12">ILocalPacketHandlerSharedPtr</a> = std::shared_ptr<ILocalPacketHandler></td> + </tr> + </table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_i_runtime_8hpp_source.xhtml#l00028">28</a> of file <a class="el" href="_i_runtime_8hpp_source.xhtml">IRuntime.hpp</a>.</p> + +</div> +</div> +<h2 class="groupheader">Function Documentation</h2> +<a id="aedd5bf7f3d6df99a1b42e7826c5b380b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aedd5bf7f3d6df99a1b42e7826c5b380b">◆ </a></span>ConvertExternalProfilingOptions()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">ProfilingOptions ConvertExternalProfilingOptions </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.xhtml">armnn::IRuntime::CreationOptions::ExternalProfilingOptions</a> & </td> + <td class="paramname"><em>options</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_profiling_options_converter_8cpp_source.xhtml#l00017">17</a> of file <a class="el" href="_profiling_options_converter_8cpp_source.xhtml">ProfilingOptionsConverter.cpp</a>.</p> + +<p class="reference">References <a class="el" href="_i_runtime_8hpp_source.xhtml#l00156">IRuntime::CreationOptions::ExternalProfilingOptions::m_CapturePeriod</a>, <a class="el" href="_i_runtime_8hpp_source.xhtml#l00146">IRuntime::CreationOptions::ExternalProfilingOptions::m_EnableProfiling</a>, <a class="el" href="_i_runtime_8hpp_source.xhtml#l00158">IRuntime::CreationOptions::ExternalProfilingOptions::m_FileFormat</a>, <a class="el" href="_i_runtime_8hpp_source.xhtml#l00154">IRuntime::CreationOptions::ExternalProfilingOptions::m_FileOnly</a>, <a class="el" href="_i_runtime_8hpp_source.xhtml#l00152">IRuntime::CreationOptions::ExternalProfilingOptions::m_IncomingCaptureFile</a>, <a class="el" href="_i_runtime_8hpp_source.xhtml#l00159">IRuntime::CreationOptions::ExternalProfilingOptions::m_LocalPacketHandlers</a>, <a class="el" href="_i_runtime_8hpp_source.xhtml#l00150">IRuntime::CreationOptions::ExternalProfilingOptions::m_OutgoingCaptureFile</a>, and <a class="el" href="_i_runtime_8hpp_source.xhtml#l00148">IRuntime::CreationOptions::ExternalProfilingOptions::m_TimelineEnabled</a>.</p> + +<p class="reference">Referenced by <a class="el" href="_runtime_8cpp_source.xhtml#l00323">RuntimeImpl::RuntimeImpl()</a>.</p> +<div class="fragment"><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> {</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  ProfilingOptions convertedOptions;</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  convertedOptions.m_EnableProfiling = options.<a class="code" href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.xhtml#a26d42007440bb01a1a6d0ab3b5a657ee">m_EnableProfiling</a>;</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  convertedOptions.m_TimelineEnabled = options.<a class="code" href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.xhtml#a5b304d775657afbf1fb724af57add374">m_TimelineEnabled</a>;</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  convertedOptions.m_OutgoingCaptureFile = options.<a class="code" href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.xhtml#aa0d6aa79d683bc79d20d4ddcf7db87db">m_OutgoingCaptureFile</a>;</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  convertedOptions.m_IncomingCaptureFile = options.<a class="code" href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.xhtml#a36dd18e4f73d470e3234d72198aa5fef">m_IncomingCaptureFile</a>;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  convertedOptions.m_FileOnly = options.<a class="code" href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.xhtml#ad8f8cb971cad412664cd7df58df7eb1e">m_FileOnly</a>;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  convertedOptions.m_CapturePeriod = options.<a class="code" href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.xhtml#a2239347f38747f993c324bdd8b1eb146">m_CapturePeriod</a>;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  convertedOptions.m_FileFormat = options.<a class="code" href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.xhtml#aeec9a6408083ab1b6bf7fa3e566ebe46">m_FileFormat</a>;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  std::copy(options.<a class="code" href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.xhtml#abaf0a782881de8cba2d411a09c2559fa">m_LocalPacketHandlers</a>.begin(), options.<a class="code" href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.xhtml#abaf0a782881de8cba2d411a09c2559fa">m_LocalPacketHandlers</a>.end(),</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  std::back_inserter(convertedOptions.m_LocalPacketHandlers));</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keywordflow">return</span> convertedOptions;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> }</div><div class="ttc" id="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options_xhtml_aa0d6aa79d683bc79d20d4ddcf7db87db"><div class="ttname"><a href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.xhtml#aa0d6aa79d683bc79d20d4ddcf7db87db">armnn::IRuntime::CreationOptions::ExternalProfilingOptions::m_OutgoingCaptureFile</a></div><div class="ttdeci">std::string m_OutgoingCaptureFile</div><div class="ttdoc">Path to a file in which outgoing timeline profiling messages will be stored. </div><div class="ttdef"><b>Definition:</b> <a href="_i_runtime_8hpp_source.xhtml#l00150">IRuntime.hpp:150</a></div></div> +<div class="ttc" id="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options_xhtml_abaf0a782881de8cba2d411a09c2559fa"><div class="ttname"><a href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.xhtml#abaf0a782881de8cba2d411a09c2559fa">armnn::IRuntime::CreationOptions::ExternalProfilingOptions::m_LocalPacketHandlers</a></div><div class="ttdeci">std::vector< arm::pipe::ILocalPacketHandlerSharedPtr > m_LocalPacketHandlers</div><div class="ttdef"><b>Definition:</b> <a href="_i_runtime_8hpp_source.xhtml#l00159">IRuntime.hpp:159</a></div></div> +<div class="ttc" id="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options_xhtml_a36dd18e4f73d470e3234d72198aa5fef"><div class="ttname"><a href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.xhtml#a36dd18e4f73d470e3234d72198aa5fef">armnn::IRuntime::CreationOptions::ExternalProfilingOptions::m_IncomingCaptureFile</a></div><div class="ttdeci">std::string m_IncomingCaptureFile</div><div class="ttdoc">Path to a file in which incoming timeline profiling messages will be stored. </div><div class="ttdef"><b>Definition:</b> <a href="_i_runtime_8hpp_source.xhtml#l00152">IRuntime.hpp:152</a></div></div> +<div class="ttc" id="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options_xhtml_a26d42007440bb01a1a6d0ab3b5a657ee"><div class="ttname"><a href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.xhtml#a26d42007440bb01a1a6d0ab3b5a657ee">armnn::IRuntime::CreationOptions::ExternalProfilingOptions::m_EnableProfiling</a></div><div class="ttdeci">bool m_EnableProfiling</div><div class="ttdoc">Indicates whether external profiling is enabled or not. </div><div class="ttdef"><b>Definition:</b> <a href="_i_runtime_8hpp_source.xhtml#l00146">IRuntime.hpp:146</a></div></div> +<div class="ttc" id="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options_xhtml_ad8f8cb971cad412664cd7df58df7eb1e"><div class="ttname"><a href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.xhtml#ad8f8cb971cad412664cd7df58df7eb1e">armnn::IRuntime::CreationOptions::ExternalProfilingOptions::m_FileOnly</a></div><div class="ttdeci">bool m_FileOnly</div><div class="ttdoc">Enable profiling output to file only. </div><div class="ttdef"><b>Definition:</b> <a href="_i_runtime_8hpp_source.xhtml#l00154">IRuntime.hpp:154</a></div></div> +<div class="ttc" id="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options_xhtml_a2239347f38747f993c324bdd8b1eb146"><div class="ttname"><a href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.xhtml#a2239347f38747f993c324bdd8b1eb146">armnn::IRuntime::CreationOptions::ExternalProfilingOptions::m_CapturePeriod</a></div><div class="ttdeci">uint32_t m_CapturePeriod</div><div class="ttdoc">The duration at which captured profiling messages will be flushed. </div><div class="ttdef"><b>Definition:</b> <a href="_i_runtime_8hpp_source.xhtml#l00156">IRuntime.hpp:156</a></div></div> +<div class="ttc" id="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options_xhtml_a5b304d775657afbf1fb724af57add374"><div class="ttname"><a href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.xhtml#a5b304d775657afbf1fb724af57add374">armnn::IRuntime::CreationOptions::ExternalProfilingOptions::m_TimelineEnabled</a></div><div class="ttdeci">bool m_TimelineEnabled</div><div class="ttdoc">Indicates whether external timeline profiling is enabled or not. </div><div class="ttdef"><b>Definition:</b> <a href="_i_runtime_8hpp_source.xhtml#l00148">IRuntime.hpp:148</a></div></div> +<div class="ttc" id="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options_xhtml_aeec9a6408083ab1b6bf7fa3e566ebe46"><div class="ttname"><a href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.xhtml#aeec9a6408083ab1b6bf7fa3e566ebe46">armnn::IRuntime::CreationOptions::ExternalProfilingOptions::m_FileFormat</a></div><div class="ttdeci">std::string m_FileFormat</div><div class="ttdoc">The format of the file used for outputting profiling data. </div><div class="ttdef"><b>Definition:</b> <a href="_i_runtime_8hpp_source.xhtml#l00158">IRuntime.hpp:158</a></div></div> +</div><!-- fragment --> +</div> +</div> +</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="namespacearm.xhtml">arm</a></li><li class="navelem"><a class="el" href="namespacearm_1_1pipe.xhtml">pipe</a></li> + <li class="footer">Generated on Fri Feb 24 2023 10:24:28 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> |