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>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>integer.hpp</h1> </div>
<div class="title">integer.hpp</div> </div>
</div>
<div class="contents">
<a href="a00057.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001
@@ -78,7 +92,7 @@
<a name="l00039"></a>00039 <span class="preprocessor"></span><span class="preprocessor">#define GLM_GTX_integer GLM_VERSION</span>
<a name="l00040"></a>00040 <span class="preprocessor"></span>
<a name="l00041"></a>00041 <span class="comment">// Dependency:</span>
<a name="l00042"></a>00042 <span class="preprocessor">#include &quot;<a class="code" href="a00050.html" title="OpenGL Mathematics (glm.g-truc.net)">../glm.hpp</a>&quot;</span>
<a name="l00042"></a>00042 <span class="preprocessor">#include &quot;../glm.hpp&quot;</span>
<a name="l00043"></a>00043
<a name="l00044"></a>00044 <span class="preprocessor">#if(defined(GLM_MESSAGES) &amp;&amp; !defined(glm_ext))</span>
<a name="l00045"></a>00045 <span class="preprocessor"></span><span class="preprocessor"># pragma message(&quot;GLM: GLM_GTX_integer extension included&quot;)</span>
@@ -87,27 +101,27 @@
<a name="l00048"></a>00048 <span class="keyword">namespace </span>glm
<a name="l00049"></a>00049 {
<a name="l00052"></a>00052
<a name="l00055"></a>00055 <span class="keywordtype">int</span> <a class="code" href="a00143.html#ga291bf218b9487a321a604265a932a3bc" title="Returns x raised to the y power.">pow</a>(<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y);
<a name="l00055"></a>00055 <span class="keywordtype">int</span> <a class="code" href="a00143.html#gac93ea301c287d87a63fa14a4c44b719b" title="Returns x raised to the y power.">pow</a>(<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y);
<a name="l00056"></a>00056
<a name="l00059"></a>00059 <span class="keywordtype">int</span> <a class="code" href="a00143.html#gaf9a4f8d8d30594504ddd224af57dd105" title="Returns the positive square root of x.">sqrt</a>(<span class="keywordtype">int</span> x);
<a name="l00059"></a>00059 <span class="keywordtype">int</span> <a class="code" href="a00143.html#ga9b2fd4f39c29e3d55c4b4087ab873f9f" title="Returns the positive square root of x.">sqrt</a>(<span class="keywordtype">int</span> x);
<a name="l00060"></a>00060
<a name="l00063"></a>00063 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genIUType&gt;
<a name="l00064"></a>00064 genIUType <a class="code" href="a00143.html#gaa5dc33fffa41105a680252706d471c36" title="Returns the base 2 log of x, i.e., returns the value y, which satisfies the equation x = 2 ^ y...">log2</a>(genIUType <span class="keyword">const</span> &amp; x);
<a name="l00064"></a>00064 genIUType <a class="code" href="a00143.html#gae19ff18661b33a0fe1b8edee61382f40" title="Returns the base 2 log of x, i.e., returns the value y, which satisfies the equation x = 2 ^ y...">log2</a>(genIUType <span class="keyword">const</span> &amp; x);
<a name="l00065"></a>00065
<a name="l00068"></a>00068 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="a00189.html#ga054b9fd24e0d18af9ae7e9b6bfb5a2c9" title="Returns the floor log2 of x.">floor_log2</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> x);
<a name="l00069"></a>00069
<a name="l00072"></a>00072 <span class="keywordtype">int</span> mod(<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y);
<a name="l00072"></a>00072 <span class="keywordtype">int</span> <a class="code" href="a00142.html#ga3bdf136bc96f670965cd2f48d14356b4" title="Modulus.">mod</a>(<span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y);
<a name="l00073"></a>00073
<a name="l00076"></a>00076 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt;
<a name="l00077"></a>00077 genType <a class="code" href="a00189.html#ga56d0b5195667769d9f43859d3fd0ed12" title="Return the factorial value of a number (!12 max, integer only) From GLM_GTX_integer extension...">factorial</a>(genType <span class="keyword">const</span> &amp; x);
<a name="l00077"></a>00077 genType <a class="code" href="a00189.html#ga6912d62d2f314fa38ef4c94fda778294" title="Return the factorial value of a number (!12 max, integer only) From GLM_GTX_integer extension...">factorial</a>(genType <span class="keyword">const</span> &amp; x);
<a name="l00078"></a>00078
<a name="l00081"></a><a class="code" href="a00189.html#gada7e83fdfe943aba4f1d5bf80cb66f40">00081</a> <span class="keyword">typedef</span> <span class="keywordtype">signed</span> <span class="keywordtype">int</span> <a class="code" href="a00189.html#gada7e83fdfe943aba4f1d5bf80cb66f40" title="32bit signed integer.">sint</a>;
<a name="l00082"></a>00082
<a name="l00085"></a>00085 uint <a class="code" href="a00143.html#ga291bf218b9487a321a604265a932a3bc" title="Returns x raised to the y power.">pow</a>(uint x, uint y);
<a name="l00085"></a>00085 uint <a class="code" href="a00143.html#gac93ea301c287d87a63fa14a4c44b719b" title="Returns x raised to the y power.">pow</a>(uint x, uint y);
<a name="l00086"></a>00086
<a name="l00089"></a>00089 uint <a class="code" href="a00143.html#gaf9a4f8d8d30594504ddd224af57dd105" title="Returns the positive square root of x.">sqrt</a>(uint x);
<a name="l00089"></a>00089 uint <a class="code" href="a00143.html#ga9b2fd4f39c29e3d55c4b4087ab873f9f" title="Returns the positive square root of x.">sqrt</a>(uint x);
<a name="l00090"></a>00090
<a name="l00093"></a>00093 uint mod(uint x, uint y);
<a name="l00093"></a>00093 uint <a class="code" href="a00142.html#ga3bdf136bc96f670965cd2f48d14356b4" title="Modulus.">mod</a>(uint x, uint y);
<a name="l00094"></a>00094
<a name="l00097"></a>00097 uint <a class="code" href="a00189.html#gade78ad3e82d61001f4641571db4dd56e" title="Returns the number of leading zeros.">nlz</a>(uint x);
<a name="l00098"></a>00098
@@ -118,8 +132,13 @@
<a name="l00104"></a>00104 <span class="preprocessor">#endif//GLM_GTX_integer</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>