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/population/Population.html | |
| parent | aa9e74e7f67789f6353fc26e02ee8e68e40609a2 (diff) | |
Added javadocs, made minor changes to the comments
Diffstat (limited to 'doc/jcgp/backend/population/Population.html')
| -rw-r--r-- | doc/jcgp/backend/population/Population.html | 411 |
1 files changed, 411 insertions, 0 deletions
diff --git a/doc/jcgp/backend/population/Population.html b/doc/jcgp/backend/population/Population.html new file mode 100644 index 0000000..b28fd28 --- /dev/null +++ b/doc/jcgp/backend/population/Population.html @@ -0,0 +1,411 @@ +<!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:06 BST 2014 --> +<title>Population</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="Population"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":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/Population.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/population/Output.html" title="class in jcgp.backend.population"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?jcgp/backend/population/Population.html" target="_top">Frames</a></li> +<li><a href="Population.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.population</div> +<h2 title="Class Population" class="title">Class Population</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>jcgp.backend.population.Population</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">Population</span> +extends java.lang.Object</pre> +<div class="block">This class primarily holds a collection of chromosomes. In addition, + it provides a few utility methods for manipulating and copying + chromosomes, useful for evolutionary strategies. + <br><br> + <code>copyChromosome()</code> is used to create copies of chromosomes, + though it is also possible to create a new instance of population + directly from a seed chromosome using the right constructor. + <br><br> + For convenience, a random chromosome can be retrieved using + <code>getRandomChromosome()</code>, which is guaranteed to use the + experiment's specified seed. If an entirely random population + is needed, <code>reinitialise()</code> should be used to randomise + all chromosomes without creating a new instance of <code>Population</code>.</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/population/Population.html#Population-jcgp.backend.population.Chromosome-jcgp.backend.resources.Resources-">Population</a></span>(<a href="../../../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Chromosome</a> parent, + <a href="../../../jcgp/backend/resources/Resources.html" title="class in jcgp.backend.resources">Resources</a> resources)</code> +<div class="block">Initialise a population of copies of the given chromosome.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../jcgp/backend/population/Population.html#Population-jcgp.backend.resources.Resources-">Population</a></span>(<a href="../../../jcgp/backend/resources/Resources.html" title="class in jcgp.backend.resources">Resources</a> resources)</code> +<div class="block">Initialise a random population according to the parameters specified + in the resources.</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/population/Population.html#copyChromosome-int-int-">copyChromosome</a></span>(int source, + int target)</code> +<div class="block">Copy a chromosome into a different position.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Chromosome</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/population/Population.html#get-int-">get</a></span>(int index)</code> +<div class="block">Returns the indexed chromosome.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Chromosome</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/population/Population.html#getRandomChromosome--">getRandomChromosome</a></span>()</code> </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/population/Population.html#reinitialise--">reinitialise</a></span>()</code> +<div class="block">Loop through all chromosomes and randomise all connections + and functions.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/population/Population.html#sort--">sort</a></span>()</code> +<div class="block">Sorts the population in ascending order of fitness quality.</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="Population-jcgp.backend.resources.Resources-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Population</h4> +<pre>public Population(<a href="../../../jcgp/backend/resources/Resources.html" title="class in jcgp.backend.resources">Resources</a> resources)</pre> +<div class="block">Initialise a random population according to the parameters specified + in the resources.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>resources</code> - the experiment's resources.</dd> +</dl> +</li> +</ul> +<a name="Population-jcgp.backend.population.Chromosome-jcgp.backend.resources.Resources-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Population</h4> +<pre>public Population(<a href="../../../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Chromosome</a> parent, + <a href="../../../jcgp/backend/resources/Resources.html" title="class in jcgp.backend.resources">Resources</a> resources)</pre> +<div class="block">Initialise a population of copies of the given chromosome.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>parent</code> - the chromosome to use as a model.</dd> +<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="get-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Chromosome</a> get(int index)</pre> +<div class="block">Returns the indexed chromosome.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>index</code> - the chromosome to return.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the indexed chromosome.</dd> +</dl> +</li> +</ul> +<a name="getRandomChromosome--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRandomChromosome</h4> +<pre>public <a href="../../../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Chromosome</a> getRandomChromosome()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a random chromosome from this population.</dd> +</dl> +</li> +</ul> +<a name="copyChromosome-int-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>copyChromosome</h4> +<pre>public void copyChromosome(int source, + int target)</pre> +<div class="block">Copy a chromosome into a different position. + After this returns, the target chromosome has + identical connections and functions to the source + one, though they are separate instances. + + This method does nothing if source == target.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>source</code> - the chromosome to copy from.</dd> +<dd><code>target</code> - the chromosome to copy to.</dd> +</dl> +</li> +</ul> +<a name="reinitialise--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>reinitialise</h4> +<pre>public void reinitialise()</pre> +<div class="block">Loop through all chromosomes and randomise all connections + and functions.</div> +</li> +</ul> +<a name="sort--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>sort</h4> +<pre>public void sort()</pre> +<div class="block">Sorts the population in ascending order of fitness quality. + What this means is that the best fitness chromosome will be + in the last position, even though it might have the lowest + fitness value. Fitness orientation as specified in the resources + is respected.</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/Population.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/population/Output.html" title="class in jcgp.backend.population"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?jcgp/backend/population/Population.html" target="_top">Frames</a></li> +<li><a href="Population.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> |