mirror/glm
1
0
Fork 0
mirror of https://github.com/g-truc/glm.git synced 2024-11-23 01:14:34 +00:00
Code Issues Packages Projects Releases Wiki Activity
c5389b595f
glm/doc/api-0.9.3/a00222.html
Christophe Riccio 50673be1bd Added 0.9.3 documentation
2011-11-12 23:26:02 +00:00

227 lines
9.4 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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"/>
<title>GLM_GTX_ulp: Accuracy measurement</title>
<link href="tabs.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="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo-mini.png"></td>
</tr>
</tbody>
</table>
</div>
<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="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>GLM_GTX_ulp: Accuracy measurement</h1> </div>
<div class="ingroups"><a class="el" href="a00152.html">GTX Extensions (Experimental)</a></div></div>
<div class="contents">
<p>Allow the measurement of the accuracy of a function against a reference implementation.
<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 T &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">uint&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00222.html#gaa9c7dda6ebfaed5249495358c3a50265">float_distance</a> (T const &amp;x, T const &amp;y)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T , template&lt; typename &gt; class vecType&gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">vecType&lt; uint &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00222.html#ga8667f717789de8b8936c607fdd27793f">float_distance</a> (vecType&lt; T &gt; const &amp;x, vecType&lt; T &gt; 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="a00222.html#ga125f81c629faed6d267ee38f9a2ba73b">next_float</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="a00222.html#ga6e01642188a9eb70920cdb66c61bd53a">next_float</a> (genType const &amp;x, uint const &amp;Distance)</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="a00222.html#ga8c0adb311cd0b5f2b66785de7da24e49">prev_float</a> (genType const &amp;x, uint const &amp;Distance)</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="a00222.html#ga90fb8abf378453f68931966989627159">prev_float</a> (genType const &amp;x)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Allow the measurement of the accuracy of a function against a reference implementation. </p>
<p>This extension works on floating-point data and provide results in ULP. &lt;<a class="el" href="a00130.html" title="OpenGL Mathematics (glm.g-truc.net)">glm/gtx/ulp.hpp</a>&gt; need to be included to use these functionalities. </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="gaa9c7dda6ebfaed5249495358c3a50265"></a><!-- doxytag: member="glm::float_distance" ref="gaa9c7dda6ebfaed5249495358c3a50265" args="(T const &amp;x, T const &amp;y)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint glm::float_distance </td>
<td>(</td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>y</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the distance in the number of ULP between 2 scalars. </p>
<p>From GLM_GTX_ulp extension. </p>
</div>
</div>
<a class="anchor" id="ga8667f717789de8b8936c607fdd27793f"></a><!-- doxytag: member="glm::float_distance" ref="ga8667f717789de8b8936c607fdd27793f" args="(vecType&lt; T &gt; const &amp;x, vecType&lt; T &gt; const &amp;y)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vecType&lt;uint&gt; glm::float_distance </td>
<td>(</td>
<td class="paramtype">vecType&lt; T &gt; const &amp;&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vecType&lt; T &gt; const &amp;&#160;</td>
<td class="paramname"><em>y</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the distance in the number of ULP between 2 vectors. </p>
<p>From GLM_GTX_ulp extension. </p>
</div>
</div>
<a class="anchor" id="ga125f81c629faed6d267ee38f9a2ba73b"></a><!-- doxytag: member="glm::next_float" ref="ga125f81c629faed6d267ee38f9a2ba73b" args="(genType const &amp;x)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">genType glm::next_float </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>Return the next ULP value(s) after the input value(s). </p>
<p>From GLM_GTX_ulp extension. </p>
</div>
</div>
<a class="anchor" id="ga6e01642188a9eb70920cdb66c61bd53a"></a><!-- doxytag: member="glm::next_float" ref="ga6e01642188a9eb70920cdb66c61bd53a" args="(genType const &amp;x, uint const &amp;Distance)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">genType glm::next_float </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint const &amp;&#160;</td>
<td class="paramname"><em>Distance</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the value(s) ULP distance after the input value(s). </p>
<p>From GLM_GTX_ulp extension. </p>
</div>
</div>
<a class="anchor" id="ga8c0adb311cd0b5f2b66785de7da24e49"></a><!-- doxytag: member="glm::prev_float" ref="ga8c0adb311cd0b5f2b66785de7da24e49" args="(genType const &amp;x, uint const &amp;Distance)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">genType glm::prev_float </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint const &amp;&#160;</td>
<td class="paramname"><em>Distance</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the value(s) ULP distance before the input value(s). </p>
<p>From GLM_GTX_ulp extension. </p>
</div>
</div>
<a class="anchor" id="ga90fb8abf378453f68931966989627159"></a><!-- doxytag: member="glm::prev_float" ref="ga90fb8abf378453f68931966989627159" args="(genType const &amp;x)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">genType glm::prev_float </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>Return the previous ULP value(s) before the input value(s). </p>
<p>From GLM_GTX_ulp extension. </p>
</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>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink