| <!-- HTML header for doxygen 1.8.15--> |
| <!-- Remember to use version doxygen 1.8.15 +--> |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.15"/> |
| <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines --> |
| <title>Compute Library: IDistribution Class Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="navtree.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="resize.js"></script> |
| <script type="text/javascript" src="navtreedata.js"></script> |
| <script type="text/javascript" src="navtree.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(initResizable); |
| /* @license-end */</script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <script type="text/x-mathjax-config"> |
| MathJax.Hub.Config({ |
| extensions: ["tex2jax.js"], |
| jax: ["input/TeX","output/HTML-CSS"], |
| }); |
| </script><script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| <link href="stylesheet.css" rel="stylesheet" type="text/css"/> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <img alt="Compute Library" src="https://raw.githubusercontent.com/ARM-software/ComputeLibrary/gh-pages/ACL_logo.png" style="max-width: 100%;margin-top: 15px;margin-left: 10px"/> |
| <td style="padding-left: 0.5em;"> |
| <div id="projectname"> |
|  <span id="projectnumber">20.02.1</span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.15 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</script> |
| <div id="main-nav"></div> |
| </div><!-- top --> |
| <div id="side-nav" class="ui-resizable side-nav-resizable"> |
| <div id="nav-tree"> |
| <div id="nav-tree-contents"> |
| <div id="nav-sync" class="sync"></div> |
| </div> |
| </div> |
| <div id="splitbar" style="-moz-user-select:none;" |
| class="ui-resizable-handle"> |
| </div> |
| </div> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function(){initNavTree('classarm__compute_1_1_i_distribution.xhtml','');}); |
| /* @license-end */ |
| </script> |
| <div id="doc-content"> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> </div> |
| <div class="headertitle"> |
| <div class="title">IDistribution Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Interface for distribution objects. |
| <a href="classarm__compute_1_1_i_distribution.xhtml#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="_i_distribution_8h_source.xhtml">IDistribution.h</a>></code></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <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> |
| <tr class="memdesc:a9ee18d758810dbcfb1c9717956f51c38"><td class="mdescLeft"> </td><td class="mdescRight">Default virtual destructor. <a href="#a9ee18d758810dbcfb1c9717956f51c38">More...</a><br /></td></tr> |
| <tr class="separator:a9ee18d758810dbcfb1c9717956f51c38"><td class="memSeparator" colspan="2"> </td></tr> |
| <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> |
| <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> |
| <tr class="separator:a254be7b34cd78d12ffc7ed2aba4882b1"><td class="memSeparator" colspan="2"> </td></tr> |
| <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> |
| <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> |
| <tr class="separator:aa983ddaeded5756189f46428be79c631"><td class="memSeparator" colspan="2"> </td></tr> |
| <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> |
| <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> |
| <tr class="separator:a0eb5856c63562cb144938ed77d6823a0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adf1d9633e64d0de6a36e0af17ccd8163"><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#adf1d9633e64d0de6a36e0af17ccd8163">clear</a> () const</td></tr> |
| <tr class="memdesc:adf1d9633e64d0de6a36e0af17ccd8163"><td class="mdescLeft"> </td><td class="mdescRight">Clears the distribution by setting every element to zero. <a href="#adf1d9633e64d0de6a36e0af17ccd8163">More...</a><br /></td></tr> |
| <tr class="separator:adf1d9633e64d0de6a36e0af17ccd8163"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Interface for distribution objects. </p> |
| |
| <p class="definition">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> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a9ee18d758810dbcfb1c9717956f51c38"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9ee18d758810dbcfb1c9717956f51c38">◆ </a></span>~IDistribution()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual ~<a class="el" href="classarm__compute_1_1_i_distribution.xhtml">IDistribution</a> </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Default virtual destructor. </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a0eb5856c63562cb144938ed77d6823a0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0eb5856c63562cb144938ed77d6823a0">◆ </a></span>buffer()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual uint32_t* buffer </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns a pointer to the start of the distribution. </p> |
| <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> |
| <dl class="section return"><dt>Returns</dt><dd>Pointer to the start of the distribution. </dd></dl> |
| |
| <p>Implemented in <a class="el" href="classarm__compute_1_1_i_c_l_distribution1_d.xhtml#ac9740300f00d726c2720535d12c334f2">ICLDistribution1D</a>, and <a class="el" href="classarm__compute_1_1_distribution1_d.xhtml#ac9740300f00d726c2720535d12c334f2">Distribution1D</a>.</p> |
| |
| <p class="reference">Referenced by <a class="el" href="_i_distribution_8cpp_source.xhtml#l00032">IDistribution::clear()</a>, and <a class="el" href="_n_e_cumulative_distribution_kernel_8cpp_source.xhtml#l00070">NECumulativeDistributionKernel::run()</a>.</p> |
| |
| </div> |
| </div> |
| <a id="adf1d9633e64d0de6a36e0af17ccd8163"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#adf1d9633e64d0de6a36e0af17ccd8163">◆ </a></span>clear()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void clear </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Clears the distribution by setting every element to zero. </p> |
| |
| <p class="definition">Definition at line <a class="el" href="_i_distribution_8cpp_source.xhtml#l00032">32</a> of file <a class="el" href="_i_distribution_8cpp_source.xhtml">IDistribution.cpp</a>.</p> |
| <div class="fragment"><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> {</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <a class="code" href="_error_8h.xhtml#a54a6080c9f4df1f908e57a9bbb46f5da">ARM_COMPUTE_ERROR_ON</a>(<span class="keyword">nullptr</span> == <a class="code" href="classarm__compute_1_1_i_distribution.xhtml#a0eb5856c63562cb144938ed77d6823a0">buffer</a>());</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  std::memset(<a class="code" href="classarm__compute_1_1_i_distribution.xhtml#a0eb5856c63562cb144938ed77d6823a0">buffer</a>(), 0, <a class="code" href="classarm__compute_1_1_i_distribution.xhtml#aa983ddaeded5756189f46428be79c631">size</a>());</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> }</div><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#l00466">Error.h:466</a></div></div> |
| <div class="ttc" id="classarm__compute_1_1_i_distribution_xhtml_a0eb5856c63562cb144938ed77d6823a0"><div class="ttname"><a href="classarm__compute_1_1_i_distribution.xhtml#a0eb5856c63562cb144938ed77d6823a0">arm_compute::IDistribution::buffer</a></div><div class="ttdeci">virtual uint32_t * buffer() const =0</div><div class="ttdoc">Returns a pointer to the start of the distribution.</div></div> |
| <div class="ttc" id="classarm__compute_1_1_i_distribution_xhtml_aa983ddaeded5756189f46428be79c631"><div class="ttname"><a href="classarm__compute_1_1_i_distribution.xhtml#aa983ddaeded5756189f46428be79c631">arm_compute::IDistribution::size</a></div><div class="ttdeci">virtual size_t size() const =0</div><div class="ttdoc">Returns the total size in bytes of the distribution.</div></div> |
| </div><!-- fragment --> |
| <p class="reference">References <a class="el" href="_error_8h_source.xhtml#l00466">ARM_COMPUTE_ERROR_ON</a>, <a class="el" href="classarm__compute_1_1_i_distribution.xhtml#a0eb5856c63562cb144938ed77d6823a0">IDistribution::buffer()</a>, and <a class="el" href="classarm__compute_1_1_i_distribution.xhtml#aa983ddaeded5756189f46428be79c631">IDistribution::size()</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a254be7b34cd78d12ffc7ed2aba4882b1"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a254be7b34cd78d12ffc7ed2aba4882b1">◆ </a></span>dimensions()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual size_t dimensions </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the dimensions of the distribution. </p> |
| <dl class="section note"><dt>Note</dt><dd>This is fixed to 1-dimensional distribution for now. </dd></dl> |
| <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> |
| |
| <p>Implemented in <a class="el" href="classarm__compute_1_1_i_distribution1_d.xhtml#ad251169c06da412071bdfb6e92444e6e">IDistribution1D</a>.</p> |
| |
| </div> |
| </div> |
| <a id="aa983ddaeded5756189f46428be79c631"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa983ddaeded5756189f46428be79c631">◆ </a></span>size()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual size_t size </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the total size in bytes of the distribution. </p> |
| <dl class="section return"><dt>Returns</dt><dd>Total size of the distribution in bytes. </dd></dl> |
| |
| <p>Implemented in <a class="el" href="classarm__compute_1_1_i_distribution1_d.xhtml#ad7701a09a964eab360a8e51fa7ad2c16">IDistribution1D</a>.</p> |
| |
| <p class="reference">Referenced by <a class="el" href="_i_distribution_8cpp_source.xhtml#l00032">IDistribution::clear()</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following files:<ul> |
| <li>arm_compute/core/<a class="el" href="_i_distribution_8h_source.xhtml">IDistribution.h</a></li> |
| <li>src/core/<a class="el" href="_i_distribution_8cpp_source.xhtml">IDistribution.cpp</a></li> |
| </ul> |
| </div><!-- contents --> |
| </div><!-- doc-content --> |
| <!-- start footer part --> |
| <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
| <ul> |
| <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> |
| <li class="footer">Generated on Thu Mar 5 2020 16:07:14 for Compute Library by |
| <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li> |
| </ul> |
| </div> |
| </body> |
| </html> |