Files
rippled/classripple_1_1test_1_1csf_1_1Histogram.html
2020-04-24 01:09:47 +00:00

369 lines
21 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: ripple::test::csf::Histogram&lt; T, Compare &gt; Class Template 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="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>
<link href="doxygen.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;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;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&amp;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>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="namespaceripple_1_1test.html">test</a></li><li class="navelem"><a class="el" href="namespaceripple_1_1test_1_1csf.html">csf</a></li><li class="navelem"><a class="el" href="classripple_1_1test_1_1csf_1_1Histogram.html">Histogram</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classripple_1_1test_1_1csf_1_1Histogram-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ripple::test::csf::Histogram&lt; T, Compare &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Basic histogram.
<a href="classripple_1_1test_1_1csf_1_1Histogram.html#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for ripple::test::csf::Histogram&lt; T, Compare &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1test_1_1csf_1_1Histogram__coll__graph.png" border="0" usemap="#ripple_1_1test_1_1csf_1_1Histogram_3_01T_00_01Compare_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="ripple_1_1test_1_1csf_1_1Histogram_3_01T_00_01Compare_01_4_coll__map" id="ripple_1_1test_1_1csf_1_1Histogram_3_01T_00_01Compare_01_4_coll__map">
<area shape="rect" title="Basic histogram." alt="" coords="5,199,200,240"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/map.html" title=" " alt="" coords="135,95,299,136"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="29,5,117,32"/>
<area shape="rect" title=" " alt="" coords="198,5,237,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<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:a2ce85845fec076ca430683b66097b610"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1test_1_1csf_1_1Histogram.html#a2ce85845fec076ca430683b66097b610">insert</a> (T const &amp;s)</td></tr>
<tr class="memdesc:a2ce85845fec076ca430683b66097b610"><td class="mdescLeft">&#160;</td><td class="mdescRight">Insert an sample. <a href="classripple_1_1test_1_1csf_1_1Histogram.html#a2ce85845fec076ca430683b66097b610">More...</a><br /></td></tr>
<tr class="separator:a2ce85845fec076ca430683b66097b610"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9a3d69c08d6ac83d937d40e39f8a962a"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1test_1_1csf_1_1Histogram.html#a9a3d69c08d6ac83d937d40e39f8a962a">size</a> () const</td></tr>
<tr class="memdesc:a9a3d69c08d6ac83d937d40e39f8a962a"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of samples. <a href="classripple_1_1test_1_1csf_1_1Histogram.html#a9a3d69c08d6ac83d937d40e39f8a962a">More...</a><br /></td></tr>
<tr class="separator:a9a3d69c08d6ac83d937d40e39f8a962a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7baa154518eac6c181a1c28e5813d938"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1test_1_1csf_1_1Histogram.html#a7baa154518eac6c181a1c28e5813d938">numBins</a> () const</td></tr>
<tr class="memdesc:a7baa154518eac6c181a1c28e5813d938"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of distinct samples (bins) <a href="classripple_1_1test_1_1csf_1_1Histogram.html#a7baa154518eac6c181a1c28e5813d938">More...</a><br /></td></tr>
<tr class="separator:a7baa154518eac6c181a1c28e5813d938"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d6c8ad7af9a4e3524a3d667718e51e9"><td class="memItemLeft" align="right" valign="top">T&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1test_1_1csf_1_1Histogram.html#a6d6c8ad7af9a4e3524a3d667718e51e9">minValue</a> () const</td></tr>
<tr class="memdesc:a6d6c8ad7af9a4e3524a3d667718e51e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Minimum observed value. <a href="classripple_1_1test_1_1csf_1_1Histogram.html#a6d6c8ad7af9a4e3524a3d667718e51e9">More...</a><br /></td></tr>
<tr class="separator:a6d6c8ad7af9a4e3524a3d667718e51e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6c6d69844873285526199a6695e05f5e"><td class="memItemLeft" align="right" valign="top">T&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1test_1_1csf_1_1Histogram.html#a6c6d69844873285526199a6695e05f5e">maxValue</a> () const</td></tr>
<tr class="memdesc:a6c6d69844873285526199a6695e05f5e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum observed value. <a href="classripple_1_1test_1_1csf_1_1Histogram.html#a6c6d69844873285526199a6695e05f5e">More...</a><br /></td></tr>
<tr class="separator:a6c6d69844873285526199a6695e05f5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a18df710918df0f0bf1057f9d01619f3b"><td class="memItemLeft" align="right" valign="top">T&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1test_1_1csf_1_1Histogram.html#a18df710918df0f0bf1057f9d01619f3b">avg</a> () const</td></tr>
<tr class="memdesc:a18df710918df0f0bf1057f9d01619f3b"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classripple_1_1test_1_1csf_1_1Histogram.html" title="Basic histogram.">Histogram</a> average. <a href="classripple_1_1test_1_1csf_1_1Histogram.html#a18df710918df0f0bf1057f9d01619f3b">More...</a><br /></td></tr>
<tr class="separator:a18df710918df0f0bf1057f9d01619f3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a76b0876283aedf2e380046b75ccc699f"><td class="memItemLeft" align="right" valign="top">T&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1test_1_1csf_1_1Histogram.html#a76b0876283aedf2e380046b75ccc699f">percentile</a> (float p) const</td></tr>
<tr class="memdesc:a76b0876283aedf2e380046b75ccc699f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate the given percentile of the distribution. <a href="classripple_1_1test_1_1csf_1_1Histogram.html#a76b0876283aedf2e380046b75ccc699f">More...</a><br /></td></tr>
<tr class="separator:a76b0876283aedf2e380046b75ccc699f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:ae0987022a49f1023f28b4afffe313230"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/container/map.html">std::map</a>&lt; T, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a>, Compare &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1test_1_1csf_1_1Histogram.html#ae0987022a49f1023f28b4afffe313230">counts_</a></td></tr>
<tr class="separator:ae0987022a49f1023f28b4afffe313230"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a344df7555d8f811e3426a6ce2cdb1747"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1test_1_1csf_1_1Histogram.html#a344df7555d8f811e3426a6ce2cdb1747">samples</a> = 0</td></tr>
<tr class="separator:a344df7555d8f811e3426a6ce2cdb1747"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;class T, class Compare = std::less&lt;T&gt;&gt;<br />
class ripple::test::csf::Histogram&lt; T, Compare &gt;</h3>
<p>Basic histogram. </p>
<p><a class="el" href="classripple_1_1test_1_1csf_1_1Histogram.html" title="Basic histogram.">Histogram</a> for a type <code>T</code> that satisfies</p><ul>
<li>Default construction: T{}</li>
<li>Comparison : T a, b; bool res = a &lt; b</li>
<li>Addition: T a, b; T c = a + b;</li>
<li>Multiplication : T a, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> b; T c = a * b;</li>
<li>Divison: T a; <a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> b; T c = a/b; </li>
</ul>
<p class="definition">Definition at line <a class="el" href="Histogram_8h_source.html#l00042">42</a> of file <a class="el" href="Histogram_8h_source.html">Histogram.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a2ce85845fec076ca430683b66097b610"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ce85845fec076ca430683b66097b610">&#9670;&nbsp;</a></span>insert()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class Compare = std::less&lt;T&gt;&gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classripple_1_1test_1_1csf_1_1Histogram.html">ripple::test::csf::Histogram</a>&lt; T, Compare &gt;::insert </td>
<td>(</td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Insert an sample. </p>
<p class="definition">Definition at line <a class="el" href="Histogram_8h_source.html#l00052">52</a> of file <a class="el" href="Histogram_8h_source.html">Histogram.h</a>.</p>
</div>
</div>
<a id="a9a3d69c08d6ac83d937d40e39f8a962a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9a3d69c08d6ac83d937d40e39f8a962a">&#9670;&nbsp;</a></span>size()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class Compare = std::less&lt;T&gt;&gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> <a class="el" href="classripple_1_1test_1_1csf_1_1Histogram.html">ripple::test::csf::Histogram</a>&lt; T, Compare &gt;::size </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>The number of samples. </p>
<p class="definition">Definition at line <a class="el" href="Histogram_8h_source.html#l00060">60</a> of file <a class="el" href="Histogram_8h_source.html">Histogram.h</a>.</p>
</div>
</div>
<a id="a7baa154518eac6c181a1c28e5813d938"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7baa154518eac6c181a1c28e5813d938">&#9670;&nbsp;</a></span>numBins()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class Compare = std::less&lt;T&gt;&gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> <a class="el" href="classripple_1_1test_1_1csf_1_1Histogram.html">ripple::test::csf::Histogram</a>&lt; T, Compare &gt;::numBins </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>The number of distinct samples (bins) </p>
<p class="definition">Definition at line <a class="el" href="Histogram_8h_source.html#l00067">67</a> of file <a class="el" href="Histogram_8h_source.html">Histogram.h</a>.</p>
</div>
</div>
<a id="a6d6c8ad7af9a4e3524a3d667718e51e9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6d6c8ad7af9a4e3524a3d667718e51e9">&#9670;&nbsp;</a></span>minValue()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class Compare = std::less&lt;T&gt;&gt; </div>
<table class="memname">
<tr>
<td class="memname">T <a class="el" href="classripple_1_1test_1_1csf_1_1Histogram.html">ripple::test::csf::Histogram</a>&lt; T, Compare &gt;::minValue </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Minimum observed value. </p>
<p class="definition">Definition at line <a class="el" href="Histogram_8h_source.html#l00074">74</a> of file <a class="el" href="Histogram_8h_source.html">Histogram.h</a>.</p>
</div>
</div>
<a id="a6c6d69844873285526199a6695e05f5e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6c6d69844873285526199a6695e05f5e">&#9670;&nbsp;</a></span>maxValue()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class Compare = std::less&lt;T&gt;&gt; </div>
<table class="memname">
<tr>
<td class="memname">T <a class="el" href="classripple_1_1test_1_1csf_1_1Histogram.html">ripple::test::csf::Histogram</a>&lt; T, Compare &gt;::maxValue </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Maximum observed value. </p>
<p class="definition">Definition at line <a class="el" href="Histogram_8h_source.html#l00081">81</a> of file <a class="el" href="Histogram_8h_source.html">Histogram.h</a>.</p>
</div>
</div>
<a id="a18df710918df0f0bf1057f9d01619f3b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a18df710918df0f0bf1057f9d01619f3b">&#9670;&nbsp;</a></span>avg()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class Compare = std::less&lt;T&gt;&gt; </div>
<table class="memname">
<tr>
<td class="memname">T <a class="el" href="classripple_1_1test_1_1csf_1_1Histogram.html">ripple::test::csf::Histogram</a>&lt; T, Compare &gt;::avg </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="classripple_1_1test_1_1csf_1_1Histogram.html" title="Basic histogram.">Histogram</a> average. </p>
<p class="definition">Definition at line <a class="el" href="Histogram_8h_source.html#l00088">88</a> of file <a class="el" href="Histogram_8h_source.html">Histogram.h</a>.</p>
</div>
</div>
<a id="a76b0876283aedf2e380046b75ccc699f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a76b0876283aedf2e380046b75ccc699f">&#9670;&nbsp;</a></span>percentile()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class Compare = std::less&lt;T&gt;&gt; </div>
<table class="memname">
<tr>
<td class="memname">T <a class="el" href="classripple_1_1test_1_1csf_1_1Histogram.html">ripple::test::csf::Histogram</a>&lt; T, Compare &gt;::percentile </td>
<td>(</td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>p</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Calculate the given percentile of the distribution. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">p</td><td>Percentile between 0 and 1, e.g. 0.50 is 50-th percentile If the percentile falls between two bins, uses the nearest bin. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The given percentile of the distribution </dd></dl>
<p class="definition">Definition at line <a class="el" href="Histogram_8h_source.html#l00109">109</a> of file <a class="el" href="Histogram_8h_source.html">Histogram.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ae0987022a49f1023f28b4afffe313230"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae0987022a49f1023f28b4afffe313230">&#9670;&nbsp;</a></span>counts_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class Compare = std::less&lt;T&gt;&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/container/map.html">std::map</a>&lt;T, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a>, Compare&gt; <a class="el" href="classripple_1_1test_1_1csf_1_1Histogram.html">ripple::test::csf::Histogram</a>&lt; T, Compare &gt;::counts_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Histogram_8h_source.html#l00046">46</a> of file <a class="el" href="Histogram_8h_source.html">Histogram.h</a>.</p>
</div>
</div>
<a id="a344df7555d8f811e3426a6ce2cdb1747"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a344df7555d8f811e3426a6ce2cdb1747">&#9670;&nbsp;</a></span>samples</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class Compare = std::less&lt;T&gt;&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> <a class="el" href="classripple_1_1test_1_1csf_1_1Histogram.html">ripple::test::csf::Histogram</a>&lt; T, Compare &gt;::samples = 0</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Histogram_8h_source.html#l00047">47</a> of file <a class="el" href="Histogram_8h_source.html">Histogram.h</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>