Updated doxygen documentation

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

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>func_integer.hpp Source File</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>
@@ -34,7 +48,7 @@
</div>
<div class="header">
<div class="headertitle">
<h1>func_integer.hpp</h1> </div>
<div class="title">func_integer.hpp</div> </div>
</div>
<div class="contents">
<a href="a00044.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001
@@ -81,55 +95,55 @@
<a name="l00042"></a>00042 {
<a name="l00045"></a>00045
<a name="l00054"></a>00054 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genUType&gt;
<a name="l00055"></a>00055 genUType <a class="code" href="a00145.html#ga1993a179966305ca79b3642b7c72f3d8" title="Adds 32-bit unsigned integer x and y, returning the sum modulo pow(2, 32).">uaddCarry</a>(
<a name="l00055"></a>00055 genUType <a class="code" href="a00145.html#ga7d96efb73301e722a527b912f05f6ac0" title="Adds 32-bit unsigned integer x and y, returning the sum modulo pow(2, 32).">uaddCarry</a>(
<a name="l00056"></a>00056 genUType <span class="keyword">const</span> &amp; x,
<a name="l00057"></a>00057 genUType <span class="keyword">const</span> &amp; y,
<a name="l00058"></a>00058 genUType &amp; carry);
<a name="l00059"></a>00059
<a name="l00068"></a>00068 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genUType&gt;
<a name="l00069"></a>00069 genUType <a class="code" href="a00145.html#gafbe35759c01322be2508750913548162" title="Subtracts the 32-bit unsigned integer y from x, returning the difference if non-negative, or pow(2, 32) plus the difference otherwise.">usubBorrow</a>(
<a name="l00069"></a>00069 genUType <a class="code" href="a00145.html#gacd727c8bb8bda7a509773f9f204ab5a1" title="Subtracts the 32-bit unsigned integer y from x, returning the difference if non-negative, or pow(2, 32) plus the difference otherwise.">usubBorrow</a>(
<a name="l00070"></a>00070 genUType <span class="keyword">const</span> &amp; x,
<a name="l00071"></a>00071 genUType <span class="keyword">const</span> &amp; y,
<a name="l00072"></a>00072 genUType &amp; borrow);
<a name="l00073"></a>00073
<a name="l00082"></a>00082 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genUType&gt;
<a name="l00083"></a>00083 <span class="keywordtype">void</span> <a class="code" href="a00145.html#ga79234161525665ae24d7ca67fe4b0237" title="Multiplies 32-bit integers x and y, producing a 64-bit result.">umulExtended</a>(
<a name="l00083"></a>00083 <span class="keywordtype">void</span> <a class="code" href="a00145.html#ga8e89fcd6b0e2cd96cd2e1b69fdb7afd9" title="Multiplies 32-bit integers x and y, producing a 64-bit result.">umulExtended</a>(
<a name="l00084"></a>00084 genUType <span class="keyword">const</span> &amp; x,
<a name="l00085"></a>00085 genUType <span class="keyword">const</span> &amp; y,
<a name="l00086"></a>00086 genUType &amp; msb,
<a name="l00087"></a>00087 genUType &amp; lsb);
<a name="l00088"></a>00088
<a name="l00097"></a>00097 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genIType&gt;
<a name="l00098"></a>00098 <span class="keywordtype">void</span> <a class="code" href="a00145.html#gaeee6a4af4e142c386548f1a9880df9a2" title="Multiplies 32-bit integers x and y, producing a 64-bit result.">imulExtended</a>(
<a name="l00098"></a>00098 <span class="keywordtype">void</span> <a class="code" href="a00145.html#gab0eaec4d0964925429322eebf8dca6d0" title="Multiplies 32-bit integers x and y, producing a 64-bit result.">imulExtended</a>(
<a name="l00099"></a>00099 genIType <span class="keyword">const</span> &amp; x,
<a name="l00100"></a>00100 genIType <span class="keyword">const</span> &amp; y,
<a name="l00101"></a>00101 genIType &amp; msb,
<a name="l00102"></a>00102 genIType &amp; lsb);
<a name="l00103"></a>00103
<a name="l00119"></a>00119 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genIUType&gt;
<a name="l00120"></a>00120 genIUType <a class="code" href="a00145.html#ga437f3b0e4753f705cf163709cbcc5c5c" title="Extracts bits [offset, offset + bits - 1] from value, returning them in the least significant bits of...">bitfieldExtract</a>(
<a name="l00120"></a>00120 genIUType <a class="code" href="a00145.html#gaeae27fd61779ae93b8d0fa9cef142c3d" title="Extracts bits [offset, offset + bits - 1] from value, returning them in the least significant bits of...">bitfieldExtract</a>(
<a name="l00121"></a>00121 genIUType <span class="keyword">const</span> &amp; Value,
<a name="l00122"></a>00122 <span class="keywordtype">int</span> <span class="keyword">const</span> &amp; Offset,
<a name="l00123"></a>00123 <span class="keywordtype">int</span> <span class="keyword">const</span> &amp; Bits);
<a name="l00124"></a>00124
<a name="l00139"></a>00139 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genIUType&gt;
<a name="l00140"></a>00140 genIUType <a class="code" href="a00145.html#gaa4b2bc29d3947a7589deb0083ca6eba7" title="Returns the insertion the bits least-significant bits of insert into base.">bitfieldInsert</a>(
<a name="l00140"></a>00140 genIUType <a class="code" href="a00145.html#ga490b328e7b5d06b477ede4a59edfb798" title="Returns the insertion the bits least-significant bits of insert into base.">bitfieldInsert</a>(
<a name="l00141"></a>00141 genIUType <span class="keyword">const</span> &amp; Base,
<a name="l00142"></a>00142 genIUType <span class="keyword">const</span> &amp; Insert,
<a name="l00143"></a>00143 <span class="keywordtype">int</span> <span class="keyword">const</span> &amp; Offset,
<a name="l00144"></a>00144 <span class="keywordtype">int</span> <span class="keyword">const</span> &amp; Bits);
<a name="l00145"></a>00145
<a name="l00154"></a>00154 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genIUType&gt;
<a name="l00155"></a>00155 genIUType <a class="code" href="a00145.html#ga84842a3d453fac629aa7d10c1ada2baf" title="Returns the reversal of the bits of value.">bitfieldReverse</a>(genIUType <span class="keyword">const</span> &amp; value);
<a name="l00155"></a>00155 genIUType <a class="code" href="a00145.html#gac36ad04d509817f2f4769d45f13f43e5" title="Returns the reversal of the bits of value.">bitfieldReverse</a>(genIUType <span class="keyword">const</span> &amp; value);
<a name="l00156"></a>00156
<a name="l00165"></a>00165 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>&gt; <span class="keyword">class </span>genIUType&gt;
<a name="l00166"></a>00166 <span class="keyword">typename</span> genIUType&lt;T&gt;::signed_type <a class="code" href="a00145.html#ga2915e0178a1ff7a8a53a43e9b3a88783" title="Returns the number of bits set to 1 in the binary representation of value.">bitCount</a>(genIUType&lt;T&gt; <span class="keyword">const</span> &amp; Value);
<a name="l00166"></a>00166 <span class="keyword">typename</span> genIUType&lt;T&gt;::signed_type <a class="code" href="a00145.html#ga5c4d37c42926b09be4384a9656f73ee4" title="Returns the number of bits set to 1 in the binary representation of value.">bitCount</a>(genIUType&lt;T&gt; <span class="keyword">const</span> &amp; Value);
<a name="l00167"></a>00167
<a name="l00178"></a>00178 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>&gt; <span class="keyword">class </span>genIUType&gt;
<a name="l00179"></a>00179 <span class="keyword">typename</span> genIUType&lt;T&gt;::signed_type <a class="code" href="a00145.html#ga3269107c94ae97255208933d5a65d9b0" title="Returns the bit number of the least significant bit set to 1 in the binary representation of value...">findLSB</a>(genIUType&lt;T&gt; <span class="keyword">const</span> &amp; Value);
<a name="l00179"></a>00179 <span class="keyword">typename</span> genIUType&lt;T&gt;::signed_type <a class="code" href="a00145.html#gaf921488d20990ec15f3fde3d1db919f0" title="Returns the bit number of the least significant bit set to 1 in the binary representation of value...">findLSB</a>(genIUType&lt;T&gt; <span class="keyword">const</span> &amp; Value);
<a name="l00180"></a>00180
<a name="l00192"></a>00192 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>&gt; <span class="keyword">class </span>genIUType&gt;
<a name="l00193"></a>00193 <span class="keyword">typename</span> genIUType&lt;T&gt;::signed_type <a class="code" href="a00145.html#ga7bde0232f7c18d11f18a26abc228e663" title="Returns the bit number of the most significant bit in the binary representation of value...">findMSB</a>(genIUType&lt;T&gt; <span class="keyword">const</span> &amp; Value);
<a name="l00193"></a>00193 <span class="keyword">typename</span> genIUType&lt;T&gt;::signed_type <a class="code" href="a00145.html#gaa17f942299cb7a51c60155f9e78228f3" title="Returns the bit number of the most significant bit in the binary representation of value...">findMSB</a>(genIUType&lt;T&gt; <span class="keyword">const</span> &amp; Value);
<a name="l00194"></a>00194
<a name="l00196"></a>00196 }<span class="comment">//namespace glm</span>
<a name="l00197"></a>00197
@@ -139,8 +153,13 @@
<a name="l00201"></a>00201 <span class="preprocessor"></span>
</pre></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>