Files
rippled/classripple_1_1test_1_1csf_1_1Selector.html
2025-11-04 00:36:48 -08:00

314 lines
17 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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: ripple::test::csf::Selector&lt; RAIter, Generator &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 id="projectrow">
<td id="projectalign">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</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_1Selector.html">Selector</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_1Selector-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::test::csf::Selector&lt; RAIter, Generator &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Invocable that returns random samples from a range according to a discrete distribution.
<a href="classripple_1_1test_1_1csf_1_1Selector.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="src_2test_2csf_2random_8h_source.html">random.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ripple::test::csf::Selector&lt; RAIter, Generator &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1test_1_1csf_1_1Selector__coll__graph.png" border="0" usemap="#aripple_1_1test_1_1csf_1_1Selector_3_01RAIter_00_01Generator_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1test_1_1csf_1_1Selector_3_01RAIter_00_01Generator_01_4_coll__map" id="aripple_1_1test_1_1csf_1_1Selector_3_01RAIter_00_01Generator_01_4_coll__map">
<area shape="rect" title="Invocable that returns random samples from a range according to a discrete distribution." alt="" coords="5,93,224,133"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/numeric/random/discrete_distribution.html" title=" " alt="" coords="23,5,206,31"/>
<area shape="poly" title=" " alt="" coords="117,44,117,93,112,93,112,44"/>
</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 id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a032c84bf6fee638c3cdc3854b18dbca5" id="r_a032c84bf6fee638c3cdc3854b18dbca5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1test_1_1csf_1_1Selector.html#a032c84bf6fee638c3cdc3854b18dbca5">Selector</a> (RAIter first, RAIter <a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/last_spec.html">last</a>, <a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>&lt; double &gt; const &amp;w, Generator &amp;g)</td></tr>
<tr class="memdesc:a032c84bf6fee638c3cdc3854b18dbca5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
<tr class="separator:a032c84bf6fee638c3cdc3854b18dbca5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a09f31f1e48d8f3fab5cbf892f7c4d989" id="r_a09f31f1e48d8f3fab5cbf892f7c4d989"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/iterator/iterator_traits.html">std::iterator_traits</a>&lt; RAIter &gt;::value_type&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1test_1_1csf_1_1Selector.html#a09f31f1e48d8f3fab5cbf892f7c4d989">operator()</a> ()</td></tr>
<tr class="separator:a09f31f1e48d8f3fab5cbf892f7c4d989"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a6b3f311f99cf92966202b58fbe613b52" id="r_a6b3f311f99cf92966202b58fbe613b52"><td class="memItemLeft" align="right" valign="top">RAIter&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1test_1_1csf_1_1Selector.html#a6b3f311f99cf92966202b58fbe613b52">first_</a></td></tr>
<tr class="separator:a6b3f311f99cf92966202b58fbe613b52"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a952b63764ab787c690f802085238692b" id="r_a952b63764ab787c690f802085238692b"><td class="memItemLeft" align="right" valign="top">RAIter&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1test_1_1csf_1_1Selector.html#a952b63764ab787c690f802085238692b">last_</a></td></tr>
<tr class="separator:a952b63764ab787c690f802085238692b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a401933096fa53a7d1bf4355229065040" id="r_a401933096fa53a7d1bf4355229065040"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/numeric/random/discrete_distribution.html">std::discrete_distribution</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1test_1_1csf_1_1Selector.html#a401933096fa53a7d1bf4355229065040">dd_</a></td></tr>
<tr class="separator:a401933096fa53a7d1bf4355229065040"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e713eb6116525962c9280c9c4589979" id="r_a1e713eb6116525962c9280c9c4589979"><td class="memItemLeft" align="right" valign="top">Generator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1test_1_1csf_1_1Selector.html#a1e713eb6116525962c9280c9c4589979">g_</a></td></tr>
<tr class="separator:a1e713eb6116525962c9280c9c4589979"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;class RAIter, class Generator&gt;<br />
class ripple::test::csf::Selector&lt; RAIter, Generator &gt;</div><p>Invocable that returns random samples from a range according to a discrete distribution. </p>
<p>Given a pair of random access iterators begin and end, each call to the instance of <a class="el" href="classripple_1_1test_1_1csf_1_1Selector.html" title="Invocable that returns random samples from a range according to a discrete distribution.">Selector</a> returns a random entry in the range (begin,end) according to the weights provided at construction. </p>
<p class="definition">Definition at line <a class="el" href="src_2test_2csf_2random_8h_source.html#l00062">62</a> of file <a class="el" href="src_2test_2csf_2random_8h_source.html">src/test/csf/random.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a032c84bf6fee638c3cdc3854b18dbca5" name="a032c84bf6fee638c3cdc3854b18dbca5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a032c84bf6fee638c3cdc3854b18dbca5">&#9670;&#160;</a></span>Selector()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class RAIter , class Generator &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1test_1_1csf_1_1Selector.html">ripple::test::csf::Selector</a>&lt; RAIter, Generator &gt;::Selector </td>
<td>(</td>
<td class="paramtype">RAIter&#160;</td>
<td class="paramname"><em>first</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">RAIter&#160;</td>
<td class="paramname"><em>last</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>&lt; double &gt; const &amp;&#160;</td>
<td class="paramname"><em>w</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Generator &amp;&#160;</td>
<td class="paramname"><em>g</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">first</td><td>Random access iterator to the start of the range </td></tr>
<tr><td class="paramname">last</td><td>Random access iterator to the end of the range </td></tr>
<tr><td class="paramname">w</td><td>Vector of weights of size list-first </td></tr>
<tr><td class="paramname">g</td><td>the pseudo-random number generator </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="src_2test_2csf_2random_8h_source.html#l00075">75</a> of file <a class="el" href="src_2test_2csf_2random_8h_source.html">src/test/csf/random.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a09f31f1e48d8f3fab5cbf892f7c4d989" name="a09f31f1e48d8f3fab5cbf892f7c4d989"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a09f31f1e48d8f3fab5cbf892f7c4d989">&#9670;&#160;</a></span>operator()()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class RAIter , class Generator &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/iterator/iterator_traits.html">std::iterator_traits</a>&lt; RAIter &gt;::value_type <a class="el" href="classripple_1_1test_1_1csf_1_1Selector.html">ripple::test::csf::Selector</a>&lt; RAIter, Generator &gt;::operator() </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="src_2test_2csf_2random_8h_source.html#l00090">90</a> of file <a class="el" href="src_2test_2csf_2random_8h_source.html">src/test/csf/random.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a6b3f311f99cf92966202b58fbe613b52" name="a6b3f311f99cf92966202b58fbe613b52"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6b3f311f99cf92966202b58fbe613b52">&#9670;&#160;</a></span>first_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class RAIter , class Generator &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">RAIter <a class="el" href="classripple_1_1test_1_1csf_1_1Selector.html">ripple::test::csf::Selector</a>&lt; RAIter, Generator &gt;::first_</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="src_2test_2csf_2random_8h_source.html#l00064">64</a> of file <a class="el" href="src_2test_2csf_2random_8h_source.html">src/test/csf/random.h</a>.</p>
</div>
</div>
<a id="a952b63764ab787c690f802085238692b" name="a952b63764ab787c690f802085238692b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a952b63764ab787c690f802085238692b">&#9670;&#160;</a></span>last_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class RAIter , class Generator &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">RAIter <a class="el" href="classripple_1_1test_1_1csf_1_1Selector.html">ripple::test::csf::Selector</a>&lt; RAIter, Generator &gt;::last_</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="src_2test_2csf_2random_8h_source.html#l00064">64</a> of file <a class="el" href="src_2test_2csf_2random_8h_source.html">src/test/csf/random.h</a>.</p>
</div>
</div>
<a id="a401933096fa53a7d1bf4355229065040" name="a401933096fa53a7d1bf4355229065040"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a401933096fa53a7d1bf4355229065040">&#9670;&#160;</a></span>dd_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class RAIter , class Generator &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/numeric/random/discrete_distribution.html">std::discrete_distribution</a> <a class="el" href="classripple_1_1test_1_1csf_1_1Selector.html">ripple::test::csf::Selector</a>&lt; RAIter, Generator &gt;::dd_</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="src_2test_2csf_2random_8h_source.html#l00065">65</a> of file <a class="el" href="src_2test_2csf_2random_8h_source.html">src/test/csf/random.h</a>.</p>
</div>
</div>
<a id="a1e713eb6116525962c9280c9c4589979" name="a1e713eb6116525962c9280c9c4589979"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e713eb6116525962c9280c9c4589979">&#9670;&#160;</a></span>g_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class RAIter , class Generator &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Generator <a class="el" href="classripple_1_1test_1_1csf_1_1Selector.html">ripple::test::csf::Selector</a>&lt; RAIter, Generator &gt;::g_</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="src_2test_2csf_2random_8h_source.html#l00066">66</a> of file <a class="el" href="src_2test_2csf_2random_8h_source.html">src/test/csf/random.h</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>