aboutsummaryrefslogtreecommitdiffstats
path: root/doc/jcgp/JCGP.html
diff options
context:
space:
mode:
authorEduardo Pedroni <ep625@york.ac.uk>2014-05-06 14:29:37 +0100
committerEduardo Pedroni <ep625@york.ac.uk>2014-05-06 14:29:37 +0100
commit8189116ea4b5db4675e31dfd04a5687d55e29262 (patch)
treec1815021452a888f8838f1628d8fb4689777e73e /doc/jcgp/JCGP.html
parentaa9e74e7f67789f6353fc26e02ee8e68e40609a2 (diff)
Added javadocs, made minor changes to the comments
Diffstat (limited to 'doc/jcgp/JCGP.html')
-rw-r--r--doc/jcgp/JCGP.html704
1 files changed, 704 insertions, 0 deletions
diff --git a/doc/jcgp/JCGP.html b/doc/jcgp/JCGP.html
new file mode 100644
index 0000000..9005792
--- /dev/null
+++ b/doc/jcgp/JCGP.html
@@ -0,0 +1,704 @@
+<!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>JCGP</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="JCGP";
+ }
+ }
+ 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":9,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10};
+var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/JCGP.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>Prev&nbsp;Class</li>
+<li>Next&nbsp;Class</li>
+</ul>
+<ul class="navList">
+<li><a href="../index.html?jcgp/JCGP.html" target="_top">Frames</a></li>
+<li><a href="JCGP.html" target="_top">No&nbsp;Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
+<li>Nested&nbsp;|&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail:&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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</div>
+<h2 title="Class JCGP" class="title">Class JCGP</h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li>java.lang.Object</li>
+<li>
+<ul class="inheritance">
+<li>jcgp.JCGP</li>
+</ul>
+</li>
+</ul>
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<hr>
+<br>
+<pre>public class <span class="typeNameLabel">JCGP</span>
+extends java.lang.Object</pre>
+<div class="block">Top-level JCGP class. This class is the entry point for a CGP experiment.
+ <br><br>
+ An instance of JCGP encapsulates the entire experiment. It contains a <code>Resources</code>
+ object which can be retrieved via a getter. Modules can be selected using their
+ respective setters.
+ <br><br>
+ The flow of the experiment is controlled using <code>start()</code>, <code>nextGeneration()</code>
+ and <code>reset()</code>. Files can be loaded with their respective load methods and
+ chromosome configurations can be saved with <code>saveChromosome()</code>.
+ <br><br>
+ JCGP supports an extra console in addition to <code>System.console()</code>, so that messages
+ can also be printed to a GUI, for example. This extra console can be set with <code>setConsole()</code>,
+ and must implement jcgp.resources.Console.</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">&nbsp;</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/JCGP.html#JCGP--">JCGP</a></span>()</code>
+<div class="block">Creates a new instance of JCGP.</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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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>java.util.ArrayList&lt;<a href="../jcgp/backend/modules/es/EvolutionaryStrategy.html" title="class in jcgp.backend.modules.es">EvolutionaryStrategy</a>&gt;</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../jcgp/JCGP.html#getEvolutionaryStrategies--">getEvolutionaryStrategies</a></span>()</code>&nbsp;</td>
+</tr>
+<tr id="i1" class="rowColor">
+<td class="colFirst"><code><a href="../jcgp/backend/modules/es/EvolutionaryStrategy.html" title="class in jcgp.backend.modules.es">EvolutionaryStrategy</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../jcgp/JCGP.html#getEvolutionaryStrategy--">getEvolutionaryStrategy</a></span>()</code>&nbsp;</td>
+</tr>
+<tr id="i2" class="altColor">
+<td class="colFirst"><code><a href="../jcgp/backend/modules/mutator/Mutator.html" title="class in jcgp.backend.modules.mutator">Mutator</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../jcgp/JCGP.html#getMutator--">getMutator</a></span>()</code>&nbsp;</td>
+</tr>
+<tr id="i3" class="rowColor">
+<td class="colFirst"><code>java.util.ArrayList&lt;<a href="../jcgp/backend/modules/mutator/Mutator.html" title="class in jcgp.backend.modules.mutator">Mutator</a>&gt;</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../jcgp/JCGP.html#getMutators--">getMutators</a></span>()</code>&nbsp;</td>
+</tr>
+<tr id="i4" class="altColor">
+<td class="colFirst"><code><a href="../jcgp/backend/population/Population.html" title="class in jcgp.backend.population">Population</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../jcgp/JCGP.html#getPopulation--">getPopulation</a></span>()</code>&nbsp;</td>
+</tr>
+<tr id="i5" class="rowColor">
+<td class="colFirst"><code><a href="../jcgp/backend/modules/problem/Problem.html" title="class in jcgp.backend.modules.problem">Problem</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../jcgp/JCGP.html#getProblem--">getProblem</a></span>()</code>&nbsp;</td>
+</tr>
+<tr id="i6" class="altColor">
+<td class="colFirst"><code>java.util.ArrayList&lt;<a href="../jcgp/backend/modules/problem/Problem.html" title="class in jcgp.backend.modules.problem">Problem</a>&gt;</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../jcgp/JCGP.html#getProblems--">getProblems</a></span>()</code>&nbsp;</td>
+</tr>
+<tr id="i7" class="rowColor">
+<td class="colFirst"><code><a href="../jcgp/backend/resources/ModifiableResources.html" title="class in jcgp.backend.resources">ModifiableResources</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../jcgp/JCGP.html#getResources--">getResources</a></span>()</code>
+<div class="block">Returns a reference to the <code>ModifiableResources</code> used by the
+ experiment.</div>
+</td>
+</tr>
+<tr id="i8" class="altColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../jcgp/JCGP.html#isFinished--">isFinished</a></span>()</code>
+<div class="block">Returns the experiment's status.</div>
+</td>
+</tr>
+<tr id="i9" class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../jcgp/JCGP.html#loadChromosome-java.io.File-int-">loadChromosome</a></span>(java.io.File&nbsp;file,
+ int&nbsp;chromosomeIndex)</code>
+<div class="block">Loads a chromosome from the given file into
+ the specified population index.</div>
+</td>
+</tr>
+<tr id="i10" class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../jcgp/JCGP.html#loadParameters-java.io.File-">loadParameters</a></span>(java.io.File&nbsp;file)</code>
+<div class="block">When given a .par file, this method loads the parameters into the
+ experiment's resources.</div>
+</td>
+</tr>
+<tr id="i11" class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../jcgp/JCGP.html#loadProblemData-java.io.File-">loadProblemData</a></span>(java.io.File&nbsp;file)</code>
+<div class="block">Parses a problem data file.</div>
+</td>
+</tr>
+<tr id="i12" class="altColor">
+<td class="colFirst"><code>static void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../jcgp/JCGP.html#main-java.lang.String...-">main</a></span>(java.lang.String...&nbsp;args)</code>
+<div class="block">JCGP main method, this is used to execute JCGP from the command line.</div>
+</td>
+</tr>
+<tr id="i13" class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../jcgp/JCGP.html#nextGeneration--">nextGeneration</a></span>()</code>
+<div class="block">Performs one full generational cycle.</div>
+</td>
+</tr>
+<tr id="i14" class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../jcgp/JCGP.html#reset--">reset</a></span>()</code>
+<div class="block">Resets the experiment.</div>
+</td>
+</tr>
+<tr id="i15" class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../jcgp/JCGP.html#saveChromosome-java.io.File-int-">saveChromosome</a></span>(java.io.File&nbsp;file,
+ int&nbsp;chromosomeIndex)</code>
+<div class="block">Saves a copy of the specified chromosome
+ into the given file.</div>
+</td>
+</tr>
+<tr id="i16" class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../jcgp/JCGP.html#setConsole-jcgp.backend.resources.Console-">setConsole</a></span>(<a href="../jcgp/backend/resources/Console.html" title="interface in jcgp.backend.resources">Console</a>&nbsp;console)</code>
+<div class="block">Sets an extra console.</div>
+</td>
+</tr>
+<tr id="i17" class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../jcgp/JCGP.html#setEvolutionaryStrategy-int-">setEvolutionaryStrategy</a></span>(int&nbsp;index)</code>&nbsp;</td>
+</tr>
+<tr id="i18" class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../jcgp/JCGP.html#setMutator-int-">setMutator</a></span>(int&nbsp;index)</code>&nbsp;</td>
+</tr>
+<tr id="i19" class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../jcgp/JCGP.html#setProblem-int-">setProblem</a></span>(int&nbsp;index)</code>&nbsp;</td>
+</tr>
+<tr id="i20" class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../jcgp/JCGP.html#start--">start</a></span>()</code>
+<div class="block">This method calls <code>nextGeneration()</code> in a loop
+ until the experiment is flagged as finished.</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&nbsp;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="JCGP--">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>JCGP</h4>
+<pre>public&nbsp;JCGP()</pre>
+<div class="block">Creates a new instance of JCGP.</div>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="main-java.lang.String...-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>main</h4>
+<pre>public static&nbsp;void&nbsp;main(java.lang.String...&nbsp;args)</pre>
+<div class="block">JCGP main method, this is used to execute JCGP from the command line.
+ <br><br>
+ In this case the program works in the same way as the classic CGP implementation,
+ requiring a .par file and an optional problem data file. As in the traditional CGP
+ implementation, the program must be compiled with the right problem type selected.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>args</code> - one or more files needed to perform the experiment.</dd>
+</dl>
+</li>
+</ul>
+<a name="getResources--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getResources</h4>
+<pre>public&nbsp;<a href="../jcgp/backend/resources/ModifiableResources.html" title="class in jcgp.backend.resources">ModifiableResources</a>&nbsp;getResources()</pre>
+<div class="block">Returns a reference to the <code>ModifiableResources</code> used by the
+ experiment. <br>
+ Use this with care, since changing experiment parameters may
+ have unintended effects if not done properly.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>a reference to the experiment's resources.</dd>
+</dl>
+</li>
+</ul>
+<a name="getPopulation--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getPopulation</h4>
+<pre>public&nbsp;<a href="../jcgp/backend/population/Population.html" title="class in jcgp.backend.population">Population</a>&nbsp;getPopulation()</pre>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>a reference to the experiment's population.</dd>
+</dl>
+</li>
+</ul>
+<a name="getMutators--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getMutators</h4>
+<pre>public&nbsp;java.util.ArrayList&lt;<a href="../jcgp/backend/modules/mutator/Mutator.html" title="class in jcgp.backend.modules.mutator">Mutator</a>&gt;&nbsp;getMutators()</pre>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>a complete list of the experiment's mutators.</dd>
+</dl>
+</li>
+</ul>
+<a name="getMutator--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getMutator</h4>
+<pre>public&nbsp;<a href="../jcgp/backend/modules/mutator/Mutator.html" title="class in jcgp.backend.modules.mutator">Mutator</a>&nbsp;getMutator()</pre>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the currently selected mutator.</dd>
+</dl>
+</li>
+</ul>
+<a name="getEvolutionaryStrategies--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getEvolutionaryStrategies</h4>
+<pre>public&nbsp;java.util.ArrayList&lt;<a href="../jcgp/backend/modules/es/EvolutionaryStrategy.html" title="class in jcgp.backend.modules.es">EvolutionaryStrategy</a>&gt;&nbsp;getEvolutionaryStrategies()</pre>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>a complete list of the experiment's evolutionary strategies.</dd>
+</dl>
+</li>
+</ul>
+<a name="getEvolutionaryStrategy--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getEvolutionaryStrategy</h4>
+<pre>public&nbsp;<a href="../jcgp/backend/modules/es/EvolutionaryStrategy.html" title="class in jcgp.backend.modules.es">EvolutionaryStrategy</a>&nbsp;getEvolutionaryStrategy()</pre>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the currently selected evolutionary strategy.</dd>
+</dl>
+</li>
+</ul>
+<a name="getProblems--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getProblems</h4>
+<pre>public&nbsp;java.util.ArrayList&lt;<a href="../jcgp/backend/modules/problem/Problem.html" title="class in jcgp.backend.modules.problem">Problem</a>&gt;&nbsp;getProblems()</pre>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>a complete list of the experiment's problem types.</dd>
+</dl>
+</li>
+</ul>
+<a name="getProblem--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getProblem</h4>
+<pre>public&nbsp;<a href="../jcgp/backend/modules/problem/Problem.html" title="class in jcgp.backend.modules.problem">Problem</a>&nbsp;getProblem()</pre>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the currently selected problem type.</dd>
+</dl>
+</li>
+</ul>
+<a name="setMutator-int-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setMutator</h4>
+<pre>public&nbsp;void&nbsp;setMutator(int&nbsp;index)</pre>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>index</code> - the index of the desired mutator.</dd>
+</dl>
+</li>
+</ul>
+<a name="setEvolutionaryStrategy-int-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setEvolutionaryStrategy</h4>
+<pre>public&nbsp;void&nbsp;setEvolutionaryStrategy(int&nbsp;index)</pre>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>index</code> - the index of the desired evolutionary strategy.</dd>
+</dl>
+</li>
+</ul>
+<a name="setProblem-int-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setProblem</h4>
+<pre>public&nbsp;void&nbsp;setProblem(int&nbsp;index)</pre>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>index</code> - the index of the desired problem type.</dd>
+</dl>
+</li>
+</ul>
+<a name="nextGeneration--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>nextGeneration</h4>
+<pre>public&nbsp;void&nbsp;nextGeneration()</pre>
+<div class="block">Performs one full generational cycle. More specifically,
+ this method evaluates the current population using the
+ selected problem, and checks whether a solution has been found.
+ <br>
+ If the experiment is to continue, a new generation is created
+ using the selected evolutionary strategy and mutator.
+ <br><br>
+ This method also deals with ending runs, in other words,
+ a new population is created at the end of each run automatically.
+ When all runs have been performed, this method sets the experiment
+ finished flag and does nothing until <code>reset()</code> is called.</div>
+</li>
+</ul>
+<a name="start--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>start</h4>
+<pre>public&nbsp;void&nbsp;start()</pre>
+<div class="block">This method calls <code>nextGeneration()</code> in a loop
+ until the experiment is flagged as finished. This is
+ performed on the same thread of execution, so this
+ method will most likely block for a significant amount
+ of time (problem-dependent, but anywhere from seconds to days).
+ <br>
+ Once the experiment is finished, calling this method does
+ nothing until <code>reset()</code> is called.</div>
+</li>
+</ul>
+<a name="reset--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>reset</h4>
+<pre>public&nbsp;void&nbsp;reset()</pre>
+<div class="block">Resets the experiment.
+ <br>
+ More specifically: this creates a new population, resets
+ the current generation and run parameters to 1 and prints
+ a complete list of the experiment's parameters.</div>
+</li>
+</ul>
+<a name="loadParameters-java.io.File-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>loadParameters</h4>
+<pre>public&nbsp;void&nbsp;loadParameters(java.io.File&nbsp;file)</pre>
+<div class="block">When given a .par file, this method loads the parameters into the
+ experiment's resources. This causes an experiment-wide reset.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>file</code> - the file to parse.</dd>
+</dl>
+</li>
+</ul>
+<a name="loadProblemData-java.io.File-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>loadProblemData</h4>
+<pre>public&nbsp;void&nbsp;loadProblemData(java.io.File&nbsp;file)</pre>
+<div class="block">Parses a problem data file. This is problem-dependent, not
+ all problems require a data file.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>file</code> - the file to parse.</dd>
+</dl>
+</li>
+</ul>
+<a name="loadChromosome-java.io.File-int-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>loadChromosome</h4>
+<pre>public&nbsp;void&nbsp;loadChromosome(java.io.File&nbsp;file,
+ int&nbsp;chromosomeIndex)</pre>
+<div class="block">Loads a chromosome from the given file into
+ the specified population index.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>file</code> - the chromosome to parse.</dd>
+<dd><code>chromosomeIndex</code> - the population index into which to parse.</dd>
+</dl>
+</li>
+</ul>
+<a name="saveChromosome-java.io.File-int-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>saveChromosome</h4>
+<pre>public&nbsp;void&nbsp;saveChromosome(java.io.File&nbsp;file,
+ int&nbsp;chromosomeIndex)</pre>
+<div class="block">Saves a copy of the specified chromosome
+ into the given file.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>file</code> - the target file.</dd>
+<dd><code>chromosomeIndex</code> - the index of the chromosome to save.</dd>
+</dl>
+</li>
+</ul>
+<a name="isFinished--">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>isFinished</h4>
+<pre>public&nbsp;boolean&nbsp;isFinished()</pre>
+<div class="block">Returns the experiment's status. When finished, the only
+ way to continue is by calling <code>reset()</code>.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>true if the experiment is finished.</dd>
+</dl>
+</li>
+</ul>
+<a name="setConsole-jcgp.backend.resources.Console-">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>setConsole</h4>
+<pre>public&nbsp;void&nbsp;setConsole(<a href="../jcgp/backend/resources/Console.html" title="interface in jcgp.backend.resources">Console</a>&nbsp;console)</pre>
+<div class="block">Sets an extra console. The entire JCGP library prints
+ messages to <code>System.console()</code> but also to an
+ additional console, if one is defined. This is used so
+ that messages are printed on a user interface as well,
+ or written directly to a file, for example.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>console</code> - the extra console to be used.</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/JCGP.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>Prev&nbsp;Class</li>
+<li>Next&nbsp;Class</li>
+</ul>
+<ul class="navList">
+<li><a href="../index.html?jcgp/JCGP.html" target="_top">Frames</a></li>
+<li><a href="JCGP.html" target="_top">No&nbsp;Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
+<li>Nested&nbsp;|&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail:&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a name="skip.navbar.bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>