Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / 01d0281404183c84d26e863502cac8d83044c0bf / . / Documentation / classarmnn_1_1_sample_memory_manager_1_1_pool.html
blob: 4ad8646f20a1cb43511c7869e49d5405b5106064 [file] [log] [blame]
Ryan OSheade36e4a2020-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: SampleMemoryManager::Pool 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 &#160;<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">
42var 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_sample_memory_manager_1_1_pool.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> &#124;
85<a href="classarmnn_1_1_sample_memory_manager_1_1_pool-members.html">List of all members</a> </div>
86 <div class="headertitle">
87<div class="title">SampleMemoryManager::Pool Class Reference</div> </div>
88</div><!--header-->
89<div class="contents">
90
91<p><code>#include &lt;<a class="el" href="_sample_memory_manager_8hpp_source.html">SampleMemoryManager.hpp</a>&gt;</code></p>
92<table class="memberdecls">
93<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
94Public Member Functions</h2></td></tr>
95<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_sample_memory_manager_1_1_pool.html#a3661b84570333e6f38f9b8a1ed73b309">Pool</a> (unsigned int numBytes)</td></tr>
96<tr class="separator:a3661b84570333e6f38f9b8a1ed73b309"><td class="memSeparator" colspan="2">&#160;</td></tr>
97<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_sample_memory_manager_1_1_pool.html#ad680831415106b724bd752599cfc42c3">~Pool</a> ()</td></tr>
98<tr class="separator:ad680831415106b724bd752599cfc42c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
99<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_sample_memory_manager_1_1_pool.html#ab91dc804181f48b0b445ac1299c36c05">Acquire</a> ()</td></tr>
100<tr class="separator:ab91dc804181f48b0b445ac1299c36c05"><td class="memSeparator" colspan="2">&#160;</td></tr>
101<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_sample_memory_manager_1_1_pool.html#a94c93747c8daa99d65c2a04c6be0748c">Release</a> ()</td></tr>
102<tr class="separator:a94c93747c8daa99d65c2a04c6be0748c"><td class="memSeparator" colspan="2">&#160;</td></tr>
103<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_sample_memory_manager_1_1_pool.html#a6a5db07a5f1fad654e844c52bf702384">GetPointer</a> ()</td></tr>
104<tr class="separator:a6a5db07a5f1fad654e844c52bf702384"><td class="memSeparator" colspan="2">&#160;</td></tr>
105<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_sample_memory_manager_1_1_pool.html#ab1d2a47dbdaf1c25da4b2b9534cfd3e5">Reserve</a> (unsigned int numBytes)</td></tr>
106<tr class="separator:ab1d2a47dbdaf1c25da4b2b9534cfd3e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
107</table>
108<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
109<div class="textblock">
110<p class="definition">Definition at line <a class="el" href="_sample_memory_manager_8hpp_source.html#l00033">33</a> of file <a class="el" href="_sample_memory_manager_8hpp_source.html">SampleMemoryManager.hpp</a>.</p>
111</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
112<a id="a3661b84570333e6f38f9b8a1ed73b309"></a>
113<h2 class="memtitle"><span class="permalink"><a href="#a3661b84570333e6f38f9b8a1ed73b309">&#9670;&nbsp;</a></span>Pool()</h2>
114
115<div class="memitem">
116<div class="memproto">
117 <table class="memname">
118 <tr>
119 <td class="memname"><a class="el" href="classarmnn_1_1_sample_memory_manager_1_1_pool.html">Pool</a> </td>
120 <td>(</td>
121 <td class="paramtype">unsigned int&#160;</td>
122 <td class="paramname"><em>numBytes</em></td><td>)</td>
123 <td></td>
124 </tr>
125 </table>
126</div><div class="memdoc">
127
128<p class="definition">Definition at line <a class="el" href="_sample_memory_manager_8cpp_source.html#l00061">61</a> of file <a class="el" href="_sample_memory_manager_8cpp_source.html">SampleMemoryManager.cpp</a>.</p>
129<div class="fragment"><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; : m_Size(numBytes),</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; m_Pointer(<span class="keyword">nullptr</span>)</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;{}</div></div><!-- fragment -->
130</div>
131</div>
132<a id="ad680831415106b724bd752599cfc42c3"></a>
133<h2 class="memtitle"><span class="permalink"><a href="#ad680831415106b724bd752599cfc42c3">&#9670;&nbsp;</a></span>~Pool()</h2>
134
135<div class="memitem">
136<div class="memproto">
137 <table class="memname">
138 <tr>
139 <td class="memname">~<a class="el" href="classarmnn_1_1_sample_memory_manager_1_1_pool.html">Pool</a> </td>
140 <td>(</td>
141 <td class="paramname"></td><td>)</td>
142 <td></td>
143 </tr>
144 </table>
145</div><div class="memdoc">
146
147<p class="definition">Definition at line <a class="el" href="_sample_memory_manager_8cpp_source.html#l00066">66</a> of file <a class="el" href="_sample_memory_manager_8cpp_source.html">SampleMemoryManager.cpp</a>.</p>
148
149<p class="reference">References <a class="el" href="_sample_memory_manager_8cpp_source.html#l00089">SampleMemoryManager::Pool::Release()</a>.</p>
150<div class="fragment"><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;{</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keywordflow">if</span> (m_Pointer)</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; {</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <a class="code" href="classarmnn_1_1_sample_memory_manager_1_1_pool.html#a94c93747c8daa99d65c2a04c6be0748c">Release</a>();</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; }</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;}</div><div class="ttc" id="classarmnn_1_1_sample_memory_manager_1_1_pool_html_a94c93747c8daa99d65c2a04c6be0748c"><div class="ttname"><a href="classarmnn_1_1_sample_memory_manager_1_1_pool.html#a94c93747c8daa99d65c2a04c6be0748c">armnn::SampleMemoryManager::Pool::Release</a></div><div class="ttdeci">void Release()</div><div class="ttdef"><b>Definition:</b> <a href="_sample_memory_manager_8cpp_source.html#l00089">SampleMemoryManager.cpp:89</a></div></div>
151</div><!-- fragment -->
152</div>
153</div>
154<h2 class="groupheader">Member Function Documentation</h2>
155<a id="ab91dc804181f48b0b445ac1299c36c05"></a>
156<h2 class="memtitle"><span class="permalink"><a href="#ab91dc804181f48b0b445ac1299c36c05">&#9670;&nbsp;</a></span>Acquire()</h2>
157
158<div class="memitem">
159<div class="memproto">
160 <table class="memname">
161 <tr>
162 <td class="memname">void Acquire </td>
163 <td>(</td>
164 <td class="paramname"></td><td>)</td>
165 <td></td>
166 </tr>
167 </table>
168</div><div class="memdoc">
169
170<p class="definition">Definition at line <a class="el" href="_sample_memory_manager_8cpp_source.html#l00084">84</a> of file <a class="el" href="_sample_memory_manager_8cpp_source.html">SampleMemoryManager.cpp</a>.</p>
171<div class="fragment"><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;{</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; m_Pointer = ::operator <span class="keyword">new</span>(size_t(m_Size));</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;}</div></div><!-- fragment -->
172</div>
173</div>
174<a id="a6a5db07a5f1fad654e844c52bf702384"></a>
175<h2 class="memtitle"><span class="permalink"><a href="#a6a5db07a5f1fad654e844c52bf702384">&#9670;&nbsp;</a></span>GetPointer()</h2>
176
177<div class="memitem">
178<div class="memproto">
179 <table class="memname">
180 <tr>
181 <td class="memname">void * GetPointer </td>
182 <td>(</td>
183 <td class="paramname"></td><td>)</td>
184 <td></td>
185 </tr>
186 </table>
187</div><div class="memdoc">
188
189<p class="definition">Definition at line <a class="el" href="_sample_memory_manager_8cpp_source.html#l00074">74</a> of file <a class="el" href="_sample_memory_manager_8cpp_source.html">SampleMemoryManager.cpp</a>.</p>
190
191<p class="reference">Referenced by <a class="el" href="_sample_memory_manager_8cpp_source.html#l00040">SampleMemoryManager::GetPointer()</a>.</p>
192<div class="fragment"><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;{</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="keywordflow">return</span> m_Pointer;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;}</div></div><!-- fragment -->
193</div>
194</div>
195<a id="a94c93747c8daa99d65c2a04c6be0748c"></a>
196<h2 class="memtitle"><span class="permalink"><a href="#a94c93747c8daa99d65c2a04c6be0748c">&#9670;&nbsp;</a></span>Release()</h2>
197
198<div class="memitem">
199<div class="memproto">
200 <table class="memname">
201 <tr>
202 <td class="memname">void Release </td>
203 <td>(</td>
204 <td class="paramname"></td><td>)</td>
205 <td></td>
206 </tr>
207 </table>
208</div><div class="memdoc">
209
210<p class="definition">Definition at line <a class="el" href="_sample_memory_manager_8cpp_source.html#l00089">89</a> of file <a class="el" href="_sample_memory_manager_8cpp_source.html">SampleMemoryManager.cpp</a>.</p>
211
212<p class="reference">Referenced by <a class="el" href="_sample_memory_manager_8cpp_source.html#l00066">SampleMemoryManager::Pool::~Pool()</a>.</p>
213<div class="fragment"><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;{</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; ::operator <span class="keyword">delete</span>(m_Pointer);</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; m_Pointer = <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;}</div></div><!-- fragment -->
214</div>
215</div>
216<a id="ab1d2a47dbdaf1c25da4b2b9534cfd3e5"></a>
217<h2 class="memtitle"><span class="permalink"><a href="#ab1d2a47dbdaf1c25da4b2b9534cfd3e5">&#9670;&nbsp;</a></span>Reserve()</h2>
218
219<div class="memitem">
220<div class="memproto">
221 <table class="memname">
222 <tr>
223 <td class="memname">void Reserve </td>
224 <td>(</td>
225 <td class="paramtype">unsigned int&#160;</td>
226 <td class="paramname"><em>numBytes</em></td><td>)</td>
227 <td></td>
228 </tr>
229 </table>
230</div><div class="memdoc">
231
232<p class="definition">Definition at line <a class="el" href="_sample_memory_manager_8cpp_source.html#l00079">79</a> of file <a class="el" href="_sample_memory_manager_8cpp_source.html">SampleMemoryManager.cpp</a>.</p>
233
234<p class="reference">Referenced by <a class="el" href="_sample_memory_manager_8cpp_source.html#l00019">SampleMemoryManager::Manage()</a>.</p>
235<div class="fragment"><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;{</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; m_Size = std::max(m_Size, numBytes);</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;}</div></div><!-- fragment -->
236</div>
237</div>
238<hr/>The documentation for this class was generated from the following files:<ul>
239<li>src/dynamic/sample/<a class="el" href="_sample_memory_manager_8hpp_source.html">SampleMemoryManager.hpp</a></li>
240<li>src/dynamic/sample/<a class="el" href="_sample_memory_manager_8cpp_source.html">SampleMemoryManager.cpp</a></li>
241</ul>
242</div><!-- contents -->
243</div><!-- doc-content -->
244<!-- start footer part -->
245<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
246 <ul>
247 <li class="navelem"><a class="el" href="namespacearmnn.html">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_sample_memory_manager.html">SampleMemoryManager</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_sample_memory_manager_1_1_pool.html">Pool</a></li>
248 <li class="footer">Generated on Fri Mar 13 2020 16:07:05 for ArmNN by
249 <a href="http://www.doxygen.org/index.html">
250 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
251 </ul>
252</div>
253</body>
254</html>