documentation/classarm__compute_1_1_i_pool_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: IPoolManager 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.02</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_pool_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">IPoolManager 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 manager interface.
 126  <a href="classarm__compute_1_1_i_pool_manager.xhtml#details">More...</a></p>
 127
 128 <p><code>#include &lt;<a class="el" href="_i_pool_manager_8h_source.xhtml">IPoolManager.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:a772884b3ff6b2c22444ba13616d9d13a"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_pool_manager.xhtml#a772884b3ff6b2c22444ba13616d9d13a">~IPoolManager</a> ()=default</td></tr>
 133 <tr class="memdesc:a772884b3ff6b2c22444ba13616d9d13a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default virtual destructor.  <a href="#a772884b3ff6b2c22444ba13616d9d13a">More...</a><br /></td></tr>
 134 <tr class="separator:a772884b3ff6b2c22444ba13616d9d13a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 135 <tr class="memitem:abab838bc75d6ecf91c0c278fff0e3d6f"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classarm__compute_1_1_i_memory_pool.xhtml">IMemoryPool</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_pool_manager.xhtml#abab838bc75d6ecf91c0c278fff0e3d6f">lock_pool</a> ()=0</td></tr>
 136 <tr class="memdesc:abab838bc75d6ecf91c0c278fff0e3d6f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Locks a pool for execution.  <a href="#abab838bc75d6ecf91c0c278fff0e3d6f">More...</a><br /></td></tr>
 137 <tr class="separator:abab838bc75d6ecf91c0c278fff0e3d6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 138 <tr class="memitem:af7d957b92062705c6273d8d56eda2c8e"><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_pool_manager.xhtml#af7d957b92062705c6273d8d56eda2c8e">unlock_pool</a> (<a class="el" href="classarm__compute_1_1_i_memory_pool.xhtml">IMemoryPool</a> *pool)=0</td></tr>
 139 <tr class="memdesc:af7d957b92062705c6273d8d56eda2c8e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Releases memory pool.  <a href="#af7d957b92062705c6273d8d56eda2c8e">More...</a><br /></td></tr>
 140 <tr class="separator:af7d957b92062705c6273d8d56eda2c8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 141 <tr class="memitem:af5ecacf4a9d67777dacc2bf917a52db4"><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_pool_manager.xhtml#af5ecacf4a9d67777dacc2bf917a52db4">register_pool</a> (std::unique_ptr&lt; <a class="el" href="classarm__compute_1_1_i_memory_pool.xhtml">IMemoryPool</a> &gt; pool)=0</td></tr>
 142 <tr class="memdesc:af5ecacf4a9d67777dacc2bf917a52db4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register pool to be managed by the pool.  <a href="#af5ecacf4a9d67777dacc2bf917a52db4">More...</a><br /></td></tr>
 143 <tr class="separator:af5ecacf4a9d67777dacc2bf917a52db4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 </table>
 145 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 146 <div class="textblock"><p><a class="el" href="classarm__compute_1_1_memory.xhtml" title="CPU implementation of memory object. ">Memory</a> pool manager interface. </p>
 147
 148 <p>Definition at line <a class="el" href="_i_pool_manager_8h_source.xhtml#l00034">34</a> of file <a class="el" href="_i_pool_manager_8h_source.xhtml">IPoolManager.h</a>.</p>
 149 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 150 <a class="anchor" id="a772884b3ff6b2c22444ba13616d9d13a"></a>
 151 <div class="memitem">
 152 <div class="memproto">
 153 <table class="mlabels">
 154   <tr>
 155   <td class="mlabels-left">
 156       <table class="memname">
 157         <tr>
 158           <td class="memname">virtual ~<a class="el" href="classarm__compute_1_1_i_pool_manager.xhtml">IPoolManager</a> </td>
 159           <td>(</td>
 160           <td class="paramname"></td><td>)</td>
 161           <td></td>
 162         </tr>
 163       </table>
 164   </td>
 165   <td class="mlabels-right">
 166 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span>  </td>
 167   </tr>
 168 </table>
 169 </div><div class="memdoc">
 170
 171 <p>Default virtual destructor. </p>
 172
 173 </div>
 174 </div>
 175 <h2 class="groupheader">Member Function Documentation</h2>
 176 <a class="anchor" id="abab838bc75d6ecf91c0c278fff0e3d6f"></a>
 177 <div class="memitem">
 178 <div class="memproto">
 179 <table class="mlabels">
 180   <tr>
 181   <td class="mlabels-left">
 182       <table class="memname">
 183         <tr>
 184           <td class="memname">virtual <a class="el" href="classarm__compute_1_1_i_memory_pool.xhtml">IMemoryPool</a>* lock_pool </td>
 185           <td>(</td>
 186           <td class="paramname"></td><td>)</td>
 187           <td></td>
 188         </tr>
 189       </table>
 190   </td>
 191   <td class="mlabels-right">
 192 <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
 193   </tr>
 194 </table>
 195 </div><div class="memdoc">
 196
 197 <p>Locks a pool for execution. </p>
 198 <dl class="section return"><dt>Returns</dt><dd>Locked pool that workload will be mapped on </dd></dl>
 199
 200 <p>Implemented in <a class="el" href="classarm__compute_1_1_pool_manager.xhtml#a942998df91ceab307b20b89f0c4479c7">PoolManager</a>.</p>
 201
 202 </div>
 203 </div>
 204 <a class="anchor" id="af5ecacf4a9d67777dacc2bf917a52db4"></a>
 205 <div class="memitem">
 206 <div class="memproto">
 207 <table class="mlabels">
 208   <tr>
 209   <td class="mlabels-left">
 210       <table class="memname">
 211         <tr>
 212           <td class="memname">virtual void register_pool </td>
 213           <td>(</td>
 214           <td class="paramtype">std::unique_ptr&lt; <a class="el" href="classarm__compute_1_1_i_memory_pool.xhtml">IMemoryPool</a> &gt;&#160;</td>
 215           <td class="paramname"><em>pool</em></td><td>)</td>
 216           <td></td>
 217         </tr>
 218       </table>
 219   </td>
 220   <td class="mlabels-right">
 221 <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
 222   </tr>
 223 </table>
 224 </div><div class="memdoc">
 225
 226 <p>Register pool to be managed by the pool. </p>
 227 <dl class="section note"><dt>Note</dt><dd>Ownership of the pools is being transferred to the pool manager</dd></dl>
 228 <dl class="params"><dt>Parameters</dt><dd>
 229   <table class="params">
 230     <tr><td class="paramdir">[in]</td><td class="paramname">pool</td><td>Pool to be managed </td></tr>
 231   </table>
 232   </dd>
 233 </dl>
 234
 235 <p>Implemented in <a class="el" href="classarm__compute_1_1_pool_manager.xhtml#a40713b55ad2d6ddb4ccead1f9e535a05">PoolManager</a>.</p>
 236
 237 </div>
 238 </div>
 239 <a class="anchor" id="af7d957b92062705c6273d8d56eda2c8e"></a>
 240 <div class="memitem">
 241 <div class="memproto">
 242 <table class="mlabels">
 243   <tr>
 244   <td class="mlabels-left">
 245       <table class="memname">
 246         <tr>
 247           <td class="memname">virtual void unlock_pool </td>
 248           <td>(</td>
 249           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_memory_pool.xhtml">IMemoryPool</a> *&#160;</td>
 250           <td class="paramname"><em>pool</em></td><td>)</td>
 251           <td></td>
 252         </tr>
 253       </table>
 254   </td>
 255   <td class="mlabels-right">
 256 <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
 257   </tr>
 258 </table>
 259 </div><div class="memdoc">
 260
 261 <p>Releases memory pool. </p>
 262 <dl class="params"><dt>Parameters</dt><dd>
 263   <table class="params">
 264     <tr><td class="paramdir">[in]</td><td class="paramname">pool</td><td><a class="el" href="classarm__compute_1_1_memory.xhtml" title="CPU implementation of memory object. ">Memory</a> pool to release </td></tr>
 265   </table>
 266   </dd>
 267 </dl>
 268
 269 <p>Implemented in <a class="el" href="classarm__compute_1_1_pool_manager.xhtml#a7520a565247b2aa3c13dcc4d9332cc4a">PoolManager</a>.</p>
 270
 271 </div>
 272 </div>
 273 <hr/>The documentation for this class was generated from the following file:<ul>
 274 <li>arm_compute/runtime/<a class="el" href="_i_pool_manager_8h_source.xhtml">IPoolManager.h</a></li>
 275 </ul>
 276 </div><!-- contents -->
 277 </div><!-- doc-content -->
 278 <!-- start footer part -->
 279 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 280   <ul>
 281     <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_pool_manager.xhtml">IPoolManager</a></li>
 282     <li class="footer">Generated on Thu Feb 22 2018 15:45:24 for Compute Library by
 283     <a href="http://www.doxygen.org/index.html">
 284     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
 285   </ul>
 286 </div>
 287 </body>
 288 </html>