class_random_generator_base.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382
  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: RandomGeneratorBase 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="#pro-methods">Protected Member Functions</a> &#124;
  74. <a href="#pro-attribs">Protected Attributes</a> &#124;
  75. <a href="class_random_generator_base-members.html">List of all members</a> </div>
  76. <div class="headertitle"><div class="title">RandomGeneratorBase Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
  77. </div><!--header-->
  78. <div class="contents">
  79. <p><code>#include &lt;mRandom.h&gt;</code></p>
  80. <div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  81. <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for RandomGeneratorBase:</div>
  82. <div id="dynsection-0-summary" class="dynsummary" style="display:block;">
  83. </div>
  84. <div id="dynsection-0-content" class="dyncontent" style="display:none;">
  85. <div class="center">
  86. <img src="class_random_generator_base.png" usemap="#RandomGeneratorBase_map" alt=""/>
  87. <map id="RandomGeneratorBase_map" name="RandomGeneratorBase_map">
  88. <area href="class_random_l_c_g.html" alt="RandomLCG" shape="rect" coords="0,56,142,80"/>
  89. <area href="class_random_p_c_g.html" alt="RandomPCG" shape="rect" coords="152,56,294,80"/>
  90. <area href="class_random_r250.html" alt="RandomR250" shape="rect" coords="304,56,446,80"/>
  91. </map>
  92. </div></div>
  93. <table class="memberdecls">
  94. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  95. Public Member Functions</h2></td></tr>
  96. <tr class="memitem:a08b675fe1ae4bdc9f781e3a4176d1eba" 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>
  97. <tr class="separator:a08b675fe1ae4bdc9f781e3a4176d1eba"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:adc8543e1b61947a4d32c49011747023e" 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>
  99. <tr class="separator:adc8543e1b61947a4d32c49011747023e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:a66dc2bd0a9e9ec761b9f9c1385d1da37" 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>
  101. <tr class="separator:a66dc2bd0a9e9ec761b9f9c1385d1da37"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:a17de5f7ebb2d29025ba92545e2a6d0df" 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>
  103. <tr class="separator:a17de5f7ebb2d29025ba92545e2a6d0df"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:a29dcddafed6b4015e6c6c32537f04451" 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>
  105. <tr class="separator:a29dcddafed6b4015e6c6c32537f04451"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:a5e952d14922dc2800e8251fe755a5b54" id="r_a5e952d14922dc2800e8251fe755a5b54"><td class="memItemLeft" align="right" valign="top">virtual U32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_random_generator_base.html#a5e952d14922dc2800e8251fe755a5b54">randI</a> (void)=0</td></tr>
  107. <tr class="separator:a5e952d14922dc2800e8251fe755a5b54"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:acf51f05fc5d44000a3a85092679addcc" id="r_acf51f05fc5d44000a3a85092679addcc"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_random_generator_base.html#acf51f05fc5d44000a3a85092679addcc">setSeed</a> (const S32 seed)=0</td></tr>
  109. <tr class="separator:acf51f05fc5d44000a3a85092679addcc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. </table><table class="memberdecls">
  111. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
  112. Protected Member Functions</h2></td></tr>
  113. <tr class="memitem:adb8b502f641ec3111995c7fdada0b5aa" 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>
  114. <tr class="separator:adb8b502f641ec3111995c7fdada0b5aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. </table><table class="memberdecls">
  116. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
  117. Protected Attributes</h2></td></tr>
  118. <tr class="memitem:ad7e56cfb8df38306897a1104d246eb77" 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"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. </table>
  121. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  122. <a id="adb8b502f641ec3111995c7fdada0b5aa" name="adb8b502f641ec3111995c7fdada0b5aa"></a>
  123. <h2 class="memtitle"><span class="permalink"><a href="#adb8b502f641ec3111995c7fdada0b5aa">&#9670;&#160;</a></span>RandomGeneratorBase()</h2>
  124. <div class="memitem">
  125. <div class="memproto">
  126. <table class="mlabels">
  127. <tr>
  128. <td class="mlabels-left">
  129. <table class="memname">
  130. <tr>
  131. <td class="memname"><a class="el" href="class_random_generator_base.html">RandomGeneratorBase</a> </td>
  132. <td>(</td>
  133. <td class="paramname"></td><td>)</td>
  134. <td></td>
  135. </tr>
  136. </table>
  137. </td>
  138. <td class="mlabels-right">
  139. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
  140. </tr>
  141. </table>
  142. </div><div class="memdoc">
  143. </div>
  144. </div>
  145. <h2 class="groupheader">Member Function Documentation</h2>
  146. <a id="adc8543e1b61947a4d32c49011747023e" name="adc8543e1b61947a4d32c49011747023e"></a>
  147. <h2 class="memtitle"><span class="permalink"><a href="#adc8543e1b61947a4d32c49011747023e">&#9670;&#160;</a></span>getSeed()</h2>
  148. <div class="memitem">
  149. <div class="memproto">
  150. <table class="mlabels">
  151. <tr>
  152. <td class="mlabels-left">
  153. <table class="memname">
  154. <tr>
  155. <td class="memname">S32 getSeed </td>
  156. <td>(</td>
  157. <td class="paramtype">void&#160;</td>
  158. <td class="paramname"></td><td>)</td>
  159. <td> const</td>
  160. </tr>
  161. </table>
  162. </td>
  163. <td class="mlabels-right">
  164. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  165. </tr>
  166. </table>
  167. </div><div class="memdoc">
  168. </div>
  169. </div>
  170. <a id="a29dcddafed6b4015e6c6c32537f04451" name="a29dcddafed6b4015e6c6c32537f04451"></a>
  171. <h2 class="memtitle"><span class="permalink"><a href="#a29dcddafed6b4015e6c6c32537f04451">&#9670;&#160;</a></span>randF()</h2>
  172. <div class="memitem">
  173. <div class="memproto">
  174. <table class="mlabels">
  175. <tr>
  176. <td class="mlabels-left">
  177. <table class="memname">
  178. <tr>
  179. <td class="memname">virtual F32 randF </td>
  180. <td>(</td>
  181. <td class="paramtype">void&#160;</td>
  182. <td class="paramname"></td><td>)</td>
  183. <td></td>
  184. </tr>
  185. </table>
  186. </td>
  187. <td class="mlabels-right">
  188. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  189. </tr>
  190. </table>
  191. </div><div class="memdoc">
  192. </div>
  193. </div>
  194. <a id="a5e952d14922dc2800e8251fe755a5b54" name="a5e952d14922dc2800e8251fe755a5b54"></a>
  195. <h2 class="memtitle"><span class="permalink"><a href="#a5e952d14922dc2800e8251fe755a5b54">&#9670;&#160;</a></span>randI()</h2>
  196. <div class="memitem">
  197. <div class="memproto">
  198. <table class="mlabels">
  199. <tr>
  200. <td class="mlabels-left">
  201. <table class="memname">
  202. <tr>
  203. <td class="memname">virtual U32 randI </td>
  204. <td>(</td>
  205. <td class="paramtype">void&#160;</td>
  206. <td class="paramname"></td><td>)</td>
  207. <td></td>
  208. </tr>
  209. </table>
  210. </td>
  211. <td class="mlabels-right">
  212. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  213. </tr>
  214. </table>
  215. </div><div class="memdoc">
  216. <p>Implemented in <a class="el" href="class_random_l_c_g.html#ab84c81f55de662a0d502251697cd9338">RandomLCG</a>, <a class="el" href="class_random_r250.html#ab84c81f55de662a0d502251697cd9338">RandomR250</a>, and <a class="el" href="class_random_p_c_g.html#ab84c81f55de662a0d502251697cd9338">RandomPCG</a>.</p>
  217. </div>
  218. </div>
  219. <a id="a66dc2bd0a9e9ec761b9f9c1385d1da37" name="a66dc2bd0a9e9ec761b9f9c1385d1da37"></a>
  220. <h2 class="memtitle"><span class="permalink"><a href="#a66dc2bd0a9e9ec761b9f9c1385d1da37">&#9670;&#160;</a></span>randRangeF()</h2>
  221. <div class="memitem">
  222. <div class="memproto">
  223. <table class="mlabels">
  224. <tr>
  225. <td class="mlabels-left">
  226. <table class="memname">
  227. <tr>
  228. <td class="memname">F32 randRangeF </td>
  229. <td>(</td>
  230. <td class="paramtype">const F32&#160;</td>
  231. <td class="paramname"><em>from</em>, </td>
  232. </tr>
  233. <tr>
  234. <td class="paramkey"></td>
  235. <td></td>
  236. <td class="paramtype">const F32&#160;</td>
  237. <td class="paramname"><em>to</em>&#160;</td>
  238. </tr>
  239. <tr>
  240. <td></td>
  241. <td>)</td>
  242. <td></td><td></td>
  243. </tr>
  244. </table>
  245. </td>
  246. <td class="mlabels-right">
  247. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  248. </tr>
  249. </table>
  250. </div><div class="memdoc">
  251. </div>
  252. </div>
  253. <a id="a17de5f7ebb2d29025ba92545e2a6d0df" name="a17de5f7ebb2d29025ba92545e2a6d0df"></a>
  254. <h2 class="memtitle"><span class="permalink"><a href="#a17de5f7ebb2d29025ba92545e2a6d0df">&#9670;&#160;</a></span>randRangeI()</h2>
  255. <div class="memitem">
  256. <div class="memproto">
  257. <table class="mlabels">
  258. <tr>
  259. <td class="mlabels-left">
  260. <table class="memname">
  261. <tr>
  262. <td class="memname">S32 randRangeI </td>
  263. <td>(</td>
  264. <td class="paramtype">const S32&#160;</td>
  265. <td class="paramname"><em>from</em>, </td>
  266. </tr>
  267. <tr>
  268. <td class="paramkey"></td>
  269. <td></td>
  270. <td class="paramtype">const S32&#160;</td>
  271. <td class="paramname"><em>to</em>&#160;</td>
  272. </tr>
  273. <tr>
  274. <td></td>
  275. <td>)</td>
  276. <td></td><td></td>
  277. </tr>
  278. </table>
  279. </td>
  280. <td class="mlabels-right">
  281. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  282. </tr>
  283. </table>
  284. </div><div class="memdoc">
  285. </div>
  286. </div>
  287. <a id="a08b675fe1ae4bdc9f781e3a4176d1eba" name="a08b675fe1ae4bdc9f781e3a4176d1eba"></a>
  288. <h2 class="memtitle"><span class="permalink"><a href="#a08b675fe1ae4bdc9f781e3a4176d1eba">&#9670;&#160;</a></span>resetSeed()</h2>
  289. <div class="memitem">
  290. <div class="memproto">
  291. <table class="memname">
  292. <tr>
  293. <td class="memname">void resetSeed </td>
  294. <td>(</td>
  295. <td class="paramtype">void&#160;</td>
  296. <td class="paramname"></td><td>)</td>
  297. <td></td>
  298. </tr>
  299. </table>
  300. </div><div class="memdoc">
  301. </div>
  302. </div>
  303. <a id="acf51f05fc5d44000a3a85092679addcc" name="acf51f05fc5d44000a3a85092679addcc"></a>
  304. <h2 class="memtitle"><span class="permalink"><a href="#acf51f05fc5d44000a3a85092679addcc">&#9670;&#160;</a></span>setSeed()</h2>
  305. <div class="memitem">
  306. <div class="memproto">
  307. <table class="mlabels">
  308. <tr>
  309. <td class="mlabels-left">
  310. <table class="memname">
  311. <tr>
  312. <td class="memname">virtual void setSeed </td>
  313. <td>(</td>
  314. <td class="paramtype">const S32&#160;</td>
  315. <td class="paramname"><em>seed</em></td><td>)</td>
  316. <td></td>
  317. </tr>
  318. </table>
  319. </td>
  320. <td class="mlabels-right">
  321. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  322. </tr>
  323. </table>
  324. </div><div class="memdoc">
  325. <p>Implemented in <a class="el" href="class_random_l_c_g.html#ad7baead515cc515af426c6bf43a9e938">RandomLCG</a>, <a class="el" href="class_random_r250.html#ad7baead515cc515af426c6bf43a9e938">RandomR250</a>, and <a class="el" href="class_random_p_c_g.html#ad7baead515cc515af426c6bf43a9e938">RandomPCG</a>.</p>
  326. </div>
  327. </div>
  328. <h2 class="groupheader">Member Data Documentation</h2>
  329. <a id="ad7e56cfb8df38306897a1104d246eb77" name="ad7e56cfb8df38306897a1104d246eb77"></a>
  330. <h2 class="memtitle"><span class="permalink"><a href="#ad7e56cfb8df38306897a1104d246eb77">&#9670;&#160;</a></span>mSeed</h2>
  331. <div class="memitem">
  332. <div class="memproto">
  333. <table class="mlabels">
  334. <tr>
  335. <td class="mlabels-left">
  336. <table class="memname">
  337. <tr>
  338. <td class="memname">S32 mSeed</td>
  339. </tr>
  340. </table>
  341. </td>
  342. <td class="mlabels-right">
  343. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  344. </tr>
  345. </table>
  346. </div><div class="memdoc">
  347. </div>
  348. </div>
  349. <hr/>The documentation for this class was generated from the following files:<ul>
  350. <li>math/<b>mRandom.h</b></li>
  351. <li>math/<b>mRandom.cc</b></li>
  352. </ul>
  353. </div><!-- contents -->
  354. <!-- start footer part -->
  355. <hr class="footer"/><address class="footer"><small>
  356. 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
  357. </small></address>
  358. </body>
  359. </html>