diff options
| author | Eduardo Pedroni <e.pedroni91@gmail.com> | 2014-10-18 15:21:45 +0200 |
|---|---|---|
| committer | Eduardo Pedroni <e.pedroni91@gmail.com> | 2014-10-18 15:21:45 +0200 |
| commit | 4f26361eb08aa09334d1eea0a124110c20d809ce (patch) | |
| tree | ea2652193f376eee5c9c44776895378b123be7c8 /doc/jcgp/backend/statistics/StatisticsLogger.html | |
| parent | fc0f9ce2aa46444ff69e89e9b9e09f3610eedd74 (diff) | |
Moved javadocs to a different repository for hosting, updated README
Diffstat (limited to 'doc/jcgp/backend/statistics/StatisticsLogger.html')
| -rw-r--r-- | doc/jcgp/backend/statistics/StatisticsLogger.html | 562 |
1 files changed, 0 insertions, 562 deletions
diff --git a/doc/jcgp/backend/statistics/StatisticsLogger.html b/doc/jcgp/backend/statistics/StatisticsLogger.html deleted file mode 100644 index e6fc8a9..0000000 --- a/doc/jcgp/backend/statistics/StatisticsLogger.html +++ /dev/null @@ -1,562 +0,0 @@ -<!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 Thu May 22 06:02:33 BST 2014 --> -<title>StatisticsLogger</title> -<meta name="date" content="2014-05-22"> -<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> |