a00150.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <title>GLM_GTC_random: Random number generation</title>
  6. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  7. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  8. </head>
  9. <body>
  10. <div id="top"><!-- do not remove this div! -->
  11. <div id="titlearea">
  12. <table cellspacing="0" cellpadding="0">
  13. <tbody>
  14. <tr style="height: 56px;">
  15. <td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
  16. </tr>
  17. </tbody>
  18. </table>
  19. </div>
  20. <!-- Generated by Doxygen 1.7.5.1 -->
  21. <div id="navrow1" class="tabs">
  22. <ul class="tablist">
  23. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  24. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  25. <li><a href="modules.html"><span>Modules</span></a></li>
  26. <li><a href="annotated.html"><span>Classes</span></a></li>
  27. <li><a href="files.html"><span>Files</span></a></li>
  28. </ul>
  29. </div>
  30. </div>
  31. <div class="header">
  32. <div class="summary">
  33. <a href="#func-members">Functions</a> </div>
  34. <div class="headertitle">
  35. <div class="title">GLM_GTC_random: Random number generation</div> </div>
  36. <div class="ingroups"><a class="el" href="a00136.html">GTC Extensions (Stable)</a></div></div>
  37. <div class="contents">
  38. <table class="memberdecls">
  39. <tr><td colspan="2"><h2><a name="func-members"></a>
  40. Functions</h2></td></tr>
  41. <tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  42. <tr><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_QUALIFIER <br class="typebreak"/>
  43. detail::tvec3&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#ga9603f085f45198fac365d85756941be5">ballRand</a> (T const &amp;Radius)</td></tr>
  44. <tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  45. <tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec2&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#ga6e74477d1997a1bc2cf62bcc36167674">circularRand</a> (T const &amp;Radius)</td></tr>
  46. <tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  47. <tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec2&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#gaacf5ed0c8f984b4ca3004019c573dc51">diskRand</a> (T const &amp;Radius)</td></tr>
  48. <tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  49. <tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#ga8cf40a2f2268b91103f763b6ea2c44d8">gaussRand</a> (genType const &amp;Mean, genType const &amp;Deviation)</td></tr>
  50. <tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  51. <tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#ga4fbce21c9727ffcd7f19813d6d7d8024">linearRand</a> (genType const &amp;Min, genType const &amp;Max)</td></tr>
  52. <tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  53. <tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00150.html#ga291f75129653fa6371d2d57d78f8aca6">sphericalRand</a> (T const &amp;Radius)</td></tr>
  54. </table>
  55. <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
  56. <p>Generate random number from various distribution methods. </p>
  57. <p>&lt;<a class="el" href="a00078.html" title="OpenGL Mathematics (glm.g-truc.net)">glm/gtc/random.hpp</a>&gt; need to be included to use these functionalities. </p>
  58. <hr/><h2>Function Documentation</h2>
  59. <a class="anchor" id="ga9603f085f45198fac365d85756941be5"></a><!-- doxytag: member="glm::ballRand" ref="ga9603f085f45198fac365d85756941be5" args="(T const &amp;Radius)" -->
  60. <div class="memitem">
  61. <div class="memproto">
  62. <table class="memname">
  63. <tr>
  64. <td class="memname">GLM_FUNC_QUALIFIER detail::tvec3&lt;T&gt; glm::ballRand </td>
  65. <td>(</td>
  66. <td class="paramtype">T const &amp;&#160;</td>
  67. <td class="paramname"><em>Radius</em></td><td>)</td>
  68. <td></td>
  69. </tr>
  70. </table>
  71. </div>
  72. <div class="memdoc">
  73. <p>Generate a random 3D vector which coordinates are regulary distributed within the volume of a ball of a given radius. </p>
  74. <dl><dt><b>Parameters:</b></dt><dd>
  75. <table class="params">
  76. <tr><td class="paramname">Radius</td><td></td></tr>
  77. </table>
  78. </dd>
  79. </dl>
  80. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="a00150.html" title="Generate random number from various distribution methods.">GLM_GTC_random: Random number generation</a> </dd></dl>
  81. </div>
  82. </div>
  83. <a class="anchor" id="ga6e74477d1997a1bc2cf62bcc36167674"></a><!-- doxytag: member="glm::circularRand" ref="ga6e74477d1997a1bc2cf62bcc36167674" args="(T const &amp;Radius)" -->
  84. <div class="memitem">
  85. <div class="memproto">
  86. <table class="memname">
  87. <tr>
  88. <td class="memname">detail::tvec2&lt;T&gt; glm::circularRand </td>
  89. <td>(</td>
  90. <td class="paramtype">T const &amp;&#160;</td>
  91. <td class="paramname"><em>Radius</em></td><td>)</td>
  92. <td></td>
  93. </tr>
  94. </table>
  95. </div>
  96. <div class="memdoc">
  97. <p>Generate a random 2D vector which coordinates are regulary distributed on a circle of a given radius. </p>
  98. <dl><dt><b>Parameters:</b></dt><dd>
  99. <table class="params">
  100. <tr><td class="paramname">Radius</td><td></td></tr>
  101. </table>
  102. </dd>
  103. </dl>
  104. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="a00150.html" title="Generate random number from various distribution methods.">GLM_GTC_random: Random number generation</a> </dd></dl>
  105. </div>
  106. </div>
  107. <a class="anchor" id="gaacf5ed0c8f984b4ca3004019c573dc51"></a><!-- doxytag: member="glm::diskRand" ref="gaacf5ed0c8f984b4ca3004019c573dc51" args="(T const &amp;Radius)" -->
  108. <div class="memitem">
  109. <div class="memproto">
  110. <table class="memname">
  111. <tr>
  112. <td class="memname">detail::tvec2&lt;T&gt; glm::diskRand </td>
  113. <td>(</td>
  114. <td class="paramtype">T const &amp;&#160;</td>
  115. <td class="paramname"><em>Radius</em></td><td>)</td>
  116. <td></td>
  117. </tr>
  118. </table>
  119. </div>
  120. <div class="memdoc">
  121. <p>Generate a random 2D vector which coordinates are regulary distributed within the area of a disk of a given radius. </p>
  122. <dl><dt><b>Parameters:</b></dt><dd>
  123. <table class="params">
  124. <tr><td class="paramname">Radius</td><td></td></tr>
  125. </table>
  126. </dd>
  127. </dl>
  128. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="a00150.html" title="Generate random number from various distribution methods.">GLM_GTC_random: Random number generation</a> </dd></dl>
  129. </div>
  130. </div>
  131. <a class="anchor" id="ga8cf40a2f2268b91103f763b6ea2c44d8"></a><!-- doxytag: member="glm::gaussRand" ref="ga8cf40a2f2268b91103f763b6ea2c44d8" args="(genType const &amp;Mean, genType const &amp;Deviation)" -->
  132. <div class="memitem">
  133. <div class="memproto">
  134. <table class="memname">
  135. <tr>
  136. <td class="memname">genType glm::gaussRand </td>
  137. <td>(</td>
  138. <td class="paramtype">genType const &amp;&#160;</td>
  139. <td class="paramname"><em>Mean</em>, </td>
  140. </tr>
  141. <tr>
  142. <td class="paramkey"></td>
  143. <td></td>
  144. <td class="paramtype">genType const &amp;&#160;</td>
  145. <td class="paramname"><em>Deviation</em>&#160;</td>
  146. </tr>
  147. <tr>
  148. <td></td>
  149. <td>)</td>
  150. <td></td><td></td>
  151. </tr>
  152. </table>
  153. </div>
  154. <div class="memdoc">
  155. <p>Generate random numbers in the interval [Min, Max], according a gaussian distribution. </p>
  156. <dl><dt><b>Parameters:</b></dt><dd>
  157. <table class="params">
  158. <tr><td class="paramname">Mean</td><td></td></tr>
  159. <tr><td class="paramname">Deviation</td><td></td></tr>
  160. </table>
  161. </dd>
  162. </dl>
  163. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="a00150.html" title="Generate random number from various distribution methods.">GLM_GTC_random: Random number generation</a> </dd></dl>
  164. </div>
  165. </div>
  166. <a class="anchor" id="ga4fbce21c9727ffcd7f19813d6d7d8024"></a><!-- doxytag: member="glm::linearRand" ref="ga4fbce21c9727ffcd7f19813d6d7d8024" args="(genType const &amp;Min, genType const &amp;Max)" -->
  167. <div class="memitem">
  168. <div class="memproto">
  169. <table class="memname">
  170. <tr>
  171. <td class="memname">genType glm::linearRand </td>
  172. <td>(</td>
  173. <td class="paramtype">genType const &amp;&#160;</td>
  174. <td class="paramname"><em>Min</em>, </td>
  175. </tr>
  176. <tr>
  177. <td class="paramkey"></td>
  178. <td></td>
  179. <td class="paramtype">genType const &amp;&#160;</td>
  180. <td class="paramname"><em>Max</em>&#160;</td>
  181. </tr>
  182. <tr>
  183. <td></td>
  184. <td>)</td>
  185. <td></td><td></td>
  186. </tr>
  187. </table>
  188. </div>
  189. <div class="memdoc">
  190. <p>Generate random numbers in the interval [Min, Max], according a linear distribution. </p>
  191. <dl><dt><b>Parameters:</b></dt><dd>
  192. <table class="params">
  193. <tr><td class="paramname">Min</td><td></td></tr>
  194. <tr><td class="paramname">Max</td><td></td></tr>
  195. </table>
  196. </dd>
  197. </dl>
  198. <dl><dt><b>Template Parameters:</b></dt><dd>
  199. <table class="">
  200. <tr><td class="paramname">genType</td><td>Value type. Currently supported: half (not recommanded), float or double scalars and vectors. </td></tr>
  201. </table>
  202. </dd>
  203. </dl>
  204. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="a00150.html" title="Generate random number from various distribution methods.">GLM_GTC_random: Random number generation</a> </dd></dl>
  205. </div>
  206. </div>
  207. <a class="anchor" id="ga291f75129653fa6371d2d57d78f8aca6"></a><!-- doxytag: member="glm::sphericalRand" ref="ga291f75129653fa6371d2d57d78f8aca6" args="(T const &amp;Radius)" -->
  208. <div class="memitem">
  209. <div class="memproto">
  210. <table class="memname">
  211. <tr>
  212. <td class="memname">detail::tvec3&lt;T&gt; glm::sphericalRand </td>
  213. <td>(</td>
  214. <td class="paramtype">T const &amp;&#160;</td>
  215. <td class="paramname"><em>Radius</em></td><td>)</td>
  216. <td></td>
  217. </tr>
  218. </table>
  219. </div>
  220. <div class="memdoc">
  221. <p>Generate a random 3D vector which coordinates are regulary distributed on a sphere of a given radius. </p>
  222. <dl><dt><b>Parameters:</b></dt><dd>
  223. <table class="params">
  224. <tr><td class="paramname">Radius</td><td></td></tr>
  225. </table>
  226. </dd>
  227. </dl>
  228. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="a00150.html" title="Generate random number from various distribution methods.">GLM_GTC_random: Random number generation</a> </dd></dl>
  229. </div>
  230. </div>
  231. </div>
  232. <hr class="footer"/><address class="footer"><small>
  233. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  234. <img class="footer" src="doxygen.png" alt="doxygen"/>
  235. </a> 1.7.5.1
  236. </small></address>
  237. </body>
  238. </html>