-
Notifications
You must be signed in to change notification settings - Fork 6
/
Utils--Benchmark.html
175 lines (136 loc) · 8.14 KB
/
Utils--Benchmark.html
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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Utils::Benchmark - Performance benchmarking : OpenKore source code documentation</title>
<link rel="stylesheet" type="text/css" href="openkore.css">
<link rel="stylesheet" type="text/css" href="highlight.css">
<!-- Fix broken PNG transparency for IE/Win5-6+ -->
<!--[if gte IE 5.5000]>
<script type="text/javascript" src="pngfix.js"></script>
<![endif]-->
</head>
<body>
<div id="title">OpenKore source code documentation</div>
<div id="navigation">
<ul>
<li><a href="http://www.openkore.com/">Main website</a></li>
<li><a href="index.html">Table of contents</a></li>
<li><b>Utils::Benchmark</b></li>
</ul>
</div>
<div id="main">
<h1>Utils::Benchmark - Performance benchmarking</h1>
This module allows you to benchmark Perl code. You use it as follows:
<pre class="example">
<span class="hl kwa">use</span> Utils<span class="hl sym">::</span><span class="hl kwd">Benchmark</span><span class="hl sym">;</span>
<span class="hl kwa">use</span> Carp<span class="hl sym">::</span><span class="hl kwd">Assert</span><span class="hl sym">;</span> <span class="hl slc"># Very important! This gives you the DEBUG constant.</span>
<span class="hl kwa">sub</span> foo <span class="hl sym">{</span>
<span class="hl sym">...</span> <span class="hl kwa">do</span> something <span class="hl sym">...</span>
<span class="hl sym">}</span>
<span class="hl kwa">sub</span> bar <span class="hl sym">{</span>
<span class="hl sym">...</span> <span class="hl kwa">do</span> something <span class="hl sym">...</span>
<span class="hl sym">}</span>
Benchmark<span class="hl sym">::</span><span class="hl kwd">begin</span><span class="hl sym">(</span><span class="hl str">"Total"</span><span class="hl sym">)</span> <span class="hl kwa">if</span> <span class="hl kwd">DEBUG</span><span class="hl sym">;</span>
Benchmark<span class="hl sym">::</span><span class="hl kwd">begin</span><span class="hl sym">(</span><span class="hl str">"foo"</span><span class="hl sym">)</span> <span class="hl kwa">if</span> <span class="hl kwd">DEBUG</span><span class="hl sym">;</span>
<span class="hl kwd">foo</span><span class="hl sym">();</span>
Benchmark<span class="hl sym">::</span><span class="hl kwd">end</span><span class="hl sym">(</span><span class="hl str">"foo"</span><span class="hl sym">)</span> <span class="hl kwa">if</span> <span class="hl kwd">DEBUG</span><span class="hl sym">;</span>
Benchmark<span class="hl sym">::</span><span class="hl kwd">begin</span><span class="hl sym">(</span><span class="hl str">"bar"</span><span class="hl sym">)</span> <span class="hl kwa">if</span> <span class="hl kwd">DEBUG</span><span class="hl sym">;</span>
<span class="hl kwd">bar</span><span class="hl sym">();</span>
Benchmark<span class="hl sym">::</span><span class="hl kwd">end</span><span class="hl sym">(</span><span class="hl str">"bar"</span><span class="hl sym">)</span> <span class="hl kwa">if</span> <span class="hl kwd">DEBUG</span><span class="hl sym">;</span>
Benchmark<span class="hl sym">::</span><span class="hl kwd">end</span><span class="hl sym">(</span><span class="hl str">"Total"</span><span class="hl sym">)</span> <span class="hl kwa">if</span> <span class="hl kwd">DEBUG</span><span class="hl sym">;</span>
<span class="hl kwc">print</span> <span class="hl sym"><</span>a href<span class="hl sym">=</span><span class="hl str">"Utils--Benchmark.html#Benchmark::results"</span><span class="hl sym">><</span>code<span class="hl sym">></span>Benchmark<span class="hl sym">::</span><span class="hl kwd">results</span><span class="hl sym">()<</span><span class="hl kwc">/code></</span>a<span class="hl sym">></span> <span class="hl kwa">if</span> <span class="hl kwd">DEBUG</span><span class="hl sym">;</span>
</pre>
<p>
You should always put "if DEBUG" after every Benchmark method call. That allows
you to disable benchmarking if the NDEBUG environment variable is set, which
will eliminate benchmarking overhead. Since DEBUG is a constant, Perl will compile
out the Benchmarking code at compile time if DEBUG evaluates to false.
See also <a href="http://cpan.uwinnipeg.ca/htdocs/Carp-Assert/Carp/Assert.html#efficiency">Carp::Assert's documentation.</a>
<p><table class="functionIndex">
<tr><th colspan="3">Functions in this module</th></tr><tr onclick="location.href='#Benchmark::begin';">
<td class="return-type">void</td>
<td class="func"><a href="#Benchmark::begin">Benchmark::begin</a></td>
<td class="decl">(<span class="type">String</span> domain)</td>
</tr><tr onclick="location.href='#Benchmark::end';">
<td class="return-type">void</td>
<td class="func"><a href="#Benchmark::end">Benchmark::end</a></td>
<td class="decl">(<span class="type">String</span> domain)</td>
</tr><tr onclick="location.href='#Benchmark::results';">
<td class="return-type">String</td>
<td class="func"><a href="#Benchmark::results">Benchmark::results</a></td>
<td class="decl">(<span class="type">String</span> relativeTo)</td>
</tr>
</table>
<p><hr class="details_sep">
<h2>Details</h2>
<div class="details">
<p>
<div class="function"><a name="Benchmark::begin"></a>
<h3>Benchmark::begin</h3>
<dl>
<dt class="decl">
<span class="return-type"> void</span> <strong>Benchmark::begin</strong>(<span class="type">String</span> domain)
</dt>
<dd>
<dl class="params_and_returns">
<dt class="params"><strong>Parameters:</strong></dt>
<dd class="param"><code>domain</code> : A unique name for the piece of code you're benchmarking.</dd>
<dt class="requires"><strong>Requires:</strong></dt>
<dd class="requires">defined($domain)</dd>
</dl><p>
<div class="desc">Begin measuring the time that a piece of code will take.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="Benchmark::end"></a>
<h3>Benchmark::end</h3>
<dl>
<dt class="decl">
<span class="return-type"> void</span> <strong>Benchmark::end</strong>(<span class="type">String</span> domain)
</dt>
<dd>
<dl class="params_and_returns">
<dt class="params"><strong>Parameters:</strong></dt>
<dd class="param"><code>domain</code> : A unique name for the piece of code you're benchmarking.</dd>
<dt class="requires"><strong>Requires:</strong></dt>
<dd class="requires">defined($domain)</dd>
</dl><p>
<div class="desc">End measuring the time that a piece of code took.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="Benchmark::results"></a>
<h3>Benchmark::results</h3>
<dl>
<dt class="decl">
<span class="return-type"> String</span> <strong>Benchmark::results</strong>(<span class="type">String</span> relativeTo)
</dt>
<dd>
<dl class="params_and_returns">
<dt class="params"><strong>Parameters:</strong></dt>
<dd class="param"><code>relativeTo</code> : The domain with which percentages are calculated.</dd>
<dt class="requires"><strong>Requires:</strong></dt>
<dd class="requires">defined($relativeTo)</dd>
<dt class="ensures"><strong>Ensures:</strong></dt>
<dd class="ensures">defined(result)</dd>
</dl><p>
<div class="desc">Returns a string which contains the benchmarking results.</div>
</dd>
</dl>
</div>
</div>
<p><hr><p>
<div id="footer">
<ul>
<li><a href="http://validator.w3.org/check?uri=referer" title="Valid HTML 4.01!"><img src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" height="31" width="88"></a></li>
<li><a href="http://www.mozilla.com/" title="Get Firefox - Take Back the Web"><img width="104" height="32" src="http://www.mozilla.org/products/firefox/buttons/getfirefox_small.png" alt="Get Firefox - Take Back the Web"></a></li>
<li><a href="http://www.mozilla.com/" title="If you were looking at this page in any browser but Microsoft Internet Explorer, it would look and run better and faster"><img width="45" height="45" src="http://linuxart.com/img/noIE-small.png" alt="If you were looking at this page in any browser but Microsoft Internet Explorer, it would look and run better and faster"></a></li>
</ul>
Last modified: Fri Nov 16 10:05:11 2012
</div>
</div>
</body>
</html>