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/TravellingSalesmanFunctions.html | |
| parent | aa9e74e7f67789f6353fc26e02ee8e68e40609a2 (diff) | |
Added javadocs, made minor changes to the comments
Diffstat (limited to 'doc/jcgp/backend/function/TravellingSalesmanFunctions.html')
| -rw-r--r-- | doc/jcgp/backend/function/TravellingSalesmanFunctions.html | 357 |
1 files changed, 357 insertions, 0 deletions
diff --git a/doc/jcgp/backend/function/TravellingSalesmanFunctions.html b/doc/jcgp/backend/function/TravellingSalesmanFunctions.html new file mode 100644 index 0000000..fbc5b00 --- /dev/null +++ b/doc/jcgp/backend/function/TravellingSalesmanFunctions.html @@ -0,0 +1,357 @@ +<!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>TravellingSalesmanFunctions</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="TravellingSalesmanFunctions"; + } + } + catch(err) { + } +//--> +</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/TravellingSalesmanFunctions.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/SymbolicRegressionFunctions.Tangent.html" title="class in jcgp.backend.function"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../jcgp/backend/function/TravellingSalesmanFunctions.AbsoluteCosineAB.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/TravellingSalesmanFunctions.html" target="_top">Frames</a></li> +<li><a href="TravellingSalesmanFunctions.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><a href="#nested.class.summary">Nested</a> | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#methods.inherited.from.class.jcgp.backend.function.FunctionSet">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li>Method</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 TravellingSalesmanFunctions" class="title">Class TravellingSalesmanFunctions</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../jcgp/backend/function/FunctionSet.html" title="class in jcgp.backend.function">jcgp.backend.function.FunctionSet</a></li> +<li> +<ul class="inheritance"> +<li>jcgp.backend.function.TravellingSalesmanFunctions</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">TravellingSalesmanFunctions</span> +extends <a href="../../../jcgp/backend/function/FunctionSet.html" title="class in jcgp.backend.function">FunctionSet</a></pre> +<div class="block">This class contains all travelling salesman functions in static nested classes. + <br> + This is the function set to be used by TravellingSalesmanProblem.</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"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested.class.summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/function/TravellingSalesmanFunctions.AbsoluteCosineAB.html" title="class in jcgp.backend.function">TravellingSalesmanFunctions.AbsoluteCosineAB</a></span></code> +<div class="block">Cosine of sum.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/function/TravellingSalesmanFunctions.AbsoluteHyperbolicTangentAB.html" title="class in jcgp.backend.function">TravellingSalesmanFunctions.AbsoluteHyperbolicTangentAB</a></span></code> +<div class="block">Hyperbolic tangent of sum.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/function/TravellingSalesmanFunctions.AbsoluteSineAB.html" title="class in jcgp.backend.function">TravellingSalesmanFunctions.AbsoluteSineAB</a></span></code> +<div class="block">Sine of sum.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/function/TravellingSalesmanFunctions.BoundedDivision.html" title="class in jcgp.backend.function">TravellingSalesmanFunctions.BoundedDivision</a></span></code> +<div class="block">Bounded division, returns the quotient of the two inputs where the larger + is the denominator.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/function/TravellingSalesmanFunctions.Cube.html" title="class in jcgp.backend.function">TravellingSalesmanFunctions.Cube</a></span></code> +<div class="block">Cube function, returns the value of input 0 cubed.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/function/TravellingSalesmanFunctions.Multiplication.html" title="class in jcgp.backend.function">TravellingSalesmanFunctions.Multiplication</a></span></code> +<div class="block">Multiplication returns the product of inputs 0 and 1.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/function/TravellingSalesmanFunctions.ScaledAddition.html" title="class in jcgp.backend.function">TravellingSalesmanFunctions.ScaledAddition</a></span></code> +<div class="block">Scaled addition returns the sum of inputs 0 and 1 scaled + to the range 0 < x > 1.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/function/TravellingSalesmanFunctions.ScaledExponential.html" title="class in jcgp.backend.function">TravellingSalesmanFunctions.ScaledExponential</a></span></code> +<div class="block">Scaled exponential function.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/function/TravellingSalesmanFunctions.ScaledHypotenuse.html" title="class in jcgp.backend.function">TravellingSalesmanFunctions.ScaledHypotenuse</a></span></code> +<div class="block">Scaled hypotenuse function.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/function/TravellingSalesmanFunctions.Square.html" title="class in jcgp.backend.function">TravellingSalesmanFunctions.Square</a></span></code> +<div class="block">Square function, returns the square of the + value of input 0.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/function/TravellingSalesmanFunctions.SquaredMultiplication.html" title="class in jcgp.backend.function">TravellingSalesmanFunctions.SquaredMultiplication</a></span></code> +<div class="block">Multiplication returns the product of inputs 0 and 1, squared.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/function/TravellingSalesmanFunctions.SquareRoot.html" title="class in jcgp.backend.function">TravellingSalesmanFunctions.SquareRoot</a></span></code> +<div class="block">Protected square root function, returns the square root of the absolute + value of input 0.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/function/TravellingSalesmanFunctions.SymmetricSubtraction.html" title="class in jcgp.backend.function">TravellingSalesmanFunctions.SymmetricSubtraction</a></span></code> +<div class="block">Symmetric subtraction returns the absolute difference between inputs 0 and 1, + scaled to the range 0 <; x > 1.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ======== 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/TravellingSalesmanFunctions.html#TravellingSalesmanFunctions--">TravellingSalesmanFunctions</a></span>()</code> +<div class="block">Creates a new instance of TravellingSalesmanFunctions.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.jcgp.backend.function.FunctionSet"> +<!-- --> +</a> +<h3>Methods inherited from class jcgp.backend.function.<a href="../../../jcgp/backend/function/FunctionSet.html" title="class in jcgp.backend.function">FunctionSet</a></h3> +<code><a href="../../../jcgp/backend/function/FunctionSet.html#disableFunction-int-">disableFunction</a>, <a href="../../../jcgp/backend/function/FunctionSet.html#enableFunction-int-">enableFunction</a>, <a href="../../../jcgp/backend/function/FunctionSet.html#getAllowedFunction-int-">getAllowedFunction</a>, <a href="../../../jcgp/backend/function/FunctionSet.html#getAllowedFunctionCount--">getAllowedFunctionCount</a>, <a href="../../../jcgp/backend/function/FunctionSet.html#getFunction-int-">getFunction</a>, <a href="../../../jcgp/backend/function/FunctionSet.html#getMaxArity--">getMaxArity</a>, <a href="../../../jcgp/backend/function/FunctionSet.html#getTotalFunctionCount--">getTotalFunctionCount</a>, <a href="../../../jcgp/backend/function/FunctionSet.html#isEnabled-jcgp.backend.function.Function-">isEnabled</a></code></li> +</ul> +<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="TravellingSalesmanFunctions--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>TravellingSalesmanFunctions</h4> +<pre>public TravellingSalesmanFunctions()</pre> +<div class="block">Creates a new instance of TravellingSalesmanFunctions.</div> +</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/TravellingSalesmanFunctions.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/SymbolicRegressionFunctions.Tangent.html" title="class in jcgp.backend.function"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../jcgp/backend/function/TravellingSalesmanFunctions.AbsoluteCosineAB.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/TravellingSalesmanFunctions.html" target="_top">Frames</a></li> +<li><a href="TravellingSalesmanFunctions.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><a href="#nested.class.summary">Nested</a> | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#methods.inherited.from.class.jcgp.backend.function.FunctionSet">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li>Method</li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> |