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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_05) on Tue May 06 14:28:07 BST 2014 -->
<title>StatisticsLogger</title>
<meta name="date" content="2014-05-06">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="StatisticsLogger";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/StatisticsLogger.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../jcgp/backend/statistics/RunEntry.html" title="class in jcgp.backend.statistics"><span class="typeNameLink">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?jcgp/backend/statistics/StatisticsLogger.html" target="_top">Frames</a></li>
<li><a href="StatisticsLogger.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">jcgp.backend.statistics</div>
<h2 title="Class StatisticsLogger" class="title">Class StatisticsLogger</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>jcgp.backend.statistics.StatisticsLogger</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">StatisticsLogger</span>
extends java.lang.Object</pre>
<div class="block">This is a utility class for logging experiment statistics when doing multiple runs.
<br><br>
Information about each run is added via the <code>logRun()</code> method. The many getters
can be used to obtain statistics about the logged runs, such as success rate and average
fitness.
<br><br>
<code>JCGP</code> uses this class to perform its logging and print out experiment data at the end.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Eduardo Pedroni</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../jcgp/backend/statistics/StatisticsLogger.html#StatisticsLogger--">StatisticsLogger</a></span>()</code>
<div class="block">Create a new statistics logger, use this when resetting is necessary.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/statistics/StatisticsLogger.html#getAverageActiveNodes--">getAverageActiveNodes</a></span>()</code>
<div class="block">Averages the number of active nodes in the
best chromosomes obtained across all runs.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/statistics/StatisticsLogger.html#getAverageActiveNodesStdDev--">getAverageActiveNodesStdDev</a></span>()</code>
<div class="block">Calculates the standard deviation of
the number of active nodes in the best solution
in each run.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/statistics/StatisticsLogger.html#getAverageFitness--">getAverageFitness</a></span>()</code>
<div class="block">Averages the best fitness obtained in each run.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/statistics/StatisticsLogger.html#getAverageFitnessStdDev--">getAverageFitnessStdDev</a></span>()</code>
<div class="block">Calculates the standard deviation of
the best fitness obtained in each run.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/statistics/StatisticsLogger.html#getAverageGenerations--">getAverageGenerations</a></span>()</code>
<div class="block">Calculates the average generation out of all runs.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/statistics/StatisticsLogger.html#getAverageGenerationsStdDev--">getAverageGenerationsStdDev</a></span>()</code>
<div class="block">Calculates the standard deviation of
the average number of generations in
each run.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/statistics/StatisticsLogger.html#getAverageSuccessfulGenerations--">getAverageSuccessfulGenerations</a></span>()</code>
<div class="block">Calculates the average generation out of successful runs only.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/statistics/StatisticsLogger.html#getAverageSuccessfulGenerationsStdDev--">getAverageSuccessfulGenerationsStdDev</a></span>()</code>
<div class="block">Calculates the standard deviation of
the average number of generations in
each run where a perfect solution was found.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/statistics/StatisticsLogger.html#getHighestFitness--">getHighestFitness</a></span>()</code> </td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/statistics/StatisticsLogger.html#getLowestFitness--">getLowestFitness</a></span>()</code> </td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/statistics/StatisticsLogger.html#getSuccessfulRuns--">getSuccessfulRuns</a></span>()</code> </td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/statistics/StatisticsLogger.html#getSuccessRate--">getSuccessRate</a></span>()</code>
<div class="block">Calculates the ratio of successful runs (runs where
a perfect solution was found) to total number of runs.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/statistics/StatisticsLogger.html#logRun-int-double-int-boolean-">logRun</a></span>(int generation,
double fitness,
int active,
boolean successful)</code>
<div class="block">Log a new run.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="StatisticsLogger--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>StatisticsLogger</h4>
<pre>public StatisticsLogger()</pre>
<div class="block">Create a new statistics logger, use this when resetting is necessary.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="logRun-int-double-int-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>logRun</h4>
<pre>public void logRun(int generation,
double fitness,
int active,
boolean successful)</pre>
<div class="block">Log a new run. Calling any of the statistics getters will
now take this logged run into account as well as all previously
logged runs.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>generation</code> - the last generation when improvement occurred.</dd>
<dd><code>fitness</code> - the best fitness achieved in the run.</dd>
<dd><code>active</code> - the number of active nodes in the best chromosome found.</dd>
<dd><code>successful</code> - true if a perfect solution was found, false if otherwise.</dd>
</dl>
</li>
</ul>
<a name="getAverageFitness--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAverageFitness</h4>
<pre>public double getAverageFitness()</pre>
<div class="block">Averages the best fitness obtained in each run.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the average fitness.</dd>
</dl>
</li>
</ul>
<a name="getAverageFitnessStdDev--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAverageFitnessStdDev</h4>
<pre>public double getAverageFitnessStdDev()</pre>
<div class="block">Calculates the standard deviation of
the best fitness obtained in each run.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the standard deviation of average fitnesses.</dd>
</dl>
</li>
</ul>
<a name="getAverageActiveNodes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAverageActiveNodes</h4>
<pre>public double getAverageActiveNodes()</pre>
<div class="block">Averages the number of active nodes in the
best chromosomes obtained across all runs.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the average number of active nodes.</dd>
</dl>
</li>
</ul>
<a name="getAverageActiveNodesStdDev--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAverageActiveNodesStdDev</h4>
<pre>public double getAverageActiveNodesStdDev()</pre>
<div class="block">Calculates the standard deviation of
the number of active nodes in the best solution
in each run.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the standard deviation of active node counts.</dd>
</dl>
</li>
</ul>
<a name="getAverageGenerations--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAverageGenerations</h4>
<pre>public double getAverageGenerations()</pre>
<div class="block">Calculates the average generation out of all runs.
The generation value in each run corresponds to the
last generation in which improvement happened.
<br><br>
Note that this method includes runs where no perfect
solution was found. For the average number of generations
for perfect solutions only, use <code>getAverageSuccessfulGenerations</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the average number of generations.</dd>
</dl>
</li>
</ul>
<a name="getAverageGenerationsStdDev--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAverageGenerationsStdDev</h4>
<pre>public double getAverageGenerationsStdDev()</pre>
<div class="block">Calculates the standard deviation of
the average number of generations in
each run.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the standard deviation of the number of generations.</dd>
</dl>
</li>
</ul>
<a name="getHighestFitness--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHighestFitness</h4>
<pre>public double getHighestFitness()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the highest fitness across all runs.</dd>
</dl>
</li>
</ul>
<a name="getLowestFitness--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLowestFitness</h4>
<pre>public double getLowestFitness()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the lowest fitness across all runs.</dd>
</dl>
</li>
</ul>
<a name="getSuccessfulRuns--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSuccessfulRuns</h4>
<pre>public int getSuccessfulRuns()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of runs in which a perfect solution was found.</dd>
</dl>
</li>
</ul>
<a name="getSuccessRate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSuccessRate</h4>
<pre>public double getSuccessRate()</pre>
<div class="block">Calculates the ratio of successful runs (runs where
a perfect solution was found) to total number of runs.
A double-precision value between 0 and 1 is returned,
where 0 means 0% success rate and 1 means 100% success rate.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the success rate across all runs.</dd>
</dl>
</li>
</ul>
<a name="getAverageSuccessfulGenerations--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAverageSuccessfulGenerations</h4>
<pre>public double getAverageSuccessfulGenerations()</pre>
<div class="block">Calculates the average generation out of successful runs only.
The generation value in each successful run corresponds to the
generation in which the perfect solution was found.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the average number of generations for perfect solutions.</dd>
</dl>
</li>
</ul>
<a name="getAverageSuccessfulGenerationsStdDev--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getAverageSuccessfulGenerationsStdDev</h4>
<pre>public double getAverageSuccessfulGenerationsStdDev()</pre>
<div class="block">Calculates the standard deviation of
the average number of generations in
each run where a perfect solution was found.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the standard deviation of the number of generations in successful runs.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/StatisticsLogger.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../jcgp/backend/statistics/RunEntry.html" title="class in jcgp.backend.statistics"><span class="typeNameLink">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?jcgp/backend/statistics/StatisticsLogger.html" target="_top">Frames</a></li>
<li><a href="StatisticsLogger.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|
