a00197.html 8.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186
  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: GLM_GTX_fast_square_root</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">GLM_GTX_fast_square_root<div class="ingroups"><a class="el" href="a00165.html">GTX Extensions (Experimental)</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:ga646eee2633e9de7274de9bc6f5af92b5"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  51. <tr class="memitem:ga646eee2633e9de7274de9bc6f5af92b5"><td class="memTemplItemLeft" align="right" valign="top">genType::value_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00197.html#ga646eee2633e9de7274de9bc6f5af92b5">fastDistance</a> (genType const &amp;x, genType const &amp;y)</td></tr>
  52. <tr class="separator:ga646eee2633e9de7274de9bc6f5af92b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  53. <tr class="memitem:ga49dd9caa2853398474e5aae377259a22"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  54. <tr class="memitem:ga49dd9caa2853398474e5aae377259a22"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00197.html#ga49dd9caa2853398474e5aae377259a22">fastInverseSqrt</a> (genType const &amp;x)</td></tr>
  55. <tr class="separator:ga49dd9caa2853398474e5aae377259a22"><td class="memSeparator" colspan="2">&#160;</td></tr>
  56. <tr class="memitem:ga2e726cc8b9f02b7c09910858ea1afac6"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  57. <tr class="memitem:ga2e726cc8b9f02b7c09910858ea1afac6"><td class="memTemplItemLeft" align="right" valign="top">genType::value_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00197.html#ga2e726cc8b9f02b7c09910858ea1afac6">fastLength</a> (genType const &amp;x)</td></tr>
  58. <tr class="separator:ga2e726cc8b9f02b7c09910858ea1afac6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  59. <tr class="memitem:ga2953e7426a420bb2b33affce7360ef40"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  60. <tr class="memitem:ga2953e7426a420bb2b33affce7360ef40"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00197.html#ga2953e7426a420bb2b33affce7360ef40">fastNormalize</a> (genType const &amp;x)</td></tr>
  61. <tr class="separator:ga2953e7426a420bb2b33affce7360ef40"><td class="memSeparator" colspan="2">&#160;</td></tr>
  62. <tr class="memitem:gad57c343d2362c1469043adedeb8ef8eb"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  63. <tr class="memitem:gad57c343d2362c1469043adedeb8ef8eb"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00197.html#gad57c343d2362c1469043adedeb8ef8eb">fastSqrt</a> (genType const &amp;x)</td></tr>
  64. <tr class="separator:gad57c343d2362c1469043adedeb8ef8eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65. </table>
  66. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  67. <p>Fast but less accurate implementations of square root based functions. </p>
  68. <ul>
  69. <li>Sqrt optimisation based on Newton's method, www.gamedev.net/community/forums/topic.asp?topic id=139956</li>
  70. </ul>
  71. <p>&lt;<a class="el" href="a00030.html" title="OpenGL Mathematics (glm.g-truc.net) ">glm/gtx/fast_square_root.hpp</a>&gt; need to be included to use these functionalities. </p>
  72. <h2 class="groupheader">Function Documentation</h2>
  73. <a class="anchor" id="ga646eee2633e9de7274de9bc6f5af92b5"></a>
  74. <div class="memitem">
  75. <div class="memproto">
  76. <table class="memname">
  77. <tr>
  78. <td class="memname">genType::value_type glm::fastDistance </td>
  79. <td>(</td>
  80. <td class="paramtype">genType const &amp;&#160;</td>
  81. <td class="paramname"><em>x</em>, </td>
  82. </tr>
  83. <tr>
  84. <td class="paramkey"></td>
  85. <td></td>
  86. <td class="paramtype">genType const &amp;&#160;</td>
  87. <td class="paramname"><em>y</em>&#160;</td>
  88. </tr>
  89. <tr>
  90. <td></td>
  91. <td>)</td>
  92. <td></td><td></td>
  93. </tr>
  94. </table>
  95. </div><div class="memdoc">
  96. <p>Faster than the common distance function but less accurate. </p>
  97. <p>From GLM_GTX_fast_square_root extension. </p>
  98. </div>
  99. </div>
  100. <a class="anchor" id="ga49dd9caa2853398474e5aae377259a22"></a>
  101. <div class="memitem">
  102. <div class="memproto">
  103. <table class="memname">
  104. <tr>
  105. <td class="memname">genType glm::fastInverseSqrt </td>
  106. <td>(</td>
  107. <td class="paramtype">genType const &amp;&#160;</td>
  108. <td class="paramname"><em>x</em></td><td>)</td>
  109. <td></td>
  110. </tr>
  111. </table>
  112. </div><div class="memdoc">
  113. <p>Faster than the common inversesqrt function but less accurate. </p>
  114. <p>From GLM_GTX_fast_square_root extension. </p>
  115. </div>
  116. </div>
  117. <a class="anchor" id="ga2e726cc8b9f02b7c09910858ea1afac6"></a>
  118. <div class="memitem">
  119. <div class="memproto">
  120. <table class="memname">
  121. <tr>
  122. <td class="memname">genType::value_type glm::fastLength </td>
  123. <td>(</td>
  124. <td class="paramtype">genType const &amp;&#160;</td>
  125. <td class="paramname"><em>x</em></td><td>)</td>
  126. <td></td>
  127. </tr>
  128. </table>
  129. </div><div class="memdoc">
  130. <p>Faster than the common length function but less accurate. </p>
  131. <p>From GLM_GTX_fast_square_root extension. </p>
  132. </div>
  133. </div>
  134. <a class="anchor" id="ga2953e7426a420bb2b33affce7360ef40"></a>
  135. <div class="memitem">
  136. <div class="memproto">
  137. <table class="memname">
  138. <tr>
  139. <td class="memname">genType glm::fastNormalize </td>
  140. <td>(</td>
  141. <td class="paramtype">genType const &amp;&#160;</td>
  142. <td class="paramname"><em>x</em></td><td>)</td>
  143. <td></td>
  144. </tr>
  145. </table>
  146. </div><div class="memdoc">
  147. <p>Faster than the common normalize function but less accurate. </p>
  148. <p>From GLM_GTX_fast_square_root extension. </p>
  149. </div>
  150. </div>
  151. <a class="anchor" id="gad57c343d2362c1469043adedeb8ef8eb"></a>
  152. <div class="memitem">
  153. <div class="memproto">
  154. <table class="memname">
  155. <tr>
  156. <td class="memname">genType glm::fastSqrt </td>
  157. <td>(</td>
  158. <td class="paramtype">genType const &amp;&#160;</td>
  159. <td class="paramname"><em>x</em></td><td>)</td>
  160. <td></td>
  161. </tr>
  162. </table>
  163. </div><div class="memdoc">
  164. <p>Faster than the common sqrt function but less accurate. </p>
  165. <p>From GLM_GTX_fast_square_root extension. </p>
  166. </div>
  167. </div>
  168. </div><!-- contents -->
  169. <!-- start footer part -->
  170. <hr class="footer"/><address class="footer"><small>
  171. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  172. <img class="footer" src="doxygen.png" alt="doxygen"/>
  173. </a> 1.8.5
  174. </small></address>
  175. </body>
  176. </html>