root/doc/html/group__errorfunc.html @ 353

Revision 353, 12.0 kB (checked in by smidl, 16 years ago)

doc

Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3<title>mixpp: Error Functions</title>
4<link href="tabs.css" rel="stylesheet" type="text/css">
5<link href="doxygen.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.8 -->
8<script type="text/javascript">
9<!--
10function changeDisplayState (e){
11  var num=this.id.replace(/[^[0-9]/g,'');
12  var button=this.firstChild;
13  var sectionDiv=document.getElementById('dynsection'+num);
14  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
15    sectionDiv.style.display='block';
16    button.src='open.gif';
17  }else{
18    sectionDiv.style.display='none';
19    button.src='closed.gif';
20  }
21}
22function initDynSections(){
23  var divs=document.getElementsByTagName('div');
24  var sectionCounter=1;
25  for(var i=0;i<divs.length-1;i++){
26    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
27      var header=divs[i];
28      var section=divs[i+1];
29      var button=header.firstChild;
30      if (button!='IMG'){
31        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
32        button=document.createElement('img');
33        divs[i].insertBefore(button,divs[i].firstChild);
34      }
35      header.style.cursor='pointer';
36      header.onclick=changeDisplayState;
37      header.id='dynheader'+sectionCounter;
38      button.src='closed.gif';
39      section.id='dynsection'+sectionCounter;
40      section.style.display='none';
41      section.style.marginLeft='14px';
42      sectionCounter++;
43    }
44  }
45}
46window.onload = initDynSections;
47-->
48</script>
49<div class="navigation" id="top">
50  <div class="tabs">
51    <ul>
52      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
53      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
54      <li><a href="modules.html"><span>Modules</span></a></li>
55      <li><a href="annotated.html"><span>Classes</span></a></li>
56      <li><a href="files.html"><span>Files</span></a></li>
57    </ul>
58  </div>
59</div>
60<div class="contents">
61<h1>Error Functions<br>
62<small>
63[<a class="el" href="group__math.html">Auxiliary math functions</a>]</small>
64</h1><table border="0" cellpadding="0" cellspacing="0">
65<tr><td></td></tr>
66<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
67<tr><td class="memItemLeft" nowrap align="right" valign="top">std::complex&lt; double &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__errorfunc.html#gce7b742c1c67b646302a32efc677bf53">itpp::erf</a> (const std::complex&lt; double &gt; &amp;z)</td></tr>
68
69<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error function for complex argument.  <a href="#gce7b742c1c67b646302a32efc677bf53"></a><br></td></tr>
70<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gd9a553a77528ed999f4df59124eea492"></a><!-- doxytag: member="errorfunc::erfinv" ref="gd9a553a77528ed999f4df59124eea492" args="(double x)" -->
71double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__errorfunc.html#gd9a553a77528ed999f4df59124eea492">itpp::erfinv</a> (double x)</td></tr>
72
73<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Inverse of error function. <br></td></tr>
74<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g5de7480ca73f92a380312e61345de76c"></a><!-- doxytag: member="errorfunc::Qfunc" ref="g5de7480ca73f92a380312e61345de76c" args="(double x)" -->
75double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__errorfunc.html#g5de7480ca73f92a380312e61345de76c">itpp::Qfunc</a> (double x)</td></tr>
76
77<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Q-function. <br></td></tr>
78<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g3f4d81d30a14a0b3293deed7eed0ca31"></a><!-- doxytag: member="errorfunc::erf" ref="g3f4d81d30a14a0b3293deed7eed0ca31" args="(const vec &amp;x)" -->
79<a class="el" href="classitpp_1_1Vec.html#02e1bb55f60f3c2eb7a020eb1c2cfcf4">vec</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__errorfunc.html#g3f4d81d30a14a0b3293deed7eed0ca31">itpp::erf</a> (const <a class="el" href="classitpp_1_1Vec.html#02e1bb55f60f3c2eb7a020eb1c2cfcf4">vec</a> &amp;x)</td></tr>
80
81<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error function. <br></td></tr>
82<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g6cd4b5424b6064e78e1d47fc9fedf942"></a><!-- doxytag: member="errorfunc::erf" ref="g6cd4b5424b6064e78e1d47fc9fedf942" args="(const mat &amp;x)" -->
83<a class="el" href="classitpp_1_1Mat.html#6bba394f181c76fda12759568986c613">mat</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__errorfunc.html#g6cd4b5424b6064e78e1d47fc9fedf942">itpp::erf</a> (const <a class="el" href="classitpp_1_1Mat.html#6bba394f181c76fda12759568986c613">mat</a> &amp;x)</td></tr>
84
85<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error function. <br></td></tr>
86<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g0f7d521f9453e0175f5ab8bc2d9930c9"></a><!-- doxytag: member="errorfunc::erf" ref="g0f7d521f9453e0175f5ab8bc2d9930c9" args="(const cvec &amp;x)" -->
87<a class="el" href="classitpp_1_1Vec.html#e83c1408740e41a7e29c383b71d4d544">cvec</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__errorfunc.html#g0f7d521f9453e0175f5ab8bc2d9930c9">itpp::erf</a> (const <a class="el" href="classitpp_1_1Vec.html#e83c1408740e41a7e29c383b71d4d544">cvec</a> &amp;x)</td></tr>
88
89<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error function. <br></td></tr>
90<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g494b6bd977cc56273eec91d986b4d744"></a><!-- doxytag: member="errorfunc::erf" ref="g494b6bd977cc56273eec91d986b4d744" args="(const cmat &amp;x)" -->
91<a class="el" href="classitpp_1_1Mat.html#6fbac4b7184807da188e5b85d42f038b">cmat</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__errorfunc.html#g494b6bd977cc56273eec91d986b4d744">itpp::erf</a> (const <a class="el" href="classitpp_1_1Mat.html#6fbac4b7184807da188e5b85d42f038b">cmat</a> &amp;x)</td></tr>
92
93<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error function. <br></td></tr>
94<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g0d51b55ef05185d6bc1eca40e4f363a5"></a><!-- doxytag: member="errorfunc::erfinv" ref="g0d51b55ef05185d6bc1eca40e4f363a5" args="(const vec &amp;x)" -->
95<a class="el" href="classitpp_1_1Vec.html#02e1bb55f60f3c2eb7a020eb1c2cfcf4">vec</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__errorfunc.html#g0d51b55ef05185d6bc1eca40e4f363a5">itpp::erfinv</a> (const <a class="el" href="classitpp_1_1Vec.html#02e1bb55f60f3c2eb7a020eb1c2cfcf4">vec</a> &amp;x)</td></tr>
96
97<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Inverse of error function. <br></td></tr>
98<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gd82b6721e38fa80078edc79b66be989a"></a><!-- doxytag: member="errorfunc::erfinv" ref="gd82b6721e38fa80078edc79b66be989a" args="(const mat &amp;x)" -->
99<a class="el" href="classitpp_1_1Mat.html#6bba394f181c76fda12759568986c613">mat</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__errorfunc.html#gd82b6721e38fa80078edc79b66be989a">itpp::erfinv</a> (const <a class="el" href="classitpp_1_1Mat.html#6bba394f181c76fda12759568986c613">mat</a> &amp;x)</td></tr>
100
101<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Inverse of error function. <br></td></tr>
102<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g9db01a2cc8ceecd4f9539e576e8d5543"></a><!-- doxytag: member="errorfunc::erfc" ref="g9db01a2cc8ceecd4f9539e576e8d5543" args="(const vec &amp;x)" -->
103<a class="el" href="classitpp_1_1Vec.html#02e1bb55f60f3c2eb7a020eb1c2cfcf4">vec</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__errorfunc.html#g9db01a2cc8ceecd4f9539e576e8d5543">itpp::erfc</a> (const <a class="el" href="classitpp_1_1Vec.html#02e1bb55f60f3c2eb7a020eb1c2cfcf4">vec</a> &amp;x)</td></tr>
104
105<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Complementary error function. <br></td></tr>
106<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga5a9663e7fbbf3d2d473a1d803de1792"></a><!-- doxytag: member="errorfunc::erfc" ref="ga5a9663e7fbbf3d2d473a1d803de1792" args="(const mat &amp;x)" -->
107<a class="el" href="classitpp_1_1Mat.html#6bba394f181c76fda12759568986c613">mat</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__errorfunc.html#ga5a9663e7fbbf3d2d473a1d803de1792">itpp::erfc</a> (const <a class="el" href="classitpp_1_1Mat.html#6bba394f181c76fda12759568986c613">mat</a> &amp;x)</td></tr>
108
109<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Complementary error function. <br></td></tr>
110<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g45bc72db1fe558ab760abed3a8db23dd"></a><!-- doxytag: member="errorfunc::Qfunc" ref="g45bc72db1fe558ab760abed3a8db23dd" args="(const vec &amp;x)" -->
111<a class="el" href="classitpp_1_1Vec.html#02e1bb55f60f3c2eb7a020eb1c2cfcf4">vec</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__errorfunc.html#g45bc72db1fe558ab760abed3a8db23dd">itpp::Qfunc</a> (const <a class="el" href="classitpp_1_1Vec.html#02e1bb55f60f3c2eb7a020eb1c2cfcf4">vec</a> &amp;x)</td></tr>
112
113<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Q-function. <br></td></tr>
114<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga3be048a71721b9aca181eaf6119beca"></a><!-- doxytag: member="errorfunc::Qfunc" ref="ga3be048a71721b9aca181eaf6119beca" args="(const mat &amp;x)" -->
115<a class="el" href="classitpp_1_1Mat.html#6bba394f181c76fda12759568986c613">mat</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__errorfunc.html#ga3be048a71721b9aca181eaf6119beca">itpp::Qfunc</a> (const <a class="el" href="classitpp_1_1Mat.html#6bba394f181c76fda12759568986c613">mat</a> &amp;x)</td></tr>
116
117<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Q-function. <br></td></tr>
118</table>
119<hr><h2>Function Documentation</h2>
120<a class="anchor" name="gce7b742c1c67b646302a32efc677bf53"></a><!-- doxytag: member="itpp::erf" ref="gce7b742c1c67b646302a32efc677bf53" args="(const std::complex&lt; double &gt; &amp;z)" -->
121<div class="memitem">
122<div class="memproto">
123      <table class="memname">
124        <tr>
125          <td class="memname">std::complex&lt; double &gt; itpp::erf           </td>
126          <td>(</td>
127          <td class="paramtype">const std::complex&lt; double &gt; &amp;&nbsp;</td>
128          <td class="paramname"> <em>z</em>          </td>
129          <td>&nbsp;)&nbsp;</td>
130          <td></td>
131        </tr>
132      </table>
133</div>
134<div class="memdoc">
135
136<p>
137Error function for complex argument.
138<p>
139<dl class="author" compact><dt><b>Author:</b></dt><dd>Adam Piatyszek</dd></dl>
140This function calculates a well known error function <code>erf(z)</code> for complex <code>z</code>. The implementation is based on unofficial implementation for Octave. Here is a part of the author's note from original sources:<p>
141Put together by John Smith john at arrows dot demon dot co dot uk, using ideas by others.<p>
142Calculate <code>erf(z)</code> for complex <code>z</code>. Three methods are implemented; which one is used depends on z.<p>
143The code includes some hard coded constants that are intended to give about 14 decimal places of accuracy. This is appropriate for 64-bit floating point numbers.
144<p>References <a class="el" href="fix__functions_8cpp-source.html#l00076">itpp::abs()</a>.</p>
145
146</div>
147</div><p>
148</div>
149<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:14 2009 for mixpp by&nbsp;
150<a href="http://www.doxygen.org/index.html">
151<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
152</body>
153</html>
Note: See TracBrowser for help on using the browser.