mirror of
https://github.com/g-truc/glm.git
synced 2024-11-26 02:04:35 +00:00
282 lines
14 KiB
HTML
282 lines
14 KiB
HTML
<!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"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.10"/>
|
|
<title>0.9.9 API documenation: GLM_GTC_ulp</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>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { init_search(); });
|
|
</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">0.9.9 API documenation
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.10 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<!-- 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 class="header">
|
|
<div class="summary">
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">GLM_GTC_ulp<div class="ingroups"><a class="el" href="a00153.html">Recommended extensions</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Include <<a class="el" href="a00126.html" title="GLM_GTC_ulp ">glm/gtc/ulp.hpp</a>> to use the features of this extension.
|
|
<a href="#details">More...</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:ga2e09bd6c8b0a9c91f6f5683d68245634"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
|
<tr class="memitem:ga2e09bd6c8b0a9c91f6f5683d68245634"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL uint </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00173.html#ga2e09bd6c8b0a9c91f6f5683d68245634">float_distance</a> (T const &x, T const &y)</td></tr>
|
|
<tr class="memdesc:ga2e09bd6c8b0a9c91f6f5683d68245634"><td class="mdescLeft"> </td><td class="mdescRight">Return the distance in the number of ULP between 2 scalars. <a href="a00173.html#ga2e09bd6c8b0a9c91f6f5683d68245634">More...</a><br /></td></tr>
|
|
<tr class="separator:ga2e09bd6c8b0a9c91f6f5683d68245634"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga72b3223069013f336d8c31812b7ada80"><td class="memTemplParams" colspan="2">template<typename T , qualifier Q> </td></tr>
|
|
<tr class="memitem:ga72b3223069013f336d8c31812b7ada80"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< 2, uint, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00173.html#ga72b3223069013f336d8c31812b7ada80">float_distance</a> (vec< 2, T, Q > const &x, vec< 2, T, Q > const &y)</td></tr>
|
|
<tr class="memdesc:ga72b3223069013f336d8c31812b7ada80"><td class="mdescLeft"> </td><td class="mdescRight">Return the distance in the number of ULP between 2 vectors. <a href="a00173.html#ga72b3223069013f336d8c31812b7ada80">More...</a><br /></td></tr>
|
|
<tr class="separator:ga72b3223069013f336d8c31812b7ada80"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gae516ae554faa6117660828240e8bdaf0"><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
|
<tr class="memitem:gae516ae554faa6117660828240e8bdaf0"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00173.html#gae516ae554faa6117660828240e8bdaf0">next_float</a> (genType const &x)</td></tr>
|
|
<tr class="memdesc:gae516ae554faa6117660828240e8bdaf0"><td class="mdescLeft"> </td><td class="mdescRight">Return the next ULP value(s) after the input value(s). <a href="a00173.html#gae516ae554faa6117660828240e8bdaf0">More...</a><br /></td></tr>
|
|
<tr class="separator:gae516ae554faa6117660828240e8bdaf0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gad107ec3d9697ef82032a33338a73ebdd"><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
|
<tr class="memitem:gad107ec3d9697ef82032a33338a73ebdd"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00173.html#gad107ec3d9697ef82032a33338a73ebdd">next_float</a> (genType const &x, uint const &Distance)</td></tr>
|
|
<tr class="memdesc:gad107ec3d9697ef82032a33338a73ebdd"><td class="mdescLeft"> </td><td class="mdescRight">Return the value(s) ULP distance after the input value(s). <a href="a00173.html#gad107ec3d9697ef82032a33338a73ebdd">More...</a><br /></td></tr>
|
|
<tr class="separator:gad107ec3d9697ef82032a33338a73ebdd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga2fcbb7bfbfc595712bfddc51b0715b07"><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
|
<tr class="memitem:ga2fcbb7bfbfc595712bfddc51b0715b07"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00173.html#ga2fcbb7bfbfc595712bfddc51b0715b07">prev_float</a> (genType const &x)</td></tr>
|
|
<tr class="memdesc:ga2fcbb7bfbfc595712bfddc51b0715b07"><td class="mdescLeft"> </td><td class="mdescRight">Return the previous ULP value(s) before the input value(s). <a href="a00173.html#ga2fcbb7bfbfc595712bfddc51b0715b07">More...</a><br /></td></tr>
|
|
<tr class="separator:ga2fcbb7bfbfc595712bfddc51b0715b07"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaa399d5b6472a70e8952f9b26ecaacdec"><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
|
<tr class="memitem:gaa399d5b6472a70e8952f9b26ecaacdec"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00173.html#gaa399d5b6472a70e8952f9b26ecaacdec">prev_float</a> (genType const &x, uint const &Distance)</td></tr>
|
|
<tr class="memdesc:gaa399d5b6472a70e8952f9b26ecaacdec"><td class="mdescLeft"> </td><td class="mdescRight">Return the value(s) ULP distance before the input value(s). <a href="a00173.html#gaa399d5b6472a70e8952f9b26ecaacdec">More...</a><br /></td></tr>
|
|
<tr class="separator:gaa399d5b6472a70e8952f9b26ecaacdec"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<p>Include <<a class="el" href="a00126.html" title="GLM_GTC_ulp ">glm/gtc/ulp.hpp</a>> to use the features of this extension. </p>
|
|
<p>Allow the measurement of the accuracy of a function against a reference implementation. This extension works on floating-point data and provide results in ULP. </p>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="ga2e09bd6c8b0a9c91f6f5683d68245634"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL uint glm::float_distance </td>
|
|
<td>(</td>
|
|
<td class="paramtype">T const & </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">T const & </td>
|
|
<td class="paramname"><em>y</em> </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>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00173.html" title="Include <glm/gtc/ulp.hpp> to use the features of this extension. ">GLM_GTC_ulp</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga72b3223069013f336d8c31812b7ada80"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL vec<2, uint, Q> glm::float_distance </td>
|
|
<td>(</td>
|
|
<td class="paramtype">vec< 2, T, Q > const & </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">vec< 2, T, Q > const & </td>
|
|
<td class="paramname"><em>y</em> </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>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00173.html" title="Include <glm/gtc/ulp.hpp> to use the features of this extension. ">GLM_GTC_ulp</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gae516ae554faa6117660828240e8bdaf0"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL genType glm::next_float </td>
|
|
<td>(</td>
|
|
<td class="paramtype">genType const & </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>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00173.html" title="Include <glm/gtc/ulp.hpp> to use the features of this extension. ">GLM_GTC_ulp</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gad107ec3d9697ef82032a33338a73ebdd"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL genType glm::next_float </td>
|
|
<td>(</td>
|
|
<td class="paramtype">genType const & </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00150.html#ga91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> const & </td>
|
|
<td class="paramname"><em>Distance</em> </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>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00173.html" title="Include <glm/gtc/ulp.hpp> to use the features of this extension. ">GLM_GTC_ulp</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga2fcbb7bfbfc595712bfddc51b0715b07"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL genType glm::prev_float </td>
|
|
<td>(</td>
|
|
<td class="paramtype">genType const & </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>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00173.html" title="Include <glm/gtc/ulp.hpp> to use the features of this extension. ">GLM_GTC_ulp</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaa399d5b6472a70e8952f9b26ecaacdec"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLM_FUNC_DECL genType glm::prev_float </td>
|
|
<td>(</td>
|
|
<td class="paramtype">genType const & </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="a00150.html#ga91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> const & </td>
|
|
<td class="paramname"><em>Distance</em> </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>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00173.html" title="Include <glm/gtc/ulp.hpp> to use the features of this extension. ">GLM_GTC_ulp</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- 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.10
|
|
</small></address>
|
|
</body>
|
|
</html>
|