File: MathFunctions_8h.html

package info (click to toggle)
openms 1.11.1-5
links: PTS, VCS
area: main
in suites: jessie, jessie-kfreebsd
size: 436,688 kB
ctags: 150,907
sloc: cpp: 387,126; xml: 71,547; python: 7,764; ansic: 2,626; php: 2,499; sql: 737; ruby: 342; sh: 325; makefile: 128
file content (88 lines) | stat: -rw-r--r-- 11,464 bytes
<HTML>
<HEAD>
<TITLE>MathFunctions.h File Reference</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
<LINK HREF="style_ini.css" REL="stylesheet" TYPE="text/css">
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<A href="index.html">Home</A> &nbsp;&middot;
<A href="classes.html">Classes</A> &nbsp;&middot;
<A href="annotated.html">Annotated Classes</A> &nbsp;&middot;
<A href="modules.html">Modules</A> &nbsp;&middot;
<A href="functions_func.html">Members</A> &nbsp;&middot;
<A href="namespaces.html">Namespaces</A> &nbsp;&middot;
<A href="pages.html">Related Pages</A>
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
<!-- Generated by Doxygen 1.8.5 -->
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_e770f0cf77e550adde3f44739ef529fe.html">include</a></li><li class="navelem"><a class="el" href="dir_6a63c4937d4da007e55fff5dcf71e0f8.html">OpenMS</a></li><li class="navelem"><a class="el" href="dir_08df52ae343b960cafc8df338f115907.html">MATH</a></li><li class="navelem"><a class="el" href="dir_6d7b74660f5171948c289f3d2cf368a9.html">MISC</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#namespaces">Namespaces</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">MathFunctions.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;<a class="el" href="Types_8h_source.html">OpenMS/CONCEPT/Types.h</a>&gt;</code><br/>
</div>
<p><a href="MathFunctions_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceOpenMS"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceOpenMS.html">OpenMS</a></td></tr>
<tr class="memdesc:namespaceOpenMS"><td class="mdescLeft">&#160;</td><td class="mdescRight">Main OpenMS namespace. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespaceOpenMS_1_1Math"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceOpenMS_1_1Math.html">OpenMS::Math</a></td></tr>
<tr class="memdesc:namespaceOpenMS_1_1Math"><td class="mdescLeft">&#160;</td><td class="mdescRight">Math namespace. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga8c08348404d21e0cffa72ea474ad07c6"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classdouble.html">double</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctionsMisc.html#ga8c08348404d21e0cffa72ea474ad07c6">ceilDecimal</a> (<a class="el" href="classdouble.html">double</a> x, int decPow)</td></tr>
<tr class="memdesc:ga8c08348404d21e0cffa72ea474ad07c6"><td class="mdescLeft">&#160;</td><td class="mdescRight">rounds <code>x</code> up to the next decimal power 10 ^ <code>decPow</code>  <a href="group__MathFunctionsMisc.html#ga8c08348404d21e0cffa72ea474ad07c6">More...</a><br/></td></tr>
<tr class="separator:ga8c08348404d21e0cffa72ea474ad07c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga329ad34d4dd857860f3b62acbffac81d"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classdouble.html">double</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctionsMisc.html#ga329ad34d4dd857860f3b62acbffac81d">roundDecimal</a> (<a class="el" href="classdouble.html">double</a> x, int decPow)</td></tr>
<tr class="memdesc:ga329ad34d4dd857860f3b62acbffac81d"><td class="mdescLeft">&#160;</td><td class="mdescRight">rounds <code>x</code> to the next decimal power 10 ^ <code>decPow</code>  <a href="group__MathFunctionsMisc.html#ga329ad34d4dd857860f3b62acbffac81d">More...</a><br/></td></tr>
<tr class="separator:ga329ad34d4dd857860f3b62acbffac81d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7ef2b76663a3979d5f6580ca42fa7d46"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classdouble.html">double</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctionsMisc.html#ga7ef2b76663a3979d5f6580ca42fa7d46">intervalTransformation</a> (<a class="el" href="classdouble.html">double</a> x, <a class="el" href="classdouble.html">double</a> left1, <a class="el" href="classdouble.html">double</a> right1, <a class="el" href="classdouble.html">double</a> left2, <a class="el" href="classdouble.html">double</a> right2)</td></tr>
<tr class="memdesc:ga7ef2b76663a3979d5f6580ca42fa7d46"><td class="mdescLeft">&#160;</td><td class="mdescRight">transforms point <code>x</code> of interval [left1,right1] into interval [left2,right2]  <a href="group__MathFunctionsMisc.html#ga7ef2b76663a3979d5f6580ca42fa7d46">More...</a><br/></td></tr>
<tr class="separator:ga7ef2b76663a3979d5f6580ca42fa7d46"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga36a865b11e5ad3aee14ce8b5705a3b9b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classdouble.html">double</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctionsMisc.html#ga36a865b11e5ad3aee14ce8b5705a3b9b">linear2log</a> (<a class="el" href="classdouble.html">double</a> x)</td></tr>
<tr class="memdesc:ga36a865b11e5ad3aee14ce8b5705a3b9b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Transforms a number from linear to log10 scale. Avoids negative logarithms by adding 1.  <a href="group__MathFunctionsMisc.html#ga36a865b11e5ad3aee14ce8b5705a3b9b">More...</a><br/></td></tr>
<tr class="separator:ga36a865b11e5ad3aee14ce8b5705a3b9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5e6462b4b9ae8a247bd9294892e2e0eb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classdouble.html">double</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctionsMisc.html#ga5e6462b4b9ae8a247bd9294892e2e0eb">log2linear</a> (<a class="el" href="classdouble.html">double</a> x)</td></tr>
<tr class="memdesc:ga5e6462b4b9ae8a247bd9294892e2e0eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Transforms a number from log10 to to linear scale. Subtracts the 1 added by <a class="el" href="group__MathFunctionsMisc.html#ga36a865b11e5ad3aee14ce8b5705a3b9b" title="Transforms a number from linear to log10 scale. Avoids negative logarithms by adding 1...">linear2log(double)</a>  <a href="group__MathFunctionsMisc.html#ga5e6462b4b9ae8a247bd9294892e2e0eb">More...</a><br/></td></tr>
<tr class="separator:ga5e6462b4b9ae8a247bd9294892e2e0eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadaeb3f406822442307da5b2b94c40885"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctionsMisc.html#gadaeb3f406822442307da5b2b94c40885">isOdd</a> (UInt x)</td></tr>
<tr class="memdesc:gadaeb3f406822442307da5b2b94c40885"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the given interger is odd.  <a href="group__MathFunctionsMisc.html#gadaeb3f406822442307da5b2b94c40885">More...</a><br/></td></tr>
<tr class="separator:gadaeb3f406822442307da5b2b94c40885"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3994eea4342458b8d83ae1984b72d6ac"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ga3994eea4342458b8d83ae1984b72d6ac"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__MathFunctionsMisc.html#ga3994eea4342458b8d83ae1984b72d6ac">round</a> (T x)</td></tr>
<tr class="memdesc:ga3994eea4342458b8d83ae1984b72d6ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Rounds the value.  <a href="group__MathFunctionsMisc.html#ga3994eea4342458b8d83ae1984b72d6ac">More...</a><br/></td></tr>
<tr class="separator:ga3994eea4342458b8d83ae1984b72d6ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3c56bd90567ff1edc267267ffdb6adc1"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MathFunctionsMisc.html#ga3c56bd90567ff1edc267267ffdb6adc1">approximatelyEqual</a> (DoubleReal a, DoubleReal b, DoubleReal tol)</td></tr>
<tr class="memdesc:ga3c56bd90567ff1edc267267ffdb6adc1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns if <code>a</code> is approximately equal <code>b</code> , allowing a tolerance of <code>tol</code>.  <a href="group__MathFunctionsMisc.html#ga3c56bd90567ff1edc267267ffdb6adc1">More...</a><br/></td></tr>
<tr class="separator:ga3c56bd90567ff1edc267267ffdb6adc1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1cb9666a99e571c3fa1eb07c546bdf92"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ga1cb9666a99e571c3fa1eb07c546bdf92"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__MathFunctionsMisc.html#ga1cb9666a99e571c3fa1eb07c546bdf92">gcd</a> (T a, T b)</td></tr>
<tr class="memdesc:ga1cb9666a99e571c3fa1eb07c546bdf92"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the greatest common divisor (gcd) of two numbers by applying the Euclidean algorithm.  <a href="group__MathFunctionsMisc.html#ga1cb9666a99e571c3fa1eb07c546bdf92">More...</a><br/></td></tr>
<tr class="separator:ga1cb9666a99e571c3fa1eb07c546bdf92"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad1c15acd54bb0012cc490de35e19cf34"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:gad1c15acd54bb0012cc490de35e19cf34"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__MathFunctionsMisc.html#gad1c15acd54bb0012cc490de35e19cf34">gcd</a> (T a, T b, T &amp;u1, T &amp;u2)</td></tr>
<tr class="memdesc:gad1c15acd54bb0012cc490de35e19cf34"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the greatest common divisor by applying the extended Euclidean algorithm (Knuth TAoCP vol. 2, p342). Calculates u1, u2 and u3 (which is returned) so that a * u1 + b * u2 = u3 = gcd(a, b, u1, u2)  <a href="group__MathFunctionsMisc.html#gad1c15acd54bb0012cc490de35e19cf34">More...</a><br/></td></tr>
<tr class="separator:gad1c15acd54bb0012cc490de35e19cf34"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
<TABLE width="100%" border="0">
<TR>
<TD><font color="#c0c0c0">OpenMS / TOPP release 1.11.1</font></TD>
<TD align="right"><font color="#c0c0c0">Documentation generated on Thu Nov 14 2013 11:19:23 using doxygen 1.8.5</font></TD>
</TR>
</TABLE>
</BODY>
</HTML>