a00872.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.18"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>1.0.2 API documentation: GLM_EXT_scalar_relational</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
  24. <td id="projectalign" style="padding-left: 0.5em;">
  25. <div id="projectname">1.0.2 API documentation
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.18 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */</script>
  48. <div id="main-nav"></div>
  49. </div><!-- top -->
  50. <!-- window showing the filter options -->
  51. <div id="MSearchSelectWindow"
  52. onmouseover="return searchBox.OnSearchSelectShow()"
  53. onmouseout="return searchBox.OnSearchSelectHide()"
  54. onkeydown="return searchBox.OnSearchSelectKey(event)">
  55. </div>
  56. <!-- iframe showing the search results (closed by default) -->
  57. <div id="MSearchResultsWindow">
  58. <iframe src="javascript:void(0)" frameborder="0"
  59. name="MSearchResults" id="MSearchResults">
  60. </iframe>
  61. </div>
  62. <div class="header">
  63. <div class="summary">
  64. <a href="#func-members">Functions</a> </div>
  65. <div class="headertitle">
  66. <div class="title">GLM_EXT_scalar_relational<div class="ingroups"><a class="el" href="a00903.html">Stable extensions</a></div></div> </div>
  67. </div><!--header-->
  68. <div class="contents">
  69. <table class="memberdecls">
  70. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  71. Functions</h2></td></tr>
  72. <tr class="memitem:ga90ebafeace352ccc14055418ebd220be"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  73. <tr class="memitem:ga90ebafeace352ccc14055418ebd220be"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL GLM_CONSTEXPR bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00872.html#ga90ebafeace352ccc14055418ebd220be">equal</a> (genType const &amp;x, genType const &amp;y, genType const &amp;epsilon)</td></tr>
  74. <tr class="memdesc:ga90ebafeace352ccc14055418ebd220be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the component-wise comparison of |x - y| &lt; epsilon. <a href="a00872.html#ga90ebafeace352ccc14055418ebd220be">More...</a><br /></td></tr>
  75. <tr class="separator:ga90ebafeace352ccc14055418ebd220be"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <tr class="memitem:ga865b9a427c42df73b8af9cd3f7f25394"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  77. <tr class="memitem:ga865b9a427c42df73b8af9cd3f7f25394"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL GLM_CONSTEXPR bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00872.html#ga865b9a427c42df73b8af9cd3f7f25394">equal</a> (genType const &amp;x, genType const &amp;y, int ULPs)</td></tr>
  78. <tr class="memdesc:ga865b9a427c42df73b8af9cd3f7f25394"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the component-wise comparison between two scalars in term of ULPs. <a href="a00872.html#ga865b9a427c42df73b8af9cd3f7f25394">More...</a><br /></td></tr>
  79. <tr class="separator:ga865b9a427c42df73b8af9cd3f7f25394"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:ga835ecf946c74f3d68be93e70b10821e7"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  81. <tr class="memitem:ga835ecf946c74f3d68be93e70b10821e7"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL GLM_CONSTEXPR bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00872.html#ga835ecf946c74f3d68be93e70b10821e7">notEqual</a> (genType const &amp;x, genType const &amp;y, genType const &amp;epsilon)</td></tr>
  82. <tr class="memdesc:ga835ecf946c74f3d68be93e70b10821e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the component-wise comparison of |x - y| &gt;= epsilon. <a href="a00872.html#ga835ecf946c74f3d68be93e70b10821e7">More...</a><br /></td></tr>
  83. <tr class="separator:ga835ecf946c74f3d68be93e70b10821e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:gabd21e65b2e4c9d501d51536c4a6ef7cb"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  85. <tr class="memitem:gabd21e65b2e4c9d501d51536c4a6ef7cb"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL GLM_CONSTEXPR bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00872.html#gabd21e65b2e4c9d501d51536c4a6ef7cb">notEqual</a> (genType const &amp;x, genType const &amp;y, int ULPs)</td></tr>
  86. <tr class="memdesc:gabd21e65b2e4c9d501d51536c4a6ef7cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the component-wise comparison between two scalars in term of ULPs. <a href="a00872.html#gabd21e65b2e4c9d501d51536c4a6ef7cb">More...</a><br /></td></tr>
  87. <tr class="separator:gabd21e65b2e4c9d501d51536c4a6ef7cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. </table>
  89. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  90. <p>Exposes comparison functions for scalar types that take a user defined epsilon values.</p>
  91. <p>Include &lt;<a class="el" href="a01717.html" title="GLM_EXT_scalar_relational">glm/ext/scalar_relational.hpp</a>&gt; to use the features of this extension.</p>
  92. <dl class="section see"><dt>See also</dt><dd>core_vector_relational </dd>
  93. <dd>
  94. <a class="el" href="a00890.html">GLM_EXT_vector_relational</a> </dd>
  95. <dd>
  96. <a class="el" href="a00836.html">GLM_EXT_matrix_relational</a> </dd></dl>
  97. <h2 class="groupheader">Function Documentation</h2>
  98. <a id="ga90ebafeace352ccc14055418ebd220be"></a>
  99. <h2 class="memtitle"><span class="permalink"><a href="#ga90ebafeace352ccc14055418ebd220be">&#9670;&nbsp;</a></span>equal() <span class="overload">[1/2]</span></h2>
  100. <div class="memitem">
  101. <div class="memproto">
  102. <table class="memname">
  103. <tr>
  104. <td class="memname">GLM_FUNC_DECL GLM_CONSTEXPR bool glm::equal </td>
  105. <td>(</td>
  106. <td class="paramtype">genType const &amp;&#160;</td>
  107. <td class="paramname"><em>x</em>, </td>
  108. </tr>
  109. <tr>
  110. <td class="paramkey"></td>
  111. <td></td>
  112. <td class="paramtype">genType const &amp;&#160;</td>
  113. <td class="paramname"><em>y</em>, </td>
  114. </tr>
  115. <tr>
  116. <td class="paramkey"></td>
  117. <td></td>
  118. <td class="paramtype">genType const &amp;&#160;</td>
  119. <td class="paramname"><em>epsilon</em>&#160;</td>
  120. </tr>
  121. <tr>
  122. <td></td>
  123. <td>)</td>
  124. <td></td><td></td>
  125. </tr>
  126. </table>
  127. </div><div class="memdoc">
  128. <p>Returns the component-wise comparison of |x - y| &lt; epsilon. </p>
  129. <p>True if this expression is satisfied.</p>
  130. <dl class="tparams"><dt>Template Parameters</dt><dd>
  131. <table class="tparams">
  132. <tr><td class="paramname">genType</td><td>Floating-point or integer scalar types </td></tr>
  133. </table>
  134. </dd>
  135. </dl>
  136. </div>
  137. </div>
  138. <a id="ga865b9a427c42df73b8af9cd3f7f25394"></a>
  139. <h2 class="memtitle"><span class="permalink"><a href="#ga865b9a427c42df73b8af9cd3f7f25394">&#9670;&nbsp;</a></span>equal() <span class="overload">[2/2]</span></h2>
  140. <div class="memitem">
  141. <div class="memproto">
  142. <table class="memname">
  143. <tr>
  144. <td class="memname">GLM_FUNC_DECL GLM_CONSTEXPR bool glm::equal </td>
  145. <td>(</td>
  146. <td class="paramtype">genType const &amp;&#160;</td>
  147. <td class="paramname"><em>x</em>, </td>
  148. </tr>
  149. <tr>
  150. <td class="paramkey"></td>
  151. <td></td>
  152. <td class="paramtype">genType const &amp;&#160;</td>
  153. <td class="paramname"><em>y</em>, </td>
  154. </tr>
  155. <tr>
  156. <td class="paramkey"></td>
  157. <td></td>
  158. <td class="paramtype">int&#160;</td>
  159. <td class="paramname"><em>ULPs</em>&#160;</td>
  160. </tr>
  161. <tr>
  162. <td></td>
  163. <td>)</td>
  164. <td></td><td></td>
  165. </tr>
  166. </table>
  167. </div><div class="memdoc">
  168. <p>Returns the component-wise comparison between two scalars in term of ULPs. </p>
  169. <p>True if this expression is satisfied.</p>
  170. <dl class="params"><dt>Parameters</dt><dd>
  171. <table class="params">
  172. <tr><td class="paramname">x</td><td>First operand. </td></tr>
  173. <tr><td class="paramname">y</td><td>Second operand. </td></tr>
  174. <tr><td class="paramname">ULPs</td><td>Maximum difference in ULPs between the two operators to consider them equal.</td></tr>
  175. </table>
  176. </dd>
  177. </dl>
  178. <dl class="tparams"><dt>Template Parameters</dt><dd>
  179. <table class="tparams">
  180. <tr><td class="paramname">genType</td><td>Floating-point or integer scalar types </td></tr>
  181. </table>
  182. </dd>
  183. </dl>
  184. </div>
  185. </div>
  186. <a id="ga835ecf946c74f3d68be93e70b10821e7"></a>
  187. <h2 class="memtitle"><span class="permalink"><a href="#ga835ecf946c74f3d68be93e70b10821e7">&#9670;&nbsp;</a></span>notEqual() <span class="overload">[1/2]</span></h2>
  188. <div class="memitem">
  189. <div class="memproto">
  190. <table class="memname">
  191. <tr>
  192. <td class="memname">GLM_FUNC_DECL GLM_CONSTEXPR bool glm::notEqual </td>
  193. <td>(</td>
  194. <td class="paramtype">genType const &amp;&#160;</td>
  195. <td class="paramname"><em>x</em>, </td>
  196. </tr>
  197. <tr>
  198. <td class="paramkey"></td>
  199. <td></td>
  200. <td class="paramtype">genType const &amp;&#160;</td>
  201. <td class="paramname"><em>y</em>, </td>
  202. </tr>
  203. <tr>
  204. <td class="paramkey"></td>
  205. <td></td>
  206. <td class="paramtype">genType const &amp;&#160;</td>
  207. <td class="paramname"><em>epsilon</em>&#160;</td>
  208. </tr>
  209. <tr>
  210. <td></td>
  211. <td>)</td>
  212. <td></td><td></td>
  213. </tr>
  214. </table>
  215. </div><div class="memdoc">
  216. <p>Returns the component-wise comparison of |x - y| &gt;= epsilon. </p>
  217. <p>True if this expression is not satisfied.</p>
  218. <dl class="tparams"><dt>Template Parameters</dt><dd>
  219. <table class="tparams">
  220. <tr><td class="paramname">genType</td><td>Floating-point or integer scalar types </td></tr>
  221. </table>
  222. </dd>
  223. </dl>
  224. </div>
  225. </div>
  226. <a id="gabd21e65b2e4c9d501d51536c4a6ef7cb"></a>
  227. <h2 class="memtitle"><span class="permalink"><a href="#gabd21e65b2e4c9d501d51536c4a6ef7cb">&#9670;&nbsp;</a></span>notEqual() <span class="overload">[2/2]</span></h2>
  228. <div class="memitem">
  229. <div class="memproto">
  230. <table class="memname">
  231. <tr>
  232. <td class="memname">GLM_FUNC_DECL GLM_CONSTEXPR bool glm::notEqual </td>
  233. <td>(</td>
  234. <td class="paramtype">genType const &amp;&#160;</td>
  235. <td class="paramname"><em>x</em>, </td>
  236. </tr>
  237. <tr>
  238. <td class="paramkey"></td>
  239. <td></td>
  240. <td class="paramtype">genType const &amp;&#160;</td>
  241. <td class="paramname"><em>y</em>, </td>
  242. </tr>
  243. <tr>
  244. <td class="paramkey"></td>
  245. <td></td>
  246. <td class="paramtype">int&#160;</td>
  247. <td class="paramname"><em>ULPs</em>&#160;</td>
  248. </tr>
  249. <tr>
  250. <td></td>
  251. <td>)</td>
  252. <td></td><td></td>
  253. </tr>
  254. </table>
  255. </div><div class="memdoc">
  256. <p>Returns the component-wise comparison between two scalars in term of ULPs. </p>
  257. <p>True if this expression is not satisfied.</p>
  258. <dl class="params"><dt>Parameters</dt><dd>
  259. <table class="params">
  260. <tr><td class="paramname">x</td><td>First operand. </td></tr>
  261. <tr><td class="paramname">y</td><td>Second operand. </td></tr>
  262. <tr><td class="paramname">ULPs</td><td>Maximum difference in ULPs between the two operators to consider them not equal.</td></tr>
  263. </table>
  264. </dd>
  265. </dl>
  266. <dl class="tparams"><dt>Template Parameters</dt><dd>
  267. <table class="tparams">
  268. <tr><td class="paramname">genType</td><td>Floating-point or integer scalar types </td></tr>
  269. </table>
  270. </dd>
  271. </dl>
  272. </div>
  273. </div>
  274. </div><!-- contents -->
  275. <!-- start footer part -->
  276. <hr class="footer"/><address class="footer"><small>
  277. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  278. <img class="footer" src="doxygen.png" alt="doxygen"/>
  279. </a> 1.8.18
  280. </small></address>
  281. </body>
  282. </html>