-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_random_8h_source.html
77 lines (77 loc) · 18.9 KB
/
_random_8h_source.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Gamedev Framework (gf): 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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="custom.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="gf_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Gamedev Framework (gf)
 <span id="projectnumber">0.11.0</span>
</div>
<div id="projectbrief">A C++14 framework for 2D games</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></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_6d069d519ae9d12fa11dd8e685586b60.html">gf</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Random.h</div> </div>
</div><!--header-->
<div class="contents">
<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"> * Gamedev Framework (gf)</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright (C) 2016-2018 Julien Bernard</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"> * This software is provided 'as-is', without any express or implied</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * warranty. In no event will the authors be held liable for any damages</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * arising from the use of this software.</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> *</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * Permission is granted to anyone to use this software for any purpose,</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * including commercial applications, and to alter it and redistribute it</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * freely, subject to the following restrictions:</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> *</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * 1. The origin of this software must not be misrepresented; you must not</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * claim that you wrote the original software. If you use this software</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * in a product, an acknowledgment in the product documentation would be</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * appreciated but is not required.</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * 2. Altered source versions must be plainly marked as such, and must not be</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * misrepresented as being the original software.</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * 3. This notice may not be removed or altered from any source distribution.</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> */</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#ifndef GF_RANDOM_H</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#define GF_RANDOM_H</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <cstdint></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <random></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "Portability.h"</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "Rect.h"</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "Vector.h"</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">namespace </span><a class="code" href="namespacegf.html">gf</a> {</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#ifndef DOXYGEN_SHOULD_SKIP_THIS</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">inline</span> <span class="keyword">namespace </span>v1 {</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classgf_1_1_random.html"> 45</a></span>  <span class="keyword">class </span>GF_API <a class="code" href="classgf_1_1_random.html">Random</a> {</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <a class="code" href="classgf_1_1_random.html">Random</a>();</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="classgf_1_1_random.html#a19401dba57cc2780114389c4875b1413"> 67</a></span>  <a class="code" href="classgf_1_1_random.html#a19401dba57cc2780114389c4875b1413">Random</a>(std::uint_fast32_t seed)</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  : m_engine(seed)</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  {</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </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="l00080"></a><span class="lineno"> 80</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div><div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="classgf_1_1_random.html#af53df683709acde299fd329dc96225b9"> 81</a></span>  <a class="code" href="group__window.html#gga795d7d5e2f2a4f38b16b95e0e78cb626ab9ece18c950afbfa6b0fdbfa4ff731d3">T</a> <a class="code" href="classgf_1_1_random.html#af53df683709acde299fd329dc96225b9">computeUniformInteger</a>(<a class="code" href="group__window.html#gga795d7d5e2f2a4f38b16b95e0e78cb626ab9ece18c950afbfa6b0fdbfa4ff731d3">T</a> min, <a class="code" href="group__window.html#gga795d7d5e2f2a4f38b16b95e0e78cb626ab9ece18c950afbfa6b0fdbfa4ff731d3">T</a> max) {</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  std::uniform_int_distribution<T> dist(min, max);</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordflow">return</span> dist(m_engine);</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  }</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div><div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="classgf_1_1_random.html#a42d392ae9b78810209498300baf0158f"> 94</a></span>  <a class="code" href="group__window.html#gga795d7d5e2f2a4f38b16b95e0e78cb626ab9ece18c950afbfa6b0fdbfa4ff731d3">T</a> <a class="code" href="classgf_1_1_random.html#a42d392ae9b78810209498300baf0158f">computeUniformFloat</a>(<a class="code" href="group__window.html#gga795d7d5e2f2a4f38b16b95e0e78cb626ab9ece18c950afbfa6b0fdbfa4ff731d3">T</a> min, <a class="code" href="group__window.html#gga795d7d5e2f2a4f38b16b95e0e78cb626ab9ece18c950afbfa6b0fdbfa4ff731d3">T</a> max) {</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  std::uniform_real_distribution<T> dist(min, max);</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordflow">return</span> dist(m_engine);</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  }</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div><div class="line"><a name="l00107"></a><span class="lineno"><a class="line" href="classgf_1_1_random.html#a7d03561d34d91c6aac6f7d9f96e6cf58"> 107</a></span>  <a class="code" href="group__window.html#gga795d7d5e2f2a4f38b16b95e0e78cb626ab9ece18c950afbfa6b0fdbfa4ff731d3">T</a> <a class="code" href="classgf_1_1_random.html#a7d03561d34d91c6aac6f7d9f96e6cf58">computeNormalFloat</a>(<a class="code" href="group__window.html#gga795d7d5e2f2a4f38b16b95e0e78cb626ab9ece18c950afbfa6b0fdbfa4ff731d3">T</a> mean, <a class="code" href="group__window.html#gga795d7d5e2f2a4f38b16b95e0e78cb626ab9ece18c950afbfa6b0fdbfa4ff731d3">T</a> stddev) {</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  std::normal_distribution<T> dist(mean, stddev);</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="keywordflow">return</span> dist(m_engine);</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  }</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> </div><div class="line"><a name="l00118"></a><span class="lineno"><a class="line" href="classgf_1_1_random.html#a360f6193816c428a02b3fe9c2a4ed40e"> 118</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classgf_1_1_random.html#a360f6193816c428a02b3fe9c2a4ed40e">computeBernoulli</a>(<span class="keywordtype">double</span> p) {</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  std::bernoulli_distribution dist(p);</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keywordflow">return</span> dist(m_engine);</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  }</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <a class="code" href="structgf_1_1_vector.html">Vector2f</a> computePosition(<span class="keyword">const</span> <a class="code" href="structgf_1_1_rect.html">RectF</a>& area);</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> </div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <a class="code" href="structgf_1_1_vector.html">Vector2i</a> computePosition(<span class="keyword">const</span> <a class="code" href="structgf_1_1_rect.html">RectI</a>& area);</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> </div><div class="line"><a name="l00144"></a><span class="lineno"><a class="line" href="classgf_1_1_random.html#a016df7d6b394bde106913a540f46803d"> 144</a></span>  std::mt19937& <a class="code" href="classgf_1_1_random.html#a016df7d6b394bde106913a540f46803d">getEngine</a>() {</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  <span class="keywordflow">return</span> m_engine;</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  }</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> </div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  std::mt19937 m_engine;</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  };</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> </div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="preprocessor">#ifndef DOXYGEN_SHOULD_SKIP_THIS</span></div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span> }</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> }</div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> </div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="preprocessor">#endif // GF_RANDOM_H</span></div><div class="ttc" id="classgf_1_1_random_html"><div class="ttname"><a href="classgf_1_1_random.html">gf::Random</a></div><div class="ttdoc">A random engine. </div><div class="ttdef"><b>Definition:</b> Random.h:45</div></div>
<div class="ttc" id="group__window_html_gga795d7d5e2f2a4f38b16b95e0e78cb626ab9ece18c950afbfa6b0fdbfa4ff731d3"><div class="ttname"><a href="group__window.html#gga795d7d5e2f2a4f38b16b95e0e78cb626ab9ece18c950afbfa6b0fdbfa4ff731d3">gf::Scancode::T</a></div></div>
<div class="ttc" id="classgf_1_1_random_html_a7d03561d34d91c6aac6f7d9f96e6cf58"><div class="ttname"><a href="classgf_1_1_random.html#a7d03561d34d91c6aac6f7d9f96e6cf58">gf::Random::computeNormalFloat</a></div><div class="ttdeci">T computeNormalFloat(T mean, T stddev)</div><div class="ttdoc">Compute a float with a normal (Gaussian) distribution. </div><div class="ttdef"><b>Definition:</b> Random.h:107</div></div>
<div class="ttc" id="classgf_1_1_random_html_a42d392ae9b78810209498300baf0158f"><div class="ttname"><a href="classgf_1_1_random.html#a42d392ae9b78810209498300baf0158f">gf::Random::computeUniformFloat</a></div><div class="ttdeci">T computeUniformFloat(T min, T max)</div><div class="ttdoc">Compute a float with a uniform distribution. </div><div class="ttdef"><b>Definition:</b> Random.h:94</div></div>
<div class="ttc" id="classgf_1_1_random_html_a19401dba57cc2780114389c4875b1413"><div class="ttname"><a href="classgf_1_1_random.html#a19401dba57cc2780114389c4875b1413">gf::Random::Random</a></div><div class="ttdeci">Random(std::uint_fast32_t seed)</div><div class="ttdoc">Constructor with simple initialization. </div><div class="ttdef"><b>Definition:</b> Random.h:67</div></div>
<div class="ttc" id="structgf_1_1_rect_html"><div class="ttname"><a href="structgf_1_1_rect.html">gf::Rect< float ></a></div></div>
<div class="ttc" id="namespacegf_html"><div class="ttname"><a href="namespacegf.html">gf</a></div><div class="ttdoc">The namespace for gf classes. </div><div class="ttdef"><b>Definition:</b> Action.h:35</div></div>
<div class="ttc" id="classgf_1_1_random_html_a360f6193816c428a02b3fe9c2a4ed40e"><div class="ttname"><a href="classgf_1_1_random.html#a360f6193816c428a02b3fe9c2a4ed40e">gf::Random::computeBernoulli</a></div><div class="ttdeci">bool computeBernoulli(double p)</div><div class="ttdoc">Compute a boolean with a Bernoulli distribution. </div><div class="ttdef"><b>Definition:</b> Random.h:118</div></div>
<div class="ttc" id="classgf_1_1_random_html_a016df7d6b394bde106913a540f46803d"><div class="ttname"><a href="classgf_1_1_random.html#a016df7d6b394bde106913a540f46803d">gf::Random::getEngine</a></div><div class="ttdeci">std::mt19937 & getEngine()</div><div class="ttdoc">Get the underlying engine. </div><div class="ttdef"><b>Definition:</b> Random.h:144</div></div>
<div class="ttc" id="classgf_1_1_random_html_af53df683709acde299fd329dc96225b9"><div class="ttname"><a href="classgf_1_1_random.html#af53df683709acde299fd329dc96225b9">gf::Random::computeUniformInteger</a></div><div class="ttdeci">T computeUniformInteger(T min, T max)</div><div class="ttdoc">Compute an integer with a uniform distribution. </div><div class="ttdef"><b>Definition:</b> Random.h:81</div></div>
<div class="ttc" id="structgf_1_1_vector_html"><div class="ttname"><a href="structgf_1_1_vector.html">gf::Vector< float, 2 ></a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>