arm_compute v18.05
[platform/upstream/armcl.git] / documentation / classarm__compute_1_1_i_lifetime_manager.xhtml
1 <!-- HTML header for doxygen 1.8.9.1-->
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.11"/>
8 <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
9 <title>Compute Library: ILifetimeManager 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 <script type="text/javascript">
18   $(document).ready(initResizable);
19   $(window).load(resizeHeight);
20 </script>
21 <link href="search/search.css" rel="stylesheet" type="text/css"/>
22 <script type="text/javascript" src="search/searchdata.js"></script>
23 <script type="text/javascript" src="search/search.js"></script>
24 <script type="text/javascript">
25   $(document).ready(function() { init_search(); });
26 </script>
27 <script type="text/x-mathjax-config">
28   MathJax.Hub.Config({
29     extensions: ["tex2jax.js"],
30     jax: ["input/TeX","output/HTML-CSS"],
31 });
32 </script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
33 <link href="doxygen.css" rel="stylesheet" type="text/css" />
34 </head>
35 <body>
36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
37 <div id="titlearea">
38 <table cellspacing="0" cellpadding="0">
39  <tbody>
40  <tr style="height: 56px;">
41   <td style="padding-left: 0.5em;">
42    <div id="projectname">Compute Library
43    &#160;<span id="projectnumber">18.05</span>
44    </div>
45   </td>
46  </tr>
47  </tbody>
48 </table>
49 </div>
50 <!-- end header part -->
51 <!-- Generated by Doxygen 1.8.11 -->
52 <script type="text/javascript">
53 var searchBox = new SearchBox("searchBox", "search",false,'Search');
54 </script>
55   <div id="navrow1" class="tabs">
56     <ul class="tablist">
57       <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
58       <li><a href="pages.xhtml"><span>Related&#160;Pages</span></a></li>
59       <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
60       <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
61       <li><a href="files.xhtml"><span>Files</span></a></li>
62       <li>
63         <div id="MSearchBox" class="MSearchBoxInactive">
64         <span class="left">
65           <img id="MSearchSelect" src="search/mag_sel.png"
66                onmouseover="return searchBox.OnSearchSelectShow()"
67                onmouseout="return searchBox.OnSearchSelectHide()"
68                alt=""/>
69           <input type="text" id="MSearchField" value="Search" accesskey="S"
70                onfocus="searchBox.OnSearchFieldFocus(true)" 
71                onblur="searchBox.OnSearchFieldFocus(false)" 
72                onkeyup="searchBox.OnSearchFieldChange(event)"/>
73           </span><span class="right">
74             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
75           </span>
76         </div>
77       </li>
78     </ul>
79   </div>
80   <div id="navrow2" class="tabs2">
81     <ul class="tablist">
82       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
83       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
84       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
85       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
86     </ul>
87   </div>
88 </div><!-- top -->
89 <div id="side-nav" class="ui-resizable side-nav-resizable">
90   <div id="nav-tree">
91     <div id="nav-tree-contents">
92       <div id="nav-sync" class="sync"></div>
93     </div>
94   </div>
95   <div id="splitbar" style="-moz-user-select:none;" 
96        class="ui-resizable-handle">
97   </div>
98 </div>
99 <script type="text/javascript">
100 $(document).ready(function(){initNavTree('classarm__compute_1_1_i_lifetime_manager.xhtml','');});
101 </script>
102 <div id="doc-content">
103 <!-- window showing the filter options -->
104 <div id="MSearchSelectWindow"
105      onmouseover="return searchBox.OnSearchSelectShow()"
106      onmouseout="return searchBox.OnSearchSelectHide()"
107      onkeydown="return searchBox.OnSearchSelectKey(event)">
108 </div>
109
110 <!-- iframe showing the search results (closed by default) -->
111 <div id="MSearchResultsWindow">
112 <iframe src="javascript:void(0)" frameborder="0" 
113         name="MSearchResults" id="MSearchResults">
114 </iframe>
115 </div>
116
117 <div class="header">
118   <div class="summary">
119 <a href="#pub-methods">Public Member Functions</a>  </div>
120   <div class="headertitle">
121 <div class="title">ILifetimeManager Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
122 </div><!--header-->
123 <div class="contents">
124
125 <p>Interface for managing the lifetime of objects.  
126  <a href="classarm__compute_1_1_i_lifetime_manager.xhtml#details">More...</a></p>
127
128 <p><code>#include &lt;<a class="el" href="_i_lifetime_manager_8h_source.xhtml">ILifetimeManager.h</a>&gt;</code></p>
129 <table class="memberdecls">
130 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
131 Public Member Functions</h2></td></tr>
132 <tr class="memitem:ac6e5bab9415fdb1e8c4ad0d4d70227e9"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_lifetime_manager.xhtml#ac6e5bab9415fdb1e8c4ad0d4d70227e9">~ILifetimeManager</a> ()=default</td></tr>
133 <tr class="memdesc:ac6e5bab9415fdb1e8c4ad0d4d70227e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual Destructor.  <a href="#ac6e5bab9415fdb1e8c4ad0d4d70227e9">More...</a><br /></td></tr>
134 <tr class="separator:ac6e5bab9415fdb1e8c4ad0d4d70227e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
135 <tr class="memitem:af9aed2d52d9469aa2a49f8c7ece1f082"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_lifetime_manager.xhtml#af9aed2d52d9469aa2a49f8c7ece1f082">register_group</a> (<a class="el" href="classarm__compute_1_1_i_memory_group.xhtml">IMemoryGroup</a> *group)=0</td></tr>
136 <tr class="memdesc:af9aed2d52d9469aa2a49f8c7ece1f082"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers a group to the lifetime manager and assigns a group id.  <a href="#af9aed2d52d9469aa2a49f8c7ece1f082">More...</a><br /></td></tr>
137 <tr class="separator:af9aed2d52d9469aa2a49f8c7ece1f082"><td class="memSeparator" colspan="2">&#160;</td></tr>
138 <tr class="memitem:ad8645b2be72197ce554268c1dc704849"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_lifetime_manager.xhtml#ad8645b2be72197ce554268c1dc704849">start_lifetime</a> (void *obj)=0</td></tr>
139 <tr class="memdesc:ad8645b2be72197ce554268c1dc704849"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers and starts lifetime of an object.  <a href="#ad8645b2be72197ce554268c1dc704849">More...</a><br /></td></tr>
140 <tr class="separator:ad8645b2be72197ce554268c1dc704849"><td class="memSeparator" colspan="2">&#160;</td></tr>
141 <tr class="memitem:a26f8b589160eda2d5fd05e920639e75b"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_lifetime_manager.xhtml#a26f8b589160eda2d5fd05e920639e75b">end_lifetime</a> (void *obj, void **handle, size_t size)=0</td></tr>
142 <tr class="memdesc:a26f8b589160eda2d5fd05e920639e75b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ends lifetime of an object.  <a href="#a26f8b589160eda2d5fd05e920639e75b">More...</a><br /></td></tr>
143 <tr class="separator:a26f8b589160eda2d5fd05e920639e75b"><td class="memSeparator" colspan="2">&#160;</td></tr>
144 <tr class="memitem:a1bb5a543056e56ff45f413040d316312"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_lifetime_manager.xhtml#a1bb5a543056e56ff45f413040d316312">are_all_finalized</a> () const =0</td></tr>
145 <tr class="memdesc:a1bb5a543056e56ff45f413040d316312"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if the lifetime of the registered object is complete.  <a href="#a1bb5a543056e56ff45f413040d316312">More...</a><br /></td></tr>
146 <tr class="separator:a1bb5a543056e56ff45f413040d316312"><td class="memSeparator" colspan="2">&#160;</td></tr>
147 <tr class="memitem:ab14145b312cf5bf366bc9d7c143f85a1"><td class="memItemLeft" align="right" valign="top">virtual std::unique_ptr&lt; <a class="el" href="classarm__compute_1_1_i_memory_pool.xhtml">IMemoryPool</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_lifetime_manager.xhtml#ab14145b312cf5bf366bc9d7c143f85a1">create_pool</a> (<a class="el" href="classarm__compute_1_1_i_allocator.xhtml">IAllocator</a> *allocator)=0</td></tr>
148 <tr class="memdesc:ab14145b312cf5bf366bc9d7c143f85a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a memory pool depending on the memory requirements.  <a href="#ab14145b312cf5bf366bc9d7c143f85a1">More...</a><br /></td></tr>
149 <tr class="separator:ab14145b312cf5bf366bc9d7c143f85a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
150 <tr class="memitem:a2f4d2a4f6dd83e9ad1578450c31357db"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespacearm__compute.xhtml#af0a4d6be70322c742c12da1edccbb74d">MappingType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_lifetime_manager.xhtml#a2f4d2a4f6dd83e9ad1578450c31357db">mapping_type</a> () const =0</td></tr>
151 <tr class="memdesc:a2f4d2a4f6dd83e9ad1578450c31357db"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the type of mappings that the lifetime manager returns.  <a href="#a2f4d2a4f6dd83e9ad1578450c31357db">More...</a><br /></td></tr>
152 <tr class="separator:a2f4d2a4f6dd83e9ad1578450c31357db"><td class="memSeparator" colspan="2">&#160;</td></tr>
153 </table>
154 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
155 <div class="textblock"><p>Interface for managing the lifetime of objects. </p>
156
157 <p>Definition at line <a class="el" href="_i_lifetime_manager_8h_source.xhtml#l00039">39</a> of file <a class="el" href="_i_lifetime_manager_8h_source.xhtml">ILifetimeManager.h</a>.</p>
158 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
159 <a class="anchor" id="ac6e5bab9415fdb1e8c4ad0d4d70227e9"></a>
160 <div class="memitem">
161 <div class="memproto">
162 <table class="mlabels">
163   <tr>
164   <td class="mlabels-left">
165       <table class="memname">
166         <tr>
167           <td class="memname">virtual ~<a class="el" href="classarm__compute_1_1_i_lifetime_manager.xhtml">ILifetimeManager</a> </td>
168           <td>(</td>
169           <td class="paramname"></td><td>)</td>
170           <td></td>
171         </tr>
172       </table>
173   </td>
174   <td class="mlabels-right">
175 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span>  </td>
176   </tr>
177 </table>
178 </div><div class="memdoc">
179
180 <p>Virtual Destructor. </p>
181
182 </div>
183 </div>
184 <h2 class="groupheader">Member Function Documentation</h2>
185 <a class="anchor" id="a1bb5a543056e56ff45f413040d316312"></a>
186 <div class="memitem">
187 <div class="memproto">
188 <table class="mlabels">
189   <tr>
190   <td class="mlabels-left">
191       <table class="memname">
192         <tr>
193           <td class="memname">virtual bool are_all_finalized </td>
194           <td>(</td>
195           <td class="paramname"></td><td>)</td>
196           <td> const</td>
197         </tr>
198       </table>
199   </td>
200   <td class="mlabels-right">
201 <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
202   </tr>
203 </table>
204 </div><div class="memdoc">
205
206 <p>Checks if the lifetime of the registered object is complete. </p>
207 <dl class="section return"><dt>Returns</dt><dd>True if all object lifetimes are finalized else false. </dd></dl>
208
209 <p>Implemented in <a class="el" href="classarm__compute_1_1_i_simple_lifetime_manager.xhtml#aa849cbaa03d63911dbbedc830f22943d">ISimpleLifetimeManager</a>.</p>
210
211 </div>
212 </div>
213 <a class="anchor" id="ab14145b312cf5bf366bc9d7c143f85a1"></a>
214 <div class="memitem">
215 <div class="memproto">
216 <table class="mlabels">
217   <tr>
218   <td class="mlabels-left">
219       <table class="memname">
220         <tr>
221           <td class="memname">virtual std::unique_ptr&lt;<a class="el" href="classarm__compute_1_1_i_memory_pool.xhtml">IMemoryPool</a>&gt; create_pool </td>
222           <td>(</td>
223           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_allocator.xhtml">IAllocator</a> *&#160;</td>
224           <td class="paramname"><em>allocator</em></td><td>)</td>
225           <td></td>
226         </tr>
227       </table>
228   </td>
229   <td class="mlabels-right">
230 <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
231   </tr>
232 </table>
233 </div><div class="memdoc">
234
235 <p>Creates a memory pool depending on the memory requirements. </p>
236 <dl class="params"><dt>Parameters</dt><dd>
237   <table class="params">
238     <tr><td class="paramname">allocator</td><td><a class="el" href="classarm__compute_1_1_allocator.xhtml" title="Default malloc allocator implementation. ">Allocator</a> to use</td></tr>
239   </table>
240   </dd>
241 </dl>
242 <dl class="section return"><dt>Returns</dt><dd>A memory pool </dd></dl>
243
244 <p>Implemented in <a class="el" href="classarm__compute_1_1_offset_lifetime_manager.xhtml#ab2463b51d72b8fefe2460d0c8ee0b685">OffsetLifetimeManager</a>, and <a class="el" href="classarm__compute_1_1_blob_lifetime_manager.xhtml#ab2463b51d72b8fefe2460d0c8ee0b685">BlobLifetimeManager</a>.</p>
245
246 </div>
247 </div>
248 <a class="anchor" id="a26f8b589160eda2d5fd05e920639e75b"></a>
249 <div class="memitem">
250 <div class="memproto">
251 <table class="mlabels">
252   <tr>
253   <td class="mlabels-left">
254       <table class="memname">
255         <tr>
256           <td class="memname">virtual void end_lifetime </td>
257           <td>(</td>
258           <td class="paramtype">void *&#160;</td>
259           <td class="paramname"><em>obj</em>, </td>
260         </tr>
261         <tr>
262           <td class="paramkey"></td>
263           <td></td>
264           <td class="paramtype">void **&#160;</td>
265           <td class="paramname"><em>handle</em>, </td>
266         </tr>
267         <tr>
268           <td class="paramkey"></td>
269           <td></td>
270           <td class="paramtype">size_t&#160;</td>
271           <td class="paramname"><em>size</em>&#160;</td>
272         </tr>
273         <tr>
274           <td></td>
275           <td>)</td>
276           <td></td><td></td>
277         </tr>
278       </table>
279   </td>
280   <td class="mlabels-right">
281 <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
282   </tr>
283 </table>
284 </div><div class="memdoc">
285
286 <p>Ends lifetime of an object. </p>
287 <dl class="params"><dt>Parameters</dt><dd>
288   <table class="params">
289     <tr><td class="paramdir">[in]</td><td class="paramname">obj</td><td>Object </td></tr>
290     <tr><td class="paramdir">[in]</td><td class="paramname">handle</td><td><a class="el" href="classarm__compute_1_1_memory.xhtml" title="CPU implementation of memory object. ">Memory</a> handle of the object </td></tr>
291     <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Size of the given object at given time </td></tr>
292   </table>
293   </dd>
294 </dl>
295
296 <p>Implemented in <a class="el" href="classarm__compute_1_1_i_simple_lifetime_manager.xhtml#ace97b0b117e5de5086cf93bcd61530f6">ISimpleLifetimeManager</a>.</p>
297
298 </div>
299 </div>
300 <a class="anchor" id="a2f4d2a4f6dd83e9ad1578450c31357db"></a>
301 <div class="memitem">
302 <div class="memproto">
303 <table class="mlabels">
304   <tr>
305   <td class="mlabels-left">
306       <table class="memname">
307         <tr>
308           <td class="memname">virtual <a class="el" href="namespacearm__compute.xhtml#af0a4d6be70322c742c12da1edccbb74d">MappingType</a> mapping_type </td>
309           <td>(</td>
310           <td class="paramname"></td><td>)</td>
311           <td> const</td>
312         </tr>
313       </table>
314   </td>
315   <td class="mlabels-right">
316 <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
317   </tr>
318 </table>
319 </div><div class="memdoc">
320
321 <p>Returns the type of mappings that the lifetime manager returns. </p>
322 <dl class="section return"><dt>Returns</dt><dd>Mapping type of the lifetime manager </dd></dl>
323
324 <p>Implemented in <a class="el" href="classarm__compute_1_1_offset_lifetime_manager.xhtml#aafd3aa9650b1e764b085c76c4faa4cd5">OffsetLifetimeManager</a>, and <a class="el" href="classarm__compute_1_1_blob_lifetime_manager.xhtml#aafd3aa9650b1e764b085c76c4faa4cd5">BlobLifetimeManager</a>.</p>
325
326 </div>
327 </div>
328 <a class="anchor" id="af9aed2d52d9469aa2a49f8c7ece1f082"></a>
329 <div class="memitem">
330 <div class="memproto">
331 <table class="mlabels">
332   <tr>
333   <td class="mlabels-left">
334       <table class="memname">
335         <tr>
336           <td class="memname">virtual void register_group </td>
337           <td>(</td>
338           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_memory_group.xhtml">IMemoryGroup</a> *&#160;</td>
339           <td class="paramname"><em>group</em></td><td>)</td>
340           <td></td>
341         </tr>
342       </table>
343   </td>
344   <td class="mlabels-right">
345 <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
346   </tr>
347 </table>
348 </div><div class="memdoc">
349
350 <p>Registers a group to the lifetime manager and assigns a group id. </p>
351 <dl class="params"><dt>Parameters</dt><dd>
352   <table class="params">
353     <tr><td class="paramdir">[in]</td><td class="paramname">group</td><td>The group id of the group </td></tr>
354   </table>
355   </dd>
356 </dl>
357
358 <p>Implemented in <a class="el" href="classarm__compute_1_1_i_simple_lifetime_manager.xhtml#a93fc2c6a7ebb5d8f44c67d492347d054">ISimpleLifetimeManager</a>.</p>
359
360 </div>
361 </div>
362 <a class="anchor" id="ad8645b2be72197ce554268c1dc704849"></a>
363 <div class="memitem">
364 <div class="memproto">
365 <table class="mlabels">
366   <tr>
367   <td class="mlabels-left">
368       <table class="memname">
369         <tr>
370           <td class="memname">virtual void start_lifetime </td>
371           <td>(</td>
372           <td class="paramtype">void *&#160;</td>
373           <td class="paramname"><em>obj</em></td><td>)</td>
374           <td></td>
375         </tr>
376       </table>
377   </td>
378   <td class="mlabels-right">
379 <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
380   </tr>
381 </table>
382 </div><div class="memdoc">
383
384 <p>Registers and starts lifetime of an object. </p>
385 <dl class="params"><dt>Parameters</dt><dd>
386   <table class="params">
387     <tr><td class="paramdir">[in]</td><td class="paramname">obj</td><td>Object to register </td></tr>
388   </table>
389   </dd>
390 </dl>
391
392 <p>Implemented in <a class="el" href="classarm__compute_1_1_i_simple_lifetime_manager.xhtml#af9e6669812c674ab36a3cb3e592d5efe">ISimpleLifetimeManager</a>.</p>
393
394 </div>
395 </div>
396 <hr/>The documentation for this class was generated from the following file:<ul>
397 <li>arm_compute/runtime/<a class="el" href="_i_lifetime_manager_8h_source.xhtml">ILifetimeManager.h</a></li>
398 </ul>
399 </div><!-- contents -->
400 </div><!-- doc-content -->
401 <!-- start footer part -->
402 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
403   <ul>
404     <li class="navelem"><a class="el" href="namespacearm__compute.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="classarm__compute_1_1_i_lifetime_manager.xhtml">ILifetimeManager</a></li>
405     <li class="footer">Generated on Wed May 23 2018 11:36:42 for Compute Library by
406     <a href="http://www.doxygen.org/index.html">
407     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
408   </ul>
409 </div>
410 </body>
411 </html>