a00262.html 7.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174
  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>GLM_GTX_fast_square_root: Fast square root 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. <!-- Generated by Doxygen 1.7.4 -->
  11. <div id="top">
  12. <div id="titlearea">
  13. <table cellspacing="0" cellpadding="0">
  14. <tbody>
  15. <tr style="height: 56px;">
  16. <td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
  17. </tr>
  18. </tbody>
  19. </table>
  20. </div>
  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="modules.html"><span>Modules</span></a></li>
  25. <li><a href="namespaces.html"><span>Namespaces</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">GLM_GTX_fast_square_root: Fast square root functions</div> </div>
  36. <div class="ingroups"><a class="el" href="a00248.html">GTX Extensions (Experimental)</a></div></div>
  37. <div class="contents">
  38. <p>Fast but less accurate implementations of square root based functions.
  39. <a href="#details">More...</a></p>
  40. <table class="memberdecls">
  41. <tr><td colspan="2"><h2><a name="func-members"></a>
  42. Functions</h2></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::value_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00262.html#ga68162c92de0e592216be943345169da7">fastDistance</a> (genType const &amp;x, genType const &amp;y)</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="a00262.html#ga1858a37f06c79e17f287bbaa8f75b08e">fastInverseSqrt</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::value_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00262.html#gada4490e940c0c4e08beab6db793f8934">fastLength</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="a00262.html#ga7e785d24d7bbac63f273baf9af1160da">fastNormalize</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="a00262.html#gaced2a1b7a161290e4d401967607d56db">fastSqrt</a> (genType const &amp;x)</td></tr>
  53. </table>
  54. <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
  55. <p>Fast but less accurate implementations of square root based functions. </p>
  56. <p>&lt;<a class="el" href="a00041_source.html">glm/gtx/fast_square_root.hpp</a>&gt; need to be included to use these functionalities. </p>
  57. <hr/><h2>Function Documentation</h2>
  58. <a class="anchor" id="ga68162c92de0e592216be943345169da7"></a><!-- doxytag: member="glm::gtx::fast_square_root::fastDistance" ref="ga68162c92de0e592216be943345169da7" args="(genType const &amp;x, genType const &amp;y)" -->
  59. <div class="memitem">
  60. <div class="memproto">
  61. <table class="memname">
  62. <tr>
  63. <td class="memname">genType::value_type glm::gtx::fast_square_root::fastDistance </td>
  64. <td>(</td>
  65. <td class="paramtype">genType const &amp;&#160;</td>
  66. <td class="paramname"><em>x</em>, </td>
  67. </tr>
  68. <tr>
  69. <td class="paramkey"></td>
  70. <td></td>
  71. <td class="paramtype">genType const &amp;&#160;</td>
  72. <td class="paramname"><em>y</em>&#160;</td>
  73. </tr>
  74. <tr>
  75. <td></td>
  76. <td>)</td>
  77. <td></td><td></td>
  78. </tr>
  79. </table>
  80. </div>
  81. <div class="memdoc">
  82. <p>Faster than the common distance function but less accurate. </p>
  83. <p>From GLM_GTX_fast_square_root extension. </p>
  84. </div>
  85. </div>
  86. <a class="anchor" id="ga1858a37f06c79e17f287bbaa8f75b08e"></a><!-- doxytag: member="glm::gtx::fast_square_root::fastInverseSqrt" ref="ga1858a37f06c79e17f287bbaa8f75b08e" args="(genType const &amp;x)" -->
  87. <div class="memitem">
  88. <div class="memproto">
  89. <table class="memname">
  90. <tr>
  91. <td class="memname">genType glm::gtx::fast_square_root::fastInverseSqrt </td>
  92. <td>(</td>
  93. <td class="paramtype">genType const &amp;&#160;</td>
  94. <td class="paramname"><em>x</em></td><td>)</td>
  95. <td></td>
  96. </tr>
  97. </table>
  98. </div>
  99. <div class="memdoc">
  100. <p>Faster than the common inversesqrt function but less accurate. </p>
  101. <p>From GLM_GTX_fast_square_root extension. </p>
  102. </div>
  103. </div>
  104. <a class="anchor" id="gada4490e940c0c4e08beab6db793f8934"></a><!-- doxytag: member="glm::gtx::fast_square_root::fastLength" ref="gada4490e940c0c4e08beab6db793f8934" args="(genType const &amp;x)" -->
  105. <div class="memitem">
  106. <div class="memproto">
  107. <table class="memname">
  108. <tr>
  109. <td class="memname">genType::value_type glm::gtx::fast_square_root::fastLength </td>
  110. <td>(</td>
  111. <td class="paramtype">genType const &amp;&#160;</td>
  112. <td class="paramname"><em>x</em></td><td>)</td>
  113. <td></td>
  114. </tr>
  115. </table>
  116. </div>
  117. <div class="memdoc">
  118. <p>Faster than the common length function but less accurate. </p>
  119. <p>From GLM_GTX_fast_square_root extension. </p>
  120. </div>
  121. </div>
  122. <a class="anchor" id="ga7e785d24d7bbac63f273baf9af1160da"></a><!-- doxytag: member="glm::gtx::fast_square_root::fastNormalize" ref="ga7e785d24d7bbac63f273baf9af1160da" args="(genType const &amp;x)" -->
  123. <div class="memitem">
  124. <div class="memproto">
  125. <table class="memname">
  126. <tr>
  127. <td class="memname">genType glm::gtx::fast_square_root::fastNormalize </td>
  128. <td>(</td>
  129. <td class="paramtype">genType const &amp;&#160;</td>
  130. <td class="paramname"><em>x</em></td><td>)</td>
  131. <td></td>
  132. </tr>
  133. </table>
  134. </div>
  135. <div class="memdoc">
  136. <p>Faster than the common normalize function but less accurate. </p>
  137. <p>From GLM_GTX_fast_square_root extension. </p>
  138. </div>
  139. </div>
  140. <a class="anchor" id="gaced2a1b7a161290e4d401967607d56db"></a><!-- doxytag: member="glm::gtx::fast_square_root::fastSqrt" ref="gaced2a1b7a161290e4d401967607d56db" args="(genType const &amp;x)" -->
  141. <div class="memitem">
  142. <div class="memproto">
  143. <table class="memname">
  144. <tr>
  145. <td class="memname">genType glm::gtx::fast_square_root::fastSqrt </td>
  146. <td>(</td>
  147. <td class="paramtype">genType const &amp;&#160;</td>
  148. <td class="paramname"><em>x</em></td><td>)</td>
  149. <td></td>
  150. </tr>
  151. </table>
  152. </div>
  153. <div class="memdoc">
  154. <p>Faster than the common sqrt function but less accurate. </p>
  155. <p>From GLM_GTX_fast_square_root extension. </p>
  156. </div>
  157. </div>
  158. </div>
  159. <hr class="footer"/><address class="footer"><small>Generated by&#160;
  160. <a href="http://www.doxygen.org/index.html">
  161. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
  162. </body>
  163. </html>