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: IDistribution1D 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.04</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_distribution1_d.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">IDistribution1D Class Reference</div> </div>
122 <div class="contents">
124 <p>1D Distribution interface
125 <a href="classarm__compute_1_1_i_distribution1_d.xhtml#details">More...</a></p>
127 <p><code>#include <<a class="el" href="_i_distribution1_d_8h_source.xhtml">IDistribution1D.h</a>></code></p>
128 <div class="dynheader">
129 Collaboration diagram for IDistribution1D:</div>
130 <div class="dyncontent">
131 <div class="center"><iframe scrolling="no" frameborder="0" src="classarm__compute_1_1_i_distribution1_d__coll__graph.svg" width="120" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
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:a9c3a40b0dbbd79ed909471d9e05283aa"><td class="memItemLeft" align="right" valign="top"> </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>
138 <tr class="memdesc:a9c3a40b0dbbd79ed909471d9e05283aa"><td class="mdescLeft"> </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>
139 <tr class="separator:a9c3a40b0dbbd79ed909471d9e05283aa"><td class="memSeparator" colspan="2"> </td></tr>
140 <tr class="memitem:ae3664b841732a09d7749953ca5b81373"><td class="memItemLeft" align="right" valign="top">size_t </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>
141 <tr class="memdesc:ae3664b841732a09d7749953ca5b81373"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of bins that the distribution has. <a href="#ae3664b841732a09d7749953ca5b81373">More...</a><br /></td></tr>
142 <tr class="separator:ae3664b841732a09d7749953ca5b81373"><td class="memSeparator" colspan="2"> </td></tr>
143 <tr class="memitem:ad952765741736e8e669876dd06636873"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_distribution1_d.xhtml#ad952765741736e8e669876dd06636873">offset</a> () const </td></tr>
144 <tr class="memdesc:ad952765741736e8e669876dd06636873"><td class="mdescLeft"> </td><td class="mdescRight">Returns the offset of the distribution. <a href="#ad952765741736e8e669876dd06636873">More...</a><br /></td></tr>
145 <tr class="separator:ad952765741736e8e669876dd06636873"><td class="memSeparator" colspan="2"> </td></tr>
146 <tr class="memitem:ac548d0ee88978d0ba481323aab25e46a"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_distribution1_d.xhtml#ac548d0ee88978d0ba481323aab25e46a">range</a> () const </td></tr>
147 <tr class="memdesc:ac548d0ee88978d0ba481323aab25e46a"><td class="mdescLeft"> </td><td class="mdescRight">Returns the range of the distribution. <a href="#ac548d0ee88978d0ba481323aab25e46a">More...</a><br /></td></tr>
148 <tr class="separator:ac548d0ee88978d0ba481323aab25e46a"><td class="memSeparator" colspan="2"> </td></tr>
149 <tr class="memitem:a862904f65dffef9c8a72d3aeadc56be1"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1_i_distribution1_d.xhtml#a862904f65dffef9c8a72d3aeadc56be1">window</a> () const </td></tr>
150 <tr class="memdesc:a862904f65dffef9c8a72d3aeadc56be1"><td class="mdescLeft"> </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>
151 <tr class="separator:a862904f65dffef9c8a72d3aeadc56be1"><td class="memSeparator" colspan="2"> </td></tr>
152 <tr class="memitem:a9027aed7fdb902ebc243647c8c3fbea2"><td class="memItemLeft" align="right" valign="top">void </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>
153 <tr class="memdesc:a9027aed7fdb902ebc243647c8c3fbea2"><td class="mdescLeft"> </td><td class="mdescRight">Sets the range of the distribution. <a href="#a9027aed7fdb902ebc243647c8c3fbea2">More...</a><br /></td></tr>
154 <tr class="separator:a9027aed7fdb902ebc243647c8c3fbea2"><td class="memSeparator" colspan="2"> </td></tr>
155 <tr class="memitem:ad7701a09a964eab360a8e51fa7ad2c16"><td class="memItemLeft" align="right" valign="top">size_t </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>
156 <tr class="memdesc:ad7701a09a964eab360a8e51fa7ad2c16"><td class="mdescLeft"> </td><td class="mdescRight">Returns the total size in bytes of the distribution. <a href="#ad7701a09a964eab360a8e51fa7ad2c16">More...</a><br /></td></tr>
157 <tr class="separator:ad7701a09a964eab360a8e51fa7ad2c16"><td class="memSeparator" colspan="2"> </td></tr>
158 <tr class="memitem:ad251169c06da412071bdfb6e92444e6e"><td class="memItemLeft" align="right" valign="top">size_t </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>
159 <tr class="memdesc:ad251169c06da412071bdfb6e92444e6e"><td class="mdescLeft"> </td><td class="mdescRight">Returns the dimensions of the distribution. <a href="#ad251169c06da412071bdfb6e92444e6e">More...</a><br /></td></tr>
160 <tr class="separator:ad251169c06da412071bdfb6e92444e6e"><td class="memSeparator" colspan="2"> </td></tr>
161 <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="-"/> Public Member Functions inherited from <a class="el" href="classarm__compute_1_1_i_distribution.xhtml">IDistribution</a></td></tr>
162 <tr class="memitem:a9ee18d758810dbcfb1c9717956f51c38 inherit pub_methods_classarm__compute_1_1_i_distribution"><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>
163 <tr class="memdesc:a9ee18d758810dbcfb1c9717956f51c38 inherit pub_methods_classarm__compute_1_1_i_distribution"><td class="mdescLeft"> </td><td class="mdescRight">Default virtual destructor. <a href="#a9ee18d758810dbcfb1c9717956f51c38">More...</a><br /></td></tr>
164 <tr class="separator:a9ee18d758810dbcfb1c9717956f51c38 inherit pub_methods_classarm__compute_1_1_i_distribution"><td class="memSeparator" colspan="2"> </td></tr>
165 <tr class="memitem:a0eb5856c63562cb144938ed77d6823a0 inherit pub_methods_classarm__compute_1_1_i_distribution"><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>
166 <tr class="memdesc:a0eb5856c63562cb144938ed77d6823a0 inherit pub_methods_classarm__compute_1_1_i_distribution"><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer to the start of the distribution. <a href="#a0eb5856c63562cb144938ed77d6823a0">More...</a><br /></td></tr>
167 <tr class="separator:a0eb5856c63562cb144938ed77d6823a0 inherit pub_methods_classarm__compute_1_1_i_distribution"><td class="memSeparator" colspan="2"> </td></tr>
168 <tr class="memitem:a5b0c20bea8c40bf73b3160cb1e0da350 inherit pub_methods_classarm__compute_1_1_i_distribution"><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>
169 <tr class="memdesc:a5b0c20bea8c40bf73b3160cb1e0da350 inherit pub_methods_classarm__compute_1_1_i_distribution"><td class="mdescLeft"> </td><td class="mdescRight">Clears the distribution by setting every element to zero. <a href="#a5b0c20bea8c40bf73b3160cb1e0da350">More...</a><br /></td></tr>
170 <tr class="separator:a5b0c20bea8c40bf73b3160cb1e0da350 inherit pub_methods_classarm__compute_1_1_i_distribution"><td class="memSeparator" colspan="2"> </td></tr>
172 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
173 <div class="textblock"><p>1D Distribution interface </p>
175 <p>Definition at line <a class="el" href="_i_distribution1_d_8h_source.xhtml#l00035">35</a> of file <a class="el" href="_i_distribution1_d_8h_source.xhtml">IDistribution1D.h</a>.</p>
176 </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
177 <a class="anchor" id="a9c3a40b0dbbd79ed909471d9e05283aa"></a>
178 <div class="memitem">
179 <div class="memproto">
180 <table class="memname">
182 <td class="memname"><a class="el" href="classarm__compute_1_1_i_distribution1_d.xhtml">IDistribution1D</a> </td>
184 <td class="paramtype">size_t </td>
185 <td class="paramname"><em>num_bins</em>, </td>
188 <td class="paramkey"></td>
190 <td class="paramtype">int32_t </td>
191 <td class="paramname"><em>offset</em>, </td>
194 <td class="paramkey"></td>
196 <td class="paramtype">uint32_t </td>
197 <td class="paramname"><em>range</em> </td>
205 </div><div class="memdoc">
207 <p>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. </p>
208 <dl class="params"><dt>Parameters</dt><dd>
209 <table class="params">
210 <tr><td class="paramdir">[in]</td><td class="paramname">num_bins</td><td>The number of bins the distribution is divided in. </td></tr>
211 <tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>The start of the values to use. </td></tr>
212 <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>
219 <h2 class="groupheader">Member Function Documentation</h2>
220 <a class="anchor" id="ad251169c06da412071bdfb6e92444e6e"></a>
221 <div class="memitem">
222 <div class="memproto">
223 <table class="mlabels">
225 <td class="mlabels-left">
226 <table class="memname">
228 <td class="memname">size_t dimensions </td>
230 <td class="paramname"></td><td>)</td>
235 <td class="mlabels-right">
236 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
239 </div><div class="memdoc">
241 <p>Returns the dimensions of the distribution. </p>
242 <dl class="section note"><dt>Note</dt><dd>This is fixed to 1-dimensional distribution for now. </dd></dl>
243 <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>
245 <p>Implements <a class="el" href="classarm__compute_1_1_i_distribution.xhtml#a254be7b34cd78d12ffc7ed2aba4882b1">IDistribution</a>.</p>
249 <a class="anchor" id="ae3664b841732a09d7749953ca5b81373"></a>
250 <div class="memitem">
251 <div class="memproto">
252 <table class="memname">
254 <td class="memname">size_t num_bins </td>
256 <td class="paramname"></td><td>)</td>
260 </div><div class="memdoc">
262 <p>Returns the number of bins that the distribution has. </p>
263 <dl class="section return"><dt>Returns</dt><dd>Number of bins of the distribution. </dd></dl>
267 <a class="anchor" id="ad952765741736e8e669876dd06636873"></a>
268 <div class="memitem">
269 <div class="memproto">
270 <table class="memname">
272 <td class="memname">int32_t offset </td>
274 <td class="paramname"></td><td>)</td>
278 </div><div class="memdoc">
280 <p>Returns the offset of the distribution. </p>
281 <dl class="section return"><dt>Returns</dt><dd>Offset of the distribution. </dd></dl>
285 <a class="anchor" id="ac548d0ee88978d0ba481323aab25e46a"></a>
286 <div class="memitem">
287 <div class="memproto">
288 <table class="memname">
290 <td class="memname">uint32_t range </td>
292 <td class="paramname"></td><td>)</td>
296 </div><div class="memdoc">
298 <p>Returns the range of the distribution. </p>
299 <dl class="section return"><dt>Returns</dt><dd>Range of the distribution. </dd></dl>
303 <a class="anchor" id="a9027aed7fdb902ebc243647c8c3fbea2"></a>
304 <div class="memitem">
305 <div class="memproto">
306 <table class="memname">
308 <td class="memname">void set_range </td>
310 <td class="paramtype">uint32_t </td>
311 <td class="paramname"><em>range</em></td><td>)</td>
315 </div><div class="memdoc">
317 <p>Sets the range of the distribution. </p>
318 <dl class="params"><dt>Parameters</dt><dd>
319 <table class="params">
320 <tr><td class="paramdir">[in]</td><td class="paramname">range</td><td>New range of the distribution to be set. </td></tr>
327 <a class="anchor" id="ad7701a09a964eab360a8e51fa7ad2c16"></a>
328 <div class="memitem">
329 <div class="memproto">
330 <table class="mlabels">
332 <td class="mlabels-left">
333 <table class="memname">
335 <td class="memname">size_t size </td>
337 <td class="paramname"></td><td>)</td>
342 <td class="mlabels-right">
343 <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
346 </div><div class="memdoc">
348 <p>Returns the total size in bytes of the distribution. </p>
349 <dl class="section return"><dt>Returns</dt><dd>Total size of the distribution in bytes. </dd></dl>
351 <p>Implements <a class="el" href="classarm__compute_1_1_i_distribution.xhtml#aa983ddaeded5756189f46428be79c631">IDistribution</a>.</p>
355 <a class="anchor" id="a862904f65dffef9c8a72d3aeadc56be1"></a>
356 <div class="memitem">
357 <div class="memproto">
358 <table class="memname">
360 <td class="memname">uint32_t window </td>
362 <td class="paramname"></td><td>)</td>
366 </div><div class="memdoc">
368 <p>Returns the window of the distribution, which is the range divided by the number of bins. </p>
369 <dl class="section note"><dt>Note</dt><dd>If range is not divided by the number of bins then it is invalid.</dd></dl>
370 <dl class="section return"><dt>Returns</dt><dd><a class="el" href="classarm__compute_1_1_window.xhtml" title="Describe a multidimensional execution window. ">Window</a> of the distribution. </dd></dl>
374 <hr/>The documentation for this class was generated from the following file:<ul>
375 <li>arm_compute/core/<a class="el" href="_i_distribution1_d_8h_source.xhtml">IDistribution1D.h</a></li>
377 </div><!-- contents -->
378 </div><!-- doc-content -->
379 <!-- start footer part -->
380 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
382 <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_distribution1_d.xhtml">IDistribution1D</a></li>
383 <li class="footer">Generated on Wed Apr 12 2017 14:26:06 for ARM Compute Library by
384 <a href="http://www.doxygen.org/index.html">
385 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>