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/modules/problem/Problem.html | |
| parent | fc0f9ce2aa46444ff69e89e9b9e09f3610eedd74 (diff) | |
Moved javadocs to a different repository for hosting, updated README
Diffstat (limited to 'doc/jcgp/backend/modules/problem/Problem.html')
| -rw-r--r-- | doc/jcgp/backend/modules/problem/Problem.html | 464 |
1 files changed, 0 insertions, 464 deletions
diff --git a/doc/jcgp/backend/modules/problem/Problem.html b/doc/jcgp/backend/modules/problem/Problem.html deleted file mode 100644 index d0e848d..0000000 --- a/doc/jcgp/backend/modules/problem/Problem.html +++ /dev/null @@ -1,464 +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>Problem</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="Problem"; - } - } - catch(err) { - } -//--> -var methods = {"i0":6,"i1":10,"i2":10,"i3":10,"i4":10,"i5":6,"i6":6,"i7":6,"i8":10}; -var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/Problem.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/DigitalCircuitProblem.html" title="class in jcgp.backend.modules.problem"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../jcgp/backend/modules/problem/SymbolicRegressionProblem.html" title="class in jcgp.backend.modules.problem"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?jcgp/backend/modules/problem/Problem.html" target="_top">Frames</a></li> -<li><a href="Problem.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>Constr | </li> -<li><a href="#method.summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li>Constr | </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 Problem" class="title">Class Problem</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>jcgp.backend.modules.problem.Problem</li> -</ul> -</li> -</ul> -</li> -</ul> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<dl> -<dt>Direct Known Subclasses:</dt> -<dd><a href="../../../../jcgp/backend/modules/problem/TestCaseProblem.html" title="class in jcgp.backend.modules.problem">TestCaseProblem</a></dd> -</dl> -<hr> -<br> -<pre>public abstract class <span class="typeNameLabel">Problem</span> -extends <a href="../../../../jcgp/backend/modules/Module.html" title="class in jcgp.backend.modules">Module</a></pre> -<div class="block">Defines the general behaviour of a CGP problem. The primary function of <code>Problem</code> - is to evaluate a population and assign a fitness value to each chromosome. - <br> - Problems are free to define whether better fitness means a higher or lower fitness value. - In some problem types, it is more convenient to treat fitness 0 as the best possible value. - This can be done by changing the fitness orientation to <code>BestFitness.HIGH</code> or <code>BestFitness.LOW</code> as appropriate. - Fitness orientation is set to high by default. - <br><br> - When extending this class, the constructor should call a few methods in order to - properly construct the problem type: <code>setFunctionSet()</code>, <code>setFileExtension()</code> and <code>setFitnessOrientation()</code>, - with the respective arguments. As with all subclasses of <code>Module</code>, <code>setName()</code> and - <code>registerParameters()</code> should be used where appropriate as well. - <br><br> - It is advisable to use <code>Resources.reportln()</code> and <code>Resources.report()</code> - to print any relevant information. Note that reportln() and report() are affected - by the report interval base parameter. Use <code>Resources.println()</code> and - <code>Resources.print()</code> to print information regardless of the current generation. - See <a href="../../../../jcgp/backend/resources/Resources.html" title="class in jcgp.backend.resources"><code>Resources</code></a> for more information.</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/modules/Module.html" title="class in jcgp.backend.modules"><code>Module</code></a></dd> -</dl> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> -<!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>abstract void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/modules/problem/Problem.html#evaluate-jcgp.backend.population.Population-">evaluate</a></span>(<a href="../../../../jcgp/backend/population/Population.html" title="class in jcgp.backend.population">Population</a> population)</code> -<div class="block">The most important method of the problem type.</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/modules/problem/Problem.html#getBestFitness--">getBestFitness</a></span>()</code> </td> -</tr> -<tr id="i2" class="altColor"> -<td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/modules/problem/Problem.html#getFileExtension--">getFileExtension</a></span>()</code> </td> -</tr> -<tr id="i3" class="rowColor"> -<td class="colFirst"><code><a href="../../../../jcgp/backend/modules/problem/BestFitness.html" title="enum in jcgp.backend.modules.problem">BestFitness</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/modules/problem/Problem.html#getFitnessOrientation--">getFitnessOrientation</a></span>()</code> </td> -</tr> -<tr id="i4" class="altColor"> -<td class="colFirst"><code><a href="../../../../jcgp/backend/function/FunctionSet.html" title="class in jcgp.backend.function">FunctionSet</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/modules/problem/Problem.html#getFunctionSet--">getFunctionSet</a></span>()</code> </td> -</tr> -<tr id="i5" class="rowColor"> -<td class="colFirst"><code>abstract int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/modules/problem/Problem.html#hasImprovement-jcgp.backend.population.Population-">hasImprovement</a></span>(<a href="../../../../jcgp/backend/population/Population.html" title="class in jcgp.backend.population">Population</a> population)</code> -<div class="block">Used to assert whether a given population has a chromosome that is an improvement over - the current best chromosome.</div> -</td> -</tr> -<tr id="i6" class="altColor"> -<td class="colFirst"><code>abstract int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/modules/problem/Problem.html#hasPerfectSolution-jcgp.backend.population.Population-">hasPerfectSolution</a></span>(<a href="../../../../jcgp/backend/population/Population.html" title="class in jcgp.backend.population">Population</a> population)</code> -<div class="block">Used to assert whether a given population contains a perfect solution - to the problem.</div> -</td> -</tr> -<tr id="i7" class="rowColor"> -<td class="colFirst"><code>abstract void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/modules/problem/Problem.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> -<tr id="i8" class="altColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/modules/problem/Problem.html#reset--">reset</a></span>()</code> -<div class="block">Resets the bestFitness parameter.</div> -</td> -</tr> -</table> -<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"> -<!-- ============ METHOD DETAIL ========== --> -<ul class="blockList"> -<li class="blockList"><a name="method.detail"> -<!-- --> -</a> -<h3>Method Detail</h3> -<a name="evaluate-jcgp.backend.population.Population-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>evaluate</h4> -<pre>public abstract void evaluate(<a href="../../../../jcgp/backend/population/Population.html" title="class in jcgp.backend.population">Population</a> population)</pre> -<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="paramLabel">Parameters:</span></dt> -<dd><code>population</code> - the population to be evaluated.</dd> -</dl> -</li> -</ul> -<a name="hasPerfectSolution-jcgp.backend.population.Population-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>hasPerfectSolution</h4> -<pre>public abstract int hasPerfectSolution(<a href="../../../../jcgp/backend/population/Population.html" title="class in jcgp.backend.population">Population</a> population)</pre> -<div class="block">Used to assert whether a given population contains 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.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>population</code> - the population to search through for a perfect chromosome.</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the perfect solution index, if one exits, -1 if no perfect solution was found.</dd> -</dl> -</li> -</ul> -<a name="hasImprovement-jcgp.backend.population.Population-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>hasImprovement</h4> -<pre>public abstract int hasImprovement(<a href="../../../../jcgp/backend/population/Population.html" title="class in jcgp.backend.population">Population</a> population)</pre> -<div class="block">Used to assert whether a given population has a chromosome that 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="paramLabel">Parameters:</span></dt> -<dd><code>population</code> - the population potentially containing a fitter chromosome.</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the index of the first chromosome in the population that is an improvement, -1 if none is found.</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 abstract 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">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="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="getFunctionSet--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getFunctionSet</h4> -<pre>public <a href="../../../../jcgp/backend/function/FunctionSet.html" title="class in jcgp.backend.function">FunctionSet</a> getFunctionSet()</pre> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the FunctionSet object used by this problem type.</dd> -</dl> -</li> -</ul> -<a name="getFileExtension--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getFileExtension</h4> -<pre>public java.lang.String getFileExtension()</pre> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the file extension accepted by this problem type for problem data files.</dd> -</dl> -</li> -</ul> -<a name="getFitnessOrientation--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getFitnessOrientation</h4> -<pre>public <a href="../../../../jcgp/backend/modules/problem/BestFitness.html" title="enum in jcgp.backend.modules.problem">BestFitness</a> getFitnessOrientation()</pre> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the fitness orientation of this particular problem.</dd> -</dl> -</li> -</ul> -<a name="getBestFitness--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getBestFitness</h4> -<pre>public double getBestFitness()</pre> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the current best fitness, in other words, the fitness - value of the fittest chromosome in the current generation.</dd> -</dl> -</li> -</ul> -<a name="reset--"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>reset</h4> -<pre>public void reset()</pre> -<div class="block">Resets the bestFitness parameter.</div> -</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/Problem.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/DigitalCircuitProblem.html" title="class in jcgp.backend.modules.problem"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../jcgp/backend/modules/problem/SymbolicRegressionProblem.html" title="class in jcgp.backend.modules.problem"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../index.html?jcgp/backend/modules/problem/Problem.html" target="_top">Frames</a></li> -<li><a href="Problem.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>Constr | </li> -<li><a href="#method.summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li>Constr | </li> -<li><a href="#method.detail">Method</a></li> -</ul> -</div> -<a name="skip.navbar.bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -</body> -</html> |