mirror of
https://github.com/g-truc/glm.git
synced 2024-12-01 12:14:35 +00:00
297 lines
13 KiB
HTML
297 lines
13 KiB
HTML
|
<!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_scalar_relational</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_scalar_relational<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:ga90ebafeace352ccc14055418ebd220be"><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
||
|
|
<tr class="memitem:ga90ebafeace352ccc14055418ebd220be"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL GLM_CONSTEXPR bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00863.html#ga90ebafeace352ccc14055418ebd220be">equal</a> (genType const &x, genType const &y, genType const &epsilon)</td></tr>
|
||
|
|
<tr class="memdesc:ga90ebafeace352ccc14055418ebd220be"><td class="mdescLeft"> </td><td class="mdescRight">Returns the component-wise comparison of |x - y| < epsilon. <a href="a00863.html#ga90ebafeace352ccc14055418ebd220be">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:ga90ebafeace352ccc14055418ebd220be"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ga865b9a427c42df73b8af9cd3f7f25394"><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
||
|
|
<tr class="memitem:ga865b9a427c42df73b8af9cd3f7f25394"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL GLM_CONSTEXPR bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00863.html#ga865b9a427c42df73b8af9cd3f7f25394">equal</a> (genType const &x, genType const &y, int ULPs)</td></tr>
|
||
|
|
<tr class="memdesc:ga865b9a427c42df73b8af9cd3f7f25394"><td class="mdescLeft"> </td><td class="mdescRight">Returns the component-wise comparison between two scalars in term of ULPs. <a href="a00863.html#ga865b9a427c42df73b8af9cd3f7f25394">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:ga865b9a427c42df73b8af9cd3f7f25394"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ga835ecf946c74f3d68be93e70b10821e7"><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
||
|
|
<tr class="memitem:ga835ecf946c74f3d68be93e70b10821e7"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL GLM_CONSTEXPR bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00863.html#ga835ecf946c74f3d68be93e70b10821e7">notEqual</a> (genType const &x, genType const &y, genType const &epsilon)</td></tr>
|
||
|
|
<tr class="memdesc:ga835ecf946c74f3d68be93e70b10821e7"><td class="mdescLeft"> </td><td class="mdescRight">Returns the component-wise comparison of |x - y| >= epsilon. <a href="a00863.html#ga835ecf946c74f3d68be93e70b10821e7">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:ga835ecf946c74f3d68be93e70b10821e7"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:gabd21e65b2e4c9d501d51536c4a6ef7cb"><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
||
|
|
<tr class="memitem:gabd21e65b2e4c9d501d51536c4a6ef7cb"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL GLM_CONSTEXPR bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00863.html#gabd21e65b2e4c9d501d51536c4a6ef7cb">notEqual</a> (genType const &x, genType const &y, int ULPs)</td></tr>
|
||
|
|
<tr class="memdesc:gabd21e65b2e4c9d501d51536c4a6ef7cb"><td class="mdescLeft"> </td><td class="mdescRight">Returns the component-wise comparison between two scalars in term of ULPs. <a href="a00863.html#gabd21e65b2e4c9d501d51536c4a6ef7cb">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:gabd21e65b2e4c9d501d51536c4a6ef7cb"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table>
|
||
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||
|
|
<p>Exposes comparison functions for scalar types that take a user defined epsilon values.</p>
|
||
|
|
<p>Include <<a class="el" href="a01594.html" title="GLM_EXT_scalar_relational">glm/ext/scalar_relational.hpp</a>> to use the features of this extension.</p>
|
||
|
|
<dl class="section see"><dt>See also</dt><dd>core_vector_relational </dd>
|
||
|
|
<dd>
|
||
|
|
<a class="el" href="a00881.html">GLM_EXT_vector_relational</a> </dd>
|
||
|
|
<dd>
|
||
|
|
<a class="el" href="a00827.html">GLM_EXT_matrix_relational</a> </dd></dl>
|
||
|
|
<h2 class="groupheader">Function Documentation</h2>
|
||
|
|
<a id="ga90ebafeace352ccc14055418ebd220be"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga90ebafeace352ccc14055418ebd220be">◆ </a></span>equal() <span class="overload">[1/2]</span></h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">GLM_FUNC_DECL GLM_CONSTEXPR bool glm::equal </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">genType const & </td>
|
||
|
|
<td class="paramname"><em>y</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">genType const & </td>
|
||
|
|
<td class="paramname"><em>epsilon</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Returns the component-wise comparison of |x - y| < epsilon. </p>
|
||
|
|
<p>True if this expression is satisfied.</p>
|
||
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
||
|
|
<table class="tparams">
|
||
|
|
<tr><td class="paramname">genType</td><td>Floating-point or integer scalar types </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="ga865b9a427c42df73b8af9cd3f7f25394"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga865b9a427c42df73b8af9cd3f7f25394">◆ </a></span>equal() <span class="overload">[2/2]</span></h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">GLM_FUNC_DECL GLM_CONSTEXPR bool glm::equal </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">genType const & </td>
|
||
|
|
<td class="paramname"><em>y</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>Returns the component-wise comparison between two scalars in term of ULPs. </p>
|
||
|
|
<p>True if this expression is satisfied.</p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">x</td><td>First operand. </td></tr>
|
||
|
|
<tr><td class="paramname">y</td><td>Second operand. </td></tr>
|
||
|
|
<tr><td class="paramname">ULPs</td><td>Maximum difference in ULPs between the two operators to consider them equal.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
||
|
|
<table class="tparams">
|
||
|
|
<tr><td class="paramname">genType</td><td>Floating-point or integer scalar types </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="ga835ecf946c74f3d68be93e70b10821e7"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga835ecf946c74f3d68be93e70b10821e7">◆ </a></span>notEqual() <span class="overload">[1/2]</span></h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">GLM_FUNC_DECL GLM_CONSTEXPR bool glm::notEqual </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">genType const & </td>
|
||
|
|
<td class="paramname"><em>y</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">genType const & </td>
|
||
|
|
<td class="paramname"><em>epsilon</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Returns the component-wise comparison of |x - y| >= epsilon. </p>
|
||
|
|
<p>True if this expression is not satisfied.</p>
|
||
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
||
|
|
<table class="tparams">
|
||
|
|
<tr><td class="paramname">genType</td><td>Floating-point or integer scalar types </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="gabd21e65b2e4c9d501d51536c4a6ef7cb"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gabd21e65b2e4c9d501d51536c4a6ef7cb">◆ </a></span>notEqual() <span class="overload">[2/2]</span></h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">GLM_FUNC_DECL GLM_CONSTEXPR bool glm::notEqual </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">genType const & </td>
|
||
|
|
<td class="paramname"><em>y</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>Returns the component-wise comparison between two scalars in term of ULPs. </p>
|
||
|
|
<p>True if this expression is not satisfied.</p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">x</td><td>First operand. </td></tr>
|
||
|
|
<tr><td class="paramname">y</td><td>Second operand. </td></tr>
|
||
|
|
<tr><td class="paramname">ULPs</td><td>Maximum difference in ULPs between the two operators to consider them not equal.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
||
|
|
<table class="tparams">
|
||
|
|
<tr><td class="paramname">genType</td><td>Floating-point or integer scalar types </td></tr>
|
||
|
|
</table>
|
||
|
|
</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>
|