arm_compute v17.10
[platform/upstream/armcl.git] / documentation / _c_l_array_8h_source.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.6"/>
8 <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
9 <title>Compute Library: arm_compute/runtime/CL/CLArray.h Source File</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="navtree.js"></script>
16 <script type="text/javascript">
17   $(document).ready(initResizable);
18   $(window).load(resizeHeight);
19 </script>
20 <link href="search/search.css" rel="stylesheet" type="text/css"/>
21 <script type="text/javascript" src="search/search.js"></script>
22 <script type="text/javascript">
23   $(document).ready(function() { searchBox.OnSelectItem(0); });
24 </script>
25 <script type="text/x-mathjax-config">
26   MathJax.Hub.Config({
27     extensions: ["tex2jax.js"],
28     jax: ["input/TeX","output/HTML-CSS"],
29 });
30 </script><script src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
31 <link href="doxygen.css" rel="stylesheet" type="text/css" />
32 </head>
33 <body>
34 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
35 <div id="titlearea">
36 <table cellspacing="0" cellpadding="0">
37  <tbody>
38  <tr style="height: 56px;">
39   <td style="padding-left: 0.5em;">
40    <div id="projectname">Compute Library
41    &#160;<span id="projectnumber">17.10</span>
42    </div>
43   </td>
44  </tr>
45  </tbody>
46 </table>
47 </div>
48 <!-- end header part -->
49 <!-- Generated by Doxygen 1.8.6 -->
50 <script type="text/javascript">
51 var searchBox = new SearchBox("searchBox", "search",false,'Search');
52 </script>
53   <div id="navrow1" class="tabs">
54     <ul class="tablist">
55       <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
56       <li><a href="pages.xhtml"><span>Related&#160;Pages</span></a></li>
57       <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
58       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
59       <li class="current"><a href="files.xhtml"><span>Files</span></a></li>
60       <li>
61         <div id="MSearchBox" class="MSearchBoxInactive">
62         <span class="left">
63           <img id="MSearchSelect" src="search/mag_sel.png"
64                onmouseover="return searchBox.OnSearchSelectShow()"
65                onmouseout="return searchBox.OnSearchSelectHide()"
66                alt=""/>
67           <input type="text" id="MSearchField" value="Search" accesskey="S"
68                onfocus="searchBox.OnSearchFieldFocus(true)" 
69                onblur="searchBox.OnSearchFieldFocus(false)" 
70                onkeyup="searchBox.OnSearchFieldChange(event)"/>
71           </span><span class="right">
72             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
73           </span>
74         </div>
75       </li>
76     </ul>
77   </div>
78   <div id="navrow2" class="tabs2">
79     <ul class="tablist">
80       <li><a href="files.xhtml"><span>File&#160;List</span></a></li>
81       <li><a href="globals.xhtml"><span>Globals</span></a></li>
82     </ul>
83   </div>
84 </div><!-- top -->
85 <div id="side-nav" class="ui-resizable side-nav-resizable">
86   <div id="nav-tree">
87     <div id="nav-tree-contents">
88       <div id="nav-sync" class="sync"></div>
89     </div>
90   </div>
91   <div id="splitbar" style="-moz-user-select:none;" 
92        class="ui-resizable-handle">
93   </div>
94 </div>
95 <script type="text/javascript">
96 $(document).ready(function(){initNavTree('_c_l_array_8h_source.xhtml','');});
97 </script>
98 <div id="doc-content">
99 <!-- window showing the filter options -->
100 <div id="MSearchSelectWindow"
101      onmouseover="return searchBox.OnSearchSelectShow()"
102      onmouseout="return searchBox.OnSearchSelectHide()"
103      onkeydown="return searchBox.OnSearchSelectKey(event)">
104 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Pages</a></div>
105
106 <!-- iframe showing the search results (closed by default) -->
107 <div id="MSearchResultsWindow">
108 <iframe src="javascript:void(0)" frameborder="0" 
109         name="MSearchResults" id="MSearchResults">
110 </iframe>
111 </div>
112
113 <div class="header">
114   <div class="headertitle">
115 <div class="title">CLArray.h</div>  </div>
116 </div><!--header-->
117 <div class="contents">
118 <a href="_c_l_array_8h.xhtml">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div>
119 <div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * Copyright (c) 2016, 2017 ARM Limited.</span></div>
120 <div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> *</span></div>
121 <div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> * SPDX-License-Identifier: MIT</span></div>
122 <div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> *</span></div>
123 <div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a copy</span></div>
124 <div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * of this software and associated documentation files (the &quot;Software&quot;), to</span></div>
125 <div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> * deal in the Software without restriction, including without limitation the</span></div>
126 <div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or</span></div>
127 <div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> * sell copies of the Software, and to permit persons to whom the Software is</span></div>
128 <div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> * furnished to do so, subject to the following conditions:</span></div>
129 <div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> *</span></div>
130 <div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> * The above copyright notice and this permission notice shall be included in all</span></div>
131 <div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> * copies or substantial portions of the Software.</span></div>
132 <div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> *</span></div>
133 <div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"> * THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div>
134 <div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div>
135 <div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span></div>
136 <div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div>
137 <div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span></div>
138 <div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment"> * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE</span></div>
139 <div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment"> * SOFTWARE.</span></div>
140 <div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment"> */</span></div>
141 <div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="preprocessor">#ifndef __ARM_COMPUTE_CLARRAY_H__</span></div>
142 <div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define __ARM_COMPUTE_CLARRAY_H__</span></div>
143 <div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="preprocessor"></span></div>
144 <div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_i_c_l_array_8h.xhtml">arm_compute/core/CL/ICLArray.h</a>&quot;</span></div>
145 <div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_open_c_l_8h.xhtml">arm_compute/core/CL/OpenCL.h</a>&quot;</span></div>
146 <div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_error_8h.xhtml">arm_compute/core/Error.h</a>&quot;</span></div>
147 <div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="arm__compute_2core_2_types_8h.xhtml">arm_compute/core/Types.h</a>&quot;</span></div>
148 <div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_c_l_scheduler_8h.xhtml">arm_compute/runtime/CL/CLScheduler.h</a>&quot;</span></div>
149 <div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;</div>
150 <div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="keyword">namespace </span>arm_compute</div>
151 <div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;{</div>
152 <div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">class</span> T&gt;</div>
153 <div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classarm__compute_1_1_c_l_array.xhtml">   37</a></span>&#160;<span class="keyword">class </span><a class="code" href="classarm__compute_1_1_c_l_array.xhtml">CLArray</a> : <span class="keyword">public</span> <a class="code" href="classarm__compute_1_1_i_c_l_array.xhtml">ICLArray</a>&lt;T&gt;</div>
154 <div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;{</div>
155 <div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="keyword">public</span>:</div>
156 <div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="classarm__compute_1_1_c_l_array.xhtml#a7f8aa474d5cad1e1ab2aa1e597af4bf0">   41</a></span>&#160;    <a class="code" href="classarm__compute_1_1_c_l_array.xhtml#a7f8aa474d5cad1e1ab2aa1e597af4bf0">CLArray</a>()</div>
157 <div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;        : <a class="code" href="classarm__compute_1_1_i_c_l_array.xhtml">ICLArray</a>&lt;T&gt;(0), _buffer()</div>
158 <div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;    {</div>
159 <div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;    }</div>
160 <div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;    <a class="code" href="classarm__compute_1_1_c_l_array.xhtml#a7f8aa474d5cad1e1ab2aa1e597af4bf0">CLArray</a>(<span class="keyword">const</span> <a class="code" href="classarm__compute_1_1_c_l_array.xhtml">CLArray</a> &amp;) = <span class="keyword">delete</span>;</div>
161 <div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;    <a class="code" href="classarm__compute_1_1_c_l_array.xhtml">CLArray</a> &amp;<a class="code" href="classarm__compute_1_1_c_l_array.xhtml#a36d785dc1a6a88471030943546aa8f51">operator=</a>(<span class="keyword">const</span> <a class="code" href="classarm__compute_1_1_c_l_array.xhtml">CLArray</a> &amp;) = <span class="keyword">delete</span>;</div>
162 <div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;    <a class="code" href="classarm__compute_1_1_c_l_array.xhtml#a7f8aa474d5cad1e1ab2aa1e597af4bf0">CLArray</a>(<a class="code" href="classarm__compute_1_1_c_l_array.xhtml">CLArray</a> &amp;&amp;)                 = <span class="keywordflow">default</span>;</div>
163 <div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;    <a class="code" href="classarm__compute_1_1_c_l_array.xhtml">CLArray</a> &amp;<a class="code" href="classarm__compute_1_1_c_l_array.xhtml#a36d785dc1a6a88471030943546aa8f51">operator=</a>(<a class="code" href="classarm__compute_1_1_c_l_array.xhtml">CLArray</a> &amp;&amp;) = <span class="keywordflow">default</span>;</div>
164 <div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="classarm__compute_1_1_c_l_array.xhtml#aaa923d0abf2a3a5722a728f39411ad07">   55</a></span>&#160;    <a class="code" href="classarm__compute_1_1_c_l_array.xhtml#aaa923d0abf2a3a5722a728f39411ad07">CLArray</a>(<span class="keywordtype">size_t</span> <a class="code" href="classarm__compute_1_1_i_array.xhtml#a2ff0fb106d58091d2b4363e808f200a3">max_num_values</a>)</div>
165 <div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;        : <a class="code" href="classarm__compute_1_1_i_c_l_array.xhtml">ICLArray</a>&lt;T&gt;(max_num_values), _buffer(<a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml">CLScheduler</a>::get().context(), CL_MEM_ALLOC_HOST_PTR | CL_MEM_READ_WRITE, max_num_values * sizeof(T))</div>
166 <div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;    {</div>
167 <div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;    }</div>
168 <div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="classarm__compute_1_1_c_l_array.xhtml#a14c53d2d17be6fa8a2c9861527c7b002">   65</a></span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classarm__compute_1_1_c_l_array.xhtml#a14c53d2d17be6fa8a2c9861527c7b002">map</a>(<span class="keywordtype">bool</span> blocking = <span class="keyword">true</span>)</div>
169 <div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;    {</div>
170 <div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;        <a class="code" href="classarm__compute_1_1_i_c_l_array.xhtml#ac0abc7a5c0d172947f0e6a0c0dde3df0">ICLArray&lt;T&gt;::map</a>(<a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml#a60f9a6836b628a7171914c4afe43b4a7">CLScheduler::get</a>().queue(), blocking);</div>
171 <div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;    }</div>
172 <div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;    <span class="keyword">using</span> <a class="code" href="classarm__compute_1_1_i_c_l_array.xhtml">ICLArray&lt;T&gt;::map</a>;</div>
173 <div class="line"><a name="l00075"></a><span class="lineno"><a class="line" href="classarm__compute_1_1_c_l_array.xhtml#a1ffeb3b5abb3d61f62b58a391816201c">   75</a></span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classarm__compute_1_1_c_l_array.xhtml#a1ffeb3b5abb3d61f62b58a391816201c">unmap</a>()</div>
174 <div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;    {</div>
175 <div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;        <a class="code" href="classarm__compute_1_1_i_c_l_array.xhtml#af974a2360069c2ef8df4496d00e4f6cc">ICLArray&lt;T&gt;::unmap</a>(<a class="code" href="classarm__compute_1_1_c_l_scheduler.xhtml#a60f9a6836b628a7171914c4afe43b4a7">CLScheduler::get</a>().queue());</div>
176 <div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;    }</div>
177 <div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;    <span class="keyword">using</span> <a class="code" href="classarm__compute_1_1_i_c_l_array.xhtml">ICLArray&lt;T&gt;::unmap</a>;</div>
178 <div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;</div>
179 <div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;    <span class="comment">// Inherited methods overridden:</span></div>
180 <div class="line"><a name="l00082"></a><span class="lineno"><a class="line" href="classarm__compute_1_1_c_l_array.xhtml#afd44a3d7dad6d984b1b87bc9f1b4fa02">   82</a></span>&#160;    <span class="keyword">const</span> cl::Buffer &amp;<a class="code" href="classarm__compute_1_1_c_l_array.xhtml#afd44a3d7dad6d984b1b87bc9f1b4fa02">cl_buffer</a>()<span class="keyword"> const override</span></div>
181 <div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;<span class="keyword">    </span>{</div>
182 <div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;        <span class="keywordflow">return</span> _buffer;</div>
183 <div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;    }</div>
184 <div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;</div>
185 <div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;<span class="keyword">protected</span>:</div>
186 <div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;    <span class="comment">// Inherited methods overridden:</span></div>
187 <div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;    uint8_t *do_map(cl::CommandQueue &amp;q, <span class="keywordtype">bool</span> blocking)<span class="keyword"> override</span></div>
188 <div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;<span class="keyword">    </span>{</div>
189 <div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;        <a class="code" href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a>(<span class="keyword">nullptr</span> == _buffer.get());</div>
190 <div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;        <span class="keywordflow">return</span> <span class="keyword">static_cast&lt;</span>uint8_t *<span class="keyword">&gt;</span>(q.enqueueMapBuffer(_buffer, blocking ? CL_TRUE : CL_FALSE, CL_MAP_READ | CL_MAP_WRITE, 0, this-&gt;<a class="code" href="classarm__compute_1_1_i_array.xhtml#a2ff0fb106d58091d2b4363e808f200a3">max_num_values</a>() * <span class="keyword">sizeof</span>(T)));</div>
191 <div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;    }</div>
192 <div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;    <span class="keywordtype">void</span> do_unmap(cl::CommandQueue &amp;q, uint8_t *mapping)<span class="keyword"> override</span></div>
193 <div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;<span class="keyword">    </span>{</div>
194 <div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;        <a class="code" href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a>(<span class="keyword">nullptr</span> == _buffer.get());</div>
195 <div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;        q.enqueueUnmapMemObject(_buffer, mapping);</div>
196 <div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;    }</div>
197 <div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;</div>
198 <div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;<span class="keyword">private</span>:</div>
199 <div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;    cl::Buffer _buffer;</div>
200 <div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;};</div>
201 <div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;</div>
202 <div class="line"><a name="l00104"></a><span class="lineno"><a class="line" href="namespacearm__compute.xhtml#a55e1c5ed17b7ee3762198a38eb50650a">  104</a></span>&#160;<span class="keyword">using</span> <a class="code" href="classarm__compute_1_1_c_l_array.xhtml">CLKeyPointArray</a>        = <a class="code" href="classarm__compute_1_1_c_l_array.xhtml">CLArray&lt;KeyPoint&gt;</a>;</div>
203 <div class="line"><a name="l00105"></a><span class="lineno"><a class="line" href="namespacearm__compute.xhtml#a0fd5f0310a26faad00b905bac3792726">  105</a></span>&#160;<span class="keyword">using</span> <a class="code" href="classarm__compute_1_1_c_l_array.xhtml">CLCoordinates2DArray</a>   = <a class="code" href="classarm__compute_1_1_c_l_array.xhtml">CLArray&lt;Coordinates2D&gt;</a>;</div>
204 <div class="line"><a name="l00106"></a><span class="lineno"><a class="line" href="namespacearm__compute.xhtml#ab8d2c7efb7643ce8f9e5446dbe1da0b4">  106</a></span>&#160;<span class="keyword">using</span> <a class="code" href="classarm__compute_1_1_c_l_array.xhtml">CLDetectionWindowArray</a> = <a class="code" href="classarm__compute_1_1_c_l_array.xhtml">CLArray&lt;DetectionWindow&gt;</a>;</div>
205 <div class="line"><a name="l00107"></a><span class="lineno"><a class="line" href="namespacearm__compute.xhtml#a7d756aef16b9c22456bb7aca8fbb4f4c">  107</a></span>&#160;<span class="keyword">using</span> <a class="code" href="classarm__compute_1_1_c_l_array.xhtml">CLROIArray</a>             = <a class="code" href="classarm__compute_1_1_c_l_array.xhtml">CLArray&lt;ROI&gt;</a>;</div>
206 <div class="line"><a name="l00108"></a><span class="lineno"><a class="line" href="namespacearm__compute.xhtml#a3f9ab729931f4e4fa36ff1683186d988">  108</a></span>&#160;<span class="keyword">using</span> <a class="code" href="classarm__compute_1_1_c_l_array.xhtml">CLSize2DArray</a>          = <a class="code" href="classarm__compute_1_1_c_l_array.xhtml">CLArray&lt;Size2D&gt;</a>;</div>
207 <div class="line"><a name="l00109"></a><span class="lineno"><a class="line" href="namespacearm__compute.xhtml#aa031694bb03711e09e25546ad2b643cc">  109</a></span>&#160;<span class="keyword">using</span> <a class="code" href="classarm__compute_1_1_c_l_array.xhtml">CLUInt8Array</a>           = <a class="code" href="classarm__compute_1_1_c_l_array.xhtml">CLArray&lt;cl_uchar&gt;</a>;</div>
208 <div class="line"><a name="l00110"></a><span class="lineno"><a class="line" href="namespacearm__compute.xhtml#a7b4c4a79c73a3f85ba89aff03fddefa7">  110</a></span>&#160;<span class="keyword">using</span> <a class="code" href="classarm__compute_1_1_c_l_array.xhtml">CLUInt16Array</a>          = <a class="code" href="classarm__compute_1_1_c_l_array.xhtml">CLArray&lt;cl_ushort&gt;</a>;</div>
209 <div class="line"><a name="l00111"></a><span class="lineno"><a class="line" href="namespacearm__compute.xhtml#a1d7d89b7e990055dc95ed37dfb24da48">  111</a></span>&#160;<span class="keyword">using</span> <a class="code" href="classarm__compute_1_1_c_l_array.xhtml">CLUInt32Array</a>          = <a class="code" href="classarm__compute_1_1_c_l_array.xhtml">CLArray&lt;cl_uint&gt;</a>;</div>
210 <div class="line"><a name="l00112"></a><span class="lineno"><a class="line" href="namespacearm__compute.xhtml#a5fb8cb339705102066c915d18f0701ac">  112</a></span>&#160;<span class="keyword">using</span> <a class="code" href="classarm__compute_1_1_c_l_array.xhtml">CLInt16Array</a>           = <a class="code" href="classarm__compute_1_1_c_l_array.xhtml">CLArray&lt;cl_short&gt;</a>;</div>
211 <div class="line"><a name="l00113"></a><span class="lineno"><a class="line" href="namespacearm__compute.xhtml#a8a401a071524761c661a75969c951cf5">  113</a></span>&#160;<span class="keyword">using</span> <a class="code" href="classarm__compute_1_1_c_l_array.xhtml">CLInt32Array</a>           = <a class="code" href="classarm__compute_1_1_c_l_array.xhtml">CLArray&lt;cl_int&gt;</a>;</div>
212 <div class="line"><a name="l00114"></a><span class="lineno"><a class="line" href="namespacearm__compute.xhtml#a193a4859b365f3ef4e0d73a1e6b12c85">  114</a></span>&#160;<span class="keyword">using</span> <a class="code" href="classarm__compute_1_1_c_l_array.xhtml">CLFloatArray</a>           = <a class="code" href="classarm__compute_1_1_c_l_array.xhtml">CLArray&lt;cl_float&gt;</a>;</div>
213 <div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;}</div>
214 <div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* __ARM_COMPUTE_CLARRAY_H__ */</span><span class="preprocessor"></span></div>
215 <div class="ttc" id="_i_c_l_array_8h_xhtml"><div class="ttname"><a href="_i_c_l_array_8h.xhtml">ICLArray.h</a></div></div>
216 <div class="ttc" id="classarm__compute_1_1_i_c_l_array_xhtml_ac0abc7a5c0d172947f0e6a0c0dde3df0"><div class="ttname"><a href="classarm__compute_1_1_i_c_l_array.xhtml#ac0abc7a5c0d172947f0e6a0c0dde3df0">arm_compute::ICLArray::map</a></div><div class="ttdeci">void map(cl::CommandQueue &amp;q, bool blocking=true)</div><div class="ttdoc">Enqueue a map operation of the allocated buffer on the given queue. </div><div class="ttdef"><b>Definition:</b> <a href="_i_c_l_array_8h_source.xhtml#l00063">ICLArray.h:63</a></div></div>
217 <div class="ttc" id="classarm__compute_1_1_c_l_array_xhtml_afd44a3d7dad6d984b1b87bc9f1b4fa02"><div class="ttname"><a href="classarm__compute_1_1_c_l_array.xhtml#afd44a3d7dad6d984b1b87bc9f1b4fa02">arm_compute::CLArray::cl_buffer</a></div><div class="ttdeci">const cl::Buffer &amp; cl_buffer() const override</div><div class="ttdoc">Interface to be implemented by the child class to return a reference to the OpenCL buffer containing ...</div><div class="ttdef"><b>Definition:</b> <a href="_c_l_array_8h_source.xhtml#l00082">CLArray.h:82</a></div></div>
218 <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#l00124">Error.h:124</a></div></div>
219 <div class="ttc" id="classarm__compute_1_1_c_l_array_xhtml_a7f8aa474d5cad1e1ab2aa1e597af4bf0"><div class="ttname"><a href="classarm__compute_1_1_c_l_array.xhtml#a7f8aa474d5cad1e1ab2aa1e597af4bf0">arm_compute::CLArray::CLArray</a></div><div class="ttdeci">CLArray()</div><div class="ttdoc">Default constructor: empty array. </div><div class="ttdef"><b>Definition:</b> <a href="_c_l_array_8h_source.xhtml#l00041">CLArray.h:41</a></div></div>
220 <div class="ttc" id="_c_l_scheduler_8h_xhtml"><div class="ttname"><a href="_c_l_scheduler_8h.xhtml">CLScheduler.h</a></div></div>
221 <div class="ttc" id="classarm__compute_1_1_i_c_l_array_xhtml"><div class="ttname"><a href="classarm__compute_1_1_i_c_l_array.xhtml">arm_compute::ICLArray</a></div><div class="ttdoc">Interface for OpenCL Array. </div><div class="ttdef"><b>Definition:</b> <a href="_i_c_l_array_8h_source.xhtml#l00035">ICLArray.h:35</a></div></div>
222 <div class="ttc" id="classarm__compute_1_1_c_l_scheduler_xhtml_a60f9a6836b628a7171914c4afe43b4a7"><div class="ttname"><a href="classarm__compute_1_1_c_l_scheduler.xhtml#a60f9a6836b628a7171914c4afe43b4a7">arm_compute::CLScheduler::get</a></div><div class="ttdeci">static CLScheduler &amp; get()</div><div class="ttdoc">Access the scheduler singleton. </div></div>
223 <div class="ttc" id="classarm__compute_1_1_c_l_array_xhtml_a14c53d2d17be6fa8a2c9861527c7b002"><div class="ttname"><a href="classarm__compute_1_1_c_l_array.xhtml#a14c53d2d17be6fa8a2c9861527c7b002">arm_compute::CLArray::map</a></div><div class="ttdeci">void map(bool blocking=true)</div><div class="ttdoc">Enqueue a map operation of the allocated buffer. </div><div class="ttdef"><b>Definition:</b> <a href="_c_l_array_8h_source.xhtml#l00065">CLArray.h:65</a></div></div>
224 <div class="ttc" id="classarm__compute_1_1_i_array_xhtml_a2ff0fb106d58091d2b4363e808f200a3"><div class="ttname"><a href="classarm__compute_1_1_i_array.xhtml#a2ff0fb106d58091d2b4363e808f200a3">arm_compute::IArray::max_num_values</a></div><div class="ttdeci">size_t max_num_values() const </div><div class="ttdoc">Maximum number of values which can be stored in this array. </div><div class="ttdef"><b>Definition:</b> <a href="_i_array_8h_source.xhtml#l00059">IArray.h:59</a></div></div>
225 <div class="ttc" id="classarm__compute_1_1_c_l_array_xhtml_aaa923d0abf2a3a5722a728f39411ad07"><div class="ttname"><a href="classarm__compute_1_1_c_l_array.xhtml#aaa923d0abf2a3a5722a728f39411ad07">arm_compute::CLArray::CLArray</a></div><div class="ttdeci">CLArray(size_t max_num_values)</div><div class="ttdoc">Constructor: initializes an array which can contain up to max_num_points values. </div><div class="ttdef"><b>Definition:</b> <a href="_c_l_array_8h_source.xhtml#l00055">CLArray.h:55</a></div></div>
226 <div class="ttc" id="_error_8h_xhtml"><div class="ttname"><a href="_error_8h.xhtml">Error.h</a></div></div>
227 <div class="ttc" id="classarm__compute_1_1_i_c_l_array_xhtml_af974a2360069c2ef8df4496d00e4f6cc"><div class="ttname"><a href="classarm__compute_1_1_i_c_l_array.xhtml#af974a2360069c2ef8df4496d00e4f6cc">arm_compute::ICLArray::unmap</a></div><div class="ttdeci">void unmap(cl::CommandQueue &amp;q)</div><div class="ttdoc">Enqueue an unmap operation of the allocated and mapped buffer on the given queue. ...</div><div class="ttdef"><b>Definition:</b> <a href="_i_c_l_array_8h_source.xhtml#l00074">ICLArray.h:74</a></div></div>
228 <div class="ttc" id="classarm__compute_1_1_c_l_scheduler_xhtml"><div class="ttname"><a href="classarm__compute_1_1_c_l_scheduler.xhtml">arm_compute::CLScheduler</a></div><div class="ttdoc">Provides global access to a CL context and command queue. </div><div class="ttdef"><b>Definition:</b> <a href="_c_l_scheduler_8h_source.xhtml#l00062">CLScheduler.h:62</a></div></div>
229 <div class="ttc" id="_open_c_l_8h_xhtml"><div class="ttname"><a href="_open_c_l_8h.xhtml">OpenCL.h</a></div></div>
230 <div class="ttc" id="classarm__compute_1_1_c_l_array_xhtml"><div class="ttname"><a href="classarm__compute_1_1_c_l_array.xhtml">arm_compute::CLArray</a></div><div class="ttdoc">CLArray implementation. </div><div class="ttdef"><b>Definition:</b> <a href="_c_l_array_8h_source.xhtml#l00037">CLArray.h:37</a></div></div>
231 <div class="ttc" id="classarm__compute_1_1_c_l_array_xhtml_a36d785dc1a6a88471030943546aa8f51"><div class="ttname"><a href="classarm__compute_1_1_c_l_array.xhtml#a36d785dc1a6a88471030943546aa8f51">arm_compute::CLArray::operator=</a></div><div class="ttdeci">CLArray &amp; operator=(const CLArray &amp;)=delete</div><div class="ttdoc">Prevent instances of this class from being copied (As this class contains pointers) ...</div></div>
232 <div class="ttc" id="arm__compute_2core_2_types_8h_xhtml"><div class="ttname"><a href="arm__compute_2core_2_types_8h.xhtml">Types.h</a></div></div>
233 <div class="ttc" id="classarm__compute_1_1_c_l_array_xhtml_a1ffeb3b5abb3d61f62b58a391816201c"><div class="ttname"><a href="classarm__compute_1_1_c_l_array.xhtml#a1ffeb3b5abb3d61f62b58a391816201c">arm_compute::CLArray::unmap</a></div><div class="ttdeci">void unmap()</div><div class="ttdoc">Enqueue an unmap operation of the allocated and mapped buffer. </div><div class="ttdef"><b>Definition:</b> <a href="_c_l_array_8h_source.xhtml#l00075">CLArray.h:75</a></div></div>
234 </div><!-- fragment --></div><!-- contents -->
235 </div><!-- doc-content -->
236 <!-- start footer part -->
237 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
238   <ul>
239     <li class="navelem"><a class="el" href="dir_d4d363c0979c7ffda4833df3f93b5668.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="dir_9464f60aea3c9b524aea6b3ae09a377f.xhtml">runtime</a></li><li class="navelem"><a class="el" href="dir_2c7d6b75b4949414a550064c78df77e5.xhtml">CL</a></li><li class="navelem"><a class="el" href="_c_l_array_8h.xhtml">CLArray.h</a></li>
240     <li class="footer">Generated on Thu Oct 12 2017 14:26:33 for Compute Library by
241     <a href="http://www.doxygen.org/index.html">
242     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
243   </ul>
244 </div>
245 </body>
246 </html>