a00267.html 6.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158
  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. <title>GLM_GTX_integer: Extended integer functions</title>
  6. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  7. <link href="doxygen.css" rel="stylesheet" type="text/css"/>
  8. </head>
  9. <body>
  10. <!-- Generated by Doxygen 1.7.4 -->
  11. <div id="top">
  12. <div id="titlearea">
  13. <table cellspacing="0" cellpadding="0">
  14. <tbody>
  15. <tr style="height: 56px;">
  16. <td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
  17. </tr>
  18. </tbody>
  19. </table>
  20. </div>
  21. <div id="navrow1" class="tabs">
  22. <ul class="tablist">
  23. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  24. <li><a href="modules.html"><span>Modules</span></a></li>
  25. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  26. <li><a href="annotated.html"><span>Classes</span></a></li>
  27. <li><a href="files.html"><span>Files</span></a></li>
  28. </ul>
  29. </div>
  30. </div>
  31. <div class="header">
  32. <div class="summary">
  33. <a href="#func-members">Functions</a> </div>
  34. <div class="headertitle">
  35. <div class="title">GLM_GTX_integer: Extended integer functions</div> </div>
  36. <div class="ingroups"><a class="el" href="a00248.html">GTX Extensions (Experimental)</a></div></div>
  37. <div class="contents">
  38. <p>Add support for integer for core functions.
  39. <a href="#details">More...</a></p>
  40. <table class="memberdecls">
  41. <tr><td colspan="2"><h2><a name="func-members"></a>
  42. Functions</h2></td></tr>
  43. <tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  44. <tr><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00267.html#gab45d1385cbb477a5684f80b0e24807e4">factorial</a> (genType const &amp;x)</td></tr>
  45. <tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00267.html#gaf48bc86895ab82c0e1f6f282d5cb6861">mod</a> (int x, int y)</td></tr>
  46. <tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00267.html#gaf34adb6543aab76a364f40bb77dbaeb8">pow</a> (int x, int y)</td></tr>
  47. <tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00267.html#gac6ee2be886e1f3be68adc5ee0552bad7">sqrt</a> (int x)</td></tr>
  48. </table>
  49. <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
  50. <p>Add support for integer for core functions. </p>
  51. <p>&lt;<a class="el" href="a00061_source.html">glm/gtx/integer.hpp</a>&gt; need to be included to use these functionalities. </p>
  52. <hr/><h2>Function Documentation</h2>
  53. <a class="anchor" id="gab45d1385cbb477a5684f80b0e24807e4"></a><!-- doxytag: member="glm::gtx::integer::factorial" ref="gab45d1385cbb477a5684f80b0e24807e4" args="(genType const &amp;x)" -->
  54. <div class="memitem">
  55. <div class="memproto">
  56. <table class="memname">
  57. <tr>
  58. <td class="memname">genType glm::gtx::integer::factorial </td>
  59. <td>(</td>
  60. <td class="paramtype">genType const &amp;&#160;</td>
  61. <td class="paramname"><em>x</em></td><td>)</td>
  62. <td></td>
  63. </tr>
  64. </table>
  65. </div>
  66. <div class="memdoc">
  67. <p>Return the factorial value of a number (!12 max, integer only) From GLM_GTX_integer extension. </p>
  68. </div>
  69. </div>
  70. <a class="anchor" id="gaf48bc86895ab82c0e1f6f282d5cb6861"></a><!-- doxytag: member="glm::gtx::integer::mod" ref="gaf48bc86895ab82c0e1f6f282d5cb6861" args="(int x, int y)" -->
  71. <div class="memitem">
  72. <div class="memproto">
  73. <table class="memname">
  74. <tr>
  75. <td class="memname">int glm::gtx::integer::mod </td>
  76. <td>(</td>
  77. <td class="paramtype">int&#160;</td>
  78. <td class="paramname"><em>x</em>, </td>
  79. </tr>
  80. <tr>
  81. <td class="paramkey"></td>
  82. <td></td>
  83. <td class="paramtype">int&#160;</td>
  84. <td class="paramname"><em>y</em>&#160;</td>
  85. </tr>
  86. <tr>
  87. <td></td>
  88. <td>)</td>
  89. <td></td><td></td>
  90. </tr>
  91. </table>
  92. </div>
  93. <div class="memdoc">
  94. <p>Modulus. </p>
  95. <p>Returns x - y * floor(x / y) for each component in x using the floating point value y. From GLM_GTX_integer extension. </p>
  96. </div>
  97. </div>
  98. <a class="anchor" id="gaf34adb6543aab76a364f40bb77dbaeb8"></a><!-- doxytag: member="glm::gtx::integer::pow" ref="gaf34adb6543aab76a364f40bb77dbaeb8" args="(int x, int y)" -->
  99. <div class="memitem">
  100. <div class="memproto">
  101. <table class="memname">
  102. <tr>
  103. <td class="memname">int glm::gtx::integer::pow </td>
  104. <td>(</td>
  105. <td class="paramtype">int&#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">int&#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>
  121. <div class="memdoc">
  122. <p>Returns x raised to the y power. </p>
  123. <p>From GLM_GTX_integer extension. </p>
  124. </div>
  125. </div>
  126. <a class="anchor" id="gac6ee2be886e1f3be68adc5ee0552bad7"></a><!-- doxytag: member="glm::gtx::integer::sqrt" ref="gac6ee2be886e1f3be68adc5ee0552bad7" args="(int x)" -->
  127. <div class="memitem">
  128. <div class="memproto">
  129. <table class="memname">
  130. <tr>
  131. <td class="memname">int glm::gtx::integer::sqrt </td>
  132. <td>(</td>
  133. <td class="paramtype">int&#160;</td>
  134. <td class="paramname"><em>x</em></td><td>)</td>
  135. <td></td>
  136. </tr>
  137. </table>
  138. </div>
  139. <div class="memdoc">
  140. <p>Returns the positive square root of x. </p>
  141. <p>From GLM_GTX_integer extension. </p>
  142. </div>
  143. </div>
  144. </div>
  145. <hr class="footer"/><address class="footer"><small>Generated by&#160;
  146. <a href="http://www.doxygen.org/index.html">
  147. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
  148. </body>
  149. </html>