Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / 0800bf541a3c6f5f2d6ff842a30e20ed48fb2eac / . / Documentation / classarmnn_1_1_i_memory_manager.xhtml
blob: d7b7e059ec03b105b907964b3b140ed8f3a3f3e4 [file] [log] [blame]
Ryan OSheade36e4a2020-03-13 16:26:19 +0000[diff] [blame]1<!-- Copyright (c) 2020 ARM Limited. -->
2<!-- -->
3<!-- SPDX-License-Identifier: MIT -->
4<!-- -->
5<!-- HTML header for doxygen 1.8.13-->
6<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
7<html xmlns="http://www.w3.org/1999/xhtml">
8<head>
9<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
10<meta http-equiv="X-UA-Compatible" content="IE=9"/>
11<meta name="generator" content="Doxygen 1.8.13"/>
12<meta name="robots" content="NOINDEX, NOFOLLOW" />
13<meta name="viewport" content="width=device-width, initial-scale=1"/>
14<title>ArmNN: IMemoryManager Class Reference</title>
15<link href="tabs.css" rel="stylesheet" type="text/css"/>
16<script type="text/javascript" src="jquery.js"></script>
17<script type="text/javascript" src="dynsections.js"></script>
18<link href="navtree.css" rel="stylesheet" type="text/css"/>
19<script type="text/javascript" src="resize.js"></script>
20<script type="text/javascript" src="navtreedata.js"></script>
21<script type="text/javascript" src="navtree.js"></script>
22<script type="text/javascript">
23 $(document).ready(initResizable);
24</script>
25<link href="search/search.css" rel="stylesheet" type="text/css"/>
26<script type="text/javascript" src="search/searchdata.js"></script>
27<script type="text/javascript" src="search/search.js"></script>
28<script type="text/x-mathjax-config">
29 MathJax.Hub.Config({
30 extensions: ["tex2jax.js"],
31 jax: ["input/TeX","output/HTML-CSS"],
32});
33</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
34<link href="doxygen.css" rel="stylesheet" type="text/css" />
35<link href="stylesheet.css" rel="stylesheet" type="text/css"/>
36</head>
37<body>
38<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
39<div id="titlearea">
40<table cellspacing="0" cellpadding="0">
41 <tbody>
42 <tr style="height: 56px;">
43 <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 10rem; margin-top: .5rem; margin-left 10px"/>
44 <td style="padding-left: 0.5em;">
45 <div id="projectname">
46 &#160;<span id="projectnumber">20.02</span>
47 </div>
48 </td>
49 </tr>
50 </tbody>
51</table>
52</div>
53<!-- end header part -->
54<!-- Generated by Doxygen 1.8.13 -->
55<script type="text/javascript">
56var searchBox = new SearchBox("searchBox", "search",false,'Search');
57</script>
58<script type="text/javascript" src="menudata.js"></script>
59<script type="text/javascript" src="menu.js"></script>
60<script type="text/javascript">
61$(function() {
62 initMenu('',true,false,'search.php','Search');
63 $(document).ready(function() { init_search(); });
64});
65</script>
66<div id="main-nav"></div>
67</div><!-- top -->
68<div id="side-nav" class="ui-resizable side-nav-resizable">
69 <div id="nav-tree">
70 <div id="nav-tree-contents">
71 <div id="nav-sync" class="sync"></div>
72 </div>
73 </div>
74 <div id="splitbar" style="-moz-user-select:none;"
75 class="ui-resizable-handle">
76 </div>
77</div>
78<script type="text/javascript">
79$(document).ready(function(){initNavTree('classarmnn_1_1_i_memory_manager.xhtml','');});
80</script>
81<div id="doc-content">
82<!-- window showing the filter options -->
83<div id="MSearchSelectWindow"
84 onmouseover="return searchBox.OnSearchSelectShow()"
85 onmouseout="return searchBox.OnSearchSelectHide()"
86 onkeydown="return searchBox.OnSearchSelectKey(event)">
87</div>
88
89<!-- iframe showing the search results (closed by default) -->
90<div id="MSearchResultsWindow">
91<iframe src="javascript:void(0)" frameborder="0"
92 name="MSearchResults" id="MSearchResults">
93</iframe>
94</div>
95
96<div class="header">
97 <div class="summary">
98<a href="#pub-methods">Public Member Functions</a> &#124;
99<a href="#pro-methods">Protected Member Functions</a> &#124;
100<a href="classarmnn_1_1_i_memory_manager-members.xhtml">List of all members</a> </div>
101 <div class="headertitle">
102<div class="title">IMemoryManager Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
103</div><!--header-->
104<div class="contents">
105
106<p><code>#include &lt;<a class="el" href="include_2armnn_2backends_2_i_memory_manager_8hpp_source.xhtml">IMemoryManager.hpp</a>&gt;</code></p>
107<div class="dynheader">
108Inheritance diagram for IMemoryManager:</div>
109<div class="dyncontent">
110 <div class="center">
111 <img src="classarmnn_1_1_i_memory_manager.png" usemap="#IMemoryManager_map" alt=""/>
112 <map id="IMemoryManager_map" name="IMemoryManager_map">
113<area href="classarmnn_1_1_base_memory_manager.xhtml" alt="BaseMemoryManager" shape="rect" coords="80,56,230,80"/>
114<area href="classarmnn_1_1_ref_memory_manager.xhtml" alt="RefMemoryManager" shape="rect" coords="240,56,390,80"/>
115<area href="classarmnn_1_1_sample_memory_manager.xhtml" alt="SampleMemoryManager" shape="rect" coords="400,56,550,80"/>
116<area href="classarmnn_1_1_cl_memory_manager.xhtml" alt="ClMemoryManager" shape="rect" coords="0,112,150,136"/>
117<area href="classarmnn_1_1_neon_memory_manager.xhtml" alt="NeonMemoryManager" shape="rect" coords="160,112,310,136"/>
118</map>
119 </div></div>
120<table class="memberdecls">
121<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
122Public Member Functions</h2></td></tr>
123<tr class="memitem:a72e29e3a91bbf0ab80b0b19bc7975a39"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_memory_manager.xhtml#a72e29e3a91bbf0ab80b0b19bc7975a39">Acquire</a> ()=0</td></tr>
124<tr class="separator:a72e29e3a91bbf0ab80b0b19bc7975a39"><td class="memSeparator" colspan="2">&#160;</td></tr>
125<tr class="memitem:a4dc7ecb0d192d6cccc9287daaf0eca0f"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_memory_manager.xhtml#a4dc7ecb0d192d6cccc9287daaf0eca0f">Release</a> ()=0</td></tr>
126<tr class="separator:a4dc7ecb0d192d6cccc9287daaf0eca0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
127<tr class="memitem:ab6c1ddb9068366530366b18984a4ef9b"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_memory_manager.xhtml#ab6c1ddb9068366530366b18984a4ef9b">~IMemoryManager</a> ()</td></tr>
128<tr class="separator:ab6c1ddb9068366530366b18984a4ef9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
129</table><table class="memberdecls">
130<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
131Protected Member Functions</h2></td></tr>
132<tr class="memitem:a881ecdf717d604ab6be9a27514a5a35a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_i_memory_manager.xhtml#a881ecdf717d604ab6be9a27514a5a35a">IMemoryManager</a> ()</td></tr>
133<tr class="separator:a881ecdf717d604ab6be9a27514a5a35a"><td class="memSeparator" colspan="2">&#160;</td></tr>
134</table>
135<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
136<div class="textblock">
137<p class="definition">Definition at line <a class="el" href="include_2armnn_2backends_2_i_memory_manager_8hpp_source.xhtml#l00012">12</a> of file <a class="el" href="include_2armnn_2backends_2_i_memory_manager_8hpp_source.xhtml">IMemoryManager.hpp</a>.</p>
138</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
139<a id="a881ecdf717d604ab6be9a27514a5a35a"></a>
140<h2 class="memtitle"><span class="permalink"><a href="#a881ecdf717d604ab6be9a27514a5a35a">&#9670;&nbsp;</a></span>IMemoryManager()</h2>
141
142<div class="memitem">
143<div class="memproto">
144<table class="mlabels">
145 <tr>
146 <td class="mlabels-left">
147 <table class="memname">
148 <tr>
149 <td class="memname"><a class="el" href="classarmnn_1_1_i_memory_manager.xhtml">IMemoryManager</a> </td>
150 <td>(</td>
151 <td class="paramname"></td><td>)</td>
152 <td></td>
153 </tr>
154 </table>
155 </td>
156 <td class="mlabels-right">
157<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
158 </tr>
159</table>
160</div><div class="memdoc">
161
162<p class="definition">Definition at line <a class="el" href="include_2armnn_2backends_2_i_memory_manager_8hpp_source.xhtml#l00015">15</a> of file <a class="el" href="include_2armnn_2backends_2_i_memory_manager_8hpp_source.xhtml">IMemoryManager.hpp</a>.</p>
163
164<p class="reference">References <a class="el" href="classarmnn_1_1_i_memory_manager.xhtml#a72e29e3a91bbf0ab80b0b19bc7975a39">IMemoryManager::Acquire()</a>, and <a class="el" href="classarmnn_1_1_i_memory_manager.xhtml#a4dc7ecb0d192d6cccc9287daaf0eca0f">IMemoryManager::Release()</a>.</p>
165<div class="fragment"><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;{}</div></div><!-- fragment -->
166</div>
167</div>
168<a id="ab6c1ddb9068366530366b18984a4ef9b"></a>
169<h2 class="memtitle"><span class="permalink"><a href="#ab6c1ddb9068366530366b18984a4ef9b">&#9670;&nbsp;</a></span>~IMemoryManager()</h2>
170
171<div class="memitem">
172<div class="memproto">
173<table class="mlabels">
174 <tr>
175 <td class="mlabels-left">
176 <table class="memname">
177 <tr>
178 <td class="memname">virtual ~<a class="el" href="classarmnn_1_1_i_memory_manager.xhtml">IMemoryManager</a> </td>
179 <td>(</td>
180 <td class="paramname"></td><td>)</td>
181 <td></td>
182 </tr>
183 </table>
184 </td>
185 <td class="mlabels-right">
186<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
187 </tr>
188</table>
189</div><div class="memdoc">
190
191<p class="definition">Definition at line <a class="el" href="include_2armnn_2backends_2_i_memory_manager_8hpp_source.xhtml#l00021">21</a> of file <a class="el" href="include_2armnn_2backends_2_i_memory_manager_8hpp_source.xhtml">IMemoryManager.hpp</a>.</p>
192<div class="fragment"><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;{}</div></div><!-- fragment -->
193</div>
194</div>
195<h2 class="groupheader">Member Function Documentation</h2>
196<a id="a72e29e3a91bbf0ab80b0b19bc7975a39"></a>
197<h2 class="memtitle"><span class="permalink"><a href="#a72e29e3a91bbf0ab80b0b19bc7975a39">&#9670;&nbsp;</a></span>Acquire()</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">virtual void Acquire </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">pure virtual</span></span> </td>
215 </tr>
216</table>
217</div><div class="memdoc">
218
219<p>Implemented in <a class="el" href="classarmnn_1_1_base_memory_manager.xhtml#a21dfb49c3ec675ca25a5eb618fe52b07">BaseMemoryManager</a>, <a class="el" href="classarmnn_1_1_ref_memory_manager.xhtml#a21dfb49c3ec675ca25a5eb618fe52b07">RefMemoryManager</a>, and <a class="el" href="classarmnn_1_1_sample_memory_manager.xhtml#a21dfb49c3ec675ca25a5eb618fe52b07">SampleMemoryManager</a>.</p>
220
221<p class="reference">Referenced by <a class="el" href="include_2armnn_2backends_2_i_memory_manager_8hpp_source.xhtml#l00015">IMemoryManager::IMemoryManager()</a>.</p>
222
223</div>
224</div>
225<a id="a4dc7ecb0d192d6cccc9287daaf0eca0f"></a>
226<h2 class="memtitle"><span class="permalink"><a href="#a4dc7ecb0d192d6cccc9287daaf0eca0f">&#9670;&nbsp;</a></span>Release()</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">virtual void Release </td>
236 <td>(</td>
237 <td class="paramname"></td><td>)</td>
238 <td></td>
239 </tr>
240 </table>
241 </td>
242 <td class="mlabels-right">
243<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
244 </tr>
245</table>
246</div><div class="memdoc">
247
248<p>Implemented in <a class="el" href="classarmnn_1_1_base_memory_manager.xhtml#a1a5dddc8911f6189f9ca01394c59faaf">BaseMemoryManager</a>, <a class="el" href="classarmnn_1_1_ref_memory_manager.xhtml#a1a5dddc8911f6189f9ca01394c59faaf">RefMemoryManager</a>, and <a class="el" href="classarmnn_1_1_sample_memory_manager.xhtml#a1a5dddc8911f6189f9ca01394c59faaf">SampleMemoryManager</a>.</p>
249
250<p class="reference">Referenced by <a class="el" href="include_2armnn_2backends_2_i_memory_manager_8hpp_source.xhtml#l00015">IMemoryManager::IMemoryManager()</a>.</p>
251
252</div>
253</div>
254<hr/>The documentation for this class was generated from the following file:<ul>
255<li>include/armnn/backends/<a class="el" href="include_2armnn_2backends_2_i_memory_manager_8hpp_source.xhtml">IMemoryManager.hpp</a></li>
256</ul>
257</div><!-- contents -->
258</div><!-- doc-content -->
259<!-- start footer part -->
260<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
261 <ul>
262 <li class="navelem"><a class="el" href="namespacearmnn.xhtml">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_i_memory_manager.xhtml">IMemoryManager</a></li>
263 <li class="footer">Generated on Fri Mar 13 2020 16:09:18 for ArmNN by
264 <a href="http://www.doxygen.org/index.html">
265 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
266 </ul>
267</div>
268</body>
269</html>