a00128.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334
  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>Exponential functions</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">Exponential functions</div> </div>
  36. <div class="ingroups"><a class="el" href="a00139.html">GLM Core</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 genType &gt; </td></tr>
  42. <tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00128.html#ga03903bb9395a13d554a5fbecdf67792b">exp</a> (genType const &amp;x)</td></tr>
  43. <tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  44. <tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00128.html#ga18385688b951da01cdc3a22c232e4e28">exp2</a> (genType const &amp;x)</td></tr>
  45. <tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  46. <tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00128.html#ga3fd19e045e3943b96e0cdad22fbda111">inversesqrt</a> (genType const &amp;x)</td></tr>
  47. <tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  48. <tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00128.html#ga46a307f466090551e328eec42abf61bc">log</a> (genType const &amp;x)</td></tr>
  49. <tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  50. <tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00128.html#gae19ff18661b33a0fe1b8edee61382f40">log2</a> (genType const &amp;x)</td></tr>
  51. <tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  52. <tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00128.html#gac93ea301c287d87a63fa14a4c44b719b">pow</a> (genType const &amp;x, genType const &amp;y)</td></tr>
  53. <tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  54. <tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00128.html#ga9b2fd4f39c29e3d55c4b4087ab873f9f">sqrt</a> (genType const &amp;x)</td></tr>
  55. </table>
  56. <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
  57. <p>These all operate component-wise. </p>
  58. <p>The description is per component. </p>
  59. <hr/><h2>Function Documentation</h2>
  60. <a class="anchor" id="ga03903bb9395a13d554a5fbecdf67792b"></a><!-- doxytag: member="glm::exp" ref="ga03903bb9395a13d554a5fbecdf67792b" args="(genType const &amp;x)" -->
  61. <div class="memitem">
  62. <div class="memproto">
  63. <table class="memname">
  64. <tr>
  65. <td class="memname">genType glm::exp </td>
  66. <td>(</td>
  67. <td class="paramtype">genType const &amp;&#160;</td>
  68. <td class="paramname"><em>x</em></td><td>)</td>
  69. <td></td>
  70. </tr>
  71. </table>
  72. </div>
  73. <div class="memdoc">
  74. <p>Returns the natural exponentiation of x, i.e., e^x. </p>
  75. <dl><dt><b>Parameters:</b></dt><dd>
  76. <table class="params">
  77. <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>
  78. </table>
  79. </dd>
  80. </dl>
  81. <dl><dt><b>Template Parameters:</b></dt><dd>
  82. <table class="">
  83. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types. </td></tr>
  84. </table>
  85. </dd>
  86. </dl>
  87. <dl class="see"><dt><b>See also:</b></dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/exp.xml">GLSL exp man page</a> </dd>
  88. <dd>
  89. <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>
  90. </div>
  91. </div>
  92. <a class="anchor" id="ga18385688b951da01cdc3a22c232e4e28"></a><!-- doxytag: member="glm::exp2" ref="ga18385688b951da01cdc3a22c232e4e28" args="(genType const &amp;x)" -->
  93. <div class="memitem">
  94. <div class="memproto">
  95. <table class="memname">
  96. <tr>
  97. <td class="memname">genType glm::exp2 </td>
  98. <td>(</td>
  99. <td class="paramtype">genType const &amp;&#160;</td>
  100. <td class="paramname"><em>x</em></td><td>)</td>
  101. <td></td>
  102. </tr>
  103. </table>
  104. </div>
  105. <div class="memdoc">
  106. <p>Returns 2 raised to the x power. </p>
  107. <dl><dt><b>Parameters:</b></dt><dd>
  108. <table class="params">
  109. <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>
  110. </table>
  111. </dd>
  112. </dl>
  113. <dl><dt><b>Template Parameters:</b></dt><dd>
  114. <table class="">
  115. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types. </td></tr>
  116. </table>
  117. </dd>
  118. </dl>
  119. <dl class="see"><dt><b>See also:</b></dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/exp2.xml">GLSL exp2 man page</a> </dd>
  120. <dd>
  121. <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>
  122. </div>
  123. </div>
  124. <a class="anchor" id="ga3fd19e045e3943b96e0cdad22fbda111"></a><!-- doxytag: member="glm::inversesqrt" ref="ga3fd19e045e3943b96e0cdad22fbda111" args="(genType const &amp;x)" -->
  125. <div class="memitem">
  126. <div class="memproto">
  127. <table class="memname">
  128. <tr>
  129. <td class="memname">genType glm::inversesqrt </td>
  130. <td>(</td>
  131. <td class="paramtype">genType const &amp;&#160;</td>
  132. <td class="paramname"><em>x</em></td><td>)</td>
  133. <td></td>
  134. </tr>
  135. </table>
  136. </div>
  137. <div class="memdoc">
  138. <p>Returns the reciprocal of the positive square root of x. </p>
  139. <dl><dt><b>Parameters:</b></dt><dd>
  140. <table class="params">
  141. <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>
  142. </table>
  143. </dd>
  144. </dl>
  145. <dl><dt><b>Template Parameters:</b></dt><dd>
  146. <table class="">
  147. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types. </td></tr>
  148. </table>
  149. </dd>
  150. </dl>
  151. <dl class="see"><dt><b>See also:</b></dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/inversesqrt.xml">GLSL inversesqrt man page</a> </dd>
  152. <dd>
  153. <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>
  154. </div>
  155. </div>
  156. <a class="anchor" id="ga46a307f466090551e328eec42abf61bc"></a><!-- doxytag: member="glm::log" ref="ga46a307f466090551e328eec42abf61bc" args="(genType const &amp;x)" -->
  157. <div class="memitem">
  158. <div class="memproto">
  159. <table class="memname">
  160. <tr>
  161. <td class="memname">genType glm::log </td>
  162. <td>(</td>
  163. <td class="paramtype">genType const &amp;&#160;</td>
  164. <td class="paramname"><em>x</em></td><td>)</td>
  165. <td></td>
  166. </tr>
  167. </table>
  168. </div>
  169. <div class="memdoc">
  170. <p>Returns the natural logarithm of x, i.e., returns the value y which satisfies the equation x = e^y. </p>
  171. <p>Results are undefined if x &lt;= 0.</p>
  172. <dl><dt><b>Parameters:</b></dt><dd>
  173. <table class="params">
  174. <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>
  175. </table>
  176. </dd>
  177. </dl>
  178. <dl><dt><b>Template Parameters:</b></dt><dd>
  179. <table class="">
  180. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types. </td></tr>
  181. </table>
  182. </dd>
  183. </dl>
  184. <dl class="see"><dt><b>See also:</b></dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/log.xml">GLSL log man page</a> </dd>
  185. <dd>
  186. <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>
  187. </div>
  188. </div>
  189. <a class="anchor" id="gae19ff18661b33a0fe1b8edee61382f40"></a><!-- doxytag: member="glm::log2" ref="gae19ff18661b33a0fe1b8edee61382f40" args="(genType const &amp;x)" -->
  190. <div class="memitem">
  191. <div class="memproto">
  192. <table class="memname">
  193. <tr>
  194. <td class="memname">genType glm::log2 </td>
  195. <td>(</td>
  196. <td class="paramtype">genType const &amp;&#160;</td>
  197. <td class="paramname"><em>x</em></td><td>)</td>
  198. <td></td>
  199. </tr>
  200. </table>
  201. </div>
  202. <div class="memdoc">
  203. <p>Returns the base 2 log of x, i.e., returns the value y, which satisfies the equation x = 2 ^ y. </p>
  204. <dl><dt><b>Parameters:</b></dt><dd>
  205. <table class="params">
  206. <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>
  207. </table>
  208. </dd>
  209. </dl>
  210. <dl><dt><b>Template Parameters:</b></dt><dd>
  211. <table class="">
  212. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types. </td></tr>
  213. </table>
  214. </dd>
  215. </dl>
  216. <dl class="see"><dt><b>See also:</b></dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/log2.xml">GLSL log2 man page</a> </dd>
  217. <dd>
  218. <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>
  219. </div>
  220. </div>
  221. <a class="anchor" id="gac93ea301c287d87a63fa14a4c44b719b"></a><!-- doxytag: member="glm::pow" ref="gac93ea301c287d87a63fa14a4c44b719b" args="(genType const &amp;x, genType const &amp;y)" -->
  222. <div class="memitem">
  223. <div class="memproto">
  224. <table class="memname">
  225. <tr>
  226. <td class="memname">genType glm::pow </td>
  227. <td>(</td>
  228. <td class="paramtype">genType const &amp;&#160;</td>
  229. <td class="paramname"><em>x</em>, </td>
  230. </tr>
  231. <tr>
  232. <td class="paramkey"></td>
  233. <td></td>
  234. <td class="paramtype">genType const &amp;&#160;</td>
  235. <td class="paramname"><em>y</em>&#160;</td>
  236. </tr>
  237. <tr>
  238. <td></td>
  239. <td>)</td>
  240. <td></td><td></td>
  241. </tr>
  242. </table>
  243. </div>
  244. <div class="memdoc">
  245. <p>Returns x raised to the y power. </p>
  246. <dl><dt><b>Parameters:</b></dt><dd>
  247. <table class="params">
  248. <tr><td class="paramname">x</td><td>pow function is defined for input values of x defined in the range (inf-, inf+) in the limit of the type precision. </td></tr>
  249. <tr><td class="paramname">y</td><td></td></tr>
  250. </table>
  251. </dd>
  252. </dl>
  253. <dl><dt><b>Template Parameters:</b></dt><dd>
  254. <table class="">
  255. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types. </td></tr>
  256. </table>
  257. </dd>
  258. </dl>
  259. <dl class="see"><dt><b>See also:</b></dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/pow.xml">GLSL pow man page</a> </dd>
  260. <dd>
  261. <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>
  262. </div>
  263. </div>
  264. <a class="anchor" id="ga9b2fd4f39c29e3d55c4b4087ab873f9f"></a><!-- doxytag: member="glm::sqrt" ref="ga9b2fd4f39c29e3d55c4b4087ab873f9f" args="(genType const &amp;x)" -->
  265. <div class="memitem">
  266. <div class="memproto">
  267. <table class="memname">
  268. <tr>
  269. <td class="memname">genType glm::sqrt </td>
  270. <td>(</td>
  271. <td class="paramtype">genType const &amp;&#160;</td>
  272. <td class="paramname"><em>x</em></td><td>)</td>
  273. <td></td>
  274. </tr>
  275. </table>
  276. </div>
  277. <div class="memdoc">
  278. <p>Returns the positive square root of x. </p>
  279. <dl><dt><b>Parameters:</b></dt><dd>
  280. <table class="params">
  281. <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>
  282. </table>
  283. </dd>
  284. </dl>
  285. <dl><dt><b>Template Parameters:</b></dt><dd>
  286. <table class="">
  287. <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types. </td></tr>
  288. </table>
  289. </dd>
  290. </dl>
  291. <dl class="see"><dt><b>See also:</b></dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/sqrt.xml">GLSL sqrt man page</a> </dd>
  292. <dd>
  293. <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>
  294. </div>
  295. </div>
  296. </div>
  297. <hr class="footer"/><address class="footer"><small>
  298. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  299. <img class="footer" src="doxygen.png" alt="doxygen"/>
  300. </a> 1.7.5.1
  301. </small></address>
  302. </body>
  303. </html>