Ryan OShea | de36e4a | 2020-03-13 16:26:19 +0000 | [diff] [blame^] | 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 2 | <html xmlns="http://www.w3.org/1999/xhtml"> |
| 3 | <head> |
| 4 | <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| 5 | <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| 6 | <meta name="generator" content="Doxygen 1.8.13"/> |
| 7 | <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| 8 | <title>ArmNN: ExecutionFrame Class Reference</title> |
| 9 | <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| 10 | <script type="text/javascript" src="jquery.js"></script> |
| 11 | <script type="text/javascript" src="dynsections.js"></script> |
| 12 | <link href="navtree.css" rel="stylesheet" type="text/css"/> |
| 13 | <script type="text/javascript" src="resize.js"></script> |
| 14 | <script type="text/javascript" src="navtreedata.js"></script> |
| 15 | <script type="text/javascript" src="navtree.js"></script> |
| 16 | <script type="text/javascript"> |
| 17 | $(document).ready(initResizable); |
| 18 | </script> |
| 19 | <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| 20 | <script type="text/javascript" src="search/searchdata.js"></script> |
| 21 | <script type="text/javascript" src="search/search.js"></script> |
| 22 | <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| 23 | </head> |
| 24 | <body> |
| 25 | <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| 26 | <div id="titlearea"> |
| 27 | <table cellspacing="0" cellpadding="0"> |
| 28 | <tbody> |
| 29 | <tr style="height: 56px;"> |
| 30 | <td id="projectalign" style="padding-left: 0.5em;"> |
| 31 | <div id="projectname">ArmNN |
| 32 |  <span id="projectnumber">NotReleased</span> |
| 33 | </div> |
| 34 | </td> |
| 35 | </tr> |
| 36 | </tbody> |
| 37 | </table> |
| 38 | </div> |
| 39 | <!-- end header part --> |
| 40 | <!-- Generated by Doxygen 1.8.13 --> |
| 41 | <script type="text/javascript"> |
| 42 | var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| 43 | </script> |
| 44 | <script type="text/javascript" src="menudata.js"></script> |
| 45 | <script type="text/javascript" src="menu.js"></script> |
| 46 | <script type="text/javascript"> |
| 47 | $(function() { |
| 48 | initMenu('',true,false,'search.php','Search'); |
| 49 | $(document).ready(function() { init_search(); }); |
| 50 | }); |
| 51 | </script> |
| 52 | <div id="main-nav"></div> |
| 53 | </div><!-- top --> |
| 54 | <div id="side-nav" class="ui-resizable side-nav-resizable"> |
| 55 | <div id="nav-tree"> |
| 56 | <div id="nav-tree-contents"> |
| 57 | <div id="nav-sync" class="sync"></div> |
| 58 | </div> |
| 59 | </div> |
| 60 | <div id="splitbar" style="-moz-user-select:none;" |
| 61 | class="ui-resizable-handle"> |
| 62 | </div> |
| 63 | </div> |
| 64 | <script type="text/javascript"> |
| 65 | $(document).ready(function(){initNavTree('classarmnn_1_1_execution_frame.html','');}); |
| 66 | </script> |
| 67 | <div id="doc-content"> |
| 68 | <!-- window showing the filter options --> |
| 69 | <div id="MSearchSelectWindow" |
| 70 | onmouseover="return searchBox.OnSearchSelectShow()" |
| 71 | onmouseout="return searchBox.OnSearchSelectHide()" |
| 72 | onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| 73 | </div> |
| 74 | |
| 75 | <!-- iframe showing the search results (closed by default) --> |
| 76 | <div id="MSearchResultsWindow"> |
| 77 | <iframe src="javascript:void(0)" frameborder="0" |
| 78 | name="MSearchResults" id="MSearchResults"> |
| 79 | </iframe> |
| 80 | </div> |
| 81 | |
| 82 | <div class="header"> |
| 83 | <div class="summary"> |
| 84 | <a href="#pub-methods">Public Member Functions</a> | |
| 85 | <a href="classarmnn_1_1_execution_frame-members.html">List of all members</a> </div> |
| 86 | <div class="headertitle"> |
| 87 | <div class="title">ExecutionFrame Class Reference</div> </div> |
| 88 | </div><!--header--> |
| 89 | <div class="contents"> |
| 90 | |
| 91 | <p><code>#include <<a class="el" href="_execution_frame_8hpp_source.html">ExecutionFrame.hpp</a>></code></p> |
| 92 | <div class="dynheader"> |
| 93 | Inheritance diagram for ExecutionFrame:</div> |
| 94 | <div class="dyncontent"> |
| 95 | <div class="center"> |
| 96 | <img src="classarmnn_1_1_execution_frame.png" usemap="#ExecutionFrame_map" alt=""/> |
| 97 | <map id="ExecutionFrame_map" name="ExecutionFrame_map"> |
| 98 | <area href="classarmnn_1_1_i_execution_frame.html" title="ExecutionFrame interface to enqueue a workload computation. " alt="IExecutionFrame" shape="rect" coords="0,0,106,24"/> |
| 99 | </map> |
| 100 | </div></div> |
| 101 | <table class="memberdecls"> |
| 102 | <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| 103 | Public Member Functions</h2></td></tr> |
| 104 | <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.html#ad93148c735945f614be3a5e57c3c1dad">ExecutionFrame</a> ()</td></tr> |
| 105 | <tr class="separator:ad93148c735945f614be3a5e57c3c1dad"><td class="memSeparator" colspan="2"> </td></tr> |
| 106 | <tr class="memitem:a53bc9f544fe292cbbc2d258595bc3af7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarmnn_1_1_i_execution_frame.html">IExecutionFrame</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_execution_frame.html#a53bc9f544fe292cbbc2d258595bc3af7">ExecuteWorkloads</a> (<a class="el" href="classarmnn_1_1_i_execution_frame.html">IExecutionFrame</a> *previousFrame) override</td></tr> |
| 107 | <tr class="separator:a53bc9f544fe292cbbc2d258595bc3af7"><td class="memSeparator" colspan="2"> </td></tr> |
| 108 | <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.html#a81627f96ba06d76e147f7d392a8117ed">PostAllocationConfigure</a> () override</td></tr> |
| 109 | <tr class="separator:a81627f96ba06d76e147f7d392a8117ed"><td class="memSeparator" colspan="2"> </td></tr> |
| 110 | <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.html#ab27ebaf88cafddc4a6ee001ec7316e73">RegisterDebugCallback</a> (const <a class="el" href="namespacearmnn.html#a15f3ad9b5e4e3d46b0a6dda246a7bc28">DebugCallbackFunction</a> &func) override</td></tr> |
| 111 | <tr class="separator:ab27ebaf88cafddc4a6ee001ec7316e73"><td class="memSeparator" colspan="2"> </td></tr> |
| 112 | <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.html#a66a0f659f0630312604b65cb8f144c0e">AddWorkloadToQueue</a> (std::unique_ptr< <a class="el" href="classarmnn_1_1_i_workload.html">IWorkload</a> > workload)</td></tr> |
| 113 | <tr class="separator:a66a0f659f0630312604b65cb8f144c0e"><td class="memSeparator" colspan="2"> </td></tr> |
| 114 | <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.html#a695550617960685f2626ef23c30e2c9d">SetNextExecutionFrame</a> (<a class="el" href="classarmnn_1_1_i_execution_frame.html">IExecutionFrame</a> *nextExecutionFrame)</td></tr> |
| 115 | <tr class="separator:a695550617960685f2626ef23c30e2c9d"><td class="memSeparator" colspan="2"> </td></tr> |
| 116 | <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.html">IExecutionFrame</a></td></tr> |
| 117 | <tr class="memitem:abbae45e5a5820264392de5421b9772a4 inherit pub_methods_classarmnn_1_1_i_execution_frame"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_execution_frame.html#abbae45e5a5820264392de5421b9772a4">~IExecutionFrame</a> ()</td></tr> |
| 118 | <tr class="separator:abbae45e5a5820264392de5421b9772a4 inherit pub_methods_classarmnn_1_1_i_execution_frame"><td class="memSeparator" colspan="2"> </td></tr> |
| 119 | </table> |
| 120 | <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| 121 | <div class="textblock"> |
| 122 | <p class="definition">Definition at line <a class="el" href="_execution_frame_8hpp_source.html#l00027">27</a> of file <a class="el" href="_execution_frame_8hpp_source.html">ExecutionFrame.hpp</a>.</p> |
| 123 | </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| 124 | <a id="ad93148c735945f614be3a5e57c3c1dad"></a> |
| 125 | <h2 class="memtitle"><span class="permalink"><a href="#ad93148c735945f614be3a5e57c3c1dad">◆ </a></span>ExecutionFrame()</h2> |
| 126 | |
| 127 | <div class="memitem"> |
| 128 | <div class="memproto"> |
| 129 | <table class="memname"> |
| 130 | <tr> |
| 131 | <td class="memname"><a class="el" href="classarmnn_1_1_execution_frame.html">ExecutionFrame</a> </td> |
| 132 | <td>(</td> |
| 133 | <td class="paramname"></td><td>)</td> |
| 134 | <td></td> |
| 135 | </tr> |
| 136 | </table> |
| 137 | </div><div class="memdoc"> |
| 138 | |
| 139 | <p class="definition">Definition at line <a class="el" href="_execution_frame_8cpp_source.html#l00012">12</a> of file <a class="el" href="_execution_frame_8cpp_source.html">ExecutionFrame.cpp</a>.</p> |
| 140 | <div class="fragment"><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> {}</div></div><!-- fragment --> |
| 141 | </div> |
| 142 | </div> |
| 143 | <h2 class="groupheader">Member Function Documentation</h2> |
| 144 | <a id="a66a0f659f0630312604b65cb8f144c0e"></a> |
| 145 | <h2 class="memtitle"><span class="permalink"><a href="#a66a0f659f0630312604b65cb8f144c0e">◆ </a></span>AddWorkloadToQueue()</h2> |
| 146 | |
| 147 | <div class="memitem"> |
| 148 | <div class="memproto"> |
| 149 | <table class="memname"> |
| 150 | <tr> |
| 151 | <td class="memname">void AddWorkloadToQueue </td> |
| 152 | <td>(</td> |
| 153 | <td class="paramtype">std::unique_ptr< <a class="el" href="classarmnn_1_1_i_workload.html">IWorkload</a> > </td> |
| 154 | <td class="paramname"><em>workload</em></td><td>)</td> |
| 155 | <td></td> |
| 156 | </tr> |
| 157 | </table> |
| 158 | </div><div class="memdoc"> |
| 159 | |
| 160 | <p class="definition">Definition at line <a class="el" href="_execution_frame_8cpp_source.html#l00040">40</a> of file <a class="el" href="_execution_frame_8cpp_source.html">ExecutionFrame.cpp</a>.</p> |
| 161 | <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 --> |
| 162 | </div> |
| 163 | </div> |
| 164 | <a id="a53bc9f544fe292cbbc2d258595bc3af7"></a> |
| 165 | <h2 class="memtitle"><span class="permalink"><a href="#a53bc9f544fe292cbbc2d258595bc3af7">◆ </a></span>ExecuteWorkloads()</h2> |
| 166 | |
| 167 | <div class="memitem"> |
| 168 | <div class="memproto"> |
| 169 | <table class="mlabels"> |
| 170 | <tr> |
| 171 | <td class="mlabels-left"> |
| 172 | <table class="memname"> |
| 173 | <tr> |
| 174 | <td class="memname"><a class="el" href="classarmnn_1_1_i_execution_frame.html">IExecutionFrame</a> * ExecuteWorkloads </td> |
| 175 | <td>(</td> |
| 176 | <td class="paramtype"><a class="el" href="classarmnn_1_1_i_execution_frame.html">IExecutionFrame</a> * </td> |
| 177 | <td class="paramname"><em>previousFrame</em></td><td>)</td> |
| 178 | <td></td> |
| 179 | </tr> |
| 180 | </table> |
| 181 | </td> |
| 182 | <td class="mlabels-right"> |
| 183 | <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> |
| 184 | </tr> |
| 185 | </table> |
| 186 | </div><div class="memdoc"> |
| 187 | |
| 188 | <p>Implements <a class="el" href="classarmnn_1_1_i_execution_frame.html#a62a4e8e95f13a5b8fd62008423160362">IExecutionFrame</a>.</p> |
| 189 | |
| 190 | <p class="definition">Definition at line <a class="el" href="_execution_frame_8cpp_source.html#l00014">14</a> of file <a class="el" href="_execution_frame_8cpp_source.html">ExecutionFrame.cpp</a>.</p> |
| 191 | |
| 192 | <p class="reference">Referenced by <a class="el" href="_execution_frame_test_8cpp_source.html#l00017">BOOST_AUTO_TEST_CASE()</a>.</p> |
| 193 | <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>  boost::ignore_unused(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><!-- fragment --> |
| 194 | </div> |
| 195 | </div> |
| 196 | <a id="a81627f96ba06d76e147f7d392a8117ed"></a> |
| 197 | <h2 class="memtitle"><span class="permalink"><a href="#a81627f96ba06d76e147f7d392a8117ed">◆ </a></span>PostAllocationConfigure()</h2> |
| 198 | |
| 199 | <div class="memitem"> |
| 200 | <div class="memproto"> |
| 201 | <table class="mlabels"> |
| 202 | <tr> |
| 203 | <td class="mlabels-left"> |
| 204 | <table class="memname"> |
| 205 | <tr> |
| 206 | <td class="memname">void PostAllocationConfigure </td> |
| 207 | <td>(</td> |
| 208 | <td class="paramname"></td><td>)</td> |
| 209 | <td></td> |
| 210 | </tr> |
| 211 | </table> |
| 212 | </td> |
| 213 | <td class="mlabels-right"> |
| 214 | <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> |
| 215 | </tr> |
| 216 | </table> |
| 217 | </div><div class="memdoc"> |
| 218 | |
| 219 | <p>Reimplemented from <a class="el" href="classarmnn_1_1_i_execution_frame.html#ae8ab22492f0a5f78d5a2ab7e76486b5d">IExecutionFrame</a>.</p> |
| 220 | |
| 221 | <p class="definition">Definition at line <a class="el" href="_execution_frame_8cpp_source.html#l00024">24</a> of file <a class="el" href="_execution_frame_8cpp_source.html">ExecutionFrame.cpp</a>.</p> |
| 222 | <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 --> |
| 223 | </div> |
| 224 | </div> |
| 225 | <a id="ab27ebaf88cafddc4a6ee001ec7316e73"></a> |
| 226 | <h2 class="memtitle"><span class="permalink"><a href="#ab27ebaf88cafddc4a6ee001ec7316e73">◆ </a></span>RegisterDebugCallback()</h2> |
| 227 | |
| 228 | <div class="memitem"> |
| 229 | <div class="memproto"> |
| 230 | <table class="mlabels"> |
| 231 | <tr> |
| 232 | <td class="mlabels-left"> |
| 233 | <table class="memname"> |
| 234 | <tr> |
| 235 | <td class="memname">void RegisterDebugCallback </td> |
| 236 | <td>(</td> |
| 237 | <td class="paramtype">const <a class="el" href="namespacearmnn.html#a15f3ad9b5e4e3d46b0a6dda246a7bc28">DebugCallbackFunction</a> & </td> |
| 238 | <td class="paramname"><em>func</em></td><td>)</td> |
| 239 | <td></td> |
| 240 | </tr> |
| 241 | </table> |
| 242 | </td> |
| 243 | <td class="mlabels-right"> |
| 244 | <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> |
| 245 | </tr> |
| 246 | </table> |
| 247 | </div><div class="memdoc"> |
| 248 | |
| 249 | <p>Reimplemented from <a class="el" href="classarmnn_1_1_i_execution_frame.html#ab81312bd5e64cbae2803de9f243bdb32">IExecutionFrame</a>.</p> |
| 250 | |
| 251 | <p class="definition">Definition at line <a class="el" href="_execution_frame_8cpp_source.html#l00032">32</a> of file <a class="el" href="_execution_frame_8cpp_source.html">ExecutionFrame.cpp</a>.</p> |
| 252 | <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 --> |
| 253 | </div> |
| 254 | </div> |
| 255 | <a id="a695550617960685f2626ef23c30e2c9d"></a> |
| 256 | <h2 class="memtitle"><span class="permalink"><a href="#a695550617960685f2626ef23c30e2c9d">◆ </a></span>SetNextExecutionFrame()</h2> |
| 257 | |
| 258 | <div class="memitem"> |
| 259 | <div class="memproto"> |
| 260 | <table class="memname"> |
| 261 | <tr> |
| 262 | <td class="memname">void SetNextExecutionFrame </td> |
| 263 | <td>(</td> |
| 264 | <td class="paramtype"><a class="el" href="classarmnn_1_1_i_execution_frame.html">IExecutionFrame</a> * </td> |
| 265 | <td class="paramname"><em>nextExecutionFrame</em></td><td>)</td> |
| 266 | <td></td> |
| 267 | </tr> |
| 268 | </table> |
| 269 | </div><div class="memdoc"> |
| 270 | |
| 271 | <p class="definition">Definition at line <a class="el" href="_execution_frame_8cpp_source.html#l00045">45</a> of file <a class="el" href="_execution_frame_8cpp_source.html">ExecutionFrame.cpp</a>.</p> |
| 272 | |
| 273 | <p class="reference">Referenced by <a class="el" href="_execution_frame_test_8cpp_source.html#l00017">BOOST_AUTO_TEST_CASE()</a>.</p> |
| 274 | <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 --> |
| 275 | </div> |
| 276 | </div> |
| 277 | <hr/>The documentation for this class was generated from the following files:<ul> |
| 278 | <li>src/armnn/<a class="el" href="_execution_frame_8hpp_source.html">ExecutionFrame.hpp</a></li> |
| 279 | <li>src/armnn/<a class="el" href="_execution_frame_8cpp_source.html">ExecutionFrame.cpp</a></li> |
| 280 | </ul> |
| 281 | </div><!-- contents --> |
| 282 | </div><!-- doc-content --> |
| 283 | <!-- start footer part --> |
| 284 | <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
| 285 | <ul> |
| 286 | <li class="navelem"><a class="el" href="namespacearmnn.html">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_execution_frame.html">ExecutionFrame</a></li> |
| 287 | <li class="footer">Generated on Fri Mar 13 2020 16:07:03 for ArmNN by |
| 288 | <a href="http://www.doxygen.org/index.html"> |
| 289 | <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> |
| 290 | </ul> |
| 291 | </div> |
| 292 | </body> |
| 293 | </html> |