Gitiles
Code Review Sign In
review.mlplatform.org / ml / armnn / 0800bf541a3c6f5f2d6ff842a30e20ed48fb2eac / . / Documentation / classarmnn_1_1_ref_memory_manager_1_1_pool.xhtml
blob: 3c0e9d661325a2905f6b3f5ace52a0ba898f6a86 [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: RefMemoryManager::Pool 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_ref_memory_manager_1_1_pool.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="classarmnn_1_1_ref_memory_manager_1_1_pool-members.xhtml">List of all members</a> </div>
100 <div class="headertitle">
101<div class="title">RefMemoryManager::Pool Class Reference</div> </div>
102</div><!--header-->
103<div class="contents">
104
105<p><code>#include &lt;<a class="el" href="_ref_memory_manager_8hpp_source.xhtml">RefMemoryManager.hpp</a>&gt;</code></p>
106<table class="memberdecls">
107<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
108Public Member Functions</h2></td></tr>
109<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.xhtml#a3661b84570333e6f38f9b8a1ed73b309">Pool</a> (unsigned int numBytes)</td></tr>
110<tr class="separator:a3661b84570333e6f38f9b8a1ed73b309"><td class="memSeparator" colspan="2">&#160;</td></tr>
111<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.xhtml#ad680831415106b724bd752599cfc42c3">~Pool</a> ()</td></tr>
112<tr class="separator:ad680831415106b724bd752599cfc42c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
113<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.xhtml#ab91dc804181f48b0b445ac1299c36c05">Acquire</a> ()</td></tr>
114<tr class="separator:ab91dc804181f48b0b445ac1299c36c05"><td class="memSeparator" colspan="2">&#160;</td></tr>
115<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.xhtml#a94c93747c8daa99d65c2a04c6be0748c">Release</a> ()</td></tr>
116<tr class="separator:a94c93747c8daa99d65c2a04c6be0748c"><td class="memSeparator" colspan="2">&#160;</td></tr>
117<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.xhtml#a6a5db07a5f1fad654e844c52bf702384">GetPointer</a> ()</td></tr>
118<tr class="separator:a6a5db07a5f1fad654e844c52bf702384"><td class="memSeparator" colspan="2">&#160;</td></tr>
119<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.xhtml#ab1d2a47dbdaf1c25da4b2b9534cfd3e5">Reserve</a> (unsigned int numBytes)</td></tr>
120<tr class="separator:ab1d2a47dbdaf1c25da4b2b9534cfd3e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
121</table>
122<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
123<div class="textblock">
124<p class="definition">Definition at line <a class="el" href="_ref_memory_manager_8hpp_source.xhtml#l00033">33</a> of file <a class="el" href="_ref_memory_manager_8hpp_source.xhtml">RefMemoryManager.hpp</a>.</p>
125</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
126<a id="a3661b84570333e6f38f9b8a1ed73b309"></a>
127<h2 class="memtitle"><span class="permalink"><a href="#a3661b84570333e6f38f9b8a1ed73b309">&#9670;&nbsp;</a></span>Pool()</h2>
128
129<div class="memitem">
130<div class="memproto">
131 <table class="memname">
132 <tr>
133 <td class="memname"><a class="el" href="classarmnn_1_1_ref_memory_manager_1_1_pool.xhtml">Pool</a> </td>
134 <td>(</td>
135 <td class="paramtype">unsigned int&#160;</td>
136 <td class="paramname"><em>numBytes</em></td><td>)</td>
137 <td></td>
138 </tr>
139 </table>
140</div><div class="memdoc">
141
142<p class="definition">Definition at line <a class="el" href="_ref_memory_manager_8cpp_source.xhtml#l00063">63</a> of file <a class="el" href="_ref_memory_manager_8cpp_source.xhtml">RefMemoryManager.cpp</a>.</p>
143<div class="fragment"><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; : m_Size(numBytes),</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; m_Pointer(<span class="keyword">nullptr</span>)</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;{}</div></div><!-- fragment -->
144</div>
145</div>
146<a id="ad680831415106b724bd752599cfc42c3"></a>
147<h2 class="memtitle"><span class="permalink"><a href="#ad680831415106b724bd752599cfc42c3">&#9670;&nbsp;</a></span>~Pool()</h2>
148
149<div class="memitem">
150<div class="memproto">
151 <table class="memname">
152 <tr>
153 <td class="memname">~<a class="el" href="classarmnn_1_1_ref_memory_manager_1_1_pool.xhtml">Pool</a> </td>
154 <td>(</td>
155 <td class="paramname"></td><td>)</td>
156 <td></td>
157 </tr>
158 </table>
159</div><div class="memdoc">
160
161<p class="definition">Definition at line <a class="el" href="_ref_memory_manager_8cpp_source.xhtml#l00068">68</a> of file <a class="el" href="_ref_memory_manager_8cpp_source.xhtml">RefMemoryManager.cpp</a>.</p>
162
163<p class="reference">References <a class="el" href="_ref_memory_manager_8cpp_source.xhtml#l00094">RefMemoryManager::Pool::Release()</a>.</p>
164<div class="fragment"><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; <span class="keywordflow">if</span> (m_Pointer)</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; <a class="code" href="classarmnn_1_1_ref_memory_manager_1_1_pool.xhtml#a94c93747c8daa99d65c2a04c6be0748c">Release</a>();</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; }</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;}</div><div class="ttc" id="classarmnn_1_1_ref_memory_manager_1_1_pool_xhtml_a94c93747c8daa99d65c2a04c6be0748c"><div class="ttname"><a href="classarmnn_1_1_ref_memory_manager_1_1_pool.xhtml#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.xhtml#l00094">RefMemoryManager.cpp:94</a></div></div>
165</div><!-- fragment -->
166</div>
167</div>
168<h2 class="groupheader">Member Function Documentation</h2>
169<a id="ab91dc804181f48b0b445ac1299c36c05"></a>
170<h2 class="memtitle"><span class="permalink"><a href="#ab91dc804181f48b0b445ac1299c36c05">&#9670;&nbsp;</a></span>Acquire()</h2>
171
172<div class="memitem">
173<div class="memproto">
174 <table class="memname">
175 <tr>
176 <td class="memname">void Acquire </td>
177 <td>(</td>
178 <td class="paramname"></td><td>)</td>
179 <td></td>
180 </tr>
181 </table>
182</div><div class="memdoc">
183
184<p class="definition">Definition at line <a class="el" href="_ref_memory_manager_8cpp_source.xhtml#l00088">88</a> of file <a class="el" href="_ref_memory_manager_8cpp_source.xhtml">RefMemoryManager.cpp</a>.</p>
185<div class="fragment"><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;{</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; BOOST_ASSERT_MSG(!m_Pointer, <span class="stringliteral">&quot;RefMemoryManager::Pool::Acquire() called when memory already acquired&quot;</span>);</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; m_Pointer = ::operator <span class="keyword">new</span>(size_t(m_Size));</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;}</div></div><!-- fragment -->
186</div>
187</div>
188<a id="a6a5db07a5f1fad654e844c52bf702384"></a>
189<h2 class="memtitle"><span class="permalink"><a href="#a6a5db07a5f1fad654e844c52bf702384">&#9670;&nbsp;</a></span>GetPointer()</h2>
190
191<div class="memitem">
192<div class="memproto">
193 <table class="memname">
194 <tr>
195 <td class="memname">void * GetPointer </td>
196 <td>(</td>
197 <td class="paramname"></td><td>)</td>
198 <td></td>
199 </tr>
200 </table>
201</div><div class="memdoc">
202
203<p class="definition">Definition at line <a class="el" href="_ref_memory_manager_8cpp_source.xhtml#l00076">76</a> of file <a class="el" href="_ref_memory_manager_8cpp_source.xhtml">RefMemoryManager.cpp</a>.</p>
204
205<p class="reference">Referenced by <a class="el" href="_ref_memory_manager_8cpp_source.xhtml#l00042">RefMemoryManager::GetPointer()</a>.</p>
206<div class="fragment"><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;{</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; BOOST_ASSERT_MSG(m_Pointer, <span class="stringliteral">&quot;RefMemoryManager::Pool::GetPointer() called when memory not acquired&quot;</span>);</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="keywordflow">return</span> m_Pointer;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;}</div></div><!-- fragment -->
207</div>
208</div>
209<a id="a94c93747c8daa99d65c2a04c6be0748c"></a>
210<h2 class="memtitle"><span class="permalink"><a href="#a94c93747c8daa99d65c2a04c6be0748c">&#9670;&nbsp;</a></span>Release()</h2>
211
212<div class="memitem">
213<div class="memproto">
214 <table class="memname">
215 <tr>
216 <td class="memname">void Release </td>
217 <td>(</td>
218 <td class="paramname"></td><td>)</td>
219 <td></td>
220 </tr>
221 </table>
222</div><div class="memdoc">
223
224<p class="definition">Definition at line <a class="el" href="_ref_memory_manager_8cpp_source.xhtml#l00094">94</a> of file <a class="el" href="_ref_memory_manager_8cpp_source.xhtml">RefMemoryManager.cpp</a>.</p>
225
226<p class="reference">Referenced by <a class="el" href="_ref_memory_manager_8cpp_source.xhtml#l00068">RefMemoryManager::Pool::~Pool()</a>.</p>
227<div class="fragment"><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;{</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; BOOST_ASSERT_MSG(m_Pointer, <span class="stringliteral">&quot;RefMemoryManager::Pool::Release() called when memory not acquired&quot;</span>);</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; ::operator <span class="keyword">delete</span>(m_Pointer);</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; m_Pointer = <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160;}</div></div><!-- fragment -->
228</div>
229</div>
230<a id="ab1d2a47dbdaf1c25da4b2b9534cfd3e5"></a>
231<h2 class="memtitle"><span class="permalink"><a href="#ab1d2a47dbdaf1c25da4b2b9534cfd3e5">&#9670;&nbsp;</a></span>Reserve()</h2>
232
233<div class="memitem">
234<div class="memproto">
235 <table class="memname">
236 <tr>
237 <td class="memname">void Reserve </td>
238 <td>(</td>
239 <td class="paramtype">unsigned int&#160;</td>
240 <td class="paramname"><em>numBytes</em></td><td>)</td>
241 <td></td>
242 </tr>
243 </table>
244</div><div class="memdoc">
245
246<p class="definition">Definition at line <a class="el" href="_ref_memory_manager_8cpp_source.xhtml#l00082">82</a> of file <a class="el" href="_ref_memory_manager_8cpp_source.xhtml">RefMemoryManager.cpp</a>.</p>
247
248<p class="reference">Referenced by <a class="el" href="_ref_memory_manager_8cpp_source.xhtml#l00020">RefMemoryManager::Manage()</a>.</p>
249<div class="fragment"><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;{</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; BOOST_ASSERT_MSG(!m_Pointer, <span class="stringliteral">&quot;RefMemoryManager::Pool::Reserve() cannot be called after memory acquired&quot;</span>);</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; m_Size = std::max(m_Size, numBytes);</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;}</div></div><!-- fragment -->
250</div>
251</div>
252<hr/>The documentation for this class was generated from the following files:<ul>
253<li>src/backends/reference/<a class="el" href="_ref_memory_manager_8hpp_source.xhtml">RefMemoryManager.hpp</a></li>
254<li>src/backends/reference/<a class="el" href="_ref_memory_manager_8cpp_source.xhtml">RefMemoryManager.cpp</a></li>
255</ul>
256</div><!-- contents -->
257</div><!-- doc-content -->
258<!-- start footer part -->
259<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
260 <ul>
261 <li class="navelem"><a class="el" href="namespacearmnn.xhtml">armnn</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_ref_memory_manager.xhtml">RefMemoryManager</a></li><li class="navelem"><a class="el" href="classarmnn_1_1_ref_memory_manager_1_1_pool.xhtml">Pool</a></li>
262 <li class="footer">Generated on Fri Mar 13 2020 16:09:20 for ArmNN by
263 <a href="http://www.doxygen.org/index.html">
264 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
265 </ul>
266</div>
267</body>
268</html>