2
0

a00869.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334
  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_integer</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_integer<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:ga2777901e41ad6e1e9d0ad6cc855d1075"><td class="memTemplParams" colspan="2">template&lt;typename genIUType &gt; </td></tr>
  73. <tr class="memitem:ga2777901e41ad6e1e9d0ad6cc855d1075"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL int&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00869.html#ga2777901e41ad6e1e9d0ad6cc855d1075">findNSB</a> (genIUType x, int significantBitCount)</td></tr>
  74. <tr class="memdesc:ga2777901e41ad6e1e9d0ad6cc855d1075"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the bit number of the Nth significant bit set to 1 in the binary representation of value. <a href="a00869.html#ga2777901e41ad6e1e9d0ad6cc855d1075">More...</a><br /></td></tr>
  75. <tr class="separator:ga2777901e41ad6e1e9d0ad6cc855d1075"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <tr class="memitem:gaec593d33956a8fe43f78fccc63ddde9a"><td class="memTemplParams" colspan="2">template&lt;typename genIUType &gt; </td></tr>
  77. <tr class="memitem:gaec593d33956a8fe43f78fccc63ddde9a"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00869.html#gaec593d33956a8fe43f78fccc63ddde9a">isMultiple</a> (genIUType v, genIUType Multiple)</td></tr>
  78. <tr class="memdesc:gaec593d33956a8fe43f78fccc63ddde9a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return true if the 'Value' is a multiple of 'Multiple'. <a href="a00869.html#gaec593d33956a8fe43f78fccc63ddde9a">More...</a><br /></td></tr>
  79. <tr class="separator:gaec593d33956a8fe43f78fccc63ddde9a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:gadf491730354aa7da67fbe23d4d688763"><td class="memTemplParams" colspan="2">template&lt;typename genIUType &gt; </td></tr>
  81. <tr class="memitem:gadf491730354aa7da67fbe23d4d688763"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00869.html#gadf491730354aa7da67fbe23d4d688763">isPowerOfTwo</a> (genIUType v)</td></tr>
  82. <tr class="memdesc:gadf491730354aa7da67fbe23d4d688763"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return true if the value is a power of two number. <a href="a00869.html#gadf491730354aa7da67fbe23d4d688763">More...</a><br /></td></tr>
  83. <tr class="separator:gadf491730354aa7da67fbe23d4d688763"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:gab770a3835c44c8a6fd225be4f4e6b317"><td class="memTemplParams" colspan="2">template&lt;typename genIUType &gt; </td></tr>
  85. <tr class="memitem:gab770a3835c44c8a6fd225be4f4e6b317"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genIUType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00869.html#gab770a3835c44c8a6fd225be4f4e6b317">nextMultiple</a> (genIUType v, genIUType Multiple)</td></tr>
  86. <tr class="memdesc:gab770a3835c44c8a6fd225be4f4e6b317"><td class="mdescLeft">&#160;</td><td class="mdescRight">Higher multiple number of Source. <a href="a00869.html#gab770a3835c44c8a6fd225be4f4e6b317">More...</a><br /></td></tr>
  87. <tr class="separator:gab770a3835c44c8a6fd225be4f4e6b317"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:ga3a37c2f2fd347886c9af6a3ca3db04dc"><td class="memTemplParams" colspan="2">template&lt;typename genIUType &gt; </td></tr>
  89. <tr class="memitem:ga3a37c2f2fd347886c9af6a3ca3db04dc"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genIUType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00869.html#ga3a37c2f2fd347886c9af6a3ca3db04dc">nextPowerOfTwo</a> (genIUType v)</td></tr>
  90. <tr class="memdesc:ga3a37c2f2fd347886c9af6a3ca3db04dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the power of two number which value is just higher the input value, round up to a power of two. <a href="a00869.html#ga3a37c2f2fd347886c9af6a3ca3db04dc">More...</a><br /></td></tr>
  91. <tr class="separator:ga3a37c2f2fd347886c9af6a3ca3db04dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:gada3bdd871ffe31f2d484aa668362f636"><td class="memTemplParams" colspan="2">template&lt;typename genIUType &gt; </td></tr>
  93. <tr class="memitem:gada3bdd871ffe31f2d484aa668362f636"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genIUType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00869.html#gada3bdd871ffe31f2d484aa668362f636">prevMultiple</a> (genIUType v, genIUType Multiple)</td></tr>
  94. <tr class="memdesc:gada3bdd871ffe31f2d484aa668362f636"><td class="mdescLeft">&#160;</td><td class="mdescRight">Lower multiple number of Source. <a href="a00869.html#gada3bdd871ffe31f2d484aa668362f636">More...</a><br /></td></tr>
  95. <tr class="separator:gada3bdd871ffe31f2d484aa668362f636"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:gab21902a0e7e5a8451a7ad80333618727"><td class="memTemplParams" colspan="2">template&lt;typename genIUType &gt; </td></tr>
  97. <tr class="memitem:gab21902a0e7e5a8451a7ad80333618727"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL genIUType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00869.html#gab21902a0e7e5a8451a7ad80333618727">prevPowerOfTwo</a> (genIUType v)</td></tr>
  98. <tr class="memdesc:gab21902a0e7e5a8451a7ad80333618727"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the power of two number which value is just lower the input value, round down to a power of two. <a href="a00869.html#gab21902a0e7e5a8451a7ad80333618727">More...</a><br /></td></tr>
  99. <tr class="separator:gab21902a0e7e5a8451a7ad80333618727"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. </table>
  101. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  102. <p>Include &lt;<a class="el" href="a00365.html" title="GLM_EXT_scalar_integer">glm/ext/scalar_integer.hpp</a>&gt; to use the features of this extension. </p>
  103. <h2 class="groupheader">Function Documentation</h2>
  104. <a id="ga2777901e41ad6e1e9d0ad6cc855d1075"></a>
  105. <h2 class="memtitle"><span class="permalink"><a href="#ga2777901e41ad6e1e9d0ad6cc855d1075">&#9670;&nbsp;</a></span>findNSB()</h2>
  106. <div class="memitem">
  107. <div class="memproto">
  108. <table class="memname">
  109. <tr>
  110. <td class="memname">GLM_FUNC_DECL int glm::findNSB </td>
  111. <td>(</td>
  112. <td class="paramtype">genIUType&#160;</td>
  113. <td class="paramname"><em>x</em>, </td>
  114. </tr>
  115. <tr>
  116. <td class="paramkey"></td>
  117. <td></td>
  118. <td class="paramtype">int&#160;</td>
  119. <td class="paramname"><em>significantBitCount</em>&#160;</td>
  120. </tr>
  121. <tr>
  122. <td></td>
  123. <td>)</td>
  124. <td></td><td></td>
  125. </tr>
  126. </table>
  127. </div><div class="memdoc">
  128. <p>Returns the bit number of the Nth significant bit set to 1 in the binary representation of value. </p>
  129. <p>If value bitcount is less than the Nth significant bit, -1 will be returned.</p>
  130. <dl class="tparams"><dt>Template Parameters</dt><dd>
  131. <table class="tparams">
  132. <tr><td class="paramname">genIUType</td><td>Signed or unsigned integer scalar types.</td></tr>
  133. </table>
  134. </dd>
  135. </dl>
  136. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00869.html">GLM_EXT_scalar_integer</a> </dd></dl>
  137. </div>
  138. </div>
  139. <a id="gaec593d33956a8fe43f78fccc63ddde9a"></a>
  140. <h2 class="memtitle"><span class="permalink"><a href="#gaec593d33956a8fe43f78fccc63ddde9a">&#9670;&nbsp;</a></span>isMultiple()</h2>
  141. <div class="memitem">
  142. <div class="memproto">
  143. <table class="memname">
  144. <tr>
  145. <td class="memname">GLM_FUNC_DECL bool glm::isMultiple </td>
  146. <td>(</td>
  147. <td class="paramtype">genIUType&#160;</td>
  148. <td class="paramname"><em>v</em>, </td>
  149. </tr>
  150. <tr>
  151. <td class="paramkey"></td>
  152. <td></td>
  153. <td class="paramtype">genIUType&#160;</td>
  154. <td class="paramname"><em>Multiple</em>&#160;</td>
  155. </tr>
  156. <tr>
  157. <td></td>
  158. <td>)</td>
  159. <td></td><td></td>
  160. </tr>
  161. </table>
  162. </div><div class="memdoc">
  163. <p>Return true if the 'Value' is a multiple of 'Multiple'. </p>
  164. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00869.html">GLM_EXT_scalar_integer</a> </dd></dl>
  165. </div>
  166. </div>
  167. <a id="gadf491730354aa7da67fbe23d4d688763"></a>
  168. <h2 class="memtitle"><span class="permalink"><a href="#gadf491730354aa7da67fbe23d4d688763">&#9670;&nbsp;</a></span>isPowerOfTwo()</h2>
  169. <div class="memitem">
  170. <div class="memproto">
  171. <table class="memname">
  172. <tr>
  173. <td class="memname">GLM_FUNC_DECL bool glm::isPowerOfTwo </td>
  174. <td>(</td>
  175. <td class="paramtype">genIUType&#160;</td>
  176. <td class="paramname"><em>v</em></td><td>)</td>
  177. <td></td>
  178. </tr>
  179. </table>
  180. </div><div class="memdoc">
  181. <p>Return true if the value is a power of two number. </p>
  182. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00869.html">GLM_EXT_scalar_integer</a> </dd></dl>
  183. </div>
  184. </div>
  185. <a id="gab770a3835c44c8a6fd225be4f4e6b317"></a>
  186. <h2 class="memtitle"><span class="permalink"><a href="#gab770a3835c44c8a6fd225be4f4e6b317">&#9670;&nbsp;</a></span>nextMultiple()</h2>
  187. <div class="memitem">
  188. <div class="memproto">
  189. <table class="memname">
  190. <tr>
  191. <td class="memname">GLM_FUNC_DECL genIUType glm::nextMultiple </td>
  192. <td>(</td>
  193. <td class="paramtype">genIUType&#160;</td>
  194. <td class="paramname"><em>v</em>, </td>
  195. </tr>
  196. <tr>
  197. <td class="paramkey"></td>
  198. <td></td>
  199. <td class="paramtype">genIUType&#160;</td>
  200. <td class="paramname"><em>Multiple</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>Higher multiple number of Source. </p>
  210. <dl class="tparams"><dt>Template Parameters</dt><dd>
  211. <table class="tparams">
  212. <tr><td class="paramname">genIUType</td><td>Integer scalar or vector types.</td></tr>
  213. </table>
  214. </dd>
  215. </dl>
  216. <dl class="params"><dt>Parameters</dt><dd>
  217. <table class="params">
  218. <tr><td class="paramname">v</td><td>Source value to which is applied the function </td></tr>
  219. <tr><td class="paramname">Multiple</td><td>Must be a null or positive value</td></tr>
  220. </table>
  221. </dd>
  222. </dl>
  223. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00869.html">GLM_EXT_scalar_integer</a> </dd></dl>
  224. </div>
  225. </div>
  226. <a id="ga3a37c2f2fd347886c9af6a3ca3db04dc"></a>
  227. <h2 class="memtitle"><span class="permalink"><a href="#ga3a37c2f2fd347886c9af6a3ca3db04dc">&#9670;&nbsp;</a></span>nextPowerOfTwo()</h2>
  228. <div class="memitem">
  229. <div class="memproto">
  230. <table class="memname">
  231. <tr>
  232. <td class="memname">GLM_FUNC_DECL genIUType glm::nextPowerOfTwo </td>
  233. <td>(</td>
  234. <td class="paramtype">genIUType&#160;</td>
  235. <td class="paramname"><em>v</em></td><td>)</td>
  236. <td></td>
  237. </tr>
  238. </table>
  239. </div><div class="memdoc">
  240. <p>Return the power of two number which value is just higher the input value, round up to a power of two. </p>
  241. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00869.html">GLM_EXT_scalar_integer</a> </dd></dl>
  242. </div>
  243. </div>
  244. <a id="gada3bdd871ffe31f2d484aa668362f636"></a>
  245. <h2 class="memtitle"><span class="permalink"><a href="#gada3bdd871ffe31f2d484aa668362f636">&#9670;&nbsp;</a></span>prevMultiple()</h2>
  246. <div class="memitem">
  247. <div class="memproto">
  248. <table class="memname">
  249. <tr>
  250. <td class="memname">GLM_FUNC_DECL genIUType glm::prevMultiple </td>
  251. <td>(</td>
  252. <td class="paramtype">genIUType&#160;</td>
  253. <td class="paramname"><em>v</em>, </td>
  254. </tr>
  255. <tr>
  256. <td class="paramkey"></td>
  257. <td></td>
  258. <td class="paramtype">genIUType&#160;</td>
  259. <td class="paramname"><em>Multiple</em>&#160;</td>
  260. </tr>
  261. <tr>
  262. <td></td>
  263. <td>)</td>
  264. <td></td><td></td>
  265. </tr>
  266. </table>
  267. </div><div class="memdoc">
  268. <p>Lower multiple number of Source. </p>
  269. <dl class="tparams"><dt>Template Parameters</dt><dd>
  270. <table class="tparams">
  271. <tr><td class="paramname">genIUType</td><td>Integer scalar or vector types.</td></tr>
  272. </table>
  273. </dd>
  274. </dl>
  275. <dl class="params"><dt>Parameters</dt><dd>
  276. <table class="params">
  277. <tr><td class="paramname">v</td><td>Source value to which is applied the function </td></tr>
  278. <tr><td class="paramname">Multiple</td><td>Must be a null or positive value</td></tr>
  279. </table>
  280. </dd>
  281. </dl>
  282. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00869.html">GLM_EXT_scalar_integer</a> </dd></dl>
  283. </div>
  284. </div>
  285. <a id="gab21902a0e7e5a8451a7ad80333618727"></a>
  286. <h2 class="memtitle"><span class="permalink"><a href="#gab21902a0e7e5a8451a7ad80333618727">&#9670;&nbsp;</a></span>prevPowerOfTwo()</h2>
  287. <div class="memitem">
  288. <div class="memproto">
  289. <table class="memname">
  290. <tr>
  291. <td class="memname">GLM_FUNC_DECL genIUType glm::prevPowerOfTwo </td>
  292. <td>(</td>
  293. <td class="paramtype">genIUType&#160;</td>
  294. <td class="paramname"><em>v</em></td><td>)</td>
  295. <td></td>
  296. </tr>
  297. </table>
  298. </div><div class="memdoc">
  299. <p>Return the power of two number which value is just lower the input value, round down to a power of two. </p>
  300. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00869.html">GLM_EXT_scalar_integer</a> </dd></dl>
  301. </div>
  302. </div>
  303. </div><!-- contents -->
  304. <!-- start footer part -->
  305. <hr class="footer"/><address class="footer"><small>
  306. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  307. <img class="footer" src="doxygen.png" alt="doxygen"/>
  308. </a> 1.8.18
  309. </small></address>
  310. </body>
  311. </html>