Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@RolandoAndrade
RolandoAndrade committed Jul 24, 2022
1 parent 5905de6 commit f41f731
Show file tree
Hide file tree
Showing 15 changed files with 175 additions and 36 deletions.
6 changes: 3 additions & 3 deletions docs/classes/Agent.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="crossover" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>crossover</span><a href="#crossover" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature" id="crossover.crossover-1">crossover<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">ChromosomeType</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">FitnessType</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>agentA<span class="tsd-signature-symbol">: </span><a href="Agent.html" class="tsd-signature-type" data-tsd-kind="Class">Agent</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">ChromosomeType</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">FitnessType</span><span class="tsd-signature-symbol">&gt;</span>, agentB<span class="tsd-signature-symbol">: </span><a href="Agent.html" class="tsd-signature-type" data-tsd-kind="Class">Agent</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">ChromosomeType</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">FitnessType</span><span class="tsd-signature-symbol">&gt;</span>, splitFunction<span class="tsd-signature-symbol">: </span><a href="../types/SplitFunction.html" class="tsd-signature-type" data-tsd-kind="Type alias">SplitFunction</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">ChromosomeType</span><span class="tsd-signature-symbol">&gt;</span>, mixFunction<span class="tsd-signature-symbol">: </span><a href="../types/MixFunction.html" class="tsd-signature-type" data-tsd-kind="Type alias">MixFunction</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">ChromosomeType</span><span class="tsd-signature-symbol">&gt;</span>, mutationFunction<span class="tsd-signature-symbol">: </span><a href="../types/MutationFunction.html" class="tsd-signature-type" data-tsd-kind="Type alias">MutationFunction</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">ChromosomeType</span><span class="tsd-signature-symbol">&gt;</span>, agentGenerator<span class="tsd-signature-symbol">: </span><a href="AgentGenerator.html" class="tsd-signature-type" data-tsd-kind="Class">AgentGenerator</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">ChromosomeType</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">FitnessType</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Agent.html" class="tsd-signature-type" data-tsd-kind="Class">Agent</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">ChromosomeType</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">FitnessType</span><span class="tsd-signature-symbol">&gt;</span></li></ul>
<li class="tsd-signature" id="crossover.crossover-1">crossover<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">ChromosomeType</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">FitnessType</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>agentA<span class="tsd-signature-symbol">: </span><a href="Agent.html" class="tsd-signature-type" data-tsd-kind="Class">Agent</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">ChromosomeType</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">FitnessType</span><span class="tsd-signature-symbol">&gt;</span>, agentB<span class="tsd-signature-symbol">: </span><a href="Agent.html" class="tsd-signature-type" data-tsd-kind="Class">Agent</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">ChromosomeType</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">FitnessType</span><span class="tsd-signature-symbol">&gt;</span>, splitFunction<span class="tsd-signature-symbol">: </span><a href="../types/SplitFunction.html" class="tsd-signature-type" data-tsd-kind="Type alias">SplitFunction</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">ChromosomeType</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">ChromosomeType</span><span class="tsd-signature-symbol">&gt;</span>, mixFunction<span class="tsd-signature-symbol">: </span><a href="../types/MixFunction.html" class="tsd-signature-type" data-tsd-kind="Type alias">MixFunction</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">ChromosomeType</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">ChromosomeType</span><span class="tsd-signature-symbol">&gt;</span>, mutationFunction<span class="tsd-signature-symbol">: </span><a href="../types/MutationFunction.html" class="tsd-signature-type" data-tsd-kind="Type alias">MutationFunction</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">ChromosomeType</span><span class="tsd-signature-symbol">&gt;</span>, agentGenerator<span class="tsd-signature-symbol">: </span><a href="AgentGenerator.html" class="tsd-signature-type" data-tsd-kind="Class">AgentGenerator</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">ChromosomeType</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">FitnessType</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Agent.html" class="tsd-signature-type" data-tsd-kind="Class">Agent</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">ChromosomeType</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">FitnessType</span><span class="tsd-signature-symbol">&gt;</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>Generates a child agent from two agents.</p>
Expand All @@ -121,11 +121,11 @@ <h5>agentB: <a href="Agent.html" class="tsd-signature-type" data-tsd-kind="Class
<div class="tsd-comment tsd-typography"><p>The second agent.</p>
</div></li>
<li>
<h5>splitFunction: <a href="../types/SplitFunction.html" class="tsd-signature-type" data-tsd-kind="Type alias">SplitFunction</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">ChromosomeType</span><span class="tsd-signature-symbol">&gt;</span></h5>
<h5>splitFunction: <a href="../types/SplitFunction.html" class="tsd-signature-type" data-tsd-kind="Type alias">SplitFunction</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">ChromosomeType</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">ChromosomeType</span><span class="tsd-signature-symbol">&gt;</span></h5>
<div class="tsd-comment tsd-typography"><p>The function used to split the genomes.</p>
</div></li>
<li>
<h5>mixFunction: <a href="../types/MixFunction.html" class="tsd-signature-type" data-tsd-kind="Type alias">MixFunction</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">ChromosomeType</span><span class="tsd-signature-symbol">&gt;</span></h5>
<h5>mixFunction: <a href="../types/MixFunction.html" class="tsd-signature-type" data-tsd-kind="Type alias">MixFunction</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">ChromosomeType</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">ChromosomeType</span><span class="tsd-signature-symbol">&gt;</span></h5>
<div class="tsd-comment tsd-typography"><p>The function used to mix the genomes.</p>
</div></li>
<li>
Expand Down
6 changes: 3 additions & 3 deletions docs/classes/Simulation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -87,19 +87,19 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</co
<div class="tsd-comment tsd-typography"><p>Defines the current generation of the simulation</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/RolandoAndrade/genetic-algorithm-framework/blob/289f280/src/main/simulation.ts#L20">main/simulation.ts:20</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/RolandoAndrade/genetic-algorithm-framework/blob/5905de6/src/main/simulation.ts#L20">main/simulation.ts:20</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a id="population" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>population</span><a href="#population" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">population<span class="tsd-signature-symbol">:</span> <a href="Agent.html" class="tsd-signature-type" data-tsd-kind="Class">Agent</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">ChromosomeType</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">FitnessType</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div>
<div class="tsd-comment tsd-typography"><p>Population of the simulation</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/RolandoAndrade/genetic-algorithm-framework/blob/289f280/src/main/simulation.ts#L18">main/simulation.ts:18</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/RolandoAndrade/genetic-algorithm-framework/blob/5905de6/src/main/simulation.ts#L18">main/simulation.ts:18</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a id="properties" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>properties</span><a href="#properties" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">properties<span class="tsd-signature-symbol">:</span> <a href="../interfaces/SimulationOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SimulationOptions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">ChromosomeType</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">FitnessType</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/RolandoAndrade/genetic-algorithm-framework/blob/289f280/src/main/simulation.ts#L25">main/simulation.ts:25</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/RolandoAndrade/genetic-algorithm-framework/blob/5905de6/src/main/simulation.ts#L25">main/simulation.ts:25</a></li></ul></aside></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a id="computeScores" class="tsd-anchor"></a>
Expand Down
Loading

0 comments on commit f41f731

Please sign in to comment.