|
0
|
1 |
|
|
|
2 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> |
|
|
3 |
<html> |
|
|
4 |
<head> |
|
|
5 |
<title>YUI Library Examples: Profiler: Simple Profiling Example</title> |
|
|
6 |
<meta http-equiv="content-type" content="text/html; charset=utf-8"> |
|
|
7 |
<link rel="stylesheet" type="text/css" href="../../assets/yui.css" > |
|
|
8 |
|
|
|
9 |
<style> |
|
|
10 |
/*Supplemental CSS for the YUI distribution*/ |
|
|
11 |
#custom-doc { width: 95%; min-width: 950px; } |
|
|
12 |
#pagetitle {background-image: url(../../assets/bg_hd.gif);} |
|
|
13 |
/* #pagetitle h1 {background-image: url(../../assets/title_h_bg.gif);}*/ |
|
|
14 |
</style> |
|
|
15 |
|
|
|
16 |
<link rel="stylesheet" type="text/css" href="../../assets/dpSyntaxHighlighter.css"> |
|
|
17 |
|
|
|
18 |
<!--there is no custom header content for this example--> |
|
|
19 |
|
|
|
20 |
<link type="text/css" rel="stylesheet" href="../../build/cssfonts/fonts-min.css" /> |
|
|
21 |
<script type="text/javascript" src="../../build/yui/yui-debug.js"></script> |
|
|
22 |
|
|
|
23 |
</head> |
|
|
24 |
<body id="yahoo-com" class=" yui-skin-sam"> |
|
|
25 |
<div id="custom-doc" class="yui-t2"> |
|
|
26 |
<div id="hd"> |
|
|
27 |
<div id="ygunav"> |
|
|
28 |
<p> |
|
|
29 |
<em> |
|
|
30 |
<a href="http://developer.yahoo.com/yui/3/">YUI 3.x Home</a> <i> - </i> |
|
|
31 |
</em> |
|
|
32 |
</p> |
|
|
33 |
<form action="http://search.yahoo.com/search" id="sitesearchform"> |
|
|
34 |
<input name="vs" type="hidden" value="developer.yahoo.com"> |
|
|
35 |
<input name="vs" type="hidden" value="yuiblog.com"> |
|
|
36 |
<div id="sitesearch"> |
|
|
37 |
<label for="searchinput">Site Search (YDN & YUIBlog): </label> |
|
|
38 |
<input type="text" id="searchinput" name="p"> |
|
|
39 |
<input type="submit" value="Search" id="searchsubmit" class="ygbt"> |
|
|
40 |
</div> |
|
|
41 |
</form> |
|
|
42 |
</div> |
|
|
43 |
<div id="ygma"><a href="../../"><img src="../../assets/logo.gif" border="0" width="200" height="93"></a></div> |
|
|
44 |
<div id="pagetitle"><h1>YUI Library Examples: Profiler: Simple Profiling Example</h1></div> |
|
|
45 |
</div> |
|
|
46 |
<div id="bd"> |
|
|
47 |
|
|
|
48 |
<div id="bar-note"><p><strong>Note:</strong> This is YUI 3.x. Looking for <a href="http://developer.yahoo.com/yui/">YUI 2.x</a>?</p></div> |
|
|
49 |
|
|
|
50 |
<div id="yui-main"> |
|
|
51 |
<div class="yui-b"> |
|
|
52 |
<div class="yui-ge"> |
|
|
53 |
<div class="yui-u first example" id="main"> |
|
|
54 |
|
|
|
55 |
<h2>Profiler: Simple Profiling Example</h2> |
|
|
56 |
|
|
|
57 |
<div id="example" class="promo"> |
|
|
58 |
<p> |
|
|
59 |
<p>This example shows basic usage of the Profiler for profiling a single function. A single function is |
|
|
60 |
profiled and all of the information displayed.</p> </p> |
|
|
61 |
|
|
|
62 |
<div class="module example-container "> |
|
|
63 |
<div id="example-canvas" class="bd"> |
|
|
64 |
|
|
|
65 |
|
|
|
66 |
<!--BEGIN SOURCE CODE FOR EXAMPLE =============================== --> |
|
|
67 |
|
|
|
68 |
<script type="text/javascript"> |
|
|
69 |
|
|
|
70 |
YUI({base:"../../build/", timeout: 10000, filter:"debug", logInclude: {profiler:true, example:true}}).use("event", "profiler",function (Y) { |
|
|
71 |
|
|
|
72 |
Y.namespace("example.profiler"); |
|
|
73 |
|
|
|
74 |
//object with method to profile |
|
|
75 |
Y.example.profiler.MathHelper = { |
|
|
76 |
factorial : function (num){ |
|
|
77 |
if (num > 1) { |
|
|
78 |
return num * Y.example.profiler.MathHelper.factorial(num-1); |
|
|
79 |
} else { |
|
|
80 |
return 1; |
|
|
81 |
} |
|
|
82 |
} |
|
|
83 |
}; |
|
|
84 |
|
|
|
85 |
//register the function |
|
|
86 |
Y.Profiler.registerFunction("Y.example.profiler.MathHelper.factorial", Y.example.profiler.MathHelper); |
|
|
87 |
|
|
|
88 |
window.onload = function (){ |
|
|
89 |
|
|
|
90 |
Y.example.profiler.MathHelper.factorial(10); |
|
|
91 |
|
|
|
92 |
var calls = Y.Profiler.getCallCount("Y.example.profiler.MathHelper.factorial"); |
|
|
93 |
var max = Y.Profiler.getMax("Y.example.profiler.MathHelper.factorial"); |
|
|
94 |
var min = Y.Profiler.getMin("Y.example.profiler.MathHelper.factorial"); |
|
|
95 |
var avg = Y.Profiler.getAverage("Y.example.profiler.MathHelper.factorial"); |
|
|
96 |
|
|
|
97 |
Y.Profiler.unregisterFunction("Y.example.profiler.MathHelper.factorial"); |
|
|
98 |
|
|
|
99 |
var msg = "Method Y.example.profiler.MathHelper was run " + calls + "times.\n" + |
|
|
100 |
"The average time was " + avg + "ms.\n" + |
|
|
101 |
"The max time was " + max + " ms.\n" + |
|
|
102 |
"The min time was " + min + " ms."; |
|
|
103 |
alert(msg); |
|
|
104 |
}; |
|
|
105 |
}); |
|
|
106 |
</script> |
|
|
107 |
<!--END SOURCE CODE FOR EXAMPLE =============================== --> |
|
|
108 |
|
|
|
109 |
|
|
|
110 |
</div> |
|
|
111 |
</div> |
|
|
112 |
</div> |
|
|
113 |
|
|
|
114 |
<h2 class="first">Simple Profiling Example</h2> |
|
|
115 |
|
|
|
116 |
<p>This example begins by creating a namespace:</p> |
|
|
117 |
<textarea name="code" class="JScript" cols="60" rows="1"> |
|
|
118 |
Y.namespace("example.profiler"); |
|
|
119 |
</textarea> |
|
|
120 |
<p>This namespace serves as the core object upon which others will be added (to prevent creating global objects).</p> |
|
|
121 |
<p>Next, an object is created with a method:</p> |
|
|
122 |
<textarea name="code" class="JScript" cols="60" rows="1"> |
|
|
123 |
//object with method to profile |
|
|
124 |
Y.example.profiler.MathHelper = { |
|
|
125 |
factorial : function (num){ |
|
|
126 |
if (num > 1) { |
|
|
127 |
return num * MathHelper.factorial(num-1); |
|
|
128 |
} else { |
|
|
129 |
return 1; |
|
|
130 |
} |
|
|
131 |
} |
|
|
132 |
}; |
|
|
133 |
</textarea> |
|
|
134 |
<p>This object, <code>MathHelper</code> contains a single method called <code>factorial()</code> that computes the |
|
|
135 |
factorial of a given number. Any time <code>factorial()</code> is called, the argument indicates how many times |
|
|
136 |
the function will be recursively called. For example, <code>factorial(10)</code> results in the funtion being |
|
|
137 |
called 10 times. This makes it an ideal test case for profiling because the results are so predictable.</p> |
|
|
138 |
<h3>Registering the function</h3> |
|
|
139 |
<p>The most important step to profile this function is to call <code>registerFunction()</code> with the fully-qualified |
|
|
140 |
function name, which is <code>Y.example.profiler.MathHelper</code>, and the object:</p> |
|
|
141 |
<textarea name="code" class="JScript" cols="60" rows="1"> |
|
|
142 |
Y.Profiler.registerFunction("Y.example.profiler.MathHelper.factorial", Y.example.profiler.MathHelper); |
|
|
143 |
</textarea> |
|
|
144 |
<p>Since this function is not fully accessible in the global scope, the owner object must be passed in |
|
|
145 |
as the second argument.</p> |
|
|
146 |
|
|
|
147 |
<h3>Running the example</h3> |
|
|
148 |
|
|
|
149 |
<p>With everything setup, the last step is to run the code. This initialization is assigned to take place when the window has been |
|
|
150 |
completely loaded by using the <code>window.onload</code> event handler:</p> |
|
|
151 |
|
|
|
152 |
<textarea name="code" class="JScript" cols="60" rows="1"> |
|
|
153 |
window.onload = function (){ |
|
|
154 |
|
|
|
155 |
Y.example.profiler.MathHelper.factorial(10); |
|
|
156 |
|
|
|
157 |
var calls = Y.Profiler.getCallCount("Y.example.profiler.MathHelper.factorial"); |
|
|
158 |
var max = Y.Profiler.getMax("Y.example.profiler.MathHelper.factorial"); |
|
|
159 |
var min = Y.Profiler.getMin("Y.example.profiler.MathHelper.factorial"); |
|
|
160 |
var avg = Y.Profiler.getAverage("Y.example.profiler.MathHelper.factorial"); |
|
|
161 |
|
|
|
162 |
Y.Profiler.unregisterFunction("Y.example.profiler.MathHelper.factorial"); |
|
|
163 |
|
|
|
164 |
var msg = "Method Y.example.profiler.MathHelper was run " + calls + "times.\n" + |
|
|
165 |
"The average time was " + avg + "ms.\n" + |
|
|
166 |
"The max time was " + max + " ms.\n" + |
|
|
167 |
"The min time was " + min + " ms."; |
|
|
168 |
alert(msg); |
|
|
169 |
}; |
|
|
170 |
</textarea> |
|
|
171 |
<p>The code block begins by calling <code>factorial()</code> once, which gets profiled. Then, the information |
|
|
172 |
about the function can be retrieved from the Profiler. This information is output into the Logger on the page, |
|
|
173 |
displaying the number of times that the function was called along with the minimum, maximum, and average |
|
|
174 |
running times. Since this is a very simple function, the run times will most likely be 0ms on most machines.</p> </div> |
|
|
175 |
<div class="yui-u sidebar"> |
|
|
176 |
|
|
|
177 |
|
|
|
178 |
<div id="examples" class="mod box4"> |
|
|
179 |
<div class="hd"> |
|
|
180 |
<h4> |
|
|
181 |
Profiler Examples:</h4> |
|
|
182 |
</div> |
|
|
183 |
<div class="bd"> |
|
|
184 |
<ul> |
|
|
185 |
<li class='selected'><a href='../profiler/profiler-simple-example.html'>Simple Profiling Example</a></li><li><a href='../profiler/profiler-object-example.html'>Object Profiling Example</a></li> </ul> |
|
|
186 |
</div> |
|
|
187 |
</div> |
|
|
188 |
|
|
|
189 |
<div class="mod box4"> |
|
|
190 |
<div class="hd"> |
|
|
191 |
<h4>More Profiler Resources:</h4> |
|
|
192 |
</div> |
|
|
193 |
<div class="bd"> |
|
|
194 |
<ul> |
|
|
195 |
<!-- <li><a href="http://developer.yahoo.com/yui/profiler/">User's Guide</a> (external)</li> --> |
|
|
196 |
<li><a href="../../api/module_profiler.html">API Documentation</a></li> |
|
|
197 |
</ul> |
|
|
198 |
</div> |
|
|
199 |
</div> |
|
|
200 |
</div> |
|
|
201 |
</div> |
|
|
202 |
|
|
|
203 |
</div> |
|
|
204 |
</div> |
|
|
205 |
|
|
|
206 |
|
|
|
207 |
<div class="yui-b toc3" id="tocWrapper"> |
|
|
208 |
<!-- TABLE OF CONTENTS --> |
|
|
209 |
<div id="toc"> |
|
|
210 |
|
|
|
211 |
<ul> |
|
|
212 |
<li class="sect first">YUI 3.x Project</li><li class="item"><a title="The Yahoo! User Interface (YUI) Library, 3.x Branch, " href="http://developer.yahoo.com/yui/3/">YUI 3 Web Site (external)</a></li><li class="item"><a title="Examples of every YUI utility and control in action" href="../../examples/">YUI 3 Examples</a></li><li class="item"><a title="Instantly searchable API documentation for the entire YUI library." href="../../api/">YUI 3 API Docs</a></li><li class="item"><a title="The YUI Library can be downloaded from SourceForge" href="http://sourceforge.net/projects/yui/">YUI 3 on Sourceforge (external)</a></li><li class="item"><a title="YUI is free and open, offered under a BSD license." href="http://developer.yahoo.com/yui/3/license.html">YUI License (external)</a></li><li class="sect">YUI 3 Core - Examples</li><li class="item"><a title="YUI (Global Prerequisite) - Functional Examples" href="../../examples/yui/index.html">YUI (Global Prerequisite)</a></li><li class="item"><a title="Event - Functional Examples" href="../../examples/event/index.html">Event</a></li><li class="item"><a title="Node - Functional Examples" href="../../examples/node/index.html">Node</a></li><li class="sect">YUI 3 Component Infrastructure - Examples</li><li class="item"><a title="Attribute - Functional Examples" href="../../examples/attribute/index.html">Attribute</a></li><li class="item"><a title="Plugin - Functional Examples" href="../../examples/plugin/index.html">Plugin</a></li><li class="item"><a title="Widget - Functional Examples" href="../../examples/widget/index.html">Widget</a></li><li class="sect">YUI 3 Utilities - Examples</li><li class="item"><a title="Animation - Functional Examples" href="../../examples/anim/index.html">Animation</a></li><li class="item"><a title="Cache - Functional Examples" href="../../examples/cache/index.html">Cache</a></li><li class="item"><a title="Cookie - Functional Examples" href="../../examples/cookie/index.html">Cookie</a></li><li class="item"><a title="DataSchema - Functional Examples" href="../../examples/dataschema/index.html">DataSchema</a></li><li class="item"><a title="DataSource - Functional Examples" href="../../examples/datasource/index.html">DataSource</a></li><li class="item"><a title="DataType - Functional Examples" href="../../examples/datatype/index.html">DataType</a></li><li class="item"><a title="Drag & Drop - Functional Examples" href="../../examples/dd/index.html">Drag & Drop</a></li><li class="item"><a title="Get - Functional Examples" href="../../examples/get/index.html">Get</a></li><li class="item"><a title="History - Functional Examples" href="../../examples/history/index.html">History</a></li><li class="item"><a title="ImageLoader - Functional Examples" href="../../examples/imageloader/index.html">ImageLoader</a></li><li class="item"><a title="IO - Functional Examples" href="../../examples/io/index.html">IO</a></li><li class="item"><a title="JSON (JavaScript Object Notation) - Functional Examples" href="../../examples/json/index.html">JSON</a></li><li class="item"><a title="Queue - Functional Examples" href="../../examples/queue/index.html">Queue</a></li><li class="item"><a title="Stylesheet - Functional Examples" href="../../examples/stylesheet/index.html">Stylesheet</a></li><li class="sect">YUI 3 Widgets - Examples</li><li class="item"><a title="Overlay - Functional Examples" href="../../examples/overlay/index.html">Overlay</a></li><li class="item"><a title="Slider - Functional Examples" href="../../examples/slider/index.html">Slider</a></li><li class="sect">YUI 3 Node Plugins - Examples</li><li class="item"><a title="FocusManager Node Plugin - Functional Examples" href="../../examples/node-focusmanager/index.html">FocusManager Node Plugin</a></li><li class="item"><a title="MenuNav Node Plugin - Functional Examples" href="../../examples/node-menunav/index.html">MenuNav Node Plugin</a></li><li class="sect">YUI 3 CSS - Examples</li><li class="item"><a title="YUI CSS Reset - Functional Examples" href="../../examples/cssreset/index.html">CSS Reset</a></li><li class="item"><a title="YUI Fonts - Functional Examples" href="../../examples/cssfonts/index.html">CSS Fonts</a></li><li class="item"><a title="YUI Base - Functional Examples" href="../../examples/cssbase/index.html">CSS Base</a></li><li class="sect">YUI 3 Developer Tools - Examples</li><li class="item"><a title="Console - Functional Examples" href="../../examples/console/index.html">Console</a></li><li class="selected "><a title="Profiler - Functional Examples" href="../../examples/profiler/index.html">Profiler</a></li><li class="item"><a title="Test - Functional Examples" href="../../examples/test/index.html">Test</a></li><li class="sect">The YUI Community</li><li class="item"><a title="The Yahoo! User Interface Blog" href="http://yuiblog.com">YUI Blog (external)</a></li><li class="item"><a title="The Yahoo! Group YDN-JavaScript hosts the YUI community forum" href="http://tech.groups.yahoo.com/group/ydn-javascript/">YUI Forum (external)</a></li><li class="item"><a title="The Yahoo! Group yui3 is dedicated to the 3.x branch of the Yahoo! User Interface (YUI) Library." href="http://tech.groups.yahoo.com/group/yui3/">YUI 3 Forum (external)</a></li><li class="item"><a title="YUI is used by Yahoo! and by hundreds of other sites, including many you know and love." href="/yui/poweredby/">YUI Sightings (external)</a></li><li class="item"><a title="Videos and podcasts from the YUI Team and from the Yahoo! frontend engineering community." href="http://developer.yahoo.com/yui/theater/">YUI Theater (external)</a></li><li class="sect">YUI Articles on the YUI Website</li><li class="item"><a title="Answers to Frequently Asked Questions about the YUI Library" href="http://developer.yahoo.com/yui/articles/faq/">YUI FAQ (external)</a></li><li class="item"><a title="Yahoo!'s philosophy of Graded Browser Support" href="http://developer.yahoo.com/yui/articles/gbs/">Graded Browser Support (external)</a></li><li class="item"><a title="Reporting Bugs and Making Feature Requests for YUI Components" href="http://developer.yahoo.com/yui/articles/reportingbugs/">Bug Reports/Feature Requests (external)</a></li><li class="item"><a title="Serve YUI source files from Yahoo! -- free, fast, and simple" href="http://developer.yahoo.com/yui/3/articles/hosting/">Serving YUI Files from Yahoo! (external)</a></li></ul> |
|
|
213 |
</div> |
|
|
214 |
</div> |
|
|
215 |
</div><!--closes bd--> |
|
|
216 |
|
|
|
217 |
<div id="ft"> |
|
|
218 |
<p class="first">Copyright © 2009 Yahoo! Inc. All rights reserved.</p> |
|
|
219 |
<p><a href="http://privacy.yahoo.com/privacy/us/devel/index.html">Privacy Policy</a> - |
|
|
220 |
<a href="http://docs.yahoo.com/info/terms/">Terms of Service</a> - |
|
|
221 |
<a href="http://docs.yahoo.com/info/copyright/copyright.html">Copyright Policy</a> - |
|
|
222 |
<a href="http://careers.yahoo.com/">Job Openings</a></p> |
|
|
223 |
</div> |
|
|
224 |
</div> |
|
|
225 |
<script src="../../assets/dpSyntaxHighlighter.js"></script> |
|
|
226 |
<script language="javascript"> |
|
|
227 |
dp.SyntaxHighlighter.HighlightAll('code'); |
|
|
228 |
</script> |
|
|
229 |
</body> |
|
|
230 |
</html> |