a00183.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233
  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.7: 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="doxygen.css" rel="stylesheet" type="text/css" />
  12. </head>
  13. <body>
  14. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  15. <div id="titlearea">
  16. <table cellspacing="0" cellpadding="0">
  17. <tbody>
  18. <tr style="height: 56px;">
  19. <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  20. <td id="projectalign" style="padding-left: 0.5em;">
  21. <div id="projectname">0.9.7
  22. </div>
  23. </td>
  24. </tr>
  25. </tbody>
  26. </table>
  27. </div>
  28. <!-- end header part -->
  29. <!-- Generated by Doxygen 1.8.10 -->
  30. <div id="navrow1" class="tabs">
  31. <ul class="tablist">
  32. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  33. <li><a href="modules.html"><span>Modules</span></a></li>
  34. <li><a href="files.html"><span>Files</span></a></li>
  35. </ul>
  36. </div>
  37. </div><!-- top -->
  38. <div class="header">
  39. <div class="summary">
  40. <a href="#func-members">Functions</a> </div>
  41. <div class="headertitle">
  42. <div class="title">GLM_GTC_ulp<div class="ingroups"><a class="el" href="a00160.html">GTC Extensions (Stable)</a></div></div> </div>
  43. </div><!--header-->
  44. <div class="contents">
  45. <table class="memberdecls">
  46. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  47. Functions</h2></td></tr>
  48. <tr class="memitem:ga2e09bd6c8b0a9c91f6f5683d68245634"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  49. <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="a00183.html#ga2e09bd6c8b0a9c91f6f5683d68245634">float_distance</a> (T const &amp;x, T const &amp;y)</td></tr>
  50. <tr class="separator:ga2e09bd6c8b0a9c91f6f5683d68245634"><td class="memSeparator" colspan="2">&#160;</td></tr>
  51. <tr class="memitem:ga85355f2549d75789eb66e5d565d8ad26"><td class="memTemplParams" colspan="2">template&lt;typename T , template&lt; typename &gt; class vecType&gt; </td></tr>
  52. <tr class="memitem:ga85355f2549d75789eb66e5d565d8ad26"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vecType&lt; uint &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00183.html#ga85355f2549d75789eb66e5d565d8ad26">float_distance</a> (vecType&lt; T &gt; const &amp;x, vecType&lt; T &gt; const &amp;y)</td></tr>
  53. <tr class="separator:ga85355f2549d75789eb66e5d565d8ad26"><td class="memSeparator" colspan="2">&#160;</td></tr>
  54. <tr class="memitem:gae516ae554faa6117660828240e8bdaf0"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  55. <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="a00183.html#gae516ae554faa6117660828240e8bdaf0">next_float</a> (genType const &amp;x)</td></tr>
  56. <tr class="separator:gae516ae554faa6117660828240e8bdaf0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  57. <tr class="memitem:gad107ec3d9697ef82032a33338a73ebdd"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  58. <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="a00183.html#gad107ec3d9697ef82032a33338a73ebdd">next_float</a> (genType const &amp;x, uint const &amp;Distance)</td></tr>
  59. <tr class="separator:gad107ec3d9697ef82032a33338a73ebdd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  60. <tr class="memitem:ga2fcbb7bfbfc595712bfddc51b0715b07"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  61. <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="a00183.html#ga2fcbb7bfbfc595712bfddc51b0715b07">prev_float</a> (genType const &amp;x)</td></tr>
  62. <tr class="separator:ga2fcbb7bfbfc595712bfddc51b0715b07"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63. <tr class="memitem:gaa399d5b6472a70e8952f9b26ecaacdec"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  64. <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="a00183.html#gaa399d5b6472a70e8952f9b26ecaacdec">prev_float</a> (genType const &amp;x, uint const &amp;Distance)</td></tr>
  65. <tr class="separator:gaa399d5b6472a70e8952f9b26ecaacdec"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66. </table>
  67. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  68. <p>Allow the measurement of the accuracy of a function against a reference implementation. </p>
  69. <p>This extension works on floating-point data and provide results in ULP. &lt;<a class="el" href="a00137.html" title="OpenGL Mathematics (glm.g-truc.net) ">glm/gtc/ulp.hpp</a>&gt; need to be included to use these features. </p>
  70. <h2 class="groupheader">Function Documentation</h2>
  71. <a class="anchor" id="ga2e09bd6c8b0a9c91f6f5683d68245634"></a>
  72. <div class="memitem">
  73. <div class="memproto">
  74. <table class="memname">
  75. <tr>
  76. <td class="memname">GLM_FUNC_DECL uint glm::float_distance </td>
  77. <td>(</td>
  78. <td class="paramtype">T const &amp;&#160;</td>
  79. <td class="paramname"><em>x</em>, </td>
  80. </tr>
  81. <tr>
  82. <td class="paramkey"></td>
  83. <td></td>
  84. <td class="paramtype">T const &amp;&#160;</td>
  85. <td class="paramname"><em>y</em>&#160;</td>
  86. </tr>
  87. <tr>
  88. <td></td>
  89. <td>)</td>
  90. <td></td><td></td>
  91. </tr>
  92. </table>
  93. </div><div class="memdoc">
  94. <p>Return the distance in the number of ULP between 2 scalars. </p>
  95. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00183.html" title="Allow the measurement of the accuracy of a function against a reference implementation. ">GLM_GTC_ulp</a> </dd></dl>
  96. </div>
  97. </div>
  98. <a class="anchor" id="ga85355f2549d75789eb66e5d565d8ad26"></a>
  99. <div class="memitem">
  100. <div class="memproto">
  101. <table class="memname">
  102. <tr>
  103. <td class="memname">GLM_FUNC_DECL vecType&lt;uint&gt; glm::float_distance </td>
  104. <td>(</td>
  105. <td class="paramtype">vecType&lt; T &gt; const &amp;&#160;</td>
  106. <td class="paramname"><em>x</em>, </td>
  107. </tr>
  108. <tr>
  109. <td class="paramkey"></td>
  110. <td></td>
  111. <td class="paramtype">vecType&lt; T &gt; const &amp;&#160;</td>
  112. <td class="paramname"><em>y</em>&#160;</td>
  113. </tr>
  114. <tr>
  115. <td></td>
  116. <td>)</td>
  117. <td></td><td></td>
  118. </tr>
  119. </table>
  120. </div><div class="memdoc">
  121. <p>Return the distance in the number of ULP between 2 vectors. </p>
  122. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00183.html" title="Allow the measurement of the accuracy of a function against a reference implementation. ">GLM_GTC_ulp</a> </dd></dl>
  123. </div>
  124. </div>
  125. <a class="anchor" id="gae516ae554faa6117660828240e8bdaf0"></a>
  126. <div class="memitem">
  127. <div class="memproto">
  128. <table class="memname">
  129. <tr>
  130. <td class="memname">GLM_FUNC_DECL genType glm::next_float </td>
  131. <td>(</td>
  132. <td class="paramtype">genType const &amp;&#160;</td>
  133. <td class="paramname"><em>x</em></td><td>)</td>
  134. <td></td>
  135. </tr>
  136. </table>
  137. </div><div class="memdoc">
  138. <p>Return the next ULP value(s) after the input value(s). </p>
  139. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00183.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="gad107ec3d9697ef82032a33338a73ebdd"></a>
  143. <div class="memitem">
  144. <div class="memproto">
  145. <table class="memname">
  146. <tr>
  147. <td class="memname">GLM_FUNC_DECL genType glm::next_float </td>
  148. <td>(</td>
  149. <td class="paramtype">genType 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"><a class="el" href="a00164.html#ga91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> const &amp;&#160;</td>
  156. <td class="paramname"><em>Distance</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 value(s) ULP distance after the input value(s). </p>
  166. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00183.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="ga2fcbb7bfbfc595712bfddc51b0715b07"></a>
  170. <div class="memitem">
  171. <div class="memproto">
  172. <table class="memname">
  173. <tr>
  174. <td class="memname">GLM_FUNC_DECL genType glm::prev_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 previous ULP value(s) before the input value(s). </p>
  183. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00183.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="gaa399d5b6472a70e8952f9b26ecaacdec"></a>
  187. <div class="memitem">
  188. <div class="memproto">
  189. <table class="memname">
  190. <tr>
  191. <td class="memname">GLM_FUNC_DECL genType glm::prev_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="a00164.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 before the input value(s). </p>
  210. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00183.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. </div><!-- contents -->
  214. <!-- start footer part -->
  215. <hr class="footer"/><address class="footer"><small>
  216. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  217. <img class="footer" src="doxygen.png" alt="doxygen"/>
  218. </a> 1.8.10
  219. </small></address>
  220. </body>
  221. </html>