root/doc/html/classitpp_1_1Stat.html @ 353

Revision 353, 13.7 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: itpp::Stat Class 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 class="current"><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 class="tabs">
60    <ul>
61      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
62      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
63      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
64      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
65    </ul>
66  </div>
67  <div class="navpath"><b>itpp</b>::<a class="el" href="classitpp_1_1Stat.html">Stat</a>
68  </div>
69</div>
70<div class="contents">
71<h1>itpp::Stat Class Reference<br>
72<small>
73[<a class="el" href="group__statistics.html">Miscellaneous Statistics Functions</a>]</small>
74</h1><!-- doxytag: class="itpp::Stat" -->A class for sampling a signal and calculating statistics. 
75<a href="#_details">More...</a>
76<p>
77<code>#include &lt;<a class="el" href="misc__stat_8h-source.html">misc_stat.h</a>&gt;</code>
78<p>
79
80<p>
81<a href="classitpp_1_1Stat-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
82<tr><td></td></tr>
83<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
84<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d781414e3ec20523c7bd355afe908e22"></a><!-- doxytag: member="itpp::Stat::Stat" ref="d781414e3ec20523c7bd355afe908e22" args="()" -->
85&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Stat.html#d781414e3ec20523c7bd355afe908e22">Stat</a> ()</td></tr>
86
87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
88<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="832adab0451106d22b36d5e0b460700f"></a><!-- doxytag: member="itpp::Stat::~Stat" ref="832adab0451106d22b36d5e0b460700f" args="()" -->
89virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Stat.html#832adab0451106d22b36d5e0b460700f">~Stat</a> ()</td></tr>
90
91<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <br></td></tr>
92<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cdfaa4bfae3327854005136a0dfa7026"></a><!-- doxytag: member="itpp::Stat::clear" ref="cdfaa4bfae3327854005136a0dfa7026" args="()" -->
93virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Stat.html#cdfaa4bfae3327854005136a0dfa7026">clear</a> ()</td></tr>
94
95<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Clear statistics. <br></td></tr>
96<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c46f9aac1f49205b00fbb446d271270"></a><!-- doxytag: member="itpp::Stat::sample" ref="1c46f9aac1f49205b00fbb446d271270" args="(const double s, const bool overflow=false)" -->
97virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Stat.html#1c46f9aac1f49205b00fbb446d271270">sample</a> (const double s, const bool overflow=false)</td></tr>
98
99<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Register a sample and flag for overflow. <br></td></tr>
100<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="301c5df70b97ec2c4c2ae40f535acdb2"></a><!-- doxytag: member="itpp::Stat::n_overflows" ref="301c5df70b97ec2c4c2ae40f535acdb2" args="() const " -->
101int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Stat.html#301c5df70b97ec2c4c2ae40f535acdb2">n_overflows</a> () const </td></tr>
102
103<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of reported overflows. <br></td></tr>
104<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="10c43f0205cd061b1d9b2acc0ddc29df"></a><!-- doxytag: member="itpp::Stat::n_samples" ref="10c43f0205cd061b1d9b2acc0ddc29df" args="() const " -->
105int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Stat.html#10c43f0205cd061b1d9b2acc0ddc29df">n_samples</a> () const </td></tr>
106
107<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of samples. <br></td></tr>
108<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7d15eeda67da9ba88747b77ae3bdd63a"></a><!-- doxytag: member="itpp::Stat::n_zeros" ref="7d15eeda67da9ba88747b77ae3bdd63a" args="() const " -->
109int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Stat.html#7d15eeda67da9ba88747b77ae3bdd63a">n_zeros</a> () const </td></tr>
110
111<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of zero samples. <br></td></tr>
112<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bb3230950e8f30d323f198b3fa064551"></a><!-- doxytag: member="itpp::Stat::avg" ref="bb3230950e8f30d323f198b3fa064551" args="() const " -->
113double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Stat.html#bb3230950e8f30d323f198b3fa064551">avg</a> () const </td></tr>
114
115<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Average over all samples. <br></td></tr>
116<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a9983bd5dc19c9dfc2ee6084e63070db"></a><!-- doxytag: member="itpp::Stat::max" ref="a9983bd5dc19c9dfc2ee6084e63070db" args="() const " -->
117double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Stat.html#a9983bd5dc19c9dfc2ee6084e63070db">max</a> () const </td></tr>
118
119<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Maximum sample. <br></td></tr>
120<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9cd72f5bb21cbeb50787603c03f3afd3"></a><!-- doxytag: member="itpp::Stat::min" ref="9cd72f5bb21cbeb50787603c03f3afd3" args="() const " -->
121double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Stat.html#9cd72f5bb21cbeb50787603c03f3afd3">min</a> () const </td></tr>
122
123<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Minimum sample. <br></td></tr>
124<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0312ea0cfe45a39de56178b4f563e65e"></a><!-- doxytag: member="itpp::Stat::sigma" ref="0312ea0cfe45a39de56178b4f563e65e" args="() const " -->
125double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Stat.html#0312ea0cfe45a39de56178b4f563e65e">sigma</a> () const </td></tr>
126
127<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Standard deviation of all samples. <br></td></tr>
128<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e46dc4c19f7f588409e59a35105efda5"></a><!-- doxytag: member="itpp::Stat::sqr_sum" ref="e46dc4c19f7f588409e59a35105efda5" args="() const " -->
129double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Stat.html#e46dc4c19f7f588409e59a35105efda5">sqr_sum</a> () const </td></tr>
130
131<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Squared sum of all samples. <br></td></tr>
132<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="aad42fdd0ff086110c161cd1e4501707"></a><!-- doxytag: member="itpp::Stat::sum" ref="aad42fdd0ff086110c161cd1e4501707" args="() const " -->
133double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Stat.html#aad42fdd0ff086110c161cd1e4501707">sum</a> () const </td></tr>
134
135<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sum of all samples. <br></td></tr>
136<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a76b0f0638119d0289d58d0b1ba56886"></a><!-- doxytag: member="itpp::Stat::histogram" ref="a76b0f0638119d0289d58d0b1ba56886" args="() const " -->
137vec&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Stat.html#a76b0f0638119d0289d58d0b1ba56886">histogram</a> () const </td></tr>
138
139<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="classitpp_1_1Histogram.html" title="Histogram computation class.">Histogram</a> over all samples (not implemented yet). <br></td></tr>
140<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
141<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="15e69c10d8957d93dc29b3c145d23499"></a><!-- doxytag: member="itpp::Stat::_n_overflows" ref="15e69c10d8957d93dc29b3c145d23499" args="" -->
142int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Stat.html#15e69c10d8957d93dc29b3c145d23499">_n_overflows</a></td></tr>
143
144<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of reported overflows. <br></td></tr>
145<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9e592280105100df158a7032ae233c18"></a><!-- doxytag: member="itpp::Stat::_n_samples" ref="9e592280105100df158a7032ae233c18" args="" -->
146int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Stat.html#9e592280105100df158a7032ae233c18">_n_samples</a></td></tr>
147
148<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of samples. <br></td></tr>
149<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0a4ce59b6041d48ecf1ae866974ce16b"></a><!-- doxytag: member="itpp::Stat::_n_zeros" ref="0a4ce59b6041d48ecf1ae866974ce16b" args="" -->
150int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Stat.html#0a4ce59b6041d48ecf1ae866974ce16b">_n_zeros</a></td></tr>
151
152<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of zero samples. <br></td></tr>
153<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2828df78aa068db56d2df75a7c44ca3d"></a><!-- doxytag: member="itpp::Stat::_max" ref="2828df78aa068db56d2df75a7c44ca3d" args="" -->
154double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Stat.html#2828df78aa068db56d2df75a7c44ca3d">_max</a></td></tr>
155
156<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Maximum sample. <br></td></tr>
157<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c4dcea6464c6dcabc5256fff31ca9e6b"></a><!-- doxytag: member="itpp::Stat::_min" ref="c4dcea6464c6dcabc5256fff31ca9e6b" args="" -->
158double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Stat.html#c4dcea6464c6dcabc5256fff31ca9e6b">_min</a></td></tr>
159
160<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Minimum sample. <br></td></tr>
161<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="422dc04de1247f7b0f997063f56ccc45"></a><!-- doxytag: member="itpp::Stat::_sqr_sum" ref="422dc04de1247f7b0f997063f56ccc45" args="" -->
162double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Stat.html#422dc04de1247f7b0f997063f56ccc45">_sqr_sum</a></td></tr>
163
164<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Squared sum of all samples. <br></td></tr>
165<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a76336dbc124d5f8bf7c7b8ee4c42b93"></a><!-- doxytag: member="itpp::Stat::_sum" ref="a76336dbc124d5f8bf7c7b8ee4c42b93" args="" -->
166double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Stat.html#a76336dbc124d5f8bf7c7b8ee4c42b93">_sum</a></td></tr>
167
168<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sum of all samples. <br></td></tr>
169</table>
170<hr><a name="_details"></a><h2>Detailed Description</h2>
171A class for sampling a signal and calculating statistics. <hr>The documentation for this class was generated from the following file:<ul>
172<li><a class="el" href="misc__stat_8h-source.html">misc_stat.h</a></ul>
173</div>
174<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:19 2009 for mixpp by&nbsp;
175<a href="http://www.doxygen.org/index.html">
176<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
177</body>
178</html>
Note: See TracBrowser for help on using the browser.