a00194.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294
  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.10"/>
  7. <title>0.9.8 API documenation: 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 id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  20. <td id="projectalign" style="padding-left: 0.5em;">
  21. <div id="projectname">0.9.8 API documenation
  22. </div>
  23. </td>
  24. </tr>
  25. </tbody>
  26. </table>
  27. </div>
  28. <!-- end header part -->
  29. <!-- Generated by Doxygen 1.8.10 -->
  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">GLM_GTX_fast_square_root<div class="ingroups"><a class="el" href="a00154.html">GTX Extensions (Experimental)</a></div></div> </div>
  43. </div><!--header-->
  44. <div class="contents">
  45. <p>Fast but less accurate implementations of square root based functions.
  46. <a href="#details">More...</a></p>
  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:gaac333418d0c4e0cc6d3d219ed606c238"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  51. <tr class="memitem:gaac333418d0c4e0cc6d3d219ed606c238"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00194.html#gaac333418d0c4e0cc6d3d219ed606c238">fastDistance</a> (genType x, genType y)</td></tr>
  52. <tr class="memdesc:gaac333418d0c4e0cc6d3d219ed606c238"><td class="mdescLeft">&#160;</td><td class="mdescRight">Faster than the common distance function but less accurate. <a href="a00194.html#gaac333418d0c4e0cc6d3d219ed606c238">More...</a><br /></td></tr>
  53. <tr class="separator:gaac333418d0c4e0cc6d3d219ed606c238"><td class="memSeparator" colspan="2">&#160;</td></tr>
  54. <tr class="memitem:ga6d1ac559cd77d69119e30c3aca0e14b5"><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:ga6d1ac559cd77d69119e30c3aca0e14b5"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00194.html#ga6d1ac559cd77d69119e30c3aca0e14b5">fastDistance</a> (vecType&lt; T, P &gt; const &amp;x, vecType&lt; T, P &gt; const &amp;y)</td></tr>
  56. <tr class="memdesc:ga6d1ac559cd77d69119e30c3aca0e14b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Faster than the common distance function but less accurate. <a href="a00194.html#ga6d1ac559cd77d69119e30c3aca0e14b5">More...</a><br /></td></tr>
  57. <tr class="separator:ga6d1ac559cd77d69119e30c3aca0e14b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  58. <tr class="memitem:ga7f081b14d9c7035c8714eba5f7f75a8f"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  59. <tr class="memitem:ga7f081b14d9c7035c8714eba5f7f75a8f"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00194.html#ga7f081b14d9c7035c8714eba5f7f75a8f">fastInverseSqrt</a> (genType x)</td></tr>
  60. <tr class="memdesc:ga7f081b14d9c7035c8714eba5f7f75a8f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Faster than the common inversesqrt function but less accurate. <a href="a00194.html#ga7f081b14d9c7035c8714eba5f7f75a8f">More...</a><br /></td></tr>
  61. <tr class="separator:ga7f081b14d9c7035c8714eba5f7f75a8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  62. <tr class="memitem:ga903878071f92e51e551791e584a171a1"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
  63. <tr class="memitem:ga903878071f92e51e551791e584a171a1"><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="a00194.html#ga903878071f92e51e551791e584a171a1">fastInverseSqrt</a> (vecType&lt; T, P &gt; const &amp;x)</td></tr>
  64. <tr class="memdesc:ga903878071f92e51e551791e584a171a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Faster than the common inversesqrt function but less accurate. <a href="a00194.html#ga903878071f92e51e551791e584a171a1">More...</a><br /></td></tr>
  65. <tr class="separator:ga903878071f92e51e551791e584a171a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66. <tr class="memitem:gafe697d6287719538346bbdf8b1367c59"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  67. <tr class="memitem:gafe697d6287719538346bbdf8b1367c59"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00194.html#gafe697d6287719538346bbdf8b1367c59">fastLength</a> (genType x)</td></tr>
  68. <tr class="memdesc:gafe697d6287719538346bbdf8b1367c59"><td class="mdescLeft">&#160;</td><td class="mdescRight">Faster than the common length function but less accurate. <a href="a00194.html#gafe697d6287719538346bbdf8b1367c59">More...</a><br /></td></tr>
  69. <tr class="separator:gafe697d6287719538346bbdf8b1367c59"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70. <tr class="memitem:gae28a3099cbd6404a4ea8ef22147ed7b0"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
  71. <tr class="memitem:gae28a3099cbd6404a4ea8ef22147ed7b0"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00194.html#gae28a3099cbd6404a4ea8ef22147ed7b0">fastLength</a> (vecType&lt; T, P &gt; const &amp;x)</td></tr>
  72. <tr class="memdesc:gae28a3099cbd6404a4ea8ef22147ed7b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Faster than the common length function but less accurate. <a href="a00194.html#gae28a3099cbd6404a4ea8ef22147ed7b0">More...</a><br /></td></tr>
  73. <tr class="separator:gae28a3099cbd6404a4ea8ef22147ed7b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. <tr class="memitem:ga3b02c1d6e0c754144e2f1e110bf9f16c"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  75. <tr class="memitem:ga3b02c1d6e0c754144e2f1e110bf9f16c"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00194.html#ga3b02c1d6e0c754144e2f1e110bf9f16c">fastNormalize</a> (genType const &amp;x)</td></tr>
  76. <tr class="memdesc:ga3b02c1d6e0c754144e2f1e110bf9f16c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Faster than the common normalize function but less accurate. <a href="a00194.html#ga3b02c1d6e0c754144e2f1e110bf9f16c">More...</a><br /></td></tr>
  77. <tr class="separator:ga3b02c1d6e0c754144e2f1e110bf9f16c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:ga6c460e9414a50b2fc455c8f64c86cdc9"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  79. <tr class="memitem:ga6c460e9414a50b2fc455c8f64c86cdc9"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00194.html#ga6c460e9414a50b2fc455c8f64c86cdc9">fastSqrt</a> (genType x)</td></tr>
  80. <tr class="memdesc:ga6c460e9414a50b2fc455c8f64c86cdc9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Faster than the common sqrt function but less accurate. <a href="a00194.html#ga6c460e9414a50b2fc455c8f64c86cdc9">More...</a><br /></td></tr>
  81. <tr class="separator:ga6c460e9414a50b2fc455c8f64c86cdc9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:gaad9f601bbc3faa04dda384e4c4e1592c"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecType&gt; </td></tr>
  83. <tr class="memitem:gaad9f601bbc3faa04dda384e4c4e1592c"><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="a00194.html#gaad9f601bbc3faa04dda384e4c4e1592c">fastSqrt</a> (vecType&lt; T, P &gt; const &amp;x)</td></tr>
  84. <tr class="memdesc:gaad9f601bbc3faa04dda384e4c4e1592c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Faster than the common sqrt function but less accurate. <a href="a00194.html#gaad9f601bbc3faa04dda384e4c4e1592c">More...</a><br /></td></tr>
  85. <tr class="separator:gaad9f601bbc3faa04dda384e4c4e1592c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. </table>
  87. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  88. <p>Fast but less accurate implementations of square root based functions. </p>
  89. <ul>
  90. <li>Sqrt optimisation based on Newton's method, www.gamedev.net/community/forums/topic.asp?topic id=139956</li>
  91. </ul>
  92. <p>&lt;<a class="el" href="a00028.html" title="GLM_GTX_fast_square_root ">glm/gtx/fast_square_root.hpp</a>&gt; need to be included to use these functionalities. </p>
  93. <h2 class="groupheader">Function Documentation</h2>
  94. <a class="anchor" id="gaac333418d0c4e0cc6d3d219ed606c238"></a>
  95. <div class="memitem">
  96. <div class="memproto">
  97. <table class="memname">
  98. <tr>
  99. <td class="memname">GLM_FUNC_DECL genType glm::fastDistance </td>
  100. <td>(</td>
  101. <td class="paramtype">genType&#160;</td>
  102. <td class="paramname"><em>x</em>, </td>
  103. </tr>
  104. <tr>
  105. <td class="paramkey"></td>
  106. <td></td>
  107. <td class="paramtype">genType&#160;</td>
  108. <td class="paramname"><em>y</em>&#160;</td>
  109. </tr>
  110. <tr>
  111. <td></td>
  112. <td>)</td>
  113. <td></td><td></td>
  114. </tr>
  115. </table>
  116. </div><div class="memdoc">
  117. <p>Faster than the common distance function but less accurate. </p>
  118. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00194.html" title="Fast but less accurate implementations of square root based functions. ">GLM_GTX_fast_square_root</a> extension. </dd></dl>
  119. </div>
  120. </div>
  121. <a class="anchor" id="ga6d1ac559cd77d69119e30c3aca0e14b5"></a>
  122. <div class="memitem">
  123. <div class="memproto">
  124. <table class="memname">
  125. <tr>
  126. <td class="memname">GLM_FUNC_DECL T glm::fastDistance </td>
  127. <td>(</td>
  128. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  129. <td class="paramname"><em>x</em>, </td>
  130. </tr>
  131. <tr>
  132. <td class="paramkey"></td>
  133. <td></td>
  134. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  135. <td class="paramname"><em>y</em>&#160;</td>
  136. </tr>
  137. <tr>
  138. <td></td>
  139. <td>)</td>
  140. <td></td><td></td>
  141. </tr>
  142. </table>
  143. </div><div class="memdoc">
  144. <p>Faster than the common distance function but less accurate. </p>
  145. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00194.html" title="Fast but less accurate implementations of square root based functions. ">GLM_GTX_fast_square_root</a> extension. </dd></dl>
  146. </div>
  147. </div>
  148. <a class="anchor" id="ga7f081b14d9c7035c8714eba5f7f75a8f"></a>
  149. <div class="memitem">
  150. <div class="memproto">
  151. <table class="memname">
  152. <tr>
  153. <td class="memname">GLM_FUNC_DECL genType glm::fastInverseSqrt </td>
  154. <td>(</td>
  155. <td class="paramtype">genType&#160;</td>
  156. <td class="paramname"><em>x</em></td><td>)</td>
  157. <td></td>
  158. </tr>
  159. </table>
  160. </div><div class="memdoc">
  161. <p>Faster than the common inversesqrt function but less accurate. </p>
  162. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00194.html" title="Fast but less accurate implementations of square root based functions. ">GLM_GTX_fast_square_root</a> extension. </dd></dl>
  163. </div>
  164. </div>
  165. <a class="anchor" id="ga903878071f92e51e551791e584a171a1"></a>
  166. <div class="memitem">
  167. <div class="memproto">
  168. <table class="memname">
  169. <tr>
  170. <td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::fastInverseSqrt </td>
  171. <td>(</td>
  172. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  173. <td class="paramname"><em>x</em></td><td>)</td>
  174. <td></td>
  175. </tr>
  176. </table>
  177. </div><div class="memdoc">
  178. <p>Faster than the common inversesqrt function but less accurate. </p>
  179. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00194.html" title="Fast but less accurate implementations of square root based functions. ">GLM_GTX_fast_square_root</a> extension. </dd></dl>
  180. </div>
  181. </div>
  182. <a class="anchor" id="gafe697d6287719538346bbdf8b1367c59"></a>
  183. <div class="memitem">
  184. <div class="memproto">
  185. <table class="memname">
  186. <tr>
  187. <td class="memname">GLM_FUNC_DECL genType glm::fastLength </td>
  188. <td>(</td>
  189. <td class="paramtype">genType&#160;</td>
  190. <td class="paramname"><em>x</em></td><td>)</td>
  191. <td></td>
  192. </tr>
  193. </table>
  194. </div><div class="memdoc">
  195. <p>Faster than the common length function but less accurate. </p>
  196. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00194.html" title="Fast but less accurate implementations of square root based functions. ">GLM_GTX_fast_square_root</a> extension. </dd></dl>
  197. </div>
  198. </div>
  199. <a class="anchor" id="gae28a3099cbd6404a4ea8ef22147ed7b0"></a>
  200. <div class="memitem">
  201. <div class="memproto">
  202. <table class="memname">
  203. <tr>
  204. <td class="memname">GLM_FUNC_DECL T glm::fastLength </td>
  205. <td>(</td>
  206. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  207. <td class="paramname"><em>x</em></td><td>)</td>
  208. <td></td>
  209. </tr>
  210. </table>
  211. </div><div class="memdoc">
  212. <p>Faster than the common length function but less accurate. </p>
  213. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00194.html" title="Fast but less accurate implementations of square root based functions. ">GLM_GTX_fast_square_root</a> extension. </dd></dl>
  214. </div>
  215. </div>
  216. <a class="anchor" id="ga3b02c1d6e0c754144e2f1e110bf9f16c"></a>
  217. <div class="memitem">
  218. <div class="memproto">
  219. <table class="memname">
  220. <tr>
  221. <td class="memname">GLM_FUNC_DECL genType glm::fastNormalize </td>
  222. <td>(</td>
  223. <td class="paramtype">genType const &amp;&#160;</td>
  224. <td class="paramname"><em>x</em></td><td>)</td>
  225. <td></td>
  226. </tr>
  227. </table>
  228. </div><div class="memdoc">
  229. <p>Faster than the common normalize function but less accurate. </p>
  230. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00194.html" title="Fast but less accurate implementations of square root based functions. ">GLM_GTX_fast_square_root</a> extension. </dd></dl>
  231. </div>
  232. </div>
  233. <a class="anchor" id="ga6c460e9414a50b2fc455c8f64c86cdc9"></a>
  234. <div class="memitem">
  235. <div class="memproto">
  236. <table class="memname">
  237. <tr>
  238. <td class="memname">GLM_FUNC_DECL genType glm::fastSqrt </td>
  239. <td>(</td>
  240. <td class="paramtype">genType&#160;</td>
  241. <td class="paramname"><em>x</em></td><td>)</td>
  242. <td></td>
  243. </tr>
  244. </table>
  245. </div><div class="memdoc">
  246. <p>Faster than the common sqrt function but less accurate. </p>
  247. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00194.html" title="Fast but less accurate implementations of square root based functions. ">GLM_GTX_fast_square_root</a> extension. </dd></dl>
  248. </div>
  249. </div>
  250. <a class="anchor" id="gaad9f601bbc3faa04dda384e4c4e1592c"></a>
  251. <div class="memitem">
  252. <div class="memproto">
  253. <table class="memname">
  254. <tr>
  255. <td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::fastSqrt </td>
  256. <td>(</td>
  257. <td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
  258. <td class="paramname"><em>x</em></td><td>)</td>
  259. <td></td>
  260. </tr>
  261. </table>
  262. </div><div class="memdoc">
  263. <p>Faster than the common sqrt function but less accurate. </p>
  264. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00194.html" title="Fast but less accurate implementations of square root based functions. ">GLM_GTX_fast_square_root</a> extension. </dd></dl>
  265. </div>
  266. </div>
  267. </div><!-- contents -->
  268. <!-- start footer part -->
  269. <hr class="footer"/><address class="footer"><small>
  270. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  271. <img class="footer" src="doxygen.png" alt="doxygen"/>
  272. </a> 1.8.10
  273. </small></address>
  274. </body>
  275. </html>