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/class-use/Chromosome.html | |
| parent | aa9e74e7f67789f6353fc26e02ee8e68e40609a2 (diff) | |
Added javadocs, made minor changes to the comments
Diffstat (limited to 'doc/jcgp/backend/population/class-use/Chromosome.html')
| -rw-r--r-- | doc/jcgp/backend/population/class-use/Chromosome.html | 340 |
1 files changed, 340 insertions, 0 deletions
diff --git a/doc/jcgp/backend/population/class-use/Chromosome.html b/doc/jcgp/backend/population/class-use/Chromosome.html new file mode 100644 index 0000000..4245432 --- /dev/null +++ b/doc/jcgp/backend/population/class-use/Chromosome.html @@ -0,0 +1,340 @@ +<!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>Uses of Class jcgp.backend.population.Chromosome</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="Uses of Class jcgp.backend.population.Chromosome"; + } + } + catch(err) { + } +//--> +</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><a href="../../../../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?jcgp/backend/population/class-use/Chromosome.html" target="_top">Frames</a></li> +<li><a href="Chromosome.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> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class jcgp.backend.population.Chromosome" class="title">Uses of Class<br>jcgp.backend.population.Chromosome</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Chromosome</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#jcgp.backend.modules.mutator">jcgp.backend.modules.mutator</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#jcgp.backend.parsers">jcgp.backend.parsers</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#jcgp.backend.population">jcgp.backend.population</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#jcgp.gui.population">jcgp.gui.population</a></td> +<td class="colLast"> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="jcgp.backend.modules.mutator"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Chromosome</a> in <a href="../../../../jcgp/backend/modules/mutator/package-summary.html">jcgp.backend.modules.mutator</a></h3> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../jcgp/backend/modules/mutator/package-summary.html">jcgp.backend.modules.mutator</a> with parameters of type <a href="../../../../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Chromosome</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="typeNameLabel">ProbabilisticMutator.</span><code><span class="memberNameLink"><a href="../../../../jcgp/backend/modules/mutator/ProbabilisticMutator.html#mutate-jcgp.backend.population.Chromosome-">mutate</a></span>(<a href="../../../../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Chromosome</a> chromosome)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><span class="typeNameLabel">Mutator.</span><code><span class="memberNameLink"><a href="../../../../jcgp/backend/modules/mutator/Mutator.html#mutate-jcgp.backend.population.Chromosome-">mutate</a></span>(<a href="../../../../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Chromosome</a> chromosome)</code> +<div class="block">Applies mutations to the specified chromosome according + to the parameter values.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="typeNameLabel">PointMutator.</span><code><span class="memberNameLink"><a href="../../../../jcgp/backend/modules/mutator/PointMutator.html#mutate-jcgp.backend.population.Chromosome-">mutate</a></span>(<a href="../../../../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Chromosome</a> chromosome)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="jcgp.backend.parsers"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Chromosome</a> in <a href="../../../../jcgp/backend/parsers/package-summary.html">jcgp.backend.parsers</a></h3> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../jcgp/backend/parsers/package-summary.html">jcgp.backend.parsers</a> with parameters of type <a href="../../../../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Chromosome</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><span class="typeNameLabel">ChromosomeParser.</span><code><span class="memberNameLink"><a href="../../../../jcgp/backend/parsers/ChromosomeParser.html#parse-java.io.File-jcgp.backend.population.Chromosome-jcgp.backend.resources.Resources-">parse</a></span>(java.io.File file, + <a href="../../../../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Chromosome</a> chromosome, + <a href="../../../../jcgp/backend/resources/Resources.html" title="class in jcgp.backend.resources">Resources</a> resources)</code> +<div class="block">Use this method to parse .chr files into a given chromosome.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><span class="typeNameLabel">ChromosomeParser.</span><code><span class="memberNameLink"><a href="../../../../jcgp/backend/parsers/ChromosomeParser.html#save-java.io.File-jcgp.backend.population.Chromosome-jcgp.backend.resources.Resources-">save</a></span>(java.io.File file, + <a href="../../../../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Chromosome</a> chromosome, + <a href="../../../../jcgp/backend/resources/Resources.html" title="class in jcgp.backend.resources">Resources</a> resources)</code> +<div class="block">Writes a chromosome into the specified .chr file.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="jcgp.backend.population"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Chromosome</a> in <a href="../../../../jcgp/backend/population/package-summary.html">jcgp.backend.population</a></h3> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../jcgp/backend/population/package-summary.html">jcgp.backend.population</a> that return <a href="../../../../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Chromosome</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr 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"><span class="typeNameLabel">Population.</span><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 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"><span class="typeNameLabel">Population.</span><code><span class="memberNameLink"><a href="../../../../jcgp/backend/population/Population.html#getRandomChromosome--">getRandomChromosome</a></span>()</code> </td> +</tr> +</tbody> +</table> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../jcgp/backend/population/package-summary.html">jcgp.backend.population</a> with parameters of type <a href="../../../../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Chromosome</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="typeNameLabel">Chromosome.</span><code><span class="memberNameLink"><a href="../../../../jcgp/backend/population/Chromosome.html#compareActiveGenesTo-jcgp.backend.population.Chromosome-">compareActiveGenesTo</a></span>(<a href="../../../../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Chromosome</a> chromosome)</code> +<div class="block">Does the same as <code>compareGenesto()</code> but only looks + at the active portion of the chromosome.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="typeNameLabel">Chromosome.</span><code><span class="memberNameLink"><a href="../../../../jcgp/backend/population/Chromosome.html#compareGenesTo-jcgp.backend.population.Chromosome-">compareGenesTo</a></span>(<a href="../../../../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Chromosome</a> chromosome)</code> +<div class="block">Performs a deep comparison between this chromosome and the provided one.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><span class="typeNameLabel">Chromosome.</span><code><span class="memberNameLink"><a href="../../../../jcgp/backend/population/Chromosome.html#compareTo-jcgp.backend.population.Chromosome-">compareTo</a></span>(<a href="../../../../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Chromosome</a> o)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="typeNameLabel">Chromosome.</span><code><span class="memberNameLink"><a href="../../../../jcgp/backend/population/Chromosome.html#copyGenes-jcgp.backend.population.Chromosome-">copyGenes</a></span>(<a href="../../../../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Chromosome</a> clone)</code> +<div class="block">Creates a deep copy of the specified chromosome in the + this instance.</div> +</td> +</tr> +</tbody> +</table> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../jcgp/backend/population/package-summary.html">jcgp.backend.population</a> with parameters of type <a href="../../../../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Chromosome</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/population/Chromosome.html#Chromosome-jcgp.backend.population.Chromosome-">Chromosome</a></span>(<a href="../../../../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Chromosome</a> clone)</code> +<div class="block">Copy constructor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/population/Node.html#Node-jcgp.backend.population.Chromosome-int-int-int-">Node</a></span>(<a href="../../../../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Chromosome</a> chromosome, + int row, + int column, + int arity)</code> +<div class="block">Constructs a new instance of <code>Node</code> with the + specified parameters.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/population/Output.html#Output-jcgp.backend.population.Chromosome-int-">Output</a></span>(<a href="../../../../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Chromosome</a> chromosome, + int index)</code> +<div class="block">Makes a new instance of <code>Output</code> with the + specified arguments.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colLast"><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> +</tbody> +</table> +</li> +<li class="blockList"><a name="jcgp.gui.population"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Chromosome</a> in <a href="../../../../jcgp/gui/population/package-summary.html">jcgp.gui.population</a></h3> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../jcgp/gui/population/package-summary.html">jcgp.gui.population</a> with parameters of type <a href="../../../../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Chromosome</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="typeNameLabel">ChromosomePane.</span><code><span class="memberNameLink"><a href="../../../../jcgp/gui/population/ChromosomePane.html#updateGenes-jcgp.backend.population.Chromosome-">updateGenes</a></span>(<a href="../../../../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Chromosome</a> chr)</code> </td> +</tr> +</tbody> +</table> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../jcgp/gui/population/package-summary.html">jcgp.gui.population</a> with parameters of type <a href="../../../../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Chromosome</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/gui/population/ChromosomePane.html#ChromosomePane-jcgp.backend.population.Chromosome-jcgp.gui.GUI-jcgp.gui.population.PopulationPane-">ChromosomePane</a></span>(<a href="../../../../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Chromosome</a> chromosome, + <a href="../../../../jcgp/gui/GUI.html" title="class in jcgp.gui">GUI</a> gui, + <a href="../../../../jcgp/gui/population/PopulationPane.html" title="class in jcgp.gui.population">PopulationPane</a> parent)</code> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?jcgp/backend/population/class-use/Chromosome.html" target="_top">Frames</a></li> +<li><a href="Chromosome.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> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> |