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">
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: CLMemory 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);
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(); });
27 <script type="text/x-mathjax-config">
29 extensions: ["tex2jax.js"],
30 jax: ["input/TeX","output/HTML-CSS"],
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" />
36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
38 <table cellspacing="0" cellpadding="0">
40 <tr style="height: 56px;">
41 <td style="padding-left: 0.5em;">
42 <div id="projectname">Compute Library
43  <span id="projectnumber">18.05</span>
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');
55 <div id="navrow1" class="tabs">
57 <li><a href="index.xhtml"><span>Main Page</span></a></li>
58 <li><a href="pages.xhtml"><span>Related 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 Structures</span></a></li>
61 <li><a href="files.xhtml"><span>Files</span></a></li>
63 <div id="MSearchBox" class="MSearchBoxInactive">
65 <img id="MSearchSelect" src="search/mag_sel.png"
66 onmouseover="return searchBox.OnSearchSelectShow()"
67 onmouseout="return searchBox.OnSearchSelectHide()"
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>
80 <div id="navrow2" class="tabs2">
82 <li><a href="annotated.xhtml"><span>Data Structures</span></a></li>
83 <li><a href="classes.xhtml"><span>Data Structure Index</span></a></li>
84 <li><a href="inherits.xhtml"><span>Class Hierarchy</span></a></li>
85 <li><a href="functions.xhtml"><span>Data Fields</span></a></li>
89 <div id="side-nav" class="ui-resizable side-nav-resizable">
91 <div id="nav-tree-contents">
92 <div id="nav-sync" class="sync"></div>
95 <div id="splitbar" style="-moz-user-select:none;"
96 class="ui-resizable-handle">
99 <script type="text/javascript">
100 $(document).ready(function(){initNavTree('classarm__compute_1_1_c_l_memory.xhtml','');});
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)">
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">
118 <div class="summary">
119 <a href="#pub-methods">Public Member Functions</a> </div>
120 <div class="headertitle">
121 <div class="title">CLMemory Class Reference</div> </div>
123 <div class="contents">
125 <p>OpenCL implementation of memory object.
126 <a href="classarm__compute_1_1_c_l_memory.xhtml#details">More...</a></p>
128 <p><code>#include <<a class="el" href="_c_l_memory_8h_source.xhtml">CLMemory.h</a>></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: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>
133 <tr class="memdesc:a591dac78f4c0e06908f0a3e577605f50"><td class="mdescLeft"> </td><td class="mdescRight">Default Constructor. <a href="#a591dac78f4c0e06908f0a3e577605f50">More...</a><br /></td></tr>
134 <tr class="separator:a591dac78f4c0e06908f0a3e577605f50"><td class="memSeparator" colspan="2"> </td></tr>
135 <tr class="memitem:aff1318098c76de3218ae43f126ba7f7c"><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#aff1318098c76de3218ae43f126ba7f7c">CLMemory</a> (std::shared_ptr< <a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml">ICLMemoryRegion</a> > memory)</td></tr>
136 <tr class="memdesc:aff1318098c76de3218ae43f126ba7f7c"><td class="mdescLeft"> </td><td class="mdescRight">Default Constructor. <a href="#aff1318098c76de3218ae43f126ba7f7c">More...</a><br /></td></tr>
137 <tr class="separator:aff1318098c76de3218ae43f126ba7f7c"><td class="memSeparator" colspan="2"> </td></tr>
138 <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>
139 <tr class="memdesc:a77238852bb5e113a9ec5ee47fd293d7d"><td class="mdescLeft"> </td><td class="mdescRight">Default Constructor. <a href="#a77238852bb5e113a9ec5ee47fd293d7d">More...</a><br /></td></tr>
140 <tr class="separator:a77238852bb5e113a9ec5ee47fd293d7d"><td class="memSeparator" colspan="2"> </td></tr>
141 <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>
142 <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>
143 <tr class="separator:a54a712c532f0515bc050188ecd6fb5b2"><td class="memSeparator" colspan="2"> </td></tr>
144 <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>
145 <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>
146 <tr class="separator:a74574cd4936f64bf0486bae1000a42c9"><td class="memSeparator" colspan="2"> </td></tr>
147 <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>
148 <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>
149 <tr class="separator:a3d0989863f04f6b06b5e7dacdaddc17b"><td class="memSeparator" colspan="2"> </td></tr>
150 <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>
151 <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>
152 <tr class="separator:af8add9f91e083ecba5952ab92de6eaf6"><td class="memSeparator" colspan="2"> </td></tr>
153 <tr class="memitem:a09a88c8dfa3028d099bec0cc4987c6e0"><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#a09a88c8dfa3028d099bec0cc4987c6e0">region</a> ()</td></tr>
154 <tr class="memdesc:a09a88c8dfa3028d099bec0cc4987c6e0"><td class="mdescLeft"> </td><td class="mdescRight">Region accessor. <a href="#a09a88c8dfa3028d099bec0cc4987c6e0">More...</a><br /></td></tr>
155 <tr class="separator:a09a88c8dfa3028d099bec0cc4987c6e0"><td class="memSeparator" colspan="2"> </td></tr>
156 <tr class="memitem:af4987c646921ef0873e6d285f10be1ba"><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#af4987c646921ef0873e6d285f10be1ba">region</a> () const </td></tr>
157 <tr class="memdesc:af4987c646921ef0873e6d285f10be1ba"><td class="mdescLeft"> </td><td class="mdescRight">Region accessor. <a href="#af4987c646921ef0873e6d285f10be1ba">More...</a><br /></td></tr>
158 <tr class="separator:af4987c646921ef0873e6d285f10be1ba"><td class="memSeparator" colspan="2"> </td></tr>
160 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
161 <div class="textblock"><p>OpenCL implementation of memory object. </p>
163 <p>Definition at line <a class="el" href="_c_l_memory_8h_source.xhtml#l00036">36</a> of file <a class="el" href="_c_l_memory_8h_source.xhtml">CLMemory.h</a>.</p>
164 </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
165 <a class="anchor" id="a591dac78f4c0e06908f0a3e577605f50"></a>
166 <div class="memitem">
167 <div class="memproto">
168 <table class="memname">
170 <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_memory.xhtml">CLMemory</a> </td>
172 <td class="paramname"></td><td>)</td>
176 </div><div class="memdoc">
178 <p>Default Constructor. </p>
182 <a class="anchor" id="aff1318098c76de3218ae43f126ba7f7c"></a>
183 <div class="memitem">
184 <div class="memproto">
185 <table class="memname">
187 <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_memory.xhtml">CLMemory</a> </td>
189 <td class="paramtype">std::shared_ptr< <a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml">ICLMemoryRegion</a> > </td>
190 <td class="paramname"><em>memory</em></td><td>)</td>
194 </div><div class="memdoc">
196 <p>Default Constructor. </p>
197 <dl class="params"><dt>Parameters</dt><dd>
198 <table class="params">
199 <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>
206 <a class="anchor" id="a77238852bb5e113a9ec5ee47fd293d7d"></a>
207 <div class="memitem">
208 <div class="memproto">
209 <table class="memname">
211 <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_memory.xhtml">CLMemory</a> </td>
213 <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml">ICLMemoryRegion</a> * </td>
214 <td class="paramname"><em>memory</em></td><td>)</td>
218 </div><div class="memdoc">
220 <p>Default Constructor. </p>
221 <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>
222 <dl class="params"><dt>Parameters</dt><dd>
223 <table class="params">
224 <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>
231 <a class="anchor" id="a54a712c532f0515bc050188ecd6fb5b2"></a>
232 <div class="memitem">
233 <div class="memproto">
234 <table class="mlabels">
236 <td class="mlabels-left">
237 <table class="memname">
239 <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_memory.xhtml">CLMemory</a> </td>
241 <td class="paramtype">const <a class="el" href="classarm__compute_1_1_c_l_memory.xhtml">CLMemory</a> & </td>
242 <td class="paramname"></td><td>)</td>
247 <td class="mlabels-right">
248 <span class="mlabels"><span class="mlabel">default</span></span> </td>
251 </div><div class="memdoc">
253 <p>Allow instances of this class to be copied. </p>
257 <a class="anchor" id="a3d0989863f04f6b06b5e7dacdaddc17b"></a>
258 <div class="memitem">
259 <div class="memproto">
260 <table class="mlabels">
262 <td class="mlabels-left">
263 <table class="memname">
265 <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_memory.xhtml">CLMemory</a> </td>
267 <td class="paramtype"><a class="el" href="classarm__compute_1_1_c_l_memory.xhtml">CLMemory</a> && </td>
268 <td class="paramname"></td><td>)</td>
273 <td class="mlabels-right">
274 <span class="mlabels"><span class="mlabel">default</span><span class="mlabel">noexcept</span></span> </td>
277 </div><div class="memdoc">
279 <p>Allow instances of this class to be moved. </p>
283 <h2 class="groupheader">Member Function Documentation</h2>
284 <a class="anchor" id="a74574cd4936f64bf0486bae1000a42c9"></a>
285 <div class="memitem">
286 <div class="memproto">
287 <table class="mlabels">
289 <td class="mlabels-left">
290 <table class="memname">
292 <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_memory.xhtml">CLMemory</a>& operator= </td>
294 <td class="paramtype">const <a class="el" href="classarm__compute_1_1_c_l_memory.xhtml">CLMemory</a> & </td>
295 <td class="paramname"></td><td>)</td>
300 <td class="mlabels-right">
301 <span class="mlabels"><span class="mlabel">default</span></span> </td>
304 </div><div class="memdoc">
306 <p>Allow instances of this class to be copy assigned. </p>
310 <a class="anchor" id="af8add9f91e083ecba5952ab92de6eaf6"></a>
311 <div class="memitem">
312 <div class="memproto">
313 <table class="mlabels">
315 <td class="mlabels-left">
316 <table class="memname">
318 <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_memory.xhtml">CLMemory</a>& operator= </td>
320 <td class="paramtype"><a class="el" href="classarm__compute_1_1_c_l_memory.xhtml">CLMemory</a> && </td>
321 <td class="paramname"></td><td>)</td>
326 <td class="mlabels-right">
327 <span class="mlabels"><span class="mlabel">default</span><span class="mlabel">noexcept</span></span> </td>
330 </div><div class="memdoc">
332 <p>Allow instances of this class to be move assigned. </p>
336 <a class="anchor" id="a09a88c8dfa3028d099bec0cc4987c6e0"></a>
337 <div class="memitem">
338 <div class="memproto">
339 <table class="memname">
341 <td class="memname"><a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml">ICLMemoryRegion</a>* region </td>
343 <td class="paramname"></td><td>)</td>
347 </div><div class="memdoc">
349 <p>Region accessor. </p>
350 <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>
354 <a class="anchor" id="af4987c646921ef0873e6d285f10be1ba"></a>
355 <div class="memitem">
356 <div class="memproto">
357 <table class="memname">
359 <td class="memname"><a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml">ICLMemoryRegion</a>* region </td>
361 <td class="paramname"></td><td>)</td>
365 </div><div class="memdoc">
367 <p>Region accessor. </p>
368 <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>
372 <hr/>The documentation for this class was generated from the following file:<ul>
373 <li>arm_compute/runtime/CL/<a class="el" href="_c_l_memory_8h_source.xhtml">CLMemory.h</a></li>
375 </div><!-- contents -->
376 </div><!-- doc-content -->
377 <!-- start footer part -->
378 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
380 <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>
381 <li class="footer">Generated on Wed May 23 2018 11:36:41 for Compute Library by
382 <a href="http://www.doxygen.org/index.html">
383 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>