a00150.html 16 KB

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