<!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>Input</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="Input"; } } catch(err) { } //--> var methods = {"i0":10,"i1":10,"i2":10,"i3":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/Input.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/Connection.html" title="interface in jcgp.backend.population"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../jcgp/backend/population/Mutable.html" title="interface in jcgp.backend.population"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../index.html?jcgp/backend/population/Input.html" target="_top">Frames</a></li> <li><a href="Input.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 Input" class="title">Class Input</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>jcgp.backend.population.Input</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></dd> </dl> <hr> <br> <pre>public class <span class="typeNameLabel">Input</span> extends java.lang.Object implements <a href="../../../jcgp/backend/population/Connection.html" title="interface in jcgp.backend.population">Connection</a></pre> <div class="block">This is a chromosome input. Inputs are a special type of connection which simply return a set value. They do not have connections and instead provide a starting point for the chromosome's active paths.</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/Input.html#Input-int-">Input</a></span>(int index)</code> <div class="block">Initialises a new input with the current index.</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>int</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/population/Input.html#getIndex--">getIndex</a></span>()</code> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code>java.lang.Object</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/population/Input.html#getValue--">getValue</a></span>()</code> <div class="block">Compute and return the value of this connection.</div> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/population/Input.html#setValue-java.lang.Object-">setValue</a></span>(java.lang.Object newValue)</code> <div class="block">Sets this input's value.</div> </td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/population/Input.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="Input-int-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>Input</h4> <pre>public Input(int index)</pre> <div class="block">Initialises a new input with the current index.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>index</code> - the index of the new input.</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="setValue-java.lang.Object-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setValue</h4> <pre>public void setValue(java.lang.Object newValue)</pre> <div class="block">Sets this input's value. The new value will now be returned by this input's <code>getValue()</code> method.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>newValue</code> - the value to set.</dd> </dl> </li> </ul> <a name="getIndex--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getIndex</h4> <pre>public int getIndex()</pre> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the input's index.</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="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/Input.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/Connection.html" title="interface in jcgp.backend.population"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../jcgp/backend/population/Mutable.html" title="interface in jcgp.backend.population"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../index.html?jcgp/backend/population/Input.html" target="_top">Frames</a></li> <li><a href="Input.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>