diff options
author | Nikhil Raj <nikhil.raj@arm.com> | 2023-11-22 11:41:15 +0000 |
---|---|---|
committer | Nikhil Raj <nikhil.raj@arm.com> | 2023-11-22 11:41:15 +0000 |
commit | 6f92c8e9f8bb38dcf5dccf8deeff5112ecd8e37c (patch) | |
tree | 0c076149c03ac45c2617f5e02a77b79287ff5a0f /23.11/classarmnn_1_1experimental_1_1_i_working_mem_handle.html | |
parent | 03c7ff3f6188240baaeaeb405a357a0c58195fec (diff) | |
download | armnn-6f92c8e9f8bb38dcf5dccf8deeff5112ecd8e37c.tar.gz |
Update Doxygen for 23.11
Signed-off-by: Nikhil Raj <nikhil.raj@arm.com>
Change-Id: I47cd933f5002cb94a73aa97689d7b3d9c93cb849
Diffstat (limited to '23.11/classarmnn_1_1experimental_1_1_i_working_mem_handle.html')
-rw-r--r-- | 23.11/classarmnn_1_1experimental_1_1_i_working_mem_handle.html | 363 |
1 files changed, 363 insertions, 0 deletions
diff --git a/23.11/classarmnn_1_1experimental_1_1_i_working_mem_handle.html b/23.11/classarmnn_1_1experimental_1_1_i_working_mem_handle.html new file mode 100644 index 0000000000..294fdc0b6c --- /dev/null +++ b/23.11/classarmnn_1_1experimental_1_1_i_working_mem_handle.html @@ -0,0 +1,363 @@ +<!-- HTML header for doxygen 1.8.17--> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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="viewport" content="width=device-width, initial-scale=1"/> +<title>Arm NN: IWorkingMemHandle 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> +<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="customdoxygen.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: 15rem; margin-top: .5rem; margin-left 13px"/> + <td id="projectalign" style="padding-left: 0.9em;"> + <div id="projectname"> +  <span id="projectnumber">23.11</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('classarmnn_1_1experimental_1_1_i_working_mem_handle.html',''); 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="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="classarmnn_1_1experimental_1_1_i_working_mem_handle-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">IWorkingMemHandle Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> +</div><!--header--> +<div class="contents"> + +<p><code>#include <<a class="el" href="_i_working_mem_handle_8hpp_source.html">IWorkingMemHandle.hpp</a>></code></p> +<div class="dynheader"> +Inheritance diagram for IWorkingMemHandle:</div> +<div class="dyncontent"> +<div class="center"><iframe scrolling="no" frameborder="0" src="classarmnn_1_1experimental_1_1_i_working_mem_handle__inherit__graph.svg" width="170" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe> +</div> +<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></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:aee41760526014b30f5daa1177357eb0d"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1experimental_1_1_i_working_mem_handle.html#aee41760526014b30f5daa1177357eb0d">~IWorkingMemHandle</a> ()</td></tr> +<tr class="separator:aee41760526014b30f5daa1177357eb0d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:abd6c4b9a4ef8432f47d0df514cd4a014"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespacearmnn.html#a0d8160388a127c1a23b37bc88dc6e2ec">NetworkId</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1experimental_1_1_i_working_mem_handle.html#abd6c4b9a4ef8432f47d0df514cd4a014">GetNetworkId</a> ()=0</td></tr> +<tr class="memdesc:abd6c4b9a4ef8432f47d0df514cd4a014"><td class="mdescLeft"> </td><td class="mdescRight">Returns the NetworkId of the Network that this <a class="el" href="classarmnn_1_1experimental_1_1_i_working_mem_handle.html">IWorkingMemHandle</a> works with. <a href="classarmnn_1_1experimental_1_1_i_working_mem_handle.html#abd6c4b9a4ef8432f47d0df514cd4a014">More...</a><br /></td></tr> +<tr class="separator:abd6c4b9a4ef8432f47d0df514cd4a014"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a5cceed8b707a09bf27eb61f17acf8a88"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1experimental_1_1_i_working_mem_handle.html#a5cceed8b707a09bf27eb61f17acf8a88">Allocate</a> ()=0</td></tr> +<tr class="memdesc:a5cceed8b707a09bf27eb61f17acf8a88"><td class="mdescLeft"> </td><td class="mdescRight">Allocate the backing memory required for execution. <a href="classarmnn_1_1experimental_1_1_i_working_mem_handle.html#a5cceed8b707a09bf27eb61f17acf8a88">More...</a><br /></td></tr> +<tr class="separator:a5cceed8b707a09bf27eb61f17acf8a88"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a49db2bfde3ca4fac7d1042a3aa5778aa"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1experimental_1_1_i_working_mem_handle.html#a49db2bfde3ca4fac7d1042a3aa5778aa">Free</a> ()=0</td></tr> +<tr class="memdesc:a49db2bfde3ca4fac7d1042a3aa5778aa"><td class="mdescLeft"> </td><td class="mdescRight">Free the backing memory required for execution. <a href="classarmnn_1_1experimental_1_1_i_working_mem_handle.html#a49db2bfde3ca4fac7d1042a3aa5778aa">More...</a><br /></td></tr> +<tr class="separator:a49db2bfde3ca4fac7d1042a3aa5778aa"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7dc65e81254ebe49a20d5d420fb4f47f"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1experimental_1_1_i_working_mem_handle.html#a7dc65e81254ebe49a20d5d420fb4f47f">IsAllocated</a> ()=0</td></tr> +<tr class="memdesc:a7dc65e81254ebe49a20d5d420fb4f47f"><td class="mdescLeft"> </td><td class="mdescRight">IsAllocated returns true if the backing memory is currently allocated. <a href="classarmnn_1_1experimental_1_1_i_working_mem_handle.html#a7dc65e81254ebe49a20d5d420fb4f47f">More...</a><br /></td></tr> +<tr class="separator:a7dc65e81254ebe49a20d5d420fb4f47f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a43a1da35a1d1d6f78f656717736ad99c"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structarmnn_1_1experimental_1_1_working_mem_descriptor.html">WorkingMemDescriptor</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1experimental_1_1_i_working_mem_handle.html#a43a1da35a1d1d6f78f656717736ad99c">GetWorkingMemDescriptorAt</a> (unsigned int id)=0</td></tr> +<tr class="memdesc:a43a1da35a1d1d6f78f656717736ad99c"><td class="mdescLeft"> </td><td class="mdescRight">Get the <a class="el" href="structarmnn_1_1experimental_1_1_working_mem_descriptor.html">WorkingMemDescriptor</a> at an index. <a href="classarmnn_1_1experimental_1_1_i_working_mem_handle.html#a43a1da35a1d1d6f78f656717736ad99c">More...</a><br /></td></tr> +<tr class="separator:a43a1da35a1d1d6f78f656717736ad99c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9ca04afc5cf914f2356d31062c7c26a7"><td class="memItemLeft" align="right" valign="top">virtual std::pair< <a class="el" href="classarmnn_1_1_backend_id.html">BackendId</a>, <a class="el" href="structarmnn_1_1experimental_1_1_execution_data.html">ExecutionData</a> > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1experimental_1_1_i_working_mem_handle.html#a9ca04afc5cf914f2356d31062c7c26a7">GetExecutionDataAt</a> (unsigned int id)=0</td></tr> +<tr class="memdesc:a9ca04afc5cf914f2356d31062c7c26a7"><td class="mdescLeft"> </td><td class="mdescRight">Get the <a class="el" href="structarmnn_1_1experimental_1_1_execution_data.html">ExecutionData</a> at an index. <a href="classarmnn_1_1experimental_1_1_i_working_mem_handle.html#a9ca04afc5cf914f2356d31062c7c26a7">More...</a><br /></td></tr> +<tr class="separator:a9ca04afc5cf914f2356d31062c7c26a7"><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="_i_working_mem_handle_8hpp_source.html#l00020">20</a> of file <a class="el" href="_i_working_mem_handle_8hpp_source.html">IWorkingMemHandle.hpp</a>.</p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="aee41760526014b30f5daa1177357eb0d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aee41760526014b30f5daa1177357eb0d">◆ </a></span>~IWorkingMemHandle()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual ~<a class="el" href="classarmnn_1_1experimental_1_1_i_working_mem_handle.html">IWorkingMemHandle</a> </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_i_working_mem_handle_8hpp_source.html#l00023">23</a> of file <a class="el" href="_i_working_mem_handle_8hpp_source.html">IWorkingMemHandle.hpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> {};</div> +</div><!-- fragment --> +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a id="a5cceed8b707a09bf27eb61f17acf8a88"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a5cceed8b707a09bf27eb61f17acf8a88">◆ </a></span>Allocate()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual void Allocate </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Allocate the backing memory required for execution. </p> +<p>If this is not called, then allocation will be deferred to execution time. </p> + +<p>Implemented in <a class="el" href="classarmnn_1_1experimental_1_1_working_mem_handle.html#a8518772c5d692e334a76617582b10b92">WorkingMemHandle</a>.</p> + +</div> +</div> +<a id="a49db2bfde3ca4fac7d1042a3aa5778aa"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a49db2bfde3ca4fac7d1042a3aa5778aa">◆ </a></span>Free()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual void Free </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Free the backing memory required for execution. </p> + +<p>Implemented in <a class="el" href="classarmnn_1_1experimental_1_1_working_mem_handle.html#a2688c89e6bdec61e0f483d9be6fd688c">WorkingMemHandle</a>.</p> + +</div> +</div> +<a id="a9ca04afc5cf914f2356d31062c7c26a7"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a9ca04afc5cf914f2356d31062c7c26a7">◆ </a></span>GetExecutionDataAt()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual std::pair<<a class="el" href="classarmnn_1_1_backend_id.html">BackendId</a>, <a class="el" href="structarmnn_1_1experimental_1_1_execution_data.html">ExecutionData</a>>& GetExecutionDataAt </td> + <td>(</td> + <td class="paramtype">unsigned int </td> + <td class="paramname"><em>id</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Get the <a class="el" href="structarmnn_1_1experimental_1_1_execution_data.html">ExecutionData</a> at an index. </p> +<p>The <a class="el" href="structarmnn_1_1experimental_1_1_execution_data.html">ExecutionData</a> is paired with a <a class="el" href="classarmnn_1_1_backend_id.html">BackendId</a> to be able to call backend specific functions upon it. The <a class="el" href="structarmnn_1_1experimental_1_1_execution_data.html">ExecutionData</a> are stored in the same order as the Workloads in a topologically sorted graph. </p> + +<p>Implemented in <a class="el" href="classarmnn_1_1experimental_1_1_working_mem_handle.html#ab522849a917e9095c462e5e5980316be">WorkingMemHandle</a>.</p> + +</div> +</div> +<a id="abd6c4b9a4ef8432f47d0df514cd4a014"></a> +<h2 class="memtitle"><span class="permalink"><a href="#abd6c4b9a4ef8432f47d0df514cd4a014">◆ </a></span>GetNetworkId()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="namespacearmnn.html#a0d8160388a127c1a23b37bc88dc6e2ec">NetworkId</a> GetNetworkId </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Returns the NetworkId of the Network that this <a class="el" href="classarmnn_1_1experimental_1_1_i_working_mem_handle.html">IWorkingMemHandle</a> works with. </p> + +<p>Implemented in <a class="el" href="classarmnn_1_1experimental_1_1_working_mem_handle.html#a6d485a38c5d662a4aa9471587b4688bb">WorkingMemHandle</a>.</p> + +<p class="reference">Referenced by <a class="el" href="_runtime_8cpp_source.html#l00696">RuntimeImpl::Execute()</a>.</p> + +</div> +</div> +<a id="a43a1da35a1d1d6f78f656717736ad99c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a43a1da35a1d1d6f78f656717736ad99c">◆ </a></span>GetWorkingMemDescriptorAt()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="structarmnn_1_1experimental_1_1_working_mem_descriptor.html">WorkingMemDescriptor</a>& GetWorkingMemDescriptorAt </td> + <td>(</td> + <td class="paramtype">unsigned int </td> + <td class="paramname"><em>id</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Get the <a class="el" href="structarmnn_1_1experimental_1_1_working_mem_descriptor.html">WorkingMemDescriptor</a> at an index. </p> +<p>The WorkingMemDescriptors are stored in the same order as the Workloads in a topologically sorted graph. </p> + +<p>Implemented in <a class="el" href="classarmnn_1_1experimental_1_1_working_mem_handle.html#a1915a1eb2ba2554103a09de391a9f6bd">WorkingMemHandle</a>.</p> + +</div> +</div> +<a id="a7dc65e81254ebe49a20d5d420fb4f47f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a7dc65e81254ebe49a20d5d420fb4f47f">◆ </a></span>IsAllocated()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual bool IsAllocated </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>IsAllocated returns true if the backing memory is currently allocated. </p> + +<p>Implemented in <a class="el" href="classarmnn_1_1experimental_1_1_working_mem_handle.html#a1a573373f4505385578f830caebf6adb">WorkingMemHandle</a>.</p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>include/armnn/<a class="el" href="_i_working_mem_handle_8hpp_source.html">IWorkingMemHandle.hpp</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.html">armnn</a></li><li class="navelem"><a class="el" href="namespacearmnn_1_1experimental.html">experimental</a></li><li class="navelem"><a class="el" href="classarmnn_1_1experimental_1_1_i_working_mem_handle.html">IWorkingMemHandle</a></li> + <li class="footer">Generated on Wed Nov 22 2023 10:57:17 for Arm NN 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> |