aboutsummaryrefslogtreecommitdiffstats
path: root/doc/jcgp/backend/population/class-use/MutableElement.html
diff options
context:
space:
mode:
authorEduardo Pedroni <ep625@york.ac.uk>2014-05-06 14:29:37 +0100
committerEduardo Pedroni <ep625@york.ac.uk>2014-05-06 14:29:37 +0100
commit8189116ea4b5db4675e31dfd04a5687d55e29262 (patch)
treec1815021452a888f8838f1628d8fb4689777e73e /doc/jcgp/backend/population/class-use/MutableElement.html
parentaa9e74e7f67789f6353fc26e02ee8e68e40609a2 (diff)
Added javadocs, made minor changes to the comments
Diffstat (limited to 'doc/jcgp/backend/population/class-use/MutableElement.html')
-rw-r--r--doc/jcgp/backend/population/class-use/MutableElement.html228
1 files changed, 228 insertions, 0 deletions
diff --git a/doc/jcgp/backend/population/class-use/MutableElement.html b/doc/jcgp/backend/population/class-use/MutableElement.html
new file mode 100644
index 0000000..77bf35f
--- /dev/null
+++ b/doc/jcgp/backend/population/class-use/MutableElement.html
@@ -0,0 +1,228 @@
+<!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 Interface jcgp.backend.population.MutableElement</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 Interface jcgp.backend.population.MutableElement";
+ }
+ }
+ 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/MutableElement.html" title="interface 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/MutableElement.html" target="_top">Frames</a></li>
+<li><a href="MutableElement.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 Interface jcgp.backend.population.MutableElement" class="title">Uses of Interface<br>jcgp.backend.population.MutableElement</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/MutableElement.html" title="interface in jcgp.backend.population">MutableElement</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.population">jcgp.backend.population</a></td>
+<td class="colLast">&nbsp;</td>
+</tr>
+</tbody>
+</table>
+</li>
+<li class="blockList">
+<ul class="blockList">
+<li class="blockList"><a name="jcgp.backend.population">
+<!-- -->
+</a>
+<h3>Uses of <a href="../../../../jcgp/backend/population/MutableElement.html" title="interface in jcgp.backend.population">MutableElement</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 classes, and an explanation">
+<caption><span>Classes in <a href="../../../../jcgp/backend/population/package-summary.html">jcgp.backend.population</a> that implement <a href="../../../../jcgp/backend/population/MutableElement.html" title="interface in jcgp.backend.population">MutableElement</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/population/Node.html" title="class in jcgp.backend.population">Node</a></span></code>
+<div class="block">Nodes make up the main part of the chromosome,
+ where the actual functions are 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/population/Output.html" title="class in jcgp.backend.population">Output</a></span></code>
+<div class="block">This is a chromosome output.</div>
+</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> that return <a href="../../../../jcgp/backend/population/MutableElement.html" title="interface in jcgp.backend.population">MutableElement</a></span><span class="tabEnd">&nbsp;</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/MutableElement.html" title="interface in jcgp.backend.population">MutableElement</a></code></td>
+<td class="colLast"><span class="typeNameLabel">Chromosome.</span><code><span class="memberNameLink"><a href="../../../../jcgp/backend/population/Chromosome.html#getRandomMutableElement--">getRandomMutableElement</a></span>()</code>
+<div class="block">This method is useful for mutating chromosomes.</div>
+</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/MutableElement.html" title="interface in jcgp.backend.population">MutableElement</a></span><span class="tabEnd">&nbsp;</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">Node.</span><code><span class="memberNameLink"><a href="../../../../jcgp/backend/population/Node.html#copyOf-jcgp.backend.population.MutableElement-">copyOf</a></span>(<a href="../../../../jcgp/backend/population/MutableElement.html" title="interface in jcgp.backend.population">MutableElement</a>&nbsp;element)</code>&nbsp;</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><span class="typeNameLabel">Output.</span><code><span class="memberNameLink"><a href="../../../../jcgp/backend/population/Output.html#copyOf-jcgp.backend.population.MutableElement-">copyOf</a></span>(<a href="../../../../jcgp/backend/population/MutableElement.html" title="interface in jcgp.backend.population">MutableElement</a>&nbsp;m)</code>&nbsp;</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><span class="typeNameLabel">MutableElement.</span><code><span class="memberNameLink"><a href="../../../../jcgp/backend/population/MutableElement.html#copyOf-jcgp.backend.population.MutableElement-">copyOf</a></span>(<a href="../../../../jcgp/backend/population/MutableElement.html" title="interface in jcgp.backend.population">MutableElement</a>&nbsp;element)</code>
+<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>
+</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/MutableElement.html" title="interface 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/MutableElement.html" target="_top">Frames</a></li>
+<li><a href="MutableElement.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>