Home Explore Help
Sign In
cpp
/
glm
mirror of https://github.com/g-truc/glm.git
2
0
Fork 0
Files Issues 0 Wiki
Branch: 0.9.5
Branches Tags
glm
/
doc
/
api
/
a00184.html

a00184.html 11 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
    6. 

  6. <meta name="generator" content="Doxygen 1.8.5"/>
    7. 

  7. <title>GLM: GLM_GTC_ulp</title>
    8. 

  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    9. 

  9. <script type="text/javascript" src="jquery.js"></script>
    10. 

  10. <script type="text/javascript" src="dynsections.js"></script>
    11. 

  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
    12. 

  12. </head>
    13. 

  13. <body>
    14. 

  14. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    15. 

  15. <div id="titlearea">
    16. 

  16. <table cellspacing="0" cellpadding="0">
    17. 

  17.  <tbody>
    18. 

  18.  <tr style="height: 56px;">
    19. 

  19.   <td style="padding-left: 0.5em;">
    20. 

  20.    <div id="projectname">GLM
    21. 

  21.    &#160;<span id="projectnumber">0.9.5</span>
    22. 

  22.    </div>
    23. 

  23.   </td>
    24. 

  24.  </tr>
    25. 

  25.  </tbody>
    26. 

  26. </table>
    27. 

  27. </div>
    28. 

  28. <!-- end header part -->
    29. 

  29. <!-- Generated by Doxygen 1.8.5 -->
    30. 

  30.   <div id="navrow1" class="tabs">
    31. 

  31.     <ul class="tablist">
    32. 

  32.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
    33. 

  33.       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
    34. 

  34.       <li><a href="modules.html"><span>Modules</span></a></li>
    35. 

  35.       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    36. 

  36.       <li><a href="files.html"><span>Files</span></a></li>
    37. 

  37.     </ul>
    38. 

  38.   </div>
    39. 

  39. </div><!-- top -->
    40. 

  40. <div class="header">
    41. 

  41.   <div class="summary">
    42. 

  42. <a href="#func-members">Functions</a>  </div>
    43. 

  43.   <div class="headertitle">
    44. 

  44. <div class="title">GLM_GTC_ulp<div class="ingroups"><a class="el" href="a00164.html">GTC Extensions (Stable)</a></div></div>  </div>
    45. 

  45. </div><!--header-->
    46. 

  46. <div class="contents">
    47. 

  47. <table class="memberdecls">
    48. 

  48. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
    49. 

  49. Functions</h2></td></tr>
    50. 

  50. <tr class="memitem:ga2e09bd6c8b0a9c91f6f5683d68245634"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
    51. 

  51. <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="a00184.html#ga2e09bd6c8b0a9c91f6f5683d68245634">float_distance</a> (T const &amp;x, T const &amp;y)</td></tr>
    52. 

  52. <tr class="separator:ga2e09bd6c8b0a9c91f6f5683d68245634"><td class="memSeparator" colspan="2">&#160;</td></tr>
    53. 

  53. <tr class="memitem:ga85355f2549d75789eb66e5d565d8ad26"><td class="memTemplParams" colspan="2">template&lt;typename T , template&lt; typename &gt; class vecType&gt; </td></tr>
    54. 

  54. <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="a00184.html#ga85355f2549d75789eb66e5d565d8ad26">float_distance</a> (vecType&lt; T &gt; const &amp;x, vecType&lt; T &gt; const &amp;y)</td></tr>
    55. 

  55. <tr class="separator:ga85355f2549d75789eb66e5d565d8ad26"><td class="memSeparator" colspan="2">&#160;</td></tr>
    56. 

  56. <tr class="memitem:gae516ae554faa6117660828240e8bdaf0"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
    57. 

  57. <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="a00184.html#gae516ae554faa6117660828240e8bdaf0">next_float</a> (genType const &amp;x)</td></tr>
    58. 

  58. <tr class="separator:gae516ae554faa6117660828240e8bdaf0"><td class="memSeparator" colspan="2">&#160;</td></tr>
    59. 

  59. <tr class="memitem:gad107ec3d9697ef82032a33338a73ebdd"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
    60. 

  60. <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="a00184.html#gad107ec3d9697ef82032a33338a73ebdd">next_float</a> (genType const &amp;x, uint const &amp;Distance)</td></tr>
    61. 

  61. <tr class="separator:gad107ec3d9697ef82032a33338a73ebdd"><td class="memSeparator" colspan="2">&#160;</td></tr>
    62. 

  62. <tr class="memitem:ga2fcbb7bfbfc595712bfddc51b0715b07"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
    63. 

  63. <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="a00184.html#ga2fcbb7bfbfc595712bfddc51b0715b07">prev_float</a> (genType const &amp;x)</td></tr>
    64. 

  64. <tr class="separator:ga2fcbb7bfbfc595712bfddc51b0715b07"><td class="memSeparator" colspan="2">&#160;</td></tr>
    65. 

  65. <tr class="memitem:gaa399d5b6472a70e8952f9b26ecaacdec"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
    66. 

  66. <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="a00184.html#gaa399d5b6472a70e8952f9b26ecaacdec">prev_float</a> (genType const &amp;x, uint const &amp;Distance)</td></tr>
    67. 

  67. <tr class="separator:gaa399d5b6472a70e8952f9b26ecaacdec"><td class="memSeparator" colspan="2">&#160;</td></tr>
    68. 

  68. </table>
    69. 

  69. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
    70. 

  70. <p>Allow the measurement of the accuracy of a function against a reference implementation. </p>
    71. 

  71. <p>This extension works on floating-point data and provide results in ULP. &lt;<a class="el" href="a00139.html" title="OpenGL Mathematics (glm.g-truc.net) ">glm/gtc/ulp.hpp</a>&gt; need to be included to use these features. </p>
    72. 

  72. <h2 class="groupheader">Function Documentation</h2>
    73. 

  73. <a class="anchor" id="ga2e09bd6c8b0a9c91f6f5683d68245634"></a>
    74. 

  74. <div class="memitem">
    75. 

  75. <div class="memproto">
    76. 

  76.       <table class="memname">
    77. 

  77.         <tr>
    78. 

  78.           <td class="memname">GLM_FUNC_DECL uint glm::float_distance </td>
    79. 

  79.           <td>(</td>
    80. 

  80.           <td class="paramtype">T const &amp;&#160;</td>
    81. 

  81.           <td class="paramname"><em>x</em>, </td>
    82. 

  82.         </tr>
    83. 

  83.         <tr>
    84. 

  84.           <td class="paramkey"></td>
    85. 

  85.           <td></td>
    86. 

  86.           <td class="paramtype">T const &amp;&#160;</td>
    87. 

  87.           <td class="paramname"><em>y</em>&#160;</td>
    88. 

  88.         </tr>
    89. 

  89.         <tr>
    90. 

  90.           <td></td>
    91. 

  91.           <td>)</td>
    92. 

  92.           <td></td><td></td>
    93. 

  93.         </tr>
    94. 

  94.       </table>
    95. 

  95. </div><div class="memdoc">
    96. 

  96. 

  97. <p>Return the distance in the number of ULP between 2 scalars. </p>
    98. 

  98. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00184.html" title="Allow the measurement of the accuracy of a function against a reference implementation. ">GLM_GTC_ulp</a> </dd></dl>
    99. 

  99. 

  100. </div>
    101. 

  101. </div>
    102. 

  102. <a class="anchor" id="ga85355f2549d75789eb66e5d565d8ad26"></a>
    103. 

  103. <div class="memitem">
    104. 

  104. <div class="memproto">
    105. 

  105.       <table class="memname">
    106. 

  106.         <tr>
    107. 

  107.           <td class="memname">GLM_FUNC_DECL vecType&lt;uint&gt; glm::float_distance </td>
    108. 

  108.           <td>(</td>
    109. 

  109.           <td class="paramtype">vecType&lt; T &gt; const &amp;&#160;</td>
    110. 

  110.           <td class="paramname"><em>x</em>, </td>
    111. 

  111.         </tr>
    112. 

  112.         <tr>
    113. 

  113.           <td class="paramkey"></td>
    114. 

  114.           <td></td>
    115. 

  115.           <td class="paramtype">vecType&lt; T &gt; const &amp;&#160;</td>
    116. 

  116.           <td class="paramname"><em>y</em>&#160;</td>
    117. 

  117.         </tr>
    118. 

  118.         <tr>
    119. 

  119.           <td></td>
    120. 

  120.           <td>)</td>
    121. 

  121.           <td></td><td></td>
    122. 

  122.         </tr>
    123. 

  123.       </table>
    124. 

  124. </div><div class="memdoc">
    125. 

  125. 

  126. <p>Return the distance in the number of ULP between 2 vectors. </p>
    127. 

  127. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00184.html" title="Allow the measurement of the accuracy of a function against a reference implementation. ">GLM_GTC_ulp</a> </dd></dl>
    128. 

  128. 

  129. </div>
    130. 

  130. </div>
    131. 

  131. <a class="anchor" id="gae516ae554faa6117660828240e8bdaf0"></a>
    132. 

  132. <div class="memitem">
    133. 

  133. <div class="memproto">
    134. 

  134.       <table class="memname">
    135. 

  135.         <tr>
    136. 

  136.           <td class="memname">GLM_FUNC_DECL genType glm::next_float </td>
    137. 

  137.           <td>(</td>
    138. 

  138.           <td class="paramtype">genType const &amp;&#160;</td>
    139. 

  139.           <td class="paramname"><em>x</em></td><td>)</td>
    140. 

  140.           <td></td>
    141. 

  141.         </tr>
    142. 

  142.       </table>
    143. 

  143. </div><div class="memdoc">
    144. 

  144. 

  145. <p>Return the next ULP value(s) after the input value(s). </p>
    146. 

  146. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00184.html" title="Allow the measurement of the accuracy of a function against a reference implementation. ">GLM_GTC_ulp</a> </dd></dl>
    147. 

  147. 

  148. </div>
    149. 

  149. </div>
    150. 

  150. <a class="anchor" id="gad107ec3d9697ef82032a33338a73ebdd"></a>
    151. 

  151. <div class="memitem">
    152. 

  152. <div class="memproto">
    153. 

  153.       <table class="memname">
    154. 

  154.         <tr>
    155. 

  155.           <td class="memname">GLM_FUNC_DECL genType glm::next_float </td>
    156. 

  156.           <td>(</td>
    157. 

  157.           <td class="paramtype">genType const &amp;&#160;</td>
    158. 

  158.           <td class="paramname"><em>x</em>, </td>
    159. 

  159.         </tr>
    160. 

  160.         <tr>
    161. 

  161.           <td class="paramkey"></td>
    162. 

  162.           <td></td>
    163. 

  163.           <td class="paramtype">uint const &amp;&#160;</td>
    164. 

  164.           <td class="paramname"><em>Distance</em>&#160;</td>
    165. 

  165.         </tr>
    166. 

  166.         <tr>
    167. 

  167.           <td></td>
    168. 

  168.           <td>)</td>
    169. 

  169.           <td></td><td></td>
    170. 

  170.         </tr>
    171. 

  171.       </table>
    172. 

  172. </div><div class="memdoc">
    173. 

  173. 

  174. <p>Return the value(s) ULP distance after the input value(s). </p>
    175. 

  175. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00184.html" title="Allow the measurement of the accuracy of a function against a reference implementation. ">GLM_GTC_ulp</a> </dd></dl>
    176. 

  176. 

  177. </div>
    178. 

  178. </div>
    179. 

  179. <a class="anchor" id="ga2fcbb7bfbfc595712bfddc51b0715b07"></a>
    180. 

  180. <div class="memitem">
    181. 

  181. <div class="memproto">
    182. 

  182.       <table class="memname">
    183. 

  183.         <tr>
    184. 

  184.           <td class="memname">GLM_FUNC_DECL genType glm::prev_float </td>
    185. 

  185.           <td>(</td>
    186. 

  186.           <td class="paramtype">genType const &amp;&#160;</td>
    187. 

  187.           <td class="paramname"><em>x</em></td><td>)</td>
    188. 

  188.           <td></td>
    189. 

  189.         </tr>
    190. 

  190.       </table>
    191. 

  191. </div><div class="memdoc">
    192. 

  192. 

  193. <p>Return the previous ULP value(s) before the input value(s). </p>
    194. 

  194. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00184.html" title="Allow the measurement of the accuracy of a function against a reference implementation. ">GLM_GTC_ulp</a> </dd></dl>
    195. 

  195. 

  196. </div>
    197. 

  197. </div>
    198. 

  198. <a class="anchor" id="gaa399d5b6472a70e8952f9b26ecaacdec"></a>
    199. 

  199. <div class="memitem">
    200. 

  200. <div class="memproto">
    201. 

  201.       <table class="memname">
    202. 

  202.         <tr>
    203. 

  203.           <td class="memname">GLM_FUNC_DECL genType glm::prev_float </td>
    204. 

  204.           <td>(</td>
    205. 

  205.           <td class="paramtype">genType const &amp;&#160;</td>
    206. 

  206.           <td class="paramname"><em>x</em>, </td>
    207. 

  207.         </tr>
    208. 

  208.         <tr>
    209. 

  209.           <td class="paramkey"></td>
    210. 

  210.           <td></td>
    211. 

  211.           <td class="paramtype">uint const &amp;&#160;</td>
    212. 

  212.           <td class="paramname"><em>Distance</em>&#160;</td>
    213. 

  213.         </tr>
    214. 

  214.         <tr>
    215. 

  215.           <td></td>
    216. 

  216.           <td>)</td>
    217. 

  217.           <td></td><td></td>
    218. 

  218.         </tr>
    219. 

  219.       </table>
    220. 

  220. </div><div class="memdoc">
    221. 

  221. 

  222. <p>Return the value(s) ULP distance before the input value(s). </p>
    223. 

  223. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00184.html" title="Allow the measurement of the accuracy of a function against a reference implementation. ">GLM_GTC_ulp</a> </dd></dl>
    224. 

  224. 

  225. </div>
    226. 

  226. </div>
    227. 

  227. </div><!-- contents -->
    228. 

  228. <!-- start footer part -->
    229. 

  229. <hr class="footer"/><address class="footer"><small>
    230. 

  230. Generated by &#160;<a href="http://www.doxygen.org/index.html">
    231. 

  231. <img class="footer" src="doxygen.png" alt="doxygen"/>
    232. 

  232. </a> 1.8.5
    233. 

  233. </small></address>
    234. 

  234. </body>
    235. 

  235. </html>
    236.