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/resources/Resources.html | |
| parent | aa9e74e7f67789f6353fc26e02ee8e68e40609a2 (diff) | |
Added javadocs, made minor changes to the comments
Diffstat (limited to 'doc/jcgp/backend/resources/Resources.html')
| -rw-r--r-- | doc/jcgp/backend/resources/Resources.html | 804 |
1 files changed, 804 insertions, 0 deletions
diff --git a/doc/jcgp/backend/resources/Resources.html b/doc/jcgp/backend/resources/Resources.html new file mode 100644 index 0000000..0f7e40a --- /dev/null +++ b/doc/jcgp/backend/resources/Resources.html @@ -0,0 +1,804 @@ +<!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:05 BST 2014 --> +<title>Resources</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="Resources"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":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/Resources.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/resources/ModifiableResources.html" title="class in jcgp.backend.resources"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?jcgp/backend/resources/Resources.html" target="_top">Frames</a></li> +<li><a href="Resources.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.resources</div> +<h2 title="Class Resources" class="title">Class Resources</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>jcgp.backend.resources.Resources</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../jcgp/backend/resources/ModifiableResources.html" title="class in jcgp.backend.resources">ModifiableResources</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">Resources</span> +extends java.lang.Object</pre> +<div class="block">Encapsulates all of the resources based on which the program operates. + Each instance of JCGP contains a single instance of <code>Resources</code>. + <br><br> + The experiment's <code>Resources</code> object is passed to modules as the program operates, and + the actual parameter values can be obtained using getter methods. Note that, for code brevity, + this class's getters do not start with the word "get". For instance, to get the number of rows, + one would use <code>rows()</code> instead of <code>getRows()</code> which doesn't exist. + The fitness orientation of the problem being solved can also be retrieved using <code>fitnessOrientation()</code>. + Evolutionary strategies will typically use this to perform selection. + <br><br> + In addition to parameters, this class also offers utility methods. Any necessary random numbers + should be obtained using <code>getRandomInt()</code> and <code>getRandomDouble()</code> as these methods + use a particular <code>Random</code> object guaranteed to generate random numbers based on the seed + parameter. Functions from the selected function set can be obtained through this class as well. + Finally, printing to the console should be done via the resources using the report and print + methods, so that these prints also get sent to the GUI console (if one is present).</div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>Eduardo Pedroni</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../jcgp/backend/parameters/Parameter.html" title="class in jcgp.backend.parameters"><code>Parameter</code></a></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/resources/Resources.html#Resources--">Resources</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>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/resources/Resources.html#arity--">arity</a></span>()</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/resources/Resources.html#columns--">columns</a></span>()</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/resources/Resources.html#currentGeneration--">currentGeneration</a></span>()</code> </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/resources/Resources.html#currentRun--">currentRun</a></span>()</code> </td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../jcgp/backend/modules/problem/BestFitness.html" title="enum in jcgp.backend.modules.problem">BestFitness</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/resources/Resources.html#fitnessOrientation--">fitnessOrientation</a></span>()</code> </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/resources/Resources.html#generations--">generations</a></span>()</code> </td> +</tr> +<tr id="i6" 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/resources/Resources.html#getFunction-int-">getFunction</a></span>(int index)</code> +<div class="block">Gets the indexed function out of the + complete set of functions.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/resources/Resources.html#getFunctionIndex-jcgp.backend.function.Function-">getFunctionIndex</a></span>(<a href="../../../jcgp/backend/function/Function.html" title="class in jcgp.backend.function">Function</a> function)</code> +<div class="block">Returns the index of a specified function.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code><a href="../../../jcgp/backend/function/FunctionSet.html" title="class in jcgp.backend.function">FunctionSet</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/resources/Resources.html#getFunctionSet--">getFunctionSet</a></span>()</code> </td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/resources/Resources.html#getRandomDouble--">getRandomDouble</a></span>()</code> +<div class="block">Gets the next random integer using the experiment's random + number generator.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/resources/Resources.html#getRandomDouble-int-">getRandomDouble</a></span>(int limit)</code> +<div class="block">Gets the next random double using the experiment's random + number generator.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<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/resources/Resources.html#getRandomFunction--">getRandomFunction</a></span>()</code> +<div class="block">Gets a random allowed function from the problem function set.</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/resources/Resources.html#getRandomInt-int-">getRandomInt</a></span>(int limit)</code> +<div class="block">Gets the next random integer using the experiment's random + number generator.</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/resources/Resources.html#inputs--">inputs</a></span>()</code> </td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/resources/Resources.html#levelsBack--">levelsBack</a></span>()</code> </td> +</tr> +<tr id="i15" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/resources/Resources.html#nodes--">nodes</a></span>()</code> </td> +</tr> +<tr id="i16" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/resources/Resources.html#outputs--">outputs</a></span>()</code> </td> +</tr> +<tr id="i17" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/resources/Resources.html#populationSize--">populationSize</a></span>()</code> </td> +</tr> +<tr id="i18" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/resources/Resources.html#print-java.lang.String-">print</a></span>(java.lang.String message)</code> +<div class="block">Prints a message to the consoles ignoring + report interval.</div> +</td> +</tr> +<tr id="i19" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/resources/Resources.html#println-java.lang.String-">println</a></span>(java.lang.String message)</code> +<div class="block">Prints a message to the consoles ignoring + report interval.</div> +</td> +</tr> +<tr id="i20" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/resources/Resources.html#report-java.lang.String-">report</a></span>(java.lang.String message)</code> +<div class="block">Prints a message to the consoles taking into account the + report interval parameter.</div> +</td> +</tr> +<tr id="i21" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/resources/Resources.html#reportInterval--">reportInterval</a></span>()</code> </td> +</tr> +<tr id="i22" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/resources/Resources.html#reportln-java.lang.String-">reportln</a></span>(java.lang.String message)</code> +<div class="block">Prints a message to the consoles taking into account the + report interval parameter.</div> +</td> +</tr> +<tr id="i23" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/resources/Resources.html#rows--">rows</a></span>()</code> </td> +</tr> +<tr id="i24" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/resources/Resources.html#runs--">runs</a></span>()</code> </td> +</tr> +<tr id="i25" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/resources/Resources.html#seed--">seed</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, 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="Resources--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Resources</h4> +<pre>public Resources()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="rows--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>rows</h4> +<pre>public int rows()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the number of rows.</dd> +</dl> +</li> +</ul> +<a name="columns--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>columns</h4> +<pre>public int columns()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the number of columns.</dd> +</dl> +</li> +</ul> +<a name="inputs--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>inputs</h4> +<pre>public int inputs()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the number of inputs.</dd> +</dl> +</li> +</ul> +<a name="outputs--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>outputs</h4> +<pre>public int outputs()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the number of outputs.</dd> +</dl> +</li> +</ul> +<a name="populationSize--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>populationSize</h4> +<pre>public int populationSize()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the population size.</dd> +</dl> +</li> +</ul> +<a name="levelsBack--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>levelsBack</h4> +<pre>public int levelsBack()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the levels back value.</dd> +</dl> +</li> +</ul> +<a name="nodes--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>nodes</h4> +<pre>public int nodes()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the total number of nodes.</dd> +</dl> +</li> +</ul> +<a name="currentGeneration--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>currentGeneration</h4> +<pre>public int currentGeneration()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the current generation.</dd> +</dl> +</li> +</ul> +<a name="generations--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>generations</h4> +<pre>public int generations()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the total number of generations.</dd> +</dl> +</li> +</ul> +<a name="currentRun--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>currentRun</h4> +<pre>public int currentRun()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the current run.</dd> +</dl> +</li> +</ul> +<a name="runs--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>runs</h4> +<pre>public int runs()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the total number of runs.</dd> +</dl> +</li> +</ul> +<a name="arity--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>arity</h4> +<pre>public int arity()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the maximum arity out of the function set.</dd> +</dl> +</li> +</ul> +<a name="seed--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>seed</h4> +<pre>public int seed()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the random seed being used.</dd> +</dl> +</li> +</ul> +<a name="reportInterval--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>reportInterval</h4> +<pre>public int reportInterval()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the report interval.</dd> +</dl> +</li> +</ul> +<a name="fitnessOrientation--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fitnessOrientation</h4> +<pre>public <a href="../../../jcgp/backend/modules/problem/BestFitness.html" title="enum in jcgp.backend.modules.problem">BestFitness</a> fitnessOrientation()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the fitness orientation.</dd> +</dl> +</li> +</ul> +<a name="getRandomInt-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRandomInt</h4> +<pre>public int getRandomInt(int limit)</pre> +<div class="block">Gets the next random integer using the experiment's random + number generator. The integer returned will be between 0 (inclusive) + and limit (exclusive).</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>limit</code> - the limit value.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a random integer between 0 and limit.</dd> +</dl> +</li> +</ul> +<a name="getRandomDouble-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRandomDouble</h4> +<pre>public double getRandomDouble(int limit)</pre> +<div class="block">Gets the next random double using the experiment's random + number generator. The double returned will be between 0 (inclusive) + and limit (exclusive).</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>limit</code> - the limit value.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a random double between 0 and limit.</dd> +</dl> +</li> +</ul> +<a name="getRandomDouble--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRandomDouble</h4> +<pre>public double getRandomDouble()</pre> +<div class="block">Gets the next random integer using the experiment's random + number generator. The integer returned will be between 0 (inclusive) + and 1 (exclusive).</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a random integer between 0 and 1.</dd> +</dl> +</li> +</ul> +<a name="getRandomFunction--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRandomFunction</h4> +<pre>public <a href="../../../jcgp/backend/function/Function.html" title="class in jcgp.backend.function">Function</a> getRandomFunction()</pre> +<div class="block">Gets a random allowed function from the problem function set. + This function uses <code>getRandomInt()</code> to choose the random + function.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a random allowed function.</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">Gets the indexed function out of the + complete set of functions.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>index</code> - the function to return.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the indexed function.</dd> +</dl> +</li> +</ul> +<a name="getFunctionSet--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFunctionSet</h4> +<pre>public <a href="../../../jcgp/backend/function/FunctionSet.html" title="class in jcgp.backend.function">FunctionSet</a> getFunctionSet()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the problem's function set.</dd> +</dl> +</li> +</ul> +<a name="getFunctionIndex-jcgp.backend.function.Function-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFunctionIndex</h4> +<pre>public int getFunctionIndex(<a href="../../../jcgp/backend/function/Function.html" title="class in jcgp.backend.function">Function</a> function)</pre> +<div class="block">Returns the index of a specified function. If the function is not found, + -1 is returned.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>function</code> - the function with unknown index.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the index of the function, or -1 if it was not found.</dd> +</dl> +</li> +</ul> +<a name="reportln-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>reportln</h4> +<pre>public void reportln(java.lang.String message)</pre> +<div class="block">Prints a message to the consoles taking into account the + report interval parameter. If no reports are allowed in + the current generation, this does nothing. + <br> + This method automatically appends a line break to the message + being printed.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>message</code> - the message to print.</dd> +</dl> +</li> +</ul> +<a name="report-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>report</h4> +<pre>public void report(java.lang.String message)</pre> +<div class="block">Prints a message to the consoles taking into account the + report interval parameter. If no reports are allowed in + the current generation, this does nothing. + <br> + This method does not append a line break to the message + being printed.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>message</code> - the message to print.</dd> +</dl> +</li> +</ul> +<a name="println-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>println</h4> +<pre>public void println(java.lang.String message)</pre> +<div class="block">Prints a message to the consoles ignoring + report interval. In other words, messages printed + using this method will always appear (though the + GUI console will still need to be flushed). + <br> + This method automatically appends a line break to the message + being printed.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>message</code> - the message to print.</dd> +</dl> +</li> +</ul> +<a name="print-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>print</h4> +<pre>public void print(java.lang.String message)</pre> +<div class="block">Prints a message to the consoles ignoring + report interval. In other words, messages printed + using this method will always appear (though the + GUI console will still need to be flushed). + <br> + This method does not append a line break to the message + being printed.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>message</code> - the message to print.</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/Resources.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/resources/ModifiableResources.html" title="class in jcgp.backend.resources"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?jcgp/backend/resources/Resources.html" target="_top">Frames</a></li> +<li><a href="Resources.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> |