Skip to content

Commit

Permalink
doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Freakwill committed Nov 27, 2024
1 parent 4b33617 commit 837b6c7
Show file tree
Hide file tree
Showing 19 changed files with 2,165 additions and 130 deletions.
Binary file modified docs/build/doctrees/API Design.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/build/doctrees/pyrimidine.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/pyrimidine.local_search.doctree
Binary file not shown.
25 changes: 24 additions & 1 deletion docs/build/html/API Design.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Examples and Comparison of Algorithms" href="Examples.html" />
<link rel="prev" title="Release History" href="Release%20History.html" />
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Neuton&amp;subset=latin" type="text/css" media="screen" charset="utf-8" />
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Nobile:regular,italic,bold,bolditalic&amp;subset=latin" type="text/css" media="screen" charset="utf-8" />
<!--[if lte IE 6]>
Expand All @@ -30,6 +32,12 @@ <h3>Navigation</h3>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="Examples.html" title="Examples and Comparison of Algorithms"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="Release%20History.html" title="Release History"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">pyrimidine 1.7 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">API Design</a></li>
</ul>
Expand Down Expand Up @@ -144,7 +152,6 @@ <h3>About fitness<a class="headerlink" href="#about-fitness" title="Link to this
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">_fitness()</span></code>: the basic method to calculate the fitness of the individual. The methods whose names are started with <code class="docutils literal notranslate"><span class="pre">_</span></code> always do the most dirty task.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">fitness</span></code>: decorated by <code class="docutils literal notranslate"><span class="pre">property</span></code>, get the fitness of the individual/population (from the cache first then call - <code class="docutils literal notranslate"><span class="pre">_fitness</span></code> if there is a cache). The fitness of a population is the maximal fitness of the individuals in the population.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">fitness</span></code>: decorated by <code class="docutils literal notranslate"><span class="pre">property</span></code>, get the fitness of the individual (from the cache first then call <code class="docutils literal notranslate"><span class="pre">_fitness</span></code> if there is a cache).</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">best/mean/std_fitness</span></code>: the maximum/mean/std of the fitnesses of the individuals in a population.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">get_all_fitness</span></code>: get the all fitnesses</p></li>
</ul>
Expand Down Expand Up @@ -258,6 +265,16 @@ <h3><a href="index.html">Table of Contents</a></h3>
</ul>

</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="Release%20History.html"
title="previous chapter">Release History</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="Examples.html"
title="next chapter">Examples and Comparison of Algorithms</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
Expand Down Expand Up @@ -288,6 +305,12 @@ <h3>Navigation</h3>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="Examples.html" title="Examples and Comparison of Algorithms"
>next</a> |</li>
<li class="right" >
<a href="Release%20History.html" title="Release History"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">pyrimidine 1.7 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">API Design</a></li>
</ul>
Expand Down
1 change: 0 additions & 1 deletion docs/build/html/_sources/API Design.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,6 @@ Calculating the fintess is the most frequent task in the algorithms.

- `_fitness()`: the basic method to calculate the fitness of the individual. The methods whose names are started with `_` always do the most dirty task.
- `fitness`: decorated by `property`, get the fitness of the individual/population (from the cache first then call - `_fitness` if there is a cache). The fitness of a population is the maximal fitness of the individuals in the population.
- `fitness`: decorated by `property`, get the fitness of the individual (from the cache first then call `_fitness` if there is a cache).
- `best/mean/std_fitness`: the maximum/mean/std of the fitnesses of the individuals in a population.
- `get_all_fitness`: get the all fitnesses

Expand Down
Loading

0 comments on commit 837b6c7

Please sign in to comment.