<!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>Node</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="Node";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/Node.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/MutableElement.html" title="interface in jcgp.backend.population"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../jcgp/backend/population/Output.html" title="class in jcgp.backend.population"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?jcgp/backend/population/Node.html" target="_top">Frames</a></li>
<li><a href="Node.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>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </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="Class Node" class="title">Class Node</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>jcgp.backend.population.Node</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../jcgp/backend/population/Connection.html" title="interface in jcgp.backend.population">Connection</a>, <a href="../../../jcgp/backend/population/MutableElement.html" title="interface in jcgp.backend.population">MutableElement</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">Node</span>
extends java.lang.Object
implements <a href="../../../jcgp/backend/population/MutableElement.html" title="interface in jcgp.backend.population">MutableElement</a>, <a href="../../../jcgp/backend/population/Connection.html" title="interface in jcgp.backend.population">Connection</a></pre>
<div class="block">Nodes make up the main part of the chromosome,
where the actual functions are evolved. Each node
contains a function and a number of connections.
The node outputs the result of performing its function
on the values of its connections. Nodes therefore
implement both <code>MutableElement</code> and <code>Connection</code>
since they can be mutated but also connected to.
Nodes are constructed with a fixed number of connections
(determined by the maximum arity of the function set)
and must be reinstantiated if the experiment arity
changes.</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">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../jcgp/backend/population/Node.html#Node-jcgp.backend.population.Chromosome-int-int-int-">Node</a></span>(<a href="../../../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Chromosome</a> chromosome,
int row,
int column,
int arity)</code>
<div class="block">Constructs a new instance of <code>Node</code> with the
specified parameters.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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/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> 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>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/population/Node.html#getColumn--">getColumn</a></span>()</code> </td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../jcgp/backend/population/Connection.html" title="interface in jcgp.backend.population">Connection</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/population/Node.html#getConnection-int-">getConnection</a></span>(int index)</code> </td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../jcgp/backend/function/Function.html" title="class in jcgp.backend.function">Function</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/population/Node.html#getFunction--">getFunction</a></span>()</code> </td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/population/Node.html#getRow--">getRow</a></span>()</code> </td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/population/Node.html#getValue--">getValue</a></span>()</code>
<div class="block">Compute and return the value of this connection.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/population/Node.html#initialise-jcgp.backend.function.Function-jcgp.backend.population.Connection...-">initialise</a></span>(<a href="../../../jcgp/backend/function/Function.html" title="class in jcgp.backend.function">Function</a> newFunction,
<a href="../../../jcgp/backend/population/Connection.html" title="interface in jcgp.backend.population">Connection</a>... newConnections)</code>
<div class="block">Initialises the node with the specified values.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/population/Node.html#setConnection-int-jcgp.backend.population.Connection-">setConnection</a></span>(int index,
<a href="../../../jcgp/backend/population/Connection.html" title="interface in jcgp.backend.population">Connection</a> newConnection)</code>
<div class="block">This method sets the indexed connection to the specified new connection.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/population/Node.html#setFunction-jcgp.backend.function.Function-">setFunction</a></span>(<a href="../../../jcgp/backend/function/Function.html" title="class in jcgp.backend.function">Function</a> newFunction)</code>
<div class="block">Sets the node function.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/population/Node.html#toString--">toString</a></span>()</code> </td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Node-jcgp.backend.population.Chromosome-int-int-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Node</h4>
<pre>public Node(<a href="../../../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Chromosome</a> chromosome,
int row,
int column,
int arity)</pre>
<div class="block">Constructs a new instance of <code>Node</code> with the
specified parameters. Nodes must contain their
own row and column for ease of copying.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>chromosome</code> - the chromosome this node belongs to.</dd>
<dd><code>row</code> - the node's row.</dd>
<dd><code>column</code> - the node's column.</dd>
<dd><code>arity</code> - the maximum arity of the experiment.</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setFunction-jcgp.backend.function.Function-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFunction</h4>
<pre>public void setFunction(<a href="../../../jcgp/backend/function/Function.html" title="class in jcgp.backend.function">Function</a> newFunction)</pre>
<div class="block">Sets the node function.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>newFunction</code> - the new function to set.</dd>
</dl>
</li>
</ul>
<a name="initialise-jcgp.backend.function.Function-jcgp.backend.population.Connection...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initialise</h4>
<pre>public void initialise(<a href="../../../jcgp/backend/function/Function.html" title="class in jcgp.backend.function">Function</a> newFunction,
<a href="../../../jcgp/backend/population/Connection.html" title="interface in jcgp.backend.population">Connection</a>... newConnections)</pre>
<div class="block">Initialises the node with the specified values.
The number of connections passed as argument must
be exactly the same as the experiment arity, or
an <code>IllegalArgumentException</code> will be thrown.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>newFunction</code> - the node function to set.</dd>
<dd><code>newConnections</code> - the node connections to set.</dd>
</dl>
</li>
</ul>
<a name="getColumn--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getColumn</h4>
<pre>public int getColumn()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this node's column.</dd>
</dl>
</li>
</ul>
<a name="getRow--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRow</h4>
<pre>public int getRow()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this node's row.</dd>
</dl>
</li>
</ul>
<a name="getFunction--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFunction</h4>
<pre>public <a href="../../../jcgp/backend/function/Function.html" title="class in jcgp.backend.function">Function</a> getFunction()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this node's function.</dd>
</dl>
</li>
</ul>
<a name="getConnection-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConnection</h4>
<pre>public <a href="../../../jcgp/backend/population/Connection.html" title="interface in jcgp.backend.population">Connection</a> getConnection(int index)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - the connection to return.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the indexed connection.</dd>
</dl>
</li>
</ul>
<a name="copyOf-jcgp.backend.population.MutableElement-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>copyOf</h4>
<pre>public boolean copyOf(<a href="../../../jcgp/backend/population/MutableElement.html" title="interface in jcgp.backend.population">MutableElement</a> element)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../jcgp/backend/population/MutableElement.html#copyOf-jcgp.backend.population.MutableElement-">MutableElement</a></code></span></div>
<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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../jcgp/backend/population/MutableElement.html#copyOf-jcgp.backend.population.MutableElement-">copyOf</a></code> in interface <code><a href="../../../jcgp/backend/population/MutableElement.html" title="interface in jcgp.backend.population">MutableElement</a></code></dd>
<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>
<a name="getValue--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValue</h4>
<pre>public java.lang.Object getValue()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../jcgp/backend/population/Connection.html#getValue--">Connection</a></code></span></div>
<div class="block">Compute and return the value of this connection. In
the case of inputs no computation is necessary, this
simply returns the value the input is set to. In the
case of nodes, the value is computed based on the
node's function and the value of its own connections.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../jcgp/backend/population/Connection.html#getValue--">getValue</a></code> in interface <code><a href="../../../jcgp/backend/population/Connection.html" title="interface in jcgp.backend.population">Connection</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the connection's value.</dd>
</dl>
</li>
</ul>
<a name="setConnection-int-jcgp.backend.population.Connection-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setConnection</h4>
<pre>public void setConnection(int index,
<a href="../../../jcgp/backend/population/Connection.html" title="interface in jcgp.backend.population">Connection</a> newConnection)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../jcgp/backend/population/MutableElement.html#setConnection-int-jcgp.backend.population.Connection-">MutableElement</a></code></span></div>
<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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../jcgp/backend/population/MutableElement.html#setConnection-int-jcgp.backend.population.Connection-">setConnection</a></code> in interface <code><a href="../../../jcgp/backend/population/MutableElement.html" title="interface in jcgp.backend.population">MutableElement</a></code></dd>
<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="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public java.lang.String toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code> in class <code>java.lang.Object</code></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/Node.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/MutableElement.html" title="interface in jcgp.backend.population"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../jcgp/backend/population/Output.html" title="class in jcgp.backend.population"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?jcgp/backend/population/Node.html" target="_top">Frames</a></li>
<li><a href="Node.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>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>