mirror of
https://github.com/g-truc/glm.git
synced 2024-11-30 03:44:38 +00:00
137 lines
14 KiB
HTML
137 lines
14 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||
|
|
<meta name="generator" content="Doxygen 1.8.18"/>
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||
|
|
<title>1.0.0 API documentation: fast_square_root.hpp Source File</title>
|
||
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||
|
|
<script type="text/javascript" src="jquery.js"></script>
|
||
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
||
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
||
|
|
<script type="text/javascript" src="search/search.js"></script>
|
||
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||
|
|
<div id="titlearea">
|
||
|
|
<table cellspacing="0" cellpadding="0">
|
||
|
|
<tbody>
|
||
|
|
<tr style="height: 56px;">
|
||
|
|
<td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
|
||
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
||
|
|
<div id="projectname">1.0.0 API documentation
|
||
|
|
</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<!-- end header part -->
|
||
|
|
<!-- Generated by Doxygen 1.8.18 -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
||
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||
|
|
/* @license-end */
|
||
|
|
</script>
|
||
|
|
<script type="text/javascript" src="menudata.js"></script>
|
||
|
|
<script type="text/javascript" src="menu.js"></script>
|
||
|
|
<script type="text/javascript">
|
||
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
||
|
|
$(function() {
|
||
|
|
initMenu('',true,false,'search.php','Search');
|
||
|
|
$(document).ready(function() { init_search(); });
|
||
|
|
});
|
||
|
|
/* @license-end */</script>
|
||
|
|
<div id="main-nav"></div>
|
||
|
|
<!-- window showing the filter options -->
|
||
|
|
<div id="MSearchSelectWindow"
|
||
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
||
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
||
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<!-- iframe showing the search results (closed by default) -->
|
||
|
|
<div id="MSearchResultsWindow">
|
||
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
||
|
|
name="MSearchResults" id="MSearchResults">
|
||
|
|
</iframe>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div id="nav-path" class="navpath">
|
||
|
|
<ul>
|
||
|
|
<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>
|
||
|
|
</div>
|
||
|
|
</div><!-- top -->
|
||
|
|
<div class="header">
|
||
|
|
<div class="headertitle">
|
||
|
|
<div class="title">fast_square_root.hpp</div> </div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
<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>  </div>
|
||
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#pragma once</span></div>
|
||
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  </div>
|
||
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">// Dependency:</span></div>
|
||
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include "../common.hpp"</span></div>
|
||
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include "../exponential.hpp"</span></div>
|
||
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include "../geometric.hpp"</span></div>
|
||
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  </div>
|
||
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#ifndef GLM_ENABLE_EXPERIMENTAL</span></div>
|
||
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor"># error "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."</span></div>
|
||
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#elif GLM_MESSAGES == GLM_ENABLE && !defined(GLM_EXT_INCLUDED)</span></div>
|
||
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor"># pragma message("GLM: GLM_GTX_fast_square_root extension included")</span></div>
|
||
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#endif</span></div>
|
||
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  </div>
|
||
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">namespace </span>glm</div>
|
||
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> {</div>
|
||
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div>
|
||
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keyword">template</span><<span class="keyword">typename</span> genType></div>
|
||
|
|
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="a00933.html#ga6c460e9414a50b2fc455c8f64c86cdc9"> 37</a></span>  GLM_FUNC_DECL genType <a class="code" href="a00933.html#gae83f0c03614f73eae5478c5b6274ee6d">fastSqrt</a>(genType x);</div>
|
||
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  </div>
|
||
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keyword">template</span><length_t L, <span class="keyword">typename</span> T, qualifier Q></div>
|
||
|
|
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="a00933.html#gae83f0c03614f73eae5478c5b6274ee6d"> 43</a></span>  GLM_FUNC_DECL vec<L, T, Q> <a class="code" href="a00933.html#gae83f0c03614f73eae5478c5b6274ee6d">fastSqrt</a>(vec<L, T, Q> <span class="keyword">const</span>& x);</div>
|
||
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  </div>
|
||
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">template</span><<span class="keyword">typename</span> genType></div>
|
||
|
|
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="a00933.html#ga7f081b14d9c7035c8714eba5f7f75a8f"> 49</a></span>  GLM_FUNC_DECL genType <a class="code" href="a00933.html#gadcd7be12b1e5ee182141359d4c45dd24">fastInverseSqrt</a>(genType x);</div>
|
||
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  </div>
|
||
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">template</span><length_t L, <span class="keyword">typename</span> T, qualifier Q></div>
|
||
|
|
<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="a00933.html#gadcd7be12b1e5ee182141359d4c45dd24"> 55</a></span>  GLM_FUNC_DECL vec<L, T, Q> <a class="code" href="a00933.html#gadcd7be12b1e5ee182141359d4c45dd24">fastInverseSqrt</a>(vec<L, T, Q> <span class="keyword">const</span>& x);</div>
|
||
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  </div>
|
||
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">template</span><<span class="keyword">typename</span> genType></div>
|
||
|
|
<div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="a00933.html#gafe697d6287719538346bbdf8b1367c59"> 61</a></span>  GLM_FUNC_DECL genType <a class="code" href="a00933.html#ga90f66be92ef61e705c005e7b3209edb8">fastLength</a>(genType x);</div>
|
||
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  </div>
|
||
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keyword">template</span><length_t L, <span class="keyword">typename</span> T, qualifier Q></div>
|
||
|
|
<div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="a00933.html#ga90f66be92ef61e705c005e7b3209edb8"> 67</a></span>  GLM_FUNC_DECL T <a class="code" href="a00933.html#ga90f66be92ef61e705c005e7b3209edb8">fastLength</a>(vec<L, T, Q> <span class="keyword">const</span>& x);</div>
|
||
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  </div>
|
||
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keyword">template</span><<span class="keyword">typename</span> genType></div>
|
||
|
|
<div class="line"><a name="l00073"></a><span class="lineno"><a class="line" href="a00933.html#gaac333418d0c4e0cc6d3d219ed606c238"> 73</a></span>  GLM_FUNC_DECL genType <a class="code" href="a00933.html#ga42d3e771fa7cb3c60d828e315829df19">fastDistance</a>(genType x, genType y);</div>
|
||
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  </div>
|
||
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keyword">template</span><length_t L, <span class="keyword">typename</span> T, qualifier Q></div>
|
||
|
|
<div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="a00933.html#ga42d3e771fa7cb3c60d828e315829df19"> 79</a></span>  GLM_FUNC_DECL T <a class="code" href="a00933.html#ga42d3e771fa7cb3c60d828e315829df19">fastDistance</a>(vec<L, T, Q> <span class="keyword">const</span>& x, vec<L, T, Q> <span class="keyword">const</span>& y);</div>
|
||
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  </div>
|
||
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keyword">template</span><<span class="keyword">typename</span> genType></div>
|
||
|
|
<div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="a00933.html#gac0991240651a3f75792ff5de2e526b8c"> 85</a></span>  GLM_FUNC_DECL genType <a class="code" href="a00933.html#gaab477221230a6e12a3b9e22e750c8928">fastNormalize</a>(genType x);</div>
|
||
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  </div>
|
||
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keyword">template</span><length_t L, <span class="keyword">typename</span> T, qualifier Q></div>
|
||
|
|
<div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="a00933.html#gaab477221230a6e12a3b9e22e750c8928"> 91</a></span>  GLM_FUNC_DECL vec<L, T, Q> <a class="code" href="a00933.html#gaab477221230a6e12a3b9e22e750c8928">fastNormalize</a>(vec<L, T, Q> <span class="keyword">const</span>& x);</div>
|
||
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  </div>
|
||
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> }<span class="comment">// namespace glm</span></div>
|
||
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  </div>
|
||
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="preprocessor">#include "fast_square_root.inl"</span></div>
|
||
|
|
</div><!-- fragment --></div><!-- contents -->
|
||
|
|
<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< L, T, Q > const &x)</div><div class="ttdoc">Faster than the common length function but less accurate.</div></div>
|
||
|
|
<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< L, T, Q > const &x, vec< L, T, Q > const &y)</div><div class="ttdoc">Faster than the common distance function but less accurate.</div></div>
|
||
|
|
<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< L, T, Q > fastInverseSqrt(vec< L, T, Q > const &x)</div><div class="ttdoc">Faster than the common inversesqrt function but less accurate.</div></div>
|
||
|
|
<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< L, T, Q > fastNormalize(vec< L, T, Q > const &x)</div><div class="ttdoc">Faster than the common normalize function but less accurate.</div></div>
|
||
|
|
<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< L, T, Q > fastSqrt(vec< L, T, Q > const &x)</div><div class="ttdoc">Faster than the common sqrt function but less accurate.</div></div>
|
||
|
|
<!-- start footer part -->
|
||
|
|
<hr class="footer"/><address class="footer"><small>
|
||
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
||
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||
|
|
</a> 1.8.18
|
||
|
|
</small></address>
|
||
|
|
</body>
|
||
|
|
</html>
|