| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373 |
- <!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"/>
- <meta http-equiv="X-UA-Compatible" content="IE=9"/>
- <meta name="generator" content="Doxygen 1.8.10"/>
- <title>0.9.9 API documenation: Exponential 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>
- <link href="search/search.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="search/searchdata.js"></script>
- <script type="text/javascript" src="search/search.js"></script>
- <script type="text/javascript">
- $(document).ready(function() { init_search(); });
- </script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- </head>
- <body>
- <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="projectalign" style="padding-left: 0.5em;">
- <div id="projectname">0.9.9 API documenation
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.8.10 -->
- <script type="text/javascript">
- var searchBox = new SearchBox("searchBox", "search",false,'Search');
- </script>
- <div id="navrow1" class="tabs">
- <ul class="tablist">
- <li><a href="index.html"><span>Main Page</span></a></li>
- <li><a href="modules.html"><span>Modules</span></a></li>
- <li><a href="files.html"><span>Files</span></a></li>
- <li>
- <div id="MSearchBox" class="MSearchBoxInactive">
- <span class="left">
- <img id="MSearchSelect" src="search/mag_sel.png"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- alt=""/>
- <input type="text" id="MSearchField" value="Search" accesskey="S"
- onfocus="searchBox.OnSearchFieldFocus(true)"
- onblur="searchBox.OnSearchFieldFocus(false)"
- onkeyup="searchBox.OnSearchFieldChange(event)"/>
- </span><span class="right">
- <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
- </span>
- </div>
- </li>
- </ul>
- </div>
- </div><!-- top -->
- <!-- window showing the filter options -->
- <div id="MSearchSelectWindow"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- onkeydown="return searchBox.OnSearchSelectKey(event)">
- </div>
- <!-- iframe showing the search results (closed by default) -->
- <div id="MSearchResultsWindow">
- <iframe src="javascript:void(0)" frameborder="0"
- name="MSearchResults" id="MSearchResults">
- </iframe>
- </div>
- <div class="header">
- <div class="summary">
- <a href="#func-members">Functions</a> </div>
- <div class="headertitle">
- <div class="title">Exponential functions<div class="ingroups"><a class="el" href="a00158.html">GLM Core</a></div></div> </div>
- </div><!--header-->
- <div class="contents">
- <p>These all operate component-wise.
- <a href="#details">More...</a></p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
- Functions</h2></td></tr>
- <tr class="memitem:ga468741ae290e63c76c6cd66021f0aed4"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier P> </td></tr>
- <tr class="memitem:ga468741ae290e63c76c6cd66021f0aed4"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00149.html#ga468741ae290e63c76c6cd66021f0aed4">exp</a> (vec< L, T, P > const &v)</td></tr>
- <tr class="memdesc:ga468741ae290e63c76c6cd66021f0aed4"><td class="mdescLeft"> </td><td class="mdescRight">Returns the natural exponentiation of x, i.e., e^x. <a href="a00149.html#ga468741ae290e63c76c6cd66021f0aed4">More...</a><br /></td></tr>
- <tr class="separator:ga468741ae290e63c76c6cd66021f0aed4"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga36757ebc570dc69bcaf8771bffc8fe66"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier P> </td></tr>
- <tr class="memitem:ga36757ebc570dc69bcaf8771bffc8fe66"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00149.html#ga36757ebc570dc69bcaf8771bffc8fe66">exp2</a> (vec< L, T, P > const &v)</td></tr>
- <tr class="memdesc:ga36757ebc570dc69bcaf8771bffc8fe66"><td class="mdescLeft"> </td><td class="mdescRight">Returns 2 raised to the v power. <a href="a00149.html#ga36757ebc570dc69bcaf8771bffc8fe66">More...</a><br /></td></tr>
- <tr class="separator:ga36757ebc570dc69bcaf8771bffc8fe66"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga994f3f9a42018b0a6664bf357517c79b"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier P> </td></tr>
- <tr class="memitem:ga994f3f9a42018b0a6664bf357517c79b"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00149.html#ga994f3f9a42018b0a6664bf357517c79b">inversesqrt</a> (vec< L, T, P > const &v)</td></tr>
- <tr class="memdesc:ga994f3f9a42018b0a6664bf357517c79b"><td class="mdescLeft"> </td><td class="mdescRight">Returns the reciprocal of the positive square root of v. <a href="a00149.html#ga994f3f9a42018b0a6664bf357517c79b">More...</a><br /></td></tr>
- <tr class="separator:ga994f3f9a42018b0a6664bf357517c79b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga2e5adba352da720dd792de225602797d"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier P> </td></tr>
- <tr class="memitem:ga2e5adba352da720dd792de225602797d"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00149.html#ga2e5adba352da720dd792de225602797d">log</a> (vec< L, T, P > const &v)</td></tr>
- <tr class="memdesc:ga2e5adba352da720dd792de225602797d"><td class="mdescLeft"> </td><td class="mdescRight">Returns the natural logarithm of v, i.e., returns the value y which satisfies the equation x = e^y. <a href="a00149.html#ga2e5adba352da720dd792de225602797d">More...</a><br /></td></tr>
- <tr class="separator:ga2e5adba352da720dd792de225602797d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga6a629ad832b14a8e21ea8a19df5aa951"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier P> </td></tr>
- <tr class="memitem:ga6a629ad832b14a8e21ea8a19df5aa951"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00149.html#ga6a629ad832b14a8e21ea8a19df5aa951">log2</a> (vec< L, T, P > const &v)</td></tr>
- <tr class="memdesc:ga6a629ad832b14a8e21ea8a19df5aa951"><td class="mdescLeft"> </td><td class="mdescRight">Returns the base 2 log of x, i.e., returns the value y, which satisfies the equation x = 2 ^ y. <a href="a00149.html#ga6a629ad832b14a8e21ea8a19df5aa951">More...</a><br /></td></tr>
- <tr class="separator:ga6a629ad832b14a8e21ea8a19df5aa951"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gaa4e20d888b7f9e05a5c6a9696b829258"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier P> </td></tr>
- <tr class="memitem:gaa4e20d888b7f9e05a5c6a9696b829258"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00149.html#gaa4e20d888b7f9e05a5c6a9696b829258">pow</a> (vec< L, T, P > const &base, vec< L, T, P > const &exponent)</td></tr>
- <tr class="memdesc:gaa4e20d888b7f9e05a5c6a9696b829258"><td class="mdescLeft"> </td><td class="mdescRight">Returns 'base' raised to the power 'exponent'. <a href="a00149.html#gaa4e20d888b7f9e05a5c6a9696b829258">More...</a><br /></td></tr>
- <tr class="separator:gaa4e20d888b7f9e05a5c6a9696b829258"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga43935741899fb441fa1e6e2f69d74f24"><td class="memTemplParams" colspan="2">template<length_t L, typename T , qualifier P> </td></tr>
- <tr class="memitem:ga43935741899fb441fa1e6e2f69d74f24"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec< L, T, P > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00149.html#ga43935741899fb441fa1e6e2f69d74f24">sqrt</a> (vec< L, T, P > const &v)</td></tr>
- <tr class="memdesc:ga43935741899fb441fa1e6e2f69d74f24"><td class="mdescLeft"> </td><td class="mdescRight">Returns the positive square root of v. <a href="a00149.html#ga43935741899fb441fa1e6e2f69d74f24">More...</a><br /></td></tr>
- <tr class="separator:ga43935741899fb441fa1e6e2f69d74f24"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <p>These all operate component-wise. </p>
- <p>The description is per component. </p>
- <h2 class="groupheader">Function Documentation</h2>
- <a class="anchor" id="ga468741ae290e63c76c6cd66021f0aed4"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">GLM_FUNC_DECL vec<L, T, P> glm::exp </td>
- <td>(</td>
- <td class="paramtype">vec< L, T, P > const & </td>
- <td class="paramname"><em>v</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns the natural exponentiation of x, i.e., e^x. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">v</td><td>exp function is defined for input values of v defined in the range (inf-, inf+) in the limit of the type qualifier. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="tparams"><dt>Template Parameters</dt><dd>
- <table class="tparams">
- <tr><td class="paramname">L</td><td>An integer between 1 and 4 included that qualify the dimension of the vector. </td></tr>
- <tr><td class="paramname">T</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/exp.xml">GLSL exp 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.2 Exponential Functions</a> </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ga36757ebc570dc69bcaf8771bffc8fe66"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">GLM_FUNC_DECL vec<L, T, P> glm::exp2 </td>
- <td>(</td>
- <td class="paramtype">vec< L, T, P > const & </td>
- <td class="paramname"><em>v</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns 2 raised to the v power. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">v</td><td>exp2 function is defined for input values of v defined in the range (inf-, inf+) in the limit of the type qualifier. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="tparams"><dt>Template Parameters</dt><dd>
- <table class="tparams">
- <tr><td class="paramname">L</td><td>An integer between 1 and 4 included that qualify the dimension of the vector. </td></tr>
- <tr><td class="paramname">T</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/exp2.xml">GLSL exp2 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.2 Exponential Functions</a> </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ga994f3f9a42018b0a6664bf357517c79b"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">GLM_FUNC_DECL vec<L, T, P> glm::inversesqrt </td>
- <td>(</td>
- <td class="paramtype">vec< L, T, P > const & </td>
- <td class="paramname"><em>v</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns the reciprocal of the positive square root of v. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">v</td><td>inversesqrt function is defined for input values of v defined in the range [0, inf+) in the limit of the type qualifier. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="tparams"><dt>Template Parameters</dt><dd>
- <table class="tparams">
- <tr><td class="paramname">L</td><td>An integer between 1 and 4 included that qualify the dimension of the vector. </td></tr>
- <tr><td class="paramname">T</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/inversesqrt.xml">GLSL inversesqrt 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.2 Exponential Functions</a> </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ga2e5adba352da720dd792de225602797d"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">GLM_FUNC_DECL vec<L, T, P> glm::log </td>
- <td>(</td>
- <td class="paramtype">vec< L, T, P > const & </td>
- <td class="paramname"><em>v</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns the natural logarithm of v, i.e., returns the value y which satisfies the equation x = e^y. </p>
- <p>Results are undefined if v <= 0.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">v</td><td>log function is defined for input values of v defined in the range (0, inf+) in the limit of the type qualifier. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="tparams"><dt>Template Parameters</dt><dd>
- <table class="tparams">
- <tr><td class="paramname">L</td><td>An integer between 1 and 4 included that qualify the dimension of the vector. </td></tr>
- <tr><td class="paramname">T</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/log.xml">GLSL log 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.2 Exponential Functions</a> </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ga6a629ad832b14a8e21ea8a19df5aa951"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">GLM_FUNC_DECL vec<L, T, P> glm::log2 </td>
- <td>(</td>
- <td class="paramtype">vec< L, T, P > const & </td>
- <td class="paramname"><em>v</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns the base 2 log of x, i.e., returns the value y, which satisfies the equation x = 2 ^ y. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">v</td><td>log2 function is defined for input values of v defined in the range (0, inf+) in the limit of the type qualifier. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="tparams"><dt>Template Parameters</dt><dd>
- <table class="tparams">
- <tr><td class="paramname">L</td><td>An integer between 1 and 4 included that qualify the dimension of the vector. </td></tr>
- <tr><td class="paramname">T</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/log2.xml">GLSL log2 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.2 Exponential Functions</a> </dd></dl>
- </div>
- </div>
- <a class="anchor" id="gaa4e20d888b7f9e05a5c6a9696b829258"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">GLM_FUNC_DECL vec<L, T, P> glm::pow </td>
- <td>(</td>
- <td class="paramtype">vec< L, T, P > const & </td>
- <td class="paramname"><em>base</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">vec< L, T, P > const & </td>
- <td class="paramname"><em>exponent</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns 'base' raised to the power 'exponent'. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">base</td><td>Floating point value. pow function is defined for input values of 'base' defined in the range (inf-, inf+) in the limit of the type qualifier. </td></tr>
- <tr><td class="paramname">exponent</td><td>Floating point value representing the 'exponent'.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section see"><dt>See also</dt><dd><a href="http://www.opengl.org/sdk/docs/manglsl/xhtml/pow.xml">GLSL pow 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.2 Exponential Functions</a> </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ga43935741899fb441fa1e6e2f69d74f24"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">GLM_FUNC_DECL vec<L, T, P> glm::sqrt </td>
- <td>(</td>
- <td class="paramtype">vec< L, T, P > const & </td>
- <td class="paramname"><em>v</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns the positive square root of v. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">v</td><td>sqrt function is defined for input values of v defined in the range [0, inf+) in the limit of the type qualifier. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="tparams"><dt>Template Parameters</dt><dd>
- <table class="tparams">
- <tr><td class="paramname">L</td><td>An integer between 1 and 4 included that qualify the dimension of the vector. </td></tr>
- <tr><td class="paramname">T</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/sqrt.xml">GLSL sqrt 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.2 Exponential Functions</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.8.10
- </small></address>
- </body>
- </html>
|