Home Explore Help
Sign In
cpp
/
glm
mirror of https://github.com/g-truc/glm.git
2
0
Fork 0
Files Issues 0 Wiki
Branch: 0.9.4
Branches Tags
glm
/
doc
/
api
/
a00130.html

a00130.html 15 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
    6. 

  6. <title>Exponential functions</title>
    7. 

  7. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    8. 

  8. <script type="text/javascript" src="jquery.js"></script>
    9. 

  9. <script type="text/javascript" src="dynsections.js"></script>
    10. 

  10. <link href="doxygen.css" rel="stylesheet" type="text/css" />
    11. 

  11. </head>
    12. 

  12. <body>
    13. 

  13. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    14. 

  14. <div id="titlearea">
    15. 

  15. <table cellspacing="0" cellpadding="0">
    16. 

  16.  <tbody>
    17. 

  17.  <tr style="height: 56px;">
    18. 

  18.   <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
    19. 

  19.  </tr>
    20. 

  20.  </tbody>
    21. 

  21. </table>
    22. 

  22. </div>
    23. 

  23. <!-- end header part -->
    24. 

  24. <!-- Generated by Doxygen 1.8.2 -->
    25. 

  25.   <div id="navrow1" class="tabs">
    26. 

  26.     <ul class="tablist">
    27. 

  27.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
    28. 

  28.       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
    29. 

  29.       <li><a href="modules.html"><span>Modules</span></a></li>
    30. 

  30.       <li><a href="files.html"><span>Files</span></a></li>
    31. 

  31.     </ul>
    32. 

  32.   </div>
    33. 

  33. </div><!-- top -->
    34. 

  34. <div class="header">
    35. 

  35.   <div class="summary">
    36. 

  36. <a href="#func-members">Functions</a>  </div>
    37. 

  37.   <div class="headertitle">
    38. 

  38. <div class="title">Exponential functions</div>  </div>
    39. 

  39. <div class="ingroups"><a class="el" href="a00141.html">GLM Core</a></div></div><!--header-->
    40. 

  40. <div class="contents">
    41. 

  41. <table class="memberdecls">
    42. 

  42. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
    43. 

  43. Functions</h2></td></tr>
    44. 

  44. <tr class="memitem:ga03903bb9395a13d554a5fbecdf67792b"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
    45. 

  45. <tr class="memitem:ga03903bb9395a13d554a5fbecdf67792b"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00130.html#ga03903bb9395a13d554a5fbecdf67792b">exp</a> (genType const &amp;x)</td></tr>
    46. 

  46. <tr class="separator:ga03903bb9395a13d554a5fbecdf67792b"><td class="memSeparator" colspan="2">&#160;</td></tr>
    47. 

  47. <tr class="memitem:ga18385688b951da01cdc3a22c232e4e28"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
    48. 

  48. <tr class="memitem:ga18385688b951da01cdc3a22c232e4e28"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00130.html#ga18385688b951da01cdc3a22c232e4e28">exp2</a> (genType const &amp;x)</td></tr>
    49. 

  49. <tr class="separator:ga18385688b951da01cdc3a22c232e4e28"><td class="memSeparator" colspan="2">&#160;</td></tr>
    50. 

  50. <tr class="memitem:ga3fd19e045e3943b96e0cdad22fbda111"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
    51. 

  51. <tr class="memitem:ga3fd19e045e3943b96e0cdad22fbda111"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00130.html#ga3fd19e045e3943b96e0cdad22fbda111">inversesqrt</a> (genType const &amp;x)</td></tr>
    52. 

  52. <tr class="separator:ga3fd19e045e3943b96e0cdad22fbda111"><td class="memSeparator" colspan="2">&#160;</td></tr>
    53. 

  53. <tr class="memitem:ga46a307f466090551e328eec42abf61bc"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
    54. 

  54. <tr class="memitem:ga46a307f466090551e328eec42abf61bc"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00130.html#ga46a307f466090551e328eec42abf61bc">log</a> (genType const &amp;x)</td></tr>
    55. 

  55. <tr class="separator:ga46a307f466090551e328eec42abf61bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
    56. 

  56. <tr class="memitem:gae19ff18661b33a0fe1b8edee61382f40"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
    57. 

  57. <tr class="memitem:gae19ff18661b33a0fe1b8edee61382f40"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00130.html#gae19ff18661b33a0fe1b8edee61382f40">log2</a> (genType const &amp;x)</td></tr>
    58. 

  58. <tr class="separator:gae19ff18661b33a0fe1b8edee61382f40"><td class="memSeparator" colspan="2">&#160;</td></tr>
    59. 

  59. <tr class="memitem:gac93ea301c287d87a63fa14a4c44b719b"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
    60. 

  60. <tr class="memitem:gac93ea301c287d87a63fa14a4c44b719b"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00130.html#gac93ea301c287d87a63fa14a4c44b719b">pow</a> (genType const &amp;x, genType const &amp;y)</td></tr>
    61. 

  61. <tr class="separator:gac93ea301c287d87a63fa14a4c44b719b"><td class="memSeparator" colspan="2">&#160;</td></tr>
    62. 

  62. <tr class="memitem:ga9b2fd4f39c29e3d55c4b4087ab873f9f"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
    63. 

  63. <tr class="memitem:ga9b2fd4f39c29e3d55c4b4087ab873f9f"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00130.html#ga9b2fd4f39c29e3d55c4b4087ab873f9f">sqrt</a> (genType const &amp;x)</td></tr>
    64. 

  64. <tr class="separator:ga9b2fd4f39c29e3d55c4b4087ab873f9f"><td class="memSeparator" colspan="2">&#160;</td></tr>
    65. 

  65. </table>
    66. 

  66. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
    67. 

  67. <p>These all operate component-wise. </p>
    68. 

  68. <p>The description is per component. </p>
    69. 

  69. <h2 class="groupheader">Function Documentation</h2>
    70. 

  70. <a class="anchor" id="ga03903bb9395a13d554a5fbecdf67792b"></a>
    71. 

  71. <div class="memitem">
    72. 

  72. <div class="memproto">
    73. 

  73.       <table class="memname">
    74. 

  74.         <tr>
    75. 

  75.           <td class="memname">genType glm::exp </td>
    76. 

  76.           <td>(</td>
    77. 

  77.           <td class="paramtype">genType const &amp;&#160;</td>
    78. 

  78.           <td class="paramname"><em>x</em></td><td>)</td>
    79. 

  79.           <td></td>
    80. 

  80.         </tr>
    81. 

  81.       </table>
    82. 

  82. </div><div class="memdoc">
    83. 

  83. 

  84. <p>Returns the natural exponentiation of x, i.e., e^x. </p>
    85. 

  85. <dl class="params"><dt>Parameters</dt><dd>
    86. 

  86.   <table class="params">
    87. 

  87.     <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>
    88. 

  88.   </table>
    89. 

  89.   </dd>
    90. 

  90. </dl>
    91. 

  91. <dl class="tparams"><dt>Template Parameters</dt><dd>
    92. 

  92.   <table class="tparams">
    93. 

  93.     <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
    94. 

  94.   </table>
    95. 

  95.   </dd>
    96. 

  96. </dl>
    97. 

  97. <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>
    98. 

  98. <dd>
    99. 

  99. <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>
    100. 

  100. 

  101. </div>
    102. 

  102. </div>
    103. 

  103. <a class="anchor" id="ga18385688b951da01cdc3a22c232e4e28"></a>
    104. 

  104. <div class="memitem">
    105. 

  105. <div class="memproto">
    106. 

  106.       <table class="memname">
    107. 

  107.         <tr>
    108. 

  108.           <td class="memname">genType glm::exp2 </td>
    109. 

  109.           <td>(</td>
    110. 

  110.           <td class="paramtype">genType const &amp;&#160;</td>
    111. 

  111.           <td class="paramname"><em>x</em></td><td>)</td>
    112. 

  112.           <td></td>
    113. 

  113.         </tr>
    114. 

  114.       </table>
    115. 

  115. </div><div class="memdoc">
    116. 

  116. 

  117. <p>Returns 2 raised to the x power. </p>
    118. 

  118. <dl class="params"><dt>Parameters</dt><dd>
    119. 

  119.   <table class="params">
    120. 

  120.     <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>
    121. 

  121.   </table>
    122. 

  122.   </dd>
    123. 

  123. </dl>
    124. 

  124. <dl class="tparams"><dt>Template Parameters</dt><dd>
    125. 

  125.   <table class="tparams">
    126. 

  126.     <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
    127. 

  127.   </table>
    128. 

  128.   </dd>
    129. 

  129. </dl>
    130. 

  130. <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>
    131. 

  131. <dd>
    132. 

  132. <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>
    133. 

  133. 

  134. </div>
    135. 

  135. </div>
    136. 

  136. <a class="anchor" id="ga3fd19e045e3943b96e0cdad22fbda111"></a>
    137. 

  137. <div class="memitem">
    138. 

  138. <div class="memproto">
    139. 

  139.       <table class="memname">
    140. 

  140.         <tr>
    141. 

  141.           <td class="memname">genType glm::inversesqrt </td>
    142. 

  142.           <td>(</td>
    143. 

  143.           <td class="paramtype">genType const &amp;&#160;</td>
    144. 

  144.           <td class="paramname"><em>x</em></td><td>)</td>
    145. 

  145.           <td></td>
    146. 

  146.         </tr>
    147. 

  147.       </table>
    148. 

  148. </div><div class="memdoc">
    149. 

  149. 

  150. <p>Returns the reciprocal of the positive square root of x. </p>
    151. 

  151. <dl class="params"><dt>Parameters</dt><dd>
    152. 

  152.   <table class="params">
    153. 

  153.     <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>
    154. 

  154.   </table>
    155. 

  155.   </dd>
    156. 

  156. </dl>
    157. 

  157. <dl class="tparams"><dt>Template Parameters</dt><dd>
    158. 

  158.   <table class="tparams">
    159. 

  159.     <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
    160. 

  160.   </table>
    161. 

  161.   </dd>
    162. 

  162. </dl>
    163. 

  163. <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>
    164. 

  164. <dd>
    165. 

  165. <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>
    166. 

  166. 

  167. </div>
    168. 

  168. </div>
    169. 

  169. <a class="anchor" id="ga46a307f466090551e328eec42abf61bc"></a>
    170. 

  170. <div class="memitem">
    171. 

  171. <div class="memproto">
    172. 

  172.       <table class="memname">
    173. 

  173.         <tr>
    174. 

  174.           <td class="memname">genType glm::log </td>
    175. 

  175.           <td>(</td>
    176. 

  176.           <td class="paramtype">genType const &amp;&#160;</td>
    177. 

  177.           <td class="paramname"><em>x</em></td><td>)</td>
    178. 

  178.           <td></td>
    179. 

  179.         </tr>
    180. 

  180.       </table>
    181. 

  181. </div><div class="memdoc">
    182. 

  182. 

  183. <p>Returns the natural logarithm of x, i.e., returns the value y which satisfies the equation x = e^y. </p>
    184. 

  184. <p>Results are undefined if x &lt;= 0.</p>
    185. 

  185. <dl class="params"><dt>Parameters</dt><dd>
    186. 

  186.   <table class="params">
    187. 

  187.     <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>
    188. 

  188.   </table>
    189. 

  189.   </dd>
    190. 

  190. </dl>
    191. 

  191. <dl class="tparams"><dt>Template Parameters</dt><dd>
    192. 

  192.   <table class="tparams">
    193. 

  193.     <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
    194. 

  194.   </table>
    195. 

  195.   </dd>
    196. 

  196. </dl>
    197. 

  197. <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>
    198. 

  198. <dd>
    199. 

  199. <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>
    200. 

  200. 

  201. </div>
    202. 

  202. </div>
    203. 

  203. <a class="anchor" id="gae19ff18661b33a0fe1b8edee61382f40"></a>
    204. 

  204. <div class="memitem">
    205. 

  205. <div class="memproto">
    206. 

  206.       <table class="memname">
    207. 

  207.         <tr>
    208. 

  208.           <td class="memname">genType glm::log2 </td>
    209. 

  209.           <td>(</td>
    210. 

  210.           <td class="paramtype">genType const &amp;&#160;</td>
    211. 

  211.           <td class="paramname"><em>x</em></td><td>)</td>
    212. 

  212.           <td></td>
    213. 

  213.         </tr>
    214. 

  214.       </table>
    215. 

  215. </div><div class="memdoc">
    216. 

  216. 

  217. <p>Returns the base 2 log of x, i.e., returns the value y, which satisfies the equation x = 2 ^ y. </p>
    218. 

  218. <dl class="params"><dt>Parameters</dt><dd>
    219. 

  219.   <table class="params">
    220. 

  220.     <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>
    221. 

  221.   </table>
    222. 

  222.   </dd>
    223. 

  223. </dl>
    224. 

  224. <dl class="tparams"><dt>Template Parameters</dt><dd>
    225. 

  225.   <table class="tparams">
    226. 

  226.     <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
    227. 

  227.   </table>
    228. 

  228.   </dd>
    229. 

  229. </dl>
    230. 

  230. <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>
    231. 

  231. <dd>
    232. 

  232. <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>
    233. 

  233. 

  234. </div>
    235. 

  235. </div>
    236. 

  236. <a class="anchor" id="gac93ea301c287d87a63fa14a4c44b719b"></a>
    237. 

  237. <div class="memitem">
    238. 

  238. <div class="memproto">
    239. 

  239.       <table class="memname">
    240. 

  240.         <tr>
    241. 

  241.           <td class="memname">genType glm::pow </td>
    242. 

  242.           <td>(</td>
    243. 

  243.           <td class="paramtype">genType const &amp;&#160;</td>
    244. 

  244.           <td class="paramname"><em>x</em>, </td>
    245. 

  245.         </tr>
    246. 

  246.         <tr>
    247. 

  247.           <td class="paramkey"></td>
    248. 

  248.           <td></td>
    249. 

  249.           <td class="paramtype">genType const &amp;&#160;</td>
    250. 

  250.           <td class="paramname"><em>y</em>&#160;</td>
    251. 

  251.         </tr>
    252. 

  252.         <tr>
    253. 

  253.           <td></td>
    254. 

  254.           <td>)</td>
    255. 

  255.           <td></td><td></td>
    256. 

  256.         </tr>
    257. 

  257.       </table>
    258. 

  258. </div><div class="memdoc">
    259. 

  259. 

  260. <p>Returns x raised to the y power. </p>
    261. 

  261. <dl class="params"><dt>Parameters</dt><dd>
    262. 

  262.   <table class="params">
    263. 

  263.     <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>
    264. 

  264.     <tr><td class="paramname">y</td><td></td></tr>
    265. 

  265.   </table>
    266. 

  266.   </dd>
    267. 

  267. </dl>
    268. 

  268. <dl class="tparams"><dt>Template Parameters</dt><dd>
    269. 

  269.   <table class="tparams">
    270. 

  270.     <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
    271. 

  271.   </table>
    272. 

  272.   </dd>
    273. 

  273. </dl>
    274. 

  274. <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>
    275. 

  275. <dd>
    276. 

  276. <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>
    277. 

  277. 

  278. </div>
    279. 

  279. </div>
    280. 

  280. <a class="anchor" id="ga9b2fd4f39c29e3d55c4b4087ab873f9f"></a>
    281. 

  281. <div class="memitem">
    282. 

  282. <div class="memproto">
    283. 

  283.       <table class="memname">
    284. 

  284.         <tr>
    285. 

  285.           <td class="memname">genType glm::sqrt </td>
    286. 

  286.           <td>(</td>
    287. 

  287.           <td class="paramtype">genType const &amp;&#160;</td>
    288. 

  288.           <td class="paramname"><em>x</em></td><td>)</td>
    289. 

  289.           <td></td>
    290. 

  290.         </tr>
    291. 

  291.       </table>
    292. 

  292. </div><div class="memdoc">
    293. 

  293. 

  294. <p>Returns the positive square root of x. </p>
    295. 

  295. <dl class="params"><dt>Parameters</dt><dd>
    296. 

  296.   <table class="params">
    297. 

  297.     <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>
    298. 

  298.   </table>
    299. 

  299.   </dd>
    300. 

  300. </dl>
    301. 

  301. <dl class="tparams"><dt>Template Parameters</dt><dd>
    302. 

  302.   <table class="tparams">
    303. 

  303.     <tr><td class="paramname">genType</td><td>Floating-point scalar or vector types.</td></tr>
    304. 

  304.   </table>
    305. 

  305.   </dd>
    306. 

  306. </dl>
    307. 

  307. <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>
    308. 

  308. <dd>
    309. 

  309. <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>
    310. 

  310. 

  311. </div>
    312. 

  312. </div>
    313. 

  313. </div><!-- contents -->
    314. 

  314. <!-- start footer part -->
    315. 

  315. <hr class="footer"/><address class="footer"><small>
    316. 

  316. Generated by &#160;<a href="http://www.doxygen.org/index.html">
    317. 

  317. <img class="footer" src="doxygen.png" alt="doxygen"/>
    318. 

  318. </a> 1.8.2
    319. 

  319. </small></address>
    320. 

  320. </body>
    321. 

  321. </html>
    322.