a00181.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.10"/>
  7. <title>0.9.9 API documenation: GLM_GTC_ulp</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/searchdata.js"></script>
  13. <script type="text/javascript" src="search/search.js"></script>
  14. <script type="text/javascript">
  15. $(document).ready(function() { init_search(); });
  16. </script>
  17. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  18. </head>
  19. <body>
  20. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  21. <div id="titlearea">
  22. <table cellspacing="0" cellpadding="0">
  23. <tbody>
  24. <tr style="height: 56px;">
  25. <td id="projectalign" style="padding-left: 0.5em;">
  26. <div id="projectname">0.9.9 API documenation
  27. </div>
  28. </td>
  29. </tr>
  30. </tbody>
  31. </table>
  32. </div>
  33. <!-- end header part -->
  34. <!-- Generated by Doxygen 1.8.10 -->
  35. <script type="text/javascript">
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. </script>
  38. <div id="navrow1" class="tabs">
  39. <ul class="tablist">
  40. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  41. <li><a href="modules.html"><span>Modules</span></a></li>
  42. <li><a href="files.html"><span>Files</span></a></li>
  43. <li>
  44. <div id="MSearchBox" class="MSearchBoxInactive">
  45. <span class="left">
  46. <img id="MSearchSelect" src="search/mag_sel.png"
  47. onmouseover="return searchBox.OnSearchSelectShow()"
  48. onmouseout="return searchBox.OnSearchSelectHide()"
  49. alt=""/>
  50. <input type="text" id="MSearchField" value="Search" accesskey="S"
  51. onfocus="searchBox.OnSearchFieldFocus(true)"
  52. onblur="searchBox.OnSearchFieldFocus(false)"
  53. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  54. </span><span class="right">
  55. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  56. </span>
  57. </div>
  58. </li>
  59. </ul>
  60. </div>
  61. </div><!-- top -->
  62. <!-- window showing the filter options -->
  63. <div id="MSearchSelectWindow"
  64. onmouseover="return searchBox.OnSearchSelectShow()"
  65. onmouseout="return searchBox.OnSearchSelectHide()"
  66. onkeydown="return searchBox.OnSearchSelectKey(event)">
  67. </div>
  68. <!-- iframe showing the search results (closed by default) -->
  69. <div id="MSearchResultsWindow">
  70. <iframe src="javascript:void(0)" frameborder="0"
  71. name="MSearchResults" id="MSearchResults">
  72. </iframe>
  73. </div>
  74. <div class="header">
  75. <div class="summary">
  76. <a href="#func-members">Functions</a> </div>
  77. <div class="headertitle">
  78. <div class="title">GLM_GTC_ulp<div class="ingroups"><a class="el" href="a00156.html">GTC Extensions (Stable)</a></div></div> </div>
  79. </div><!--header-->
  80. <div class="contents">
  81. <p>Allow the measurement of the accuracy of a function against a reference implementation.
  82. <a href="#details">More...</a></p>
  83. <table class="memberdecls">
  84. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  85. Functions</h2></td></tr>
  86. <tr class="memitem:ga2e09bd6c8b0a9c91f6f5683d68245634"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  87. <tr class="memitem:ga2e09bd6c8b0a9c91f6f5683d68245634"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL uint&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00181.html#ga2e09bd6c8b0a9c91f6f5683d68245634">float_distance</a> (T const &amp;x, T const &amp;y)</td></tr>
  88. <tr class="memdesc:ga2e09bd6c8b0a9c91f6f5683d68245634"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the distance in the number of ULP between 2 scalars. <a href="a00181.html#ga2e09bd6c8b0a9c91f6f5683d68245634">More...</a><br /></td></tr>
  89. <tr class="separator:ga2e09bd6c8b0a9c91f6f5683d68245634"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:ga72b3223069013f336d8c31812b7ada80"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  91. <tr class="memitem:ga72b3223069013f336d8c31812b7ada80"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; 2, uint, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00181.html#ga72b3223069013f336d8c31812b7ada80">float_distance</a> (vec&lt; 2, T, Q &gt; const &amp;x, vec&lt; 2, T, Q &gt; const &amp;y)</td></tr>
  92. <tr class="memdesc:ga72b3223069013f336d8c31812b7ada80"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the distance in the number of ULP between 2 vectors. <a href="a00181.html#ga72b3223069013f336d8c31812b7ada80">More...</a><br /></td></tr>
  93. <tr class="separator:ga72b3223069013f336d8c31812b7ada80"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:gae516ae554faa6117660828240e8bdaf0"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  95. <tr class="memitem:gae516ae554faa6117660828240e8bdaf0"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00181.html#gae516ae554faa6117660828240e8bdaf0">next_float</a> (genType const &amp;x)</td></tr>
  96. <tr class="memdesc:gae516ae554faa6117660828240e8bdaf0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the next ULP value(s) after the input value(s). <a href="a00181.html#gae516ae554faa6117660828240e8bdaf0">More...</a><br /></td></tr>
  97. <tr class="separator:gae516ae554faa6117660828240e8bdaf0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:gad107ec3d9697ef82032a33338a73ebdd"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  99. <tr class="memitem:gad107ec3d9697ef82032a33338a73ebdd"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00181.html#gad107ec3d9697ef82032a33338a73ebdd">next_float</a> (genType const &amp;x, uint const &amp;Distance)</td></tr>
  100. <tr class="memdesc:gad107ec3d9697ef82032a33338a73ebdd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the value(s) ULP distance after the input value(s). <a href="a00181.html#gad107ec3d9697ef82032a33338a73ebdd">More...</a><br /></td></tr>
  101. <tr class="separator:gad107ec3d9697ef82032a33338a73ebdd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:ga2fcbb7bfbfc595712bfddc51b0715b07"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  103. <tr class="memitem:ga2fcbb7bfbfc595712bfddc51b0715b07"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00181.html#ga2fcbb7bfbfc595712bfddc51b0715b07">prev_float</a> (genType const &amp;x)</td></tr>
  104. <tr class="memdesc:ga2fcbb7bfbfc595712bfddc51b0715b07"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the previous ULP value(s) before the input value(s). <a href="a00181.html#ga2fcbb7bfbfc595712bfddc51b0715b07">More...</a><br /></td></tr>
  105. <tr class="separator:ga2fcbb7bfbfc595712bfddc51b0715b07"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:gaa399d5b6472a70e8952f9b26ecaacdec"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  107. <tr class="memitem:gaa399d5b6472a70e8952f9b26ecaacdec"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00181.html#gaa399d5b6472a70e8952f9b26ecaacdec">prev_float</a> (genType const &amp;x, uint const &amp;Distance)</td></tr>
  108. <tr class="memdesc:gaa399d5b6472a70e8952f9b26ecaacdec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the value(s) ULP distance before the input value(s). <a href="a00181.html#gaa399d5b6472a70e8952f9b26ecaacdec">More...</a><br /></td></tr>
  109. <tr class="separator:gaa399d5b6472a70e8952f9b26ecaacdec"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. </table>
  111. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  112. <p>Allow the measurement of the accuracy of a function against a reference implementation. </p>
  113. <p>This extension works on floating-point data and provide results in ULP. &lt;<a class="el" href="a00133.html" title="GLM_GTC_ulp ">glm/gtc/ulp.hpp</a>&gt; need to be included to use these features. </p>
  114. <h2 class="groupheader">Function Documentation</h2>
  115. <a class="anchor" id="ga2e09bd6c8b0a9c91f6f5683d68245634"></a>
  116. <div class="memitem">
  117. <div class="memproto">
  118. <table class="memname">
  119. <tr>
  120. <td class="memname">GLM_FUNC_DECL uint glm::float_distance </td>
  121. <td>(</td>
  122. <td class="paramtype">T const &amp;&#160;</td>
  123. <td class="paramname"><em>x</em>, </td>
  124. </tr>
  125. <tr>
  126. <td class="paramkey"></td>
  127. <td></td>
  128. <td class="paramtype">T const &amp;&#160;</td>
  129. <td class="paramname"><em>y</em>&#160;</td>
  130. </tr>
  131. <tr>
  132. <td></td>
  133. <td>)</td>
  134. <td></td><td></td>
  135. </tr>
  136. </table>
  137. </div><div class="memdoc">
  138. <p>Return the distance in the number of ULP between 2 scalars. </p>
  139. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00181.html" title="Allow the measurement of the accuracy of a function against a reference implementation. ">GLM_GTC_ulp</a> </dd></dl>
  140. </div>
  141. </div>
  142. <a class="anchor" id="ga72b3223069013f336d8c31812b7ada80"></a>
  143. <div class="memitem">
  144. <div class="memproto">
  145. <table class="memname">
  146. <tr>
  147. <td class="memname">GLM_FUNC_DECL vec&lt;2, uint, Q&gt; glm::float_distance </td>
  148. <td>(</td>
  149. <td class="paramtype">vec&lt; 2, T, Q &gt; const &amp;&#160;</td>
  150. <td class="paramname"><em>x</em>, </td>
  151. </tr>
  152. <tr>
  153. <td class="paramkey"></td>
  154. <td></td>
  155. <td class="paramtype">vec&lt; 2, T, Q &gt; const &amp;&#160;</td>
  156. <td class="paramname"><em>y</em>&#160;</td>
  157. </tr>
  158. <tr>
  159. <td></td>
  160. <td>)</td>
  161. <td></td><td></td>
  162. </tr>
  163. </table>
  164. </div><div class="memdoc">
  165. <p>Return the distance in the number of ULP between 2 vectors. </p>
  166. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00181.html" title="Allow the measurement of the accuracy of a function against a reference implementation. ">GLM_GTC_ulp</a> </dd></dl>
  167. </div>
  168. </div>
  169. <a class="anchor" id="gae516ae554faa6117660828240e8bdaf0"></a>
  170. <div class="memitem">
  171. <div class="memproto">
  172. <table class="memname">
  173. <tr>
  174. <td class="memname">GLM_FUNC_DECL genType glm::next_float </td>
  175. <td>(</td>
  176. <td class="paramtype">genType const &amp;&#160;</td>
  177. <td class="paramname"><em>x</em></td><td>)</td>
  178. <td></td>
  179. </tr>
  180. </table>
  181. </div><div class="memdoc">
  182. <p>Return the next ULP value(s) after the input value(s). </p>
  183. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00181.html" title="Allow the measurement of the accuracy of a function against a reference implementation. ">GLM_GTC_ulp</a> </dd></dl>
  184. </div>
  185. </div>
  186. <a class="anchor" id="gad107ec3d9697ef82032a33338a73ebdd"></a>
  187. <div class="memitem">
  188. <div class="memproto">
  189. <table class="memname">
  190. <tr>
  191. <td class="memname">GLM_FUNC_DECL genType glm::next_float </td>
  192. <td>(</td>
  193. <td class="paramtype">genType const &amp;&#160;</td>
  194. <td class="paramname"><em>x</em>, </td>
  195. </tr>
  196. <tr>
  197. <td class="paramkey"></td>
  198. <td></td>
  199. <td class="paramtype"><a class="el" href="a00160.html#ga91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> const &amp;&#160;</td>
  200. <td class="paramname"><em>Distance</em>&#160;</td>
  201. </tr>
  202. <tr>
  203. <td></td>
  204. <td>)</td>
  205. <td></td><td></td>
  206. </tr>
  207. </table>
  208. </div><div class="memdoc">
  209. <p>Return the value(s) ULP distance after the input value(s). </p>
  210. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00181.html" title="Allow the measurement of the accuracy of a function against a reference implementation. ">GLM_GTC_ulp</a> </dd></dl>
  211. </div>
  212. </div>
  213. <a class="anchor" id="ga2fcbb7bfbfc595712bfddc51b0715b07"></a>
  214. <div class="memitem">
  215. <div class="memproto">
  216. <table class="memname">
  217. <tr>
  218. <td class="memname">GLM_FUNC_DECL genType glm::prev_float </td>
  219. <td>(</td>
  220. <td class="paramtype">genType const &amp;&#160;</td>
  221. <td class="paramname"><em>x</em></td><td>)</td>
  222. <td></td>
  223. </tr>
  224. </table>
  225. </div><div class="memdoc">
  226. <p>Return the previous ULP value(s) before the input value(s). </p>
  227. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00181.html" title="Allow the measurement of the accuracy of a function against a reference implementation. ">GLM_GTC_ulp</a> </dd></dl>
  228. </div>
  229. </div>
  230. <a class="anchor" id="gaa399d5b6472a70e8952f9b26ecaacdec"></a>
  231. <div class="memitem">
  232. <div class="memproto">
  233. <table class="memname">
  234. <tr>
  235. <td class="memname">GLM_FUNC_DECL genType glm::prev_float </td>
  236. <td>(</td>
  237. <td class="paramtype">genType const &amp;&#160;</td>
  238. <td class="paramname"><em>x</em>, </td>
  239. </tr>
  240. <tr>
  241. <td class="paramkey"></td>
  242. <td></td>
  243. <td class="paramtype"><a class="el" href="a00160.html#ga91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> const &amp;&#160;</td>
  244. <td class="paramname"><em>Distance</em>&#160;</td>
  245. </tr>
  246. <tr>
  247. <td></td>
  248. <td>)</td>
  249. <td></td><td></td>
  250. </tr>
  251. </table>
  252. </div><div class="memdoc">
  253. <p>Return the value(s) ULP distance before the input value(s). </p>
  254. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00181.html" title="Allow the measurement of the accuracy of a function against a reference implementation. ">GLM_GTC_ulp</a> </dd></dl>
  255. </div>
  256. </div>
  257. </div><!-- contents -->
  258. <!-- start footer part -->
  259. <hr class="footer"/><address class="footer"><small>
  260. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  261. <img class="footer" src="doxygen.png" alt="doxygen"/>
  262. </a> 1.8.10
  263. </small></address>
  264. </body>
  265. </html>