Updated doxygen documentation

This commit is contained in:
Christophe Riccio
2011-12-07 14:50:15 +00:00
parent a3b5034d4e
commit f18ad6bf2e
389 changed files with 27429 additions and 14460 deletions

View File

@@ -2,22 +2,36 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>GLM_GTX_fast_square_root: Fast square root functions</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="top"><!-- do not remove this div! -->
<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="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
@@ -32,34 +46,31 @@
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>GLM_GTX_fast_square_root: Fast square root functions</h1> </div>
<div class="title">GLM_GTX_fast_square_root: Fast square root functions</div> </div>
<div class="ingroups"><a class="el" href="a00152.html">GTX Extensions (Experimental)</a></div></div>
<div class="contents">
<p>Fast but less accurate implementations of square root based functions.
<a href="#_details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType::value_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00183.html#gaa576cf70903b0bc1631fa32ebadd0134">fastDistance</a> (genType const &amp;x, genType const &amp;y)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType::value_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00183.html#ga646eee2633e9de7274de9bc6f5af92b5">fastDistance</a> (genType const &amp;x, genType const &amp;y)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00183.html#gad8adfc67c842b9f2fa9dc1b251cfc097">fastInverseSqrt</a> (genType const &amp;x)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00183.html#ga49dd9caa2853398474e5aae377259a22">fastInverseSqrt</a> (genType const &amp;x)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType::value_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00183.html#ga7653f1b39ef2ee1b6633842238bef911">fastLength</a> (genType const &amp;x)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType::value_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00183.html#ga2e726cc8b9f02b7c09910858ea1afac6">fastLength</a> (genType const &amp;x)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00183.html#gafa857a1f03e384286b9509b91e3fec1b">fastNormalize</a> (genType const &amp;x)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00183.html#ga2953e7426a420bb2b33affce7360ef40">fastNormalize</a> (genType const &amp;x)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00183.html#gab351f0ee922133ec048453e133ea8c8a">fastSqrt</a> (genType const &amp;x)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00183.html#gad57c343d2362c1469043adedeb8ef8eb">fastSqrt</a> (genType const &amp;x)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<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="a00039.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>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="gaa576cf70903b0bc1631fa32ebadd0134"></a><!-- doxytag: member="glm::fastDistance" ref="gaa576cf70903b0bc1631fa32ebadd0134" args="(genType const &amp;x, genType const &amp;y)" -->
<a class="anchor" id="ga646eee2633e9de7274de9bc6f5af92b5"></a><!-- doxytag: member="glm::fastDistance" ref="ga646eee2633e9de7274de9bc6f5af92b5" args="(genType const &amp;x, genType const &amp;y)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -89,7 +100,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="gad8adfc67c842b9f2fa9dc1b251cfc097"></a><!-- doxytag: member="glm::fastInverseSqrt" ref="gad8adfc67c842b9f2fa9dc1b251cfc097" args="(genType const &amp;x)" -->
<a class="anchor" id="ga49dd9caa2853398474e5aae377259a22"></a><!-- doxytag: member="glm::fastInverseSqrt" ref="ga49dd9caa2853398474e5aae377259a22" args="(genType const &amp;x)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -109,7 +120,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="ga7653f1b39ef2ee1b6633842238bef911"></a><!-- doxytag: member="glm::fastLength" ref="ga7653f1b39ef2ee1b6633842238bef911" args="(genType const &amp;x)" -->
<a class="anchor" id="ga2e726cc8b9f02b7c09910858ea1afac6"></a><!-- doxytag: member="glm::fastLength" ref="ga2e726cc8b9f02b7c09910858ea1afac6" args="(genType const &amp;x)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -129,7 +140,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="gafa857a1f03e384286b9509b91e3fec1b"></a><!-- doxytag: member="glm::fastNormalize" ref="gafa857a1f03e384286b9509b91e3fec1b" args="(genType const &amp;x)" -->
<a class="anchor" id="ga2953e7426a420bb2b33affce7360ef40"></a><!-- doxytag: member="glm::fastNormalize" ref="ga2953e7426a420bb2b33affce7360ef40" args="(genType const &amp;x)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -149,7 +160,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="gab351f0ee922133ec048453e133ea8c8a"></a><!-- doxytag: member="glm::fastSqrt" ref="gab351f0ee922133ec048453e133ea8c8a" args="(genType const &amp;x)" -->
<a class="anchor" id="gad57c343d2362c1469043adedeb8ef8eb"></a><!-- doxytag: member="glm::fastSqrt" ref="gad57c343d2362c1469043adedeb8ef8eb" args="(genType const &amp;x)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -170,8 +181,13 @@ Functions</h2></td></tr>
</div>
</div>
</div>
<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.7.3 </small></address>
<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.7.5
</small></address>
</body>
</html>