a00156.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327
  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.5"/>
  7. <title>GLM: Exponential functions</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="doxygen.css" rel="stylesheet" type="text/css" />
  12. </head>
  13. <body>
  14. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  15. <div id="titlearea">
  16. <table cellspacing="0" cellpadding="0">
  17. <tbody>
  18. <tr style="height: 56px;">
  19. <td style="padding-left: 0.5em;">
  20. <div id="projectname">GLM
  21. &#160;<span id="projectnumber">0.9.5</span>
  22. </div>
  23. </td>
  24. </tr>
  25. </tbody>
  26. </table>
  27. </div>
  28. <!-- end header part -->
  29. <!-- Generated by Doxygen 1.8.5 -->
  30. <div id="navrow1" class="tabs">
  31. <ul class="tablist">
  32. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  33. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  34. <li><a href="modules.html"><span>Modules</span></a></li>
  35. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  36. <li><a href="files.html"><span>Files</span></a></li>
  37. </ul>
  38. </div>
  39. </div><!-- top -->
  40. <div class="header">
  41. <div class="summary">
  42. <a href="#func-members">Functions</a> </div>
  43. <div class="headertitle">
  44. <div class="title">Exponential functions<div class="ingroups"><a class="el" href="a00167.html">GLM Core</a></div></div> </div>
  45. </div><!--header-->
  46. <div class="contents">
  47. <table class="memberdecls">
  48. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  49. Functions</h2></td></tr>
  50. <tr class="memitem:gae154699ba6bda068d4b87cf9b987381f"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  51. <tr class="memitem:gae154699ba6bda068d4b87cf9b987381f"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00156.html#gae154699ba6bda068d4b87cf9b987381f">exp</a> (genType const &amp;x)</td></tr>
  52. <tr class="separator:gae154699ba6bda068d4b87cf9b987381f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  53. <tr class="memitem:gac45997fb3ac907cad408d6da0a0f5f54"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  54. <tr class="memitem:gac45997fb3ac907cad408d6da0a0f5f54"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00156.html#gac45997fb3ac907cad408d6da0a0f5f54">exp2</a> (genType const &amp;x)</td></tr>
  55. <tr class="separator:gac45997fb3ac907cad408d6da0a0f5f54"><td class="memSeparator" colspan="2">&#160;</td></tr>
  56. <tr class="memitem:ga5ac08ead2e50ad0295b9ad85a3e449e9"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  57. <tr class="memitem:ga5ac08ead2e50ad0295b9ad85a3e449e9"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00156.html#ga5ac08ead2e50ad0295b9ad85a3e449e9">inversesqrt</a> (genType const &amp;x)</td></tr>
  58. <tr class="separator:ga5ac08ead2e50ad0295b9ad85a3e449e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  59. <tr class="memitem:ga0c8da2d2921da250e8700ac4476916a1"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  60. <tr class="memitem:ga0c8da2d2921da250e8700ac4476916a1"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00156.html#ga0c8da2d2921da250e8700ac4476916a1">log</a> (genType const &amp;x)</td></tr>
  61. <tr class="separator:ga0c8da2d2921da250e8700ac4476916a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  62. <tr class="memitem:gace633300a51ca1cbc1a42f565dcd3407"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  63. <tr class="memitem:gace633300a51ca1cbc1a42f565dcd3407"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00156.html#gace633300a51ca1cbc1a42f565dcd3407">log2</a> (genType const &amp;x)</td></tr>
  64. <tr class="separator:gace633300a51ca1cbc1a42f565dcd3407"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65. <tr class="memitem:ga1ce4b2fddd26d0d3a35a8d98f37f3ac0"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  66. <tr class="memitem:ga1ce4b2fddd26d0d3a35a8d98f37f3ac0"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00156.html#ga1ce4b2fddd26d0d3a35a8d98f37f3ac0">pow</a> (genType const &amp;base, genType const &amp;exponent)</td></tr>
  67. <tr class="separator:ga1ce4b2fddd26d0d3a35a8d98f37f3ac0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68. <tr class="memitem:ga2317d4ff45af448b8402431afa0711f3"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  69. <tr class="memitem:ga2317d4ff45af448b8402431afa0711f3"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00156.html#ga2317d4ff45af448b8402431afa0711f3">sqrt</a> (genType const &amp;x)</td></tr>
  70. <tr class="separator:ga2317d4ff45af448b8402431afa0711f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71. </table>
  72. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  73. <p>These all operate component-wise. </p>
  74. <p>The description is per component. </p>
  75. <h2 class="groupheader">Function Documentation</h2>
  76. <a class="anchor" id="gae154699ba6bda068d4b87cf9b987381f"></a>
  77. <div class="memitem">
  78. <div class="memproto">
  79. <table class="memname">
  80. <tr>
  81. <td class="memname">GLM_FUNC_DECL genType glm::exp </td>
  82. <td>(</td>
  83. <td class="paramtype">genType const &amp;&#160;</td>
  84. <td class="paramname"><em>x</em></td><td>)</td>
  85. <td></td>
  86. </tr>
  87. </table>
  88. </div><div class="memdoc">
  89. <p>Returns the natural exponentiation of x, i.e., e^x. </p>
  90. <dl class="params"><dt>Parameters</dt><dd>
  91. <table class="params">
  92. <tr><td class="paramname">x</td><td>exp function is defined for input values of x defined in the range (inf-, inf+) in the limit of the type precision. </td></tr>
  93. </table>
  94. </dd>
  95. </dl>
  96. <dl class="tparams"><dt>Template Parameters</dt><dd>
  97. <table class="tparams">
  98. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  99. </table>
  100. </dd>
  101. </dl>
  102. <dl class="section see"><dt>See Also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/exp.xml">GLSL exp man page</a> </dd>
  103. <dd>
  104. <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.2 Exponential Functions</a> </dd></dl>
  105. </div>
  106. </div>
  107. <a class="anchor" id="gac45997fb3ac907cad408d6da0a0f5f54"></a>
  108. <div class="memitem">
  109. <div class="memproto">
  110. <table class="memname">
  111. <tr>
  112. <td class="memname">GLM_FUNC_DECL genType glm::exp2 </td>
  113. <td>(</td>
  114. <td class="paramtype">genType const &amp;&#160;</td>
  115. <td class="paramname"><em>x</em></td><td>)</td>
  116. <td></td>
  117. </tr>
  118. </table>
  119. </div><div class="memdoc">
  120. <p>Returns 2 raised to the x power. </p>
  121. <dl class="params"><dt>Parameters</dt><dd>
  122. <table class="params">
  123. <tr><td class="paramname">x</td><td>exp2 function is defined for input values of x defined in the range (inf-, inf+) in the limit of the type precision. </td></tr>
  124. </table>
  125. </dd>
  126. </dl>
  127. <dl class="tparams"><dt>Template Parameters</dt><dd>
  128. <table class="tparams">
  129. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  130. </table>
  131. </dd>
  132. </dl>
  133. <dl class="section see"><dt>See Also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/exp2.xml">GLSL exp2 man page</a> </dd>
  134. <dd>
  135. <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.2 Exponential Functions</a> </dd></dl>
  136. </div>
  137. </div>
  138. <a class="anchor" id="ga5ac08ead2e50ad0295b9ad85a3e449e9"></a>
  139. <div class="memitem">
  140. <div class="memproto">
  141. <table class="memname">
  142. <tr>
  143. <td class="memname">GLM_FUNC_DECL genType glm::inversesqrt </td>
  144. <td>(</td>
  145. <td class="paramtype">genType const &amp;&#160;</td>
  146. <td class="paramname"><em>x</em></td><td>)</td>
  147. <td></td>
  148. </tr>
  149. </table>
  150. </div><div class="memdoc">
  151. <p>Returns the reciprocal of the positive square root of x. </p>
  152. <dl class="params"><dt>Parameters</dt><dd>
  153. <table class="params">
  154. <tr><td class="paramname">x</td><td>inversesqrt function is defined for input values of x defined in the range [0, inf+) in the limit of the type precision. </td></tr>
  155. </table>
  156. </dd>
  157. </dl>
  158. <dl class="tparams"><dt>Template Parameters</dt><dd>
  159. <table class="tparams">
  160. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  161. </table>
  162. </dd>
  163. </dl>
  164. <dl class="section see"><dt>See Also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/inversesqrt.xml">GLSL inversesqrt man page</a> </dd>
  165. <dd>
  166. <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.2 Exponential Functions</a> </dd></dl>
  167. </div>
  168. </div>
  169. <a class="anchor" id="ga0c8da2d2921da250e8700ac4476916a1"></a>
  170. <div class="memitem">
  171. <div class="memproto">
  172. <table class="memname">
  173. <tr>
  174. <td class="memname">GLM_FUNC_DECL genType glm::log </td>
  175. <td>(</td>
  176. <td class="paramtype">genType const &amp;&#160;</td>
  177. <td class="paramname"><em>x</em></td><td>)</td>
  178. <td></td>
  179. </tr>
  180. </table>
  181. </div><div class="memdoc">
  182. <p>Returns the natural logarithm of x, i.e., returns the value y which satisfies the equation x = e^y. </p>
  183. <p>Results are undefined if x &lt;= 0.</p>
  184. <dl class="params"><dt>Parameters</dt><dd>
  185. <table class="params">
  186. <tr><td class="paramname">x</td><td>log function is defined for input values of x defined in the range (0, inf+) in the limit of the type precision. </td></tr>
  187. </table>
  188. </dd>
  189. </dl>
  190. <dl class="tparams"><dt>Template Parameters</dt><dd>
  191. <table class="tparams">
  192. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  193. </table>
  194. </dd>
  195. </dl>
  196. <dl class="section see"><dt>See Also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/log.xml">GLSL log man page</a> </dd>
  197. <dd>
  198. <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.2 Exponential Functions</a> </dd></dl>
  199. </div>
  200. </div>
  201. <a class="anchor" id="gace633300a51ca1cbc1a42f565dcd3407"></a>
  202. <div class="memitem">
  203. <div class="memproto">
  204. <table class="memname">
  205. <tr>
  206. <td class="memname">GLM_FUNC_DECL genType glm::log2 </td>
  207. <td>(</td>
  208. <td class="paramtype">genType const &amp;&#160;</td>
  209. <td class="paramname"><em>x</em></td><td>)</td>
  210. <td></td>
  211. </tr>
  212. </table>
  213. </div><div class="memdoc">
  214. <p>Returns the base 2 log of x, i.e., returns the value y, which satisfies the equation x = 2 ^ y. </p>
  215. <dl class="params"><dt>Parameters</dt><dd>
  216. <table class="params">
  217. <tr><td class="paramname">x</td><td>log2 function is defined for input values of x defined in the range (0, inf+) in the limit of the type precision. </td></tr>
  218. </table>
  219. </dd>
  220. </dl>
  221. <dl class="tparams"><dt>Template Parameters</dt><dd>
  222. <table class="tparams">
  223. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  224. </table>
  225. </dd>
  226. </dl>
  227. <dl class="section see"><dt>See Also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/log2.xml">GLSL log2 man page</a> </dd>
  228. <dd>
  229. <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.2 Exponential Functions</a> </dd></dl>
  230. </div>
  231. </div>
  232. <a class="anchor" id="ga1ce4b2fddd26d0d3a35a8d98f37f3ac0"></a>
  233. <div class="memitem">
  234. <div class="memproto">
  235. <table class="memname">
  236. <tr>
  237. <td class="memname">GLM_FUNC_DECL genType glm::pow </td>
  238. <td>(</td>
  239. <td class="paramtype">genType const &amp;&#160;</td>
  240. <td class="paramname"><em>base</em>, </td>
  241. </tr>
  242. <tr>
  243. <td class="paramkey"></td>
  244. <td></td>
  245. <td class="paramtype">genType const &amp;&#160;</td>
  246. <td class="paramname"><em>exponent</em>&#160;</td>
  247. </tr>
  248. <tr>
  249. <td></td>
  250. <td>)</td>
  251. <td></td><td></td>
  252. </tr>
  253. </table>
  254. </div><div class="memdoc">
  255. <p>Returns 'base' raised to the power 'exponent'. </p>
  256. <dl class="params"><dt>Parameters</dt><dd>
  257. <table class="params">
  258. <tr><td class="paramname">base</td><td>Floating point value. pow function is defined for input values of x defined in the range (inf-, inf+) in the limit of the type precision. </td></tr>
  259. <tr><td class="paramname">exponent</td><td>Floating point value representing the 'exponent'. </td></tr>
  260. </table>
  261. </dd>
  262. </dl>
  263. <dl class="tparams"><dt>Template Parameters</dt><dd>
  264. <table class="tparams">
  265. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  266. </table>
  267. </dd>
  268. </dl>
  269. <dl class="section see"><dt>See Also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/pow.xml">GLSL pow man page</a> </dd>
  270. <dd>
  271. <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.2 Exponential Functions</a> </dd></dl>
  272. </div>
  273. </div>
  274. <a class="anchor" id="ga2317d4ff45af448b8402431afa0711f3"></a>
  275. <div class="memitem">
  276. <div class="memproto">
  277. <table class="memname">
  278. <tr>
  279. <td class="memname">GLM_FUNC_DECL genType glm::sqrt </td>
  280. <td>(</td>
  281. <td class="paramtype">genType const &amp;&#160;</td>
  282. <td class="paramname"><em>x</em></td><td>)</td>
  283. <td></td>
  284. </tr>
  285. </table>
  286. </div><div class="memdoc">
  287. <p>Returns the positive square root of x. </p>
  288. <dl class="params"><dt>Parameters</dt><dd>
  289. <table class="params">
  290. <tr><td class="paramname">x</td><td>sqrt function is defined for input values of x defined in the range [0, inf+) in the limit of the type precision. </td></tr>
  291. </table>
  292. </dd>
  293. </dl>
  294. <dl class="tparams"><dt>Template Parameters</dt><dd>
  295. <table class="tparams">
  296. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
  297. </table>
  298. </dd>
  299. </dl>
  300. <dl class="section see"><dt>See Also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/sqrt.xml">GLSL sqrt man page</a> </dd>
  301. <dd>
  302. <a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.2 Exponential Functions</a> </dd></dl>
  303. </div>
  304. </div>
  305. </div><!-- contents -->
  306. <!-- start footer part -->
  307. <hr class="footer"/><address class="footer"><small>
  308. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  309. <img class="footer" src="doxygen.png" alt="doxygen"/>
  310. </a> 1.8.5
  311. </small></address>
  312. </body>
  313. </html>