<!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: GLM_EXT_vector_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>
<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>
</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_EXT_vector_ulp<div class="ingroups"><a class="el" href="a00894.html">Stable extensions</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:gabe2040cbbe66a60cafb37f6155f78e4c"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr>
<tr class="memitem:gabe2040cbbe66a60cafb37f6155f78e4c"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, <a class="el" href="a00859.html#gaff5189f97f9e842d9636a0f240001b2e">int64</a>, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00887.html#gabe2040cbbe66a60cafb37f6155f78e4c">floatDistance</a> (vec< L, double, Q > const &x, vec< L, double, Q > const &y)</td></tr>
<tr class="memdesc:gabe2040cbbe66a60cafb37f6155f78e4c"><td class="mdescLeft"> </td><td class="mdescRight">Return the distance in the number of ULP between 2 double-precision floating-point scalars. <a href="a00887.html#gabe2040cbbe66a60cafb37f6155f78e4c">More...</a><br /></td></tr>
<tr class="separator:gabe2040cbbe66a60cafb37f6155f78e4c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga03f464c6a03a725ea18e72cf1ed31417"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr>
<tr class="memitem:ga03f464c6a03a725ea18e72cf1ed31417"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, int, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00887.html#ga03f464c6a03a725ea18e72cf1ed31417">floatDistance</a> (vec< L, float, Q > const &x, vec< L, float, Q > const &y)</td></tr>
<tr class="memdesc:ga03f464c6a03a725ea18e72cf1ed31417"><td class="mdescLeft"> </td><td class="mdescRight">Return the distance in the number of ULP between 2 single-precision floating-point scalars. <a href="a00887.html#ga03f464c6a03a725ea18e72cf1ed31417">More...</a><br /></td></tr>
<tr class="separator:ga03f464c6a03a725ea18e72cf1ed31417"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadbd6e5dff9c0ae4567b3edd9019c1bee"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr>
<tr class="memitem:gadbd6e5dff9c0ae4567b3edd9019c1bee"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00887.html#gadbd6e5dff9c0ae4567b3edd9019c1bee">nextFloat</a> (vec< L, T, Q > const &x)</td></tr>
<tr class="memdesc:gadbd6e5dff9c0ae4567b3edd9019c1bee"><td class="mdescLeft"> </td><td class="mdescRight">Return the next ULP value(s) after the input value(s). <a href="a00887.html#gadbd6e5dff9c0ae4567b3edd9019c1bee">More...</a><br /></td></tr>
<tr class="separator:gadbd6e5dff9c0ae4567b3edd9019c1bee"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga92f82c4f45b5b43ccc29533990db079d"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr>
<tr class="memitem:ga92f82c4f45b5b43ccc29533990db079d"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00887.html#ga92f82c4f45b5b43ccc29533990db079d">nextFloat</a> (vec< L, T, Q > const &x, int ULPs)</td></tr>
<tr class="memdesc:ga92f82c4f45b5b43ccc29533990db079d"><td class="mdescLeft"> </td><td class="mdescRight">Return the value(s) ULP distance after the input value(s). <a href="a00887.html#ga92f82c4f45b5b43ccc29533990db079d">More...</a><br /></td></tr>
<tr class="separator:ga92f82c4f45b5b43ccc29533990db079d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga48e9b73c50fcf589e0032b8dbed9a3f9"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr>
<tr class="memitem:ga48e9b73c50fcf589e0032b8dbed9a3f9"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00887.html#ga48e9b73c50fcf589e0032b8dbed9a3f9">nextFloat</a> (vec< L, T, Q > const &x, vec< L, int, Q > const &ULPs)</td></tr>
<tr class="memdesc:ga48e9b73c50fcf589e0032b8dbed9a3f9"><td class="mdescLeft"> </td><td class="mdescRight">Return the value(s) ULP distance after the input value(s). <a href="a00887.html#ga48e9b73c50fcf589e0032b8dbed9a3f9">More...</a><br /></td></tr>
<tr class="separator:ga48e9b73c50fcf589e0032b8dbed9a3f9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga82d4ce132256c1a70d0e7100e6eae2e1"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr>
<tr class="memitem:ga82d4ce132256c1a70d0e7100e6eae2e1"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00887.html#ga82d4ce132256c1a70d0e7100e6eae2e1">prevFloat</a> (vec< L, T, Q > const &x)</td></tr>
<tr class="memdesc:ga82d4ce132256c1a70d0e7100e6eae2e1"><td class="mdescLeft"> </td><td class="mdescRight">Return the previous ULP value(s) before the input value(s). <a href="a00887.html#ga82d4ce132256c1a70d0e7100e6eae2e1">More...</a><br /></td></tr>
<tr class="separator:ga82d4ce132256c1a70d0e7100e6eae2e1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4ab818050036d40994346defe41a05b9"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr>
<tr class="memitem:ga4ab818050036d40994346defe41a05b9"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00887.html#ga4ab818050036d40994346defe41a05b9">prevFloat</a> (vec< L, T, Q > const &x, int ULPs)</td></tr>
<tr class="memdesc:ga4ab818050036d40994346defe41a05b9"><td class="mdescLeft"> </td><td class="mdescRight">Return the value(s) ULP distance before the input value(s). <a href="a00887.html#ga4ab818050036d40994346defe41a05b9">More...</a><br /></td></tr>
<tr class="separator:ga4ab818050036d40994346defe41a05b9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga569e3ce6771e1e4f9e425ec6d859d9f9"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier Q> </td></tr>
<tr class="memitem:ga569e3ce6771e1e4f9e425ec6d859d9f9"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, Q > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00887.html#ga569e3ce6771e1e4f9e425ec6d859d9f9">prevFloat</a> (vec< L, T, Q > const &x, vec< L, int, Q > const &ULPs)</td></tr>
<tr class="memdesc:ga569e3ce6771e1e4f9e425ec6d859d9f9"><td class="mdescLeft"> </td><td class="mdescRight">Return the value(s) ULP distance before the input value(s). <a href="a00887.html#ga569e3ce6771e1e4f9e425ec6d859d9f9">More...</a><br /></td></tr>
<tr class="separator:ga569e3ce6771e1e4f9e425ec6d859d9f9"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<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>
<p>Include <<a class="el" href="a00515.html" title="GLM_EXT_vector_ulp">glm/ext/vector_ulp.hpp</a>> to use the features of this extension.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00865.html">GLM_EXT_scalar_ulp</a> </dd>
<dd>
<a class="el" href="a00863.html">GLM_EXT_scalar_relational</a> </dd>
<dd>
<a class="el" href="a00881.html">GLM_EXT_vector_relational</a> </dd></dl>
<h2 class="groupheader">Function Documentation</h2>
<a id="gabe2040cbbe66a60cafb37f6155f78e4c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabe2040cbbe66a60cafb37f6155f78e4c">◆ </a></span>floatDistance() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL vec<L, <a class="el" href="a00859.html#gaff5189f97f9e842d9636a0f240001b2e">int64</a>, Q> glm::floatDistance </td>
<td>(</td>
<td class="paramtype">vec< L, double, Q > const & </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vec< L, double, 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 double-precision floating-point scalars. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
<tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00865.html">GLM_EXT_scalar_ulp</a> </dd></dl>
</div>
</div>
<a id="ga03f464c6a03a725ea18e72cf1ed31417"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga03f464c6a03a725ea18e72cf1ed31417">◆ </a></span>floatDistance() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL vec<L, int, Q> glm::floatDistance </td>
<td>(</td>
<td class="paramtype">vec< L, float, Q > const & </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vec< L, float, 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 single-precision floating-point scalars. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
<tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00865.html">GLM_EXT_scalar_ulp</a> </dd></dl>
</div>
</div>
<a id="gadbd6e5dff9c0ae4567b3edd9019c1bee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadbd6e5dff9c0ae4567b3edd9019c1bee">◆ </a></span>nextFloat() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL vec<L, T, Q> glm::nextFloat </td>
<td>(</td>
<td class="paramtype">vec< L, T, Q > 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="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
<tr><td class="paramname">T</td><td>Floating-point </td></tr>
<tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00865.html">GLM_EXT_scalar_ulp</a> </dd></dl>
</div>
</div>
<a id="ga92f82c4f45b5b43ccc29533990db079d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga92f82c4f45b5b43ccc29533990db079d">◆ </a></span>nextFloat() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL vec<L, T, Q> glm::nextFloat </td>
<td>(</td>
<td class="paramtype">vec< L, T, Q > const & </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>ULPs</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="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
<tr><td class="paramname">T</td><td>Floating-point </td></tr>
<tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00865.html">GLM_EXT_scalar_ulp</a> </dd></dl>
</div>
</div>
<a id="ga48e9b73c50fcf589e0032b8dbed9a3f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga48e9b73c50fcf589e0032b8dbed9a3f9">◆ </a></span>nextFloat() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL vec<L, T, Q> glm::nextFloat </td>
<td>(</td>
<td class="paramtype">vec< L, T, Q > const & </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vec< L, int, Q > const & </td>
<td class="paramname"><em>ULPs</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="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
<tr><td class="paramname">T</td><td>Floating-point </td></tr>
<tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00865.html">GLM_EXT_scalar_ulp</a> </dd></dl>
</div>
</div>
<a id="ga82d4ce132256c1a70d0e7100e6eae2e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga82d4ce132256c1a70d0e7100e6eae2e1">◆ </a></span>prevFloat() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL vec<L, T, Q> glm::prevFloat </td>
<td>(</td>
<td class="paramtype">vec< L, T, Q > 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="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
<tr><td class="paramname">T</td><td>Floating-point </td></tr>
<tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00865.html">GLM_EXT_scalar_ulp</a> </dd></dl>
</div>
</div>
<a id="ga4ab818050036d40994346defe41a05b9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4ab818050036d40994346defe41a05b9">◆ </a></span>prevFloat() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL vec<L, T, Q> glm::prevFloat </td>
<td>(</td>
<td class="paramtype">vec< L, T, Q > const & </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>ULPs</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="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
<tr><td class="paramname">T</td><td>Floating-point </td></tr>
<tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00865.html">GLM_EXT_scalar_ulp</a> </dd></dl>
</div>
</div>
<a id="ga569e3ce6771e1e4f9e425ec6d859d9f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga569e3ce6771e1e4f9e425ec6d859d9f9">◆ </a></span>prevFloat() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL vec<L, T, Q> glm::prevFloat </td>
<td>(</td>
<td class="paramtype">vec< L, T, Q > const & </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vec< L, int, Q > const & </td>
<td class="paramname"><em>ULPs</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="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">L</td><td>Integer between 1 and 4 included that qualify the dimension of the vector </td></tr>
<tr><td class="paramname">T</td><td>Floating-point </td></tr>
<tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00865.html">GLM_EXT_scalar_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.18
</small></address>
</body>
</html>