aboutsummaryrefslogtreecommitdiffstats
path: root/doc/jcgp/backend/population/MutableElement.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/jcgp/backend/population/MutableElement.html')
-rw-r--r--doc/jcgp/backend/population/MutableElement.html306
1 files changed, 306 insertions, 0 deletions
diff --git a/doc/jcgp/backend/population/MutableElement.html b/doc/jcgp/backend/population/MutableElement.html
new file mode 100644
index 0000000..4af7b7e
--- /dev/null
+++ b/doc/jcgp/backend/population/MutableElement.html
@@ -0,0 +1,306 @@
+<!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:06 BST 2014 -->
+<title>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="MutableElement";
+ }
+ }
+ catch(err) {
+ }
+//-->
+var methods = {"i0":6,"i1":6};
+var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
+var altColor = "altColor";
+var rowColor = "rowColor";
+var tableTab = "tableTab";
+var activeTableTab = "activeTableTab";
+</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 class="navBarCell1Rev">Class</li>
+<li><a href="class-use/MutableElement.html">Use</a></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><a href="../../../jcgp/backend/population/Input.html" title="class in jcgp.backend.population"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
+<li><a href="../../../jcgp/backend/population/Node.html" title="class in jcgp.backend.population"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../index.html?jcgp/backend/population/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>
+<div>
+<ul class="subNavList">
+<li>Summary:&nbsp;</li>
+<li>Nested&nbsp;|&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li>Constr&nbsp;|&nbsp;</li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail:&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li>Constr&nbsp;|&nbsp;</li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a name="skip.navbar.top">
+<!-- -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<!-- ======== START OF CLASS DATA ======== -->
+<div class="header">
+<div class="subTitle">jcgp.backend.population</div>
+<h2 title="Interface MutableElement" class="title">Interface MutableElement</h2>
+</div>
+<div class="contentContainer">
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Known Implementing Classes:</dt>
+<dd><a href="../../../jcgp/backend/population/Node.html" title="class in jcgp.backend.population">Node</a>, <a href="../../../jcgp/backend/population/Output.html" title="class in jcgp.backend.population">Output</a></dd>
+</dl>
+<hr>
+<br>
+<pre>public interface <span class="typeNameLabel">MutableElement</span></pre>
+<div class="block"><code>MutableElement</code> declares the expected behaviour of any
+ part of a chromosome that is mutable, more specifically
+ nodes or outputs. Inputs are not mutable since they don't have
+ connections or functions.
+ <br><br>
+ This interface provides a way to deal with mutable elements
+ generically without having to specify whether they are nodes
+ or outputs. In this way a random mutable element can be picked and
+ dealt with more easily, facilitating mutations.</div>
+<dl>
+<dt><span class="simpleTagLabel">Author:</span></dt>
+<dd>Eduardo Pedroni</dd>
+</dl>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- ========== METHOD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.summary">
+<!-- -->
+</a>
+<h3>Method Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
+<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
+<tr id="i0" class="altColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><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>
+<tr id="i1" class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/population/MutableElement.html#setConnection-int-jcgp.backend.population.Connection-">setConnection</a></span>(int&nbsp;index,
+ <a href="../../../jcgp/backend/population/Connection.html" title="interface in jcgp.backend.population">Connection</a>&nbsp;newConnection)</code>
+<div class="block">This method sets the indexed connection to the specified new connection.</div>
+</td>
+</tr>
+</table>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method.detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="setConnection-int-jcgp.backend.population.Connection-">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setConnection</h4>
+<pre>void&nbsp;setConnection(int&nbsp;index,
+ <a href="../../../jcgp/backend/population/Connection.html" title="interface in jcgp.backend.population">Connection</a>&nbsp;newConnection)</pre>
+<div class="block">This method sets the indexed connection to the specified new connection.
+ Implementing classes may choose to ignore the given index (such as in the
+ case of outputs, which only have one connection).</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>index</code> - the connection index to set.</dd>
+<dd><code>newConnection</code> - the chromosome element to connect to.</dd>
+</dl>
+</li>
+</ul>
+<a name="copyOf-jcgp.backend.population.MutableElement-">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>copyOf</h4>
+<pre>boolean&nbsp;copyOf(<a href="../../../jcgp/backend/population/MutableElement.html" title="interface in jcgp.backend.population">MutableElement</a>&nbsp;element)</pre>
+<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:
+ <ul>
+ <li>the elements being compared are not the same instance;</li>
+ <li>the connections of the compared elements are not the same instance;</li>
+ <li>the elements have the same function (in the case of Node);</li>
+ <li>the grid position of the elements themselves are the same;</li>
+ <li>the grid position of all equivalent connections are the same;</li>
+ </ul>
+ <br><br>
+ The relationship computed by this method is:
+ <ul>
+ <li>symmetric: a.copyOf(b) == b.copyOf(a);</li>
+ <li>not reflexive: a.copyOf(a) returns false;</li>
+ <li>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.</li>
+ </ul></div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>element</code> - the mutable element to compare to.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>true if <code>element</code> is a copy of this element.</dd>
+</dl>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+<!-- ========= END OF CLASS DATA ========= -->
+<!-- ======= 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 class="navBarCell1Rev">Class</li>
+<li><a href="class-use/MutableElement.html">Use</a></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><a href="../../../jcgp/backend/population/Input.html" title="class in jcgp.backend.population"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
+<li><a href="../../../jcgp/backend/population/Node.html" title="class in jcgp.backend.population"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../index.html?jcgp/backend/population/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>
+<div>
+<ul class="subNavList">
+<li>Summary:&nbsp;</li>
+<li>Nested&nbsp;|&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li>Constr&nbsp;|&nbsp;</li>
+<li><a href="#method.summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail:&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li>Constr&nbsp;|&nbsp;</li>
+<li><a href="#method.detail">Method</a></li>
+</ul>
+</div>
+<a name="skip.navbar.bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</body>
+</html>