class_random_r250.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.9.8"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Torque2D Reference: RandomR250 Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  17. </head>
  18. <body>
  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20. <div id="titlearea">
  21. <table cellspacing="0" cellpadding="0">
  22. <tbody>
  23. <tr id="projectrow">
  24. <td id="projectalign">
  25. <div id="projectname">Torque2D Reference
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.9.8 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  36. var searchBox = new SearchBox("searchBox", "search/",'.html');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */
  48. </script>
  49. <div id="main-nav"></div>
  50. <!-- window showing the filter options -->
  51. <div id="MSearchSelectWindow"
  52. onmouseover="return searchBox.OnSearchSelectShow()"
  53. onmouseout="return searchBox.OnSearchSelectHide()"
  54. onkeydown="return searchBox.OnSearchSelectKey(event)">
  55. </div>
  56. <!-- iframe showing the search results (closed by default) -->
  57. <div id="MSearchResultsWindow">
  58. <div id="MSearchResults">
  59. <div class="SRPage">
  60. <div id="SRIndex">
  61. <div id="SRResults"></div>
  62. <div class="SRStatus" id="Loading">Loading...</div>
  63. <div class="SRStatus" id="Searching">Searching...</div>
  64. <div class="SRStatus" id="NoMatches">No Matches</div>
  65. </div>
  66. </div>
  67. </div>
  68. </div>
  69. </div><!-- top -->
  70. <div class="header">
  71. <div class="summary">
  72. <a href="#pub-methods">Public Member Functions</a> &#124;
  73. <a href="class_random_r250-members.html">List of all members</a> </div>
  74. <div class="headertitle"><div class="title">RandomR250 Class Reference</div></div>
  75. </div><!--header-->
  76. <div class="contents">
  77. <p><code>#include &lt;mRandom.h&gt;</code></p>
  78. <div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  79. <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for RandomR250:</div>
  80. <div id="dynsection-0-summary" class="dynsummary" style="display:block;">
  81. </div>
  82. <div id="dynsection-0-content" class="dyncontent" style="display:none;">
  83. <div class="center">
  84. <img src="class_random_r250.png" usemap="#RandomR250_map" alt=""/>
  85. <map id="RandomR250_map" name="RandomR250_map">
  86. <area href="class_random_generator_base.html" alt="RandomGeneratorBase" shape="rect" coords="0,0,142,24"/>
  87. </map>
  88. </div></div>
  89. <table class="memberdecls">
  90. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  91. Public Member Functions</h2></td></tr>
  92. <tr class="memitem:a94e12030c0c39d7ba060da9d6174744f" id="r_a94e12030c0c39d7ba060da9d6174744f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_random_r250.html#a94e12030c0c39d7ba060da9d6174744f">RandomR250</a> ()</td></tr>
  93. <tr class="separator:a94e12030c0c39d7ba060da9d6174744f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:ac9ee10171f0526271c5eeb29ec279842" id="r_ac9ee10171f0526271c5eeb29ec279842"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_random_r250.html#ac9ee10171f0526271c5eeb29ec279842">RandomR250</a> (const S32 seed)</td></tr>
  95. <tr class="separator:ac9ee10171f0526271c5eeb29ec279842"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:ad7baead515cc515af426c6bf43a9e938" id="r_ad7baead515cc515af426c6bf43a9e938"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_random_r250.html#ad7baead515cc515af426c6bf43a9e938">setSeed</a> (const S32 seed)</td></tr>
  97. <tr class="separator:ad7baead515cc515af426c6bf43a9e938"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:ab84c81f55de662a0d502251697cd9338" id="r_ab84c81f55de662a0d502251697cd9338"><td class="memItemLeft" align="right" valign="top">U32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_random_r250.html#ab84c81f55de662a0d502251697cd9338">randI</a> (void)</td></tr>
  99. <tr class="separator:ab84c81f55de662a0d502251697cd9338"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="inherit_header pub_methods_class_random_generator_base"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_random_generator_base')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_random_generator_base.html">RandomGeneratorBase</a></td></tr>
  101. <tr class="memitem:a08b675fe1ae4bdc9f781e3a4176d1eba inherit pub_methods_class_random_generator_base" id="r_a08b675fe1ae4bdc9f781e3a4176d1eba"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_random_generator_base.html#a08b675fe1ae4bdc9f781e3a4176d1eba">resetSeed</a> (void)</td></tr>
  102. <tr class="separator:a08b675fe1ae4bdc9f781e3a4176d1eba inherit pub_methods_class_random_generator_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:adc8543e1b61947a4d32c49011747023e inherit pub_methods_class_random_generator_base" id="r_adc8543e1b61947a4d32c49011747023e"><td class="memItemLeft" align="right" valign="top">S32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_random_generator_base.html#adc8543e1b61947a4d32c49011747023e">getSeed</a> (void) const</td></tr>
  104. <tr class="separator:adc8543e1b61947a4d32c49011747023e inherit pub_methods_class_random_generator_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:a66dc2bd0a9e9ec761b9f9c1385d1da37 inherit pub_methods_class_random_generator_base" id="r_a66dc2bd0a9e9ec761b9f9c1385d1da37"><td class="memItemLeft" align="right" valign="top">F32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_random_generator_base.html#a66dc2bd0a9e9ec761b9f9c1385d1da37">randRangeF</a> (const F32 from, const F32 to)</td></tr>
  106. <tr class="separator:a66dc2bd0a9e9ec761b9f9c1385d1da37 inherit pub_methods_class_random_generator_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:a17de5f7ebb2d29025ba92545e2a6d0df inherit pub_methods_class_random_generator_base" id="r_a17de5f7ebb2d29025ba92545e2a6d0df"><td class="memItemLeft" align="right" valign="top">S32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_random_generator_base.html#a17de5f7ebb2d29025ba92545e2a6d0df">randRangeI</a> (const S32 from, const S32 to)</td></tr>
  108. <tr class="separator:a17de5f7ebb2d29025ba92545e2a6d0df inherit pub_methods_class_random_generator_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:a29dcddafed6b4015e6c6c32537f04451 inherit pub_methods_class_random_generator_base" id="r_a29dcddafed6b4015e6c6c32537f04451"><td class="memItemLeft" align="right" valign="top">virtual F32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_random_generator_base.html#a29dcddafed6b4015e6c6c32537f04451">randF</a> (void)</td></tr>
  110. <tr class="separator:a29dcddafed6b4015e6c6c32537f04451 inherit pub_methods_class_random_generator_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. </table><table class="memberdecls">
  112. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
  113. Additional Inherited Members</h2></td></tr>
  114. <tr class="inherit_header pro_methods_class_random_generator_base"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_class_random_generator_base')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="class_random_generator_base.html">RandomGeneratorBase</a></td></tr>
  115. <tr class="memitem:adb8b502f641ec3111995c7fdada0b5aa inherit pro_methods_class_random_generator_base" id="r_adb8b502f641ec3111995c7fdada0b5aa"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_random_generator_base.html#adb8b502f641ec3111995c7fdada0b5aa">RandomGeneratorBase</a> ()</td></tr>
  116. <tr class="separator:adb8b502f641ec3111995c7fdada0b5aa inherit pro_methods_class_random_generator_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="inherit_header pro_attribs_class_random_generator_base"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_class_random_generator_base')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="class_random_generator_base.html">RandomGeneratorBase</a></td></tr>
  118. <tr class="memitem:ad7e56cfb8df38306897a1104d246eb77 inherit pro_attribs_class_random_generator_base" id="r_ad7e56cfb8df38306897a1104d246eb77"><td class="memItemLeft" align="right" valign="top">S32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_random_generator_base.html#ad7e56cfb8df38306897a1104d246eb77">mSeed</a></td></tr>
  119. <tr class="separator:ad7e56cfb8df38306897a1104d246eb77 inherit pro_attribs_class_random_generator_base"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. </table>
  121. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  122. <div class="textblock"><p>Fast, very good random numbers</p>
  123. <p>Period = 2^249</p>
  124. <p>Kirkpatrick, S., and E. Stoll, 1981; A Very Fast Shift-Register Sequence Random Number Generator, Journal of Computational Physics, V. 40.</p>
  125. <p>Maier, W.L., 1991; A Fast Pseudo Random Number Generator, Dr. Dobb's Journal, May, pp. 152 - 157 </p>
  126. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  127. <a id="a94e12030c0c39d7ba060da9d6174744f" name="a94e12030c0c39d7ba060da9d6174744f"></a>
  128. <h2 class="memtitle"><span class="permalink"><a href="#a94e12030c0c39d7ba060da9d6174744f">&#9670;&#160;</a></span>RandomR250() <span class="overload">[1/2]</span></h2>
  129. <div class="memitem">
  130. <div class="memproto">
  131. <table class="memname">
  132. <tr>
  133. <td class="memname"><a class="el" href="class_random_r250.html">RandomR250</a> </td>
  134. <td>(</td>
  135. <td class="paramname"></td><td>)</td>
  136. <td></td>
  137. </tr>
  138. </table>
  139. </div><div class="memdoc">
  140. </div>
  141. </div>
  142. <a id="ac9ee10171f0526271c5eeb29ec279842" name="ac9ee10171f0526271c5eeb29ec279842"></a>
  143. <h2 class="memtitle"><span class="permalink"><a href="#ac9ee10171f0526271c5eeb29ec279842">&#9670;&#160;</a></span>RandomR250() <span class="overload">[2/2]</span></h2>
  144. <div class="memitem">
  145. <div class="memproto">
  146. <table class="memname">
  147. <tr>
  148. <td class="memname"><a class="el" href="class_random_r250.html">RandomR250</a> </td>
  149. <td>(</td>
  150. <td class="paramtype">const S32&#160;</td>
  151. <td class="paramname"><em>seed</em></td><td>)</td>
  152. <td></td>
  153. </tr>
  154. </table>
  155. </div><div class="memdoc">
  156. </div>
  157. </div>
  158. <h2 class="groupheader">Member Function Documentation</h2>
  159. <a id="ab84c81f55de662a0d502251697cd9338" name="ab84c81f55de662a0d502251697cd9338"></a>
  160. <h2 class="memtitle"><span class="permalink"><a href="#ab84c81f55de662a0d502251697cd9338">&#9670;&#160;</a></span>randI()</h2>
  161. <div class="memitem">
  162. <div class="memproto">
  163. <table class="mlabels">
  164. <tr>
  165. <td class="mlabels-left">
  166. <table class="memname">
  167. <tr>
  168. <td class="memname">U32 randI </td>
  169. <td>(</td>
  170. <td class="paramtype">void&#160;</td>
  171. <td class="paramname"></td><td>)</td>
  172. <td></td>
  173. </tr>
  174. </table>
  175. </td>
  176. <td class="mlabels-right">
  177. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  178. </tr>
  179. </table>
  180. </div><div class="memdoc">
  181. <p>Implements <a class="el" href="class_random_generator_base.html#a5e952d14922dc2800e8251fe755a5b54">RandomGeneratorBase</a>.</p>
  182. </div>
  183. </div>
  184. <a id="ad7baead515cc515af426c6bf43a9e938" name="ad7baead515cc515af426c6bf43a9e938"></a>
  185. <h2 class="memtitle"><span class="permalink"><a href="#ad7baead515cc515af426c6bf43a9e938">&#9670;&#160;</a></span>setSeed()</h2>
  186. <div class="memitem">
  187. <div class="memproto">
  188. <table class="mlabels">
  189. <tr>
  190. <td class="mlabels-left">
  191. <table class="memname">
  192. <tr>
  193. <td class="memname">void setSeed </td>
  194. <td>(</td>
  195. <td class="paramtype">const S32&#160;</td>
  196. <td class="paramname"><em>seed</em></td><td>)</td>
  197. <td></td>
  198. </tr>
  199. </table>
  200. </td>
  201. <td class="mlabels-right">
  202. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  203. </tr>
  204. </table>
  205. </div><div class="memdoc">
  206. <p>Implements <a class="el" href="class_random_generator_base.html#acf51f05fc5d44000a3a85092679addcc">RandomGeneratorBase</a>.</p>
  207. </div>
  208. </div>
  209. <hr/>The documentation for this class was generated from the following files:<ul>
  210. <li>math/<b>mRandom.h</b></li>
  211. <li>math/<b>mRandom.cc</b></li>
  212. </ul>
  213. </div><!-- contents -->
  214. <!-- start footer part -->
  215. <hr class="footer"/><address class="footer"><small>
  216. 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
  217. </small></address>
  218. </body>
  219. </html>