| <!-- 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: CLMemory 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&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"> |
|  <span id="projectnumber">19.08</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&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&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&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function(){initNavTree('classarm__compute_1_1_c_l_memory.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">CLMemory Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>OpenCL implementation of memory object. |
| <a href="classarm__compute_1_1_c_l_memory.xhtml#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="_c_l_memory_8h_source.xhtml">CLMemory.h</a>></code></p> |
| <div class="dynheader"> |
| Collaboration diagram for CLMemory:</div> |
| <div class="dyncontent"> |
| <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_c_l_memory__coll__graph.svg" width="102" 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:a591dac78f4c0e06908f0a3e577605f50"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_memory.xhtml#a591dac78f4c0e06908f0a3e577605f50">CLMemory</a> ()</td></tr> |
| <tr class="memdesc:a591dac78f4c0e06908f0a3e577605f50"><td class="mdescLeft"> </td><td class="mdescRight">Default Constructor. <a href="#a591dac78f4c0e06908f0a3e577605f50">More...</a><br /></td></tr> |
| <tr class="separator:a591dac78f4c0e06908f0a3e577605f50"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a97857d1e38440e51daf04bb9797909a8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_memory.xhtml#a97857d1e38440e51daf04bb9797909a8">CLMemory</a> (const std::shared_ptr< <a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml">ICLMemoryRegion</a> > &memory)</td></tr> |
| <tr class="memdesc:a97857d1e38440e51daf04bb9797909a8"><td class="mdescLeft"> </td><td class="mdescRight">Default Constructor. <a href="#a97857d1e38440e51daf04bb9797909a8">More...</a><br /></td></tr> |
| <tr class="separator:a97857d1e38440e51daf04bb9797909a8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a77238852bb5e113a9ec5ee47fd293d7d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_memory.xhtml#a77238852bb5e113a9ec5ee47fd293d7d">CLMemory</a> (<a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml">ICLMemoryRegion</a> *memory)</td></tr> |
| <tr class="memdesc:a77238852bb5e113a9ec5ee47fd293d7d"><td class="mdescLeft"> </td><td class="mdescRight">Default Constructor. <a href="#a77238852bb5e113a9ec5ee47fd293d7d">More...</a><br /></td></tr> |
| <tr class="separator:a77238852bb5e113a9ec5ee47fd293d7d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a54a712c532f0515bc050188ecd6fb5b2"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_memory.xhtml#a54a712c532f0515bc050188ecd6fb5b2">CLMemory</a> (const <a class="el" href="classarm__compute_1_1_c_l_memory.xhtml">CLMemory</a> &)=default</td></tr> |
| <tr class="memdesc:a54a712c532f0515bc050188ecd6fb5b2"><td class="mdescLeft"> </td><td class="mdescRight">Allow instances of this class to be copied. <a href="#a54a712c532f0515bc050188ecd6fb5b2">More...</a><br /></td></tr> |
| <tr class="separator:a54a712c532f0515bc050188ecd6fb5b2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a74574cd4936f64bf0486bae1000a42c9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_c_l_memory.xhtml">CLMemory</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_memory.xhtml#a74574cd4936f64bf0486bae1000a42c9">operator=</a> (const <a class="el" href="classarm__compute_1_1_c_l_memory.xhtml">CLMemory</a> &)=default</td></tr> |
| <tr class="memdesc:a74574cd4936f64bf0486bae1000a42c9"><td class="mdescLeft"> </td><td class="mdescRight">Allow instances of this class to be copy assigned. <a href="#a74574cd4936f64bf0486bae1000a42c9">More...</a><br /></td></tr> |
| <tr class="separator:a74574cd4936f64bf0486bae1000a42c9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3d0989863f04f6b06b5e7dacdaddc17b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_memory.xhtml#a3d0989863f04f6b06b5e7dacdaddc17b">CLMemory</a> (<a class="el" href="classarm__compute_1_1_c_l_memory.xhtml">CLMemory</a> &&) noexcept=default</td></tr> |
| <tr class="memdesc:a3d0989863f04f6b06b5e7dacdaddc17b"><td class="mdescLeft"> </td><td class="mdescRight">Allow instances of this class to be moved. <a href="#a3d0989863f04f6b06b5e7dacdaddc17b">More...</a><br /></td></tr> |
| <tr class="separator:a3d0989863f04f6b06b5e7dacdaddc17b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af8add9f91e083ecba5952ab92de6eaf6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_c_l_memory.xhtml">CLMemory</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_memory.xhtml#af8add9f91e083ecba5952ab92de6eaf6">operator=</a> (<a class="el" href="classarm__compute_1_1_c_l_memory.xhtml">CLMemory</a> &&) noexcept=default</td></tr> |
| <tr class="memdesc:af8add9f91e083ecba5952ab92de6eaf6"><td class="mdescLeft"> </td><td class="mdescRight">Allow instances of this class to be move assigned. <a href="#af8add9f91e083ecba5952ab92de6eaf6">More...</a><br /></td></tr> |
| <tr class="separator:af8add9f91e083ecba5952ab92de6eaf6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4ca2850f9acbac8fb013038b4d9b684d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml">ICLMemoryRegion</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_memory.xhtml#a4ca2850f9acbac8fb013038b4d9b684d">cl_region</a> ()</td></tr> |
| <tr class="memdesc:a4ca2850f9acbac8fb013038b4d9b684d"><td class="mdescLeft"> </td><td class="mdescRight">OpenCL Region accessor. <a href="#a4ca2850f9acbac8fb013038b4d9b684d">More...</a><br /></td></tr> |
| <tr class="separator:a4ca2850f9acbac8fb013038b4d9b684d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a90c5bffbf35df6abf5dffd84ce83b471"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml">ICLMemoryRegion</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_memory.xhtml#a90c5bffbf35df6abf5dffd84ce83b471">cl_region</a> () const</td></tr> |
| <tr class="memdesc:a90c5bffbf35df6abf5dffd84ce83b471"><td class="mdescLeft"> </td><td class="mdescRight">OpenCL Region accessor. <a href="#a90c5bffbf35df6abf5dffd84ce83b471">More...</a><br /></td></tr> |
| <tr class="separator:a90c5bffbf35df6abf5dffd84ce83b471"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a146cb960b44f4b1fb11ef4420382021a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_i_memory_region.xhtml">IMemoryRegion</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_memory.xhtml#a146cb960b44f4b1fb11ef4420382021a">region</a> () final</td></tr> |
| <tr class="memdesc:a146cb960b44f4b1fb11ef4420382021a"><td class="mdescLeft"> </td><td class="mdescRight">Region accessor. <a href="#a146cb960b44f4b1fb11ef4420382021a">More...</a><br /></td></tr> |
| <tr class="separator:a146cb960b44f4b1fb11ef4420382021a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a71ae8f88077f2d892643da1d89c48ac4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1_i_memory_region.xhtml">IMemoryRegion</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_memory.xhtml#a71ae8f88077f2d892643da1d89c48ac4">region</a> () const final</td></tr> |
| <tr class="memdesc:a71ae8f88077f2d892643da1d89c48ac4"><td class="mdescLeft"> </td><td class="mdescRight">Region accessor. <a href="#a71ae8f88077f2d892643da1d89c48ac4">More...</a><br /></td></tr> |
| <tr class="separator:a71ae8f88077f2d892643da1d89c48ac4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5e343ebd0fb1c7816e7abfee53d2578b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_memory.xhtml#a5e343ebd0fb1c7816e7abfee53d2578b">set_region</a> (<a class="el" href="classarm__compute_1_1_i_memory_region.xhtml">IMemoryRegion</a> *<a class="el" href="classarm__compute_1_1_c_l_memory.xhtml#a146cb960b44f4b1fb11ef4420382021a">region</a>) final</td></tr> |
| <tr class="memdesc:a5e343ebd0fb1c7816e7abfee53d2578b"><td class="mdescLeft"> </td><td class="mdescRight">Sets a memory region. <a href="#a5e343ebd0fb1c7816e7abfee53d2578b">More...</a><br /></td></tr> |
| <tr class="separator:a5e343ebd0fb1c7816e7abfee53d2578b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af2d30bc4b38a0f4703ff154a39f1b422"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_memory.xhtml#af2d30bc4b38a0f4703ff154a39f1b422">set_owned_region</a> (std::unique_ptr< <a class="el" href="classarm__compute_1_1_i_memory_region.xhtml">IMemoryRegion</a> > <a class="el" href="classarm__compute_1_1_c_l_memory.xhtml#a146cb960b44f4b1fb11ef4420382021a">region</a>) final</td></tr> |
| <tr class="memdesc:af2d30bc4b38a0f4703ff154a39f1b422"><td class="mdescLeft"> </td><td class="mdescRight">Sets a memory region. <a href="#af2d30bc4b38a0f4703ff154a39f1b422">More...</a><br /></td></tr> |
| <tr class="separator:af2d30bc4b38a0f4703ff154a39f1b422"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_classarm__compute_1_1_i_memory"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_memory')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_memory.xhtml">IMemory</a></td></tr> |
| <tr class="memitem:a2e5f508e93ea2a8b1040e9382604909c inherit pub_methods_classarm__compute_1_1_i_memory"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_memory.xhtml#a2e5f508e93ea2a8b1040e9382604909c">~IMemory</a> ()=default</td></tr> |
| <tr class="memdesc:a2e5f508e93ea2a8b1040e9382604909c inherit pub_methods_classarm__compute_1_1_i_memory"><td class="mdescLeft"> </td><td class="mdescRight">Virtual default destructor. <a href="classarm__compute_1_1_i_memory.xhtml#a2e5f508e93ea2a8b1040e9382604909c">More...</a><br /></td></tr> |
| <tr class="separator:a2e5f508e93ea2a8b1040e9382604909c inherit pub_methods_classarm__compute_1_1_i_memory"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>OpenCL implementation of memory object. </p> |
| |
| <p class="definition">Definition at line <a class="el" href="_c_l_memory_8h_source.xhtml#l00038">38</a> of file <a class="el" href="_c_l_memory_8h_source.xhtml">CLMemory.h</a>.</p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a591dac78f4c0e06908f0a3e577605f50"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a591dac78f4c0e06908f0a3e577605f50">◆ </a></span>CLMemory() <span class="overload">[1/5]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_memory.xhtml">CLMemory</a> </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Default Constructor. </p> |
| |
| <p class="definition">Definition at line <a class="el" href="_c_l_memory_8cpp_source.xhtml#l00031">31</a> of file <a class="el" href="_c_l_memory_8cpp_source.xhtml">CLMemory.cpp</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  : _region(<span class="keyword">nullptr</span>), _region_owned(<span class="keyword">nullptr</span>)</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> {</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> }</div></div><!-- fragment --> |
| </div> |
| </div> |
| <a id="a97857d1e38440e51daf04bb9797909a8"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a97857d1e38440e51daf04bb9797909a8">◆ </a></span>CLMemory() <span class="overload">[2/5]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_memory.xhtml">CLMemory</a> </td> |
| <td>(</td> |
| <td class="paramtype">const std::shared_ptr< <a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml">ICLMemoryRegion</a> > & </td> |
| <td class="paramname"><em>memory</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Default Constructor. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">memory</td><td><a class="el" href="classarm__compute_1_1_memory.xhtml" title="CPU implementation of memory object.">Memory</a> to be imported </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p class="definition">Definition at line <a class="el" href="_c_l_memory_8cpp_source.xhtml#l00036">36</a> of file <a class="el" href="_c_l_memory_8cpp_source.xhtml">CLMemory.cpp</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  : _region(<span class="keyword">nullptr</span>), _region_owned(memory)</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> {</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  _region_owned = memory;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  _region = _region_owned.get();</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> }</div></div><!-- fragment --> |
| </div> |
| </div> |
| <a id="a77238852bb5e113a9ec5ee47fd293d7d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a77238852bb5e113a9ec5ee47fd293d7d">◆ </a></span>CLMemory() <span class="overload">[3/5]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_memory.xhtml">CLMemory</a> </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml">ICLMemoryRegion</a> * </td> |
| <td class="paramname"><em>memory</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Default Constructor. </p> |
| <dl class="section note"><dt>Note</dt><dd>Ownership of the memory is not transferred to this object. Thus management (allocate/free) should be done by the client.</dd></dl> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">memory</td><td><a class="el" href="classarm__compute_1_1_memory.xhtml" title="CPU implementation of memory object.">Memory</a> to be imported </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p class="definition">Definition at line <a class="el" href="_c_l_memory_8cpp_source.xhtml#l00043">43</a> of file <a class="el" href="_c_l_memory_8cpp_source.xhtml">CLMemory.cpp</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  : _region(memory), _region_owned(<span class="keyword">nullptr</span>)</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> {</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  _region = memory;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> }</div></div><!-- fragment --> |
| </div> |
| </div> |
| <a id="a54a712c532f0515bc050188ecd6fb5b2"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a54a712c532f0515bc050188ecd6fb5b2">◆ </a></span>CLMemory() <span class="overload">[4/5]</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_c_l_memory.xhtml">CLMemory</a> </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classarm__compute_1_1_c_l_memory.xhtml">CLMemory</a> & </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 copied. </p> |
| |
| </div> |
| </div> |
| <a id="a3d0989863f04f6b06b5e7dacdaddc17b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3d0989863f04f6b06b5e7dacdaddc17b">◆ </a></span>CLMemory() <span class="overload">[5/5]</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_c_l_memory.xhtml">CLMemory</a> </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classarm__compute_1_1_c_l_memory.xhtml">CLMemory</a> && </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 class="mlabel">noexcept</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Allow instances of this class to be moved. </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a4ca2850f9acbac8fb013038b4d9b684d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4ca2850f9acbac8fb013038b4d9b684d">◆ </a></span>cl_region() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml">ICLMemoryRegion</a> * cl_region </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>OpenCL Region accessor. </p> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="classarm__compute_1_1_memory.xhtml" title="CPU implementation of memory object.">Memory</a> region </dd></dl> |
| |
| <p class="definition">Definition at line <a class="el" href="_c_l_memory_8cpp_source.xhtml#l00049">49</a> of file <a class="el" href="_c_l_memory_8cpp_source.xhtml">CLMemory.cpp</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> {</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keywordflow">return</span> _region;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> }</div></div><!-- fragment --> |
| <p class="reference">Referenced by <a class="el" href="_c_l_tensor_allocator_8cpp_source.xhtml#l00119">CLTensorAllocator::allocate()</a>, <a class="el" href="_c_l_tensor_allocator_8cpp_source.xhtml#l00114">CLTensorAllocator::cl_data()</a>, <a class="el" href="_c_l_tensor_allocator_8cpp_source.xhtml#l00193">CLTensorAllocator::map()</a>, <a class="el" href="_c_l_tensor_allocator_8cpp_source.xhtml#l00173">CLTensorAllocator::set_associated_memory_group()</a>, <a class="el" href="_c_l_memory_8cpp_source.xhtml#l00069">CLMemory::set_region()</a>, and <a class="el" href="_c_l_tensor_allocator_8cpp_source.xhtml#l00203">CLTensorAllocator::unmap()</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a90c5bffbf35df6abf5dffd84ce83b471"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a90c5bffbf35df6abf5dffd84ce83b471">◆ </a></span>cl_region() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml">ICLMemoryRegion</a> * cl_region </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>OpenCL Region accessor. </p> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="classarm__compute_1_1_memory.xhtml" title="CPU implementation of memory object.">Memory</a> region </dd></dl> |
| |
| <p class="definition">Definition at line <a class="el" href="_c_l_memory_8cpp_source.xhtml#l00054">54</a> of file <a class="el" href="_c_l_memory_8cpp_source.xhtml">CLMemory.cpp</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> {</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordflow">return</span> _region;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> }</div></div><!-- fragment --> |
| </div> |
| </div> |
| <a id="a74574cd4936f64bf0486bae1000a42c9"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a74574cd4936f64bf0486bae1000a42c9">◆ </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_c_l_memory.xhtml">CLMemory</a>& operator= </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classarm__compute_1_1_c_l_memory.xhtml">CLMemory</a> & </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 copy assigned. </p> |
| |
| </div> |
| </div> |
| <a id="af8add9f91e083ecba5952ab92de6eaf6"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af8add9f91e083ecba5952ab92de6eaf6">◆ </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_c_l_memory.xhtml">CLMemory</a>& operator= </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classarm__compute_1_1_c_l_memory.xhtml">CLMemory</a> && </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 class="mlabel">noexcept</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Allow instances of this class to be move assigned. </p> |
| |
| </div> |
| </div> |
| <a id="a146cb960b44f4b1fb11ef4420382021a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a146cb960b44f4b1fb11ef4420382021a">◆ </a></span>region() <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_i_memory_region.xhtml">IMemoryRegion</a> * region </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">final</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Region accessor. </p> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="classarm__compute_1_1_memory.xhtml" title="CPU implementation of memory object.">Memory</a> region </dd></dl> |
| |
| <p>Implements <a class="el" href="classarm__compute_1_1_i_memory.xhtml#ab2258b6ffc84dbbb1894448c4c4ff30c">IMemory</a>.</p> |
| |
| <p class="definition">Definition at line <a class="el" href="_c_l_memory_8cpp_source.xhtml#l00059">59</a> of file <a class="el" href="_c_l_memory_8cpp_source.xhtml">CLMemory.cpp</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> {</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordflow">return</span> _region;</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> }</div></div><!-- fragment --> |
| <p class="reference">Referenced by <a class="el" href="_c_l_tensor_allocator_8cpp_source.xhtml#l00119">CLTensorAllocator::allocate()</a>, <a class="el" href="_c_l_tensor_allocator_8cpp_source.xhtml#l00114">CLTensorAllocator::cl_data()</a>, <a class="el" href="_c_l_tensor_allocator_8cpp_source.xhtml#l00193">CLTensorAllocator::map()</a>, <a class="el" href="_c_l_tensor_allocator_8cpp_source.xhtml#l00173">CLTensorAllocator::set_associated_memory_group()</a>, <a class="el" href="_c_l_memory_8cpp_source.xhtml#l00076">CLMemory::set_owned_region()</a>, <a class="el" href="_c_l_memory_8cpp_source.xhtml#l00069">CLMemory::set_region()</a>, and <a class="el" href="_c_l_tensor_allocator_8cpp_source.xhtml#l00203">CLTensorAllocator::unmap()</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a71ae8f88077f2d892643da1d89c48ac4"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a71ae8f88077f2d892643da1d89c48ac4">◆ </a></span>region() <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_i_memory_region.xhtml">IMemoryRegion</a> * region </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">final</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Region accessor. </p> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="classarm__compute_1_1_memory.xhtml" title="CPU implementation of memory object.">Memory</a> region </dd></dl> |
| |
| <p>Implements <a class="el" href="classarm__compute_1_1_i_memory.xhtml#a27dab25f7225ed143200b499a0ce27e8">IMemory</a>.</p> |
| |
| <p class="definition">Definition at line <a class="el" href="_c_l_memory_8cpp_source.xhtml#l00064">64</a> of file <a class="el" href="_c_l_memory_8cpp_source.xhtml">CLMemory.cpp</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> {</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordflow">return</span> _region;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> }</div></div><!-- fragment --> |
| </div> |
| </div> |
| <a id="af2d30bc4b38a0f4703ff154a39f1b422"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af2d30bc4b38a0f4703ff154a39f1b422">◆ </a></span>set_owned_region()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void set_owned_region </td> |
| <td>(</td> |
| <td class="paramtype">std::unique_ptr< <a class="el" href="classarm__compute_1_1_i_memory_region.xhtml">IMemoryRegion</a> > </td> |
| <td class="paramname"><em>region</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">final</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets a memory region. </p> |
| <dl class="section warning"><dt>Warning</dt><dd>Ownership of the memory region is transfered along</dd></dl> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">region</td><td><a class="el" href="classarm__compute_1_1_memory.xhtml" title="CPU implementation of memory object.">Memory</a> region </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implements <a class="el" href="classarm__compute_1_1_i_memory.xhtml#aa00bd341767c1945c2f16d8056143f2c">IMemory</a>.</p> |
| |
| <p class="definition">Definition at line <a class="el" href="_c_l_memory_8cpp_source.xhtml#l00076">76</a> of file <a class="el" href="_c_l_memory_8cpp_source.xhtml">CLMemory.cpp</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> {</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  _region_owned = utils::cast::polymorphic_downcast_unique_ptr<ICLMemoryRegion>(std::move(<a class="code" href="classarm__compute_1_1_c_l_memory.xhtml#a146cb960b44f4b1fb11ef4420382021a">region</a>));</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  _region = _region_owned.get();</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> }</div><div class="ttc" id="classarm__compute_1_1_c_l_memory_xhtml_a146cb960b44f4b1fb11ef4420382021a"><div class="ttname"><a href="classarm__compute_1_1_c_l_memory.xhtml#a146cb960b44f4b1fb11ef4420382021a">arm_compute::CLMemory::region</a></div><div class="ttdeci">IMemoryRegion * region() final</div><div class="ttdoc">Region accessor.</div><div class="ttdef"><b>Definition:</b> <a href="_c_l_memory_8cpp_source.xhtml#l00059">CLMemory.cpp:59</a></div></div> |
| </div><!-- fragment --> |
| <p class="reference">References <a class="el" href="_c_l_memory_8cpp_source.xhtml#l00059">CLMemory::region()</a>.</p> |
| |
| <p class="reference">Referenced by <a class="el" href="_c_l_tensor_allocator_8cpp_source.xhtml#l00119">CLTensorAllocator::allocate()</a>, and <a class="el" href="_c_l_tensor_allocator_8cpp_source.xhtml#l00160">CLTensorAllocator::import_memory()</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a5e343ebd0fb1c7816e7abfee53d2578b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5e343ebd0fb1c7816e7abfee53d2578b">◆ </a></span>set_region()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void set_region </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_memory_region.xhtml">IMemoryRegion</a> * </td> |
| <td class="paramname"><em>region</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">final</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets a memory region. </p> |
| <dl class="section warning"><dt>Warning</dt><dd>Ownership of the memory region remains to the caller</dd></dl> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">region</td><td><a class="el" href="classarm__compute_1_1_memory.xhtml" title="CPU implementation of memory object.">Memory</a> region </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implements <a class="el" href="classarm__compute_1_1_i_memory.xhtml#a5f1239a904c50f8013ba163960605bce">IMemory</a>.</p> |
| |
| <p class="definition">Definition at line <a class="el" href="_c_l_memory_8cpp_source.xhtml#l00069">69</a> of file <a class="el" href="_c_l_memory_8cpp_source.xhtml">CLMemory.cpp</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> {</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">auto</span> <a class="code" href="classarm__compute_1_1_c_l_memory.xhtml#a4ca2850f9acbac8fb013038b4d9b684d">cl_region</a> = utils::cast::polymorphic_downcast<ICLMemoryRegion *>(<a class="code" href="classarm__compute_1_1_c_l_memory.xhtml#a146cb960b44f4b1fb11ef4420382021a">region</a>);</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  _region_owned = <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  _region = <a class="code" href="classarm__compute_1_1_c_l_memory.xhtml#a4ca2850f9acbac8fb013038b4d9b684d">cl_region</a>;</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> }</div><div class="ttc" id="classarm__compute_1_1_c_l_memory_xhtml_a146cb960b44f4b1fb11ef4420382021a"><div class="ttname"><a href="classarm__compute_1_1_c_l_memory.xhtml#a146cb960b44f4b1fb11ef4420382021a">arm_compute::CLMemory::region</a></div><div class="ttdeci">IMemoryRegion * region() final</div><div class="ttdoc">Region accessor.</div><div class="ttdef"><b>Definition:</b> <a href="_c_l_memory_8cpp_source.xhtml#l00059">CLMemory.cpp:59</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_c_l_memory_xhtml_a4ca2850f9acbac8fb013038b4d9b684d"><div class="ttname"><a href="classarm__compute_1_1_c_l_memory.xhtml#a4ca2850f9acbac8fb013038b4d9b684d">arm_compute::CLMemory::cl_region</a></div><div class="ttdeci">ICLMemoryRegion * cl_region()</div><div class="ttdoc">OpenCL Region accessor.</div><div class="ttdef"><b>Definition:</b> <a href="_c_l_memory_8cpp_source.xhtml#l00049">CLMemory.cpp:49</a></div></div> |
| </div><!-- fragment --> |
| <p class="reference">References <a class="el" href="_c_l_memory_8cpp_source.xhtml#l00049">CLMemory::cl_region()</a>, and <a class="el" href="_c_l_memory_8cpp_source.xhtml#l00059">CLMemory::region()</a>.</p> |
| |
| <p class="reference">Referenced by <a class="el" href="_c_l_tensor_allocator_8cpp_source.xhtml#l00152">CLTensorAllocator::free()</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following files:<ul> |
| <li>arm_compute/runtime/CL/<a class="el" href="_c_l_memory_8h_source.xhtml">CLMemory.h</a></li> |
| <li>src/runtime/CL/<a class="el" href="_c_l_memory_8cpp_source.xhtml">CLMemory.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_c_l_memory.xhtml">CLMemory</a></li> |
| <li class="footer">Generated on Mon Sep 2 2019 11:47:33 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> |
