intelligence
Version:
Machine learning library written in javascript
967 lines (303 loc) • 14.2 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: Individual</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: Individual</h1>
<section>
<header>
<h2>
Individual
</h2>
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name" id="Individual"><span class="type-signature"></span>new Individual<span class="signature">(options)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Genetic algorithm individual</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>Individual options</p>
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>minLength</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The minimum number of genes</p></td>
</tr>
<tr>
<td class="name"><code>maxLength</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The maximum number of genes</p></td>
</tr>
<tr>
<td class="name"><code>geneFactory</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last"><p>A function that returns a random gene</p></td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>body</code></td>
<td class="type">
<span class="param-type">Array.<object></span>
</td>
<td class="description last"><p>An array of genes that represent a single chromosome</p></td>
</tr>
<tr>
<td class="name"><code>fitness</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The individuals fitness rating</p></td>
</tr>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>Individual options</p></td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="individual.js.html">genetic/individual.js</a>, <a href="individual.js.html#line15">line 15</a>
</li></ul></dd>
</dl>
</dd>
</div>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="copy"><span class="type-signature"></span>copy<span class="signature">()</span><span class="type-signature"> → {<a href="Individual.html">Individual</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Creates a deep copy of the individual</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="individual.js.html">genetic/individual.js</a>, <a href="individual.js.html#line59">line 59</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>A copy of the Individual instance</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Individual.html">Individual</a></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="createNew"><span class="type-signature"></span>createNew<span class="signature">()</span><span class="type-signature"> → {<a href="Individual.html">Individual</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Creates a deep copy of the individual and then re initialises</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="individual.js.html">genetic/individual.js</a>, <a href="individual.js.html#line67">line 67</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>A new individual based on the current individual</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Individual.html">Individual</a></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="initialise"><span class="type-signature"></span>initialise<span class="signature">()</span><span class="type-signature"> → {<a href="Individual.html">Individual</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Re creates the individuals body with randomly generated genes</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="individual.js.html">genetic/individual.js</a>, <a href="individual.js.html#line46">line 46</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Reference to current object for chaining</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Individual.html">Individual</a></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="isFixedLength"><span class="type-signature"></span>isFixedLength<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4>
</dt>
<dd>
<div class="description">
<p>Determine whether the individual body length can change (i.e. minLength === maxLength)</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="individual.js.html">genetic/individual.js</a>, <a href="individual.js.html#line87">line 87</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>A true value if the indiviuals body is of fixed length, otherwise false</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="mutate"><span class="type-signature"></span>mutate<span class="signature">()</span><span class="type-signature"> → {<a href="Individual.html">Individual</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Mutates the individual by swapping a single gene with a randomly created gene</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="individual.js.html">genetic/individual.js</a>, <a href="individual.js.html#line77">line 77</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Reference to current object for chaining</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Individual.html">Individual</a></span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="validateRequiredOptions"><span class="type-signature"></span>validateRequiredOptions<span class="signature">()</span><span class="type-signature"> → {<a href="Individual.html">Individual</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Validates the individuals current options</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="individual.js.html">genetic/individual.js</a>, <a href="individual.js.html#line29">line 29</a>
</li></ul></dd>
</dl>
<h5>Throws:</h5>
<div class="param-desc">
An exception will occur if a required option is missing
</div>
<h5>Returns:</h5>
<div class="param-desc">
<p>Reference to current object for chaining</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="Individual.html">Individual</a></span>
</dd>
</dl>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="Individual.html">Individual</a></li><li><a href="LinearConditionalNode.html">LinearConditionalNode</a></li><li><a href="LinearFunctionNode.html">LinearFunctionNode</a></li><li><a href="LinearGPNode.html">LinearGPNode</a></li><li><a href="LinearIndividual.html">LinearIndividual</a></li><li><a href="Population.html">Population</a></li><li><a href="RegisterReference.html">RegisterReference</a></li><li><a href="RegisterSet.html">RegisterSet</a></li></ul><h3>Global</h3><ul><li><a href="global.html#alphabet">alphabet</a></li><li><a href="global.html#arrayEqual">arrayEqual</a></li><li><a href="global.html#binaryNumber">binaryNumber</a></li><li><a href="global.html#binaryString">binaryString</a></li><li><a href="global.html#createCalculation">createCalculation</a></li><li><a href="global.html#createConstant">createConstant</a></li><li><a href="global.html#createInput">createInput</a></li><li><a href="global.html#createOutput">createOutput</a></li><li><a href="global.html#formatString">formatString</a></li><li><a href="global.html#fpEqual">fpEqual</a></li><li><a href="global.html#inherits">inherits</a></li><li><a href="global.html#linearNode">linearNode</a></li><li><a href="global.html#onePointFixed">onePointFixed</a></li><li><a href="global.html#onePointVariable">onePointVariable</a></li><li><a href="global.html#randBetween">randBetween</a></li><li><a href="global.html#random">random</a></li><li><a href="global.html#randomNumber">randomNumber</a></li><li><a href="global.html#rank">rank</a></li><li><a href="global.html#rouletteWheel">rouletteWheel</a></li><li><a href="global.html#selectRandom">selectRandom</a></li><li><a href="global.html#swapGenes">swapGenes</a></li><li><a href="global.html#tournament">tournament</a></li><li><a href="global.html#twoPointFixed">twoPointFixed</a></li><li><a href="global.html#twoPointVariable">twoPointVariable</a></li><li><a href="global.html#uniform">uniform</a></li><li><a href="global.html#validateFixedLength">validateFixedLength</a></li><li><a href="global.html#validateMinimumLength">validateMinimumLength</a></li><li><a href="global.html#validateVariableLength">validateVariableLength</a></li></ul>
</nav>
<br clear="both">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Sat Aug 16 2014 23:33:39 GMT+0100 (GMT Summer Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>