diff options
| author | Nikhil Raj <nikhil.raj@arm.com> | 2023-05-19 11:14:28 +0100 |
|---|---|---|
| committer | Nikhil Raj <nikhil.raj@arm.com> | 2023-05-19 11:14:28 +0100 |
| commit | 8efb48a6847c5cd166c561127ae6611150963ce3 (patch) | |
| tree | f4262b7e54d26021a54bbc310f46d16a291463e5 /23.05/_i_working_mem_handle_8hpp_source.xhtml | |
| parent | 023fe66a59414a0a7b337c7be5c3c341eb5b55d2 (diff) | |
| download | armnn-8efb48a6847c5cd166c561127ae6611150963ce3.tar.gz | |
Update Doxygen docu for 23.05
Signed-off-by: Nikhil Raj <nikhil.raj@arm.com>
Change-Id: I0a992286f14fa68fcc6e5eba31ac39fed003cbbe
Diffstat (limited to '23.05/_i_working_mem_handle_8hpp_source.xhtml')
| -rw-r--r-- | 23.05/_i_working_mem_handle_8hpp_source.xhtml | 177 |
1 files changed, 177 insertions, 0 deletions
diff --git a/23.05/_i_working_mem_handle_8hpp_source.xhtml b/23.05/_i_working_mem_handle_8hpp_source.xhtml new file mode 100644 index 0000000000..580fd2b663 --- /dev/null +++ b/23.05/_i_working_mem_handle_8hpp_source.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.17"/> +<meta name="robots" content="NOINDEX, NOFOLLOW" /> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>ArmNN: include/armnn/IWorkingMemHandle.hpp Source File</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> +<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" async="async" 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.05</span> + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.17 --> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +/* @license-end */ +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +/* @license-end */</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"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(document).ready(function(){initNavTree('_i_working_mem_handle_8hpp_source.xhtml',''); initResizable(); }); +/* @license-end */ +</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="headertitle"> +<div class="title">IWorkingMemHandle.hpp</div> </div> +</div><!--header--> +<div class="contents"> +<a href="_i_working_mem_handle_8hpp.xhtml">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//</span></div> +<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// Copyright © 2022 Arm Ltd and Contributors. All rights reserved.</span></div> +<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// SPDX-License-Identifier: MIT</span></div> +<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">//</span></div> +<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>  </div> +<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#pragma once</span></div> +<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>  </div> +<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="keyword">namespace </span><a class="code" href="namespacearmnn.xhtml">armnn</a></div> +<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> {</div> +<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>  </div> +<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="keyword">using</span> <a class="code" href="namespacearmnn.xhtml#a0d8160388a127c1a23b37bc88dc6e2ec">NetworkId</a> = int;</div> +<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>  </div> +<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="keyword">namespace </span>experimental</div> +<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> {</div> +<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> <span class="keyword">struct </span>ExecutionData;</div> +<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  </div> +<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">struct </span>WorkingMemDescriptor;</div> +<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div> +<div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="classarmnn_1_1experimental_1_1_i_working_mem_handle.xhtml"> 20</a></span> <span class="keyword">class </span><a class="code" href="classarmnn_1_1experimental_1_1_i_working_mem_handle.xhtml">IWorkingMemHandle</a></div> +<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> {</div> +<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">public</span>:</div> +<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="classarmnn_1_1experimental_1_1_i_working_mem_handle.xhtml#aee41760526014b30f5daa1177357eb0d"> 23</a></span>  <span class="keyword">virtual</span> <a class="code" href="classarmnn_1_1experimental_1_1_i_working_mem_handle.xhtml#aee41760526014b30f5daa1177357eb0d">~IWorkingMemHandle</a>() {};</div> +<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"></span> </div> +<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> /// Returns the NetworkId of the Network that this IWorkingMemHandle works with.</span></div> +<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"></span> <span class="keyword">virtual</span> <a class="code" href="namespacearmnn.xhtml#a0d8160388a127c1a23b37bc88dc6e2ec">NetworkId</a> <a class="code" href="classarmnn_1_1experimental_1_1_i_working_mem_handle.xhtml#abd6c4b9a4ef8432f47d0df514cd4a014">GetNetworkId</a>() = 0;</div> +<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"></span> </div> +<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> /// Allocate the backing memory required for execution. If this is not called, then allocation will be</span></div> +<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> /// deferred to execution time.</span></div> +<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1experimental_1_1_i_working_mem_handle.xhtml#a5cceed8b707a09bf27eb61f17acf8a88">Allocate</a>() = 0;</div> +<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"></span> </div> +<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> /// Free the backing memory required for execution.</span></div> +<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classarmnn_1_1experimental_1_1_i_working_mem_handle.xhtml#a49db2bfde3ca4fac7d1042a3aa5778aa">Free</a>() = 0;</div> +<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"></span> </div> +<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> /// IsAllocated returns true if the backing memory is currently allocated.</span></div> +<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classarmnn_1_1experimental_1_1_i_working_mem_handle.xhtml#a7dc65e81254ebe49a20d5d420fb4f47f">IsAllocated</a>() = 0;</div> +<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"></span> </div> +<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> /// Get the WorkingMemDescriptor at an index. The WorkingMemDescriptors are stored in the same order as</span></div> +<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> /// the Workloads in a topologically sorted graph.</span></div> +<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"></span> <span class="keyword">virtual</span> <a class="code" href="structarmnn_1_1experimental_1_1_working_mem_descriptor.xhtml">WorkingMemDescriptor</a>& <a class="code" href="classarmnn_1_1experimental_1_1_i_working_mem_handle.xhtml#a43a1da35a1d1d6f78f656717736ad99c">GetWorkingMemDescriptorAt</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <span class="keywordtype">id</span>) = 0;</div> +<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"></span> </div> +<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> /// Get the ExecutionData at an index.</span></div> +<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> /// The ExecutionData is paired with a BackendId to be able to call backend specific functions upon it.</span></div> +<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> /// The ExecutionData are stored in the same order as the Workloads in a topologically sorted graph.</span></div> +<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"></span> <span class="keyword">virtual</span> std::pair<BackendId, ExecutionData>& <a class="code" href="classarmnn_1_1experimental_1_1_i_working_mem_handle.xhtml#a9ca04afc5cf914f2356d31062c7c26a7">GetExecutionDataAt</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <span class="keywordtype">id</span>) = 0;</div> +<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>  </div> +<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> } <span class="comment">// end experimental namespace</span></div> +<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  </div> +<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> } <span class="comment">// end armnn namespace</span></div> +</div><!-- fragment --></div><!-- contents --> +</div><!-- doc-content --> +<div class="ttc" id="aclassarmnn_1_1experimental_1_1_i_working_mem_handle_xhtml"><div class="ttname"><a href="classarmnn_1_1experimental_1_1_i_working_mem_handle.xhtml">armnn::experimental::IWorkingMemHandle</a></div><div class="ttdef"><b>Definition:</b> <a href="_i_working_mem_handle_8hpp_source.xhtml#l00020">IWorkingMemHandle.hpp:20</a></div></div> +<div class="ttc" id="aclassarmnn_1_1experimental_1_1_i_working_mem_handle_xhtml_aee41760526014b30f5daa1177357eb0d"><div class="ttname"><a href="classarmnn_1_1experimental_1_1_i_working_mem_handle.xhtml#aee41760526014b30f5daa1177357eb0d">armnn::experimental::IWorkingMemHandle::~IWorkingMemHandle</a></div><div class="ttdeci">virtual ~IWorkingMemHandle()</div><div class="ttdef"><b>Definition:</b> <a href="_i_working_mem_handle_8hpp_source.xhtml#l00023">IWorkingMemHandle.hpp:23</a></div></div> +<div class="ttc" id="aclassarmnn_1_1experimental_1_1_i_working_mem_handle_xhtml_a43a1da35a1d1d6f78f656717736ad99c"><div class="ttname"><a href="classarmnn_1_1experimental_1_1_i_working_mem_handle.xhtml#a43a1da35a1d1d6f78f656717736ad99c">armnn::experimental::IWorkingMemHandle::GetWorkingMemDescriptorAt</a></div><div class="ttdeci">virtual WorkingMemDescriptor & GetWorkingMemDescriptorAt(unsigned int id)=0</div><div class="ttdoc">Get the WorkingMemDescriptor at an index.</div></div> +<div class="ttc" id="astructarmnn_1_1experimental_1_1_working_mem_descriptor_xhtml"><div class="ttname"><a href="structarmnn_1_1experimental_1_1_working_mem_descriptor.xhtml">armnn::experimental::WorkingMemDescriptor</a></div><div class="ttdef"><b>Definition:</b> <a href="_working_mem_descriptor_8hpp_source.xhtml#l00018">WorkingMemDescriptor.hpp:18</a></div></div> +<div class="ttc" id="aclassarmnn_1_1experimental_1_1_i_working_mem_handle_xhtml_a7dc65e81254ebe49a20d5d420fb4f47f"><div class="ttname"><a href="classarmnn_1_1experimental_1_1_i_working_mem_handle.xhtml#a7dc65e81254ebe49a20d5d420fb4f47f">armnn::experimental::IWorkingMemHandle::IsAllocated</a></div><div class="ttdeci">virtual bool IsAllocated()=0</div><div class="ttdoc">IsAllocated returns true if the backing memory is currently allocated.</div></div> +<div class="ttc" id="anamespacearmnn_xhtml"><div class="ttname"><a href="namespacearmnn.xhtml">armnn</a></div><div class="ttdoc">Copyright (c) 2021 ARM Limited and Contributors.</div><div class="ttdef"><b>Definition:</b> <a href="01__00__quick__start_8dox_source.xhtml#l00006">01_00_quick_start.dox:6</a></div></div> +<div class="ttc" id="aclassarmnn_1_1experimental_1_1_i_working_mem_handle_xhtml_a49db2bfde3ca4fac7d1042a3aa5778aa"><div class="ttname"><a href="classarmnn_1_1experimental_1_1_i_working_mem_handle.xhtml#a49db2bfde3ca4fac7d1042a3aa5778aa">armnn::experimental::IWorkingMemHandle::Free</a></div><div class="ttdeci">virtual void Free()=0</div><div class="ttdoc">Free the backing memory required for execution.</div></div> +<div class="ttc" id="aclassarmnn_1_1experimental_1_1_i_working_mem_handle_xhtml_abd6c4b9a4ef8432f47d0df514cd4a014"><div class="ttname"><a href="classarmnn_1_1experimental_1_1_i_working_mem_handle.xhtml#abd6c4b9a4ef8432f47d0df514cd4a014">armnn::experimental::IWorkingMemHandle::GetNetworkId</a></div><div class="ttdeci">virtual NetworkId GetNetworkId()=0</div><div class="ttdoc">Returns the NetworkId of the Network that this IWorkingMemHandle works with.</div></div> +<div class="ttc" id="anamespacearmnn_xhtml_a0d8160388a127c1a23b37bc88dc6e2ec"><div class="ttname"><a href="namespacearmnn.xhtml#a0d8160388a127c1a23b37bc88dc6e2ec">armnn::NetworkId</a></div><div class="ttdeci">int NetworkId</div><div class="ttdef"><b>Definition:</b> <a href="_i_runtime_8hpp_source.xhtml#l00035">IRuntime.hpp:35</a></div></div> +<div class="ttc" id="aclassarmnn_1_1experimental_1_1_i_working_mem_handle_xhtml_a9ca04afc5cf914f2356d31062c7c26a7"><div class="ttname"><a href="classarmnn_1_1experimental_1_1_i_working_mem_handle.xhtml#a9ca04afc5cf914f2356d31062c7c26a7">armnn::experimental::IWorkingMemHandle::GetExecutionDataAt</a></div><div class="ttdeci">virtual std::pair< BackendId, ExecutionData > & GetExecutionDataAt(unsigned int id)=0</div><div class="ttdoc">Get the ExecutionData at an index.</div></div> +<div class="ttc" id="aclassarmnn_1_1experimental_1_1_i_working_mem_handle_xhtml_a5cceed8b707a09bf27eb61f17acf8a88"><div class="ttname"><a href="classarmnn_1_1experimental_1_1_i_working_mem_handle.xhtml#a5cceed8b707a09bf27eb61f17acf8a88">armnn::experimental::IWorkingMemHandle::Allocate</a></div><div class="ttdeci">virtual void Allocate()=0</div><div class="ttdoc">Allocate the backing memory required for execution.</div></div> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.xhtml">include</a></li><li class="navelem"><a class="el" href="dir_2b72cc348e06937955e62ebdd8a13436.xhtml">armnn</a></li><li class="navelem"><a class="el" href="_i_working_mem_handle_8hpp.xhtml">IWorkingMemHandle.hpp</a></li> + <li class="footer">Generated on Thu May 18 2023 10:35:39 for ArmNN by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li> + </ul> +</div> +</body> +</html> |