mewin/glm
1
0
Fork 0
Code Releases Activity

Updated doxygen for 0.9.6 API

Browse Source
This commit is contained in:
Christophe Riccio
2014-11-25 01:28:32 +01:00
parent c273be264c
commit 39334f282c
464 changed files with 68872 additions and 70562 deletions
Download Patch File Download Diff File Expand all files Collapse all files

279
doc/api/a00196.html
View File

@@ -3,8 +3,8 @@
<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.5"/>
<title>GLM: GLM_GTX_fast_exponential</title>
<meta name="generator" content="Doxygen 1.8.8"/>
<title>0.9.6: GLM_GTX_fast_square_root</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>
@@ -16,9 +16,9 @@
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">GLM
&#160;<span id="projectnumber">0.9.5</span>
<div id="projectname">0.9.6
</div>
</td>
</tr>
@@ -26,13 +26,11 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<!-- Generated by Doxygen 1.8.8 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
@@ -41,147 +39,55 @@
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">GLM_GTX_fast_exponential<div class="ingroups"><a class="el" href="a00165.html">GTX Extensions (Experimental)</a></div></div> </div>
<div class="title">GLM_GTX_fast_square_root<div class="ingroups"><a class="el" href="a00160.html">GTX Extensions (Experimental)</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga81550f837781889cc21fe49852102ea0"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ga81550f837781889cc21fe49852102ea0"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00196.html#ga81550f837781889cc21fe49852102ea0">fastExp</a> (const T &amp;x)</td></tr>
<tr class="separator:ga81550f837781889cc21fe49852102ea0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga27ffd3d58db8a5309300f16cc5d9284c"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ga27ffd3d58db8a5309300f16cc5d9284c"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00196.html#ga27ffd3d58db8a5309300f16cc5d9284c">fastExp2</a> (const T &amp;x)</td></tr>
<tr class="separator:ga27ffd3d58db8a5309300f16cc5d9284c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaddd4e635f1c3168122fe7b14753935b9"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:gaddd4e635f1c3168122fe7b14753935b9"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00196.html#gaddd4e635f1c3168122fe7b14753935b9">fastLn</a> (const T &amp;x)</td></tr>
<tr class="separator:gaddd4e635f1c3168122fe7b14753935b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga784a80d571f0f596d438863775827cd0"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ga784a80d571f0f596d438863775827cd0"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00196.html#ga784a80d571f0f596d438863775827cd0">fastLog</a> (const T &amp;x)</td></tr>
<tr class="separator:ga784a80d571f0f596d438863775827cd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac516a11818384b9392412ac199044cf6"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:gac516a11818384b9392412ac199044cf6"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00196.html#gac516a11818384b9392412ac199044cf6">fastLog2</a> (const T &amp;x)</td></tr>
<tr class="separator:gac516a11818384b9392412ac199044cf6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0ecbe429c87b820368f425ee8d22841a"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga0ecbe429c87b820368f425ee8d22841a"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00196.html#ga0ecbe429c87b820368f425ee8d22841a">fastPow</a> (genType const &amp;x, genType const &amp;y)</td></tr>
<tr class="separator:ga0ecbe429c87b820368f425ee8d22841a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3afd7b7f1ac505ca9247dc6ffa0c25cb"><td class="memTemplParams" colspan="2">template&lt;typename genTypeT , typename genTypeU &gt; </td></tr>
<tr class="memitem:ga3afd7b7f1ac505ca9247dc6ffa0c25cb"><td class="memTemplItemLeft" align="right" valign="top">genTypeT&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00196.html#ga3afd7b7f1ac505ca9247dc6ffa0c25cb">fastPow</a> (genTypeT const &amp;x, genTypeU const &amp;y)</td></tr>
<tr class="separator:ga3afd7b7f1ac505ca9247dc6ffa0c25cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaac333418d0c4e0cc6d3d219ed606c238"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<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="a00196.html#gaac333418d0c4e0cc6d3d219ed606c238">fastDistance</a> (genType x, genType y)</td></tr>
<tr class="separator:gaac333418d0c4e0cc6d3d219ed606c238"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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="a00196.html#ga6d1ac559cd77d69119e30c3aca0e14b5">fastDistance</a> (vecType&lt; T, P &gt; const &amp;x, vecType&lt; T, P &gt; const &amp;y)</td></tr>
<tr class="separator:ga6d1ac559cd77d69119e30c3aca0e14b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7f081b14d9c7035c8714eba5f7f75a8f"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<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="a00196.html#ga7f081b14d9c7035c8714eba5f7f75a8f">fastInverseSqrt</a> (genType x)</td></tr>
<tr class="separator:ga7f081b14d9c7035c8714eba5f7f75a8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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="a00196.html#ga903878071f92e51e551791e584a171a1">fastInverseSqrt</a> (vecType&lt; T, P &gt; const &amp;x)</td></tr>
<tr class="separator:ga903878071f92e51e551791e584a171a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga70aa3c80d8bb22e021c6c3ebdcf8e3ee"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga70aa3c80d8bb22e021c6c3ebdcf8e3ee"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType::value_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00196.html#ga70aa3c80d8bb22e021c6c3ebdcf8e3ee">fastLength</a> (genType const &amp;x)</td></tr>
<tr class="separator:ga70aa3c80d8bb22e021c6c3ebdcf8e3ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3b02c1d6e0c754144e2f1e110bf9f16c"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<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="a00196.html#ga3b02c1d6e0c754144e2f1e110bf9f16c">fastNormalize</a> (genType const &amp;x)</td></tr>
<tr class="separator:ga3b02c1d6e0c754144e2f1e110bf9f16c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6c460e9414a50b2fc455c8f64c86cdc9"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<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="a00196.html#ga6c460e9414a50b2fc455c8f64c86cdc9">fastSqrt</a> (genType x)</td></tr>
<tr class="separator:ga6c460e9414a50b2fc455c8f64c86cdc9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Fast but less accurate implementations of exponential based functions. </p>
<p>&lt;<a class="el" href="a00029.html" title="OpenGL Mathematics (glm.g-truc.net) ">glm/gtx/fast_exponential.hpp</a>&gt; need to be included to use these functionalities. </p>
<p>Fast but less accurate implementations of square root based functions. </p>
<ul>
<li>Sqrt optimisation based on Newton's method, www.gamedev.net/community/forums/topic.asp?topic id=139956</li>
</ul>
<p>&lt;<a class="el" href="a00026.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>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga81550f837781889cc21fe49852102ea0"></a>
<a class="anchor" id="gaac333418d0c4e0cc6d3d219ed606c238"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T glm::fastExp </td>
<td class="memname">GLM_FUNC_DECL genType glm::fastDistance </td>
<td>(</td>
<td class="paramtype">const T &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Faster than the common exp function but less accurate. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00196.html" title="Fast but less accurate implementations of exponential based functions. ">GLM_GTX_fast_exponential</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga27ffd3d58db8a5309300f16cc5d9284c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T glm::fastExp2 </td>
<td>(</td>
<td class="paramtype">const T &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Faster than the common exp2 function but less accurate. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00196.html" title="Fast but less accurate implementations of exponential based functions. ">GLM_GTX_fast_exponential</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gaddd4e635f1c3168122fe7b14753935b9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T glm::fastLn </td>
<td>(</td>
<td class="paramtype">const T &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Faster than the common ln function but less accurate. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00196.html" title="Fast but less accurate implementations of exponential based functions. ">GLM_GTX_fast_exponential</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga784a80d571f0f596d438863775827cd0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T glm::fastLog </td>
<td>(</td>
<td class="paramtype">const T &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Faster than the common log function but less accurate. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00196.html" title="Fast but less accurate implementations of exponential based functions. ">GLM_GTX_fast_exponential</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gac516a11818384b9392412ac199044cf6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T glm::fastLog2 </td>
<td>(</td>
<td class="paramtype">const T &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Faster than the common log2 function but less accurate. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00196.html" title="Fast but less accurate implementations of exponential based functions. ">GLM_GTX_fast_exponential</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga0ecbe429c87b820368f425ee8d22841a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">genType glm::fastPow </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramtype">genType&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramtype">genType&#160;</td>
<td class="paramname"><em>y</em>&#160;</td>
</tr>
<tr>
@@ -192,25 +98,25 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Faster than the common pow function but less accurate. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00196.html" title="Fast but less accurate implementations of exponential based functions. ">GLM_GTX_fast_exponential</a> </dd></dl>
<p>Faster than the common distance function but less accurate. </p>
<p>From GLM_GTX_fast_square_root extension. </p>
</div>
</div>
<a class="anchor" id="ga3afd7b7f1ac505ca9247dc6ffa0c25cb"></a>
<a class="anchor" id="ga6d1ac559cd77d69119e30c3aca0e14b5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">genTypeT glm::fastPow </td>
<td class="memname">GLM_FUNC_DECL T glm::fastDistance </td>
<td>(</td>
<td class="paramtype">genTypeT const &amp;&#160;</td>
<td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genTypeU const &amp;&#160;</td>
<td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>y</em>&#160;</td>
</tr>
<tr>
@@ -221,8 +127,103 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Faster than the common pow function but less accurate. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00196.html" title="Fast but less accurate implementations of exponential based functions. ">GLM_GTX_fast_exponential</a> </dd></dl>
<p>Faster than the common distance function but less accurate. </p>
<p>From GLM_GTX_fast_square_root extension. </p>
</div>
</div>
<a class="anchor" id="ga7f081b14d9c7035c8714eba5f7f75a8f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL genType glm::fastInverseSqrt </td>
<td>(</td>
<td class="paramtype">genType&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Faster than the common inversesqrt function but less accurate. </p>
<p>From GLM_GTX_fast_square_root extension. </p>
</div>
</div>
<a class="anchor" id="ga903878071f92e51e551791e584a171a1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL vecType&lt;T, P&gt; glm::fastInverseSqrt </td>
<td>(</td>
<td class="paramtype">vecType&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Faster than the common inversesqrt function but less accurate. </p>
<p>From GLM_GTX_fast_square_root extension. </p>
</div>
</div>
<a class="anchor" id="ga70aa3c80d8bb22e021c6c3ebdcf8e3ee"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL genType::value_type glm::fastLength </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Faster than the common length function but less accurate. </p>
<p>From GLM_GTX_fast_square_root extension. </p>
</div>
</div>
<a class="anchor" id="ga3b02c1d6e0c754144e2f1e110bf9f16c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL genType glm::fastNormalize </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Faster than the common normalize function but less accurate. </p>
<p>From GLM_GTX_fast_square_root extension. </p>
</div>
</div>
<a class="anchor" id="ga6c460e9414a50b2fc455c8f64c86cdc9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL genType glm::fastSqrt </td>
<td>(</td>
<td class="paramtype">genType&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Faster than the common sqrt function but less accurate. </p>
<p>From GLM_GTX_fast_square_root extension. </p>
</div>
</div>
@@ -231,7 +232,7 @@ Functions</h2></td></tr>
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</a> 1.8.8
</small></address>
</body>
</html>