blob: 382b4154f7b6a4655ffc030271a143aaca7f1b1b [file] [log] [blame]
Nikhil Raj38b600d2024-02-15 15:02:19 +00001<!-- HTML header for doxygen 1.8.17-->
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml">
4<head>
5<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6<meta http-equiv="X-UA-Compatible" content="IE=9"/>
7<meta name="generator" content="Doxygen 1.8.17"/>
8<meta name="viewport" content="width=device-width, initial-scale=1"/>
9<title>Arm NN: arm::pipe Namespace Reference</title>
10<link href="tabs.css" rel="stylesheet" type="text/css"/>
11<script type="text/javascript" src="jquery.js"></script>
12<script type="text/javascript" src="dynsections.js"></script>
13<link href="navtree.css" rel="stylesheet" type="text/css"/>
14<script type="text/javascript" src="resize.js"></script>
15<script type="text/javascript" src="navtreedata.js"></script>
16<script type="text/javascript" src="navtree.js"></script>
17<link href="search/search.css" rel="stylesheet" type="text/css"/>
18<script type="text/javascript" src="search/searchdata.js"></script>
19<script type="text/javascript" src="search/search.js"></script>
20<script type="text/x-mathjax-config">
21 MathJax.Hub.Config({
22 extensions: ["tex2jax.js"],
23 jax: ["input/TeX","output/HTML-CSS"],
24});
25</script>
26<script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
27<link href="doxygen.css" rel="stylesheet" type="text/css" />
28<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
29</head>
30<body>
31<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
32<div id="titlearea">
33<table cellspacing="0" cellpadding="0">
34 <tbody>
35 <tr style="height: 56px;">
36 <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 15rem; margin-top: .5rem; margin-left 13px"/>
37 <td id="projectalign" style="padding-left: 0.9em;">
38 <div id="projectname">
39 &#160;<span id="projectnumber">24.02</span>
40 </div>
41 </td>
42 </tr>
43 </tbody>
44</table>
45</div>
46<!-- end header part -->
47<!-- Generated by Doxygen 1.8.17 -->
48<script type="text/javascript">
49/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
50var searchBox = new SearchBox("searchBox", "search",false,'Search');
51/* @license-end */
52</script>
53<script type="text/javascript" src="menudata.js"></script>
54<script type="text/javascript" src="menu.js"></script>
55<script type="text/javascript">
56/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
57$(function() {
58 initMenu('',true,false,'search.php','Search');
59 $(document).ready(function() { init_search(); });
60});
61/* @license-end */</script>
62<div id="main-nav"></div>
63</div><!-- top -->
64<div id="side-nav" class="ui-resizable side-nav-resizable">
65 <div id="nav-tree">
66 <div id="nav-tree-contents">
67 <div id="nav-sync" class="sync"></div>
68 </div>
69 </div>
70 <div id="splitbar" style="-moz-user-select:none;"
71 class="ui-resizable-handle">
72 </div>
73</div>
74<script type="text/javascript">
75/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
76$(document).ready(function(){initNavTree('namespacearm_1_1pipe.html',''); initResizable(); });
77/* @license-end */
78</script>
79<div id="doc-content">
80<!-- window showing the filter options -->
81<div id="MSearchSelectWindow"
82 onmouseover="return searchBox.OnSearchSelectShow()"
83 onmouseout="return searchBox.OnSearchSelectHide()"
84 onkeydown="return searchBox.OnSearchSelectKey(event)">
85</div>
86
87<!-- iframe showing the search results (closed by default) -->
88<div id="MSearchResultsWindow">
89<iframe src="javascript:void(0)" frameborder="0"
90 name="MSearchResults" id="MSearchResults">
91</iframe>
92</div>
93
94<div class="header">
95 <div class="summary">
96<a href="#typedef-members">Typedefs</a> &#124;
97<a href="#func-members">Functions</a> </div>
98 <div class="headertitle">
99<div class="title">arm::pipe Namespace Reference</div> </div>
100</div><!--header-->
101<div class="contents">
102<table class="memberdecls">
103<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
104Typedefs</h2></td></tr>
105<tr class="memitem:a96b0827ffefa36d7ec2b4ac34a922d12"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearm_1_1pipe.html#a96b0827ffefa36d7ec2b4ac34a922d12">ILocalPacketHandlerSharedPtr</a> = std::shared_ptr&lt; ILocalPacketHandler &gt;</td></tr>
106<tr class="separator:a96b0827ffefa36d7ec2b4ac34a922d12"><td class="memSeparator" colspan="2">&#160;</td></tr>
107</table><table class="memberdecls">
108<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
109Functions</h2></td></tr>
110<tr class="memitem:aedd5bf7f3d6df99a1b42e7826c5b380b"><td class="memItemLeft" align="right" valign="top">ProfilingOptions&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearm_1_1pipe.html#aedd5bf7f3d6df99a1b42e7826c5b380b">ConvertExternalProfilingOptions</a> (const <a class="el" href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.html">armnn::IRuntime::CreationOptions::ExternalProfilingOptions</a> &amp;options)</td></tr>
111<tr class="separator:aedd5bf7f3d6df99a1b42e7826c5b380b"><td class="memSeparator" colspan="2">&#160;</td></tr>
112</table>
113<h2 class="groupheader">Typedef Documentation</h2>
114<a id="a96b0827ffefa36d7ec2b4ac34a922d12"></a>
115<h2 class="memtitle"><span class="permalink"><a href="#a96b0827ffefa36d7ec2b4ac34a922d12">&#9670;&nbsp;</a></span>ILocalPacketHandlerSharedPtr</h2>
116
117<div class="memitem">
118<div class="memproto">
119 <table class="memname">
120 <tr>
121 <td class="memname">using <a class="el" href="namespacearm_1_1pipe.html#a96b0827ffefa36d7ec2b4ac34a922d12">ILocalPacketHandlerSharedPtr</a> = std::shared_ptr&lt;ILocalPacketHandler&gt;</td>
122 </tr>
123 </table>
124</div><div class="memdoc">
125
126<p class="definition">Definition at line <a class="el" href="_i_runtime_8hpp_source.html#l00028">28</a> of file <a class="el" href="_i_runtime_8hpp_source.html">IRuntime.hpp</a>.</p>
127
128</div>
129</div>
130<h2 class="groupheader">Function Documentation</h2>
131<a id="aedd5bf7f3d6df99a1b42e7826c5b380b"></a>
132<h2 class="memtitle"><span class="permalink"><a href="#aedd5bf7f3d6df99a1b42e7826c5b380b">&#9670;&nbsp;</a></span>ConvertExternalProfilingOptions()</h2>
133
134<div class="memitem">
135<div class="memproto">
136 <table class="memname">
137 <tr>
138 <td class="memname">ProfilingOptions ConvertExternalProfilingOptions </td>
139 <td>(</td>
140 <td class="paramtype">const <a class="el" href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.html">armnn::IRuntime::CreationOptions::ExternalProfilingOptions</a> &amp;&#160;</td>
141 <td class="paramname"><em>options</em></td><td>)</td>
142 <td></td>
143 </tr>
144 </table>
145</div><div class="memdoc">
146
147<p class="definition">Definition at line <a class="el" href="_profiling_options_converter_8cpp_source.html#l00017">17</a> of file <a class="el" href="_profiling_options_converter_8cpp_source.html">ProfilingOptionsConverter.cpp</a>.</p>
148<div class="fragment"><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;{</div>
149<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; ProfilingOptions convertedOptions;</div>
150<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; convertedOptions.m_EnableProfiling = options.<a class="code" href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.html#a26d42007440bb01a1a6d0ab3b5a657ee">m_EnableProfiling</a>;</div>
151<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; convertedOptions.m_TimelineEnabled = options.<a class="code" href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.html#a5b304d775657afbf1fb724af57add374">m_TimelineEnabled</a>;</div>
152<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; convertedOptions.m_OutgoingCaptureFile = options.<a class="code" href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.html#aa0d6aa79d683bc79d20d4ddcf7db87db">m_OutgoingCaptureFile</a>;</div>
153<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; convertedOptions.m_IncomingCaptureFile = options.<a class="code" href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.html#a36dd18e4f73d470e3234d72198aa5fef">m_IncomingCaptureFile</a>;</div>
154<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; convertedOptions.m_FileOnly = options.<a class="code" href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.html#ad8f8cb971cad412664cd7df58df7eb1e">m_FileOnly</a>;</div>
155<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; convertedOptions.m_CapturePeriod = options.<a class="code" href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.html#a2239347f38747f993c324bdd8b1eb146">m_CapturePeriod</a>;</div>
156<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; convertedOptions.m_FileFormat = options.<a class="code" href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.html#aeec9a6408083ab1b6bf7fa3e566ebe46">m_FileFormat</a>;</div>
157<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; std::copy(options.<a class="code" href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.html#abaf0a782881de8cba2d411a09c2559fa">m_LocalPacketHandlers</a>.begin(), options.<a class="code" href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.html#abaf0a782881de8cba2d411a09c2559fa">m_LocalPacketHandlers</a>.end(),</div>
158<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; std::back_inserter(convertedOptions.m_LocalPacketHandlers));</div>
159<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keywordflow">return</span> convertedOptions;</div>
160<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;}</div>
161</div><!-- fragment -->
162<p class="reference">References <a class="el" href="_i_runtime_8hpp_source.html#l00149">IRuntime::CreationOptions::ExternalProfilingOptions::m_CapturePeriod</a>, <a class="el" href="_i_runtime_8hpp_source.html#l00139">IRuntime::CreationOptions::ExternalProfilingOptions::m_EnableProfiling</a>, <a class="el" href="_i_runtime_8hpp_source.html#l00151">IRuntime::CreationOptions::ExternalProfilingOptions::m_FileFormat</a>, <a class="el" href="_i_runtime_8hpp_source.html#l00147">IRuntime::CreationOptions::ExternalProfilingOptions::m_FileOnly</a>, <a class="el" href="_i_runtime_8hpp_source.html#l00145">IRuntime::CreationOptions::ExternalProfilingOptions::m_IncomingCaptureFile</a>, <a class="el" href="_i_runtime_8hpp_source.html#l00152">IRuntime::CreationOptions::ExternalProfilingOptions::m_LocalPacketHandlers</a>, <a class="el" href="_i_runtime_8hpp_source.html#l00143">IRuntime::CreationOptions::ExternalProfilingOptions::m_OutgoingCaptureFile</a>, and <a class="el" href="_i_runtime_8hpp_source.html#l00141">IRuntime::CreationOptions::ExternalProfilingOptions::m_TimelineEnabled</a>.</p>
163
164<p class="reference">Referenced by <a class="el" href="_runtime_8cpp_source.html#l00323">RuntimeImpl::RuntimeImpl()</a>.</p>
165
166</div>
167</div>
168</div><!-- contents -->
169</div><!-- doc-content -->
170<div class="ttc" id="astructarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options_html_abaf0a782881de8cba2d411a09c2559fa"><div class="ttname"><a href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.html#abaf0a782881de8cba2d411a09c2559fa">armnn::IRuntime::CreationOptions::ExternalProfilingOptions::m_LocalPacketHandlers</a></div><div class="ttdeci">std::vector&lt; arm::pipe::ILocalPacketHandlerSharedPtr &gt; m_LocalPacketHandlers</div><div class="ttdef"><b>Definition:</b> <a href="_i_runtime_8hpp_source.html#l00152">IRuntime.hpp:152</a></div></div>
171<div class="ttc" id="astructarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options_html_ad8f8cb971cad412664cd7df58df7eb1e"><div class="ttname"><a href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.html#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.html#l00147">IRuntime.hpp:147</a></div></div>
172<div class="ttc" id="astructarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options_html_a36dd18e4f73d470e3234d72198aa5fef"><div class="ttname"><a href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.html#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.html#l00145">IRuntime.hpp:145</a></div></div>
173<div class="ttc" id="astructarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options_html_a5b304d775657afbf1fb724af57add374"><div class="ttname"><a href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.html#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.html#l00141">IRuntime.hpp:141</a></div></div>
174<div class="ttc" id="astructarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options_html_a2239347f38747f993c324bdd8b1eb146"><div class="ttname"><a href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.html#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.html#l00149">IRuntime.hpp:149</a></div></div>
175<div class="ttc" id="astructarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options_html_aeec9a6408083ab1b6bf7fa3e566ebe46"><div class="ttname"><a href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.html#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.html#l00151">IRuntime.hpp:151</a></div></div>
176<div class="ttc" id="astructarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options_html_aa0d6aa79d683bc79d20d4ddcf7db87db"><div class="ttname"><a href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.html#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.html#l00143">IRuntime.hpp:143</a></div></div>
177<div class="ttc" id="astructarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options_html_a26d42007440bb01a1a6d0ab3b5a657ee"><div class="ttname"><a href="structarmnn_1_1_i_runtime_1_1_creation_options_1_1_external_profiling_options.html#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.html#l00139">IRuntime.hpp:139</a></div></div>
178<!-- start footer part -->
179<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
180 <ul>
181 <li class="navelem"><a class="el" href="namespacearm.html">arm</a></li><li class="navelem"><a class="el" href="namespacearm_1_1pipe.html">pipe</a></li>
182 <li class="footer">Generated on Wed Feb 14 2024 16:36:20 for Arm NN by
183 <a href="http://www.doxygen.org/index.html">
184 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
185 </ul>
186</div>
187</body>
188</html>