Updated documentation
This commit is contained in:
@@ -2,243 +2,144 @@
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
|
||||
<title>GLM_GTX_fast_exponential: Fast exponentiation functions</title>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||
<title>GLM_GTX_component_wise</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>
|
||||
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
<body>
|
||||
<div id="top"><!-- do not remove this div! -->
|
||||
|
||||
|
||||
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||
<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.png"/></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<!-- Generated by Doxygen 1.7.5.1 -->
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.2 -->
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</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><!-- top -->
|
||||
<div class="header">
|
||||
<div class="summary">
|
||||
<a href="#func-members">Functions</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">GLM_GTX_fast_exponential: Fast exponentiation functions</div> </div>
|
||||
<div class="ingroups"><a class="el" href="a00137.html">GTX Extensions (Experimental)</a></div></div>
|
||||
<div class="title">GLM_GTX_component_wise</div> </div>
|
||||
<div class="ingroups"><a class="el" href="a00139.html">GTX Extensions (Experimental)</a></div></div><!--header-->
|
||||
<div class="contents">
|
||||
<table class="memberdecls">
|
||||
<tr><td colspan="2"><h2><a name="func-members"></a>
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
||||
Functions</h2></td></tr>
|
||||
<tr><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
||||
<tr><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00167.html#ga81550f837781889cc21fe49852102ea0">fastExp</a> (const T &x)</td></tr>
|
||||
<tr><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
||||
<tr><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00167.html#ga27ffd3d58db8a5309300f16cc5d9284c">fastExp2</a> (const T &x)</td></tr>
|
||||
<tr><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
||||
<tr><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00167.html#gaddd4e635f1c3168122fe7b14753935b9">fastLn</a> (const T &x)</td></tr>
|
||||
<tr><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
||||
<tr><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00167.html#ga784a80d571f0f596d438863775827cd0">fastLog</a> (const T &x)</td></tr>
|
||||
<tr><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
||||
<tr><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00167.html#gac516a11818384b9392412ac199044cf6">fastLog2</a> (const T &x)</td></tr>
|
||||
<tr><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
||||
<tr><td class="memTemplItemLeft" align="right" valign="top">genType </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00167.html#ga0ecbe429c87b820368f425ee8d22841a">fastPow</a> (genType const &x, genType const &y)</td></tr>
|
||||
<tr><td class="memTemplParams" colspan="2">template<typename genTypeT , typename genTypeU > </td></tr>
|
||||
<tr><td class="memTemplItemLeft" align="right" valign="top">genTypeT </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00167.html#ga3afd7b7f1ac505ca9247dc6ffa0c25cb">fastPow</a> (genTypeT const &x, genTypeU const &y)</td></tr>
|
||||
<tr class="memitem:ga70016a744618371aafdb9a6ed8b9ffda"><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
||||
<tr class="memitem:ga70016a744618371aafdb9a6ed8b9ffda"><td class="memTemplItemLeft" align="right" valign="top">genType::value_type </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00167.html#ga70016a744618371aafdb9a6ed8b9ffda">compAdd</a> (genType const &v)</td></tr>
|
||||
<tr class="separator:ga70016a744618371aafdb9a6ed8b9ffda"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ga7570faad7d86649a9a5d766f3e731e89"><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
||||
<tr class="memitem:ga7570faad7d86649a9a5d766f3e731e89"><td class="memTemplItemLeft" align="right" valign="top">genType::value_type </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00167.html#ga7570faad7d86649a9a5d766f3e731e89">compMax</a> (genType const &v)</td></tr>
|
||||
<tr class="separator:ga7570faad7d86649a9a5d766f3e731e89"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gabe82f26e0f548e09008ad0874af9e837"><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
||||
<tr class="memitem:gabe82f26e0f548e09008ad0874af9e837"><td class="memTemplItemLeft" align="right" valign="top">genType::value_type </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00167.html#gabe82f26e0f548e09008ad0874af9e837">compMin</a> (genType const &v)</td></tr>
|
||||
<tr class="separator:gabe82f26e0f548e09008ad0874af9e837"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gac0831fc64d0ce245f7f961d72e1893fd"><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
||||
<tr class="memitem:gac0831fc64d0ce245f7f961d72e1893fd"><td class="memTemplItemLeft" align="right" valign="top">genType::value_type </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00167.html#gac0831fc64d0ce245f7f961d72e1893fd">compMul</a> (genType const &v)</td></tr>
|
||||
<tr class="separator:gac0831fc64d0ce245f7f961d72e1893fd"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
|
||||
<p>Fast but less accurate implementations of exponential based functions. </p>
|
||||
<p><<a class="el" href="a00023.html" title="OpenGL Mathematics (glm.g-truc.net)">glm/gtx/fast_exponential.hpp</a>> need to be included to use these functionalities. </p>
|
||||
<hr/><h2>Function Documentation</h2>
|
||||
<a class="anchor" id="ga81550f837781889cc21fe49852102ea0"></a><!-- doxytag: member="glm::fastExp" ref="ga81550f837781889cc21fe49852102ea0" args="(const T &x)" -->
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<p>Operations between components of a type. </p>
|
||||
<p><<a class="el" href="a00014.html" title="OpenGL Mathematics (glm.g-truc.net)">glm/gtx/component_wise.hpp</a>> need to be included to use these functionalities. </p>
|
||||
<h2 class="groupheader">Function Documentation</h2>
|
||||
<a class="anchor" id="ga70016a744618371aafdb9a6ed8b9ffda"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">T glm::fastExp </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const T & </td>
|
||||
<td class="paramname"><em>x</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>Faster than the common exp function but less accurate. </p>
|
||||
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="a00167.html" title="Fast but less accurate implementations of exponential based functions.">GLM_GTX_fast_exponential: Fast exponentiation functions</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga27ffd3d58db8a5309300f16cc5d9284c"></a><!-- doxytag: member="glm::fastExp2" ref="ga27ffd3d58db8a5309300f16cc5d9284c" args="(const T &x)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">T glm::fastExp2 </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const T & </td>
|
||||
<td class="paramname"><em>x</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>Faster than the common exp2 function but less accurate. </p>
|
||||
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="a00167.html" title="Fast but less accurate implementations of exponential based functions.">GLM_GTX_fast_exponential: Fast exponentiation functions</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="gaddd4e635f1c3168122fe7b14753935b9"></a><!-- doxytag: member="glm::fastLn" ref="gaddd4e635f1c3168122fe7b14753935b9" args="(const T &x)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">T glm::fastLn </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const T & </td>
|
||||
<td class="paramname"><em>x</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>Faster than the common ln function but less accurate. </p>
|
||||
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="a00167.html" title="Fast but less accurate implementations of exponential based functions.">GLM_GTX_fast_exponential: Fast exponentiation functions</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga784a80d571f0f596d438863775827cd0"></a><!-- doxytag: member="glm::fastLog" ref="ga784a80d571f0f596d438863775827cd0" args="(const T &x)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">T glm::fastLog </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const T & </td>
|
||||
<td class="paramname"><em>x</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>Faster than the common log function but less accurate. </p>
|
||||
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="a00167.html" title="Fast but less accurate implementations of exponential based functions.">GLM_GTX_fast_exponential: Fast exponentiation functions</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="gac516a11818384b9392412ac199044cf6"></a><!-- doxytag: member="glm::fastLog2" ref="gac516a11818384b9392412ac199044cf6" args="(const T &x)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">T glm::fastLog2 </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const T & </td>
|
||||
<td class="paramname"><em>x</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>Faster than the common log2 function but less accurate. </p>
|
||||
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="a00167.html" title="Fast but less accurate implementations of exponential based functions.">GLM_GTX_fast_exponential: Fast exponentiation functions</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga0ecbe429c87b820368f425ee8d22841a"></a><!-- doxytag: member="glm::fastPow" ref="ga0ecbe429c87b820368f425ee8d22841a" args="(genType const &x, genType const &y)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">genType glm::fastPow </td>
|
||||
<td class="memname">genType::value_type glm::compAdd </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>x</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td class="paramname"><em>v</em></td><td>)</td>
|
||||
<td></td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>y</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Faster than the common pow function but less accurate. </p>
|
||||
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="a00167.html" title="Fast but less accurate implementations of exponential based functions.">GLM_GTX_fast_exponential: Fast exponentiation functions</a> </dd></dl>
|
||||
<p>Add all vector components together. </p>
|
||||
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00167.html" title="Operations between components of a type.">GLM_GTX_component_wise</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga3afd7b7f1ac505ca9247dc6ffa0c25cb"></a><!-- doxytag: member="glm::fastPow" ref="ga3afd7b7f1ac505ca9247dc6ffa0c25cb" args="(genTypeT const &x, genTypeU const &y)" -->
|
||||
<a class="anchor" id="ga7570faad7d86649a9a5d766f3e731e89"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">genTypeT glm::fastPow </td>
|
||||
<td class="memname">genType::value_type glm::compMax </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">genTypeT const & </td>
|
||||
<td class="paramname"><em>x</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>v</em></td><td>)</td>
|
||||
<td></td>
|
||||
<td class="paramtype">genTypeU const & </td>
|
||||
<td class="paramname"><em>y</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Faster than the common pow function but less accurate. </p>
|
||||
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="a00167.html" title="Fast but less accurate implementations of exponential based functions.">GLM_GTX_fast_exponential: Fast exponentiation functions</a> </dd></dl>
|
||||
<p>Find the maximum value between single vector components. </p>
|
||||
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00167.html" title="Operations between components of a type.">GLM_GTX_component_wise</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="gabe82f26e0f548e09008ad0874af9e837"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">genType::value_type glm::compMin </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>v</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Find the minimum value between single vector components. </p>
|
||||
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00167.html" title="Operations between components of a type.">GLM_GTX_component_wise</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="gac0831fc64d0ce245f7f961d72e1893fd"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">genType::value_type glm::compMul </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>v</em></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Multiply all vector components together. </p>
|
||||
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00167.html" title="Operations between components of a type.">GLM_GTX_component_wise</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated by  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||
</a> 1.7.5.1
|
||||
</a> 1.8.2
|
||||
</small></address>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
||||
Reference in New Issue
Block a user