diff options
| author | Eduardo Pedroni <ep625@york.ac.uk> | 2014-05-06 14:29:37 +0100 |
|---|---|---|
| committer | Eduardo Pedroni <ep625@york.ac.uk> | 2014-05-06 14:29:37 +0100 |
| commit | 8189116ea4b5db4675e31dfd04a5687d55e29262 (patch) | |
| tree | c1815021452a888f8838f1628d8fb4689777e73e /doc/jcgp/backend/modules/problem/TravellingSalesmanProblem.html | |
| parent | aa9e74e7f67789f6353fc26e02ee8e68e40609a2 (diff) | |
Added javadocs, made minor changes to the comments
Diffstat (limited to 'doc/jcgp/backend/modules/problem/TravellingSalesmanProblem.html')
| -rw-r--r-- | doc/jcgp/backend/modules/problem/TravellingSalesmanProblem.html | 433 |
1 files changed, 433 insertions, 0 deletions
diff --git a/doc/jcgp/backend/modules/problem/TravellingSalesmanProblem.html b/doc/jcgp/backend/modules/problem/TravellingSalesmanProblem.html new file mode 100644 index 0000000..4a2d0c9 --- /dev/null +++ b/doc/jcgp/backend/modules/problem/TravellingSalesmanProblem.html @@ -0,0 +1,433 @@ +<!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 Sat May 03 18:23:22 BST 2014 --> +<title>TravellingSalesmanProblem</title> +<meta name="date" content="2014-05-03"> +<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="TravellingSalesmanProblem"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":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/TravellingSalesmanProblem.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/modules/problem/TestCaseProblem.TestCase.html" title="class in jcgp.backend.modules.problem"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?jcgp/backend/modules/problem/TravellingSalesmanProblem.html" target="_top">Frames</a></li> +<li><a href="TravellingSalesmanProblem.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.modules.problem</div> +<h2 title="Class TravellingSalesmanProblem" class="title">Class TravellingSalesmanProblem</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../jcgp/backend/modules/Module.html" title="class in jcgp.backend.modules">jcgp.backend.modules.Module</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../jcgp/backend/modules/problem/Problem.html" title="class in jcgp.backend.modules.problem">jcgp.backend.modules.problem.Problem</a></li> +<li> +<ul class="inheritance"> +<li>jcgp.backend.modules.problem.TravellingSalesmanProblem</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">TravellingSalesmanProblem</span> +extends <a href="../../../../jcgp/backend/modules/problem/Problem.html" title="class in jcgp.backend.modules.problem">Problem</a></pre> +<div class="block">Travelling salesman problem + <br><br> + Using this problem type, travelling salesman tours can be evolved. + <code>parseData()</code> must be used to load the desired city + coordinates in the standard .tsp format.</div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>Eduardo Pedroni</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../jcgp/backend/function/TravellingSalesmanFunctions.html" title="class in jcgp.backend.function"><code>TravellingSalesmanFunctions</code></a></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/modules/problem/TravellingSalesmanProblem.html#TravellingSalesmanProblem-jcgp.backend.resources.Resources-">TravellingSalesmanProblem</a></span>(<a href="../../../../jcgp/backend/resources/Resources.html" title="class in jcgp.backend.resources">Resources</a> resources)</code> +<div class="block">Construct a new instance of TravellingSalesmanProblem.</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>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/modules/problem/TravellingSalesmanProblem.html#evaluate-jcgp.backend.population.Population-jcgp.backend.resources.Resources-">evaluate</a></span>(<a href="../../../../jcgp/backend/population/Population.html" title="class in jcgp.backend.population">Population</a> population, + <a href="../../../../jcgp/backend/resources/Resources.html" title="class in jcgp.backend.resources">Resources</a> resources)</code> +<div class="block">The most important method of the problem type.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/modules/problem/TravellingSalesmanProblem.html#isImprovement-jcgp.backend.population.Chromosome-">isImprovement</a></span>(<a href="../../../../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Chromosome</a> fittest)</code> +<div class="block">Used to assert whether a given chromosome is an improvement over + the current best chromosome.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/modules/problem/TravellingSalesmanProblem.html#isPerfectSolution-jcgp.backend.population.Chromosome-">isPerfectSolution</a></span>(<a href="../../../../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Chromosome</a> fittest)</code> +<div class="block">Used to assert whether a given chromosome is a perfect solution + to the problem.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/modules/problem/TravellingSalesmanProblem.html#parseProblemData-java.io.File-jcgp.backend.resources.ModifiableResources-">parseProblemData</a></span>(java.io.File file, + <a href="../../../../jcgp/backend/resources/ModifiableResources.html" title="class in jcgp.backend.resources">ModifiableResources</a> resources)</code> +<div class="block">Parses the specified file and uses the parsed data to + set up the problem type instance appropriately.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.jcgp.backend.modules.problem.Problem"> +<!-- --> +</a> +<h3>Methods inherited from class jcgp.backend.modules.problem.<a href="../../../../jcgp/backend/modules/problem/Problem.html" title="class in jcgp.backend.modules.problem">Problem</a></h3> +<code><a href="../../../../jcgp/backend/modules/problem/Problem.html#getBestFitness--">getBestFitness</a>, <a href="../../../../jcgp/backend/modules/problem/Problem.html#getFileExtension--">getFileExtension</a>, <a href="../../../../jcgp/backend/modules/problem/Problem.html#getFunctionSet--">getFunctionSet</a>, <a href="../../../../jcgp/backend/modules/problem/Problem.html#reset--">reset</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.jcgp.backend.modules.Module"> +<!-- --> +</a> +<h3>Methods inherited from class jcgp.backend.modules.<a href="../../../../jcgp/backend/modules/Module.html" title="class in jcgp.backend.modules">Module</a></h3> +<code><a href="../../../../jcgp/backend/modules/Module.html#getLocalParameters--">getLocalParameters</a>, <a href="../../../../jcgp/backend/modules/Module.html#toString--">toString</a></code></li> +</ul> +<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, 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="TravellingSalesmanProblem-jcgp.backend.resources.Resources-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>TravellingSalesmanProblem</h4> +<pre>public TravellingSalesmanProblem(<a href="../../../../jcgp/backend/resources/Resources.html" title="class in jcgp.backend.resources">Resources</a> resources)</pre> +<div class="block">Construct a new instance of TravellingSalesmanProblem.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>resources</code> - a reference to the experiment's resources.</dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="evaluate-jcgp.backend.population.Population-jcgp.backend.resources.Resources-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>evaluate</h4> +<pre>public void evaluate(<a href="../../../../jcgp/backend/population/Population.html" title="class in jcgp.backend.population">Population</a> population, + <a href="../../../../jcgp/backend/resources/Resources.html" title="class in jcgp.backend.resources">Resources</a> resources)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../jcgp/backend/modules/problem/Problem.html#evaluate-jcgp.backend.population.Population-jcgp.backend.resources.Resources-">Problem</a></code></span></div> +<div class="block">The most important method of the problem type. This is called once + per generation, when the new population has been generated. + <br><br> + The basic functionality of this method is to loop through all chromosomes + in the population and decode them according to the problem type. The + fitness of each chromosome is then calculated using the problem data + or otherwise (subjective problem types such as art generation might + leave fitness evaluations up to the user) and assigned to the appropriate + chromosome. + <br><br> + In addition, realisations of this method should update the value of + bestFitness as appropriate, since the value of this parameter is displayed + if a GUI is in use.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../jcgp/backend/modules/problem/Problem.html#evaluate-jcgp.backend.population.Population-jcgp.backend.resources.Resources-">evaluate</a></code> in class <code><a href="../../../../jcgp/backend/modules/problem/Problem.html" title="class in jcgp.backend.modules.problem">Problem</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>population</code> - the population to be evaluated.</dd> +<dd><code>resources</code> - parameters and utilities for optional reference.</dd> +</dl> +</li> +</ul> +<a name="isPerfectSolution-jcgp.backend.population.Chromosome-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isPerfectSolution</h4> +<pre>public boolean isPerfectSolution(<a href="../../../../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Chromosome</a> fittest)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../jcgp/backend/modules/problem/Problem.html#isPerfectSolution-jcgp.backend.population.Chromosome-">Problem</a></code></span></div> +<div class="block">Used to assert whether a given chromosome is a perfect solution + to the problem. It is up to the problem to define what qualifies + a perfect solution, as some problems (subject ones such as music and + art evolution, for example) might not have perfect solutions at all. + <br><br> + Note that if this method returns true, the experiment will move on + to the next run, or finish if no more runs are left.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../jcgp/backend/modules/problem/Problem.html#isPerfectSolution-jcgp.backend.population.Chromosome-">isPerfectSolution</a></code> in class <code><a href="../../../../jcgp/backend/modules/problem/Problem.html" title="class in jcgp.backend.modules.problem">Problem</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>fittest</code> - the potentially perfect chromosome.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if the argument is a perfect solution.</dd> +</dl> +</li> +</ul> +<a name="parseProblemData-java.io.File-jcgp.backend.resources.ModifiableResources-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>parseProblemData</h4> +<pre>public void parseProblemData(java.io.File file, + <a href="../../../../jcgp/backend/resources/ModifiableResources.html" title="class in jcgp.backend.resources">ModifiableResources</a> resources)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../jcgp/backend/modules/problem/Problem.html#parseProblemData-java.io.File-jcgp.backend.resources.ModifiableResources-">Problem</a></code></span></div> +<div class="block">Parses the specified file and uses the parsed data to + set up the problem type instance appropriately. Any necessary + resource changes can be performed using the provided <code>ModifiableResources</code> + instance. + <br><br> + In addition, realisations of this method should update the value of + maxFitness where appropriate, as this may be displayed to the user + if a GUI is in use.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../jcgp/backend/modules/problem/Problem.html#parseProblemData-java.io.File-jcgp.backend.resources.ModifiableResources-">parseProblemData</a></code> in class <code><a href="../../../../jcgp/backend/modules/problem/Problem.html" title="class in jcgp.backend.modules.problem">Problem</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>file</code> - the data file to parse.</dd> +<dd><code>resources</code> - a modifiable reference to the experiment's resources.</dd> +</dl> +</li> +</ul> +<a name="isImprovement-jcgp.backend.population.Chromosome-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>isImprovement</h4> +<pre>public boolean isImprovement(<a href="../../../../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Chromosome</a> fittest)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../jcgp/backend/modules/problem/Problem.html#isImprovement-jcgp.backend.population.Chromosome-">Problem</a></code></span></div> +<div class="block">Used to assert whether a given chromosome is an improvement over + the current best chromosome. A typical implementation of this method + will simply compare chromosome fitness values, though the problem type + is free to implement this in any way.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../jcgp/backend/modules/problem/Problem.html#isImprovement-jcgp.backend.population.Chromosome-">isImprovement</a></code> in class <code><a href="../../../../jcgp/backend/modules/problem/Problem.html" title="class in jcgp.backend.modules.problem">Problem</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>fittest</code> - the potentially fitter chromosome.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if the argument is fitter than the currently fittest chromosome.</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/TravellingSalesmanProblem.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/modules/problem/TestCaseProblem.TestCase.html" title="class in jcgp.backend.modules.problem"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?jcgp/backend/modules/problem/TravellingSalesmanProblem.html" target="_top">Frames</a></li> +<li><a href="TravellingSalesmanProblem.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> |