Skip to content

Commit 521f9f8

Browse files
committed
Documentation for 79aeaa9
1 parent 126302a commit 521f9f8

File tree

131 files changed

+3361
-3488
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

131 files changed

+3361
-3488
lines changed

d0/d08/realtime__stats_8cpp.html

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -145,36 +145,32 @@
145145
<tr class="heading"><td colspan="2"><h2 id="header-func-members" class="groupheader"><a id="func-members" name="func-members"></a>
146146
Functions</h2></td></tr>
147147
<tr class="memitem:aa54c915581fcc495489175a4386d59fd" id="r_aa54c915581fcc495489175a4386d59fd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa54c915581fcc495489175a4386d59fd">test_function</a> (const float *test_data, const int number_of_samples)</td></tr>
148-
<tr class="memitem:a3c04138a5bfe5d72780bb7e82a18e627" id="r_a3c04138a5bfe5d72780bb7e82a18e627"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3c04138a5bfe5d72780bb7e82a18e627">main</a> (int argc, char **argv)</td></tr>
148+
<tr class="memitem:ae66f6b31b5ad750f1fe042a706a4e3d4" id="r_ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a> ()</td></tr>
149149
</table>
150150
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
151151
<div class="textblock"><p>Compute statistics for data entered in rreal-time. </p>
152152
<p>This algorithm is really beneficial to compute statistics on data read in realtime. For example, devices reading biometrics data. The algorithm is simple enough to be easily implemented in an embedded system. </p><dl class="section author"><dt>Author</dt><dd><a href="https://github.com/kvedala" target="_blank">Krishna Vedala</a> </dd></dl>
153153

154154
<p class="definition">Definition in file <a class="el" href="../../d0/d08/realtime__stats_8cpp_source.html">realtime_stats.cpp</a>.</p>
155155
</div><a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2>
156-
<a id="a3c04138a5bfe5d72780bb7e82a18e627" name="a3c04138a5bfe5d72780bb7e82a18e627"></a>
157-
<h2 class="memtitle"><span class="permalink"><a href="#a3c04138a5bfe5d72780bb7e82a18e627">&#9670;&#160;</a></span>main()</h2>
156+
<a id="ae66f6b31b5ad750f1fe042a706a4e3d4" name="ae66f6b31b5ad750f1fe042a706a4e3d4"></a>
157+
<h2 class="memtitle"><span class="permalink"><a href="#ae66f6b31b5ad750f1fe042a706a4e3d4">&#9670;&#160;</a></span>main()</h2>
158158

159159
<div class="memitem">
160160
<div class="memproto">
161161
<table class="memname">
162162
<tr>
163163
<td class="memname">int main </td>
164164
<td>(</td>
165-
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>argc</em></span>, </td>
166-
</tr>
167-
<tr>
168-
<td class="paramkey"></td>
165+
<td class="paramtype">void</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
169166
<td></td>
170-
<td class="paramtype">char **</td> <td class="paramname"><span class="paramname"><em>argv</em></span>&#160;)</td>
171167
</tr>
172168
</table>
173169
</div><div class="memdoc">
174170
<p>Main function </p>
175171

176172
<p class="definition">Definition at line <a class="el" href="../../d0/d08/realtime__stats_8cpp_source.html#l00158">158</a> of file <a class="el" href="../../d0/d08/realtime__stats_8cpp_source.html">realtime_stats.cpp</a>.</p>
177-
<div class="fragment"><div class="line"><span class="lineno"> 158</span> {</div>
173+
<div class="fragment"><div class="line"><span class="lineno"> 158</span> {</div>
178174
<div class="line"><span class="lineno"> 159</span> <span class="keyword">const</span> <span class="keywordtype">float</span> test_data1[] = {3, 4, 5, -1.4, -3.6, 1.9, 1.};</div>
179175
<div class="line"><span class="lineno"> 160</span> <a class="code hl_function" href="#aa54c915581fcc495489175a4386d59fd">test_function</a>(test_data1, <span class="keyword">sizeof</span>(test_data1) / <span class="keyword">sizeof</span>(test_data1[0]));</div>
180176
<div class="line"><span class="lineno"> 161</span> </div>

d0/d08/realtime__stats_8cpp.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@ var realtime__stats_8cpp =
44
[ "statistics::stats_computer2< T >", "d8/dab/classstatistics_1_1stats__computer2.html", "d8/dab/classstatistics_1_1stats__computer2" ],
55
[ "stats_computer1< T >", "d2/d0f/classstats__computer1.html", "d2/d0f/classstats__computer1" ],
66
[ "stats_computer2< T >", "dc/d02/classstats__computer2.html", "dc/d02/classstats__computer2" ],
7-
[ "main", "d0/d08/realtime__stats_8cpp.html#a3c04138a5bfe5d72780bb7e82a18e627", null ],
7+
[ "main", "d0/d08/realtime__stats_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4", null ],
88
[ "test_function", "d0/d08/realtime__stats_8cpp.html#aa54c915581fcc495489175a4386d59fd", null ]
99
];

d0/d08/realtime__stats_8cpp_source.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,7 @@
244244
</div>
245245
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno"> 156</span></div>
246246
<div class="foldopen" id="foldopen00158" data-start="{" data-end="}">
247-
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno"><a class="line" href="../../d0/d08/realtime__stats_8cpp.html#a3c04138a5bfe5d72780bb7e82a18e627"> 158</a></span><span class="keywordtype">int</span> <a class="code hl_function" href="../../dd/d1e/generate__parentheses_8cpp.html#gae66f6b31b5ad750f1fe042a706a4e3d4">main</a>(<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span> **argv) {</div>
247+
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno"><a class="line" href="../../d0/d08/realtime__stats_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4"> 158</a></span><span class="keywordtype">int</span> <a class="code hl_function" href="../../d0/d08/realtime__stats_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a>() {</div>
248248
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno"> 159</span> <span class="keyword">const</span> <span class="keywordtype">float</span> test_data1[] = {3, 4, 5, -1.4, -3.6, 1.9, 1.};</div>
249249
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno"> 160</span> <a class="code hl_function" href="../../d0/d08/realtime__stats_8cpp.html#aa54c915581fcc495489175a4386d59fd">test_function</a>(test_data1, <span class="keyword">sizeof</span>(test_data1) / <span class="keyword">sizeof</span>(test_data1[0]));</div>
250250
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno"> 161</span> </div>
@@ -293,9 +293,9 @@
293293
<div class="ttc" id="aclassstatistics_1_1stats__computer2_html_acf2e84df4fc386bb3295016ef8fd156e"><div class="ttname"><a href="../../d8/dab/classstatistics_1_1stats__computer2.html#acf2e84df4fc386bb3295016ef8fd156e">statistics::stats_computer2::std</a></div><div class="ttdeci">double std() const</div><div class="ttdef"><b>Definition</b> <a href="#l00092">realtime_stats.cpp:92</a></div></div>
294294
<div class="ttc" id="aclassstatistics_1_1stats__computer2_html_ade6de704deea24fdc88077b3d9a0d534"><div class="ttname"><a href="../../d8/dab/classstatistics_1_1stats__computer2.html#ade6de704deea24fdc88077b3d9a0d534">statistics::stats_computer2::new_val</a></div><div class="ttdeci">void new_val(T x)</div><div class="ttdef"><b>Definition</b> <a href="#l00077">realtime_stats.cpp:77</a></div></div>
295295
<div class="ttc" id="aclassstatistics_1_1stats__computer2_html_af6198817084276113b3c064e87ce0555"><div class="ttname"><a href="../../d8/dab/classstatistics_1_1stats__computer2.html#af6198817084276113b3c064e87ce0555">statistics::stats_computer2::variance</a></div><div class="ttdeci">double variance() const</div><div class="ttdef"><b>Definition</b> <a href="#l00089">realtime_stats.cpp:89</a></div></div>
296-
<div class="ttc" id="agenerate__parentheses_8cpp_html_gae66f6b31b5ad750f1fe042a706a4e3d4"><div class="ttname"><a href="../../dd/d1e/generate__parentheses_8cpp.html#gae66f6b31b5ad750f1fe042a706a4e3d4">main</a></div><div class="ttdeci">int main()</div><div class="ttdoc">Main function.</div><div class="ttdef"><b>Definition</b> <a href="../../dd/d1e/generate__parentheses_8cpp_source.html#l00110">generate_parentheses.cpp:110</a></div></div>
297296
<div class="ttc" id="anamespacestatistics_html"><div class="ttname"><a href="../../d2/dcf/namespacestatistics.html">statistics</a></div><div class="ttdoc">Statistical algorithms.</div></div>
298297
<div class="ttc" id="arealtime__stats_8cpp_html_aa54c915581fcc495489175a4386d59fd"><div class="ttname"><a href="../../d0/d08/realtime__stats_8cpp.html#aa54c915581fcc495489175a4386d59fd">test_function</a></div><div class="ttdeci">void test_function(const float *test_data, const int number_of_samples)</div><div class="ttdef"><b>Definition</b> <a href="#l00118">realtime_stats.cpp:118</a></div></div>
298+
<div class="ttc" id="arealtime__stats_8cpp_html_ae66f6b31b5ad750f1fe042a706a4e3d4"><div class="ttname"><a href="../../d0/d08/realtime__stats_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a></div><div class="ttdeci">int main()</div><div class="ttdef"><b>Definition</b> <a href="#l00158">realtime_stats.cpp:158</a></div></div>
299299
</div><!-- fragment --></div><!-- contents -->
300300
</div><!-- doc-content -->
301301
</div><!-- container -->

0 commit comments

Comments
 (0)