Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / 1dc83febfb76d6a770bdf3ba16c4034a970c2320 / . / 24.05 / classarmnn_1_1_ref_memory_manager_1_1_pool.html
blob: 508cbd8d2015f5fa7d48d6d333f82326cbd64d11 [file] [log] [blame]
Nikhil Raj1dc83fe2024-05-16 09:47:51 +0100[diff] [blame^]1<!-- HTML header for doxygen 1.8.17-->
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml">
4<head>
5<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6<meta http-equiv="X-UA-Compatible" content="IE=9"/>
7<meta name="generator" content="Doxygen 1.8.17"/>
8<meta name="viewport" content="width=device-width, initial-scale=1"/>
9<title>Arm NN: RefMemoryManager::Pool Class Reference</title>
10<link href="tabs.css" rel="stylesheet" type="text/css"/>
11<script type="text/javascript" src="jquery.js"></script>
12<script type="text/javascript" src="dynsections.js"></script>
13<link href="navtree.css" rel="stylesheet" type="text/css"/>
14<script type="text/javascript" src="resize.js"></script>
15<script type="text/javascript" src="navtreedata.js"></script>
16<script type="text/javascript" src="navtree.js"></script>
17<link href="search/search.css" rel="stylesheet" type="text/css"/>
18<script type="text/javascript" src="search/searchdata.js"></script>
19<script type="text/javascript" src="search/search.js"></script>
20<script type="text/x-mathjax-config">
21 MathJax.Hub.Config({
22 extensions: ["tex2jax.js"],
23 jax: ["input/TeX","output/HTML-CSS"],
24});
25</script>
26<script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
27<link href="doxygen.css" rel="stylesheet" type="text/css" />
28<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
29</head>
30<body>
31<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
32<div id="titlearea">
33<table cellspacing="0" cellpadding="0">
34 <tbody>
35 <tr style="height: 56px;">
36 <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 15rem; margin-top: .5rem; margin-left 13px"/>
37 <td id="projectalign" style="padding-left: 0.9em;">
38 <div id="projectname">
39 &#160;<span id="projectnumber">24.05</span>
40 </div>
41 </td>
42 </tr>
43 </tbody>
44</table>
45</div>
46<!-- end header part -->
47<!-- Generated by Doxygen 1.8.17 -->
48<script type="text/javascript">
49/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
50var searchBox = new SearchBox("searchBox", "search",false,'Search');
51/* @license-end */
52</script>
53<script type="text/javascript" src="menudata.js"></script>
54<script type="text/javascript" src="menu.js"></script>
55<script type="text/javascript">
56/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
57$(function() {
58 initMenu('',true,false,'search.php','Search');
59 $(document).ready(function() { init_search(); });
60});
61/* @license-end */</script>
62<div id="main-nav"></div>
63</div><!-- top -->
64<div id="side-nav" class="ui-resizable side-nav-resizable">
65 <div id="nav-tree">
66 <div id="nav-tree-contents">
67 <div id="nav-sync" class="sync"></div>
68 </div>
69 </div>
70 <div id="splitbar" style="-moz-user-select:none;"
71 class="ui-resizable-handle">
72 </div>
73</div>
74<script type="text/javascript">
75/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
76$(document).ready(function(){initNavTree('classarmnn_1_1_ref_memory_manager_1_1_pool.html',''); initResizable(); });
77/* @license-end */
78</script>
79<div id="doc-content">
80<!-- window showing the filter options -->
81<div id="MSearchSelectWindow"
82 onmouseover="return searchBox.OnSearchSelectShow()"
83 onmouseout="return searchBox.OnSearchSelectHide()"
84 onkeydown="return searchBox.OnSearchSelectKey(event)">
85</div>
86
87<!-- iframe showing the search results (closed by default) -->
88<div id="MSearchResultsWindow">
89<iframe src="javascript:void(0)" frameborder="0"
90 name="MSearchResults" id="MSearchResults">
91</iframe>
92</div>
93
94<div class="header">
95 <div class="summary">
96<a href="#pub-methods">Public Member Functions</a> &#124;
97<a href="classarmnn_1_1_ref_memory_manager_1_1_pool-members.html">List of all members</a> </div>
98 <div class="headertitle">
99<div class="title">RefMemoryManager::Pool Class Reference</div> </div>
100</div><!--header-->
101<div class="contents">
102
103<p><code>#include &lt;<a class="el" href="_ref_memory_manager_8hpp_source.html">RefMemoryManager.hpp</a>&gt;</code></p>
104<table class="memberdecls">
105<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
106Public Member Functions</h2></td></tr>
107<tr class="memitem:a3661b84570333e6f38f9b8a1ed73b309"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_ref_memory_manager_1_1_pool.html#a3661b84570333e6f38f9b8a1ed73b309">Pool</a> (unsigned int numBytes)</td></tr>
108<tr class="separator:a3661b84570333e6f38f9b8a1ed73b309"><td class="memSeparator" colspan="2">&#160;</td></tr>
109<tr class="memitem:ad680831415106b724bd752599cfc42c3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_ref_memory_manager_1_1_pool.html#ad680831415106b724bd752599cfc42c3">~Pool</a> ()</td></tr>
110<tr class="separator:ad680831415106b724bd752599cfc42c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
111<tr class="memitem:ab91dc804181f48b0b445ac1299c36c05"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_ref_memory_manager_1_1_pool.html#ab91dc804181f48b0b445ac1299c36c05">Acquire</a> ()</td></tr>
112<tr class="separator:ab91dc804181f48b0b445ac1299c36c05"><td class="memSeparator" colspan="2">&#160;</td></tr>
113<tr class="memitem:a94c93747c8daa99d65c2a04c6be0748c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_ref_memory_manager_1_1_pool.html#a94c93747c8daa99d65c2a04c6be0748c">Release</a> ()</td></tr>
114<tr class="separator:a94c93747c8daa99d65c2a04c6be0748c"><td class="memSeparator" colspan="2">&#160;</td></tr>
115<tr class="memitem:a6a5db07a5f1fad654e844c52bf702384"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_ref_memory_manager_1_1_pool.html#a6a5db07a5f1fad654e844c52bf702384">GetPointer</a> ()</td></tr>
116<tr class="separator:a6a5db07a5f1fad654e844c52bf702384"><td class="memSeparator" colspan="2">&#160;</td></tr>
117<tr class="memitem:ab1d2a47dbdaf1c25da4b2b9534cfd3e5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarmnn_1_1_ref_memory_manager_1_1_pool.html#ab1d2a47dbdaf1c25da4b2b9534cfd3e5">Reserve</a> (unsigned int numBytes)</td></tr>
118<tr class="separator:ab1d2a47dbdaf1c25da4b2b9534cfd3e5"><td class="memSeparator" colspan="2">&#160;</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="_ref_memory_manager_8hpp_source.html#l00033">33</a> of file <a class="el" href="_ref_memory_manager_8hpp_source.html">RefMemoryManager.hpp</a>.</p>
123</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
124<a id="a3661b84570333e6f38f9b8a1ed73b309"></a>
125<h2 class="memtitle"><span class="permalink"><a href="#a3661b84570333e6f38f9b8a1ed73b309">&#9670;&nbsp;</a></span>Pool()</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_ref_memory_manager_1_1_pool.html">Pool</a> </td>
132 <td>(</td>
133 <td class="paramtype">unsigned int&#160;</td>
134 <td class="paramname"><em>numBytes</em></td><td>)</td>
135 <td></td>
136 </tr>
137 </table>
138</div><div class="memdoc">
139
140<p class="definition">Definition at line <a class="el" href="_ref_memory_manager_8cpp_source.html#l00063">63</a> of file <a class="el" href="_ref_memory_manager_8cpp_source.html">RefMemoryManager.cpp</a>.</p>
141<div class="fragment"><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; : m_Size(numBytes),</div>
142<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; m_Pointer(<span class="keyword">nullptr</span>)</div>
143<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;{}</div>
144</div><!-- fragment -->
145</div>
146</div>
147<a id="ad680831415106b724bd752599cfc42c3"></a>
148<h2 class="memtitle"><span class="permalink"><a href="#ad680831415106b724bd752599cfc42c3">&#9670;&nbsp;</a></span>~Pool()</h2>
149
150<div class="memitem">
151<div class="memproto">
152 <table class="memname">
153 <tr>
154 <td class="memname">~<a class="el" href="classarmnn_1_1_ref_memory_manager_1_1_pool.html">Pool</a> </td>
155 <td>(</td>
156 <td class="paramname"></td><td>)</td>
157 <td></td>
158 </tr>
159 </table>
160</div><div class="memdoc">
161
162<p class="definition">Definition at line <a class="el" href="_ref_memory_manager_8cpp_source.html#l00068">68</a> of file <a class="el" href="_ref_memory_manager_8cpp_source.html">RefMemoryManager.cpp</a>.</p>
163<div class="fragment"><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;{</div>
164<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="keywordflow">if</span> (m_Pointer)</div>
165<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; {</div>
166<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <a class="code" href="classarmnn_1_1_ref_memory_manager_1_1_pool.html#a94c93747c8daa99d65c2a04c6be0748c">Release</a>();</div>
167<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; }</div>
168<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;}</div>
169</div><!-- fragment -->
170<p class="reference">References <a class="el" href="_ref_memory_manager_8cpp_source.html#l00055">RefMemoryManager::Release()</a>.</p>
171
172</div>
173</div>
174<h2 class="groupheader">Member Function Documentation</h2>
175<a id="ab91dc804181f48b0b445ac1299c36c05"></a>
176<h2 class="memtitle"><span class="permalink"><a href="#ab91dc804181f48b0b445ac1299c36c05">&#9670;&nbsp;</a></span>Acquire()</h2>
177
178<div class="memitem">
179<div class="memproto">
180 <table class="memname">
181 <tr>
182 <td class="memname">void Acquire </td>
183 <td>(</td>
184 <td class="paramname"></td><td>)</td>
185 <td></td>
186 </tr>
187 </table>
188</div><div class="memdoc">
189
190<p class="definition">Definition at line <a class="el" href="_ref_memory_manager_8cpp_source.html#l00090">90</a> of file <a class="el" href="_ref_memory_manager_8cpp_source.html">RefMemoryManager.cpp</a>.</p>
191<div class="fragment"><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;{</div>
192<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <a class="code" href="_exceptions_8hpp.html#a797787c23ad8c69dee5f2ae6e0c69d63">ARMNN_THROW_MSG_IF_FALSE</a>(!m_Pointer, RuntimeException,</div>
193<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <span class="stringliteral">&quot;RefMemoryManager::Pool::Acquire() called when memory already acquired&quot;</span>);</div>
194<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; m_Pointer = ::operator <span class="keyword">new</span>(size_t(m_Size));</div>
195<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;}</div>
196</div><!-- fragment -->
197<p class="reference">References <a class="el" href="_exceptions_8hpp_source.html#l00206">ARMNN_THROW_MSG_IF_FALSE</a>.</p>
198
199</div>
200</div>
201<a id="a6a5db07a5f1fad654e844c52bf702384"></a>
202<h2 class="memtitle"><span class="permalink"><a href="#a6a5db07a5f1fad654e844c52bf702384">&#9670;&nbsp;</a></span>GetPointer()</h2>
203
204<div class="memitem">
205<div class="memproto">
206 <table class="memname">
207 <tr>
208 <td class="memname">void * GetPointer </td>
209 <td>(</td>
210 <td class="paramname"></td><td>)</td>
211 <td></td>
212 </tr>
213 </table>
214</div><div class="memdoc">
215
216<p class="definition">Definition at line <a class="el" href="_ref_memory_manager_8cpp_source.html#l00076">76</a> of file <a class="el" href="_ref_memory_manager_8cpp_source.html">RefMemoryManager.cpp</a>.</p>
217<div class="fragment"><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;{</div>
218<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <a class="code" href="_exceptions_8hpp.html#a797787c23ad8c69dee5f2ae6e0c69d63">ARMNN_THROW_MSG_IF_FALSE</a>(m_Pointer, RuntimeException,</div>
219<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="stringliteral">&quot;RefMemoryManager::Pool::GetPointer() called when memory not acquired&quot;</span>);</div>
220<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="keywordflow">return</span> m_Pointer;</div>
221<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;}</div>
222</div><!-- fragment -->
223<p class="reference">References <a class="el" href="_exceptions_8hpp_source.html#l00206">ARMNN_THROW_MSG_IF_FALSE</a>.</p>
224
225<p class="reference">Referenced by <a class="el" href="_ref_memory_manager_8cpp_source.html#l00042">RefMemoryManager::GetPointer()</a>.</p>
226
227</div>
228</div>
229<a id="a94c93747c8daa99d65c2a04c6be0748c"></a>
230<h2 class="memtitle"><span class="permalink"><a href="#a94c93747c8daa99d65c2a04c6be0748c">&#9670;&nbsp;</a></span>Release()</h2>
231
232<div class="memitem">
233<div class="memproto">
234 <table class="memname">
235 <tr>
236 <td class="memname">void Release </td>
237 <td>(</td>
238 <td class="paramname"></td><td>)</td>
239 <td></td>
240 </tr>
241 </table>
242</div><div class="memdoc">
243
244<p class="definition">Definition at line <a class="el" href="_ref_memory_manager_8cpp_source.html#l00097">97</a> of file <a class="el" href="_ref_memory_manager_8cpp_source.html">RefMemoryManager.cpp</a>.</p>
245<div class="fragment"><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;{</div>
246<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; <a class="code" href="_exceptions_8hpp.html#a797787c23ad8c69dee5f2ae6e0c69d63">ARMNN_THROW_MSG_IF_FALSE</a>(m_Pointer, RuntimeException,</div>
247<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; <span class="stringliteral">&quot;RefMemoryManager::Pool::Release() called when memory not acquired&quot;</span>);</div>
248<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; ::operator <span class="keyword">delete</span>(m_Pointer);</div>
249<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; m_Pointer = <span class="keyword">nullptr</span>;</div>
250<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160;}</div>
251</div><!-- fragment -->
252<p class="reference">References <a class="el" href="_exceptions_8hpp_source.html#l00206">ARMNN_THROW_MSG_IF_FALSE</a>.</p>
253
254</div>
255</div>
256<a id="ab1d2a47dbdaf1c25da4b2b9534cfd3e5"></a>
257<h2 class="memtitle"><span class="permalink"><a href="#ab1d2a47dbdaf1c25da4b2b9534cfd3e5">&#9670;&nbsp;</a></span>Reserve()</h2>
258
259<div class="memitem">
260<div class="memproto">
261 <table class="memname">
262 <tr>
263 <td class="memname">void Reserve </td>
264 <td>(</td>
265 <td class="paramtype">unsigned int&#160;</td>
266 <td class="paramname"><em>numBytes</em></td><td>)</td>
267 <td></td>
268 </tr>
269 </table>
270</div><div class="memdoc">
271
272<p class="definition">Definition at line <a class="el" href="_ref_memory_manager_8cpp_source.html#l00083">83</a> of file <a class="el" href="_ref_memory_manager_8cpp_source.html">RefMemoryManager.cpp</a>.</p>
273<div class="fragment"><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;{</div>
274<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <a class="code" href="_exceptions_8hpp.html#a797787c23ad8c69dee5f2ae6e0c69d63">ARMNN_THROW_MSG_IF_FALSE</a>(!m_Pointer, RuntimeException,</div>
275<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <span class="stringliteral">&quot;RefMemoryManager::Pool::Reserve() cannot be called after memory acquired&quot;</span>);</div>
276<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; m_Size = std::max(m_Size, numBytes);</div>
277<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;}</div>
278</div><!-- fragment -->
279<p class="reference">References <a class="el" href="_exceptions_8hpp_source.html#l00206">ARMNN_THROW_MSG_IF_FALSE</a>.</p>
280
281<p class="reference">Referenced by <a class="el" href="_ref_memory_manager_8cpp_source.html#l00020">RefMemoryManager::Manage()</a>.</p>
282
283</div>
284</div>
285<hr/>The documentation for this class was generated from the following files:<ul>
286<li>src/backends/reference/<a class="el" href="_ref_memory_manager_8hpp_source.html">RefMemoryManager.hpp</a></li>
287<li>src/backends/reference/<a class="el" href="_ref_memory_manager_8cpp_source.html">RefMemoryManager.cpp</a></li>
288</ul>
289</div><!-- contents -->
290</div><!-- doc-content -->
291<div class="ttc" id="aclassarmnn_1_1_ref_memory_manager_1_1_pool_html_a94c93747c8daa99d65c2a04c6be0748c"><div class="ttname"><a href="classarmnn_1_1_ref_memory_manager_1_1_pool.html#a94c93747c8daa99d65c2a04c6be0748c">armnn::RefMemoryManager::Pool::Release</a></div><div class="ttdeci">void Release()</div><div class="ttdef"><b>Definition:</b> <a href="_ref_memory_manager_8cpp_source.html#l00097">RefMemoryManager.cpp:97</a></div></div>
292<div class="ttc" id="a_exceptions_8hpp_html_a797787c23ad8c69dee5f2ae6e0c69d63"><div class="ttname"><a href="_exceptions_8hpp.html#a797787c23ad8c69dee5f2ae6e0c69d63">ARMNN_THROW_MSG_IF_FALSE</a></div><div class="ttdeci">#define ARMNN_THROW_MSG_IF_FALSE(_cond, _except, _str)</div><div class="ttdef"><b>Definition:</b> <a href="_exceptions_8hpp_source.html#l00206">Exceptions.hpp:206</a></div></div>
293<!-- start footer part -->
294<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
295 <ul>
296 <li class="navelem"><a class="el" href="namespacearmnn.html">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_ref_memory_manager.html">RefMemoryManager</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_ref_memory_manager_1_1_pool.html">Pool</a></li>
297 <li class="footer">Generated on Thu May 16 2024 09:31:58 for Arm NN by
298 <a href="http://www.doxygen.org/index.html">
299 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
300 </ul>
301</div>
302</body>
303</html>