diff options
| author | Eduardo Pedroni <ep625@york.ac.uk> | 2014-05-06 14:29:37 +0100 |
|---|---|---|
| committer | Eduardo Pedroni <ep625@york.ac.uk> | 2014-05-06 14:29:37 +0100 |
| commit | 8189116ea4b5db4675e31dfd04a5687d55e29262 (patch) | |
| tree | c1815021452a888f8838f1628d8fb4689777e73e /doc/jcgp/backend/function/Function.html | |
| parent | aa9e74e7f67789f6353fc26e02ee8e68e40609a2 (diff) | |
Added javadocs, made minor changes to the comments
Diffstat (limited to 'doc/jcgp/backend/function/Function.html')
| -rw-r--r-- | doc/jcgp/backend/function/Function.html | 310 |
1 files changed, 310 insertions, 0 deletions
diff --git a/doc/jcgp/backend/function/Function.html b/doc/jcgp/backend/function/Function.html new file mode 100644 index 0000000..e08145b --- /dev/null +++ b/doc/jcgp/backend/function/Function.html @@ -0,0 +1,310 @@ +<!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:07 BST 2014 --> +<title>Function</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="Function"; + } + } + 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/Function.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/function/DigitalCircuitFunctions.Xor.html" title="class in jcgp.backend.function"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../jcgp/backend/function/FunctionSet.html" title="class in jcgp.backend.function"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?jcgp/backend/function/Function.html" target="_top">Frames</a></li> +<li><a href="Function.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.function</div> +<h2 title="Class Function" class="title">Class Function</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>jcgp.backend.function.Function</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../jcgp/backend/function/DigitalCircuitFunctions.And.html" title="class in jcgp.backend.function">DigitalCircuitFunctions.And</a>, <a href="../../../jcgp/backend/function/DigitalCircuitFunctions.AndNotA.html" title="class in jcgp.backend.function">DigitalCircuitFunctions.AndNotA</a>, <a href="../../../jcgp/backend/function/DigitalCircuitFunctions.AndNotB.html" title="class in jcgp.backend.function">DigitalCircuitFunctions.AndNotB</a>, <a href="../../../jcgp/backend/function/DigitalCircuitFunctions.ConstantOne.html" title="class in jcgp.backend.function">DigitalCircuitFunctions.ConstantOne</a>, <a href="../../../jcgp/backend/function/DigitalCircuitFunctions.ConstantZero.html" title="class in jcgp.backend.function">DigitalCircuitFunctions.ConstantZero</a>, <a href="../../../jcgp/backend/function/DigitalCircuitFunctions.Mux1.html" title="class in jcgp.backend.function">DigitalCircuitFunctions.Mux1</a>, <a href="../../../jcgp/backend/function/DigitalCircuitFunctions.Mux2.html" title="class in jcgp.backend.function">DigitalCircuitFunctions.Mux2</a>, <a href="../../../jcgp/backend/function/DigitalCircuitFunctions.Mux3.html" title="class in jcgp.backend.function">DigitalCircuitFunctions.Mux3</a>, <a href="../../../jcgp/backend/function/DigitalCircuitFunctions.Mux4.html" title="class in jcgp.backend.function">DigitalCircuitFunctions.Mux4</a>, <a href="../../../jcgp/backend/function/DigitalCircuitFunctions.Nand.html" title="class in jcgp.backend.function">DigitalCircuitFunctions.Nand</a>, <a href="../../../jcgp/backend/function/DigitalCircuitFunctions.Nor.html" title="class in jcgp.backend.function">DigitalCircuitFunctions.Nor</a>, <a href="../../../jcgp/backend/function/DigitalCircuitFunctions.NotA.html" title="class in jcgp.backend.function">DigitalCircuitFunctions.NotA</a>, <a href="../../../jcgp/backend/function/DigitalCircuitFunctions.NotB.html" title="class in jcgp.backend.function">DigitalCircuitFunctions.NotB</a>, <a href="../../../jcgp/backend/function/DigitalCircuitFunctions.Or.html" title="class in jcgp.backend.function">DigitalCircuitFunctions.Or</a>, <a href="../../../jcgp/backend/function/DigitalCircuitFunctions.OrNotA.html" title="class in jcgp.backend.function">DigitalCircuitFunctions.OrNotA</a>, <a href="../../../jcgp/backend/function/DigitalCircuitFunctions.OrNotB.html" title="class in jcgp.backend.function">DigitalCircuitFunctions.OrNotB</a>, <a href="../../../jcgp/backend/function/DigitalCircuitFunctions.WireA.html" title="class in jcgp.backend.function">DigitalCircuitFunctions.WireA</a>, <a href="../../../jcgp/backend/function/DigitalCircuitFunctions.WireB.html" title="class in jcgp.backend.function">DigitalCircuitFunctions.WireB</a>, <a href="../../../jcgp/backend/function/DigitalCircuitFunctions.Xnor.html" title="class in jcgp.backend.function">DigitalCircuitFunctions.Xnor</a>, <a href="../../../jcgp/backend/function/DigitalCircuitFunctions.Xor.html" title="class in jcgp.backend.function">DigitalCircuitFunctions.Xor</a>, <a href="../../../jcgp/backend/function/SymbolicRegressionFunctions.Absolute.html" title="class in jcgp.backend.function">SymbolicRegressionFunctions.Absolute</a>, <a href="../../../jcgp/backend/function/SymbolicRegressionFunctions.Addition.html" title="class in jcgp.backend.function">SymbolicRegressionFunctions.Addition</a>, <a href="../../../jcgp/backend/function/SymbolicRegressionFunctions.Cosine.html" title="class in jcgp.backend.function">SymbolicRegressionFunctions.Cosine</a>, <a href="../../../jcgp/backend/function/SymbolicRegressionFunctions.CosineAB.html" title="class in jcgp.backend.function">SymbolicRegressionFunctions.CosineAB</a>, <a href="../../../jcgp/backend/function/SymbolicRegressionFunctions.Division.html" title="class in jcgp.backend.function">SymbolicRegressionFunctions.Division</a>, <a href="../../../jcgp/backend/function/SymbolicRegressionFunctions.Exponential.html" title="class in jcgp.backend.function">SymbolicRegressionFunctions.Exponential</a>, <a href="../../../jcgp/backend/function/SymbolicRegressionFunctions.HyperbolicCosine.html" title="class in jcgp.backend.function">SymbolicRegressionFunctions.HyperbolicCosine</a>, <a href="../../../jcgp/backend/function/SymbolicRegressionFunctions.HyperbolicSine.html" title="class in jcgp.backend.function">SymbolicRegressionFunctions.HyperbolicSine</a>, <a href="../../../jcgp/backend/function/SymbolicRegressionFunctions.HyperbolicTangent.html" title="class in jcgp.backend.function">SymbolicRegressionFunctions.HyperbolicTangent</a>, <a href="../../../jcgp/backend/function/SymbolicRegressionFunctions.Hypotenuse.html" title="class in jcgp.backend.function">SymbolicRegressionFunctions.Hypotenuse</a>, <a href="../../../jcgp/backend/function/SymbolicRegressionFunctions.LogBaseTen.html" title="class in jcgp.backend.function">SymbolicRegressionFunctions.LogBaseTen</a>, <a href="../../../jcgp/backend/function/SymbolicRegressionFunctions.Multiplication.html" title="class in jcgp.backend.function">SymbolicRegressionFunctions.Multiplication</a>, <a href="../../../jcgp/backend/function/SymbolicRegressionFunctions.NaturalLog.html" title="class in jcgp.backend.function">SymbolicRegressionFunctions.NaturalLog</a>, <a href="../../../jcgp/backend/function/SymbolicRegressionFunctions.Power.html" title="class in jcgp.backend.function">SymbolicRegressionFunctions.Power</a>, <a href="../../../jcgp/backend/function/SymbolicRegressionFunctions.Reciprocal.html" title="class in jcgp.backend.function">SymbolicRegressionFunctions.Reciprocal</a>, <a href="../../../jcgp/backend/function/SymbolicRegressionFunctions.Sine.html" title="class in jcgp.backend.function">SymbolicRegressionFunctions.Sine</a>, <a href="../../../jcgp/backend/function/SymbolicRegressionFunctions.SineAB.html" title="class in jcgp.backend.function">SymbolicRegressionFunctions.SineAB</a>, <a href="../../../jcgp/backend/function/SymbolicRegressionFunctions.SquareRoot.html" title="class in jcgp.backend.function">SymbolicRegressionFunctions.SquareRoot</a>, <a href="../../../jcgp/backend/function/SymbolicRegressionFunctions.Subtraction.html" title="class in jcgp.backend.function">SymbolicRegressionFunctions.Subtraction</a>, <a href="../../../jcgp/backend/function/SymbolicRegressionFunctions.Tangent.html" title="class in jcgp.backend.function">SymbolicRegressionFunctions.Tangent</a>, <a href="../../../jcgp/backend/function/TravellingSalesmanFunctions.AbsoluteCosineAB.html" title="class in jcgp.backend.function">TravellingSalesmanFunctions.AbsoluteCosineAB</a>, <a href="../../../jcgp/backend/function/TravellingSalesmanFunctions.AbsoluteHyperbolicTangentAB.html" title="class in jcgp.backend.function">TravellingSalesmanFunctions.AbsoluteHyperbolicTangentAB</a>, <a href="../../../jcgp/backend/function/TravellingSalesmanFunctions.AbsoluteSineAB.html" title="class in jcgp.backend.function">TravellingSalesmanFunctions.AbsoluteSineAB</a>, <a href="../../../jcgp/backend/function/TravellingSalesmanFunctions.BoundedDivision.html" title="class in jcgp.backend.function">TravellingSalesmanFunctions.BoundedDivision</a>, <a href="../../../jcgp/backend/function/TravellingSalesmanFunctions.Cube.html" title="class in jcgp.backend.function">TravellingSalesmanFunctions.Cube</a>, <a href="../../../jcgp/backend/function/TravellingSalesmanFunctions.Multiplication.html" title="class in jcgp.backend.function">TravellingSalesmanFunctions.Multiplication</a>, <a href="../../../jcgp/backend/function/TravellingSalesmanFunctions.ScaledAddition.html" title="class in jcgp.backend.function">TravellingSalesmanFunctions.ScaledAddition</a>, <a href="../../../jcgp/backend/function/TravellingSalesmanFunctions.ScaledExponential.html" title="class in jcgp.backend.function">TravellingSalesmanFunctions.ScaledExponential</a>, <a href="../../../jcgp/backend/function/TravellingSalesmanFunctions.ScaledHypotenuse.html" title="class in jcgp.backend.function">TravellingSalesmanFunctions.ScaledHypotenuse</a>, <a href="../../../jcgp/backend/function/TravellingSalesmanFunctions.Square.html" title="class in jcgp.backend.function">TravellingSalesmanFunctions.Square</a>, <a href="../../../jcgp/backend/function/TravellingSalesmanFunctions.SquaredMultiplication.html" title="class in jcgp.backend.function">TravellingSalesmanFunctions.SquaredMultiplication</a>, <a href="../../../jcgp/backend/function/TravellingSalesmanFunctions.SquareRoot.html" title="class in jcgp.backend.function">TravellingSalesmanFunctions.SquareRoot</a>, <a href="../../../jcgp/backend/function/TravellingSalesmanFunctions.SymmetricSubtraction.html" title="class in jcgp.backend.function">TravellingSalesmanFunctions.SymmetricSubtraction</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="typeNameLabel">Function</span> +extends java.lang.Object</pre> +<div class="block">Function is a callback wrapper. + <br><br> + A concrete implementation of Function overrides <code>run()</code> to perform + any arbitrary operation on the arguments specified. It must also override + <code>getArity()</code> to return the function arity.</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/function/Function.html#Function--">Function</a></span>()</code> </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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>abstract int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/function/Function.html#getArity--">getArity</a></span>()</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>abstract java.lang.Object</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/function/Function.html#run-java.lang.Object...-">run</a></span>(java.lang.Object... args)</code> +<div class="block">Executes the function.</div> +</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, toString, 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="Function--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Function</h4> +<pre>public Function()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="run-java.lang.Object...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>run</h4> +<pre>public abstract java.lang.Object run(java.lang.Object... args)</pre> +<div class="block">Executes the function.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>args</code> - the function arguments.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the function result.</dd> +</dl> +</li> +</ul> +<a name="getArity--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getArity</h4> +<pre>public abstract int getArity()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the arity of the function.</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/Function.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/function/DigitalCircuitFunctions.Xor.html" title="class in jcgp.backend.function"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../jcgp/backend/function/FunctionSet.html" title="class in jcgp.backend.function"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?jcgp/backend/function/Function.html" target="_top">Frames</a></li> +<li><a href="Function.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> |