a00626_source.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.18"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>1.0.0 API documentation: fast_square_root.hpp Source File</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
  24. <td id="projectalign" style="padding-left: 0.5em;">
  25. <div id="projectname">1.0.0 API documentation
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.18 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */</script>
  48. <div id="main-nav"></div>
  49. <!-- window showing the filter options -->
  50. <div id="MSearchSelectWindow"
  51. onmouseover="return searchBox.OnSearchSelectShow()"
  52. onmouseout="return searchBox.OnSearchSelectHide()"
  53. onkeydown="return searchBox.OnSearchSelectKey(event)">
  54. </div>
  55. <!-- iframe showing the search results (closed by default) -->
  56. <div id="MSearchResultsWindow">
  57. <iframe src="javascript:void(0)" frameborder="0"
  58. name="MSearchResults" id="MSearchResults">
  59. </iframe>
  60. </div>
  61. <div id="nav-path" class="navpath">
  62. <ul>
  63. <li class="navelem"><a class="el" href="dir_885cc87fac2d91e269af0a5a959fa5f6.html">E:</a></li><li class="navelem"><a class="el" href="dir_63ed049134a778d525e06b63afc2c979.html">Github</a></li><li class="navelem"><a class="el" href="dir_c98a9ac98258ab9f831b188d66361a70.html">g-truc</a></li><li class="navelem"><a class="el" href="dir_50f12b6ceb23d7f6adfb377a1ae8b006.html">glm</a></li><li class="navelem"><a class="el" href="dir_fca33f1b5115d46f42c670590789c0d2.html">glm</a></li><li class="navelem"><a class="el" href="dir_628fd60eb37daf5aa9a81e3983c640b7.html">gtx</a></li> </ul>
  64. </div>
  65. </div><!-- top -->
  66. <div class="header">
  67. <div class="headertitle">
  68. <div class="title">fast_square_root.hpp</div> </div>
  69. </div><!--header-->
  70. <div class="contents">
  71. <a href="a00626.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160; </div>
  72. <div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#pragma once</span></div>
  73. <div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; </div>
  74. <div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment">// Dependency:</span></div>
  75. <div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#include &quot;../common.hpp&quot;</span></div>
  76. <div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#include &quot;../exponential.hpp&quot;</span></div>
  77. <div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &quot;../geometric.hpp&quot;</span></div>
  78. <div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; </div>
  79. <div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#ifndef GLM_ENABLE_EXPERIMENTAL</span></div>
  80. <div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor"># error &quot;GLM: GLM_GTX_fast_square_root is an experimental extension and may change in the future. Use #define GLM_ENABLE_EXPERIMENTAL before including it, if you really want to use it.&quot;</span></div>
  81. <div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#elif GLM_MESSAGES == GLM_ENABLE &amp;&amp; !defined(GLM_EXT_INCLUDED)</span></div>
  82. <div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor"># pragma message(&quot;GLM: GLM_GTX_fast_square_root extension included&quot;)</span></div>
  83. <div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#endif</span></div>
  84. <div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; </div>
  85. <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="keyword">namespace </span>glm</div>
  86. <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;{</div>
  87. <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; </div>
  88. <div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> genType&gt;</div>
  89. <div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="a00933.html#ga6c460e9414a50b2fc455c8f64c86cdc9"> 37</a></span>&#160; GLM_FUNC_DECL genType <a class="code" href="a00933.html#gae83f0c03614f73eae5478c5b6274ee6d">fastSqrt</a>(genType x);</div>
  90. <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; </div>
  91. <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keyword">template</span>&lt;length_t L, <span class="keyword">typename</span> T, qualifier Q&gt;</div>
  92. <div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="a00933.html#gae83f0c03614f73eae5478c5b6274ee6d"> 43</a></span>&#160; GLM_FUNC_DECL vec&lt;L, T, Q&gt; <a class="code" href="a00933.html#gae83f0c03614f73eae5478c5b6274ee6d">fastSqrt</a>(vec&lt;L, T, Q&gt; <span class="keyword">const</span>&amp; x);</div>
  93. <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; </div>
  94. <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> genType&gt;</div>
  95. <div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="a00933.html#ga7f081b14d9c7035c8714eba5f7f75a8f"> 49</a></span>&#160; GLM_FUNC_DECL genType <a class="code" href="a00933.html#gadcd7be12b1e5ee182141359d4c45dd24">fastInverseSqrt</a>(genType x);</div>
  96. <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; </div>
  97. <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keyword">template</span>&lt;length_t L, <span class="keyword">typename</span> T, qualifier Q&gt;</div>
  98. <div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="a00933.html#gadcd7be12b1e5ee182141359d4c45dd24"> 55</a></span>&#160; GLM_FUNC_DECL vec&lt;L, T, Q&gt; <a class="code" href="a00933.html#gadcd7be12b1e5ee182141359d4c45dd24">fastInverseSqrt</a>(vec&lt;L, T, Q&gt; <span class="keyword">const</span>&amp; x);</div>
  99. <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; </div>
  100. <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> genType&gt;</div>
  101. <div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="a00933.html#gafe697d6287719538346bbdf8b1367c59"> 61</a></span>&#160; GLM_FUNC_DECL genType <a class="code" href="a00933.html#ga90f66be92ef61e705c005e7b3209edb8">fastLength</a>(genType x);</div>
  102. <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; </div>
  103. <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keyword">template</span>&lt;length_t L, <span class="keyword">typename</span> T, qualifier Q&gt;</div>
  104. <div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="a00933.html#ga90f66be92ef61e705c005e7b3209edb8"> 67</a></span>&#160; GLM_FUNC_DECL T <a class="code" href="a00933.html#ga90f66be92ef61e705c005e7b3209edb8">fastLength</a>(vec&lt;L, T, Q&gt; <span class="keyword">const</span>&amp; x);</div>
  105. <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; </div>
  106. <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> genType&gt;</div>
  107. <div class="line"><a name="l00073"></a><span class="lineno"><a class="line" href="a00933.html#gaac333418d0c4e0cc6d3d219ed606c238"> 73</a></span>&#160; GLM_FUNC_DECL genType <a class="code" href="a00933.html#ga42d3e771fa7cb3c60d828e315829df19">fastDistance</a>(genType x, genType y);</div>
  108. <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; </div>
  109. <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="keyword">template</span>&lt;length_t L, <span class="keyword">typename</span> T, qualifier Q&gt;</div>
  110. <div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="a00933.html#ga42d3e771fa7cb3c60d828e315829df19"> 79</a></span>&#160; GLM_FUNC_DECL T <a class="code" href="a00933.html#ga42d3e771fa7cb3c60d828e315829df19">fastDistance</a>(vec&lt;L, T, Q&gt; <span class="keyword">const</span>&amp; x, vec&lt;L, T, Q&gt; <span class="keyword">const</span>&amp; y);</div>
  111. <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; </div>
  112. <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> genType&gt;</div>
  113. <div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="a00933.html#gac0991240651a3f75792ff5de2e526b8c"> 85</a></span>&#160; GLM_FUNC_DECL genType <a class="code" href="a00933.html#gaab477221230a6e12a3b9e22e750c8928">fastNormalize</a>(genType x);</div>
  114. <div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; </div>
  115. <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; <span class="keyword">template</span>&lt;length_t L, <span class="keyword">typename</span> T, qualifier Q&gt;</div>
  116. <div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="a00933.html#gaab477221230a6e12a3b9e22e750c8928"> 91</a></span>&#160; GLM_FUNC_DECL vec&lt;L, T, Q&gt; <a class="code" href="a00933.html#gaab477221230a6e12a3b9e22e750c8928">fastNormalize</a>(vec&lt;L, T, Q&gt; <span class="keyword">const</span>&amp; x);</div>
  117. <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; </div>
  118. <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;}<span class="comment">// namespace glm</span></div>
  119. <div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; </div>
  120. <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;<span class="preprocessor">#include &quot;fast_square_root.inl&quot;</span></div>
  121. </div><!-- fragment --></div><!-- contents -->
  122. <div class="ttc" id="aa00933_html_ga90f66be92ef61e705c005e7b3209edb8"><div class="ttname"><a href="a00933.html#ga90f66be92ef61e705c005e7b3209edb8">glm::fastLength</a></div><div class="ttdeci">GLM_FUNC_DECL T fastLength(vec&lt; L, T, Q &gt; const &amp;x)</div><div class="ttdoc">Faster than the common length function but less accurate.</div></div>
  123. <div class="ttc" id="aa00933_html_ga42d3e771fa7cb3c60d828e315829df19"><div class="ttname"><a href="a00933.html#ga42d3e771fa7cb3c60d828e315829df19">glm::fastDistance</a></div><div class="ttdeci">GLM_FUNC_DECL T fastDistance(vec&lt; L, T, Q &gt; const &amp;x, vec&lt; L, T, Q &gt; const &amp;y)</div><div class="ttdoc">Faster than the common distance function but less accurate.</div></div>
  124. <div class="ttc" id="aa00933_html_gadcd7be12b1e5ee182141359d4c45dd24"><div class="ttname"><a href="a00933.html#gadcd7be12b1e5ee182141359d4c45dd24">glm::fastInverseSqrt</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; L, T, Q &gt; fastInverseSqrt(vec&lt; L, T, Q &gt; const &amp;x)</div><div class="ttdoc">Faster than the common inversesqrt function but less accurate.</div></div>
  125. <div class="ttc" id="aa00933_html_gaab477221230a6e12a3b9e22e750c8928"><div class="ttname"><a href="a00933.html#gaab477221230a6e12a3b9e22e750c8928">glm::fastNormalize</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; L, T, Q &gt; fastNormalize(vec&lt; L, T, Q &gt; const &amp;x)</div><div class="ttdoc">Faster than the common normalize function but less accurate.</div></div>
  126. <div class="ttc" id="aa00933_html_gae83f0c03614f73eae5478c5b6274ee6d"><div class="ttname"><a href="a00933.html#gae83f0c03614f73eae5478c5b6274ee6d">glm::fastSqrt</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; L, T, Q &gt; fastSqrt(vec&lt; L, T, Q &gt; const &amp;x)</div><div class="ttdoc">Faster than the common sqrt function but less accurate.</div></div>
  127. <!-- start footer part -->
  128. <hr class="footer"/><address class="footer"><small>
  129. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  130. <img class="footer" src="doxygen.png" alt="doxygen"/>
  131. </a> 1.8.18
  132. </small></address>
  133. </body>
  134. </html>