arm_compute v18.05
[platform/upstream/armcl.git] / documentation / classarm__compute_1_1_c_l_memory.xhtml
1 <!-- HTML header for doxygen 1.8.9.1-->
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
4 <head>
5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
7 <meta name="generator" content="Doxygen 1.8.11"/>
8 <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
9 <title>Compute Library: 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);
20 </script>
21 <link href="search/search.css" rel="stylesheet" type="text/css"/>
22 <script type="text/javascript" src="search/searchdata.js"></script>
23 <script type="text/javascript" src="search/search.js"></script>
24 <script type="text/javascript">
25   $(document).ready(function() { init_search(); });
26 </script>
27 <script type="text/x-mathjax-config">
28   MathJax.Hub.Config({
29     extensions: ["tex2jax.js"],
30     jax: ["input/TeX","output/HTML-CSS"],
31 });
32 </script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
33 <link href="doxygen.css" rel="stylesheet" type="text/css" />
34 </head>
35 <body>
36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
37 <div id="titlearea">
38 <table cellspacing="0" cellpadding="0">
39  <tbody>
40  <tr style="height: 56px;">
41   <td style="padding-left: 0.5em;">
42    <div id="projectname">Compute Library
43    &#160;<span id="projectnumber">18.05</span>
44    </div>
45   </td>
46  </tr>
47  </tbody>
48 </table>
49 </div>
50 <!-- end header part -->
51 <!-- Generated by Doxygen 1.8.11 -->
52 <script type="text/javascript">
53 var searchBox = new SearchBox("searchBox", "search",false,'Search');
54 </script>
55   <div id="navrow1" class="tabs">
56     <ul class="tablist">
57       <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
58       <li><a href="pages.xhtml"><span>Related&#160;Pages</span></a></li>
59       <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
60       <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
61       <li><a href="files.xhtml"><span>Files</span></a></li>
62       <li>
63         <div id="MSearchBox" class="MSearchBoxInactive">
64         <span class="left">
65           <img id="MSearchSelect" src="search/mag_sel.png"
66                onmouseover="return searchBox.OnSearchSelectShow()"
67                onmouseout="return searchBox.OnSearchSelectHide()"
68                alt=""/>
69           <input type="text" id="MSearchField" value="Search" accesskey="S"
70                onfocus="searchBox.OnSearchFieldFocus(true)" 
71                onblur="searchBox.OnSearchFieldFocus(false)" 
72                onkeyup="searchBox.OnSearchFieldChange(event)"/>
73           </span><span class="right">
74             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
75           </span>
76         </div>
77       </li>
78     </ul>
79   </div>
80   <div id="navrow2" class="tabs2">
81     <ul class="tablist">
82       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
83       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
84       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
85       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
86     </ul>
87   </div>
88 </div><!-- top -->
89 <div id="side-nav" class="ui-resizable side-nav-resizable">
90   <div id="nav-tree">
91     <div id="nav-tree-contents">
92       <div id="nav-sync" class="sync"></div>
93     </div>
94   </div>
95   <div id="splitbar" style="-moz-user-select:none;" 
96        class="ui-resizable-handle">
97   </div>
98 </div>
99 <script type="text/javascript">
100 $(document).ready(function(){initNavTree('classarm__compute_1_1_c_l_memory.xhtml','');});
101 </script>
102 <div id="doc-content">
103 <!-- window showing the filter options -->
104 <div id="MSearchSelectWindow"
105      onmouseover="return searchBox.OnSearchSelectShow()"
106      onmouseout="return searchBox.OnSearchSelectHide()"
107      onkeydown="return searchBox.OnSearchSelectKey(event)">
108 </div>
109
110 <!-- iframe showing the search results (closed by default) -->
111 <div id="MSearchResultsWindow">
112 <iframe src="javascript:void(0)" frameborder="0" 
113         name="MSearchResults" id="MSearchResults">
114 </iframe>
115 </div>
116
117 <div class="header">
118   <div class="summary">
119 <a href="#pub-methods">Public Member Functions</a>  </div>
120   <div class="headertitle">
121 <div class="title">CLMemory Class Reference</div>  </div>
122 </div><!--header-->
123 <div class="contents">
124
125 <p>OpenCL implementation of memory object.  
126  <a href="classarm__compute_1_1_c_l_memory.xhtml#details">More...</a></p>
127
128 <p><code>#include &lt;<a class="el" href="_c_l_memory_8h_source.xhtml">CLMemory.h</a>&gt;</code></p>
129 <table class="memberdecls">
130 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
131 Public Member Functions</h2></td></tr>
132 <tr class="memitem:a591dac78f4c0e06908f0a3e577605f50"><td class="memItemLeft" align="right" valign="top">&#160;</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">&#160;</td><td class="mdescRight">Default Constructor.  <a href="#a591dac78f4c0e06908f0a3e577605f50">More...</a><br /></td></tr>
134 <tr class="separator:a591dac78f4c0e06908f0a3e577605f50"><td class="memSeparator" colspan="2">&#160;</td></tr>
135 <tr class="memitem:aff1318098c76de3218ae43f126ba7f7c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_c_l_memory.xhtml#aff1318098c76de3218ae43f126ba7f7c">CLMemory</a> (std::shared_ptr&lt; <a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml">ICLMemoryRegion</a> &gt; memory)</td></tr>
136 <tr class="memdesc:aff1318098c76de3218ae43f126ba7f7c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default Constructor.  <a href="#aff1318098c76de3218ae43f126ba7f7c">More...</a><br /></td></tr>
137 <tr class="separator:aff1318098c76de3218ae43f126ba7f7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
138 <tr class="memitem:a77238852bb5e113a9ec5ee47fd293d7d"><td class="memItemLeft" align="right" valign="top">&#160;</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">&#160;</td><td class="mdescRight">Default Constructor.  <a href="#a77238852bb5e113a9ec5ee47fd293d7d">More...</a><br /></td></tr>
140 <tr class="separator:a77238852bb5e113a9ec5ee47fd293d7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
141 <tr class="memitem:a54a712c532f0515bc050188ecd6fb5b2"><td class="memItemLeft" align="right" valign="top">&#160;</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> &amp;)=default</td></tr>
142 <tr class="memdesc:a54a712c532f0515bc050188ecd6fb5b2"><td class="mdescLeft">&#160;</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">&#160;</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> &amp;&#160;</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> &amp;)=default</td></tr>
145 <tr class="memdesc:a74574cd4936f64bf0486bae1000a42c9"><td class="mdescLeft">&#160;</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">&#160;</td></tr>
147 <tr class="memitem:a3d0989863f04f6b06b5e7dacdaddc17b"><td class="memItemLeft" align="right" valign="top">&#160;</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> &amp;&amp;) noexcept=default</td></tr>
148 <tr class="memdesc:a3d0989863f04f6b06b5e7dacdaddc17b"><td class="mdescLeft">&#160;</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">&#160;</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> &amp;&#160;</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> &amp;&amp;) noexcept=default</td></tr>
151 <tr class="memdesc:af8add9f91e083ecba5952ab92de6eaf6"><td class="mdescLeft">&#160;</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">&#160;</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> *&#160;</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">&#160;</td><td class="mdescRight">Region accessor.  <a href="#a09a88c8dfa3028d099bec0cc4987c6e0">More...</a><br /></td></tr>
155 <tr class="separator:a09a88c8dfa3028d099bec0cc4987c6e0"><td class="memSeparator" colspan="2">&#160;</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> *&#160;</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">&#160;</td><td class="mdescRight">Region accessor.  <a href="#af4987c646921ef0873e6d285f10be1ba">More...</a><br /></td></tr>
158 <tr class="separator:af4987c646921ef0873e6d285f10be1ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
159 </table>
160 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
161 <div class="textblock"><p>OpenCL implementation of memory object. </p>
162
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 &amp; Destructor Documentation</h2>
165 <a class="anchor" id="a591dac78f4c0e06908f0a3e577605f50"></a>
166 <div class="memitem">
167 <div class="memproto">
168       <table class="memname">
169         <tr>
170           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_memory.xhtml">CLMemory</a> </td>
171           <td>(</td>
172           <td class="paramname"></td><td>)</td>
173           <td></td>
174         </tr>
175       </table>
176 </div><div class="memdoc">
177
178 <p>Default Constructor. </p>
179
180 </div>
181 </div>
182 <a class="anchor" id="aff1318098c76de3218ae43f126ba7f7c"></a>
183 <div class="memitem">
184 <div class="memproto">
185       <table class="memname">
186         <tr>
187           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_memory.xhtml">CLMemory</a> </td>
188           <td>(</td>
189           <td class="paramtype">std::shared_ptr&lt; <a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml">ICLMemoryRegion</a> &gt;&#160;</td>
190           <td class="paramname"><em>memory</em></td><td>)</td>
191           <td></td>
192         </tr>
193       </table>
194 </div><div class="memdoc">
195
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>
200   </table>
201   </dd>
202 </dl>
203
204 </div>
205 </div>
206 <a class="anchor" id="a77238852bb5e113a9ec5ee47fd293d7d"></a>
207 <div class="memitem">
208 <div class="memproto">
209       <table class="memname">
210         <tr>
211           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_memory.xhtml">CLMemory</a> </td>
212           <td>(</td>
213           <td class="paramtype"><a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml">ICLMemoryRegion</a> *&#160;</td>
214           <td class="paramname"><em>memory</em></td><td>)</td>
215           <td></td>
216         </tr>
217       </table>
218 </div><div class="memdoc">
219
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>
225   </table>
226   </dd>
227 </dl>
228
229 </div>
230 </div>
231 <a class="anchor" id="a54a712c532f0515bc050188ecd6fb5b2"></a>
232 <div class="memitem">
233 <div class="memproto">
234 <table class="mlabels">
235   <tr>
236   <td class="mlabels-left">
237       <table class="memname">
238         <tr>
239           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_memory.xhtml">CLMemory</a> </td>
240           <td>(</td>
241           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_c_l_memory.xhtml">CLMemory</a> &amp;&#160;</td>
242           <td class="paramname"></td><td>)</td>
243           <td></td>
244         </tr>
245       </table>
246   </td>
247   <td class="mlabels-right">
248 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
249   </tr>
250 </table>
251 </div><div class="memdoc">
252
253 <p>Allow instances of this class to be copied. </p>
254
255 </div>
256 </div>
257 <a class="anchor" id="a3d0989863f04f6b06b5e7dacdaddc17b"></a>
258 <div class="memitem">
259 <div class="memproto">
260 <table class="mlabels">
261   <tr>
262   <td class="mlabels-left">
263       <table class="memname">
264         <tr>
265           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_memory.xhtml">CLMemory</a> </td>
266           <td>(</td>
267           <td class="paramtype"><a class="el" href="classarm__compute_1_1_c_l_memory.xhtml">CLMemory</a> &amp;&amp;&#160;</td>
268           <td class="paramname"></td><td>)</td>
269           <td></td>
270         </tr>
271       </table>
272   </td>
273   <td class="mlabels-right">
274 <span class="mlabels"><span class="mlabel">default</span><span class="mlabel">noexcept</span></span>  </td>
275   </tr>
276 </table>
277 </div><div class="memdoc">
278
279 <p>Allow instances of this class to be moved. </p>
280
281 </div>
282 </div>
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">
288   <tr>
289   <td class="mlabels-left">
290       <table class="memname">
291         <tr>
292           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_memory.xhtml">CLMemory</a>&amp; operator= </td>
293           <td>(</td>
294           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_c_l_memory.xhtml">CLMemory</a> &amp;&#160;</td>
295           <td class="paramname"></td><td>)</td>
296           <td></td>
297         </tr>
298       </table>
299   </td>
300   <td class="mlabels-right">
301 <span class="mlabels"><span class="mlabel">default</span></span>  </td>
302   </tr>
303 </table>
304 </div><div class="memdoc">
305
306 <p>Allow instances of this class to be copy assigned. </p>
307
308 </div>
309 </div>
310 <a class="anchor" id="af8add9f91e083ecba5952ab92de6eaf6"></a>
311 <div class="memitem">
312 <div class="memproto">
313 <table class="mlabels">
314   <tr>
315   <td class="mlabels-left">
316       <table class="memname">
317         <tr>
318           <td class="memname"><a class="el" href="classarm__compute_1_1_c_l_memory.xhtml">CLMemory</a>&amp; operator= </td>
319           <td>(</td>
320           <td class="paramtype"><a class="el" href="classarm__compute_1_1_c_l_memory.xhtml">CLMemory</a> &amp;&amp;&#160;</td>
321           <td class="paramname"></td><td>)</td>
322           <td></td>
323         </tr>
324       </table>
325   </td>
326   <td class="mlabels-right">
327 <span class="mlabels"><span class="mlabel">default</span><span class="mlabel">noexcept</span></span>  </td>
328   </tr>
329 </table>
330 </div><div class="memdoc">
331
332 <p>Allow instances of this class to be move assigned. </p>
333
334 </div>
335 </div>
336 <a class="anchor" id="a09a88c8dfa3028d099bec0cc4987c6e0"></a>
337 <div class="memitem">
338 <div class="memproto">
339       <table class="memname">
340         <tr>
341           <td class="memname"><a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml">ICLMemoryRegion</a>* region </td>
342           <td>(</td>
343           <td class="paramname"></td><td>)</td>
344           <td></td>
345         </tr>
346       </table>
347 </div><div class="memdoc">
348
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>
351
352 </div>
353 </div>
354 <a class="anchor" id="af4987c646921ef0873e6d285f10be1ba"></a>
355 <div class="memitem">
356 <div class="memproto">
357       <table class="memname">
358         <tr>
359           <td class="memname"><a class="el" href="classarm__compute_1_1_i_c_l_memory_region.xhtml">ICLMemoryRegion</a>* region </td>
360           <td>(</td>
361           <td class="paramname"></td><td>)</td>
362           <td> const</td>
363         </tr>
364       </table>
365 </div><div class="memdoc">
366
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>
369
370 </div>
371 </div>
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>
374 </ul>
375 </div><!-- contents -->
376 </div><!-- doc-content -->
377 <!-- start footer part -->
378 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
379   <ul>
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>
384   </ul>
385 </div>
386 </body>
387 </html>