Files
C-Plus-Plus/d7/d7c/classstatistics_1_1stats__computer1.html
2024-08-30 17:22:07 +00:00

346 lines
20 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Algorithms_in_C++: statistics::stats_computer1&lt; T &gt; Class Template Reference</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>
<script type="text/javascript" src="../../clipboard.js"></script>
<link href="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../navtreedata.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<script type="text/javascript" src="../../resize.js"></script>
<script type="text/javascript" src="../../cookie.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/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js", "TeX/AMSmath.js", "TeX/AMSsymbols.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=TeX-MML-AM_CHTML/MathJax.js"></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 id="projectrow">
<td id="projectalign">
<div id="projectname">Algorithms_in_C++<span id="projectnumber">&#160;1.0.0</span>
</div>
<div id="projectbrief">Set of algorithms implemented in C++.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "../../search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(1); });
/* @license-end */
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('../../',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('d7/d7c/classstatistics_1_1stats__computer1.html','../../'); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="../../d0/d78/classstatistics_1_1stats__computer1-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">statistics::stats_computer1&lt; T &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Collaboration diagram for statistics::stats_computer1&lt; T &gt;:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="../../d6/d38/classstatistics_1_1stats__computer1__coll__graph.svg" width="223" height="126"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
<center><span class="legend">[<a target="top" href="../../graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aa13bf7c38de112f71921a5525d71a2f2" id="r_aa13bf7c38de112f71921a5525d71a2f2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa13bf7c38de112f71921a5525d71a2f2">new_val</a> (T x)</td></tr>
<tr class="separator:aa13bf7c38de112f71921a5525d71a2f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a390697dcee210b91823ceff04b25081b" id="r_a390697dcee210b91823ceff04b25081b"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a390697dcee210b91823ceff04b25081b">mean</a> () const</td></tr>
<tr class="separator:a390697dcee210b91823ceff04b25081b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a27f0a03e2fd2254f1c81fe668226bd92" id="r_a27f0a03e2fd2254f1c81fe668226bd92"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a27f0a03e2fd2254f1c81fe668226bd92">variance</a> () const</td></tr>
<tr class="separator:a27f0a03e2fd2254f1c81fe668226bd92"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af57e942d49f4fd70f059f224b4ac07e1" id="r_af57e942d49f4fd70f059f224b4ac07e1"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af57e942d49f4fd70f059f224b4ac07e1">std</a> () const</td></tr>
<tr class="separator:af57e942d49f4fd70f059f224b4ac07e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:ab2e69e75fe0da096bf61fa13420b43eb" id="r_ab2e69e75fe0da096bf61fa13420b43eb"><td class="memItemLeft" align="right" valign="top"><a id="ab2e69e75fe0da096bf61fa13420b43eb" name="ab2e69e75fe0da096bf61fa13420b43eb"></a>
unsigned int&#160;</td><td class="memItemRight" valign="bottom"><b>n</b> = 0</td></tr>
<tr class="separator:ab2e69e75fe0da096bf61fa13420b43eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2a097b80909181880f13b54a264ed337" id="r_a2a097b80909181880f13b54a264ed337"><td class="memItemLeft" align="right" valign="top"><a id="a2a097b80909181880f13b54a264ed337" name="a2a097b80909181880f13b54a264ed337"></a>
double&#160;</td><td class="memItemRight" valign="bottom"><b>Ex</b></td></tr>
<tr class="separator:a2a097b80909181880f13b54a264ed337"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8ab2b14d5650b14e46b70b412573f60a" id="r_a8ab2b14d5650b14e46b70b412573f60a"><td class="memItemLeft" align="right" valign="top"><a id="a8ab2b14d5650b14e46b70b412573f60a" name="a8ab2b14d5650b14e46b70b412573f60a"></a>
double&#160;</td><td class="memItemRight" valign="bottom"><b>Ex2</b></td></tr>
<tr class="separator:a8ab2b14d5650b14e46b70b412573f60a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a48c03a44c784eb6913ad186d34c302db" id="r_a48c03a44c784eb6913ad186d34c302db"><td class="memItemLeft" align="right" valign="top"><a id="a48c03a44c784eb6913ad186d34c302db" name="a48c03a44c784eb6913ad186d34c302db"></a>
T&#160;</td><td class="memItemRight" valign="bottom"><b>K</b></td></tr>
<tr class="separator:a48c03a44c784eb6913ad186d34c302db"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a350bf6c429691d3578c4dfc6679a0797" id="r_a350bf6c429691d3578c4dfc6679a0797"><td class="memItemLeft" align="right" valign="top"><a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_istream.html">std::istream</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a350bf6c429691d3578c4dfc6679a0797">operator&gt;&gt;</a> (<a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_istream.html">std::istream</a> &amp;input, <a class="el" href="../../d7/d7c/classstatistics_1_1stats__computer1.html">stats_computer1</a> &amp;stat)</td></tr>
<tr class="separator:a350bf6c429691d3578c4dfc6679a0797"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;typename T&gt;<br />
class statistics::stats_computer1&lt; T &gt;</div><p>continuous mean and variance computance using first value as an approximation for the mean. If the first number is much far form the mean, the algorithm becomes very inaccurate to compute variance and standard deviation. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a390697dcee210b91823ceff04b25081b" name="a390697dcee210b91823ceff04b25081b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a390697dcee210b91823ceff04b25081b">&#9670;&#160;</a></span>mean()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double <a class="el" href="../../d7/d7c/classstatistics_1_1stats__computer1.html">statistics::stats_computer1</a>&lt; T &gt;::mean </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>return sample mean computed till last sample </p>
<div class="fragment"><div class="line"><span class="lineno"> 42</span>{ <span class="keywordflow">return</span> K + Ex / n; }</div>
</div><!-- fragment -->
</div>
</div>
<a id="aa13bf7c38de112f71921a5525d71a2f2" name="aa13bf7c38de112f71921a5525d71a2f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa13bf7c38de112f71921a5525d71a2f2">&#9670;&#160;</a></span>new_val()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="../../d7/d7c/classstatistics_1_1stats__computer1.html">statistics::stats_computer1</a>&lt; T &gt;::new_val </td>
<td>(</td>
<td class="paramtype">T</td> <td class="paramname"><span class="paramname"><em>x</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">x</td><td>new data sample </td></tr>
</table>
</dd>
</dl>
<div class="fragment"><div class="line"><span class="lineno"> 32</span> {</div>
<div class="line"><span class="lineno"> 33</span> <span class="keywordflow">if</span> (n == 0)</div>
<div class="line"><span class="lineno"> 34</span> K = x;</div>
<div class="line"><span class="lineno"> 35</span> n++;</div>
<div class="line"><span class="lineno"> 36</span> T tmp = x - K;</div>
<div class="line"><span class="lineno"> 37</span> Ex += tmp;</div>
<div class="line"><span class="lineno"> 38</span> Ex2 += <span class="keyword">static_cast&lt;</span><span class="keywordtype">double</span><span class="keyword">&gt;</span>(tmp) * tmp;</div>
<div class="line"><span class="lineno"> 39</span> }</div>
</div><!-- fragment -->
</div>
</div>
<a id="af57e942d49f4fd70f059f224b4ac07e1" name="af57e942d49f4fd70f059f224b4ac07e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af57e942d49f4fd70f059f224b4ac07e1">&#9670;&#160;</a></span>std()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double <a class="el" href="../../d7/d7c/classstatistics_1_1stats__computer1.html">statistics::stats_computer1</a>&lt; T &gt;::std </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>return sample standard deviation computed till last sample </p>
<div class="fragment"><div class="line"><span class="lineno"> 48</span>{ <span class="keywordflow">return</span> <a class="code hl_functionRef" target="_blank" href="http://en.cppreference.com/w/cpp/numeric/math/sqrt.html">std::sqrt</a>(this-&gt;<a class="code hl_function" href="#a27f0a03e2fd2254f1c81fe668226bd92">variance</a>()); }</div>
<div class="ttc" id="aclassstatistics_1_1stats__computer1_html_a27f0a03e2fd2254f1c81fe668226bd92"><div class="ttname"><a href="#a27f0a03e2fd2254f1c81fe668226bd92">statistics::stats_computer1::variance</a></div><div class="ttdeci">double variance() const</div><div class="ttdef"><b>Definition</b> realtime_stats.cpp:45</div></div>
<div class="ttc" id="asqrt_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/numeric/math/sqrt.html">std::sqrt</a></div><div class="ttdeci">T sqrt(T... args)</div></div>
</div><!-- fragment --><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="../../d7/d7c/classstatistics_1_1stats__computer1_af57e942d49f4fd70f059f224b4ac07e1_cgraph.svg" width="444" height="102"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div>
</div>
<a id="a27f0a03e2fd2254f1c81fe668226bd92" name="a27f0a03e2fd2254f1c81fe668226bd92"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a27f0a03e2fd2254f1c81fe668226bd92">&#9670;&#160;</a></span>variance()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double <a class="el" href="../../d7/d7c/classstatistics_1_1stats__computer1.html">statistics::stats_computer1</a>&lt; T &gt;::variance </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>return data variance computed till last sample </p>
<div class="fragment"><div class="line"><span class="lineno"> 45</span>{ <span class="keywordflow">return</span> (Ex2 - (Ex * Ex) / n) / (n - 1); }</div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Friends And Related Symbol Documentation</h2>
<a id="a350bf6c429691d3578c4dfc6679a0797" name="a350bf6c429691d3578c4dfc6679a0797"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a350bf6c429691d3578c4dfc6679a0797">&#9670;&#160;</a></span>operator&gt;&gt;</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_istream.html">std::istream</a> &amp; operator&gt;&gt; </td>
<td>(</td>
<td class="paramtype"><a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_istream.html">std::istream</a> &amp;</td> <td class="paramname"><span class="paramname"><em>input</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../d7/d7c/classstatistics_1_1stats__computer1.html">stats_computer1</a>&lt; T &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>stat</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>short-hand operator to read new sample from input stream <br />
e.g.: <code><a class="elRef" target="_blank" href="http://en.cppreference.com/w/cpp/io/basic_istream.html">std::cin</a> &gt;&gt; stats1;</code> </p>
<div class="fragment"><div class="line"><span class="lineno"> 54</span> {</div>
<div class="line"><span class="lineno"> 55</span> T val;</div>
<div class="line"><span class="lineno"> 56</span> input &gt;&gt; val;</div>
<div class="line"><span class="lineno"> 57</span> stat.<a class="code hl_function" href="#aa13bf7c38de112f71921a5525d71a2f2">new_val</a>(val);</div>
<div class="line"><span class="lineno"> 58</span> <span class="keywordflow">return</span> input;</div>
<div class="line"><span class="lineno"> 59</span> }</div>
<div class="ttc" id="aclassstatistics_1_1stats__computer1_html_aa13bf7c38de112f71921a5525d71a2f2"><div class="ttname"><a href="#aa13bf7c38de112f71921a5525d71a2f2">statistics::stats_computer1::new_val</a></div><div class="ttdeci">void new_val(T x)</div><div class="ttdef"><b>Definition</b> realtime_stats.cpp:32</div></div>
</div><!-- fragment -->
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>math/<a class="el" href="../../d0/d08/realtime__stats_8cpp.html">realtime_stats.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="../../d2/dcf/namespacestatistics.html">statistics</a></li><li class="navelem"><a class="el" href="../../d7/d7c/classstatistics_1_1stats__computer1.html">stats_computer1</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
</ul>
</div>
</body>
</html>