diff options
| author | Eduardo Pedroni <ep625@york.ac.uk> | 2014-05-22 07:44:52 +0100 |
|---|---|---|
| committer | Eduardo Pedroni <ep625@york.ac.uk> | 2014-05-22 07:44:52 +0100 |
| commit | 2b571f08d091dc062cedbb9816c29dcf0cbd4f12 (patch) | |
| tree | 98505fe5fbd433eafe74a188f833b71a4627e08f /doc/jcgp/backend/population/Output.html | |
| parent | 9aac9892b5c827e70c4598e0e052d10aad40a2d9 (diff) | |
Final commit, will release later today.
Diffstat (limited to 'doc/jcgp/backend/population/Output.html')
| -rw-r--r-- | doc/jcgp/backend/population/Output.html | 99 |
1 files changed, 70 insertions, 29 deletions
diff --git a/doc/jcgp/backend/population/Output.html b/doc/jcgp/backend/population/Output.html index 912b2bb..98897d4 100644 --- a/doc/jcgp/backend/population/Output.html +++ b/doc/jcgp/backend/population/Output.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_05) on Mon May 12 23:05:44 BST 2014 --> +<!-- Generated by javadoc (1.8.0_05) on Thu May 22 06:02:32 BST 2014 --> <title>Output</title> -<meta name="date" content="2014-05-12"> +<meta name="date" content="2014-05-22"> <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../../script.js"></script> </head> @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10}; +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -120,7 +120,11 @@ implements <a href="../../../jcgp/backend/population/Mutable.html" title="interf type of mutable element with a single connection. It returns the value of its single connection, but it may not be connected to - it terminates a chromosome - active connection path.</div> + active connection path. + <br><br> + When mutating an output, it is easiest to use <code>mutate()</code>. + Alternatively, you may also perform a specific mutation using + <code>setSource(...)</code>.</div> <dl> <dt><span class="simpleTagLabel">Author:</span></dt> <dd>Eduardo Pedroni</dd> @@ -193,7 +197,10 @@ implements <a href="../../../jcgp/backend/population/Mutable.html" title="interf </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/Output.html#getActiveNodes-java.util.ArrayList-">getActiveNodes</a></span>(java.util.ArrayList<<a href="../../../jcgp/backend/population/Node.html" title="class in jcgp.backend.population">Node</a>> activeNodes)</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/population/Output.html#getActiveNodes-java.util.ArrayList-">getActiveNodes</a></span>(java.util.ArrayList<<a href="../../../jcgp/backend/population/Node.html" title="class in jcgp.backend.population">Node</a>> activeNodes)</code> +<div class="block">Calls <code>getActive(...)</code> on this output's + source.</div> +</td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code>int</code></td> @@ -205,14 +212,17 @@ implements <a href="../../../jcgp/backend/population/Mutable.html" title="interf </tr> <tr id="i5" class="rowColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/population/Output.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">When mutating an output, the index parameter - is simply ignored and the output source is - set.</div> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/population/Output.html#mutate--">mutate</a></span>()</code> +<div class="block">This method performs an arbitrary mutation on the <code>Mutable</code>.</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/Output.html#setSource-jcgp.backend.population.Connection-">setSource</a></span>(<a href="../../../jcgp/backend/population/Connection.html" title="interface in jcgp.backend.population">Connection</a> newConnection)</code> +<div class="block">This method sets the output source to the specified connection.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/population/Output.html#toString--">toString</a></span>()</code> </td> </tr> @@ -283,45 +293,54 @@ implements <a href="../../../jcgp/backend/population/Mutable.html" title="interf <li class="blockList"> <h4>getIndex</h4> <pre>public int getIndex()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this output's index.</dd> +</dl> </li> </ul> -<a name="getSource--"> +<a name="setSource-jcgp.backend.population.Connection-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>getSource</h4> -<pre>public <a href="../../../jcgp/backend/population/Connection.html" title="interface in jcgp.backend.population">Connection</a> getSource()</pre> +<h4>setSource</h4> +<pre>public void setSource(<a href="../../../jcgp/backend/population/Connection.html" title="interface in jcgp.backend.population">Connection</a> newConnection)</pre> +<div class="block">This method sets the output source to the specified connection.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>newConnection</code> - the <code>Connection</code> to connect to.</dd> +</dl> </li> </ul> -<a name="getActiveNodes-java.util.ArrayList-"> +<a name="getSource--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>getActiveNodes</h4> -<pre>public void getActiveNodes(java.util.ArrayList<<a href="../../../jcgp/backend/population/Node.html" title="class in jcgp.backend.population">Node</a>> activeNodes)</pre> +<h4>getSource</h4> +<pre>public <a href="../../../jcgp/backend/population/Connection.html" title="interface in jcgp.backend.population">Connection</a> getSource()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the source of this output's value.</dd> +</dl> </li> </ul> -<a name="setConnection-int-jcgp.backend.population.Connection-"> +<a name="getActiveNodes-java.util.ArrayList-"> <!-- --> </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">When mutating an output, the index parameter - is simply ignored and the output source is - set.</div> +<h4>getActiveNodes</h4> +<pre>public void getActiveNodes(java.util.ArrayList<<a href="../../../jcgp/backend/population/Node.html" title="class in jcgp.backend.population">Node</a>> activeNodes)</pre> +<div class="block">Calls <code>getActive(...)</code> on this output's + source. This kicks off a recursive process whereby + all nodes connected to this output are added to the + specified list of nodes. This is used to create a + list of all active nodes.</div> <dl> -<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> -<dd><code><a href="../../../jcgp/backend/population/Mutable.html#setConnection-int-jcgp.backend.population.Connection-">setConnection</a></code> in interface <code><a href="../../../jcgp/backend/population/Mutable.html" title="interface in jcgp.backend.population">Mutable</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> -<dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../../jcgp/backend/population/Mutable.html#setConnection-int-jcgp.backend.population.Connection-"><code>Mutable.setConnection(int, jcgp.backend.population.Connection)</code></a></dd> +<dd><code>activeNodes</code> - the list to add all active nodes to.</dd> </dl> </li> </ul> @@ -361,6 +380,28 @@ implements <a href="../../../jcgp/backend/population/Mutable.html" title="interf </dl> </li> </ul> +<a name="mutate--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>mutate</h4> +<pre>public void mutate()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../jcgp/backend/population/Mutable.html#mutate--">Mutable</a></code></span></div> +<div class="block">This method performs an arbitrary mutation on the <code>Mutable</code>. + <br><br> + In the case of nodes, this chooses to mutate a function or connection + fairly, and carries out the required mutation by using the node's own + reference to chromosome. + <br><br> + In the case of outputs, this simply picks a random connection to serve + as the source - any connection is allowed.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../jcgp/backend/population/Mutable.html#mutate--">mutate</a></code> in interface <code><a href="../../../jcgp/backend/population/Mutable.html" title="interface in jcgp.backend.population">Mutable</a></code></dd> +</dl> +</li> +</ul> <a name="toString--"> <!-- --> </a> |