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>ARM Compute Library: IDistribution 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">ARM Compute Library
43  <span id="projectnumber">17.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="namespaces.xhtml"><span>Namespaces</span></a></li>
59 <li class="current"><a href="annotated.xhtml"><span>Data Structures</span></a></li>
60 <li><a href="files.xhtml"><span>Files</span></a></li>
62 <div id="MSearchBox" class="MSearchBoxInactive">
64 <img id="MSearchSelect" src="search/mag_sel.png"
65 onmouseover="return searchBox.OnSearchSelectShow()"
66 onmouseout="return searchBox.OnSearchSelectHide()"
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>
79 <div id="navrow2" class="tabs2">
81 <li><a href="annotated.xhtml"><span>Data Structures</span></a></li>
82 <li><a href="classes.xhtml"><span>Data Structure Index</span></a></li>
83 <li><a href="inherits.xhtml"><span>Class Hierarchy</span></a></li>
84 <li><a href="functions.xhtml"><span>Data Fields</span></a></li>
88 <div id="side-nav" class="ui-resizable side-nav-resizable">
90 <div id="nav-tree-contents">
91 <div id="nav-sync" class="sync"></div>
94 <div id="splitbar" style="-moz-user-select:none;"
95 class="ui-resizable-handle">
98 <script type="text/javascript">
99 $(document).ready(function(){initNavTree('classarm__compute_1_1_i_distribution.xhtml','');});
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)">
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">
117 <div class="summary">
118 <a href="#pub-methods">Public Member Functions</a> </div>
119 <div class="headertitle">
120 <div class="title">IDistribution Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
122 <div class="contents">
124 <p>Interface for distribution objects.
125 <a href="classarm__compute_1_1_i_distribution.xhtml#details">More...</a></p>
127 <p><code>#include <<a class="el" href="_i_distribution_8h_source.xhtml">IDistribution.h</a>></code></p>
128 <table class="memberdecls">
129 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
130 Public Member Functions</h2></td></tr>
131 <tr class="memitem:a9ee18d758810dbcfb1c9717956f51c38"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_distribution.xhtml#a9ee18d758810dbcfb1c9717956f51c38">~IDistribution</a> ()=default</td></tr>
132 <tr class="memdesc:a9ee18d758810dbcfb1c9717956f51c38"><td class="mdescLeft"> </td><td class="mdescRight">Default virtual destructor. <a href="#a9ee18d758810dbcfb1c9717956f51c38">More...</a><br /></td></tr>
133 <tr class="separator:a9ee18d758810dbcfb1c9717956f51c38"><td class="memSeparator" colspan="2"> </td></tr>
134 <tr class="memitem:a254be7b34cd78d12ffc7ed2aba4882b1"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_distribution.xhtml#a254be7b34cd78d12ffc7ed2aba4882b1">dimensions</a> () const =0</td></tr>
135 <tr class="memdesc:a254be7b34cd78d12ffc7ed2aba4882b1"><td class="mdescLeft"> </td><td class="mdescRight">Returns the dimensions of the distribution. <a href="#a254be7b34cd78d12ffc7ed2aba4882b1">More...</a><br /></td></tr>
136 <tr class="separator:a254be7b34cd78d12ffc7ed2aba4882b1"><td class="memSeparator" colspan="2"> </td></tr>
137 <tr class="memitem:aa983ddaeded5756189f46428be79c631"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_distribution.xhtml#aa983ddaeded5756189f46428be79c631">size</a> () const =0</td></tr>
138 <tr class="memdesc:aa983ddaeded5756189f46428be79c631"><td class="mdescLeft"> </td><td class="mdescRight">Returns the total size in bytes of the distribution. <a href="#aa983ddaeded5756189f46428be79c631">More...</a><br /></td></tr>
139 <tr class="separator:aa983ddaeded5756189f46428be79c631"><td class="memSeparator" colspan="2"> </td></tr>
140 <tr class="memitem:a0eb5856c63562cb144938ed77d6823a0"><td class="memItemLeft" align="right" valign="top">virtual uint32_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_distribution.xhtml#a0eb5856c63562cb144938ed77d6823a0">buffer</a> () const =0</td></tr>
141 <tr class="memdesc:a0eb5856c63562cb144938ed77d6823a0"><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer to the start of the distribution. <a href="#a0eb5856c63562cb144938ed77d6823a0">More...</a><br /></td></tr>
142 <tr class="separator:a0eb5856c63562cb144938ed77d6823a0"><td class="memSeparator" colspan="2"> </td></tr>
143 <tr class="memitem:a5b0c20bea8c40bf73b3160cb1e0da350"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_distribution.xhtml#a5b0c20bea8c40bf73b3160cb1e0da350">clear</a> () const </td></tr>
144 <tr class="memdesc:a5b0c20bea8c40bf73b3160cb1e0da350"><td class="mdescLeft"> </td><td class="mdescRight">Clears the distribution by setting every element to zero. <a href="#a5b0c20bea8c40bf73b3160cb1e0da350">More...</a><br /></td></tr>
145 <tr class="separator:a5b0c20bea8c40bf73b3160cb1e0da350"><td class="memSeparator" colspan="2"> </td></tr>
147 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
148 <div class="textblock"><p>Interface for distribution objects. </p>
150 <p>Definition at line <a class="el" href="_i_distribution_8h_source.xhtml#l00033">33</a> of file <a class="el" href="_i_distribution_8h_source.xhtml">IDistribution.h</a>.</p>
151 </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
152 <a class="anchor" id="a9ee18d758810dbcfb1c9717956f51c38"></a>
153 <div class="memitem">
154 <div class="memproto">
155 <table class="mlabels">
157 <td class="mlabels-left">
158 <table class="memname">
160 <td class="memname">virtual ~<a class="el" href="classarm__compute_1_1_i_distribution.xhtml">IDistribution</a> </td>
162 <td class="paramname"></td><td>)</td>
167 <td class="mlabels-right">
168 <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span> </td>
171 </div><div class="memdoc">
173 <p>Default virtual destructor. </p>
177 <h2 class="groupheader">Member Function Documentation</h2>
178 <a class="anchor" id="a0eb5856c63562cb144938ed77d6823a0"></a>
179 <div class="memitem">
180 <div class="memproto">
181 <table class="mlabels">
183 <td class="mlabels-left">
184 <table class="memname">
186 <td class="memname">virtual uint32_t* buffer </td>
188 <td class="paramname"></td><td>)</td>
193 <td class="mlabels-right">
194 <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
197 </div><div class="memdoc">
199 <p>Returns a pointer to the start of the distribution. </p>
200 <p>Other elements of the array can be accessed using <a class="el" href="classarm__compute_1_1_i_distribution.xhtml#a0eb5856c63562cb144938ed77d6823a0" title="Returns a pointer to the start of the distribution. ">buffer()</a>[idx] for 0 <= idx < num_bins()</p>
201 <dl class="section return"><dt>Returns</dt><dd>Pointer to the start of the distribution. </dd></dl>
203 <p>Implemented in <a class="el" href="classarm__compute_1_1_i_c_l_distribution1_d.xhtml#a0a383529771c579b362ede2307c6bab9">ICLDistribution1D</a>, and <a class="el" href="classarm__compute_1_1_distribution1_d.xhtml#a0a383529771c579b362ede2307c6bab9">Distribution1D</a>.</p>
207 <a class="anchor" id="a5b0c20bea8c40bf73b3160cb1e0da350"></a>
208 <div class="memitem">
209 <div class="memproto">
210 <table class="memname">
212 <td class="memname">void clear </td>
214 <td class="paramname"></td><td>)</td>
218 </div><div class="memdoc">
220 <p>Clears the distribution by setting every element to zero. </p>
224 <a class="anchor" id="a254be7b34cd78d12ffc7ed2aba4882b1"></a>
225 <div class="memitem">
226 <div class="memproto">
227 <table class="mlabels">
229 <td class="mlabels-left">
230 <table class="memname">
232 <td class="memname">virtual size_t dimensions </td>
234 <td class="paramname"></td><td>)</td>
239 <td class="mlabels-right">
240 <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
243 </div><div class="memdoc">
245 <p>Returns the dimensions of the distribution. </p>
246 <dl class="section note"><dt>Note</dt><dd>This is fixed to 1-dimensional distribution for now. </dd></dl>
247 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="classarm__compute_1_1_dimensions.xhtml" title="Dimensions with dimensionality. ">Dimensions</a> of the distribution. </dd></dl>
249 <p>Implemented in <a class="el" href="classarm__compute_1_1_i_distribution1_d.xhtml#ad251169c06da412071bdfb6e92444e6e">IDistribution1D</a>.</p>
253 <a class="anchor" id="aa983ddaeded5756189f46428be79c631"></a>
254 <div class="memitem">
255 <div class="memproto">
256 <table class="mlabels">
258 <td class="mlabels-left">
259 <table class="memname">
261 <td class="memname">virtual size_t size </td>
263 <td class="paramname"></td><td>)</td>
268 <td class="mlabels-right">
269 <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
272 </div><div class="memdoc">
274 <p>Returns the total size in bytes of the distribution. </p>
275 <dl class="section return"><dt>Returns</dt><dd>Total size of the distribution in bytes. </dd></dl>
277 <p>Implemented in <a class="el" href="classarm__compute_1_1_i_distribution1_d.xhtml#ad7701a09a964eab360a8e51fa7ad2c16">IDistribution1D</a>.</p>
281 <hr/>The documentation for this class was generated from the following file:<ul>
282 <li>arm_compute/core/<a class="el" href="_i_distribution_8h_source.xhtml">IDistribution.h</a></li>
284 </div><!-- contents -->
285 </div><!-- doc-content -->
286 <!-- start footer part -->
287 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
289 <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_distribution.xhtml">IDistribution</a></li>
290 <li class="footer">Generated on Wed May 3 2017 17:20:05 for ARM Compute Library by
291 <a href="http://www.doxygen.org/index.html">
292 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>