<!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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>IAtari: 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="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>
<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="projectlogo"><img alt="Logo" src="robot.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">IAtari
</div>
<div id="projectbrief">Genetic algorithm generating AI capable to play Atari2600 games.</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('Random_8h_source.html','');});
/* @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="headertitle">
<div class="title">Random.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="Random_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> This file is part of Leela Zero.</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> Copyright (C) 2017 Gian-Carlo Pascutto</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"></span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> Leela Zero is free software: you can redistribute it and/or modify</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> it under the terms of the GNU General Public License as published by</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> the Free Software Foundation, either version 3 of the License, or</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> (at your option) any later version.</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"></span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> Leela Zero is distributed in the hope that it will be useful,</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> GNU General Public License for more details.</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"></span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> You should have received a copy of the GNU General Public License</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> along with Leela Zero. If not, see <http://www.gnu.org/licenses/>.</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">*/</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#ifndef RANDOM_H_INCLUDED</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#define RANDOM_H_INCLUDED</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <cstdint></span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <limits></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">/*</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> Random number generator xoroshiro128+</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">*/</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">namespace </span><a class="code" href="namespaceUtils.html">Utils</a></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> {</div><div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="classUtils_1_1Random.html"> 30</a></span> <span class="keyword">class </span><a class="code" href="classUtils_1_1Random.html">Random</a> {</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <a class="code" href="classUtils_1_1Random.html#ab2e106214e6cc251cf130ce3b0d3f855">Random</a>() = <span class="keyword">delete</span>;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <a class="code" href="classUtils_1_1Random.html#ab2e106214e6cc251cf130ce3b0d3f855">Random</a>(std::uint64_t seed = 0);</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keywordtype">void</span> <a class="code" href="classUtils_1_1Random.html#ab3f39df2fbc7acd4028ebac7fc00c85c">seedrandom</a>(std::uint64_t s);</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="comment">// Random numbers from [0, max - 1]</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keyword">template</span><<span class="keywordtype">int</span> MAX></div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="classUtils_1_1Random.html#ae8717dcaaefb0b13748c481882eb8ad0"> 38</a></span>  std::uint32_t <a class="code" href="classUtils_1_1Random.html#ae8717dcaaefb0b13748c481882eb8ad0">randfix</a>() {</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  static_assert(0 < MAX &&</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  MAX < std::numeric_limits<std::uint32_t>::max(),</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="stringliteral">"randfix out of range"</span>);</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="comment">// Last bit isn't random, so don't use it in isolation. We specialize</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="comment">// this case.</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  static_assert(MAX != 2, <span class="stringliteral">"don't isolate the LSB with xoroshiro128+"</span>);</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keywordflow">return</span> gen() % MAX;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  }</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  std::uint64_t <a class="code" href="classUtils_1_1Random.html#ac29bb970fb5f04ecdf2716313292a620">randuint64</a>();</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="comment">// Random number from [0, max - 1]</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  std::uint64_t <a class="code" href="classUtils_1_1Random.html#ac29bb970fb5f04ecdf2716313292a620">randuint64</a>(<span class="keyword">const</span> std::uint64_t <a class="code" href="classUtils_1_1Random.html#a5280b19c643548243b709a9924857bd9">max</a>);</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="comment">// return the thread local RNG</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">static</span> <a class="code" href="classUtils_1_1Random.html">Random</a>& <a class="code" href="classUtils_1_1Random.html#a89773304fae633ae89de05fef313edab">get_Rng</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="comment">// UniformRandomBitGenerator interface</span></div><div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="classUtils_1_1Random.html#a81041c98f41a29ba6d28bf070d20217c"> 57</a></span>  <span class="keyword">using</span> <a class="code" href="classUtils_1_1Random.html#a81041c98f41a29ba6d28bf070d20217c">result_type</a> = std::uint64_t;</div><div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="classUtils_1_1Random.html#a133a9d6947f69cf36a15a5ade5939d4c"> 58</a></span>  constexpr <span class="keyword">static</span> <a class="code" href="classUtils_1_1Random.html#a81041c98f41a29ba6d28bf070d20217c">result_type</a> <a class="code" href="classUtils_1_1Random.html#a133a9d6947f69cf36a15a5ade5939d4c">min</a>() {</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordflow">return</span> std::numeric_limits<result_type>::min();</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  }</div><div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="classUtils_1_1Random.html#a5280b19c643548243b709a9924857bd9"> 61</a></span>  constexpr <span class="keyword">static</span> <a class="code" href="classUtils_1_1Random.html#a81041c98f41a29ba6d28bf070d20217c">result_type</a> <a class="code" href="classUtils_1_1Random.html#a5280b19c643548243b709a9924857bd9">max</a>() {</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordflow">return</span> std::numeric_limits<result_type>::max();</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  }</div><div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="classUtils_1_1Random.html#aba95e56619101b2173eaab956f538a78"> 64</a></span>  <a class="code" href="classUtils_1_1Random.html#a81041c98f41a29ba6d28bf070d20217c">result_type</a> <a class="code" href="classUtils_1_1Random.html#aba95e56619101b2173eaab956f538a78">operator()</a>() {</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordflow">return</span> gen();</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  }</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  std::uint64_t gen(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  std::uint64_t m_s[2];</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> };</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment">// Specialization for last bit: use sign test</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="keyword">template</span><></div><div class="line"><a name="l00075"></a><span class="lineno"><a class="line" href="classUtils_1_1Random.html#a4bdc6d3f73b0987016b96d70e819edb4"> 75</a></span> <span class="keyword">inline</span> std::uint32_t Random::randfix<2>() {</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordflow">return</span> (gen() > (std::numeric_limits<std::uint64_t>::max() / 2));</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> }</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> }</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="classUtils_1_1Random_html_a5280b19c643548243b709a9924857bd9"><div class="ttname"><a href="classUtils_1_1Random.html#a5280b19c643548243b709a9924857bd9">Utils::Random::max</a></div><div class="ttdeci">static constexpr result_type max()</div><div class="ttdef"><b>Definition:</b> Random.h:61</div></div>
<div class="ttc" id="classUtils_1_1Random_html_a89773304fae633ae89de05fef313edab"><div class="ttname"><a href="classUtils_1_1Random.html#a89773304fae633ae89de05fef313edab">Utils::Random::get_Rng</a></div><div class="ttdeci">static Random & get_Rng(void)</div><div class="ttdef"><b>Definition:</b> Random.cpp:30</div></div>
<div class="ttc" id="classUtils_1_1Random_html_a81041c98f41a29ba6d28bf070d20217c"><div class="ttname"><a href="classUtils_1_1Random.html#a81041c98f41a29ba6d28bf070d20217c">Utils::Random::result_type</a></div><div class="ttdeci">std::uint64_t result_type</div><div class="ttdef"><b>Definition:</b> Random.h:57</div></div>
<div class="ttc" id="classUtils_1_1Random_html"><div class="ttname"><a href="classUtils_1_1Random.html">Utils::Random</a></div><div class="ttdef"><b>Definition:</b> Random.h:30</div></div>
<div class="ttc" id="classUtils_1_1Random_html_a133a9d6947f69cf36a15a5ade5939d4c"><div class="ttname"><a href="classUtils_1_1Random.html#a133a9d6947f69cf36a15a5ade5939d4c">Utils::Random::min</a></div><div class="ttdeci">static constexpr result_type min()</div><div class="ttdef"><b>Definition:</b> Random.h:58</div></div>
<div class="ttc" id="classUtils_1_1Random_html_ab2e106214e6cc251cf130ce3b0d3f855"><div class="ttname"><a href="classUtils_1_1Random.html#ab2e106214e6cc251cf130ce3b0d3f855">Utils::Random::Random</a></div><div class="ttdeci">Random()=delete</div></div>
<div class="ttc" id="classUtils_1_1Random_html_ac29bb970fb5f04ecdf2716313292a620"><div class="ttname"><a href="classUtils_1_1Random.html#ac29bb970fb5f04ecdf2716313292a620">Utils::Random::randuint64</a></div><div class="ttdeci">std::uint64_t randuint64()</div><div class="ttdef"><b>Definition:</b> Random.cpp:65</div></div>
<div class="ttc" id="classUtils_1_1Random_html_ae8717dcaaefb0b13748c481882eb8ad0"><div class="ttname"><a href="classUtils_1_1Random.html#ae8717dcaaefb0b13748c481882eb8ad0">Utils::Random::randfix</a></div><div class="ttdeci">std::uint32_t randfix()</div><div class="ttdef"><b>Definition:</b> Random.h:38</div></div>
<div class="ttc" id="classUtils_1_1Random_html_aba95e56619101b2173eaab956f538a78"><div class="ttname"><a href="classUtils_1_1Random.html#aba95e56619101b2173eaab956f538a78">Utils::Random::operator()</a></div><div class="ttdeci">result_type operator()()</div><div class="ttdef"><b>Definition:</b> Random.h:64</div></div>
<div class="ttc" id="classUtils_1_1Random_html_ab3f39df2fbc7acd4028ebac7fc00c85c"><div class="ttname"><a href="classUtils_1_1Random.html#ab3f39df2fbc7acd4028ebac7fc00c85c">Utils::Random::seedrandom</a></div><div class="ttdeci">void seedrandom(std::uint64_t s)</div><div class="ttdef"><b>Definition:</b> Random.cpp:76</div></div>
<div class="ttc" id="namespaceUtils_html"><div class="ttname"><a href="namespaceUtils.html">Utils</a></div><div class="ttdoc">A set of useful method and class.</div><div class="ttdef"><b>Definition:</b> Random.cpp:27</div></div>
</div><!-- fragment --></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="Random_8h.html">Random.h</a></li>
<li class="footer">Generated 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>