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-15.html | |
| parent | aa9e74e7f67789f6353fc26e02ee8e68e40609a2 (diff) | |
Added javadocs, made minor changes to the comments
Diffstat (limited to 'doc/index-files/index-15.html')
| -rw-r--r-- | doc/index-files/index-15.html | 269 |
1 files changed, 269 insertions, 0 deletions
diff --git a/doc/index-files/index-15.html b/doc/index-files/index-15.html new file mode 100644 index 0000000..d1f37d6 --- /dev/null +++ b/doc/index-files/index-15.html @@ -0,0 +1,269 @@ +<!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>P-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="P-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-14.html">Prev Letter</a></li> +<li><a href="index-16.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-files/index-15.html" target="_top">Frames</a></li> +<li><a href="index-15.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:P"> +<!-- --> +</a> +<h2 class="title">P</h2> +<dl> +<dt><a href="../jcgp/backend/parameters/Parameter.html" title="class in jcgp.backend.parameters"><span class="typeNameLink">Parameter</span></a><<a href="../jcgp/backend/parameters/Parameter.html" title="type parameter in Parameter">T</a>> - Class in <a href="../jcgp/backend/parameters/package-summary.html">jcgp.backend.parameters</a></dt> +<dd> +<div class="block">Specifies an abstract model of a module parameter.</div> +</dd> +<dt><a href="../jcgp/backend/parsers/ParameterParser.html" title="class in jcgp.backend.parsers"><span class="typeNameLink">ParameterParser</span></a> - Class in <a href="../jcgp/backend/parsers/package-summary.html">jcgp.backend.parsers</a></dt> +<dd> +<div class="block">Contains a static method for parsing parameters from a + .par file.</div> +</dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/parsers/ParameterParser.html#ParameterParser--">ParameterParser()</a></span> - Constructor for class jcgp.backend.parsers.<a href="../jcgp/backend/parsers/ParameterParser.html" title="class in jcgp.backend.parsers">ParameterParser</a></dt> +<dd> </dd> +<dt><a href="../jcgp/backend/parameters/ParameterStatus.html" title="enum in jcgp.backend.parameters"><span class="typeNameLink">ParameterStatus</span></a> - Enum in <a href="../jcgp/backend/parameters/package-summary.html">jcgp.backend.parameters</a></dt> +<dd> +<div class="block">Enum type containing all possible states for parameters.</div> +</dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/parsers/ChromosomeParser.html#parse-java.io.File-jcgp.backend.population.Chromosome-jcgp.backend.resources.Resources-">parse(File, Chromosome, Resources)</a></span> - Static method in class jcgp.backend.parsers.<a href="../jcgp/backend/parsers/ChromosomeParser.html" title="class in jcgp.backend.parsers">ChromosomeParser</a></dt> +<dd> +<div class="block">Use this method to parse .chr files into a given chromosome.</div> +</dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/parsers/FunctionParser.html#parse-java.io.File-jcgp.backend.function.FunctionSet-jcgp.backend.resources.Resources-">parse(File, FunctionSet, Resources)</a></span> - Static method in class jcgp.backend.parsers.<a href="../jcgp/backend/parsers/FunctionParser.html" title="class in jcgp.backend.parsers">FunctionParser</a></dt> +<dd> +<div class="block">Reads the specified file and attempts to enable + and disable the functions in the FunctionSet + accordingly.</div> +</dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/parsers/ParameterParser.html#parse-java.io.File-jcgp.backend.resources.ModifiableResources-">parse(File, ModifiableResources)</a></span> - Static method in class jcgp.backend.parsers.<a href="../jcgp/backend/parsers/ParameterParser.html" title="class in jcgp.backend.parsers">ParameterParser</a></dt> +<dd> +<div class="block">Parses the parameters from a specified CGP parameter file and + modifies the experiment resources appropriately.</div> +</dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/parsers/TestCaseParser.html#parse-java.io.File-jcgp.backend.modules.problem.TestCaseProblem-jcgp.backend.resources.ModifiableResources-">parse(File, TestCaseProblem<?>, ModifiableResources)</a></span> - Static method in class jcgp.backend.parsers.<a href="../jcgp/backend/parsers/TestCaseParser.html" title="class in jcgp.backend.parsers">TestCaseParser</a></dt> +<dd> +<div class="block">Sets the number of inputs and outputs in the resources + to match the given file, and parses each test case + from the file into the specified problem.</div> +</dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/modules/problem/Problem.html#parseProblemData-java.io.File-jcgp.backend.resources.ModifiableResources-">parseProblemData(File, ModifiableResources)</a></span> - Method in class jcgp.backend.modules.problem.<a href="../jcgp/backend/modules/problem/Problem.html" title="class in jcgp.backend.modules.problem">Problem</a></dt> +<dd> +<div class="block">Parses the specified file and uses the parsed data to + set up the problem type instance appropriately.</div> +</dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/modules/problem/TestCaseProblem.html#parseProblemData-java.io.File-jcgp.backend.resources.ModifiableResources-">parseProblemData(File, ModifiableResources)</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> </dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/modules/problem/DigitalCircuitProblem.html#parseTestCase-java.lang.String:A-java.lang.String:A-">parseTestCase(String[], String[])</a></span> - Method in class jcgp.backend.modules.problem.<a href="../jcgp/backend/modules/problem/DigitalCircuitProblem.html" title="class in jcgp.backend.modules.problem">DigitalCircuitProblem</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/modules/problem/SymbolicRegressionProblem.html#parseTestCase-java.lang.String:A-java.lang.String:A-">parseTestCase(String[], String[])</a></span> - Method in class jcgp.backend.modules.problem.<a href="../jcgp/backend/modules/problem/SymbolicRegressionProblem.html" title="class in jcgp.backend.modules.problem">SymbolicRegressionProblem</a></dt> +<dd> </dd> +<dt><a href="../jcgp/backend/modules/mutator/PercentPointMutator.html" title="class in jcgp.backend.modules.mutator"><span class="typeNameLink">PercentPointMutator</span></a> - Class in <a href="../jcgp/backend/modules/mutator/package-summary.html">jcgp.backend.modules.mutator</a></dt> +<dd> +<div class="block">Percent point mutator + <br><br> + This operator calculates how many genes to mutate based on the mutation rate + parameter.</div> +</dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/modules/mutator/PercentPointMutator.html#PercentPointMutator-jcgp.backend.resources.Resources-">PercentPointMutator(Resources)</a></span> - Constructor for class jcgp.backend.modules.mutator.<a href="../jcgp/backend/modules/mutator/PercentPointMutator.html" title="class in jcgp.backend.modules.mutator">PercentPointMutator</a></dt> +<dd> +<div class="block">Creates a new instance of PercentPointMutator.</div> +</dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/modules/problem/DigitalCircuitProblem.html#perfectSolutionFound-jcgp.backend.population.Population-">perfectSolutionFound(Population)</a></span> - Method in class jcgp.backend.modules.problem.<a href="../jcgp/backend/modules/problem/DigitalCircuitProblem.html" title="class in jcgp.backend.modules.problem">DigitalCircuitProblem</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/modules/problem/Problem.html#perfectSolutionFound-jcgp.backend.population.Population-">perfectSolutionFound(Population)</a></span> - Method in class jcgp.backend.modules.problem.<a href="../jcgp/backend/modules/problem/Problem.html" title="class in jcgp.backend.modules.problem">Problem</a></dt> +<dd> +<div class="block">Used to assert whether a given population contains a perfect solution + to the problem.</div> +</dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/modules/problem/SymbolicRegressionProblem.html#perfectSolutionFound-jcgp.backend.population.Population-">perfectSolutionFound(Population)</a></span> - Method in class jcgp.backend.modules.problem.<a href="../jcgp/backend/modules/problem/SymbolicRegressionProblem.html" title="class in jcgp.backend.modules.problem">SymbolicRegressionProblem</a></dt> +<dd> </dd> +<dt><a href="../jcgp/backend/modules/mutator/PointMutator.html" title="class in jcgp.backend.modules.mutator"><span class="typeNameLink">PointMutator</span></a> - Class in <a href="../jcgp/backend/modules/mutator/package-summary.html">jcgp.backend.modules.mutator</a></dt> +<dd> +<div class="block">Point mutator + <br><br> + In point mutation, a number of random genes + is picked and mutated until all required + mutations have been performed.</div> +</dd> +<dt><a href="../jcgp/backend/population/Population.html" title="class in jcgp.backend.population"><span class="typeNameLink">Population</span></a> - Class in <a href="../jcgp/backend/population/package-summary.html">jcgp.backend.population</a></dt> +<dd> +<div class="block">This class primarily holds a collection of chromosomes.</div> +</dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/population/Population.html#Population-jcgp.backend.resources.Resources-">Population(Resources)</a></span> - Constructor for class jcgp.backend.population.<a href="../jcgp/backend/population/Population.html" title="class in jcgp.backend.population">Population</a></dt> +<dd> +<div class="block">Initialise a random population according to the parameters specified + in the resources.</div> +</dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/population/Population.html#Population-jcgp.backend.population.Chromosome-jcgp.backend.resources.Resources-">Population(Chromosome, Resources)</a></span> - Constructor for class jcgp.backend.population.<a href="../jcgp/backend/population/Population.html" title="class in jcgp.backend.population">Population</a></dt> +<dd> +<div class="block">Initialise a population of copies of the given chromosome.</div> +</dd> +<dt><a href="../jcgp/gui/population/PopulationPane.html" title="class in jcgp.gui.population"><span class="typeNameLink">PopulationPane</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/PopulationPane.html#PopulationPane-jcgp.gui.GUI-">PopulationPane(GUI)</a></span> - Constructor for class jcgp.gui.population.<a href="../jcgp/gui/population/PopulationPane.html" title="class in jcgp.gui.population">PopulationPane</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/resources/Resources.html#populationSize--">populationSize()</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/function/SymbolicRegressionFunctions.Power.html#Power--">Power()</a></span> - Constructor for class jcgp.backend.function.<a href="../jcgp/backend/function/SymbolicRegressionFunctions.Power.html" title="class in jcgp.backend.function">SymbolicRegressionFunctions.Power</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/resources/Console.html#print-java.lang.String-">print(String)</a></span> - Method in interface jcgp.backend.resources.<a href="../jcgp/backend/resources/Console.html" title="interface in jcgp.backend.resources">Console</a></dt> +<dd> +<div class="block">Prints a string without line break at the end (unless the string + itself specifies one).</div> +</dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/resources/Resources.html#print-java.lang.String-">print(String)</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> +<div class="block">Prints a message to the consoles ignoring + report interval.</div> +</dd> +<dt><span class="memberNameLink"><a href="../jcgp/gui/console/GUIConsole.html#print-java.lang.String-">print(String)</a></span> - Method in class jcgp.gui.console.<a href="../jcgp/gui/console/GUIConsole.html" title="class in jcgp.gui.console">GUIConsole</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/resources/Console.html#println-java.lang.String-">println(String)</a></span> - Method in interface jcgp.backend.resources.<a href="../jcgp/backend/resources/Console.html" title="interface in jcgp.backend.resources">Console</a></dt> +<dd> +<div class="block">Prints a string and automatically adds a line break at the end.</div> +</dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/resources/Resources.html#println-java.lang.String-">println(String)</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> +<div class="block">Prints a message to the consoles ignoring + report interval.</div> +</dd> +<dt><span class="memberNameLink"><a href="../jcgp/gui/console/GUIConsole.html#println-java.lang.String-">println(String)</a></span> - Method in class jcgp.gui.console.<a href="../jcgp/gui/console/GUIConsole.html" title="class in jcgp.gui.console">GUIConsole</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/population/Chromosome.html#printNodes--">printNodes()</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">Iterates through the nodes and prints all connections and functions.</div> +</dd> +<dt><a href="../jcgp/backend/modules/mutator/ProbabilisticMutator.html" title="class in jcgp.backend.modules.mutator"><span class="typeNameLink">ProbabilisticMutator</span></a> - Class in <a href="../jcgp/backend/modules/mutator/package-summary.html">jcgp.backend.modules.mutator</a></dt> +<dd> +<div class="block">Probabilistic mutator + <br><br> + This operator iterates through every mutable gene in the chromosome and + decides whether to mutate each of them individually.</div> +</dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/modules/mutator/ProbabilisticMutator.html#ProbabilisticMutator-jcgp.backend.resources.Resources-">ProbabilisticMutator(Resources)</a></span> - Constructor for class jcgp.backend.modules.mutator.<a href="../jcgp/backend/modules/mutator/ProbabilisticMutator.html" title="class in jcgp.backend.modules.mutator">ProbabilisticMutator</a></dt> +<dd> +<div class="block">Creates a new instance of ProbabilisticMutator.</div> +</dd> +<dt><a href="../jcgp/backend/modules/problem/Problem.html" title="class in jcgp.backend.modules.problem"><span class="typeNameLink">Problem</span></a> - Class in <a href="../jcgp/backend/modules/problem/package-summary.html">jcgp.backend.modules.problem</a></dt> +<dd> +<div class="block">Defines the general behaviour of a CGP problem.</div> +</dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/modules/problem/Problem.html#Problem-jcgp.backend.resources.Resources-">Problem(Resources)</a></span> - Constructor for class jcgp.backend.modules.problem.<a href="../jcgp/backend/modules/problem/Problem.html" title="class in jcgp.backend.modules.problem">Problem</a></dt> +<dd> +<div class="block">Initialises the two problem-wide parameters, maxFitness and bestFitness.</div> +</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-14.html">Prev Letter</a></li> +<li><a href="index-16.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-files/index-15.html" target="_top">Frames</a></li> +<li><a href="index-15.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> |