mewin/glm
1
0
Fork 0
Code Releases Activity

Updated doxygen documentation

Browse Source
This commit is contained in:
Christophe Riccio
2011-12-07 14:50:15 +00:00
parent a3b5034d4e
commit f18ad6bf2e
389 changed files with 27429 additions and 14460 deletions
Download Patch File Download Diff File Expand all files Collapse all files

80
doc/api-0.9.3/a00145.html
View File

@@ -2,22 +2,36 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Integer functions</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo-mini.png"></td>
<td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
@@ -32,41 +46,38 @@
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>Integer functions</h1> </div>
<div class="title">Integer functions</div> </div>
<div class="ingroups"><a class="el" href="a00154.html">GLM Core</a></div></div>
<div class="contents">
<p>These all operate component-wise.
<a href="#_details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T , template&lt; typename &gt; class genIUType&gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genIUType&lt; T &gt;::signed_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00145.html#ga2915e0178a1ff7a8a53a43e9b3a88783">bitCount</a> (genIUType&lt; T &gt; const &amp;Value)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genIUType&lt; T &gt;::signed_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00145.html#ga5c4d37c42926b09be4384a9656f73ee4">bitCount</a> (genIUType&lt; T &gt; const &amp;Value)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename genIUType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genIUType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00145.html#ga437f3b0e4753f705cf163709cbcc5c5c">bitfieldExtract</a> (genIUType const &amp;Value, int const &amp;Offset, int const &amp;Bits)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genIUType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00145.html#gaeae27fd61779ae93b8d0fa9cef142c3d">bitfieldExtract</a> (genIUType const &amp;Value, int const &amp;Offset, int const &amp;Bits)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename genIUType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genIUType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00145.html#gaa4b2bc29d3947a7589deb0083ca6eba7">bitfieldInsert</a> (genIUType const &amp;Base, genIUType const &amp;Insert, int const &amp;Offset, int const &amp;Bits)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genIUType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00145.html#ga490b328e7b5d06b477ede4a59edfb798">bitfieldInsert</a> (genIUType const &amp;Base, genIUType const &amp;Insert, int const &amp;Offset, int const &amp;Bits)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename genIUType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genIUType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00145.html#ga84842a3d453fac629aa7d10c1ada2baf">bitfieldReverse</a> (genIUType const &amp;value)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genIUType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00145.html#gac36ad04d509817f2f4769d45f13f43e5">bitfieldReverse</a> (genIUType const &amp;value)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T , template&lt; typename &gt; class genIUType&gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genIUType&lt; T &gt;::signed_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00145.html#ga3269107c94ae97255208933d5a65d9b0">findLSB</a> (genIUType&lt; T &gt; const &amp;Value)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genIUType&lt; T &gt;::signed_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00145.html#gaf921488d20990ec15f3fde3d1db919f0">findLSB</a> (genIUType&lt; T &gt; const &amp;Value)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T , template&lt; typename &gt; class genIUType&gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genIUType&lt; T &gt;::signed_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00145.html#ga7bde0232f7c18d11f18a26abc228e663">findMSB</a> (genIUType&lt; T &gt; const &amp;Value)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genIUType&lt; T &gt;::signed_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00145.html#gaa17f942299cb7a51c60155f9e78228f3">findMSB</a> (genIUType&lt; T &gt; const &amp;Value)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename genIType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00145.html#gaeee6a4af4e142c386548f1a9880df9a2">imulExtended</a> (genIType const &amp;x, genIType const &amp;y, genIType &amp;msb, genIType &amp;lsb)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00145.html#gab0eaec4d0964925429322eebf8dca6d0">imulExtended</a> (genIType const &amp;x, genIType const &amp;y, genIType &amp;msb, genIType &amp;lsb)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename genUType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genUType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00145.html#ga1993a179966305ca79b3642b7c72f3d8">uaddCarry</a> (genUType const &amp;x, genUType const &amp;y, genUType &amp;carry)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genUType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00145.html#ga7d96efb73301e722a527b912f05f6ac0">uaddCarry</a> (genUType const &amp;x, genUType const &amp;y, genUType &amp;carry)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename genUType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00145.html#ga79234161525665ae24d7ca67fe4b0237">umulExtended</a> (genUType const &amp;x, genUType const &amp;y, genUType &amp;msb, genUType &amp;lsb)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00145.html#ga8e89fcd6b0e2cd96cd2e1b69fdb7afd9">umulExtended</a> (genUType const &amp;x, genUType const &amp;y, genUType &amp;msb, genUType &amp;lsb)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename genUType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genUType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00145.html#gafbe35759c01322be2508750913548162">usubBorrow</a> (genUType const &amp;x, genUType const &amp;y, genUType &amp;borrow)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">genUType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00145.html#gacd727c8bb8bda7a509773f9f204ab5a1">usubBorrow</a> (genUType const &amp;x, genUType const &amp;y, genUType &amp;borrow)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>These all operate component-wise. </p>
<p>The description is per component. The notation [a, b] means the set of bits from bit-number a through bit-number b, inclusive. The lowest-order bit is bit 0. </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga2915e0178a1ff7a8a53a43e9b3a88783"></a><!-- doxytag: member="glm::bitCount" ref="ga2915e0178a1ff7a8a53a43e9b3a88783" args="(genIUType&lt; T &gt; const &amp;Value)" -->
<a class="anchor" id="ga5c4d37c42926b09be4384a9656f73ee4"></a><!-- doxytag: member="glm::bitCount" ref="ga5c4d37c42926b09be4384a9656f73ee4" args="(genIUType&lt; T &gt; const &amp;Value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -95,7 +106,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="ga437f3b0e4753f705cf163709cbcc5c5c"></a><!-- doxytag: member="glm::bitfieldExtract" ref="ga437f3b0e4753f705cf163709cbcc5c5c" args="(genIUType const &amp;Value, int const &amp;Offset, int const &amp;Bits)" -->
<a class="anchor" id="gaeae27fd61779ae93b8d0fa9cef142c3d"></a><!-- doxytag: member="glm::bitfieldExtract" ref="gaeae27fd61779ae93b8d0fa9cef142c3d" args="(genIUType const &amp;Value, int const &amp;Offset, int const &amp;Bits)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -141,7 +152,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="gaa4b2bc29d3947a7589deb0083ca6eba7"></a><!-- doxytag: member="glm::bitfieldInsert" ref="gaa4b2bc29d3947a7589deb0083ca6eba7" args="(genIUType const &amp;Base, genIUType const &amp;Insert, int const &amp;Offset, int const &amp;Bits)" -->
<a class="anchor" id="ga490b328e7b5d06b477ede4a59edfb798"></a><!-- doxytag: member="glm::bitfieldInsert" ref="ga490b328e7b5d06b477ede4a59edfb798" args="(genIUType const &amp;Base, genIUType const &amp;Insert, int const &amp;Offset, int const &amp;Bits)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -192,7 +203,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="ga84842a3d453fac629aa7d10c1ada2baf"></a><!-- doxytag: member="glm::bitfieldReverse" ref="ga84842a3d453fac629aa7d10c1ada2baf" args="(genIUType const &amp;value)" -->
<a class="anchor" id="gac36ad04d509817f2f4769d45f13f43e5"></a><!-- doxytag: member="glm::bitfieldReverse" ref="gac36ad04d509817f2f4769d45f13f43e5" args="(genIUType const &amp;value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -221,7 +232,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="ga3269107c94ae97255208933d5a65d9b0"></a><!-- doxytag: member="glm::findLSB" ref="ga3269107c94ae97255208933d5a65d9b0" args="(genIUType&lt; T &gt; const &amp;Value)" -->
<a class="anchor" id="gaf921488d20990ec15f3fde3d1db919f0"></a><!-- doxytag: member="glm::findLSB" ref="gaf921488d20990ec15f3fde3d1db919f0" args="(genIUType&lt; T &gt; const &amp;Value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -251,7 +262,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="ga7bde0232f7c18d11f18a26abc228e663"></a><!-- doxytag: member="glm::findMSB" ref="ga7bde0232f7c18d11f18a26abc228e663" args="(genIUType&lt; T &gt; const &amp;Value)" -->
<a class="anchor" id="gaa17f942299cb7a51c60155f9e78228f3"></a><!-- doxytag: member="glm::findMSB" ref="gaa17f942299cb7a51c60155f9e78228f3" args="(genIUType&lt; T &gt; const &amp;Value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -281,7 +292,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="gaeee6a4af4e142c386548f1a9880df9a2"></a><!-- doxytag: member="glm::imulExtended" ref="gaeee6a4af4e142c386548f1a9880df9a2" args="(genIType const &amp;x, genIType const &amp;y, genIType &amp;msb, genIType &amp;lsb)" -->
<a class="anchor" id="gab0eaec4d0964925429322eebf8dca6d0"></a><!-- doxytag: member="glm::imulExtended" ref="gab0eaec4d0964925429322eebf8dca6d0" args="(genIType const &amp;x, genIType const &amp;y, genIType &amp;msb, genIType &amp;lsb)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -332,7 +343,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="ga1993a179966305ca79b3642b7c72f3d8"></a><!-- doxytag: member="glm::uaddCarry" ref="ga1993a179966305ca79b3642b7c72f3d8" args="(genUType const &amp;x, genUType const &amp;y, genUType &amp;carry)" -->
<a class="anchor" id="ga7d96efb73301e722a527b912f05f6ac0"></a><!-- doxytag: member="glm::uaddCarry" ref="ga7d96efb73301e722a527b912f05f6ac0" args="(genUType const &amp;x, genUType const &amp;y, genUType &amp;carry)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -377,7 +388,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="ga79234161525665ae24d7ca67fe4b0237"></a><!-- doxytag: member="glm::umulExtended" ref="ga79234161525665ae24d7ca67fe4b0237" args="(genUType const &amp;x, genUType const &amp;y, genUType &amp;msb, genUType &amp;lsb)" -->
<a class="anchor" id="ga8e89fcd6b0e2cd96cd2e1b69fdb7afd9"></a><!-- doxytag: member="glm::umulExtended" ref="ga8e89fcd6b0e2cd96cd2e1b69fdb7afd9" args="(genUType const &amp;x, genUType const &amp;y, genUType &amp;msb, genUType &amp;lsb)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -428,7 +439,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="gafbe35759c01322be2508750913548162"></a><!-- doxytag: member="glm::usubBorrow" ref="gafbe35759c01322be2508750913548162" args="(genUType const &amp;x, genUType const &amp;y, genUType &amp;borrow)" -->
<a class="anchor" id="gacd727c8bb8bda7a509773f9f204ab5a1"></a><!-- doxytag: member="glm::usubBorrow" ref="gacd727c8bb8bda7a509773f9f204ab5a1" args="(genUType const &amp;x, genUType const &amp;y, genUType &amp;borrow)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -474,8 +485,13 @@ Functions</h2></td></tr>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.5
</small></address>
</body>
</html>