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/index-files/index-9.html | |
| parent | aa9e74e7f67789f6353fc26e02ee8e68e40609a2 (diff) | |
Added javadocs, made minor changes to the comments
Diffstat (limited to 'doc/index-files/index-9.html')
| -rw-r--r-- | doc/index-files/index-9.html | 206 |
1 files changed, 206 insertions, 0 deletions
diff --git a/doc/index-files/index-9.html b/doc/index-files/index-9.html new file mode 100644 index 0000000..fcefb3b --- /dev/null +++ b/doc/index-files/index-9.html @@ -0,0 +1,206 @@ +<!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>I-Index</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="I-Index"; + } + } + 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>Package</li> +<li>Class</li> +<li>Use</li> +<li><a href="../overview-tree.html">Tree</a></li> +<li><a href="../deprecated-list.html">Deprecated</a></li> +<li class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-8.html">Prev Letter</a></li> +<li><a href="index-10.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-files/index-9.html" target="_top">Frames</a></li> +<li><a href="index-9.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> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="contentContainer"><a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">R</a> <a href="index-17.html">S</a> <a href="index-18.html">T</a> <a href="index-19.html">U</a> <a href="index-20.html">V</a> <a href="index-21.html">W</a> <a href="index-22.html">X</a> <a name="I:I"> +<!-- --> +</a> +<h2 class="title">I</h2> +<dl> +<dt><span class="memberNameLink"><a href="../jcgp/backend/resources/ModifiableResources.html#incrementGeneration--">incrementGeneration()</a></span> - Method in class jcgp.backend.resources.<a href="../jcgp/backend/resources/ModifiableResources.html" title="class in jcgp.backend.resources">ModifiableResources</a></dt> +<dd> +<div class="block">Adds 1 to the current generation.</div> +</dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/resources/ModifiableResources.html#incrementRun--">incrementRun()</a></span> - Method in class jcgp.backend.resources.<a href="../jcgp/backend/resources/ModifiableResources.html" title="class in jcgp.backend.resources">ModifiableResources</a></dt> +<dd> +<div class="block">Adds 1 to the current generation.</div> +</dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/population/Node.html#initialise-jcgp.backend.function.Function-jcgp.backend.population.Connection...-">initialise(Function, Connection...)</a></span> - Method in class jcgp.backend.population.<a href="../jcgp/backend/population/Node.html" title="class in jcgp.backend.population">Node</a></dt> +<dd> +<div class="block">Initialises the node with the specified values.</div> +</dd> +<dt><a href="../jcgp/backend/population/Input.html" title="class in jcgp.backend.population"><span class="typeNameLink">Input</span></a> - Class in <a href="../jcgp/backend/population/package-summary.html">jcgp.backend.population</a></dt> +<dd> +<div class="block">This is a chromosome input.</div> +</dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/population/Input.html#Input-int-">Input(int)</a></span> - Constructor for class jcgp.backend.population.<a href="../jcgp/backend/population/Input.html" title="class in jcgp.backend.population">Input</a></dt> +<dd> +<div class="block">Initialises a new input with the current index.</div> +</dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/resources/Resources.html#inputs--">inputs()</a></span> - Method in class jcgp.backend.resources.<a href="../jcgp/backend/resources/Resources.html" title="class in jcgp.backend.resources">Resources</a></dt> +<dd> </dd> +<dt><a href="../jcgp/backend/parameters/monitors/IntegerMonitor.html" title="class in jcgp.backend.parameters.monitors"><span class="typeNameLink">IntegerMonitor</span></a> - Class in <a href="../jcgp/backend/parameters/monitors/package-summary.html">jcgp.backend.parameters.monitors</a></dt> +<dd> +<div class="block">This is a special type of <code>IntegerParameter</code> which + cannot be modified in the GUI (if the GUI is in use).</div> +</dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/parameters/monitors/IntegerMonitor.html#IntegerMonitor-int-java.lang.String-">IntegerMonitor(int, String)</a></span> - Constructor for class jcgp.backend.parameters.monitors.<a href="../jcgp/backend/parameters/monitors/IntegerMonitor.html" title="class in jcgp.backend.parameters.monitors">IntegerMonitor</a></dt> +<dd> +<div class="block">Creates a new instance of this class, assuming the monitor + is not critical.</div> +</dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/parameters/monitors/IntegerMonitor.html#IntegerMonitor-int-java.lang.String-boolean-">IntegerMonitor(int, String, boolean)</a></span> - Constructor for class jcgp.backend.parameters.monitors.<a href="../jcgp/backend/parameters/monitors/IntegerMonitor.html" title="class in jcgp.backend.parameters.monitors">IntegerMonitor</a></dt> +<dd> +<div class="block">Creates a new instance of this class.</div> +</dd> +<dt><a href="../jcgp/backend/parameters/IntegerParameter.html" title="class in jcgp.backend.parameters"><span class="typeNameLink">IntegerParameter</span></a> - Class in <a href="../jcgp/backend/parameters/package-summary.html">jcgp.backend.parameters</a></dt> +<dd> +<div class="block">Parameter subclass for the double type.</div> +</dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/parameters/IntegerParameter.html#IntegerParameter-int-java.lang.String-">IntegerParameter(int, String)</a></span> - Constructor for class jcgp.backend.parameters.<a href="../jcgp/backend/parameters/IntegerParameter.html" title="class in jcgp.backend.parameters">IntegerParameter</a></dt> +<dd> +<div class="block">Creates a new instance of this class, assuming the parameter + is not critical.</div> +</dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/parameters/IntegerParameter.html#IntegerParameter-int-java.lang.String-boolean-">IntegerParameter(int, String, boolean)</a></span> - Constructor for class jcgp.backend.parameters.<a href="../jcgp/backend/parameters/IntegerParameter.html" title="class in jcgp.backend.parameters">IntegerParameter</a></dt> +<dd> +<div class="block">Creates a new instance of this class.</div> +</dd> +<dt><span class="memberNameLink"><a href="../jcgp/gui/settings/parameters/GUIParameter.html#INVALID_PARAMETER_STYLE">INVALID_PARAMETER_STYLE</a></span> - Static variable in class jcgp.gui.settings.parameters.<a href="../jcgp/gui/settings/parameters/GUIParameter.html" title="class in jcgp.gui.settings.parameters">GUIParameter</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/parameters/Parameter.html#isCritical--">isCritical()</a></span> - Method in class jcgp.backend.parameters.<a href="../jcgp/backend/parameters/Parameter.html" title="class in jcgp.backend.parameters">Parameter</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/function/FunctionSet.html#isEnabled-jcgp.backend.function.Function-">isEnabled(Function)</a></span> - Method in class jcgp.backend.function.<a href="../jcgp/backend/function/FunctionSet.html" title="class in jcgp.backend.function">FunctionSet</a></dt> +<dd> +<div class="block">Checks if a specified function is enabled.</div> +</dd> +<dt><span class="memberNameLink"><a href="../jcgp/gui/population/ChromosomePane.html#isEvaluating--">isEvaluating()</a></span> - Method in class jcgp.gui.population.<a href="../jcgp/gui/population/ChromosomePane.html" title="class in jcgp.gui.population">ChromosomePane</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="../jcgp/gui/population/PopulationPane.html#isEvaluating--">isEvaluating()</a></span> - Method in class jcgp.gui.population.<a href="../jcgp/gui/population/PopulationPane.html" title="class in jcgp.gui.population">PopulationPane</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="../jcgp/gui/settings/SettingsPane.html#isExperimentRunning--">isExperimentRunning()</a></span> - Method in class jcgp.gui.settings.<a href="../jcgp/gui/settings/SettingsPane.html" title="class in jcgp.gui.settings">SettingsPane</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="../jcgp/JCGP.html#isFinished--">isFinished()</a></span> - Method in class jcgp.<a href="../jcgp/JCGP.html" title="class in jcgp">JCGP</a></dt> +<dd> +<div class="block">Returns the experiment's status.</div> +</dd> +<dt><span class="memberNameLink"><a href="../jcgp/gui/population/GUIGene.html#isLocked--">isLocked()</a></span> - Method in class jcgp.gui.population.<a href="../jcgp/gui/population/GUIGene.html" title="class in jcgp.gui.population">GUIGene</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/parameters/Parameter.html#isMonitor--">isMonitor()</a></span> - Method in class jcgp.backend.parameters.<a href="../jcgp/backend/parameters/Parameter.html" title="class in jcgp.backend.parameters">Parameter</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="../jcgp/gui/settings/SettingsPane.html#isResetRequired--">isResetRequired()</a></span> - Method in class jcgp.gui.settings.<a href="../jcgp/gui/settings/SettingsPane.html" title="class in jcgp.gui.settings">SettingsPane</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="../jcgp/backend/statistics/RunEntry.html#isSuccessful--">isSuccessful()</a></span> - Method in class jcgp.backend.statistics.<a href="../jcgp/backend/statistics/RunEntry.html" title="class in jcgp.backend.statistics">RunEntry</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="../jcgp/gui/settings/parameters/GUIParameter.html#isValid--">isValid()</a></span> - Method in class jcgp.gui.settings.parameters.<a href="../jcgp/gui/settings/parameters/GUIParameter.html" title="class in jcgp.gui.settings.parameters">GUIParameter</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="../jcgp/gui/GUI.html#isWorking--">isWorking()</a></span> - Method in class jcgp.gui.<a href="../jcgp/gui/GUI.html" title="class in jcgp.gui">GUI</a></dt> +<dd> </dd> +</dl> +<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">R</a> <a href="index-17.html">S</a> <a href="index-18.html">T</a> <a href="index-19.html">U</a> <a href="index-20.html">V</a> <a href="index-21.html">W</a> <a href="index-22.html">X</a> </div> +<!-- ======= 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>Package</li> +<li>Class</li> +<li>Use</li> +<li><a href="../overview-tree.html">Tree</a></li> +<li><a href="../deprecated-list.html">Deprecated</a></li> +<li class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-8.html">Prev Letter</a></li> +<li><a href="index-10.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-files/index-9.html" target="_top">Frames</a></li> +<li><a href="index-9.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> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> |