blob: 19af74552182f5bf945a2214bae18736a34ece6d [file] [log] [blame]
<!-- HTML header for doxygen 1.8.15-->
<!-- Remember to use version doxygen 1.8.15 +-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
<title>Compute Library: BlobMemoryPool Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="stylesheet.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<img alt="Compute Library" src="https://raw.githubusercontent.com/ARM-software/ComputeLibrary/gh-pages/ACL_logo.png" style="max-width: 100%;margin-top: 15px;margin-left: 10px"/>
<td style="padding-left: 0.5em;">
<div id="projectname">
&#160;<span id="projectnumber">20.02.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classarm__compute_1_1_blob_memory_pool.xhtml','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">BlobMemoryPool Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Blob memory pool.
<a href="classarm__compute_1_1_blob_memory_pool.xhtml#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_blob_memory_pool_8h_source.xhtml">BlobMemoryPool.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for BlobMemoryPool:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_blob_memory_pool__coll__graph.svg" width="140" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a62bb579b23f7c2202b6c24e31fa02d3d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_blob_memory_pool.xhtml#a62bb579b23f7c2202b6c24e31fa02d3d">BlobMemoryPool</a> (<a class="el" href="classarm__compute_1_1_i_allocator.xhtml">IAllocator</a> *allocator, std::vector&lt; <a class="el" href="structarm__compute_1_1_blob_info.xhtml">BlobInfo</a> &gt; blob_info)</td></tr>
<tr class="memdesc:a62bb579b23f7c2202b6c24e31fa02d3d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default Constructor. <a href="#a62bb579b23f7c2202b6c24e31fa02d3d">More...</a><br /></td></tr>
<tr class="separator:a62bb579b23f7c2202b6c24e31fa02d3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2e429f60410f02b72c74cae123aca669"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_blob_memory_pool.xhtml#a2e429f60410f02b72c74cae123aca669">~BlobMemoryPool</a> ()</td></tr>
<tr class="memdesc:a2e429f60410f02b72c74cae123aca669"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default Destructor. <a href="#a2e429f60410f02b72c74cae123aca669">More...</a><br /></td></tr>
<tr class="separator:a2e429f60410f02b72c74cae123aca669"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae3f7b519f24156d81c6cb74af7803c06"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_blob_memory_pool.xhtml#ae3f7b519f24156d81c6cb74af7803c06">BlobMemoryPool</a> (const <a class="el" href="classarm__compute_1_1_blob_memory_pool.xhtml">BlobMemoryPool</a> &amp;)=delete</td></tr>
<tr class="memdesc:ae3f7b519f24156d81c6cb74af7803c06"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class to be copy constructed. <a href="#ae3f7b519f24156d81c6cb74af7803c06">More...</a><br /></td></tr>
<tr class="separator:ae3f7b519f24156d81c6cb74af7803c06"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a48ffa311cc6842633aff367dd6f0d601"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_blob_memory_pool.xhtml">BlobMemoryPool</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_blob_memory_pool.xhtml#a48ffa311cc6842633aff367dd6f0d601">operator=</a> (const <a class="el" href="classarm__compute_1_1_blob_memory_pool.xhtml">BlobMemoryPool</a> &amp;)=delete</td></tr>
<tr class="memdesc:a48ffa311cc6842633aff367dd6f0d601"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class to be copy assigned. <a href="#a48ffa311cc6842633aff367dd6f0d601">More...</a><br /></td></tr>
<tr class="separator:a48ffa311cc6842633aff367dd6f0d601"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae5fe157f7be806bedd55e5c116a21995"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_blob_memory_pool.xhtml#ae5fe157f7be806bedd55e5c116a21995">BlobMemoryPool</a> (<a class="el" href="classarm__compute_1_1_blob_memory_pool.xhtml">BlobMemoryPool</a> &amp;&amp;)=default</td></tr>
<tr class="memdesc:ae5fe157f7be806bedd55e5c116a21995"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be move constructed. <a href="#ae5fe157f7be806bedd55e5c116a21995">More...</a><br /></td></tr>
<tr class="separator:ae5fe157f7be806bedd55e5c116a21995"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aefaf0120dcb471db4f69ad73c6a79a8b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_blob_memory_pool.xhtml">BlobMemoryPool</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_blob_memory_pool.xhtml#aefaf0120dcb471db4f69ad73c6a79a8b">operator=</a> (<a class="el" href="classarm__compute_1_1_blob_memory_pool.xhtml">BlobMemoryPool</a> &amp;&amp;)=default</td></tr>
<tr class="memdesc:aefaf0120dcb471db4f69ad73c6a79a8b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be move assigned. <a href="#aefaf0120dcb471db4f69ad73c6a79a8b">More...</a><br /></td></tr>
<tr class="separator:aefaf0120dcb471db4f69ad73c6a79a8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a93acd60164fb91350b542af0200410a6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_blob_memory_pool.xhtml#a93acd60164fb91350b542af0200410a6">acquire</a> (<a class="el" href="namespacearm__compute.xhtml#a43b7da220a8ead83acff98f218f7eb6b">MemoryMappings</a> &amp;handles) override</td></tr>
<tr class="memdesc:a93acd60164fb91350b542af0200410a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets occupant to the memory pool. <a href="#a93acd60164fb91350b542af0200410a6">More...</a><br /></td></tr>
<tr class="separator:a93acd60164fb91350b542af0200410a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af47c67ca8d1961b09543879bb734e8be"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_blob_memory_pool.xhtml#af47c67ca8d1961b09543879bb734e8be">release</a> (<a class="el" href="namespacearm__compute.xhtml#a43b7da220a8ead83acff98f218f7eb6b">MemoryMappings</a> &amp;handles) override</td></tr>
<tr class="memdesc:af47c67ca8d1961b09543879bb734e8be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Releases a memory block. <a href="#af47c67ca8d1961b09543879bb734e8be">More...</a><br /></td></tr>
<tr class="separator:af47c67ca8d1961b09543879bb734e8be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aafd3aa9650b1e764b085c76c4faa4cd5"><td class="memItemLeft" align="right" valign="top"><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_blob_memory_pool.xhtml#aafd3aa9650b1e764b085c76c4faa4cd5">mapping_type</a> () const override</td></tr>
<tr class="memdesc:aafd3aa9650b1e764b085c76c4faa4cd5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the mapping types that this pool accepts. <a href="#aafd3aa9650b1e764b085c76c4faa4cd5">More...</a><br /></td></tr>
<tr class="separator:aafd3aa9650b1e764b085c76c4faa4cd5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1854bcee41d35bbd99a3ff7b274e3819"><td class="memItemLeft" align="right" valign="top">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_blob_memory_pool.xhtml#a1854bcee41d35bbd99a3ff7b274e3819">duplicate</a> () override</td></tr>
<tr class="memdesc:a1854bcee41d35bbd99a3ff7b274e3819"><td class="mdescLeft">&#160;</td><td class="mdescRight">Duplicates the existing memory pool. <a href="#a1854bcee41d35bbd99a3ff7b274e3819">More...</a><br /></td></tr>
<tr class="separator:a1854bcee41d35bbd99a3ff7b274e3819"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classarm__compute_1_1_i_memory_pool"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_memory_pool')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_memory_pool.xhtml">IMemoryPool</a></td></tr>
<tr class="memitem:a81f863b710d9f96cc867a0755be73ab0 inherit pub_methods_classarm__compute_1_1_i_memory_pool"><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>
<tr class="memdesc:a81f863b710d9f96cc867a0755be73ab0 inherit pub_methods_classarm__compute_1_1_i_memory_pool"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default Virtual Destructor. <a href="classarm__compute_1_1_i_memory_pool.xhtml#a81f863b710d9f96cc867a0755be73ab0">More...</a><br /></td></tr>
<tr class="separator:a81f863b710d9f96cc867a0755be73ab0 inherit pub_methods_classarm__compute_1_1_i_memory_pool"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Blob memory pool. </p>
<p class="definition">Definition at line <a class="el" href="_blob_memory_pool_8h_source.xhtml#l00042">42</a> of file <a class="el" href="_blob_memory_pool_8h_source.xhtml">BlobMemoryPool.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a62bb579b23f7c2202b6c24e31fa02d3d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a62bb579b23f7c2202b6c24e31fa02d3d">&#9670;&nbsp;</a></span>BlobMemoryPool() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classarm__compute_1_1_blob_memory_pool.xhtml">BlobMemoryPool</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classarm__compute_1_1_i_allocator.xhtml">IAllocator</a> *&#160;</td>
<td class="paramname"><em>allocator</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::vector&lt; <a class="el" href="structarm__compute_1_1_blob_info.xhtml">BlobInfo</a> &gt;&#160;</td>
<td class="paramname"><em>blob_info</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Default Constructor. </p>
<dl class="section note"><dt>Note</dt><dd>allocator should outlive the memory pool</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">allocator</td><td>Backing memory allocator </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">blob_info</td><td>Configuration information of the blobs to be allocated </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="_blob_memory_pool_8cpp_source.xhtml#l00036">36</a> of file <a class="el" href="_blob_memory_pool_8cpp_source.xhtml">BlobMemoryPool.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; : _allocator(<a class="code" href="namespacearm__compute_1_1test_1_1validation.xhtml#a3d45498be87235b5165d9972b2d0644d">allocator</a>), _blobs(), _blob_info(std::move(blob_info))</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;{</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <a class="code" href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a>(!<a class="code" href="namespacearm__compute_1_1test_1_1validation.xhtml#a3d45498be87235b5165d9972b2d0644d">allocator</a>);</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; allocate_blobs(_blob_info);</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;}</div><div class="ttc" id="_error_8h_xhtml_a54a6080c9f4df1f908e57a9bbb46f5da"><div class="ttname"><a href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a></div><div class="ttdeci">#define ARM_COMPUTE_ERROR_ON(cond)</div><div class="ttdoc">If the condition is true then an error message is printed and an exception thrown.</div><div class="ttdef"><b>Definition:</b> <a href="_error_8h_source.xhtml#l00466">Error.h:466</a></div></div>
<div class="ttc" id="namespacearm__compute_1_1test_1_1validation_xhtml_a3d45498be87235b5165d9972b2d0644d"><div class="ttname"><a href="namespacearm__compute_1_1test_1_1validation.xhtml#a3d45498be87235b5165d9972b2d0644d">arm_compute::test::validation::allocator</a></div><div class="ttdeci">input allocator() -&gt; allocate()</div></div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="namespacearm__compute_1_1test_1_1validation.xhtml#a3d45498be87235b5165d9972b2d0644d">arm_compute::test::validation::allocator()</a>, and <a class="el" href="_error_8h_source.xhtml#l00466">ARM_COMPUTE_ERROR_ON</a>.</p>
</div>
</div>
<a id="a2e429f60410f02b72c74cae123aca669"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2e429f60410f02b72c74cae123aca669">&#9670;&nbsp;</a></span>~BlobMemoryPool()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">~<a class="el" href="classarm__compute_1_1_blob_memory_pool.xhtml">BlobMemoryPool</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Default Destructor. </p>
<p class="definition">Definition at line <a class="el" href="_blob_memory_pool_8cpp_source.xhtml#l00043">43</a> of file <a class="el" href="_blob_memory_pool_8cpp_source.xhtml">BlobMemoryPool.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;{</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <a class="code" href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a>(!_allocator);</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; free_blobs();</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;}</div><div class="ttc" id="_error_8h_xhtml_a54a6080c9f4df1f908e57a9bbb46f5da"><div class="ttname"><a href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a></div><div class="ttdeci">#define ARM_COMPUTE_ERROR_ON(cond)</div><div class="ttdoc">If the condition is true then an error message is printed and an exception thrown.</div><div class="ttdef"><b>Definition:</b> <a href="_error_8h_source.xhtml#l00466">Error.h:466</a></div></div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="_error_8h_source.xhtml#l00466">ARM_COMPUTE_ERROR_ON</a>.</p>
</div>
</div>
<a id="ae3f7b519f24156d81c6cb74af7803c06"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae3f7b519f24156d81c6cb74af7803c06">&#9670;&nbsp;</a></span>BlobMemoryPool() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classarm__compute_1_1_blob_memory_pool.xhtml">BlobMemoryPool</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classarm__compute_1_1_blob_memory_pool.xhtml">BlobMemoryPool</a> &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Prevent instances of this class to be copy constructed. </p>
</div>
</div>
<a id="ae5fe157f7be806bedd55e5c116a21995"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae5fe157f7be806bedd55e5c116a21995">&#9670;&nbsp;</a></span>BlobMemoryPool() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classarm__compute_1_1_blob_memory_pool.xhtml">BlobMemoryPool</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classarm__compute_1_1_blob_memory_pool.xhtml">BlobMemoryPool</a> &amp;&amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Allow instances of this class to be move constructed. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a93acd60164fb91350b542af0200410a6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a93acd60164fb91350b542af0200410a6">&#9670;&nbsp;</a></span>acquire()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void acquire </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#a43b7da220a8ead83acff98f218f7eb6b">MemoryMappings</a> &amp;&#160;</td>
<td class="paramname"><em>handles</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets occupant to the memory pool. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">handles</td><td>A vector of pairs (handle, index) </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classarm__compute_1_1_i_memory_pool.xhtml#a064f06f20fc565efbb2227aac827c12f">IMemoryPool</a>.</p>
<p class="definition">Definition at line <a class="el" href="_blob_memory_pool_8cpp_source.xhtml#l00049">49</a> of file <a class="el" href="_blob_memory_pool_8cpp_source.xhtml">BlobMemoryPool.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;{</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="comment">// Set memory to handlers</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keywordflow">for</span>(<span class="keyword">auto</span> &amp;handle : handles)</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; {</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <a class="code" href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a>(handle.first == <span class="keyword">nullptr</span>);</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; handle.first-&gt;set_region(_blobs[handle.second].get());</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; }</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;}</div><div class="ttc" id="_error_8h_xhtml_a54a6080c9f4df1f908e57a9bbb46f5da"><div class="ttname"><a href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a></div><div class="ttdeci">#define ARM_COMPUTE_ERROR_ON(cond)</div><div class="ttdoc">If the condition is true then an error message is printed and an exception thrown.</div><div class="ttdef"><b>Definition:</b> <a href="_error_8h_source.xhtml#l00466">Error.h:466</a></div></div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="_error_8h_source.xhtml#l00466">ARM_COMPUTE_ERROR_ON</a>.</p>
</div>
</div>
<a id="a1854bcee41d35bbd99a3ff7b274e3819"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1854bcee41d35bbd99a3ff7b274e3819">&#9670;&nbsp;</a></span>duplicate()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::unique_ptr&lt; <a class="el" href="classarm__compute_1_1_i_memory_pool.xhtml">IMemoryPool</a> &gt; duplicate </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Duplicates the existing memory pool. </p>
<dl class="section return"><dt>Returns</dt><dd>A duplicate of the existing pool </dd></dl>
<p>Implements <a class="el" href="classarm__compute_1_1_i_memory_pool.xhtml#af6c6c5e675fab42e482d11d02df2a79e">IMemoryPool</a>.</p>
<p class="definition">Definition at line <a class="el" href="_blob_memory_pool_8cpp_source.xhtml#l00073">73</a> of file <a class="el" href="_blob_memory_pool_8cpp_source.xhtml">BlobMemoryPool.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;{</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <a class="code" href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a>(!_allocator);</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="keywordflow">return</span> support::cpp14::make_unique&lt;BlobMemoryPool&gt;(_allocator, _blob_info);</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;}</div><div class="ttc" id="_error_8h_xhtml_a54a6080c9f4df1f908e57a9bbb46f5da"><div class="ttname"><a href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a></div><div class="ttdeci">#define ARM_COMPUTE_ERROR_ON(cond)</div><div class="ttdoc">If the condition is true then an error message is printed and an exception thrown.</div><div class="ttdef"><b>Definition:</b> <a href="_error_8h_source.xhtml#l00466">Error.h:466</a></div></div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="_error_8h_source.xhtml#l00466">ARM_COMPUTE_ERROR_ON</a>.</p>
</div>
</div>
<a id="aafd3aa9650b1e764b085c76c4faa4cd5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aafd3aa9650b1e764b085c76c4faa4cd5">&#9670;&nbsp;</a></span>mapping_type()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacearm__compute.xhtml#af0a4d6be70322c742c12da1edccbb74d">MappingType</a> mapping_type </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the mapping types that this pool accepts. </p>
<dl class="section return"><dt>Returns</dt><dd>the mapping type of the memory </dd></dl>
<p>Implements <a class="el" href="classarm__compute_1_1_i_memory_pool.xhtml#a2f4d2a4f6dd83e9ad1578450c31357db">IMemoryPool</a>.</p>
<p class="definition">Definition at line <a class="el" href="_blob_memory_pool_8cpp_source.xhtml#l00068">68</a> of file <a class="el" href="_blob_memory_pool_8cpp_source.xhtml">BlobMemoryPool.cpp</a>.</p>
<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">return</span> <a class="code" href="namespacearm__compute.xhtml#af0a4d6be70322c742c12da1edccbb74daac354f9e7a5097598cdd933b42fd190e">MappingType::BLOBS</a>;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;}</div><div class="ttc" id="namespacearm__compute_xhtml_af0a4d6be70322c742c12da1edccbb74daac354f9e7a5097598cdd933b42fd190e"><div class="ttname"><a href="namespacearm__compute.xhtml#af0a4d6be70322c742c12da1edccbb74daac354f9e7a5097598cdd933b42fd190e">arm_compute::MappingType::BLOBS</a></div><div class="ttdoc">Mappings are in blob granularity.</div></div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="namespacearm__compute.xhtml#af0a4d6be70322c742c12da1edccbb74daac354f9e7a5097598cdd933b42fd190e">arm_compute::BLOBS</a>.</p>
</div>
</div>
<a id="a48ffa311cc6842633aff367dd6f0d601"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a48ffa311cc6842633aff367dd6f0d601">&#9670;&nbsp;</a></span>operator=() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classarm__compute_1_1_blob_memory_pool.xhtml">BlobMemoryPool</a>&amp; operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classarm__compute_1_1_blob_memory_pool.xhtml">BlobMemoryPool</a> &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Prevent instances of this class to be copy assigned. </p>
</div>
</div>
<a id="aefaf0120dcb471db4f69ad73c6a79a8b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aefaf0120dcb471db4f69ad73c6a79a8b">&#9670;&nbsp;</a></span>operator=() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classarm__compute_1_1_blob_memory_pool.xhtml">BlobMemoryPool</a>&amp; operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classarm__compute_1_1_blob_memory_pool.xhtml">BlobMemoryPool</a> &amp;&amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Allow instances of this class to be move assigned. </p>
</div>
</div>
<a id="af47c67ca8d1961b09543879bb734e8be"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af47c67ca8d1961b09543879bb734e8be">&#9670;&nbsp;</a></span>release()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void release </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacearm__compute.xhtml#a43b7da220a8ead83acff98f218f7eb6b">MemoryMappings</a> &amp;&#160;</td>
<td class="paramname"><em>handles</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Releases a memory block. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">handles</td><td>A vector containing a pair of handles and indices </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classarm__compute_1_1_i_memory_pool.xhtml#ab9d340d42cc3ec933f5da369f1f808bb">IMemoryPool</a>.</p>
<p class="definition">Definition at line <a class="el" href="_blob_memory_pool_8cpp_source.xhtml#l00059">59</a> of file <a class="el" href="_blob_memory_pool_8cpp_source.xhtml">BlobMemoryPool.cpp</a>.</p>
<div class="fragment"><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;{</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keywordflow">for</span>(<span class="keyword">auto</span> &amp;handle : handles)</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; {</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <a class="code" href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a>(handle.first == <span class="keyword">nullptr</span>);</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; handle.first-&gt;set_region(<span class="keyword">nullptr</span>);</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; }</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;}</div><div class="ttc" id="_error_8h_xhtml_a54a6080c9f4df1f908e57a9bbb46f5da"><div class="ttname"><a href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a></div><div class="ttdeci">#define ARM_COMPUTE_ERROR_ON(cond)</div><div class="ttdoc">If the condition is true then an error message is printed and an exception thrown.</div><div class="ttdef"><b>Definition:</b> <a href="_error_8h_source.xhtml#l00466">Error.h:466</a></div></div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="_error_8h_source.xhtml#l00466">ARM_COMPUTE_ERROR_ON</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>arm_compute/runtime/<a class="el" href="_blob_memory_pool_8h_source.xhtml">BlobMemoryPool.h</a></li>
<li>src/runtime/<a class="el" href="_blob_memory_pool_8cpp_source.xhtml">BlobMemoryPool.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<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_blob_memory_pool.xhtml">BlobMemoryPool</a></li>
<li class="footer">Generated on Thu Mar 5 2020 16:07:09 for Compute Library by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
</ul>
</div>
</body>
</html>