mewin/glm
1
0
Fork 0
Code Releases Activity

Updated API documentation

Browse Source
This commit is contained in:
Christophe Riccio
2013-12-25 23:48:55 +01:00
parent 792e5ff74f
commit fee3eddd37
459 changed files with 76100 additions and 48806 deletions
Download Patch File Download Diff File Expand all files Collapse all files

256
doc/api/a00159.html
View File

@@ -3,7 +3,8 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>GLM_GTC_ulp</title>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>GLM: Matrix functions</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
@@ -15,18 +16,23 @@
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">GLM
&#160;<span id="projectnumber">0.9.5</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.2 -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
@@ -35,49 +41,106 @@
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">GLM_GTC_ulp</div> </div>
<div class="ingroups"><a class="el" href="a00138.html">GTC Extensions (Stable)</a></div></div><!--header-->
<div class="title">Matrix functions<div class="ingroups"><a class="el" href="a00167.html">GLM Core</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga0c49c371f6b2adf02d03661e0f2499c9"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ga0c49c371f6b2adf02d03661e0f2499c9"><td class="memTemplItemLeft" align="right" valign="top">uint&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00159.html#ga0c49c371f6b2adf02d03661e0f2499c9">float_distance</a> (T const &amp;x, T const &amp;y)</td></tr>
<tr class="separator:ga0c49c371f6b2adf02d03661e0f2499c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9b2de9eb54e59f20b20f7eccd40d435e"><td class="memTemplParams" colspan="2">template&lt;typename T , template&lt; typename &gt; class vecType&gt; </td></tr>
<tr class="memitem:ga9b2de9eb54e59f20b20f7eccd40d435e"><td class="memTemplItemLeft" align="right" valign="top">vecType&lt; uint &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00159.html#ga9b2de9eb54e59f20b20f7eccd40d435e">float_distance</a> (vecType&lt; T &gt; const &amp;x, vecType&lt; T &gt; const &amp;y)</td></tr>
<tr class="separator:ga9b2de9eb54e59f20b20f7eccd40d435e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3be6de2d954fb457ff88085128e4b521"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga3be6de2d954fb457ff88085128e4b521"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00159.html#ga3be6de2d954fb457ff88085128e4b521">next_float</a> (genType const &amp;x)</td></tr>
<tr class="separator:ga3be6de2d954fb457ff88085128e4b521"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga27752f3f7a9a79a50e95a9ed42800ca7"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga27752f3f7a9a79a50e95a9ed42800ca7"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00159.html#ga27752f3f7a9a79a50e95a9ed42800ca7">next_float</a> (genType const &amp;x, uint const &amp;Distance)</td></tr>
<tr class="separator:ga27752f3f7a9a79a50e95a9ed42800ca7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2a0122b31c643ca1546635fe8e4f9f74"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga2a0122b31c643ca1546635fe8e4f9f74"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00159.html#ga2a0122b31c643ca1546635fe8e4f9f74">prev_float</a> (genType const &amp;x)</td></tr>
<tr class="separator:ga2a0122b31c643ca1546635fe8e4f9f74"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae506d2fb08aff01e00763d7ed76fe117"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:gae506d2fb08aff01e00763d7ed76fe117"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00159.html#gae506d2fb08aff01e00763d7ed76fe117">prev_float</a> (genType const &amp;x, uint const &amp;Distance)</td></tr>
<tr class="separator:gae506d2fb08aff01e00763d7ed76fe117"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga26ea77c574802bc6fc193c40478718d2"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class matType&gt; </td></tr>
<tr class="memitem:ga26ea77c574802bc6fc193c40478718d2"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00159.html#ga26ea77c574802bc6fc193c40478718d2">determinant</a> (matType&lt; T, P &gt; const &amp;m)</td></tr>
<tr class="separator:ga26ea77c574802bc6fc193c40478718d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7635d3dbe5aa10ff73a0e6903bf6bea5"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class matType&gt; </td></tr>
<tr class="memitem:ga7635d3dbe5aa10ff73a0e6903bf6bea5"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL matType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00159.html#ga7635d3dbe5aa10ff73a0e6903bf6bea5">inverse</a> (matType&lt; T, P &gt; const &amp;m)</td></tr>
<tr class="separator:ga7635d3dbe5aa10ff73a0e6903bf6bea5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4a54992e4741188ee624b21e3ba91814"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class matType&gt; </td></tr>
<tr class="memitem:ga4a54992e4741188ee624b21e3ba91814"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL matType&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00159.html#ga4a54992e4741188ee624b21e3ba91814">matrixCompMult</a> (matType&lt; T, P &gt; const &amp;x, matType&lt; T, P &gt; const &amp;y)</td></tr>
<tr class="separator:ga4a54992e4741188ee624b21e3ba91814"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8ef7ab7abd0437b9cb727d9842a5ecac"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P, template&lt; typename, precision &gt; class vecTypeA, template&lt; typename, precision &gt; class vecTypeB&gt; </td></tr>
<tr class="memitem:ga8ef7ab7abd0437b9cb727d9842a5ecac"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00159.html#ga8ef7ab7abd0437b9cb727d9842a5ecac">outerProduct</a> (vecTypeA&lt; T, P &gt; const &amp;c, vecTypeB&lt; T, P &gt; const &amp;r)</td></tr>
<tr class="separator:ga8ef7ab7abd0437b9cb727d9842a5ecac"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Allow the measurement of the accuracy of a function against a reference implementation. </p>
<p>This extension works on floating-point data and provide results in ULP. &lt;<a class="el" href="a00116.html" title="OpenGL Mathematics (glm.g-truc.net)">glm/gtc/ulp.hpp</a>&gt; need to be included to use these features. </p>
<p>For each of the following built-in matrix functions, there is both a single-precision floating point version, where all arguments and return values are single precision, and a double-precision floating version, where all arguments and return values are double precision. </p>
<p>Only the single-precision floating point version is shown. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga0c49c371f6b2adf02d03661e0f2499c9"></a>
<a class="anchor" id="ga26ea77c574802bc6fc193c40478718d2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint glm::float_distance </td>
<td class="memname">GLM_FUNC_DECL T glm::determinant </td>
<td>(</td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramtype">matType&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>m</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the transposed matrix of x. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">matType</td><td>Floating-point matrix types.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/transpose.xml">GLSL transpose man page</a> </dd>
<dd>
<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.6 Matrix Functions</a> Return the <a class="el" href="a00159.html#ga26ea77c574802bc6fc193c40478718d2" title="Returns the transposed matrix of x. ">determinant</a> of a squared matrix.</dd></dl>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">valType</td><td>Floating-point scalar types.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/determinant.xml">GLSL determinant man page</a> </dd>
<dd>
<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.6 Matrix Functions</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga7635d3dbe5aa10ff73a0e6903bf6bea5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL matType&lt;T, P&gt; glm::inverse </td>
<td>(</td>
<td class="paramtype">matType&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>m</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the inverse of a squared matrix. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">valType</td><td>Floating-point scalar types.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/inverse.xml">GLSL inverse man page</a> </dd>
<dd>
<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.6 Matrix Functions</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga4a54992e4741188ee624b21e3ba91814"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLM_FUNC_DECL matType&lt;T, P&gt; glm::matrixCompMult </td>
<td>(</td>
<td class="paramtype">matType&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramtype">matType&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>y</em>&#160;</td>
</tr>
<tr>
@@ -88,26 +151,34 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Return the distance in the number of ULP between 2 scalars. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00159.html" title="Allow the measurement of the accuracy of a function against a reference implementation.">GLM_GTC_ulp</a> </dd></dl>
<p>Multiply matrix x by matrix y component-wise, i.e., result[i][j] is the scalar product of x[i][j] and y[i][j]. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">matType</td><td>Floating-point matrix types.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/matrixCompMult.xml">GLSL matrixCompMult man page</a> </dd>
<dd>
<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.6 Matrix Functions</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga9b2de9eb54e59f20b20f7eccd40d435e"></a>
<a class="anchor" id="ga8ef7ab7abd0437b9cb727d9842a5ecac"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vecType&lt;uint&gt; glm::float_distance </td>
<td class="memname">GLM_FUNC_DECL void glm::outerProduct </td>
<td>(</td>
<td class="paramtype">vecType&lt; T &gt; const &amp;&#160;</td>
<td class="paramname"><em>x</em>, </td>
<td class="paramtype">vecTypeA&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">vecType&lt; T &gt; const &amp;&#160;</td>
<td class="paramname"><em>y</em>&#160;</td>
<td class="paramtype">vecTypeB&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>r</em>&#160;</td>
</tr>
<tr>
<td></td>
@@ -117,104 +188,17 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Return the distance in the number of ULP between 2 vectors. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00159.html" title="Allow the measurement of the accuracy of a function against a reference implementation.">GLM_GTC_ulp</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga3be6de2d954fb457ff88085128e4b521"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">genType glm::next_float </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the next ULP value(s) after the input value(s). </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00159.html" title="Allow the measurement of the accuracy of a function against a reference implementation.">GLM_GTC_ulp</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga27752f3f7a9a79a50e95a9ed42800ca7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">genType glm::next_float </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint const &amp;&#160;</td>
<td class="paramname"><em>Distance</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the value(s) ULP distance after the input value(s). </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00159.html" title="Allow the measurement of the accuracy of a function against a reference implementation.">GLM_GTC_ulp</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga2a0122b31c643ca1546635fe8e4f9f74"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">genType glm::prev_float </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the previous ULP value(s) before the input value(s). </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00159.html" title="Allow the measurement of the accuracy of a function against a reference implementation.">GLM_GTC_ulp</a> </dd></dl>
</div>
</div>
<a class="anchor" id="gae506d2fb08aff01e00763d7ed76fe117"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">genType glm::prev_float </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint const &amp;&#160;</td>
<td class="paramname"><em>Distance</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the value(s) ULP distance before the input value(s). </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00159.html" title="Allow the measurement of the accuracy of a function against a reference implementation.">GLM_GTC_ulp</a> </dd></dl>
<p>Treats the first parameter c as a column vector and the second parameter r as a row vector and does a linear algebraic matrix multiply c * r. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">matType</td><td>Floating-point matrix types.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/outerProduct.xml">GLSL outerProduct man page</a> </dd>
<dd>
<a href="http://www.opengl.org/registry/doc/GLSLangSpec.4.20.8.pdf">GLSL 4.20.8 specification, section 8.6 Matrix Functions</a></dd></dl>
<dl class="todo"><dt><b><a class="el" href="a00239.html#_todo000004">Todo:</a></b></dt><dd>Clarify the declaration to specify that matType doesn't have to be provided when used. </dd></dl>
</div>
</div>
@@ -223,7 +207,7 @@ Functions</h2></td></tr>
<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.8.2
</a> 1.8.5
</small></address>
</body>
</html>