Added javadocs, made minor changes to the comments

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/modules/class-use/Module.html
parent: aa9e74e7f67789f6353fc26e02ee8e68e40609a2 (diff)
1 files changed, 292 insertions, 0 deletions
diff --git a/doc/jcgp/backend/modules/class-use/Module.html b/doc/jcgp/backend/modules/class-use/Module.html
new file mode 100644
index 0000000..6ab68d0
--- /dev/null
+++ b/doc/jcgp/backend/modules/class-use/Module.html
@@ -0,0 +1,292 @@
+<!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.modules.Module</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.modules.Module";
+        }
+    }
+    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/modules/Module.html" title="class in jcgp.backend.modules">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/modules/class-use/Module.html" target="_top">Frames</a></li>
+<li><a href="Module.html" target="_top">No&nbsp;Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="../../../../allclasses-noframe.html">All&nbsp;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.modules.Module" class="title">Uses of Class<br>jcgp.backend.modules.Module</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/modules/Module.html" title="class in jcgp.backend.modules">Module</a></span><span class="tabEnd">&nbsp;</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.es">jcgp.backend.modules.es</a></td>
+<td class="colLast">&nbsp;</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a href="#jcgp.backend.modules.mutator">jcgp.backend.modules.mutator</a></td>
+<td class="colLast">&nbsp;</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><a href="#jcgp.backend.modules.problem">jcgp.backend.modules.problem</a></td>
+<td class="colLast">&nbsp;</td>
+</tr>
+</tbody>
+</table>
+</li>
+<li class="blockList">
+<ul class="blockList">
+<li class="blockList"><a name="jcgp.backend.modules.es">
+<!--   -->
+</a>
+<h3>Uses of <a href="../../../../jcgp/backend/modules/Module.html" title="class in jcgp.backend.modules">Module</a> in <a href="../../../../jcgp/backend/modules/es/package-summary.html">jcgp.backend.modules.es</a></h3>
+<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation">
+<caption><span>Subclasses of <a href="../../../../jcgp/backend/modules/Module.html" title="class in jcgp.backend.modules">Module</a> in <a href="../../../../jcgp/backend/modules/es/package-summary.html">jcgp.backend.modules.es</a></span><span class="tabEnd">&nbsp;</span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Class and Description</th>
+</tr>
+<tbody>
+<tr class="altColor">
+<td class="colFirst"><code>class&nbsp;</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/modules/es/EvolutionaryStrategy.html" title="class in jcgp.backend.modules.es">EvolutionaryStrategy</a></span></code>
+<div class="block">This class specifies the characteristics of an evolutionary strategy.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>class&nbsp;</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/modules/es/MuPlusLambda.html" title="class in jcgp.backend.modules.es">MuPlusLambda</a></span></code>
+<div class="block">(μ + λ)-ES
+ <br><br>
+ This strategy selects the μ fittest chromosomes from the population.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>class&nbsp;</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/modules/es/TournamentSelection.html" title="class in jcgp.backend.modules.es">TournamentSelection</a></span></code>
+<div class="block">Tournament selection
+ <br><br>
+ This strategy generates a new population by selecting a specified number
+ of chromosomes from the original population and selecting the fittest out
+ of the isolated subset (the tournament).</div>
+</td>
+</tr>
+</tbody>
+</table>
+</li>
+<li class="blockList"><a name="jcgp.backend.modules.mutator">
+<!--   -->
+</a>
+<h3>Uses of <a href="../../../../jcgp/backend/modules/Module.html" title="class in jcgp.backend.modules">Module</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 subclasses, and an explanation">
+<caption><span>Subclasses of <a href="../../../../jcgp/backend/modules/Module.html" title="class in jcgp.backend.modules">Module</a> in <a href="../../../../jcgp/backend/modules/mutator/package-summary.html">jcgp.backend.modules.mutator</a></span><span class="tabEnd">&nbsp;</span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Class and Description</th>
+</tr>
+<tbody>
+<tr class="altColor">
+<td class="colFirst"><code>class&nbsp;</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/modules/mutator/FixedPointMutator.html" title="class in jcgp.backend.modules.mutator">FixedPointMutator</a></span></code>
+<div class="block">Fixed point mutator
+ <br><br>
+ This operator uses the point mutator 
+ algorithm to mutate a user-defined fixed
+ number of genes.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>class&nbsp;</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/modules/mutator/Mutator.html" title="class in jcgp.backend.modules.mutator">Mutator</a></span></code>
+<div class="block">This class specifies the basic characteristics of a mutation operator.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>class&nbsp;</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/modules/mutator/PercentPointMutator.html" title="class in jcgp.backend.modules.mutator">PercentPointMutator</a></span></code>
+<div class="block">Percent point mutator
+ <br><br>
+ This operator calculates how many genes to mutate based on the mutation rate
+ parameter.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>class&nbsp;</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/modules/mutator/PointMutator.html" title="class in jcgp.backend.modules.mutator">PointMutator</a></span></code>
+<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>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>class&nbsp;</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/modules/mutator/ProbabilisticMutator.html" title="class in jcgp.backend.modules.mutator">ProbabilisticMutator</a></span></code>
+<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>
+</td>
+</tr>
+</tbody>
+</table>
+</li>
+<li class="blockList"><a name="jcgp.backend.modules.problem">
+<!--   -->
+</a>
+<h3>Uses of <a href="../../../../jcgp/backend/modules/Module.html" title="class in jcgp.backend.modules">Module</a> in <a href="../../../../jcgp/backend/modules/problem/package-summary.html">jcgp.backend.modules.problem</a></h3>
+<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation">
+<caption><span>Subclasses of <a href="../../../../jcgp/backend/modules/Module.html" title="class in jcgp.backend.modules">Module</a> in <a href="../../../../jcgp/backend/modules/problem/package-summary.html">jcgp.backend.modules.problem</a></span><span class="tabEnd">&nbsp;</span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Class and Description</th>
+</tr>
+<tbody>
+<tr class="altColor">
+<td class="colFirst"><code>class&nbsp;</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/modules/problem/DigitalCircuitProblem.html" title="class in jcgp.backend.modules.problem">DigitalCircuitProblem</a></span></code>
+<div class="block">Digital circuit problem
+ <br><br>
+ Using this problem type, digital logic circuits can be evolved.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>class&nbsp;</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/modules/problem/Problem.html" title="class in jcgp.backend.modules.problem">Problem</a></span></code>
+<div class="block">Defines the general behaviour of a CGP problem.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>class&nbsp;</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/modules/problem/SymbolicRegressionProblem.html" title="class in jcgp.backend.modules.problem">SymbolicRegressionProblem</a></span></code>
+<div class="block">Symbolic regression functions
+ <br><br>
+ Using this problem type, regression problems can be solved.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>class&nbsp;</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/modules/problem/TestCaseProblem.html" title="class in jcgp.backend.modules.problem">TestCaseProblem</a>&lt;T&gt;</span></code>
+<div class="block">Abstract model for a problem that uses test cases.</div>
+</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/modules/Module.html" title="class in jcgp.backend.modules">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/modules/class-use/Module.html" target="_top">Frames</a></li>
+<li><a href="Module.html" target="_top">No&nbsp;Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../../allclasses-noframe.html">All&nbsp;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>
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/modules/class-use/Module.html
parent	aa9e74e7f67789f6353fc26e02ee8e68e40609a2 (diff)