documentation/classarm__compute_1_1_i_memory_pool.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: IMemoryPool 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.03</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_memory_pool.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">IMemoryPool Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
 122 </div><!--header-->
 123 <div class="contents">
 124
 125 <p><a class="el" href="classarm__compute_1_1_memory.xhtml" title="CPU implementation of memory object. ">Memory</a> Pool Inteface.
 126  <a href="classarm__compute_1_1_i_memory_pool.xhtml#details">More...</a></p>
 127
 128 <p><code>#include &lt;<a class="el" href="_i_memory_pool_8h_source.xhtml">IMemoryPool.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:a81f863b710d9f96cc867a0755be73ab0"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_memory_pool.xhtml#a81f863b710d9f96cc867a0755be73ab0">~IMemoryPool</a> ()=default</td></tr>
 133 <tr class="memdesc:a81f863b710d9f96cc867a0755be73ab0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default Virtual Destructor.  <a href="#a81f863b710d9f96cc867a0755be73ab0">More...</a><br /></td></tr>
 134 <tr class="separator:a81f863b710d9f96cc867a0755be73ab0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 135 <tr class="memitem:a064f06f20fc565efbb2227aac827c12f"><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_memory_pool.xhtml#a064f06f20fc565efbb2227aac827c12f">acquire</a> (<a class="el" href="namespacearm__compute.xhtml#a762c7da7319adcc433b3ac7a67e18ed5">MemoryMappings</a> &amp;handles)=0</td></tr>
 136 <tr class="memdesc:a064f06f20fc565efbb2227aac827c12f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets occupant to the memory pool.  <a href="#a064f06f20fc565efbb2227aac827c12f">More...</a><br /></td></tr>
 137 <tr class="separator:a064f06f20fc565efbb2227aac827c12f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 138 <tr class="memitem:ab9d340d42cc3ec933f5da369f1f808bb"><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_memory_pool.xhtml#ab9d340d42cc3ec933f5da369f1f808bb">release</a> (<a class="el" href="namespacearm__compute.xhtml#a762c7da7319adcc433b3ac7a67e18ed5">MemoryMappings</a> &amp;handles)=0</td></tr>
 139 <tr class="memdesc:ab9d340d42cc3ec933f5da369f1f808bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Releases a memory block.  <a href="#ab9d340d42cc3ec933f5da369f1f808bb">More...</a><br /></td></tr>
 140 <tr class="separator:ab9d340d42cc3ec933f5da369f1f808bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 141 <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_memory_pool.xhtml#a2f4d2a4f6dd83e9ad1578450c31357db">mapping_type</a> () const =0</td></tr>
 142 <tr class="memdesc:a2f4d2a4f6dd83e9ad1578450c31357db"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the mapping types that this pool accepts.  <a href="#a2f4d2a4f6dd83e9ad1578450c31357db">More...</a><br /></td></tr>
 143 <tr class="separator:a2f4d2a4f6dd83e9ad1578450c31357db"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <tr class="memitem:af6c6c5e675fab42e482d11d02df2a79e"><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_memory_pool.xhtml#af6c6c5e675fab42e482d11d02df2a79e">duplicate</a> ()=0</td></tr>
 145 <tr class="memdesc:af6c6c5e675fab42e482d11d02df2a79e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Duplicates the existing memory pool.  <a href="#af6c6c5e675fab42e482d11d02df2a79e">More...</a><br /></td></tr>
 146 <tr class="separator:af6c6c5e675fab42e482d11d02df2a79e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 </table>
 148 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 149 <div class="textblock"><p><a class="el" href="classarm__compute_1_1_memory.xhtml" title="CPU implementation of memory object. ">Memory</a> Pool Inteface. </p>
 150
 151 <p>Definition at line <a class="el" href="_i_memory_pool_8h_source.xhtml#l00037">37</a> of file <a class="el" href="_i_memory_pool_8h_source.xhtml">IMemoryPool.h</a>.</p>
 152 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 153 <a class="anchor" id="a81f863b710d9f96cc867a0755be73ab0"></a>
 154 <div class="memitem">
 155 <div class="memproto">
 156 <table class="mlabels">
 157   <tr>
 158   <td class="mlabels-left">
 159       <table class="memname">
 160         <tr>
 161           <td class="memname">virtual ~<a class="el" href="classarm__compute_1_1_i_memory_pool.xhtml">IMemoryPool</a> </td>
 162           <td>(</td>
 163           <td class="paramname"></td><td>)</td>
 164           <td></td>
 165         </tr>
 166       </table>
 167   </td>
 168   <td class="mlabels-right">
 169 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span>  </td>
 170   </tr>
 171 </table>
 172 </div><div class="memdoc">
 173
 174 <p>Default Virtual Destructor. </p>
 175
 176 </div>
 177 </div>
 178 <h2 class="groupheader">Member Function Documentation</h2>
 179 <a class="anchor" id="a064f06f20fc565efbb2227aac827c12f"></a>
 180 <div class="memitem">
 181 <div class="memproto">
 182 <table class="mlabels">
 183   <tr>
 184   <td class="mlabels-left">
 185       <table class="memname">
 186         <tr>
 187           <td class="memname">virtual void acquire </td>
 188           <td>(</td>
 189           <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#a762c7da7319adcc433b3ac7a67e18ed5">MemoryMappings</a> &amp;&#160;</td>
 190           <td class="paramname"><em>handles</em></td><td>)</td>
 191           <td></td>
 192         </tr>
 193       </table>
 194   </td>
 195   <td class="mlabels-right">
 196 <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
 197   </tr>
 198 </table>
 199 </div><div class="memdoc">
 200
 201 <p>Sets occupant to the memory pool. </p>
 202 <dl class="params"><dt>Parameters</dt><dd>
 203   <table class="params">
 204     <tr><td class="paramdir">[in]</td><td class="paramname">handles</td><td>A vector of pairs (handle, index) </td></tr>
 205   </table>
 206   </dd>
 207 </dl>
 208
 209 <p>Implemented in <a class="el" href="classarm__compute_1_1_blob_memory_pool.xhtml#a93acd60164fb91350b542af0200410a6">BlobMemoryPool</a>, and <a class="el" href="classarm__compute_1_1_offset_memory_pool.xhtml#a93acd60164fb91350b542af0200410a6">OffsetMemoryPool</a>.</p>
 210
 211 </div>
 212 </div>
 213 <a class="anchor" id="af6c6c5e675fab42e482d11d02df2a79e"></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; duplicate </td>
 222           <td>(</td>
 223           <td class="paramname"></td><td>)</td>
 224           <td></td>
 225         </tr>
 226       </table>
 227   </td>
 228   <td class="mlabels-right">
 229 <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
 230   </tr>
 231 </table>
 232 </div><div class="memdoc">
 233
 234 <p>Duplicates the existing memory pool. </p>
 235 <dl class="section return"><dt>Returns</dt><dd>A duplicate of the existing pool </dd></dl>
 236
 237 <p>Implemented in <a class="el" href="classarm__compute_1_1_blob_memory_pool.xhtml#aceea990dd135afa94795f0ad3a532df5">BlobMemoryPool</a>, and <a class="el" href="classarm__compute_1_1_offset_memory_pool.xhtml#aceea990dd135afa94795f0ad3a532df5">OffsetMemoryPool</a>.</p>
 238
 239 </div>
 240 </div>
 241 <a class="anchor" id="a2f4d2a4f6dd83e9ad1578450c31357db"></a>
 242 <div class="memitem">
 243 <div class="memproto">
 244 <table class="mlabels">
 245   <tr>
 246   <td class="mlabels-left">
 247       <table class="memname">
 248         <tr>
 249           <td class="memname">virtual <a class="el" href="namespacearm__compute.xhtml#af0a4d6be70322c742c12da1edccbb74d">MappingType</a> mapping_type </td>
 250           <td>(</td>
 251           <td class="paramname"></td><td>)</td>
 252           <td> const</td>
 253         </tr>
 254       </table>
 255   </td>
 256   <td class="mlabels-right">
 257 <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
 258   </tr>
 259 </table>
 260 </div><div class="memdoc">
 261
 262 <p>Returns the mapping types that this pool accepts. </p>
 263 <dl class="section return"><dt>Returns</dt><dd>the mapping type of the memory </dd></dl>
 264
 265 <p>Implemented in <a class="el" href="classarm__compute_1_1_blob_memory_pool.xhtml#aafd3aa9650b1e764b085c76c4faa4cd5">BlobMemoryPool</a>, and <a class="el" href="classarm__compute_1_1_offset_memory_pool.xhtml#aafd3aa9650b1e764b085c76c4faa4cd5">OffsetMemoryPool</a>.</p>
 266
 267 </div>
 268 </div>
 269 <a class="anchor" id="ab9d340d42cc3ec933f5da369f1f808bb"></a>
 270 <div class="memitem">
 271 <div class="memproto">
 272 <table class="mlabels">
 273   <tr>
 274   <td class="mlabels-left">
 275       <table class="memname">
 276         <tr>
 277           <td class="memname">virtual void release </td>
 278           <td>(</td>
 279           <td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#a762c7da7319adcc433b3ac7a67e18ed5">MemoryMappings</a> &amp;&#160;</td>
 280           <td class="paramname"><em>handles</em></td><td>)</td>
 281           <td></td>
 282         </tr>
 283       </table>
 284   </td>
 285   <td class="mlabels-right">
 286 <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
 287   </tr>
 288 </table>
 289 </div><div class="memdoc">
 290
 291 <p>Releases a memory block. </p>
 292 <dl class="params"><dt>Parameters</dt><dd>
 293   <table class="params">
 294     <tr><td class="paramdir">[in]</td><td class="paramname">handles</td><td>A vector containing a pair of handles and indices </td></tr>
 295   </table>
 296   </dd>
 297 </dl>
 298
 299 <p>Implemented in <a class="el" href="classarm__compute_1_1_blob_memory_pool.xhtml#af47c67ca8d1961b09543879bb734e8be">BlobMemoryPool</a>, and <a class="el" href="classarm__compute_1_1_offset_memory_pool.xhtml#af47c67ca8d1961b09543879bb734e8be">OffsetMemoryPool</a>.</p>
 300
 301 <p>Referenced by <a class="el" href="_memory_group_base_8h_source.xhtml#l00136">MemoryGroupBase&lt; TensorType &gt;::release()</a>.</p>
 302
 303 </div>
 304 </div>
 305 <hr/>The documentation for this class was generated from the following file:<ul>
 306 <li>arm_compute/runtime/<a class="el" href="_i_memory_pool_8h_source.xhtml">IMemoryPool.h</a></li>
 307 </ul>
 308 </div><!-- contents -->
 309 </div><!-- doc-content -->
 310 <!-- start footer part -->
 311 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 312   <ul>
 313     <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_memory_pool.xhtml">IMemoryPool</a></li>
 314     <li class="footer">Generated on Fri Mar 2 2018 12:37:58 for Compute Library by
 315     <a href="http://www.doxygen.org/index.html">
 316     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
 317   </ul>
 318 </div>
 319 </body>
 320 </html>