-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmsutimer_8h_source.html
More file actions
157 lines (155 loc) · 16.6 KB
/
msutimer_8h_source.html
File metadata and controls
157 lines (155 loc) · 16.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MSUTimer: msutimer.h Source File</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>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">MSUTimer
 <span id="projectnumber">v0.01 alpha</span>
</div>
<div id="projectbrief">Simple High Resolution Timer for C</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('msutimer_8h_source.html',''); initResizable(); });
/* @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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">msutimer.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="msutimer_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"><a class="line" href="msutimer_8h.html#aaa3124bc53d7c37e4b282170aa44c133"> 1</a></span> <span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">Zlib License</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">--------------------------------------------------</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">Copyright (c) 2021 migf1@hotmail.com</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span> </div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">This software is provided 'as-is', without any express or implied</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">warranty. In no event will the authors be held liable for any damages</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">arising from the use of this software.</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"></span> </div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">Permission is granted to anyone to use this software for any purpose,</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">including commercial applications, and to alter it and redistribute it</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">freely, subject to the following restrictions:</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"></span> </div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">1. The origin of this software must not be misrepresented; you must not</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> claim that you wrote the original software. If you use this software</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> in a product, an acknowledgment in the product documentation would be</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> appreciated but is not required.</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">2. Altered source versions must be plainly marked as such, and must not be</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> misrepresented as being the original software.</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">3. This notice may not be removed or altered from any source distribution.</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">--------------------------------------------------</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor">#ifndef MSUTIMER_H </span><span class="comment">/* start of inclusion guard */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#define MSUTIMER_H</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  </div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor">#include <stddef.h></span> <span class="comment">// size_t, etc</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor">#include <stdbool.h></span> <span class="comment">// C99: bool, true, false</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>MSUTimer_ MSUTimer;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  </div>
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="msutimer_8h.html#a39aa51836a0fc8e7da43e6293bc6f87a"> 51</a></span> <span class="preprocessor">#define MSUT_US2MS(usecs) ((usecs) * 0.001) </span></div>
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="msutimer_8h.html#a3803c248d042a7a010433db47737b6e4"> 52</a></span> <span class="preprocessor">#define MSUT_US2S(usecs) ((usecs) * 0.000001) </span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> MSUTimer *<a class="code" href="msutimer_8h.html#acb8782114eb99c008bd70f31856075f7">msutimer_new</a>(<span class="keywordtype">void</span>); </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> MSUTimer *<a class="code" href="msutimer_8h.html#a9eb8df77fffe284b53342938a32a8bd8">msutimer_free</a>(MSUTimer *timer); </div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="keywordtype">double</span> <a class="code" href="msutimer_8h.html#a0ad520b7e2ed145d3b650b37be37da88">msutimer_accuracy_usecs</a>(MSUTimer *timer);</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="keywordtype">double</span> <a class="code" href="msutimer_8h.html#ae8fb0b9fe87ca6721a959f1ad8f5066e">msutimer_gettime</a>( MSUTimer *timer ); </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="keywordtype">double</span> <a class="code" href="msutimer_8h.html#a1a38919d5622d0d27cf6292b19b34f04">msutimer_diff_usecs</a>(MSUTimer *timer); </div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="keywordtype">double</span> <a class="code" href="msutimer_8h.html#a3b59e9d5d3bb4a20302c815d3728bdd1">msutimer_diff_msecs</a>(MSUTimer *timer); </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="keywordtype">double</span> <a class="code" href="msutimer_8h.html#a291e54b82e889c82346ec7c98ae6f18e">msutimer_diff_secs</a>(MSUTimer *timer); </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  </div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="keywordtype">double</span> <a class="code" href="msutimer_8h.html#a012bbbc2104dd2e471dc635626fe7b5c">msutimer_bench</a>(MSUTimer *timer, <span class="keywordtype">size_t</span> nrepeats, <span class="keywordtype">bool</span> (*callback)(<span class="keywordtype">void</span> *), <span class="keywordtype">void</span> *userdata, <span class="keywordtype">size_t</span> *erepeat);</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="keywordtype">double</span> <a class="code" href="msutimer_8h.html#a0680bc49327dac06b2a2bb1c715914e9">msutimer_bench_average</a>(MSUTimer *timer, <span class="keywordtype">size_t</span> nrepeats, <span class="keywordtype">bool</span> (*callback)(<span class="keywordtype">void</span> *), <span class="keywordtype">void</span> *userdata, <span class="keywordtype">size_t</span> *erepeat);</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="keywordtype">double</span> <a class="code" href="msutimer_8h.html#a59f02f48eab0566b6188937a8d5c8292">msutimer_bench_median</a>(MSUTimer *timer, <span class="keywordtype">size_t</span> nrepeats, <span class="keywordtype">bool</span> (*callback)(<span class="keywordtype">void</span> *), <span class="keywordtype">void</span> *userdata, <span class="keywordtype">size_t</span> *erepeat);</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="preprocessor">#endif </span><span class="comment">/* end of inclusion guard */</span><span class="preprocessor"></span></div>
<div class="ttc" id="amsutimer_8h_html_a012bbbc2104dd2e471dc635626fe7b5c"><div class="ttname"><a href="msutimer_8h.html#a012bbbc2104dd2e471dc635626fe7b5c">msutimer_bench</a></div><div class="ttdeci">double msutimer_bench(MSUTimer *timer, size_t nrepeats, bool(*callback)(void *), void *userdata, size_t *erepeat)</div><div class="ttdoc">Get callback's execution time.</div><div class="ttdef"><b>Definition:</b> msutimer.c:544</div></div>
<div class="ttc" id="amsutimer_8h_html_a0680bc49327dac06b2a2bb1c715914e9"><div class="ttname"><a href="msutimer_8h.html#a0680bc49327dac06b2a2bb1c715914e9">msutimer_bench_average</a></div><div class="ttdeci">double msutimer_bench_average(MSUTimer *timer, size_t nrepeats, bool(*callback)(void *), void *userdata, size_t *erepeat)</div><div class="ttdoc">Get callback's average execution time.</div><div class="ttdef"><b>Definition:</b> msutimer.c:610</div></div>
<div class="ttc" id="amsutimer_8h_html_a0ad520b7e2ed145d3b650b37be37da88"><div class="ttname"><a href="msutimer_8h.html#a0ad520b7e2ed145d3b650b37be37da88">msutimer_accuracy_usecs</a></div><div class="ttdeci">double msutimer_accuracy_usecs(MSUTimer *timer)</div><div class="ttdoc">Get MSUTimer accuracy.</div><div class="ttdef"><b>Definition:</b> msutimer.c:469</div></div>
<div class="ttc" id="amsutimer_8h_html_a1a38919d5622d0d27cf6292b19b34f04"><div class="ttname"><a href="msutimer_8h.html#a1a38919d5622d0d27cf6292b19b34f04">msutimer_diff_usecs</a></div><div class="ttdeci">double msutimer_diff_usecs(MSUTimer *timer)</div><div class="ttdoc">Get updated time-difference in microseconds.</div><div class="ttdef"><b>Definition:</b> msutimer.c:353</div></div>
<div class="ttc" id="amsutimer_8h_html_a291e54b82e889c82346ec7c98ae6f18e"><div class="ttname"><a href="msutimer_8h.html#a291e54b82e889c82346ec7c98ae6f18e">msutimer_diff_secs</a></div><div class="ttdeci">double msutimer_diff_secs(MSUTimer *timer)</div><div class="ttdoc">Get updated time-difference in seconds.</div><div class="ttdef"><b>Definition:</b> msutimer.c:409</div></div>
<div class="ttc" id="amsutimer_8h_html_a3b59e9d5d3bb4a20302c815d3728bdd1"><div class="ttname"><a href="msutimer_8h.html#a3b59e9d5d3bb4a20302c815d3728bdd1">msutimer_diff_msecs</a></div><div class="ttdeci">double msutimer_diff_msecs(MSUTimer *timer)</div><div class="ttdoc">Get updated time-difference in milliseconds.</div><div class="ttdef"><b>Definition:</b> msutimer.c:381</div></div>
<div class="ttc" id="amsutimer_8h_html_a59f02f48eab0566b6188937a8d5c8292"><div class="ttname"><a href="msutimer_8h.html#a59f02f48eab0566b6188937a8d5c8292">msutimer_bench_median</a></div><div class="ttdeci">double msutimer_bench_median(MSUTimer *timer, size_t nrepeats, bool(*callback)(void *), void *userdata, size_t *erepeat)</div><div class="ttdoc">Get callback's median execution time.</div><div class="ttdef"><b>Definition:</b> msutimer.c:681</div></div>
<div class="ttc" id="amsutimer_8h_html_a9eb8df77fffe284b53342938a32a8bd8"><div class="ttname"><a href="msutimer_8h.html#a9eb8df77fffe284b53342938a32a8bd8">msutimer_free</a></div><div class="ttdeci">MSUTimer * msutimer_free(MSUTimer *timer)</div><div class="ttdoc">Free an existing timer.</div><div class="ttdef"><b>Definition:</b> msutimer.c:262</div></div>
<div class="ttc" id="amsutimer_8h_html_acb8782114eb99c008bd70f31856075f7"><div class="ttname"><a href="msutimer_8h.html#acb8782114eb99c008bd70f31856075f7">msutimer_new</a></div><div class="ttdeci">MSUTimer * msutimer_new(void)</div><div class="ttdoc">Create a new timer.</div><div class="ttdef"><b>Definition:</b> msutimer.c:205</div></div>
<div class="ttc" id="amsutimer_8h_html_ae8fb0b9fe87ca6721a959f1ad8f5066e"><div class="ttname"><a href="msutimer_8h.html#ae8fb0b9fe87ca6721a959f1ad8f5066e">msutimer_gettime</a></div><div class="ttdeci">double msutimer_gettime(MSUTimer *timer)</div><div class="ttdoc">Get current time & update time-difference.</div><div class="ttdef"><b>Definition:</b> msutimer.c:306</div></div>
</div><!-- fragment --></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="msutimer_8h.html">msutimer.h</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.9.1 </li>
</ul>
</div>
</body>
</html>