glm/doc/api-0.9.2/a00276.html
Christophe Riccio 8d2d112180 Added API doc
2011-10-24 15:24:48 +01:00

471 lines
20 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>GLM_GTX_norm: Vector norm calculations</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</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="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">GLM_GTX_norm: Vector norm calculations</div> </div>
<div class="ingroups"><a class="el" href="a00248.html">GTX Extensions (Experimental)</a></div></div>
<div class="contents">
<p>Various way to compute vector norms.
<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 &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00276.html#ga8ced68108693319d844c896d3e8a2887">distance2</a> (const T p0, const T p1)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00276.html#gada108564c8942d3ef4764000dd594a9e">distance2</a> (const detail::tvec3&lt; T &gt; &amp;p0, const detail::tvec3&lt; T &gt; &amp;p1)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00276.html#ga98e5a19ff47fa12f7706625348ef42db">distance2</a> (const detail::tvec4&lt; T &gt; &amp;p0, const detail::tvec4&lt; T &gt; &amp;p1)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00276.html#ga33760ddfae66d50cc5068e132086aa23">distance2</a> (const detail::tvec2&lt; T &gt; &amp;p0, const detail::tvec2&lt; T &gt; &amp;p1)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00276.html#gab9942ce9c9a3de0fcb2b2d1a7eea5d1b">l1Norm</a> (const detail::tvec3&lt; T &gt; &amp;x, const detail::tvec3&lt; T &gt; &amp;y)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00276.html#ga98acb7ecd07cedacaff9af8b4085a29a">l1Norm</a> (const detail::tvec3&lt; T &gt; &amp;v)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00276.html#ga281fb89a1b196753973cb6932ed43042">l2Norm</a> (const detail::tvec3&lt; T &gt; &amp;x)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00276.html#ga2963700ea5540e339e021733f9b1c285">l2Norm</a> (const detail::tvec3&lt; T &gt; &amp;x, const detail::tvec3&lt; T &gt; &amp;y)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00276.html#ga0ba79b01a2b7935086007d58357acea3">length2</a> (const detail::tvec4&lt; T &gt; &amp;x)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00276.html#ga461cea3ee3b98f8fcfea856def1f0ede">length2</a> (const T x)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00276.html#gac7f1bcdfe9c78e388cffd45683fa7fdd">length2</a> (const detail::tvec2&lt; T &gt; &amp;x)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00276.html#ga812dd3800d13ed6c2808041d34c5f6a0">length2</a> (const detail::tvec3&lt; T &gt; &amp;x)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00276.html#gae70a605bad6c714a2e091db043408d99">length2</a> (const detail::tquat&lt; T &gt; &amp;q)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00276.html#gacfed1ae105bff09745f86d8789503776">lxNorm</a> (const detail::tvec3&lt; T &gt; &amp;x, unsigned int Depth)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00276.html#gab6b384000fdc1a560fd927684f4f3a2a">lxNorm</a> (const detail::tvec3&lt; T &gt; &amp;x, const detail::tvec3&lt; T &gt; &amp;y, unsigned int Depth)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>Various way to compute vector norms. </p>
<p>&lt;<a class="el" href="a00083_source.html">glm/gtx/norm.hpp</a>&gt; need to be included to use these functionalities. </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga8ced68108693319d844c896d3e8a2887"></a><!-- doxytag: member="glm::gtx::norm::distance2" ref="ga8ced68108693319d844c896d3e8a2887" args="(const T p0, const T p1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T glm::gtx::norm::distance2 </td>
<td>(</td>
<td class="paramtype">const T&#160;</td>
<td class="paramname"><em>p0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const T&#160;</td>
<td class="paramname"><em>p1</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the squared distance between p0 and p1, i.e., length(p0 - p1). </p>
<p>From GLM_GTX_norm extension. </p>
</div>
</div>
<a class="anchor" id="gada108564c8942d3ef4764000dd594a9e"></a><!-- doxytag: member="glm::gtx::norm::distance2" ref="gada108564c8942d3ef4764000dd594a9e" args="(const detail::tvec3&lt; T &gt; &amp;p0, const detail::tvec3&lt; T &gt; &amp;p1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T glm::gtx::norm::distance2 </td>
<td>(</td>
<td class="paramtype">const detail::tvec3&lt; T &gt; &amp;&#160;</td>
<td class="paramname"><em>p0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const detail::tvec3&lt; T &gt; &amp;&#160;</td>
<td class="paramname"><em>p1</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the squared distance between p0 and p1, i.e., length(p0 - p1). </p>
<p>From GLM_GTX_norm extension. </p>
</div>
</div>
<a class="anchor" id="ga98e5a19ff47fa12f7706625348ef42db"></a><!-- doxytag: member="glm::gtx::norm::distance2" ref="ga98e5a19ff47fa12f7706625348ef42db" args="(const detail::tvec4&lt; T &gt; &amp;p0, const detail::tvec4&lt; T &gt; &amp;p1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T glm::gtx::norm::distance2 </td>
<td>(</td>
<td class="paramtype">const detail::tvec4&lt; T &gt; &amp;&#160;</td>
<td class="paramname"><em>p0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const detail::tvec4&lt; T &gt; &amp;&#160;</td>
<td class="paramname"><em>p1</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the squared distance between p0 and p1, i.e., length(p0 - p1). </p>
<p>From GLM_GTX_norm extension. </p>
</div>
</div>
<a class="anchor" id="ga33760ddfae66d50cc5068e132086aa23"></a><!-- doxytag: member="glm::gtx::norm::distance2" ref="ga33760ddfae66d50cc5068e132086aa23" args="(const detail::tvec2&lt; T &gt; &amp;p0, const detail::tvec2&lt; T &gt; &amp;p1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T glm::gtx::norm::distance2 </td>
<td>(</td>
<td class="paramtype">const detail::tvec2&lt; T &gt; &amp;&#160;</td>
<td class="paramname"><em>p0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const detail::tvec2&lt; T &gt; &amp;&#160;</td>
<td class="paramname"><em>p1</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the squared distance between p0 and p1, i.e., length(p0 - p1). </p>
<p>From GLM_GTX_norm extension. </p>
</div>
</div>
<a class="anchor" id="gab9942ce9c9a3de0fcb2b2d1a7eea5d1b"></a><!-- doxytag: member="glm::gtx::norm::l1Norm" ref="gab9942ce9c9a3de0fcb2b2d1a7eea5d1b" args="(const detail::tvec3&lt; T &gt; &amp;x, const detail::tvec3&lt; T &gt; &amp;y)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T glm::gtx::norm::l1Norm </td>
<td>(</td>
<td class="paramtype">const detail::tvec3&lt; T &gt; &amp;&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const detail::tvec3&lt; T &gt; &amp;&#160;</td>
<td class="paramname"><em>y</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the L1 norm between x and y. </p>
<p>From GLM_GTX_norm extension. </p>
</div>
</div>
<a class="anchor" id="ga98acb7ecd07cedacaff9af8b4085a29a"></a><!-- doxytag: member="glm::gtx::norm::l1Norm" ref="ga98acb7ecd07cedacaff9af8b4085a29a" args="(const detail::tvec3&lt; T &gt; &amp;v)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T glm::gtx::norm::l1Norm </td>
<td>(</td>
<td class="paramtype">const detail::tvec3&lt; T &gt; &amp;&#160;</td>
<td class="paramname"><em>v</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the L1 norm of v. </p>
<p>From GLM_GTX_norm extension. </p>
</div>
</div>
<a class="anchor" id="ga281fb89a1b196753973cb6932ed43042"></a><!-- doxytag: member="glm::gtx::norm::l2Norm" ref="ga281fb89a1b196753973cb6932ed43042" args="(const detail::tvec3&lt; T &gt; &amp;x)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T glm::gtx::norm::l2Norm </td>
<td>(</td>
<td class="paramtype">const detail::tvec3&lt; T &gt; &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the L2 norm of v. </p>
<p>From GLM_GTX_norm extension. </p>
</div>
</div>
<a class="anchor" id="ga2963700ea5540e339e021733f9b1c285"></a><!-- doxytag: member="glm::gtx::norm::l2Norm" ref="ga2963700ea5540e339e021733f9b1c285" args="(const detail::tvec3&lt; T &gt; &amp;x, const detail::tvec3&lt; T &gt; &amp;y)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T glm::gtx::norm::l2Norm </td>
<td>(</td>
<td class="paramtype">const detail::tvec3&lt; T &gt; &amp;&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const detail::tvec3&lt; T &gt; &amp;&#160;</td>
<td class="paramname"><em>y</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the L2 norm between x and y. </p>
<p>From GLM_GTX_norm extension. </p>
</div>
</div>
<a class="anchor" id="ga0ba79b01a2b7935086007d58357acea3"></a><!-- doxytag: member="glm::gtx::norm::length2" ref="ga0ba79b01a2b7935086007d58357acea3" args="(const detail::tvec4&lt; T &gt; &amp;x)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T glm::gtx::norm::length2 </td>
<td>(</td>
<td class="paramtype">const detail::tvec4&lt; T &gt; &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the squared length of x. </p>
<p>From GLM_GTX_norm extension. </p>
</div>
</div>
<a class="anchor" id="ga461cea3ee3b98f8fcfea856def1f0ede"></a><!-- doxytag: member="glm::gtx::norm::length2" ref="ga461cea3ee3b98f8fcfea856def1f0ede" args="(const T x)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T glm::gtx::norm::length2 </td>
<td>(</td>
<td class="paramtype">const T&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the squared length of x. </p>
<p>From GLM_GTX_norm extension. </p>
</div>
</div>
<a class="anchor" id="gac7f1bcdfe9c78e388cffd45683fa7fdd"></a><!-- doxytag: member="glm::gtx::norm::length2" ref="gac7f1bcdfe9c78e388cffd45683fa7fdd" args="(const detail::tvec2&lt; T &gt; &amp;x)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T glm::gtx::norm::length2 </td>
<td>(</td>
<td class="paramtype">const detail::tvec2&lt; T &gt; &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the squared length of x. </p>
<p>From GLM_GTX_norm extension. </p>
</div>
</div>
<a class="anchor" id="ga812dd3800d13ed6c2808041d34c5f6a0"></a><!-- doxytag: member="glm::gtx::norm::length2" ref="ga812dd3800d13ed6c2808041d34c5f6a0" args="(const detail::tvec3&lt; T &gt; &amp;x)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T glm::gtx::norm::length2 </td>
<td>(</td>
<td class="paramtype">const detail::tvec3&lt; T &gt; &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the squared length of x. </p>
<p>From GLM_GTX_norm extension. </p>
</div>
</div>
<a class="anchor" id="gae70a605bad6c714a2e091db043408d99"></a><!-- doxytag: member="glm::gtx::norm::length2" ref="gae70a605bad6c714a2e091db043408d99" args="(const detail::tquat&lt; T &gt; &amp;q)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T glm::gtx::norm::length2 </td>
<td>(</td>
<td class="paramtype">const detail::tquat&lt; T &gt; &amp;&#160;</td>
<td class="paramname"><em>q</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the squared length of x. </p>
<p>From GLM_GTX_norm extension. </p>
</div>
</div>
<a class="anchor" id="gacfed1ae105bff09745f86d8789503776"></a><!-- doxytag: member="glm::gtx::norm::lxNorm" ref="gacfed1ae105bff09745f86d8789503776" args="(const detail::tvec3&lt; T &gt; &amp;x, unsigned int Depth)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T glm::gtx::norm::lxNorm </td>
<td>(</td>
<td class="paramtype">const detail::tvec3&lt; T &gt; &amp;&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>Depth</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the L norm of v. </p>
<p>From GLM_GTX_norm extension. </p>
</div>
</div>
<a class="anchor" id="gab6b384000fdc1a560fd927684f4f3a2a"></a><!-- doxytag: member="glm::gtx::norm::lxNorm" ref="gab6b384000fdc1a560fd927684f4f3a2a" args="(const detail::tvec3&lt; T &gt; &amp;x, const detail::tvec3&lt; T &gt; &amp;y, unsigned int Depth)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T glm::gtx::norm::lxNorm </td>
<td>(</td>
<td class="paramtype">const detail::tvec3&lt; T &gt; &amp;&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const detail::tvec3&lt; T &gt; &amp;&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>Depth</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the L norm between x and y. </p>
<p>From GLM_GTX_norm extension. </p>
</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.4 </small></address>
</body>
</html>