arm_compute v17.04
[platform/upstream/armcl.git] / documentation / classarm__compute_1_1_i_c_l_distribution1_d.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>ARM Compute Library: ICLDistribution1D 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">ARM Compute Library
43    &#160;<span id="projectnumber">17.04</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="namespaces.xhtml"><span>Namespaces</span></a></li>
59       <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
60       <li><a href="files.xhtml"><span>Files</span></a></li>
61       <li>
62         <div id="MSearchBox" class="MSearchBoxInactive">
63         <span class="left">
64           <img id="MSearchSelect" src="search/mag_sel.png"
65                onmouseover="return searchBox.OnSearchSelectShow()"
66                onmouseout="return searchBox.OnSearchSelectHide()"
67                alt=""/>
68           <input type="text" id="MSearchField" value="Search" accesskey="S"
69                onfocus="searchBox.OnSearchFieldFocus(true)" 
70                onblur="searchBox.OnSearchFieldFocus(false)" 
71                onkeyup="searchBox.OnSearchFieldChange(event)"/>
72           </span><span class="right">
73             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
74           </span>
75         </div>
76       </li>
77     </ul>
78   </div>
79   <div id="navrow2" class="tabs2">
80     <ul class="tablist">
81       <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
82       <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
83       <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
84       <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
85     </ul>
86   </div>
87 </div><!-- top -->
88 <div id="side-nav" class="ui-resizable side-nav-resizable">
89   <div id="nav-tree">
90     <div id="nav-tree-contents">
91       <div id="nav-sync" class="sync"></div>
92     </div>
93   </div>
94   <div id="splitbar" style="-moz-user-select:none;" 
95        class="ui-resizable-handle">
96   </div>
97 </div>
98 <script type="text/javascript">
99 $(document).ready(function(){initNavTree('classarm__compute_1_1_i_c_l_distribution1_d.xhtml','');});
100 </script>
101 <div id="doc-content">
102 <!-- window showing the filter options -->
103 <div id="MSearchSelectWindow"
104      onmouseover="return searchBox.OnSearchSelectShow()"
105      onmouseout="return searchBox.OnSearchSelectHide()"
106      onkeydown="return searchBox.OnSearchSelectKey(event)">
107 </div>
108
109 <!-- iframe showing the search results (closed by default) -->
110 <div id="MSearchResultsWindow">
111 <iframe src="javascript:void(0)" frameborder="0" 
112         name="MSearchResults" id="MSearchResults">
113 </iframe>
114 </div>
115
116 <div class="header">
117   <div class="summary">
118 <a href="#pub-methods">Public Member Functions</a>  </div>
119   <div class="headertitle">
120 <div class="title">ICLDistribution1D Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
121 </div><!--header-->
122 <div class="contents">
123
124 <p><a class="el" href="classarm__compute_1_1_i_c_l_distribution1_d.xhtml" title="ICLDistribution1D interface class. ">ICLDistribution1D</a> interface class.  
125  <a href="classarm__compute_1_1_i_c_l_distribution1_d.xhtml#details">More...</a></p>
126
127 <p><code>#include &lt;<a class="el" href="_i_c_l_distribution1_d_8h_source.xhtml">ICLDistribution1D.h</a>&gt;</code></p>
128 <div class="dynheader">
129 Collaboration diagram for ICLDistribution1D:</div>
130 <div class="dyncontent">
131 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_i_c_l_distribution1_d__coll__graph.svg" width="138" height="187"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
132 </div>
133 <center><span class="legend">[<a target="top" href="graph_legend.xhtml">legend</a>]</span></center></div>
134 <table class="memberdecls">
135 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
136 Public Member Functions</h2></td></tr>
137 <tr class="memitem:a0289f4eb4c6ca9ddcdc7d0926592a98f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_distribution1_d.xhtml#a0289f4eb4c6ca9ddcdc7d0926592a98f">ICLDistribution1D</a> (size_t <a class="el" href="classarm__compute_1_1_i_distribution1_d.xhtml#ae3664b841732a09d7749953ca5b81373">num_bins</a>, int32_t <a class="el" href="classarm__compute_1_1_i_distribution1_d.xhtml#ad952765741736e8e669876dd06636873">offset</a>, uint32_t <a class="el" href="classarm__compute_1_1_i_distribution1_d.xhtml#ac548d0ee88978d0ba481323aab25e46a">range</a>)</td></tr>
138 <tr class="memdesc:a0289f4eb4c6ca9ddcdc7d0926592a98f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor: Creates a 1D CLDistribution of a consecutive interval [offset, offset + range - 1] defined by a start offset and valid range, divided equally into num_bins parts.  <a href="#a0289f4eb4c6ca9ddcdc7d0926592a98f">More...</a><br /></td></tr>
139 <tr class="separator:a0289f4eb4c6ca9ddcdc7d0926592a98f"><td class="memSeparator" colspan="2">&#160;</td></tr>
140 <tr class="memitem:a298d976d9b3cf2a86f114292c1a58839"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_distribution1_d.xhtml#a298d976d9b3cf2a86f114292c1a58839">ICLDistribution1D</a> (const <a class="el" href="classarm__compute_1_1_i_c_l_distribution1_d.xhtml">ICLDistribution1D</a> &amp;)=delete</td></tr>
141 <tr class="memdesc:a298d976d9b3cf2a86f114292c1a58839"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers).  <a href="#a298d976d9b3cf2a86f114292c1a58839">More...</a><br /></td></tr>
142 <tr class="separator:a298d976d9b3cf2a86f114292c1a58839"><td class="memSeparator" colspan="2">&#160;</td></tr>
143 <tr class="memitem:a0182f7f14809fcf8e7d1b9c8afebeafd"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classarm__compute_1_1_i_c_l_distribution1_d.xhtml">ICLDistribution1D</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_distribution1_d.xhtml#a0182f7f14809fcf8e7d1b9c8afebeafd">operator=</a> (const <a class="el" href="classarm__compute_1_1_i_c_l_distribution1_d.xhtml">ICLDistribution1D</a> &amp;)=delete</td></tr>
144 <tr class="memdesc:a0182f7f14809fcf8e7d1b9c8afebeafd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers).  <a href="#a0182f7f14809fcf8e7d1b9c8afebeafd">More...</a><br /></td></tr>
145 <tr class="separator:a0182f7f14809fcf8e7d1b9c8afebeafd"><td class="memSeparator" colspan="2">&#160;</td></tr>
146 <tr class="memitem:ac0abc7a5c0d172947f0e6a0c0dde3df0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_distribution1_d.xhtml#ac0abc7a5c0d172947f0e6a0c0dde3df0">map</a> (cl::CommandQueue &amp;q, bool blocking=true)</td></tr>
147 <tr class="memdesc:ac0abc7a5c0d172947f0e6a0c0dde3df0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enqueue a map operation of the allocated buffer on the given queue.  <a href="#ac0abc7a5c0d172947f0e6a0c0dde3df0">More...</a><br /></td></tr>
148 <tr class="separator:ac0abc7a5c0d172947f0e6a0c0dde3df0"><td class="memSeparator" colspan="2">&#160;</td></tr>
149 <tr class="memitem:af974a2360069c2ef8df4496d00e4f6cc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_distribution1_d.xhtml#af974a2360069c2ef8df4496d00e4f6cc">unmap</a> (cl::CommandQueue &amp;q)</td></tr>
150 <tr class="memdesc:af974a2360069c2ef8df4496d00e4f6cc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enqueue an unmap operation of the allocated and mapped buffer on the given queue.  <a href="#af974a2360069c2ef8df4496d00e4f6cc">More...</a><br /></td></tr>
151 <tr class="separator:af974a2360069c2ef8df4496d00e4f6cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
152 <tr class="memitem:aea577b83a6734249a78ac036a23d5c6b"><td class="memItemLeft" align="right" valign="top">virtual cl::Buffer &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_distribution1_d.xhtml#aea577b83a6734249a78ac036a23d5c6b">cl_buffer</a> ()=0</td></tr>
153 <tr class="memdesc:aea577b83a6734249a78ac036a23d5c6b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interface to be implemented by the child class to return a reference to the OpenCL buffer containing the distribution's data.  <a href="#aea577b83a6734249a78ac036a23d5c6b">More...</a><br /></td></tr>
154 <tr class="separator:aea577b83a6734249a78ac036a23d5c6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
155 <tr class="memitem:a0a383529771c579b362ede2307c6bab9"><td class="memItemLeft" align="right" valign="top">uint32_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_c_l_distribution1_d.xhtml#a0a383529771c579b362ede2307c6bab9">buffer</a> () const override</td></tr>
156 <tr class="memdesc:a0a383529771c579b362ede2307c6bab9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a pointer to the start of the distribution.  <a href="#a0a383529771c579b362ede2307c6bab9">More...</a><br /></td></tr>
157 <tr class="separator:a0a383529771c579b362ede2307c6bab9"><td class="memSeparator" colspan="2">&#160;</td></tr>
158 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_distribution1_d"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_distribution1_d')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_distribution1_d.xhtml">IDistribution1D</a></td></tr>
159 <tr class="memitem:a9c3a40b0dbbd79ed909471d9e05283aa inherit pub_methods_classarm__compute_1_1_i_distribution1_d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_distribution1_d.xhtml#a9c3a40b0dbbd79ed909471d9e05283aa">IDistribution1D</a> (size_t <a class="el" href="classarm__compute_1_1_i_distribution1_d.xhtml#ae3664b841732a09d7749953ca5b81373">num_bins</a>, int32_t <a class="el" href="classarm__compute_1_1_i_distribution1_d.xhtml#ad952765741736e8e669876dd06636873">offset</a>, uint32_t <a class="el" href="classarm__compute_1_1_i_distribution1_d.xhtml#ac548d0ee88978d0ba481323aab25e46a">range</a>)</td></tr>
160 <tr class="memdesc:a9c3a40b0dbbd79ed909471d9e05283aa inherit pub_methods_classarm__compute_1_1_i_distribution1_d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor: Creates a 1D Distribution of a consecutive interval [offset, offset + range - 1] defined by a start offset and valid range, divided equally into num_bins parts.  <a href="#a9c3a40b0dbbd79ed909471d9e05283aa">More...</a><br /></td></tr>
161 <tr class="separator:a9c3a40b0dbbd79ed909471d9e05283aa inherit pub_methods_classarm__compute_1_1_i_distribution1_d"><td class="memSeparator" colspan="2">&#160;</td></tr>
162 <tr class="memitem:ae3664b841732a09d7749953ca5b81373 inherit pub_methods_classarm__compute_1_1_i_distribution1_d"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_distribution1_d.xhtml#ae3664b841732a09d7749953ca5b81373">num_bins</a> () const </td></tr>
163 <tr class="memdesc:ae3664b841732a09d7749953ca5b81373 inherit pub_methods_classarm__compute_1_1_i_distribution1_d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of bins that the distribution has.  <a href="#ae3664b841732a09d7749953ca5b81373">More...</a><br /></td></tr>
164 <tr class="separator:ae3664b841732a09d7749953ca5b81373 inherit pub_methods_classarm__compute_1_1_i_distribution1_d"><td class="memSeparator" colspan="2">&#160;</td></tr>
165 <tr class="memitem:ad952765741736e8e669876dd06636873 inherit pub_methods_classarm__compute_1_1_i_distribution1_d"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_distribution1_d.xhtml#ad952765741736e8e669876dd06636873">offset</a> () const </td></tr>
166 <tr class="memdesc:ad952765741736e8e669876dd06636873 inherit pub_methods_classarm__compute_1_1_i_distribution1_d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the offset of the distribution.  <a href="#ad952765741736e8e669876dd06636873">More...</a><br /></td></tr>
167 <tr class="separator:ad952765741736e8e669876dd06636873 inherit pub_methods_classarm__compute_1_1_i_distribution1_d"><td class="memSeparator" colspan="2">&#160;</td></tr>
168 <tr class="memitem:ac548d0ee88978d0ba481323aab25e46a inherit pub_methods_classarm__compute_1_1_i_distribution1_d"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_distribution1_d.xhtml#ac548d0ee88978d0ba481323aab25e46a">range</a> () const </td></tr>
169 <tr class="memdesc:ac548d0ee88978d0ba481323aab25e46a inherit pub_methods_classarm__compute_1_1_i_distribution1_d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the range of the distribution.  <a href="#ac548d0ee88978d0ba481323aab25e46a">More...</a><br /></td></tr>
170 <tr class="separator:ac548d0ee88978d0ba481323aab25e46a inherit pub_methods_classarm__compute_1_1_i_distribution1_d"><td class="memSeparator" colspan="2">&#160;</td></tr>
171 <tr class="memitem:a862904f65dffef9c8a72d3aeadc56be1 inherit pub_methods_classarm__compute_1_1_i_distribution1_d"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_distribution1_d.xhtml#a862904f65dffef9c8a72d3aeadc56be1">window</a> () const </td></tr>
172 <tr class="memdesc:a862904f65dffef9c8a72d3aeadc56be1 inherit pub_methods_classarm__compute_1_1_i_distribution1_d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the window of the distribution, which is the range divided by the number of bins.  <a href="#a862904f65dffef9c8a72d3aeadc56be1">More...</a><br /></td></tr>
173 <tr class="separator:a862904f65dffef9c8a72d3aeadc56be1 inherit pub_methods_classarm__compute_1_1_i_distribution1_d"><td class="memSeparator" colspan="2">&#160;</td></tr>
174 <tr class="memitem:a9027aed7fdb902ebc243647c8c3fbea2 inherit pub_methods_classarm__compute_1_1_i_distribution1_d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_distribution1_d.xhtml#a9027aed7fdb902ebc243647c8c3fbea2">set_range</a> (uint32_t <a class="el" href="classarm__compute_1_1_i_distribution1_d.xhtml#ac548d0ee88978d0ba481323aab25e46a">range</a>)</td></tr>
175 <tr class="memdesc:a9027aed7fdb902ebc243647c8c3fbea2 inherit pub_methods_classarm__compute_1_1_i_distribution1_d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the range of the distribution.  <a href="#a9027aed7fdb902ebc243647c8c3fbea2">More...</a><br /></td></tr>
176 <tr class="separator:a9027aed7fdb902ebc243647c8c3fbea2 inherit pub_methods_classarm__compute_1_1_i_distribution1_d"><td class="memSeparator" colspan="2">&#160;</td></tr>
177 <tr class="memitem:ad7701a09a964eab360a8e51fa7ad2c16 inherit pub_methods_classarm__compute_1_1_i_distribution1_d"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_distribution1_d.xhtml#ad7701a09a964eab360a8e51fa7ad2c16">size</a> () const override</td></tr>
178 <tr class="memdesc:ad7701a09a964eab360a8e51fa7ad2c16 inherit pub_methods_classarm__compute_1_1_i_distribution1_d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the total size in bytes of the distribution.  <a href="#ad7701a09a964eab360a8e51fa7ad2c16">More...</a><br /></td></tr>
179 <tr class="separator:ad7701a09a964eab360a8e51fa7ad2c16 inherit pub_methods_classarm__compute_1_1_i_distribution1_d"><td class="memSeparator" colspan="2">&#160;</td></tr>
180 <tr class="memitem:ad251169c06da412071bdfb6e92444e6e inherit pub_methods_classarm__compute_1_1_i_distribution1_d"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_distribution1_d.xhtml#ad251169c06da412071bdfb6e92444e6e">dimensions</a> () const override</td></tr>
181 <tr class="memdesc:ad251169c06da412071bdfb6e92444e6e inherit pub_methods_classarm__compute_1_1_i_distribution1_d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the dimensions of the distribution.  <a href="#ad251169c06da412071bdfb6e92444e6e">More...</a><br /></td></tr>
182 <tr class="separator:ad251169c06da412071bdfb6e92444e6e inherit pub_methods_classarm__compute_1_1_i_distribution1_d"><td class="memSeparator" colspan="2">&#160;</td></tr>
183 <tr class="inherit_header pub_methods_classarm__compute_1_1_i_distribution"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classarm__compute_1_1_i_distribution')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_distribution.xhtml">IDistribution</a></td></tr>
184 <tr class="memitem:a9ee18d758810dbcfb1c9717956f51c38 inherit pub_methods_classarm__compute_1_1_i_distribution"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_distribution.xhtml#a9ee18d758810dbcfb1c9717956f51c38">~IDistribution</a> ()=default</td></tr>
185 <tr class="memdesc:a9ee18d758810dbcfb1c9717956f51c38 inherit pub_methods_classarm__compute_1_1_i_distribution"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default virtual destructor.  <a href="#a9ee18d758810dbcfb1c9717956f51c38">More...</a><br /></td></tr>
186 <tr class="separator:a9ee18d758810dbcfb1c9717956f51c38 inherit pub_methods_classarm__compute_1_1_i_distribution"><td class="memSeparator" colspan="2">&#160;</td></tr>
187 <tr class="memitem:a5b0c20bea8c40bf73b3160cb1e0da350 inherit pub_methods_classarm__compute_1_1_i_distribution"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_distribution.xhtml#a5b0c20bea8c40bf73b3160cb1e0da350">clear</a> () const </td></tr>
188 <tr class="memdesc:a5b0c20bea8c40bf73b3160cb1e0da350 inherit pub_methods_classarm__compute_1_1_i_distribution"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clears the distribution by setting every element to zero.  <a href="#a5b0c20bea8c40bf73b3160cb1e0da350">More...</a><br /></td></tr>
189 <tr class="separator:a5b0c20bea8c40bf73b3160cb1e0da350 inherit pub_methods_classarm__compute_1_1_i_distribution"><td class="memSeparator" colspan="2">&#160;</td></tr>
190 </table>
191 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
192 <div class="textblock"><p><a class="el" href="classarm__compute_1_1_i_c_l_distribution1_d.xhtml" title="ICLDistribution1D interface class. ">ICLDistribution1D</a> interface class. </p>
193
194 <p>Definition at line <a class="el" href="_i_c_l_distribution1_d_8h_source.xhtml#l00041">41</a> of file <a class="el" href="_i_c_l_distribution1_d_8h_source.xhtml">ICLDistribution1D.h</a>.</p>
195 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
196 <a class="anchor" id="a0289f4eb4c6ca9ddcdc7d0926592a98f"></a>
197 <div class="memitem">
198 <div class="memproto">
199       <table class="memname">
200         <tr>
201           <td class="memname"><a class="el" href="classarm__compute_1_1_i_c_l_distribution1_d.xhtml">ICLDistribution1D</a> </td>
202           <td>(</td>
203           <td class="paramtype">size_t&#160;</td>
204           <td class="paramname"><em>num_bins</em>, </td>
205         </tr>
206         <tr>
207           <td class="paramkey"></td>
208           <td></td>
209           <td class="paramtype">int32_t&#160;</td>
210           <td class="paramname"><em>offset</em>, </td>
211         </tr>
212         <tr>
213           <td class="paramkey"></td>
214           <td></td>
215           <td class="paramtype">uint32_t&#160;</td>
216           <td class="paramname"><em>range</em>&#160;</td>
217         </tr>
218         <tr>
219           <td></td>
220           <td>)</td>
221           <td></td><td></td>
222         </tr>
223       </table>
224 </div><div class="memdoc">
225
226 <p>Constructor: Creates a 1D CLDistribution of a consecutive interval [offset, offset + range - 1] defined by a start offset and valid range, divided equally into num_bins parts. </p>
227 <dl class="params"><dt>Parameters</dt><dd>
228   <table class="params">
229     <tr><td class="paramdir">[in]</td><td class="paramname">num_bins</td><td>The number of bins the distribution is divided in. </td></tr>
230     <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The start of the values to use. </td></tr>
231     <tr><td class="paramdir">[in]</td><td class="paramname">range</td><td>The total number of the consecutive values of the distribution interval. </td></tr>
232   </table>
233   </dd>
234 </dl>
235
236 </div>
237 </div>
238 <a class="anchor" id="a298d976d9b3cf2a86f114292c1a58839"></a>
239 <div class="memitem">
240 <div class="memproto">
241 <table class="mlabels">
242   <tr>
243   <td class="mlabels-left">
244       <table class="memname">
245         <tr>
246           <td class="memname"><a class="el" href="classarm__compute_1_1_i_c_l_distribution1_d.xhtml">ICLDistribution1D</a> </td>
247           <td>(</td>
248           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_c_l_distribution1_d.xhtml">ICLDistribution1D</a> &amp;&#160;</td>
249           <td class="paramname"></td><td>)</td>
250           <td></td>
251         </tr>
252       </table>
253   </td>
254   <td class="mlabels-right">
255 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
256   </tr>
257 </table>
258 </div><div class="memdoc">
259
260 <p>Prevent instances of this class from being copied (As this class contains pointers). </p>
261
262 </div>
263 </div>
264 <h2 class="groupheader">Member Function Documentation</h2>
265 <a class="anchor" id="a0a383529771c579b362ede2307c6bab9"></a>
266 <div class="memitem">
267 <div class="memproto">
268 <table class="mlabels">
269   <tr>
270   <td class="mlabels-left">
271       <table class="memname">
272         <tr>
273           <td class="memname">uint32_t* buffer </td>
274           <td>(</td>
275           <td class="paramname"></td><td>)</td>
276           <td> const</td>
277         </tr>
278       </table>
279   </td>
280   <td class="mlabels-right">
281 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
282   </tr>
283 </table>
284 </div><div class="memdoc">
285
286 <p>Returns a pointer to the start of the distribution. </p>
287 <p>Other elements of the array can be accessed using <a class="el" href="classarm__compute_1_1_i_c_l_distribution1_d.xhtml#a0a383529771c579b362ede2307c6bab9" title="Returns a pointer to the start of the distribution. ">buffer()</a>[idx] for 0 &lt;= idx &lt; <a class="el" href="classarm__compute_1_1_i_distribution1_d.xhtml#ae3664b841732a09d7749953ca5b81373" title="Returns the number of bins that the distribution has. ">num_bins()</a></p>
288 <dl class="section return"><dt>Returns</dt><dd>Pointer to the start of the distribution. </dd></dl>
289
290 <p>Implements <a class="el" href="classarm__compute_1_1_i_distribution.xhtml#a0eb5856c63562cb144938ed77d6823a0">IDistribution</a>.</p>
291
292 </div>
293 </div>
294 <a class="anchor" id="aea577b83a6734249a78ac036a23d5c6b"></a>
295 <div class="memitem">
296 <div class="memproto">
297 <table class="mlabels">
298   <tr>
299   <td class="mlabels-left">
300       <table class="memname">
301         <tr>
302           <td class="memname">virtual cl::Buffer&amp; cl_buffer </td>
303           <td>(</td>
304           <td class="paramname"></td><td>)</td>
305           <td></td>
306         </tr>
307       </table>
308   </td>
309   <td class="mlabels-right">
310 <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
311   </tr>
312 </table>
313 </div><div class="memdoc">
314
315 <p>Interface to be implemented by the child class to return a reference to the OpenCL buffer containing the distribution's data. </p>
316 <dl class="section return"><dt>Returns</dt><dd>A reference to an OpenCL buffer containing the distribution's data. </dd></dl>
317
318 <p>Implemented in <a class="el" href="classarm__compute_1_1_c_l_distribution1_d.xhtml#a55dcc12377d15f244c59975f7cd1f623">CLDistribution1D</a>.</p>
319
320 </div>
321 </div>
322 <a class="anchor" id="ac0abc7a5c0d172947f0e6a0c0dde3df0"></a>
323 <div class="memitem">
324 <div class="memproto">
325       <table class="memname">
326         <tr>
327           <td class="memname">void map </td>
328           <td>(</td>
329           <td class="paramtype">cl::CommandQueue &amp;&#160;</td>
330           <td class="paramname"><em>q</em>, </td>
331         </tr>
332         <tr>
333           <td class="paramkey"></td>
334           <td></td>
335           <td class="paramtype">bool&#160;</td>
336           <td class="paramname"><em>blocking</em> = <code>true</code>&#160;</td>
337         </tr>
338         <tr>
339           <td></td>
340           <td>)</td>
341           <td></td><td></td>
342         </tr>
343       </table>
344 </div><div class="memdoc">
345
346 <p>Enqueue a map operation of the allocated buffer on the given queue. </p>
347 <dl class="params"><dt>Parameters</dt><dd>
348   <table class="params">
349     <tr><td class="paramdir">[in,out]</td><td class="paramname">q</td><td>The CL command queue to use for the mapping operation. </td></tr>
350     <tr><td class="paramdir">[in]</td><td class="paramname">blocking</td><td>If true, then the mapping will be ready to use by the time this method returns, else it is the caller's responsibility to flush the queue and wait for the mapping operation to have completed before using the returned mapping pointer. </td></tr>
351   </table>
352   </dd>
353 </dl>
354
355 </div>
356 </div>
357 <a class="anchor" id="a0182f7f14809fcf8e7d1b9c8afebeafd"></a>
358 <div class="memitem">
359 <div class="memproto">
360 <table class="mlabels">
361   <tr>
362   <td class="mlabels-left">
363       <table class="memname">
364         <tr>
365           <td class="memname">const <a class="el" href="classarm__compute_1_1_i_c_l_distribution1_d.xhtml">ICLDistribution1D</a>&amp; operator= </td>
366           <td>(</td>
367           <td class="paramtype">const <a class="el" href="classarm__compute_1_1_i_c_l_distribution1_d.xhtml">ICLDistribution1D</a> &amp;&#160;</td>
368           <td class="paramname"></td><td>)</td>
369           <td></td>
370         </tr>
371       </table>
372   </td>
373   <td class="mlabels-right">
374 <span class="mlabels"><span class="mlabel">delete</span></span>  </td>
375   </tr>
376 </table>
377 </div><div class="memdoc">
378
379 <p>Prevent instances of this class from being copied (As this class contains pointers). </p>
380
381 </div>
382 </div>
383 <a class="anchor" id="af974a2360069c2ef8df4496d00e4f6cc"></a>
384 <div class="memitem">
385 <div class="memproto">
386       <table class="memname">
387         <tr>
388           <td class="memname">void unmap </td>
389           <td>(</td>
390           <td class="paramtype">cl::CommandQueue &amp;&#160;</td>
391           <td class="paramname"><em>q</em></td><td>)</td>
392           <td></td>
393         </tr>
394       </table>
395 </div><div class="memdoc">
396
397 <p>Enqueue an unmap operation of the allocated and mapped buffer on the given queue. </p>
398 <dl class="section note"><dt>Note</dt><dd>This method simply enqueues the unmap operation, it is the caller's responsibility to flush the queue and make sure the unmap is finished before the memory is accessed by the device.</dd></dl>
399 <dl class="params"><dt>Parameters</dt><dd>
400   <table class="params">
401     <tr><td class="paramdir">[in,out]</td><td class="paramname">q</td><td>The CL command queue to use for the mapping operation. </td></tr>
402   </table>
403   </dd>
404 </dl>
405
406 </div>
407 </div>
408 <hr/>The documentation for this class was generated from the following file:<ul>
409 <li>arm_compute/core/CL/<a class="el" href="_i_c_l_distribution1_d_8h_source.xhtml">ICLDistribution1D.h</a></li>
410 </ul>
411 </div><!-- contents -->
412 </div><!-- doc-content -->
413 <!-- start footer part -->
414 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
415   <ul>
416     <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_i_c_l_distribution1_d.xhtml">ICLDistribution1D</a></li>
417     <li class="footer">Generated on Wed Apr 12 2017 14:26:06 for ARM Compute Library by
418     <a href="http://www.doxygen.org/index.html">
419     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
420   </ul>
421 </div>
422 </body>
423 </html>