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/index-files/index-3.html | |
| parent | aa9e74e7f67789f6353fc26e02ee8e68e40609a2 (diff) | |
Added javadocs, made minor changes to the comments
Diffstat (limited to 'doc/index-files/index-3.html')
| -rw-r--r-- | doc/index-files/index-3.html | 233 |
1 files changed, 233 insertions, 0 deletions
diff --git a/doc/index-files/index-3.html b/doc/index-files/index-3.html new file mode 100644 index 0000000..2833121 --- /dev/null +++ b/doc/index-files/index-3.html @@ -0,0 +1,233 @@ +<!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>C-Index</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="C-Index"; + } + } + 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>Package</li> +<li>Class</li> +<li>Use</li> +<li><a href="../overview-tree.html">Tree</a></li> +<li><a href="../deprecated-list.html">Deprecated</a></li> +<li class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-2.html">Prev Letter</a></li> +<li><a href="index-4.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-files/index-3.html" target="_top">Frames</a></li> +<li><a href="index-3.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="contentContainer"><a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">R</a> <a href="index-17.html">S</a> <a href="index-18.html">T</a> <a href="index-19.html">U</a> <a href="index-20.html">V</a> <a href="index-21.html">W</a> <a href="index-22.html">X</a> <a name="I:C"> +<!-- --> +</a> +<h2 class="title">C</h2> +<dl> +<dt><span class="memberNameLink"><a href="../jcgp/backend/population/Output.html#calculate--">calculate()</a></span> - Method in class jcgp.backend.population.<a href="../jcgp/backend/population/Output.html" title="class in jcgp.backend.population">Output</a></dt> +<dd> </dd> +<dt><a href="../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population"><span class="typeNameLink">Chromosome</span></a> - Class in <a href="../jcgp/backend/population/package-summary.html">jcgp.backend.population</a></dt> +<dd> +<div class="block">This class encapsulates a CGP chromosome.</div> +</dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/population/Chromosome.html#Chromosome-jcgp.backend.resources.Resources-">Chromosome(Resources)</a></span> - Constructor for class jcgp.backend.population.<a href="../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Chromosome</a></dt> +<dd> +<div class="block">Initialise a chromosome with the specified parameters.</div> +</dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/population/Chromosome.html#Chromosome-jcgp.backend.population.Chromosome-">Chromosome(Chromosome)</a></span> - Constructor for class jcgp.backend.population.<a href="../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Chromosome</a></dt> +<dd> +<div class="block">Copy constructor.</div> +</dd> +<dt><a href="../jcgp/gui/population/ChromosomePane.html" title="class in jcgp.gui.population"><span class="typeNameLink">ChromosomePane</span></a> - Class in <a href="../jcgp/gui/population/package-summary.html">jcgp.gui.population</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="../jcgp/gui/population/ChromosomePane.html#ChromosomePane-jcgp.backend.population.Chromosome-jcgp.gui.GUI-jcgp.gui.population.PopulationPane-">ChromosomePane(Chromosome, GUI, PopulationPane)</a></span> - Constructor for class jcgp.gui.population.<a href="../jcgp/gui/population/ChromosomePane.html" title="class in jcgp.gui.population">ChromosomePane</a></dt> +<dd> </dd> +<dt><a href="../jcgp/backend/parsers/ChromosomeParser.html" title="class in jcgp.backend.parsers"><span class="typeNameLink">ChromosomeParser</span></a> - Class in <a href="../jcgp/backend/parsers/package-summary.html">jcgp.backend.parsers</a></dt> +<dd> +<div class="block">This class contains a method for parsing .chr files and another + for writing .chr files from given chromosomes.</div> +</dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/parsers/ChromosomeParser.html#ChromosomeParser--">ChromosomeParser()</a></span> - Constructor for class jcgp.backend.parsers.<a href="../jcgp/backend/parsers/ChromosomeParser.html" title="class in jcgp.backend.parsers">ChromosomeParser</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/modules/problem/TestCaseProblem.html#clearTestCases--">clearTestCases()</a></span> - Method in class jcgp.backend.modules.problem.<a href="../jcgp/backend/modules/problem/TestCaseProblem.html" title="class in jcgp.backend.modules.problem">TestCaseProblem</a></dt> +<dd> +<div class="block">Remove all test cases.</div> +</dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/resources/Resources.html#columns--">columns()</a></span> - Method in class jcgp.backend.resources.<a href="../jcgp/backend/resources/Resources.html" title="class in jcgp.backend.resources">Resources</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/population/Chromosome.html#compareActiveGenesTo-jcgp.backend.population.Chromosome-">compareActiveGenesTo(Chromosome)</a></span> - Method in class jcgp.backend.population.<a href="../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Chromosome</a></dt> +<dd> +<div class="block">Does the same as <code>compareGenesto()</code> but only looks + at the active portion of the chromosome.</div> +</dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/population/Chromosome.html#compareGenesTo-jcgp.backend.population.Chromosome-">compareGenesTo(Chromosome)</a></span> - Method in class jcgp.backend.population.<a href="../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Chromosome</a></dt> +<dd> +<div class="block">Performs a deep comparison between this chromosome and the provided one.</div> +</dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/population/Chromosome.html#compareTo-jcgp.backend.population.Chromosome-">compareTo(Chromosome)</a></span> - Method in class jcgp.backend.population.<a href="../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Chromosome</a></dt> +<dd> </dd> +<dt><a href="../jcgp/backend/population/Connection.html" title="interface in jcgp.backend.population"><span class="typeNameLink">Connection</span></a> - Interface in <a href="../jcgp/backend/population/package-summary.html">jcgp.backend.population</a></dt> +<dd> +<div class="block"><code>Connection</code> declares the expected behaviour of any + part of a chromosome that can be connected to, specifically + nodes or inputs.</div> +</dd> +<dt><a href="../jcgp/backend/resources/Console.html" title="interface in jcgp.backend.resources"><span class="typeNameLink">Console</span></a> - Interface in <a href="../jcgp/backend/resources/package-summary.html">jcgp.backend.resources</a></dt> +<dd> +<div class="block">Defines the basic model for a console.</div> +</dd> +<dt><span class="memberNameLink"><a href="../jcgp/gui/GUI.html#CONSOLE_MIN_HEIGHT">CONSOLE_MIN_HEIGHT</a></span> - Static variable in class jcgp.gui.<a href="../jcgp/gui/GUI.html" title="class in jcgp.gui">GUI</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/function/DigitalCircuitFunctions.ConstantOne.html#ConstantOne--">ConstantOne()</a></span> - Constructor for class jcgp.backend.function.<a href="../jcgp/backend/function/DigitalCircuitFunctions.ConstantOne.html" title="class in jcgp.backend.function">DigitalCircuitFunctions.ConstantOne</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/function/DigitalCircuitFunctions.ConstantZero.html#ConstantZero--">ConstantZero()</a></span> - Constructor for class jcgp.backend.function.<a href="../jcgp/backend/function/DigitalCircuitFunctions.ConstantZero.html" title="class in jcgp.backend.function">DigitalCircuitFunctions.ConstantZero</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/population/Population.html#copyChromosome-int-int-">copyChromosome(int, int)</a></span> - Method in class jcgp.backend.population.<a href="../jcgp/backend/population/Population.html" title="class in jcgp.backend.population">Population</a></dt> +<dd> +<div class="block">Copy a chromosome into a different position.</div> +</dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/population/Chromosome.html#copyGenes-jcgp.backend.population.Chromosome-">copyGenes(Chromosome)</a></span> - Method in class jcgp.backend.population.<a href="../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Chromosome</a></dt> +<dd> +<div class="block">Creates a deep copy of the specified chromosome in the + this instance.</div> +</dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/population/MutableElement.html#copyOf-jcgp.backend.population.MutableElement-">copyOf(MutableElement)</a></span> - Method in interface jcgp.backend.population.<a href="../jcgp/backend/population/MutableElement.html" title="interface in jcgp.backend.population">MutableElement</a></dt> +<dd> +<div class="block">Asserts if the specified element is a copy of the elements + this is called on.<br> + This method returns true if and only if: + + the elements being compared are not the same instance; + the connections of the compared elements are not the same instance; + the elements have the same function (in the case of Node); + the grid position of the elements themselves are the same; + the grid position of all equivalent connections are the same; + + <br><br> + The relationship computed by this method is: + + symmetric: a.copyOf(b) == b.copyOf(a); + not reflexive: a.copyOf(a) returns false; + not transitive: if a.copyOf(b) is true and b.copyOf(c) is true, a.copyOf(c) is + not necessarily true since it is possible that a == c. + </div> +</dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/population/Node.html#copyOf-jcgp.backend.population.MutableElement-">copyOf(MutableElement)</a></span> - Method in class jcgp.backend.population.<a href="../jcgp/backend/population/Node.html" title="class in jcgp.backend.population">Node</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/population/Output.html#copyOf-jcgp.backend.population.MutableElement-">copyOf(MutableElement)</a></span> - Method in class jcgp.backend.population.<a href="../jcgp/backend/population/Output.html" title="class in jcgp.backend.population">Output</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/function/SymbolicRegressionFunctions.Cosine.html#Cosine--">Cosine()</a></span> - Constructor for class jcgp.backend.function.<a href="../jcgp/backend/function/SymbolicRegressionFunctions.Cosine.html" title="class in jcgp.backend.function">SymbolicRegressionFunctions.Cosine</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/function/SymbolicRegressionFunctions.CosineAB.html#CosineAB--">CosineAB()</a></span> - Constructor for class jcgp.backend.function.<a href="../jcgp/backend/function/SymbolicRegressionFunctions.CosineAB.html" title="class in jcgp.backend.function">SymbolicRegressionFunctions.CosineAB</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="../jcgp/gui/settings/parameters/GUIParameter.html#create-jcgp.backend.parameters.Parameter-jcgp.gui.settings.SettingsPane-">create(Parameter<?>, SettingsPane)</a></span> - Static method in class jcgp.gui.settings.parameters.<a href="../jcgp/gui/settings/parameters/GUIParameter.html" title="class in jcgp.gui.settings.parameters">GUIParameter</a></dt> +<dd> +<div class="block">Factory method to create @code{GUIParameter}s from @code{Parameter}s.</div> +</dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/function/TravellingSalesmanFunctions.Cube.html#Cube--">Cube()</a></span> - Constructor for class jcgp.backend.function.<a href="../jcgp/backend/function/TravellingSalesmanFunctions.Cube.html" title="class in jcgp.backend.function">TravellingSalesmanFunctions.Cube</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/resources/Resources.html#currentGeneration--">currentGeneration()</a></span> - Method in class jcgp.backend.resources.<a href="../jcgp/backend/resources/Resources.html" title="class in jcgp.backend.resources">Resources</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/resources/Resources.html#currentRun--">currentRun()</a></span> - Method in class jcgp.backend.resources.<a href="../jcgp/backend/resources/Resources.html" title="class in jcgp.backend.resources">Resources</a></dt> +<dd> </dd> +</dl> +<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">R</a> <a href="index-17.html">S</a> <a href="index-18.html">T</a> <a href="index-19.html">U</a> <a href="index-20.html">V</a> <a href="index-21.html">W</a> <a href="index-22.html">X</a> </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>Package</li> +<li>Class</li> +<li>Use</li> +<li><a href="../overview-tree.html">Tree</a></li> +<li><a href="../deprecated-list.html">Deprecated</a></li> +<li class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-2.html">Prev Letter</a></li> +<li><a href="index-4.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-files/index-3.html" target="_top">Frames</a></li> +<li><a href="index-3.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> |