ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-20 19:15:54 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
2ef1af9423e3adf2a90158ce99b5ef20fc13619e
rippled/include_2xrpl_2basics_2random_8h_source.html
bthomee e7f4ae8bed deploy: afc05659ed
2025-08-19 09:49:50 -07:00

307 lines
40 KiB
HTML
Raw Blame History

<!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: random.h Source File</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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- 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="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_0103a8ad82dcc2c51f5cde661b4b5cb7.html">xrpl</a></li><li class="navelem"><a class="el" href="dir_f534ca90a4985f34ab325acfbcd39b84.html">basics</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">include/xrpl/basics/random.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">//------------------------------------------------------------------------------</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">/*</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> This file is part of rippled: https://github.com/ripple/rippled</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> Copyright (c) 2012, 2013 Ripple Labs Inc.</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"></span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> Permission to use, copy, modify, and/or distribute this software for any</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> purpose with or without fee is hereby granted, provided that the above</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> copyright notice and this permission notice appear in all copies.</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"></span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> THE SOFTWARE IS PROVIDED &quot;AS IS&quot; AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment">*/</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment">//==============================================================================</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#ifndef RIPPLE_BASICS_RANDOM_H_INCLUDED</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#define RIPPLE_BASICS_RANDOM_H_INCLUDED</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include &lt;xrpl/beast/utility/instrumentation.h&gt;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include &lt;xrpl/beast/xor_shift_engine.h&gt;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/cstddef.html">cstddef</a>&gt;</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/cstdint.html">cstdint</a>&gt;</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/limits.html">limits</a>&gt;</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/mutex.html">mutex</a>&gt;</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/random.html">random</a>&gt;</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/type_traits.html">type_traits</a>&gt;</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="preprocessor">#ifndef __INTELLISENSE__</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="keyword">static_assert</span>(</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/is_integral.html">std::is_integral&lt;beast::xor_shift_engine::result_type&gt;::value</a> &amp;&amp;</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/is_unsigned.html">std::is_unsigned&lt;beast::xor_shift_engine::result_type&gt;::value</a>,</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="stringliteral">&quot;The Ripple default PRNG engine must return an unsigned integral type.&quot;</span>);</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="keyword">static_assert</span>(</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <a class="code hl_functionRef" href="http://en.cppreference.com/w/cpp/types/numeric_limits/max.html">std::numeric_limits&lt;beast::xor_shift_engine::result_type&gt;::max</a>() &gt;=</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <a class="code hl_functionRef" href="http://en.cppreference.com/w/cpp/types/numeric_limits/max.html">std::numeric_limits&lt;std::uint64_t&gt;::max</a>(),</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <span class="stringliteral">&quot;The Ripple default PRNG engine return must be at least 64 bits wide.&quot;</span>);</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="keyword">namespace </span>detail {</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="comment">// Determines if a type can be called like an Engine</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span><span class="keyword">template</span> &lt;<span class="keyword">class</span> Engine, <span class="keyword">class</span> Result = <span class="keyword">typename</span> Engine::result_type&gt;</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"><a class="line" href="namespaceripple_1_1detail.html#afc38aa9ea5bbed77a9d15119fe3ad676"> 51</a></span><span class="keyword">using </span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/is_invocable.html">is_engine</a> = <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/is_invocable.html">std::is_invocable_r&lt;Result, Engine&gt;</a>;</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span>} <span class="comment">// namespace detail</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> </div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span><span class="keyword">inline</span> <a class="code hl_class" href="classbeast_1_1detail_1_1xor__shift__engine.html">beast::xor_shift_engine</a>&amp;</div>
<div class="foldopen" id="foldopen00065" data-start="{" data-end="}">
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"><a class="line" href="namespaceripple.html#afe66a903fefc1f0613602efe9e2283de"> 65</a></span><a class="code hl_function" href="namespaceripple.html#afe66a903fefc1f0613602efe9e2283de">default_prng</a>()</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span>{</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <span class="comment">// This is used to seed the thread-specific PRNGs on demand</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <span class="keyword">static</span> <a class="code hl_class" href="classbeast_1_1detail_1_1xor__shift__engine.html">beast::xor_shift_engine</a> seeder = [] {</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/numeric/random/random_device.html">std::random_device</a> rng;</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/numeric/random/uniform_int_distribution.html">std::uniform_int_distribution&lt;std::uint64_t&gt;</a> distribution{1};</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> <span class="keywordflow">return</span> <a class="code hl_typedef" href="namespacebeast.html#a3a89b040ab5ccff1b2ce7692464c6a48">beast::xor_shift_engine</a>(distribution(rng));</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> }();</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> </div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> <span class="comment">// This protects the seeder</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="keyword">static</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/thread/mutex.html">std::mutex</a> m;</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> </div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> <span class="comment">// The thread-specific PRNGs:</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> <span class="keyword">thread_local</span> <a class="code hl_class" href="classbeast_1_1detail_1_1xor__shift__engine.html">beast::xor_shift_engine</a> engine = [] {</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a> seed;</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> {</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/thread/lock_guard.html">std::lock_guard</a> lk(m);</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/numeric/random/uniform_int_distribution.html">std::uniform_int_distribution&lt;std::uint64_t&gt;</a> distribution{1};</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> seed = distribution(seeder);</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> }</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> <span class="keywordflow">return</span> <a class="code hl_class" href="classbeast_1_1detail_1_1xor__shift__engine.html">beast::xor_shift_engine</a>{seed};</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> }();</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> </div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> <span class="keywordflow">return</span> engine;</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span>}</div>
</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> </div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span><span class="keyword">template</span> &lt;<span class="keyword">class</span> Engine, <span class="keyword">class</span> Integral&gt;</div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/enable_if.html">std::enable_if_t</a>&lt;</div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/is_integral.html">std::is_integral&lt;Integral&gt;::value</a> &amp;&amp; detail::is_engine&lt;Engine&gt;::value,</div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> Integral&gt;</div>
<div class="foldopen" id="foldopen00115" data-start="{" data-end="}">
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"><a class="line" href="namespaceripple.html#a7e8c5e8439747ed61273789c9940d5b7"> 115</a></span><a class="code hl_function" href="namespaceripple.html#a1747b036b81bd3769995670092912976">rand_int</a>(Engine&amp; engine, Integral min, Integral max)</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span>{</div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> XRPL_ASSERT(max &gt; min, <span class="stringliteral">&quot;ripple::rand_int : max over min inputs&quot;</span>);</div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> </div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> <span class="comment">// This should have no state and constructing it should</span></div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> <span class="comment">// be very cheap. If that turns out not to be the case</span></div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> <span class="comment">// it could be hand-optimized.</span></div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> <span class="keywordflow">return</span> <a class="code hl_variableRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::uniform_int_distribution&lt;Integral&gt;</a>(min, max)(engine);</div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span>}</div>
</div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> </div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span><span class="keyword">template</span> &lt;<span class="keyword">class</span> Integral&gt;</div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/enable_if.html">std::enable_if_t&lt;std::is_integral&lt;Integral&gt;::value</a>, Integral&gt;</div>
<div class="foldopen" id="foldopen00127" data-start="{" data-end="}">
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"><a class="line" href="namespaceripple.html#a201c1de23cbce2b5ba49a6f96b96f9aa"> 127</a></span><a class="code hl_function" href="namespaceripple.html#a1747b036b81bd3769995670092912976">rand_int</a>(Integral min, Integral max)</div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span>{</div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span> <span class="keywordflow">return</span> <a class="code hl_function" href="namespaceripple.html#a1747b036b81bd3769995670092912976">rand_int</a>(<a class="code hl_function" href="namespaceripple.html#afe66a903fefc1f0613602efe9e2283de">default_prng</a>(), min, max);</div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span>}</div>
</div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span> </div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span><span class="keyword">template</span> &lt;<span class="keyword">class</span> Engine, <span class="keyword">class</span> Integral&gt;</div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/enable_if.html">std::enable_if_t</a>&lt;</div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/is_integral.html">std::is_integral&lt;Integral&gt;::value</a> &amp;&amp; detail::is_engine&lt;Engine&gt;::value,</div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> Integral&gt;</div>
<div class="foldopen" id="foldopen00136" data-start="{" data-end="}">
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"><a class="line" href="namespaceripple.html#a0503294c3be3aff83a13e2a51a74f675"> 136</a></span><a class="code hl_function" href="namespaceripple.html#a1747b036b81bd3769995670092912976">rand_int</a>(Engine&amp; engine, Integral max)</div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span>{</div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span> <span class="keywordflow">return</span> <a class="code hl_function" href="namespaceripple.html#a1747b036b81bd3769995670092912976">rand_int</a>(engine, Integral(0), max);</div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span>}</div>
</div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span> </div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span><span class="keyword">template</span> &lt;<span class="keyword">class</span> Integral&gt;</div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/enable_if.html">std::enable_if_t&lt;std::is_integral&lt;Integral&gt;::value</a>, Integral&gt;</div>
<div class="foldopen" id="foldopen00143" data-start="{" data-end="}">
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"><a class="line" href="namespaceripple.html#a004db52c5945c192ecca58e224ceb5f8"> 143</a></span><a class="code hl_function" href="namespaceripple.html#a1747b036b81bd3769995670092912976">rand_int</a>(Integral max)</div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno"> 144</span>{</div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span> <span class="keywordflow">return</span> <a class="code hl_function" href="namespaceripple.html#a1747b036b81bd3769995670092912976">rand_int</a>(<a class="code hl_function" href="namespaceripple.html#afe66a903fefc1f0613602efe9e2283de">default_prng</a>(), max);</div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span>}</div>
</div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span> </div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span><span class="keyword">template</span> &lt;<span class="keyword">class</span> Integral, <span class="keyword">class</span> Engine&gt;</div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno"> 149</span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/enable_if.html">std::enable_if_t</a>&lt;</div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/is_integral.html">std::is_integral&lt;Integral&gt;::value</a> &amp;&amp; detail::is_engine&lt;Engine&gt;::value,</div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span> Integral&gt;</div>
<div class="foldopen" id="foldopen00152" data-start="{" data-end="}">
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"><a class="line" href="namespaceripple.html#a8a5b5f5fa34f990853c3e197a8704f73"> 152</a></span><a class="code hl_function" href="namespaceripple.html#a1747b036b81bd3769995670092912976">rand_int</a>(Engine&amp; engine)</div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno"> 153</span>{</div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno"> 154</span> <span class="keywordflow">return</span> <a class="code hl_function" href="namespaceripple.html#a1747b036b81bd3769995670092912976">rand_int</a>(engine, <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/numeric_limits.html">std::numeric_limits&lt;Integral&gt;::max</a>());</div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno"> 155</span>}</div>
</div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno"> 156</span> </div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno"> 157</span><span class="keyword">template</span> &lt;<span class="keyword">class</span> Integral = <span class="keywordtype">int</span>&gt;</div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno"> 158</span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/enable_if.html">std::enable_if_t&lt;std::is_integral&lt;Integral&gt;::value</a>, Integral&gt;</div>
<div class="foldopen" id="foldopen00159" data-start="{" data-end="}">
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno"><a class="line" href="namespaceripple.html#a1747b036b81bd3769995670092912976"> 159</a></span><a class="code hl_function" href="namespaceripple.html#a1747b036b81bd3769995670092912976">rand_int</a>()</div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno"> 160</span>{</div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno"> 161</span> <span class="keywordflow">return</span> <a class="code hl_function" href="namespaceripple.html#a1747b036b81bd3769995670092912976">rand_int</a>(<a class="code hl_function" href="namespaceripple.html#afe66a903fefc1f0613602efe9e2283de">default_prng</a>(), <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/numeric_limits.html">std::numeric_limits&lt;Integral&gt;::max</a>());</div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno"> 162</span>}</div>
</div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno"> 167</span><span class="keyword">template</span> &lt;<span class="keyword">class</span> Byte, <span class="keyword">class</span> Engine&gt;</div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno"> 168</span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/enable_if.html">std::enable_if_t</a>&lt;</div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno"> 169</span> (<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::is_same&lt;Byte, unsigned char&gt;::value</a> ||</div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno"> 170</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::is_same&lt;Byte, std::uint8_t&gt;::value</a>) &amp;&amp;</div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno"> 171</span> detail::is_engine&lt;Engine&gt;::value,</div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno"> 172</span> Byte&gt;</div>
<div class="foldopen" id="foldopen00173" data-start="{" data-end="}">
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno"><a class="line" href="namespaceripple.html#a7ea35455d341aef7e7f1b6efb83f26ab"> 173</a></span><a class="code hl_function" href="namespaceripple.html#a07f252d7421718e945f09463c3c8d255">rand_byte</a>(Engine&amp; engine)</div>
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno"> 174</span>{</div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno"> 175</span> <span class="keywordflow">return</span> <span class="keyword">static_cast&lt;</span>Byte<span class="keyword">&gt;</span>(rand_int&lt;Engine, std::uint32_t&gt;(</div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno"> 176</span> engine,</div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno"> 177</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/numeric_limits.html">std::numeric_limits&lt;Byte&gt;::min</a>(),</div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno"> 178</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/numeric_limits.html">std::numeric_limits&lt;Byte&gt;::max</a>()));</div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno"> 179</span>}</div>
</div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno"> 180</span> </div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno"> 181</span><span class="keyword">template</span> &lt;<span class="keyword">class</span> Byte = std::u<span class="keywordtype">int</span>8_t&gt;</div>
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno"> 182</span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/enable_if.html">std::enable_if_t</a>&lt;</div>
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno"> 183</span> (<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::is_same&lt;Byte, unsigned char&gt;::value</a> ||</div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno"> 184</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::is_same&lt;Byte, std::uint8_t&gt;::value</a>),</div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno"> 185</span> Byte&gt;</div>
<div class="foldopen" id="foldopen00186" data-start="{" data-end="}">
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno"><a class="line" href="namespaceripple.html#a07f252d7421718e945f09463c3c8d255"> 186</a></span><a class="code hl_function" href="namespaceripple.html#a07f252d7421718e945f09463c3c8d255">rand_byte</a>()</div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno"> 187</span>{</div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno"> 188</span> <span class="keywordflow">return</span> rand_byte&lt;Byte&gt;(<a class="code hl_function" href="namespaceripple.html#afe66a903fefc1f0613602efe9e2283de">default_prng</a>());</div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno"> 189</span>}</div>
</div>
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno"> 194</span><span class="keyword">template</span> &lt;<span class="keyword">class</span> Engine&gt;</div>
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno"> 195</span><span class="keyword">inline</span> <span class="keywordtype">bool</span></div>
<div class="foldopen" id="foldopen00196" data-start="{" data-end="}">
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno"><a class="line" href="namespaceripple.html#a37fc7093cfe63d4e2cab63d40aa813dd"> 196</a></span><a class="code hl_function" href="namespaceripple.html#ad7f6ed671155855d566c0adb954b188b">rand_bool</a>(Engine&amp; engine)</div>
<div class="line"><a id="l00197" name="l00197"></a><span class="lineno"> 197</span>{</div>
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno"> 198</span> <span class="keywordflow">return</span> <a class="code hl_function" href="namespaceripple.html#a1747b036b81bd3769995670092912976">rand_int</a>(engine, 1) == 1;</div>
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno"> 199</span>}</div>
</div>
<div class="line"><a id="l00200" name="l00200"></a><span class="lineno"> 200</span> </div>
<div class="line"><a id="l00201" name="l00201"></a><span class="lineno"> 201</span><span class="keyword">inline</span> <span class="keywordtype">bool</span></div>
<div class="foldopen" id="foldopen00202" data-start="{" data-end="}">
<div class="line"><a id="l00202" name="l00202"></a><span class="lineno"><a class="line" href="namespaceripple.html#ad7f6ed671155855d566c0adb954b188b"> 202</a></span><a class="code hl_function" href="namespaceripple.html#ad7f6ed671155855d566c0adb954b188b">rand_bool</a>()</div>
<div class="line"><a id="l00203" name="l00203"></a><span class="lineno"> 203</span>{</div>
<div class="line"><a id="l00204" name="l00204"></a><span class="lineno"> 204</span> <span class="keywordflow">return</span> <a class="code hl_function" href="namespaceripple.html#ad7f6ed671155855d566c0adb954b188b">rand_bool</a>(<a class="code hl_function" href="namespaceripple.html#afe66a903fefc1f0613602efe9e2283de">default_prng</a>());</div>
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno"> 205</span>}</div>
</div>
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno"> 208</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00209" name="l00209"></a><span class="lineno"> 209</span> </div>
<div class="line"><a id="l00210" name="l00210"></a><span class="lineno"> 210</span><span class="preprocessor">#endif </span><span class="comment">// RIPPLE_BASICS_RANDOM_H_INCLUDED</span></div>
<div class="ttc" id="aclassbeast_1_1detail_1_1xor__shift__engine_html"><div class="ttname"><a href="classbeast_1_1detail_1_1xor__shift__engine.html">beast::detail::xor_shift_engine</a></div><div class="ttdef"><b>Definition</b> <a href="xor__shift__engine_8h_source.html#l00032">xor_shift_engine.h:33</a></div></div>
<div class="ttc" id="acstddef_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/cstddef.html">cstddef</a></div></div>
<div class="ttc" id="acstdint_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/cstdint.html">cstdint</a></div></div>
<div class="ttc" id="aenable_if_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/enable_if.html">std::enable_if_t</a></div></div>
<div class="ttc" id="ainteger_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint64_t</a></div></div>
<div class="ttc" id="ais_integral_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/is_integral.html">std::is_integral</a></div></div>
<div class="ttc" id="ais_invocable_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/is_invocable.html">std::is_invocable_r</a></div></div>
<div class="ttc" id="ais_same_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/is_same.html">std::is_same_v</a></div><div class="ttdeci">T is_same_v</div></div>
<div class="ttc" id="ais_unsigned_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/is_unsigned.html">std::is_unsigned</a></div></div>
<div class="ttc" id="alimits_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/limits.html">limits</a></div></div>
<div class="ttc" id="alock_guard_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/thread/lock_guard.html">std::lock_guard</a></div></div>
<div class="ttc" id="amax_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/numeric_limits/max.html">std::numeric_limits::max</a></div><div class="ttdeci">T max(T... args)</div></div>
<div class="ttc" id="amutex_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/mutex.html">mutex</a></div></div>
<div class="ttc" id="anamespacebeast_html_a3a89b040ab5ccff1b2ce7692464c6a48"><div class="ttname"><a href="namespacebeast.html#a3a89b040ab5ccff1b2ce7692464c6a48">beast::xor_shift_engine</a></div><div class="ttdeci">detail::xor_shift_engine&lt;&gt; xor_shift_engine</div><div class="ttdoc">XOR-shift Generator.</div><div class="ttdef"><b>Definition</b> <a href="xor__shift__engine_8h_source.html#l00114">xor_shift_engine.h:114</a></div></div>
<div class="ttc" id="anamespaceripple_html"><div class="ttname"><a href="namespaceripple.html">ripple</a></div><div class="ttdoc">Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.</div><div class="ttdef"><b>Definition</b> <a href="algorithm_8h_source.html#l00025">algorithm.h:25</a></div></div>
<div class="ttc" id="anamespaceripple_html_a07f252d7421718e945f09463c3c8d255"><div class="ttname"><a href="namespaceripple.html#a07f252d7421718e945f09463c3c8d255">ripple::rand_byte</a></div><div class="ttdeci">std::enable_if_t&lt;(std::is_same&lt; Byte, unsigned char &gt;::value||std::is_same&lt; Byte, std::uint8_t &gt;::value), Byte &gt; rand_byte()</div><div class="ttdef"><b>Definition</b> <a href="include_2xrpl_2basics_2random_8h_source.html#l00186">include/xrpl/basics/random.h:186</a></div></div>
<div class="ttc" id="anamespaceripple_html_a1747b036b81bd3769995670092912976"><div class="ttname"><a href="namespaceripple.html#a1747b036b81bd3769995670092912976">ripple::rand_int</a></div><div class="ttdeci">std::enable_if_t&lt; std::is_integral&lt; Integral &gt;::value, Integral &gt; rand_int()</div><div class="ttdef"><b>Definition</b> <a href="include_2xrpl_2basics_2random_8h_source.html#l00159">include/xrpl/basics/random.h:159</a></div></div>
<div class="ttc" id="anamespaceripple_html_ad7f6ed671155855d566c0adb954b188b"><div class="ttname"><a href="namespaceripple.html#ad7f6ed671155855d566c0adb954b188b">ripple::rand_bool</a></div><div class="ttdeci">bool rand_bool()</div><div class="ttdef"><b>Definition</b> <a href="include_2xrpl_2basics_2random_8h_source.html#l00202">include/xrpl/basics/random.h:202</a></div></div>
<div class="ttc" id="anamespaceripple_html_afe66a903fefc1f0613602efe9e2283de"><div class="ttname"><a href="namespaceripple.html#afe66a903fefc1f0613602efe9e2283de">ripple::default_prng</a></div><div class="ttdeci">beast::xor_shift_engine &amp; default_prng()</div><div class="ttdoc">Return the default random engine.</div><div class="ttdef"><b>Definition</b> <a href="include_2xrpl_2basics_2random_8h_source.html#l00065">include/xrpl/basics/random.h:65</a></div></div>
<div class="ttc" id="anumeric_limits_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/numeric_limits.html">std::numeric_limits</a></div></div>
<div class="ttc" id="arandom_device_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/numeric/random/random_device.html">std::random_device</a></div></div>
<div class="ttc" id="arandom_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/random.html">random</a></div></div>
<div class="ttc" id="atype_traits_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/type_traits.html">type_traits</a></div></div>
<div class="ttc" id="auniform_int_distribution_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/numeric/random/uniform_int_distribution.html">std::uniform_int_distribution</a></div></div>
</div><!-- fragment --></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>
Reference in New Issue View Git Blame Copy Permalink