diff options
| author | Eduardo Pedroni <e.pedroni91@gmail.com> | 2014-10-18 15:21:45 +0200 |
|---|---|---|
| committer | Eduardo Pedroni <e.pedroni91@gmail.com> | 2014-10-18 15:21:45 +0200 |
| commit | 4f26361eb08aa09334d1eea0a124110c20d809ce (patch) | |
| tree | ea2652193f376eee5c9c44776895378b123be7c8 /doc/jcgp/backend/population/Output.html | |
| parent | fc0f9ce2aa46444ff69e89e9b9e09f3610eedd74 (diff) | |
Moved javadocs to a different repository for hosting, updated README
Diffstat (limited to 'doc/jcgp/backend/population/Output.html')
| -rw-r--r-- | doc/jcgp/backend/population/Output.html | 488 |
1 files changed, 0 insertions, 488 deletions
diff --git a/doc/jcgp/backend/population/Output.html b/doc/jcgp/backend/population/Output.html deleted file mode 100644 index 98897d4..0000000 --- a/doc/jcgp/backend/population/Output.html +++ /dev/null @@ -1,488 +0,0 @@ -<!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 Thu May 22 06:02:32 BST 2014 --> -<title>Output</title> -<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> -<body> -<script type="text/javascript"><!-- - try { - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Output"; - } - } - catch(err) { - } -//--> -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"; -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/Output.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/Node.html" title="class in jcgp.backend.population"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../jcgp/backend/population/Population.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/Output.html" target="_top">Frames</a></li> -<li><a href="Output.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 Output" class="title">Class Output</h2> -</div> -<div class="contentContainer"> -<ul class="inheritance"> -<li>java.lang.Object</li> -<li> -<ul class="inheritance"> -<li>jcgp.backend.population.Output</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/Mutable.html" title="interface in jcgp.backend.population">Mutable</a></dd> -</dl> -<hr> -<br> -<pre>public class <span class="typeNameLabel">Output</span> -extends java.lang.Object -implements <a href="../../../jcgp/backend/population/Mutable.html" title="interface in jcgp.backend.population">Mutable</a></pre> -<div class="block">This is a chromosome output. Outputs are a special - 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. - <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> -</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/Output.html#Output-jcgp.backend.population.Chromosome-int-">Output</a></span>(<a href="../../../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Chromosome</a> chromosome, - int index)</code> -<div class="block">Makes a new instance of <code>Output</code> with the - specified arguments.</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>java.lang.Object</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/population/Output.html#calculate--">calculate</a></span>()</code> </td> -</tr> -<tr id="i1" class="rowColor"> -<td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/population/Output.html#copyOf-jcgp.backend.population.Mutable-">copyOf</a></span>(<a href="../../../jcgp/backend/population/Mutable.html" title="interface in jcgp.backend.population">Mutable</a> m)</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="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> -<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> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/population/Output.html#getIndex--">getIndex</a></span>()</code> </td> -</tr> -<tr id="i4" 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/Output.html#getSource--">getSource</a></span>()</code> </td> -</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#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> -</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="Output-jcgp.backend.population.Chromosome-int-"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>Output</h4> -<pre>public Output(<a href="../../../jcgp/backend/population/Chromosome.html" title="class in jcgp.backend.population">Chromosome</a> chromosome, - int index)</pre> -<div class="block">Makes a new instance of <code>Output</code> with the - specified arguments.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>chromosome</code> - the chromosome this output belongs to.</dd> -<dd><code>index</code> - the output index.</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="calculate--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>calculate</h4> -<pre>public java.lang.Object calculate()</pre> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the value of the output's source.</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>this output's index.</dd> -</dl> -</li> -</ul> -<a name="setSource-jcgp.backend.population.Connection-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<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="getSource--"> -<!-- --> -</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> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the source of this output's value.</dd> -</dl> -</li> -</ul> -<a name="getActiveNodes-java.util.ArrayList-"> -<!-- --> -</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> -<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="paramLabel">Parameters:</span></dt> -<dd><code>activeNodes</code> - the list to add all active nodes to.</dd> -</dl> -</li> -</ul> -<a name="copyOf-jcgp.backend.population.Mutable-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>copyOf</h4> -<pre>public boolean copyOf(<a href="../../../jcgp/backend/population/Mutable.html" title="interface in jcgp.backend.population">Mutable</a> m)</pre> -<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../jcgp/backend/population/Mutable.html#copyOf-jcgp.backend.population.Mutable-">Mutable</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/Mutable.html#copyOf-jcgp.backend.population.Mutable-">copyOf</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>m</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="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> -<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/Output.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/Node.html" title="class in jcgp.backend.population"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../jcgp/backend/population/Population.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/Output.html" target="_top">Frames</a></li> -<li><a href="Output.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> |