diff options
author | Jim Flynn <jim.flynn@arm.com> | 2020-03-20 12:25:56 +0000 |
---|---|---|
committer | Jim Flynn <jim.flynn@arm.com> | 2020-03-20 12:25:56 +0000 |
commit | 6940dd720ebb6b3d1df8ca203ab696daefe58189 (patch) | |
tree | 453b6bf09531c92efe5c7abb0926bae104042fd7 /Documentation/classarmnn_1_1_execution_frame.xhtml | |
parent | 4e2e213d1f22ccd8021bf654e46397434ee50390 (diff) | |
download | armnn-6940dd720ebb6b3d1df8ca203ab696daefe58189.tar.gz |
renamed Documentation folder 20.02 and added .nojekyll file
Signed-off-by: Jim Flynn <jim.flynn@arm.com>
Diffstat (limited to 'Documentation/classarmnn_1_1_execution_frame.xhtml')
-rw-r--r-- | Documentation/classarmnn_1_1_execution_frame.xhtml | 310 |
1 files changed, 0 insertions, 310 deletions
diff --git a/Documentation/classarmnn_1_1_execution_frame.xhtml b/Documentation/classarmnn_1_1_execution_frame.xhtml deleted file mode 100644 index 65a3a10bde..0000000000 --- a/Documentation/classarmnn_1_1_execution_frame.xhtml +++ /dev/null @@ -1,310 +0,0 @@ -<!-- 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: ExecutionFrame 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> -<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">20.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('classarmnn_1_1_execution_frame.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="#pub-methods">Public Member Functions</a> | -<a href="classarmnn_1_1_execution_frame-members.xhtml">List of all members</a> </div> - <div class="headertitle"> -<div class="title">ExecutionFrame Class Reference</div> </div> -</div><!--header--> -<div class="contents"> - -<p><code>#include <<a class="el" href="_execution_frame_8hpp_source.xhtml">ExecutionFrame.hpp</a>></code></p> -<div class="dynheader"> -Inheritance diagram for ExecutionFrame:</div> -<div class="dyncontent"> - <div class="center"> - <img src="classarmnn_1_1_execution_frame.png" usemap="#ExecutionFrame_map" alt=""/> - <map id="ExecutionFrame_map" name="ExecutionFrame_map"> -<area href="classarmnn_1_1_i_execution_frame.xhtml" title="ExecutionFrame interface to enqueue a workload computation. " alt="IExecutionFrame" shape="rect" coords="0,0,106,24"/> -</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:ad93148c735945f614be3a5e57c3c1dad"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_execution_frame.xhtml#ad93148c735945f614be3a5e57c3c1dad">ExecutionFrame</a> ()</td></tr> -<tr class="separator:ad93148c735945f614be3a5e57c3c1dad"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a53bc9f544fe292cbbc2d258595bc3af7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarmnn_1_1_i_execution_frame.xhtml">IExecutionFrame</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_execution_frame.xhtml#a53bc9f544fe292cbbc2d258595bc3af7">ExecuteWorkloads</a> (<a class="el" href="classarmnn_1_1_i_execution_frame.xhtml">IExecutionFrame</a> *previousFrame) override</td></tr> -<tr class="separator:a53bc9f544fe292cbbc2d258595bc3af7"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a81627f96ba06d76e147f7d392a8117ed"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_execution_frame.xhtml#a81627f96ba06d76e147f7d392a8117ed">PostAllocationConfigure</a> () override</td></tr> -<tr class="separator:a81627f96ba06d76e147f7d392a8117ed"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ab27ebaf88cafddc4a6ee001ec7316e73"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_execution_frame.xhtml#ab27ebaf88cafddc4a6ee001ec7316e73">RegisterDebugCallback</a> (const <a class="el" href="namespacearmnn.xhtml#a15f3ad9b5e4e3d46b0a6dda246a7bc28">DebugCallbackFunction</a> &func) override</td></tr> -<tr class="separator:ab27ebaf88cafddc4a6ee001ec7316e73"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a66a0f659f0630312604b65cb8f144c0e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_execution_frame.xhtml#a66a0f659f0630312604b65cb8f144c0e">AddWorkloadToQueue</a> (std::unique_ptr< <a class="el" href="classarmnn_1_1_i_workload.xhtml">IWorkload</a> > workload)</td></tr> -<tr class="separator:a66a0f659f0630312604b65cb8f144c0e"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a695550617960685f2626ef23c30e2c9d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_execution_frame.xhtml#a695550617960685f2626ef23c30e2c9d">SetNextExecutionFrame</a> (<a class="el" href="classarmnn_1_1_i_execution_frame.xhtml">IExecutionFrame</a> *nextExecutionFrame)</td></tr> -<tr class="separator:a695550617960685f2626ef23c30e2c9d"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="inherit_header pub_methods_classarmnn_1_1_i_execution_frame"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarmnn_1_1_i_execution_frame')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classarmnn_1_1_i_execution_frame.xhtml">IExecutionFrame</a></td></tr> -<tr class="memitem:a1ca0125ac3082676dae03050a52e6068 inherit pub_methods_classarmnn_1_1_i_execution_frame"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_execution_frame.xhtml#a1ca0125ac3082676dae03050a52e6068">~IExecutionFrame</a> ()</td></tr> -<tr class="separator:a1ca0125ac3082676dae03050a52e6068 inherit pub_methods_classarmnn_1_1_i_execution_frame"><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="_execution_frame_8hpp_source.xhtml#l00027">27</a> of file <a class="el" href="_execution_frame_8hpp_source.xhtml">ExecutionFrame.hpp</a>.</p> -</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> -<a id="ad93148c735945f614be3a5e57c3c1dad"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ad93148c735945f614be3a5e57c3c1dad">◆ </a></span>ExecutionFrame()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="classarmnn_1_1_execution_frame.xhtml">ExecutionFrame</a> </td> - <td>(</td> - <td class="paramname"></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> - -<p class="definition">Definition at line <a class="el" href="_execution_frame_8cpp_source.xhtml#l00012">12</a> of file <a class="el" href="_execution_frame_8cpp_source.xhtml">ExecutionFrame.cpp</a>.</p> -<div class="fragment"><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> {}</div></div><!-- fragment --> -</div> -</div> -<h2 class="groupheader">Member Function Documentation</h2> -<a id="a66a0f659f0630312604b65cb8f144c0e"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a66a0f659f0630312604b65cb8f144c0e">◆ </a></span>AddWorkloadToQueue()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void AddWorkloadToQueue </td> - <td>(</td> - <td class="paramtype">std::unique_ptr< <a class="el" href="classarmnn_1_1_i_workload.xhtml">IWorkload</a> > </td> - <td class="paramname"><em>workload</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> - -<p class="definition">Definition at line <a class="el" href="_execution_frame_8cpp_source.xhtml#l00040">40</a> of file <a class="el" href="_execution_frame_8cpp_source.xhtml">ExecutionFrame.cpp</a>.</p> -<div class="fragment"><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> {</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  m_WorkloadQueue.push_back(move(workload));</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> }</div></div><!-- fragment --> -</div> -</div> -<a id="a53bc9f544fe292cbbc2d258595bc3af7"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a53bc9f544fe292cbbc2d258595bc3af7">◆ </a></span>ExecuteWorkloads()</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_execution_frame.xhtml">IExecutionFrame</a> * ExecuteWorkloads </td> - <td>(</td> - <td class="paramtype"><a class="el" href="classarmnn_1_1_i_execution_frame.xhtml">IExecutionFrame</a> * </td> - <td class="paramname"><em>previousFrame</em></td><td>)</td> - <td></td> - </tr> - </table> - </td> - <td class="mlabels-right"> -<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> - </tr> -</table> -</div><div class="memdoc"> - -<p>Implements <a class="el" href="classarmnn_1_1_i_execution_frame.xhtml#a62a4e8e95f13a5b8fd62008423160362">IExecutionFrame</a>.</p> - -<p class="definition">Definition at line <a class="el" href="_execution_frame_8cpp_source.xhtml#l00014">14</a> of file <a class="el" href="_execution_frame_8cpp_source.xhtml">ExecutionFrame.cpp</a>.</p> - -<p class="reference">References <a class="el" href="_ignore_unused_8hpp_source.xhtml#l00014">armnn::IgnoreUnused()</a>.</p> - -<p class="reference">Referenced by <a class="el" href="_execution_frame_test_8cpp_source.xhtml#l00017">BOOST_AUTO_TEST_CASE()</a>.</p> -<div class="fragment"><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> {</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  <a class="code" href="namespacearmnn.xhtml#a44affeeb090c3c6a3062830562672e84">IgnoreUnused</a>(previousFrame);</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  <span class="keywordflow">for</span> (<span class="keyword">auto</span>& workload: m_WorkloadQueue)</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  {</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  workload->Execute();</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  }</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  <span class="keywordflow">return</span> m_NextExecutionFrame;</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> }</div><div class="ttc" id="namespacearmnn_xhtml_a44affeeb090c3c6a3062830562672e84"><div class="ttname"><a href="namespacearmnn.xhtml#a44affeeb090c3c6a3062830562672e84">armnn::IgnoreUnused</a></div><div class="ttdeci">void IgnoreUnused(Ts &&...)</div><div class="ttdef"><b>Definition:</b> <a href="_ignore_unused_8hpp_source.xhtml#l00014">IgnoreUnused.hpp:14</a></div></div> -</div><!-- fragment --> -</div> -</div> -<a id="a81627f96ba06d76e147f7d392a8117ed"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a81627f96ba06d76e147f7d392a8117ed">◆ </a></span>PostAllocationConfigure()</h2> - -<div class="memitem"> -<div class="memproto"> -<table class="mlabels"> - <tr> - <td class="mlabels-left"> - <table class="memname"> - <tr> - <td class="memname">void PostAllocationConfigure </td> - <td>(</td> - <td class="paramname"></td><td>)</td> - <td></td> - </tr> - </table> - </td> - <td class="mlabels-right"> -<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> - </tr> -</table> -</div><div class="memdoc"> - -<p>Reimplemented from <a class="el" href="classarmnn_1_1_i_execution_frame.xhtml#ae8ab22492f0a5f78d5a2ab7e76486b5d">IExecutionFrame</a>.</p> - -<p class="definition">Definition at line <a class="el" href="_execution_frame_8cpp_source.xhtml#l00024">24</a> of file <a class="el" href="_execution_frame_8cpp_source.xhtml">ExecutionFrame.cpp</a>.</p> -<div class="fragment"><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> {</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="keywordflow">for</span> (<span class="keyword">auto</span>&& workloadPtr: m_WorkloadQueue)</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  {</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  workloadPtr.get()->PostAllocationConfigure();</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  }</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> }</div></div><!-- fragment --> -</div> -</div> -<a id="ab27ebaf88cafddc4a6ee001ec7316e73"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ab27ebaf88cafddc4a6ee001ec7316e73">◆ </a></span>RegisterDebugCallback()</h2> - -<div class="memitem"> -<div class="memproto"> -<table class="mlabels"> - <tr> - <td class="mlabels-left"> - <table class="memname"> - <tr> - <td class="memname">void RegisterDebugCallback </td> - <td>(</td> - <td class="paramtype">const <a class="el" href="namespacearmnn.xhtml#a15f3ad9b5e4e3d46b0a6dda246a7bc28">DebugCallbackFunction</a> & </td> - <td class="paramname"><em>func</em></td><td>)</td> - <td></td> - </tr> - </table> - </td> - <td class="mlabels-right"> -<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> - </tr> -</table> -</div><div class="memdoc"> - -<p>Reimplemented from <a class="el" href="classarmnn_1_1_i_execution_frame.xhtml#ab81312bd5e64cbae2803de9f243bdb32">IExecutionFrame</a>.</p> - -<p class="definition">Definition at line <a class="el" href="_execution_frame_8cpp_source.xhtml#l00032">32</a> of file <a class="el" href="_execution_frame_8cpp_source.xhtml">ExecutionFrame.cpp</a>.</p> -<div class="fragment"><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> {</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keywordflow">for</span> (<span class="keyword">auto</span>&& workloadPtr: m_WorkloadQueue)</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  {</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  workloadPtr.get()->RegisterDebugCallback(func);</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  }</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> }</div></div><!-- fragment --> -</div> -</div> -<a id="a695550617960685f2626ef23c30e2c9d"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a695550617960685f2626ef23c30e2c9d">◆ </a></span>SetNextExecutionFrame()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void SetNextExecutionFrame </td> - <td>(</td> - <td class="paramtype"><a class="el" href="classarmnn_1_1_i_execution_frame.xhtml">IExecutionFrame</a> * </td> - <td class="paramname"><em>nextExecutionFrame</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> - -<p class="definition">Definition at line <a class="el" href="_execution_frame_8cpp_source.xhtml#l00045">45</a> of file <a class="el" href="_execution_frame_8cpp_source.xhtml">ExecutionFrame.cpp</a>.</p> - -<p class="reference">Referenced by <a class="el" href="_execution_frame_test_8cpp_source.xhtml#l00017">BOOST_AUTO_TEST_CASE()</a>.</p> -<div class="fragment"><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> {</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  m_NextExecutionFrame = nextExecutionFrame;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> }</div></div><!-- fragment --> -</div> -</div> -<hr/>The documentation for this class was generated from the following files:<ul> -<li>src/armnn/<a class="el" href="_execution_frame_8hpp_source.xhtml">ExecutionFrame.hpp</a></li> -<li>src/armnn/<a class="el" href="_execution_frame_8cpp_source.xhtml">ExecutionFrame.cpp</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.xhtml">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_execution_frame.xhtml">ExecutionFrame</a></li> - <li class="footer">Generated on Fri Mar 13 2020 16:09:18 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> |