root/doc/html/misc__stat_8h.html @ 354

Revision 353, 26.3 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: misc_stat.h File Reference</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 class="current"><a href="files.html"><span>Files</span></a></li>
57    </ul>
58  </div>
59  <div class="tabs">
60    <ul>
61      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
62      <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
63    </ul>
64  </div>
65</div>
66<div class="contents">
67<h1>misc_stat.h File Reference</h1>Miscellaneous statistics functions and classes - header file. 
68<a href="#_details">More...</a>
69<p>
70<code>#include &lt;<a class="el" href="min__max_8h-source.html">itpp/base/math/min_max.h</a>&gt;</code><br>
71<code>#include &lt;<a class="el" href="mat_8h-source.html">itpp/base/mat.h</a>&gt;</code><br>
72<code>#include &lt;<a class="el" href="elem__math_8h-source.html">itpp/base/math/elem_math.h</a>&gt;</code><br>
73<code>#include &lt;<a class="el" href="matfunc_8h-source.html">itpp/base/matfunc.h</a>&gt;</code><br>
74
75<p>
76<a href="misc__stat_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
77<tr><td></td></tr>
78<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
79<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Stat.html">itpp::Stat</a></td></tr>
80
81<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A class for sampling a signal and calculating statistics.  <a href="classitpp_1_1Stat.html#_details">More...</a><br></td></tr>
82<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
83<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g0d54de7e2151c01c03d2a67728d9348f"></a><!-- doxytag: member="misc_stat.h::mean" ref="g0d54de7e2151c01c03d2a67728d9348f" args="(const vec &amp;v)" -->
84double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__statistics.html#g0d54de7e2151c01c03d2a67728d9348f">itpp::mean</a> (const <a class="el" href="classitpp_1_1Vec.html#02e1bb55f60f3c2eb7a020eb1c2cfcf4">vec</a> &amp;v)</td></tr>
85
86<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The mean value. <br></td></tr>
87<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gaaf3e3c616250ca3ca5978f48cbb5dd1"></a><!-- doxytag: member="misc_stat.h::mean" ref="gaaf3e3c616250ca3ca5978f48cbb5dd1" args="(const cvec &amp;v)" -->
88std::complex&lt; double &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__statistics.html#gaaf3e3c616250ca3ca5978f48cbb5dd1">itpp::mean</a> (const <a class="el" href="classitpp_1_1Vec.html#e83c1408740e41a7e29c383b71d4d544">cvec</a> &amp;v)</td></tr>
89
90<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The mean value. <br></td></tr>
91<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g7afe5ec5250289ad54c4781a7dd33106"></a><!-- doxytag: member="misc_stat.h::mean" ref="g7afe5ec5250289ad54c4781a7dd33106" args="(const svec &amp;v)" -->
92double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__statistics.html#g7afe5ec5250289ad54c4781a7dd33106">itpp::mean</a> (const <a class="el" href="classitpp_1_1Vec.html#7d53e7d4b228c818e8ade5c59c4ed9d9">svec</a> &amp;v)</td></tr>
93
94<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The mean value. <br></td></tr>
95<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g4b54d91471c62a9e0762fa1f11c54747"></a><!-- doxytag: member="misc_stat.h::mean" ref="g4b54d91471c62a9e0762fa1f11c54747" args="(const ivec &amp;v)" -->
96double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__statistics.html#g4b54d91471c62a9e0762fa1f11c54747">itpp::mean</a> (const <a class="el" href="classitpp_1_1Vec.html#b03757d874926a9be91535e71af1656e">ivec</a> &amp;v)</td></tr>
97
98<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The mean value. <br></td></tr>
99<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gf6b99073aa2aa917bed339de7c346f9b"></a><!-- doxytag: member="misc_stat.h::mean" ref="gf6b99073aa2aa917bed339de7c346f9b" args="(const mat &amp;m)" -->
100double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__statistics.html#gf6b99073aa2aa917bed339de7c346f9b">itpp::mean</a> (const <a class="el" href="classitpp_1_1Mat.html#6bba394f181c76fda12759568986c613">mat</a> &amp;m)</td></tr>
101
102<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The mean value. <br></td></tr>
103<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g29d3c842d5588b90771a0165d70049d4"></a><!-- doxytag: member="misc_stat.h::mean" ref="g29d3c842d5588b90771a0165d70049d4" args="(const cmat &amp;m)" -->
104std::complex&lt; double &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__statistics.html#g29d3c842d5588b90771a0165d70049d4">itpp::mean</a> (const <a class="el" href="classitpp_1_1Mat.html#6fbac4b7184807da188e5b85d42f038b">cmat</a> &amp;m)</td></tr>
105
106<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The mean value. <br></td></tr>
107<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga25d48abcbd380b02e9cc754f3ffcca5"></a><!-- doxytag: member="misc_stat.h::mean" ref="ga25d48abcbd380b02e9cc754f3ffcca5" args="(const smat &amp;m)" -->
108double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__statistics.html#ga25d48abcbd380b02e9cc754f3ffcca5">itpp::mean</a> (const <a class="el" href="classitpp_1_1Mat.html#debd320317a18c022d3ca856af6d3687">smat</a> &amp;m)</td></tr>
109
110<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The mean value. <br></td></tr>
111<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gc370b4cfdc6baa037b7442ae6e2c4b5c"></a><!-- doxytag: member="misc_stat.h::mean" ref="gc370b4cfdc6baa037b7442ae6e2c4b5c" args="(const imat &amp;m)" -->
112double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__statistics.html#gc370b4cfdc6baa037b7442ae6e2c4b5c">itpp::mean</a> (const <a class="el" href="classitpp_1_1Mat.html#9e0dd2f635e4bd0b28c09685d9c4f3bb">imat</a> &amp;m)</td></tr>
113
114<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The mean value. <br></td></tr>
115<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="gb694fa4cd6dcdb3b4b2dfbb7dbf14eb5"></a><!-- doxytag: member="misc_stat.h::geometric_mean" ref="gb694fa4cd6dcdb3b4b2dfbb7dbf14eb5" args="(const Vec&lt; T &gt; &amp;v)" -->
116template&lt;class T &gt; </td></tr>
117<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">double&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__statistics.html#gb694fa4cd6dcdb3b4b2dfbb7dbf14eb5">itpp::geometric_mean</a> (const Vec&lt; T &gt; &amp;v)</td></tr>
118
119<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The geometric mean of a vector. <br></td></tr>
120<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="g520b83173c482245fb13e718f94a6c82"></a><!-- doxytag: member="misc_stat.h::geometric_mean" ref="g520b83173c482245fb13e718f94a6c82" args="(const Mat&lt; T &gt; &amp;m)" -->
121template&lt;class T &gt; </td></tr>
122<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">double&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__statistics.html#g520b83173c482245fb13e718f94a6c82">itpp::geometric_mean</a> (const Mat&lt; T &gt; &amp;m)</td></tr>
123
124<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The geometric mean of a matrix. <br></td></tr>
125<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="gfa60b547d34225cdd35adccf91775d9f"></a><!-- doxytag: member="misc_stat.h::median" ref="gfa60b547d34225cdd35adccf91775d9f" args="(const Vec&lt; T &gt; &amp;v)" -->
126template&lt;class T &gt; </td></tr>
127<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">double&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__statistics.html#gfa60b547d34225cdd35adccf91775d9f">itpp::median</a> (const Vec&lt; T &gt; &amp;v)</td></tr>
128
129<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The median. <br></td></tr>
130<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g8017c2e680dbd2f56c8bbf1572337b29"></a><!-- doxytag: member="misc_stat.h::norm" ref="g8017c2e680dbd2f56c8bbf1572337b29" args="(const cvec &amp;v)" -->
131double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__statistics.html#g8017c2e680dbd2f56c8bbf1572337b29">itpp::norm</a> (const <a class="el" href="classitpp_1_1Vec.html#e83c1408740e41a7e29c383b71d4d544">cvec</a> &amp;v)</td></tr>
132
133<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Calculate the 2-norm: norm(v)=sqrt(sum(abs(v).^2)). <br></td></tr>
134<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="g2cd659a539e6a85709a6de1a143e4618"></a><!-- doxytag: member="misc_stat.h::norm" ref="g2cd659a539e6a85709a6de1a143e4618" args="(const Vec&lt; T &gt; &amp;v)" -->
135template&lt;class T &gt; </td></tr>
136<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">double&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__statistics.html#g2cd659a539e6a85709a6de1a143e4618">itpp::norm</a> (const Vec&lt; T &gt; &amp;v)</td></tr>
137
138<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Calculate the 2-norm: norm(v)=sqrt(sum(abs(v).^2)). <br></td></tr>
139<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g516b973d7e8a792c9a22e0b42d3bb00b"></a><!-- doxytag: member="misc_stat.h::norm" ref="g516b973d7e8a792c9a22e0b42d3bb00b" args="(const cvec &amp;v, int p)" -->
140double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__statistics.html#g516b973d7e8a792c9a22e0b42d3bb00b">itpp::norm</a> (const <a class="el" href="classitpp_1_1Vec.html#e83c1408740e41a7e29c383b71d4d544">cvec</a> &amp;v, int p)</td></tr>
141
142<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Calculate the p-norm: norm(v,p)=sum(abs(v).^2)^(1/p). <br></td></tr>
143<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="g1ca85f4f5c9bf6260a6b41e10a878e31"></a><!-- doxytag: member="misc_stat.h::norm" ref="g1ca85f4f5c9bf6260a6b41e10a878e31" args="(const Vec&lt; T &gt; &amp;v, int p)" -->
144template&lt;class T &gt; </td></tr>
145<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">double&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__statistics.html#g1ca85f4f5c9bf6260a6b41e10a878e31">itpp::norm</a> (const Vec&lt; T &gt; &amp;v, int p)</td></tr>
146
147<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Calculate the p-norm: norm(v,p)=sum(abs(v).^2)^(1/p). <br></td></tr>
148<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g01d46dbf6c159d444b0dac31e80b21fc"></a><!-- doxytag: member="misc_stat.h::norm" ref="g01d46dbf6c159d444b0dac31e80b21fc" args="(const cvec &amp;v, const std::string &amp;s)" -->
149double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__statistics.html#g01d46dbf6c159d444b0dac31e80b21fc">itpp::norm</a> (const <a class="el" href="classitpp_1_1Vec.html#e83c1408740e41a7e29c383b71d4d544">cvec</a> &amp;v, const std::string &amp;s)</td></tr>
150
151<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Calculate the Frobenius norm for s = "fro" (equal to 2-norm). <br></td></tr>
152<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="gc2a8340331beb29e8f97baa00b2e31b8"></a><!-- doxytag: member="misc_stat.h::norm" ref="gc2a8340331beb29e8f97baa00b2e31b8" args="(const Vec&lt; T &gt; &amp;v, const std::string &amp;s)" -->
153template&lt;class T &gt; </td></tr>
154<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">double&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__statistics.html#gc2a8340331beb29e8f97baa00b2e31b8">itpp::norm</a> (const Vec&lt; T &gt; &amp;v, const std::string &amp;s)</td></tr>
155
156<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Calculate the Frobenius norm for s = "fro" (equal to 2-norm). <br></td></tr>
157<tr><td class="memItemLeft" nowrap align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__statistics.html#g33961993e1531da45cc4a3c02a6dd124">itpp::norm</a> (const <a class="el" href="classitpp_1_1Mat.html#6bba394f181c76fda12759568986c613">mat</a> &amp;m, int p)</td></tr>
158
159<tr><td class="memItemLeft" nowrap align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__statistics.html#g831b04981a856a72f8f669bff13fd1e3">itpp::norm</a> (const <a class="el" href="classitpp_1_1Mat.html#6fbac4b7184807da188e5b85d42f038b">cmat</a> &amp;m, int p)</td></tr>
160
161<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g23a0b74b4713026fbeebc7cc0d7e19bd"></a><!-- doxytag: member="misc_stat.h::norm" ref="g23a0b74b4713026fbeebc7cc0d7e19bd" args="(const mat &amp;m, const std::string &amp;s)" -->
162double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__statistics.html#g23a0b74b4713026fbeebc7cc0d7e19bd">itpp::norm</a> (const <a class="el" href="classitpp_1_1Mat.html#6bba394f181c76fda12759568986c613">mat</a> &amp;m, const std::string &amp;s)</td></tr>
163
164<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Calculate the Frobenius norm of a matrix for s = "fro". <br></td></tr>
165<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ged268405b2969894507b862c8e2052f3"></a><!-- doxytag: member="misc_stat.h::norm" ref="ged268405b2969894507b862c8e2052f3" args="(const cmat &amp;m, const std::string &amp;s)" -->
166double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__statistics.html#ged268405b2969894507b862c8e2052f3">itpp::norm</a> (const <a class="el" href="classitpp_1_1Mat.html#6fbac4b7184807da188e5b85d42f038b">cmat</a> &amp;m, const std::string &amp;s)</td></tr>
167
168<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Calculate the Frobenius norm of a matrix for s = "fro". <br></td></tr>
169<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g9245a3ae0b0ea33e57991d449abd1c9e"></a><!-- doxytag: member="misc_stat.h::variance" ref="g9245a3ae0b0ea33e57991d449abd1c9e" args="(const cvec &amp;v)" -->
170double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__statistics.html#g9245a3ae0b0ea33e57991d449abd1c9e">itpp::variance</a> (const <a class="el" href="classitpp_1_1Vec.html#e83c1408740e41a7e29c383b71d4d544">cvec</a> &amp;v)</td></tr>
171
172<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The variance of the elements in the vector. Normalized with N-1 to be unbiased. <br></td></tr>
173<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="g7a4799948ff9779eaeecabde0ce5fcbb"></a><!-- doxytag: member="misc_stat.h::variance" ref="g7a4799948ff9779eaeecabde0ce5fcbb" args="(const Vec&lt; T &gt; &amp;v)" -->
174template&lt;class T &gt; </td></tr>
175<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">double&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__statistics.html#g7a4799948ff9779eaeecabde0ce5fcbb">itpp::variance</a> (const Vec&lt; T &gt; &amp;v)</td></tr>
176
177<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The variance of the elements in the vector. Normalized with N-1 to be unbiased. <br></td></tr>
178<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="ga45f7193097f878a35b65b591690d0d0"></a><!-- doxytag: member="misc_stat.h::energy" ref="ga45f7193097f878a35b65b591690d0d0" args="(const Vec&lt; T &gt; &amp;v)" -->
179template&lt;class T &gt; </td></tr>
180<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">double&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__statistics.html#ga45f7193097f878a35b65b591690d0d0">itpp::energy</a> (const Vec&lt; T &gt; &amp;v)</td></tr>
181
182<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Calculate the energy: squared 2-norm. energy(v)=sum(abs(v).^2). <br></td></tr>
183<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g38b936ea401045e0667c193fb0e0da8c"></a><!-- doxytag: member="misc_stat.h::within_tolerance" ref="g38b936ea401045e0667c193fb0e0da8c" args="(double x, double xref, double tol=1e&#45;14)" -->
184bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__statistics.html#g38b936ea401045e0667c193fb0e0da8c">itpp::within_tolerance</a> (double x, double xref, double tol=1e-14)</td></tr>
185
186<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return true if the input value <code>x</code> is within the tolerance <code>tol</code> of the reference value <code>xref</code>. <br></td></tr>
187<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gd45b87b809750f8e464f2d518c7b9d89"></a><!-- doxytag: member="misc_stat.h::within_tolerance" ref="gd45b87b809750f8e464f2d518c7b9d89" args="(std::complex&lt; double &gt; x, std::complex&lt; double &gt; xref, double tol=1e&#45;14)" -->
188bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__statistics.html#gd45b87b809750f8e464f2d518c7b9d89">itpp::within_tolerance</a> (std::complex&lt; double &gt; x, std::complex&lt; double &gt; xref, double tol=1e-14)</td></tr>
189
190<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return true if the input value <code>x</code> is within the tolerance <code>tol</code> of the reference value <code>xref</code>. <br></td></tr>
191<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gd87b1fc7b3e0a18bd2d450dc2883a169"></a><!-- doxytag: member="misc_stat.h::within_tolerance" ref="gd87b1fc7b3e0a18bd2d450dc2883a169" args="(const vec &amp;x, const vec &amp;xref, double tol=1e&#45;14)" -->
192bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__statistics.html#gd87b1fc7b3e0a18bd2d450dc2883a169">itpp::within_tolerance</a> (const <a class="el" href="classitpp_1_1Vec.html#02e1bb55f60f3c2eb7a020eb1c2cfcf4">vec</a> &amp;x, const <a class="el" href="classitpp_1_1Vec.html#02e1bb55f60f3c2eb7a020eb1c2cfcf4">vec</a> &amp;xref, double tol=1e-14)</td></tr>
193
194<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return true if the input vector <code>x</code> is elementwise within the tolerance <code>tol</code> of the reference vector <code>xref</code>. <br></td></tr>
195<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g5acad6199520ccfc17fc956791e116f9"></a><!-- doxytag: member="misc_stat.h::within_tolerance" ref="g5acad6199520ccfc17fc956791e116f9" args="(const cvec &amp;x, const cvec &amp;xref, double tol=1e&#45;14)" -->
196bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__statistics.html#g5acad6199520ccfc17fc956791e116f9">itpp::within_tolerance</a> (const <a class="el" href="classitpp_1_1Vec.html#e83c1408740e41a7e29c383b71d4d544">cvec</a> &amp;x, const <a class="el" href="classitpp_1_1Vec.html#e83c1408740e41a7e29c383b71d4d544">cvec</a> &amp;xref, double tol=1e-14)</td></tr>
197
198<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return true if the input vector <code>x</code> is elementwise within the tolerance <code>tol</code> of the reference vector <code>xref</code>. <br></td></tr>
199<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gb35370c1a742e895ec4584e6fd6100ab"></a><!-- doxytag: member="misc_stat.h::within_tolerance" ref="gb35370c1a742e895ec4584e6fd6100ab" args="(const mat &amp;X, const mat &amp;Xref, double tol=1e&#45;14)" -->
200bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__statistics.html#gb35370c1a742e895ec4584e6fd6100ab">itpp::within_tolerance</a> (const <a class="el" href="classitpp_1_1Mat.html#6bba394f181c76fda12759568986c613">mat</a> &amp;X, const <a class="el" href="classitpp_1_1Mat.html#6bba394f181c76fda12759568986c613">mat</a> &amp;Xref, double tol=1e-14)</td></tr>
201
202<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return true if the input matrix <code>X</code> is elementwise within the tolerance <code>tol</code> of the reference matrix <code>Xref</code>. <br></td></tr>
203<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g5a534abd4196839b8669b5679d5ab7c8"></a><!-- doxytag: member="misc_stat.h::within_tolerance" ref="g5a534abd4196839b8669b5679d5ab7c8" args="(const cmat &amp;X, const cmat &amp;Xref, double tol=1e&#45;14)" -->
204bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__statistics.html#g5a534abd4196839b8669b5679d5ab7c8">itpp::within_tolerance</a> (const <a class="el" href="classitpp_1_1Mat.html#6fbac4b7184807da188e5b85d42f038b">cmat</a> &amp;X, const <a class="el" href="classitpp_1_1Mat.html#6fbac4b7184807da188e5b85d42f038b">cmat</a> &amp;Xref, double tol=1e-14)</td></tr>
205
206<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return true if the input matrix <code>X</code> is elementwise within the tolerance <code>tol</code> of the reference matrix <code>Xref</code>. <br></td></tr>
207<tr><td class="memItemLeft" nowrap align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__statistics.html#gde571eebaa7dbd8289b6d7184fe625ca">itpp::moment</a> (const <a class="el" href="classitpp_1_1Vec.html#02e1bb55f60f3c2eb7a020eb1c2cfcf4">vec</a> &amp;x, const int r)</td></tr>
208
209<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Calculate the central moment of vector x.  <a href="group__statistics.html#gde571eebaa7dbd8289b6d7184fe625ca"></a><br></td></tr>
210<tr><td class="memItemLeft" nowrap align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__statistics.html#g43f3c117ed93400ceed5bdacf37f49ea">itpp::skewness</a> (const <a class="el" href="classitpp_1_1Vec.html#02e1bb55f60f3c2eb7a020eb1c2cfcf4">vec</a> &amp;x)</td></tr>
211
212<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Calculate the skewness excess of the input vector x.  <a href="group__statistics.html#g43f3c117ed93400ceed5bdacf37f49ea"></a><br></td></tr>
213<tr><td class="memItemLeft" nowrap align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__statistics.html#g00f842b0e850195093781692a6aaaac3">itpp::kurtosisexcess</a> (const <a class="el" href="classitpp_1_1Vec.html#02e1bb55f60f3c2eb7a020eb1c2cfcf4">vec</a> &amp;x)</td></tr>
214
215<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Calculate the kurtosis excess of the input vector x.  <a href="group__statistics.html#g00f842b0e850195093781692a6aaaac3"></a><br></td></tr>
216<tr><td class="memItemLeft" nowrap align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__statistics.html#g49dd4e3746500b1587bfd96fb54439f0">itpp::kurtosis</a> (const <a class="el" href="classitpp_1_1Vec.html#02e1bb55f60f3c2eb7a020eb1c2cfcf4">vec</a> &amp;x)</td></tr>
217
218<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Calculate the kurtosis of the input vector x.  <a href="group__statistics.html#g49dd4e3746500b1587bfd96fb54439f0"></a><br></td></tr>
219</table>
220<hr><a name="_details"></a><h2>Detailed Description</h2>
221Miscellaneous statistics functions and classes - header file.
222<p>
223<dl class="author" compact><dt><b>Author:</b></dt><dd>Tony Ottosson, Johan Bergman and Adam Piatyszek</dd></dl>
224-------------------------------------------------------------------------<p>
225Copyright (C) 1995-2008 (see AUTHORS file for a list of contributors)<p>
226This file is part of IT++ - a C++ library of mathematical, signal processing, speech processing, and communications classes and functions.<p>
227IT++ is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.<p>
228IT++ is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.<p>
229You should have received a copy of the GNU General Public License along with IT++. If not, see &lt;<a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>&gt;.<p>
230------------------------------------------------------------------------- </div>
231<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:14 2009 for mixpp by&nbsp;
232<a href="http://www.doxygen.org/index.html">
233<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
234</body>
235</html>
Note: See TracBrowser for help on using the browser.