a00175.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319
  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. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.10"/>
  7. <title>0.9.9 API documenation: GLM_GTC_random</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/searchdata.js"></script>
  13. <script type="text/javascript" src="search/search.js"></script>
  14. <script type="text/javascript">
  15. $(document).ready(function() { init_search(); });
  16. </script>
  17. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  18. </head>
  19. <body>
  20. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  21. <div id="titlearea">
  22. <table cellspacing="0" cellpadding="0">
  23. <tbody>
  24. <tr style="height: 56px;">
  25. <td id="projectalign" style="padding-left: 0.5em;">
  26. <div id="projectname">0.9.9 API documenation
  27. </div>
  28. </td>
  29. </tr>
  30. </tbody>
  31. </table>
  32. </div>
  33. <!-- end header part -->
  34. <!-- Generated by Doxygen 1.8.10 -->
  35. <script type="text/javascript">
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. </script>
  38. <div id="navrow1" class="tabs">
  39. <ul class="tablist">
  40. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  41. <li><a href="modules.html"><span>Modules</span></a></li>
  42. <li><a href="files.html"><span>Files</span></a></li>
  43. <li>
  44. <div id="MSearchBox" class="MSearchBoxInactive">
  45. <span class="left">
  46. <img id="MSearchSelect" src="search/mag_sel.png"
  47. onmouseover="return searchBox.OnSearchSelectShow()"
  48. onmouseout="return searchBox.OnSearchSelectHide()"
  49. alt=""/>
  50. <input type="text" id="MSearchField" value="Search" accesskey="S"
  51. onfocus="searchBox.OnSearchFieldFocus(true)"
  52. onblur="searchBox.OnSearchFieldFocus(false)"
  53. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  54. </span><span class="right">
  55. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  56. </span>
  57. </div>
  58. </li>
  59. </ul>
  60. </div>
  61. </div><!-- top -->
  62. <!-- window showing the filter options -->
  63. <div id="MSearchSelectWindow"
  64. onmouseover="return searchBox.OnSearchSelectShow()"
  65. onmouseout="return searchBox.OnSearchSelectHide()"
  66. onkeydown="return searchBox.OnSearchSelectKey(event)">
  67. </div>
  68. <!-- iframe showing the search results (closed by default) -->
  69. <div id="MSearchResultsWindow">
  70. <iframe src="javascript:void(0)" frameborder="0"
  71. name="MSearchResults" id="MSearchResults">
  72. </iframe>
  73. </div>
  74. <div class="header">
  75. <div class="summary">
  76. <a href="#func-members">Functions</a> </div>
  77. <div class="headertitle">
  78. <div class="title">GLM_GTC_random<div class="ingroups"><a class="el" href="a00156.html">GTC Extensions (Stable)</a></div></div> </div>
  79. </div><!--header-->
  80. <div class="contents">
  81. <p>Generate random number from various distribution methods.
  82. <a href="#details">More...</a></p>
  83. <table class="memberdecls">
  84. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  85. Functions</h2></td></tr>
  86. <tr class="memitem:ga7c53b7797f3147af68a11c767679fa3f"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  87. <tr class="memitem:ga7c53b7797f3147af68a11c767679fa3f"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; 3, T, defaultp &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00175.html#ga7c53b7797f3147af68a11c767679fa3f">ballRand</a> (T Radius)</td></tr>
  88. <tr class="memdesc:ga7c53b7797f3147af68a11c767679fa3f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate a random 3D vector which coordinates are regulary distributed within the volume of a ball of a given radius. <a href="a00175.html#ga7c53b7797f3147af68a11c767679fa3f">More...</a><br /></td></tr>
  89. <tr class="separator:ga7c53b7797f3147af68a11c767679fa3f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:ga9dd05c36025088fae25b97c869e88517"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  91. <tr class="memitem:ga9dd05c36025088fae25b97c869e88517"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; 2, T, defaultp &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00175.html#ga9dd05c36025088fae25b97c869e88517">circularRand</a> (T Radius)</td></tr>
  92. <tr class="memdesc:ga9dd05c36025088fae25b97c869e88517"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate a random 2D vector which coordinates are regulary distributed on a circle of a given radius. <a href="a00175.html#ga9dd05c36025088fae25b97c869e88517">More...</a><br /></td></tr>
  93. <tr class="separator:ga9dd05c36025088fae25b97c869e88517"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:gaa0b18071f3f97dbf8bcf6f53c6fe5f73"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  95. <tr class="memitem:gaa0b18071f3f97dbf8bcf6f53c6fe5f73"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; 2, T, defaultp &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00175.html#gaa0b18071f3f97dbf8bcf6f53c6fe5f73">diskRand</a> (T Radius)</td></tr>
  96. <tr class="memdesc:gaa0b18071f3f97dbf8bcf6f53c6fe5f73"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate a random 2D vector which coordinates are regulary distributed within the area of a disk of a given radius. <a href="a00175.html#gaa0b18071f3f97dbf8bcf6f53c6fe5f73">More...</a><br /></td></tr>
  97. <tr class="separator:gaa0b18071f3f97dbf8bcf6f53c6fe5f73"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:ga5193a83e49e4fdc5652c084711083574"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  99. <tr class="memitem:ga5193a83e49e4fdc5652c084711083574"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00175.html#ga5193a83e49e4fdc5652c084711083574">gaussRand</a> (genType Mean, genType Deviation)</td></tr>
  100. <tr class="memdesc:ga5193a83e49e4fdc5652c084711083574"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate random numbers in the interval [Min, Max], according a gaussian distribution. <a href="a00175.html#ga5193a83e49e4fdc5652c084711083574">More...</a><br /></td></tr>
  101. <tr class="separator:ga5193a83e49e4fdc5652c084711083574"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:ga04e241ab88374a477a2c2ceadd2fa03d"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  103. <tr class="memitem:ga04e241ab88374a477a2c2ceadd2fa03d"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00175.html#ga04e241ab88374a477a2c2ceadd2fa03d">linearRand</a> (genType Min, genType Max)</td></tr>
  104. <tr class="memdesc:ga04e241ab88374a477a2c2ceadd2fa03d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate random numbers in the interval [Min, Max], according a linear distribution. <a href="a00175.html#ga04e241ab88374a477a2c2ceadd2fa03d">More...</a><br /></td></tr>
  105. <tr class="separator:ga04e241ab88374a477a2c2ceadd2fa03d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:gab22e2ce52a7cfb06314622a8e513d047"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier P&gt; </td></tr>
  107. <tr class="memitem:gab22e2ce52a7cfb06314622a8e513d047"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00175.html#gab22e2ce52a7cfb06314622a8e513d047">linearRand</a> (vec&lt; L, T, P &gt; const &amp;Min, vec&lt; L, T, P &gt; const &amp;Max)</td></tr>
  108. <tr class="memdesc:gab22e2ce52a7cfb06314622a8e513d047"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate random numbers in the interval [Min, Max], according a linear distribution. <a href="a00175.html#gab22e2ce52a7cfb06314622a8e513d047">More...</a><br /></td></tr>
  109. <tr class="separator:gab22e2ce52a7cfb06314622a8e513d047"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:ga22f90fcaccdf001c516ca90f6428e138"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  111. <tr class="memitem:ga22f90fcaccdf001c516ca90f6428e138"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; 3, T, defaultp &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00175.html#ga22f90fcaccdf001c516ca90f6428e138">sphericalRand</a> (T Radius)</td></tr>
  112. <tr class="memdesc:ga22f90fcaccdf001c516ca90f6428e138"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate a random 3D vector which coordinates are regulary distributed on a sphere of a given radius. <a href="a00175.html#ga22f90fcaccdf001c516ca90f6428e138">More...</a><br /></td></tr>
  113. <tr class="separator:ga22f90fcaccdf001c516ca90f6428e138"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. </table>
  115. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  116. <p>Generate random number from various distribution methods. </p>
  117. <p>&lt;<a class="el" href="a00093.html" title="GLM_GTC_random ">glm/gtc/random.hpp</a>&gt; need to be included to use these functionalities. </p>
  118. <h2 class="groupheader">Function Documentation</h2>
  119. <a class="anchor" id="ga7c53b7797f3147af68a11c767679fa3f"></a>
  120. <div class="memitem">
  121. <div class="memproto">
  122. <table class="memname">
  123. <tr>
  124. <td class="memname">GLM_FUNC_DECL vec&lt;3, T, defaultp&gt; glm::ballRand </td>
  125. <td>(</td>
  126. <td class="paramtype">T&#160;</td>
  127. <td class="paramname"><em>Radius</em></td><td>)</td>
  128. <td></td>
  129. </tr>
  130. </table>
  131. </div><div class="memdoc">
  132. <p>Generate a random 3D vector which coordinates are regulary distributed within the volume of a ball of a given radius. </p>
  133. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00175.html" title="Generate random number from various distribution methods. ">GLM_GTC_random</a> </dd></dl>
  134. </div>
  135. </div>
  136. <a class="anchor" id="ga9dd05c36025088fae25b97c869e88517"></a>
  137. <div class="memitem">
  138. <div class="memproto">
  139. <table class="memname">
  140. <tr>
  141. <td class="memname">GLM_FUNC_DECL vec&lt;2, T, defaultp&gt; glm::circularRand </td>
  142. <td>(</td>
  143. <td class="paramtype">T&#160;</td>
  144. <td class="paramname"><em>Radius</em></td><td>)</td>
  145. <td></td>
  146. </tr>
  147. </table>
  148. </div><div class="memdoc">
  149. <p>Generate a random 2D vector which coordinates are regulary distributed on a circle of a given radius. </p>
  150. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00175.html" title="Generate random number from various distribution methods. ">GLM_GTC_random</a> </dd></dl>
  151. </div>
  152. </div>
  153. <a class="anchor" id="gaa0b18071f3f97dbf8bcf6f53c6fe5f73"></a>
  154. <div class="memitem">
  155. <div class="memproto">
  156. <table class="memname">
  157. <tr>
  158. <td class="memname">GLM_FUNC_DECL vec&lt;2, T, defaultp&gt; glm::diskRand </td>
  159. <td>(</td>
  160. <td class="paramtype">T&#160;</td>
  161. <td class="paramname"><em>Radius</em></td><td>)</td>
  162. <td></td>
  163. </tr>
  164. </table>
  165. </div><div class="memdoc">
  166. <p>Generate a random 2D vector which coordinates are regulary distributed within the area of a disk of a given radius. </p>
  167. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00175.html" title="Generate random number from various distribution methods. ">GLM_GTC_random</a> </dd></dl>
  168. </div>
  169. </div>
  170. <a class="anchor" id="ga5193a83e49e4fdc5652c084711083574"></a>
  171. <div class="memitem">
  172. <div class="memproto">
  173. <table class="memname">
  174. <tr>
  175. <td class="memname">GLM_FUNC_DECL genType glm::gaussRand </td>
  176. <td>(</td>
  177. <td class="paramtype">genType&#160;</td>
  178. <td class="paramname"><em>Mean</em>, </td>
  179. </tr>
  180. <tr>
  181. <td class="paramkey"></td>
  182. <td></td>
  183. <td class="paramtype">genType&#160;</td>
  184. <td class="paramname"><em>Deviation</em>&#160;</td>
  185. </tr>
  186. <tr>
  187. <td></td>
  188. <td>)</td>
  189. <td></td><td></td>
  190. </tr>
  191. </table>
  192. </div><div class="memdoc">
  193. <p>Generate random numbers in the interval [Min, Max], according a gaussian distribution. </p>
  194. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00175.html" title="Generate random number from various distribution methods. ">GLM_GTC_random</a> </dd></dl>
  195. </div>
  196. </div>
  197. <a class="anchor" id="ga04e241ab88374a477a2c2ceadd2fa03d"></a>
  198. <div class="memitem">
  199. <div class="memproto">
  200. <table class="memname">
  201. <tr>
  202. <td class="memname">GLM_FUNC_DECL genType glm::linearRand </td>
  203. <td>(</td>
  204. <td class="paramtype">genType&#160;</td>
  205. <td class="paramname"><em>Min</em>, </td>
  206. </tr>
  207. <tr>
  208. <td class="paramkey"></td>
  209. <td></td>
  210. <td class="paramtype">genType&#160;</td>
  211. <td class="paramname"><em>Max</em>&#160;</td>
  212. </tr>
  213. <tr>
  214. <td></td>
  215. <td>)</td>
  216. <td></td><td></td>
  217. </tr>
  218. </table>
  219. </div><div class="memdoc">
  220. <p>Generate random numbers in the interval [Min, Max], according a linear distribution. </p>
  221. <dl class="params"><dt>Parameters</dt><dd>
  222. <table class="params">
  223. <tr><td class="paramname">Min</td><td>Minimum value included in the sampling </td></tr>
  224. <tr><td class="paramname">Max</td><td>Maximum value included in the sampling </td></tr>
  225. </table>
  226. </dd>
  227. </dl>
  228. <dl class="tparams"><dt>Template Parameters</dt><dd>
  229. <table class="tparams">
  230. <tr><td class="paramname">genType</td><td>Value type. Currently supported: float or double scalars. </td></tr>
  231. </table>
  232. </dd>
  233. </dl>
  234. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00175.html" title="Generate random number from various distribution methods. ">GLM_GTC_random</a> </dd></dl>
  235. </div>
  236. </div>
  237. <a class="anchor" id="gab22e2ce52a7cfb06314622a8e513d047"></a>
  238. <div class="memitem">
  239. <div class="memproto">
  240. <table class="memname">
  241. <tr>
  242. <td class="memname">GLM_FUNC_DECL vec&lt;L, T, P&gt; glm::linearRand </td>
  243. <td>(</td>
  244. <td class="paramtype">vec&lt; L, T, P &gt; const &amp;&#160;</td>
  245. <td class="paramname"><em>Min</em>, </td>
  246. </tr>
  247. <tr>
  248. <td class="paramkey"></td>
  249. <td></td>
  250. <td class="paramtype">vec&lt; L, T, P &gt; const &amp;&#160;</td>
  251. <td class="paramname"><em>Max</em>&#160;</td>
  252. </tr>
  253. <tr>
  254. <td></td>
  255. <td>)</td>
  256. <td></td><td></td>
  257. </tr>
  258. </table>
  259. </div><div class="memdoc">
  260. <p>Generate random numbers in the interval [Min, Max], according a linear distribution. </p>
  261. <dl class="params"><dt>Parameters</dt><dd>
  262. <table class="params">
  263. <tr><td class="paramname">Min</td><td>Minimum value included in the sampling </td></tr>
  264. <tr><td class="paramname">Max</td><td>Maximum value included in the sampling </td></tr>
  265. </table>
  266. </dd>
  267. </dl>
  268. <dl class="tparams"><dt>Template Parameters</dt><dd>
  269. <table class="tparams">
  270. <tr><td class="paramname">T</td><td>Value type. Currently supported: float or double.</td></tr>
  271. </table>
  272. </dd>
  273. </dl>
  274. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00175.html" title="Generate random number from various distribution methods. ">GLM_GTC_random</a> </dd></dl>
  275. </div>
  276. </div>
  277. <a class="anchor" id="ga22f90fcaccdf001c516ca90f6428e138"></a>
  278. <div class="memitem">
  279. <div class="memproto">
  280. <table class="memname">
  281. <tr>
  282. <td class="memname">GLM_FUNC_DECL vec&lt;3, T, defaultp&gt; glm::sphericalRand </td>
  283. <td>(</td>
  284. <td class="paramtype">T&#160;</td>
  285. <td class="paramname"><em>Radius</em></td><td>)</td>
  286. <td></td>
  287. </tr>
  288. </table>
  289. </div><div class="memdoc">
  290. <p>Generate a random 3D vector which coordinates are regulary distributed on a sphere of a given radius. </p>
  291. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00175.html" title="Generate random number from various distribution methods. ">GLM_GTC_random</a> </dd></dl>
  292. </div>
  293. </div>
  294. </div><!-- contents -->
  295. <!-- start footer part -->
  296. <hr class="footer"/><address class="footer"><small>
  297. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  298. <img class="footer" src="doxygen.png" alt="doxygen"/>
  299. </a> 1.8.10
  300. </small></address>
  301. </body>
  302. </html>