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/function/FunctionSet.html | |
| parent | fc0f9ce2aa46444ff69e89e9b9e09f3610eedd74 (diff) | |
Moved javadocs to a different repository for hosting, updated README
Diffstat (limited to 'doc/jcgp/backend/function/FunctionSet.html')
| -rw-r--r-- | doc/jcgp/backend/function/FunctionSet.html | 452 |
1 files changed, 0 insertions, 452 deletions
diff --git a/doc/jcgp/backend/function/FunctionSet.html b/doc/jcgp/backend/function/FunctionSet.html deleted file mode 100644 index 92ee84e..0000000 --- a/doc/jcgp/backend/function/FunctionSet.html +++ /dev/null @@ -1,452 +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:33 BST 2014 --> -<title>FunctionSet</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="FunctionSet"; - } - } - 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/FunctionSet.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/Function.html" title="class in jcgp.backend.function"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../jcgp/backend/function/SymbolicRegressionFunctions.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/FunctionSet.html" target="_top">Frames</a></li> -<li><a href="FunctionSet.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 FunctionSet" class="title">Class FunctionSet</h2> -</div> -<div class="contentContainer"> -<ul class="inheritance"> -<li>java.lang.Object</li> -<li> -<ul class="inheritance"> -<li>jcgp.backend.function.FunctionSet</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.html" title="class in jcgp.backend.function">DigitalCircuitFunctions</a>, <a href="../../../jcgp/backend/function/SymbolicRegressionFunctions.html" title="class in jcgp.backend.function">SymbolicRegressionFunctions</a>, <a href="../../../jcgp/backend/function/TravellingSalesmanFunctions.html" title="class in jcgp.backend.function">TravellingSalesmanFunctions</a></dd> -</dl> -<hr> -<br> -<pre>public abstract class <span class="typeNameLabel">FunctionSet</span> -extends java.lang.Object</pre> -<div class="block">FunctionSet encapsulates a group of functions. This is done to - simplify the implementation of problem types. - <br><br> - FunctionSet contains a variety of useful methods for acquiring general - information, such as the maximum arity across all functions and the total - number of functions. - <br><br> - In addition, FunctionSet offers the ability to enable and disable functions. - Accessing the functions through <code>getAllowedFunction()</code> will return - allowed functions only, providing an easy way to control which functions - can be used in mutations. - <br><br> - An implementation of FunctionSet must simply use its constructor to set - the name field and use <code>registerFunctions()</code> to add the required - functions.</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/FunctionSet.html#FunctionSet--">FunctionSet</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="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>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/function/FunctionSet.html#disableFunction-int-">disableFunction</a></span>(int index)</code> -<div class="block">Disables the indexed function.</div> -</td> -</tr> -<tr id="i1" class="rowColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/function/FunctionSet.html#enableFunction-int-">enableFunction</a></span>(int index)</code> -<div class="block">Disables the indexed function.</div> -</td> -</tr> -<tr id="i2" class="altColor"> -<td class="colFirst"><code><a href="../../../jcgp/backend/function/Function.html" title="class in jcgp.backend.function">Function</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/function/FunctionSet.html#getAllowedFunction-int-">getAllowedFunction</a></span>(int index)</code> -<div class="block">Returns an allowed function.</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/function/FunctionSet.html#getAllowedFunctionCount--">getAllowedFunctionCount</a></span>()</code> </td> -</tr> -<tr id="i4" class="altColor"> -<td class="colFirst"><code><a href="../../../jcgp/backend/function/Function.html" title="class in jcgp.backend.function">Function</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/function/FunctionSet.html#getFunction-int-">getFunction</a></span>(int index)</code> -<div class="block">Returns a function from the complete collection, - enabled or disabled alike.</div> -</td> -</tr> -<tr id="i5" class="rowColor"> -<td class="colFirst"><code>int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/function/FunctionSet.html#getMaxArity--">getMaxArity</a></span>()</code> -<div class="block">Computes and returns the maximum arity out of - all enabled functions.</div> -</td> -</tr> -<tr id="i6" class="altColor"> -<td class="colFirst"><code>int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/function/FunctionSet.html#getTotalFunctionCount--">getTotalFunctionCount</a></span>()</code> </td> -</tr> -<tr id="i7" class="rowColor"> -<td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/function/FunctionSet.html#isEnabled-jcgp.backend.function.Function-">isEnabled</a></span>(<a href="../../../jcgp/backend/function/Function.html" title="class in jcgp.backend.function">Function</a> function)</code> -<div class="block">Checks if a specified function is enabled.</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="FunctionSet--"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>FunctionSet</h4> -<pre>public FunctionSet()</pre> -</li> -</ul> -</li> -</ul> -<!-- ============ METHOD DETAIL ========== --> -<ul class="blockList"> -<li class="blockList"><a name="method.detail"> -<!-- --> -</a> -<h3>Method Detail</h3> -<a name="getAllowedFunctionCount--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getAllowedFunctionCount</h4> -<pre>public int getAllowedFunctionCount()</pre> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the number of currently allowed functions.</dd> -</dl> -</li> -</ul> -<a name="getTotalFunctionCount--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getTotalFunctionCount</h4> -<pre>public int getTotalFunctionCount()</pre> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the total number of functions, including disabled ones.</dd> -</dl> -</li> -</ul> -<a name="getAllowedFunction-int-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getAllowedFunction</h4> -<pre>public <a href="../../../jcgp/backend/function/Function.html" title="class in jcgp.backend.function">Function</a> getAllowedFunction(int index)</pre> -<div class="block">Returns an allowed function. This throws an - ArrayIndexOutOfBoundsException if the supplied - index is beyond the count of allowed functions.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>index</code> - the allowed function index.</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the allowed function object.</dd> -</dl> -</li> -</ul> -<a name="getFunction-int-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getFunction</h4> -<pre>public <a href="../../../jcgp/backend/function/Function.html" title="class in jcgp.backend.function">Function</a> getFunction(int index)</pre> -<div class="block">Returns a function from the complete collection, - enabled or disabled alike. This throws an - ArrayIndexOutOfBoundsException if the supplied - index is beyond the count of allowed functions.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>index</code> - the function index.</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the function object.</dd> -</dl> -</li> -</ul> -<a name="getMaxArity--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getMaxArity</h4> -<pre>public int getMaxArity()</pre> -<div class="block">Computes and returns the maximum arity out of - all enabled functions.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the problem's current maximum arity.</dd> -</dl> -</li> -</ul> -<a name="disableFunction-int-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>disableFunction</h4> -<pre>public void disableFunction(int index)</pre> -<div class="block">Disables the indexed function. If the function - is already disabled, this does nothing.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>index</code> - the function to disable.</dd> -</dl> -</li> -</ul> -<a name="enableFunction-int-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>enableFunction</h4> -<pre>public void enableFunction(int index)</pre> -<div class="block">Disables the indexed function. If the function is - already enabled, this does nothing.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>index</code> - the function to disable.</dd> -</dl> -</li> -</ul> -<a name="isEnabled-jcgp.backend.function.Function-"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>isEnabled</h4> -<pre>public boolean isEnabled(<a href="../../../jcgp/backend/function/Function.html" title="class in jcgp.backend.function">Function</a> function)</pre> -<div class="block">Checks if a specified function is enabled. If the function - does not belong in the FunctionSet, this returns false.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>function</code> - the function to check.</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>true if the function is enabled.</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/FunctionSet.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/Function.html" title="class in jcgp.backend.function"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../jcgp/backend/function/SymbolicRegressionFunctions.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/FunctionSet.html" target="_top">Frames</a></li> -<li><a href="FunctionSet.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> |