a00874.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302
  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_ulp</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_ulp<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:ga4b76118ff56adfbc41a5925908b48606"><td class="memItemLeft" align="right" valign="top">GLM_FUNC_DECL <a class="el" href="a00868.html#gaff5189f97f9e842d9636a0f240001b2e">int64</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00874.html#ga4b76118ff56adfbc41a5925908b48606">floatDistance</a> (double x, double y)</td></tr>
  73. <tr class="memdesc:ga4b76118ff56adfbc41a5925908b48606"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the distance in the number of ULP between 2 double-precision floating-point scalars. <a href="a00874.html#ga4b76118ff56adfbc41a5925908b48606">More...</a><br /></td></tr>
  74. <tr class="separator:ga4b76118ff56adfbc41a5925908b48606"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75. <tr class="memitem:gae609a2729cacccbabe966221d61e0dc4"><td class="memItemLeft" align="right" valign="top">GLM_FUNC_DECL int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00874.html#gae609a2729cacccbabe966221d61e0dc4">floatDistance</a> (float x, float y)</td></tr>
  76. <tr class="memdesc:gae609a2729cacccbabe966221d61e0dc4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the distance in the number of ULP between 2 single-precision floating-point scalars. <a href="a00874.html#gae609a2729cacccbabe966221d61e0dc4">More...</a><br /></td></tr>
  77. <tr class="separator:gae609a2729cacccbabe966221d61e0dc4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:ga30bc0280e7cefd159867b1aa5050b94a"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  79. <tr class="memitem:ga30bc0280e7cefd159867b1aa5050b94a"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00874.html#ga30bc0280e7cefd159867b1aa5050b94a">nextFloat</a> (genType x)</td></tr>
  80. <tr class="memdesc:ga30bc0280e7cefd159867b1aa5050b94a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the next ULP value(s) after the input value(s). <a href="a00874.html#ga30bc0280e7cefd159867b1aa5050b94a">More...</a><br /></td></tr>
  81. <tr class="separator:ga30bc0280e7cefd159867b1aa5050b94a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:ga54eb5916c5250c8f0ad8224fb8e0d392"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  83. <tr class="memitem:ga54eb5916c5250c8f0ad8224fb8e0d392"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00874.html#ga54eb5916c5250c8f0ad8224fb8e0d392">nextFloat</a> (genType x, int ULPs)</td></tr>
  84. <tr class="memdesc:ga54eb5916c5250c8f0ad8224fb8e0d392"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the value(s) ULP distance after the input value(s). <a href="a00874.html#ga54eb5916c5250c8f0ad8224fb8e0d392">More...</a><br /></td></tr>
  85. <tr class="separator:ga54eb5916c5250c8f0ad8224fb8e0d392"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:ga25320ace5b3e239405077912eb4e7bf9"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  87. <tr class="memitem:ga25320ace5b3e239405077912eb4e7bf9"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00874.html#ga25320ace5b3e239405077912eb4e7bf9">prevFloat</a> (genType x)</td></tr>
  88. <tr class="memdesc:ga25320ace5b3e239405077912eb4e7bf9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the previous ULP value(s) before the input value(s). <a href="a00874.html#ga25320ace5b3e239405077912eb4e7bf9">More...</a><br /></td></tr>
  89. <tr class="separator:ga25320ace5b3e239405077912eb4e7bf9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:ga760b98a221f1f511edbcdf0b06c49841"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  91. <tr class="memitem:ga760b98a221f1f511edbcdf0b06c49841"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00874.html#ga760b98a221f1f511edbcdf0b06c49841">prevFloat</a> (genType x, int ULPs)</td></tr>
  92. <tr class="memdesc:ga760b98a221f1f511edbcdf0b06c49841"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the value(s) ULP distance before the input value(s). <a href="a00874.html#ga760b98a221f1f511edbcdf0b06c49841">More...</a><br /></td></tr>
  93. <tr class="separator:ga760b98a221f1f511edbcdf0b06c49841"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. </table>
  95. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  96. <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>
  97. <p>Include &lt;<a class="el" href="a00380.html" title="GLM_EXT_scalar_ulp">glm/ext/scalar_ulp.hpp</a>&gt; to use the features of this extension.</p>
  98. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00896.html">GLM_EXT_vector_ulp</a> </dd>
  99. <dd>
  100. <a class="el" href="a00872.html">GLM_EXT_scalar_relational</a> </dd></dl>
  101. <h2 class="groupheader">Function Documentation</h2>
  102. <a id="ga4b76118ff56adfbc41a5925908b48606"></a>
  103. <h2 class="memtitle"><span class="permalink"><a href="#ga4b76118ff56adfbc41a5925908b48606">&#9670;&nbsp;</a></span>floatDistance() <span class="overload">[1/2]</span></h2>
  104. <div class="memitem">
  105. <div class="memproto">
  106. <table class="memname">
  107. <tr>
  108. <td class="memname">GLM_FUNC_DECL <a class="el" href="a00868.html#gaff5189f97f9e842d9636a0f240001b2e">int64</a> glm::floatDistance </td>
  109. <td>(</td>
  110. <td class="paramtype">double&#160;</td>
  111. <td class="paramname"><em>x</em>, </td>
  112. </tr>
  113. <tr>
  114. <td class="paramkey"></td>
  115. <td></td>
  116. <td class="paramtype">double&#160;</td>
  117. <td class="paramname"><em>y</em>&#160;</td>
  118. </tr>
  119. <tr>
  120. <td></td>
  121. <td>)</td>
  122. <td></td><td></td>
  123. </tr>
  124. </table>
  125. </div><div class="memdoc">
  126. <p>Return the distance in the number of ULP between 2 double-precision floating-point scalars. </p>
  127. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00874.html">GLM_EXT_scalar_ulp</a> </dd></dl>
  128. </div>
  129. </div>
  130. <a id="gae609a2729cacccbabe966221d61e0dc4"></a>
  131. <h2 class="memtitle"><span class="permalink"><a href="#gae609a2729cacccbabe966221d61e0dc4">&#9670;&nbsp;</a></span>floatDistance() <span class="overload">[2/2]</span></h2>
  132. <div class="memitem">
  133. <div class="memproto">
  134. <table class="memname">
  135. <tr>
  136. <td class="memname">GLM_FUNC_DECL int glm::floatDistance </td>
  137. <td>(</td>
  138. <td class="paramtype">float&#160;</td>
  139. <td class="paramname"><em>x</em>, </td>
  140. </tr>
  141. <tr>
  142. <td class="paramkey"></td>
  143. <td></td>
  144. <td class="paramtype">float&#160;</td>
  145. <td class="paramname"><em>y</em>&#160;</td>
  146. </tr>
  147. <tr>
  148. <td></td>
  149. <td>)</td>
  150. <td></td><td></td>
  151. </tr>
  152. </table>
  153. </div><div class="memdoc">
  154. <p>Return the distance in the number of ULP between 2 single-precision floating-point scalars. </p>
  155. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00874.html">GLM_EXT_scalar_ulp</a> </dd></dl>
  156. </div>
  157. </div>
  158. <a id="ga30bc0280e7cefd159867b1aa5050b94a"></a>
  159. <h2 class="memtitle"><span class="permalink"><a href="#ga30bc0280e7cefd159867b1aa5050b94a">&#9670;&nbsp;</a></span>nextFloat() <span class="overload">[1/2]</span></h2>
  160. <div class="memitem">
  161. <div class="memproto">
  162. <table class="memname">
  163. <tr>
  164. <td class="memname">GLM_FUNC_DECL genType glm::nextFloat </td>
  165. <td>(</td>
  166. <td class="paramtype">genType&#160;</td>
  167. <td class="paramname"><em>x</em></td><td>)</td>
  168. <td></td>
  169. </tr>
  170. </table>
  171. </div><div class="memdoc">
  172. <p>Return the next ULP value(s) after the input value(s). </p>
  173. <dl class="tparams"><dt>Template Parameters</dt><dd>
  174. <table class="tparams">
  175. <tr><td class="paramname">genType</td><td>A floating-point scalar type.</td></tr>
  176. </table>
  177. </dd>
  178. </dl>
  179. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00874.html">GLM_EXT_scalar_ulp</a> </dd></dl>
  180. </div>
  181. </div>
  182. <a id="ga54eb5916c5250c8f0ad8224fb8e0d392"></a>
  183. <h2 class="memtitle"><span class="permalink"><a href="#ga54eb5916c5250c8f0ad8224fb8e0d392">&#9670;&nbsp;</a></span>nextFloat() <span class="overload">[2/2]</span></h2>
  184. <div class="memitem">
  185. <div class="memproto">
  186. <table class="memname">
  187. <tr>
  188. <td class="memname">GLM_FUNC_DECL genType glm::nextFloat </td>
  189. <td>(</td>
  190. <td class="paramtype">genType&#160;</td>
  191. <td class="paramname"><em>x</em>, </td>
  192. </tr>
  193. <tr>
  194. <td class="paramkey"></td>
  195. <td></td>
  196. <td class="paramtype">int&#160;</td>
  197. <td class="paramname"><em>ULPs</em>&#160;</td>
  198. </tr>
  199. <tr>
  200. <td></td>
  201. <td>)</td>
  202. <td></td><td></td>
  203. </tr>
  204. </table>
  205. </div><div class="memdoc">
  206. <p>Return the value(s) ULP distance after the input value(s). </p>
  207. <dl class="tparams"><dt>Template Parameters</dt><dd>
  208. <table class="tparams">
  209. <tr><td class="paramname">genType</td><td>A floating-point scalar type.</td></tr>
  210. </table>
  211. </dd>
  212. </dl>
  213. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00874.html">GLM_EXT_scalar_ulp</a> </dd></dl>
  214. </div>
  215. </div>
  216. <a id="ga25320ace5b3e239405077912eb4e7bf9"></a>
  217. <h2 class="memtitle"><span class="permalink"><a href="#ga25320ace5b3e239405077912eb4e7bf9">&#9670;&nbsp;</a></span>prevFloat() <span class="overload">[1/2]</span></h2>
  218. <div class="memitem">
  219. <div class="memproto">
  220. <table class="memname">
  221. <tr>
  222. <td class="memname">GLM_FUNC_DECL genType glm::prevFloat </td>
  223. <td>(</td>
  224. <td class="paramtype">genType&#160;</td>
  225. <td class="paramname"><em>x</em></td><td>)</td>
  226. <td></td>
  227. </tr>
  228. </table>
  229. </div><div class="memdoc">
  230. <p>Return the previous ULP value(s) before the input value(s). </p>
  231. <dl class="tparams"><dt>Template Parameters</dt><dd>
  232. <table class="tparams">
  233. <tr><td class="paramname">genType</td><td>A floating-point scalar type.</td></tr>
  234. </table>
  235. </dd>
  236. </dl>
  237. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00874.html">GLM_EXT_scalar_ulp</a> </dd></dl>
  238. </div>
  239. </div>
  240. <a id="ga760b98a221f1f511edbcdf0b06c49841"></a>
  241. <h2 class="memtitle"><span class="permalink"><a href="#ga760b98a221f1f511edbcdf0b06c49841">&#9670;&nbsp;</a></span>prevFloat() <span class="overload">[2/2]</span></h2>
  242. <div class="memitem">
  243. <div class="memproto">
  244. <table class="memname">
  245. <tr>
  246. <td class="memname">GLM_FUNC_DECL genType glm::prevFloat </td>
  247. <td>(</td>
  248. <td class="paramtype">genType&#160;</td>
  249. <td class="paramname"><em>x</em>, </td>
  250. </tr>
  251. <tr>
  252. <td class="paramkey"></td>
  253. <td></td>
  254. <td class="paramtype">int&#160;</td>
  255. <td class="paramname"><em>ULPs</em>&#160;</td>
  256. </tr>
  257. <tr>
  258. <td></td>
  259. <td>)</td>
  260. <td></td><td></td>
  261. </tr>
  262. </table>
  263. </div><div class="memdoc">
  264. <p>Return the value(s) ULP distance before the input value(s). </p>
  265. <dl class="tparams"><dt>Template Parameters</dt><dd>
  266. <table class="tparams">
  267. <tr><td class="paramname">genType</td><td>A floating-point scalar type.</td></tr>
  268. </table>
  269. </dd>
  270. </dl>
  271. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00874.html">GLM_EXT_scalar_ulp</a> </dd></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>