doc

Freakwill · Nov 27, 2024 · 42cf368 · 42cf368
1 parent 837b6c7
commit 42cf368
Show file tree

Hide file tree

Showing 59 changed files with 738 additions and 1,428 deletions.
diff --git a/docs/build/doctrees/Misc.doctree b/docs/build/doctrees/Misc.doctree
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree
diff --git a/docs/build/doctrees/modules.doctree b/docs/build/doctrees/modules.doctree
diff --git a/docs/build/doctrees/pyrimidine.benchmarks.doctree b/docs/build/doctrees/pyrimidine.benchmarks.doctree
diff --git a/docs/build/doctrees/pyrimidine.doctree b/docs/build/doctrees/pyrimidine.doctree
diff --git a/docs/build/doctrees/pyrimidine.learn.doctree b/docs/build/doctrees/pyrimidine.learn.doctree
diff --git a/docs/build/doctrees/pyrimidine.local_search.doctree b/docs/build/doctrees/pyrimidine.local_search.doctree
diff --git a/docs/build/doctrees/pyrimidine.misc.doctree b/docs/build/doctrees/pyrimidine.misc.doctree
diff --git a/docs/build/html/Customization.html b/docs/build/html/Customization.html
@@ -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="Helpers" href="Helpers.html" />
+    <link rel="prev" title="Examples and Comparison of Algorithms" href="Examples.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]>
@@ -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="Helpers.html" title="Helpers"
+             accesskey="N">next</a> |</li>
+        <li class="right" >
+          <a href="Examples.html" title="Examples and Comparison of Algorithms"
+             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="">Customization</a></li> 
       </ul>
@@ -325,6 +333,16 @@ <h3><a href="index.html">Table of Contents</a></h3>
 </ul>
 
   </div>
+  <div>
+    <h4>Previous topic</h4>
+    <p class="topless"><a href="Examples.html"
+                          title="previous chapter">Examples and Comparison of Algorithms</a></p>
+  </div>
+  <div>
+    <h4>Next topic</h4>
+    <p class="topless"><a href="Helpers.html"
+                          title="next chapter">Helpers</a></p>
+  </div>
   <div role="note" aria-label="source link">
     <h3>This Page</h3>
     <ul class="this-page-menu">
@@ -355,6 +373,12 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
+        <li class="right" >
+          <a href="Helpers.html" title="Helpers"
+             >next</a> |</li>
+        <li class="right" >
+          <a href="Examples.html" title="Examples and Comparison of Algorithms"
+             >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="">Customization</a></li> 
       </ul>

diff --git a/docs/build/html/Developers.html b/docs/build/html/Developers.html
@@ -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="Misc" href="Media.html" />
+    <link rel="prev" title="Helpers" href="Helpers.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]>
@@ -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="Media.html" title="Misc"
+             accesskey="N">next</a> |</li>
+        <li class="right" >
+          <a href="Helpers.html" title="Helpers"
+             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="">Developers</a></li> 
       </ul>
@@ -72,6 +80,16 @@ <h3><a href="index.html">Table of Contents</a></h3>
 </ul>
 
   </div>
+  <div>
+    <h4>Previous topic</h4>
+    <p class="topless"><a href="Helpers.html"
+                          title="previous chapter">Helpers</a></p>
+  </div>
+  <div>
+    <h4>Next topic</h4>
+    <p class="topless"><a href="Media.html"
+                          title="next chapter">Misc</a></p>
+  </div>
   <div role="note" aria-label="source link">
     <h3>This Page</h3>
     <ul class="this-page-menu">
@@ -102,6 +120,12 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
+        <li class="right" >
+          <a href="Media.html" title="Misc"
+             >next</a> |</li>
+        <li class="right" >
+          <a href="Helpers.html" title="Helpers"
+             >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="">Developers</a></li> 
       </ul>

diff --git a/docs/build/html/Examples.html b/docs/build/html/Examples.html
@@ -15,6 +15,8 @@
     <script defer="defer" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
+    <link rel="next" title="Customization" href="Customization.html" />
+    <link rel="prev" title="API Design" href="API%20Design.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]>
@@ -32,6 +34,12 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
+        <li class="right" >
+          <a href="Customization.html" title="Customization"
+             accesskey="N">next</a> |</li>
+        <li class="right" >
+          <a href="API%20Design.html" title="API Design"
+             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="">Examples and Comparison of Algorithms</a></li> 
       </ul>
@@ -717,6 +725,16 @@ <h3><a href="index.html">Table of Contents</a></h3>
 </ul>
 
   </div>
+  <div>
+    <h4>Previous topic</h4>
+    <p class="topless"><a href="API%20Design.html"
+                          title="previous chapter">API Design</a></p>
+  </div>
+  <div>
+    <h4>Next topic</h4>
+    <p class="topless"><a href="Customization.html"
+                          title="next chapter">Customization</a></p>
+  </div>
   <div role="note" aria-label="source link">
     <h3>This Page</h3>
     <ul class="this-page-menu">
@@ -747,6 +765,12 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
+        <li class="right" >
+          <a href="Customization.html" title="Customization"
+             >next</a> |</li>
+        <li class="right" >
+          <a href="API%20Design.html" title="API Design"
+             >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="">Examples and Comparison of Algorithms</a></li> 
       </ul>

diff --git a/docs/build/html/Helpers.html b/docs/build/html/Helpers.html
@@ -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="Developers" href="Developers.html" />
+    <link rel="prev" title="Customization" href="Customization.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]>
@@ -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="Developers.html" title="Developers"
+             accesskey="N">next</a> |</li>
+        <li class="right" >
+          <a href="Customization.html" title="Customization"
+             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="">Helpers</a></li> 
       </ul>
@@ -208,6 +216,16 @@ <h3><a href="index.html">Table of Contents</a></h3>
 </ul>
 
   </div>
+  <div>
+    <h4>Previous topic</h4>
+    <p class="topless"><a href="Customization.html"
+                          title="previous chapter">Customization</a></p>
+  </div>
+  <div>
+    <h4>Next topic</h4>
+    <p class="topless"><a href="Developers.html"
+                          title="next chapter">Developers</a></p>
+  </div>
   <div role="note" aria-label="source link">
     <h3>This Page</h3>
     <ul class="this-page-menu">
@@ -238,6 +256,12 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
+        <li class="right" >
+          <a href="Developers.html" title="Developers"
+             >next</a> |</li>
+        <li class="right" >
+          <a href="Customization.html" title="Customization"
+             >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="">Helpers</a></li> 
       </ul>

diff --git a/docs/build/html/Home.html b/docs/build/html/Home.html
@@ -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="Installation and Getting Started" href="Install.html" />
+    <link rel="prev" title="Welcome to pyrimidine’s world of genetic algorithm" href="index.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]>
@@ -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="Install.html" title="Installation and Getting Started"
+             accesskey="N">next</a> |</li>
+        <li class="right" >
+          <a href="index.html" title="Welcome to pyrimidine’s world of genetic algorithm"
+             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="">pyrimidine: a universal framework for genetic algorithm</a></li> 
       </ul>
@@ -197,6 +205,16 @@ <h3><a href="index.html">Table of Contents</a></h3>
 </ul>
 
   </div>
+  <div>
+    <h4>Previous topic</h4>
+    <p class="topless"><a href="index.html"
+                          title="previous chapter">Welcome to pyrimidine’s world of genetic algorithm</a></p>
+  </div>
+  <div>
+    <h4>Next topic</h4>
+    <p class="topless"><a href="Install.html"
+                          title="next chapter">Installation and Getting Started</a></p>
+  </div>
   <div role="note" aria-label="source link">
     <h3>This Page</h3>
     <ul class="this-page-menu">
@@ -227,6 +245,12 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
+        <li class="right" >
+          <a href="Install.html" title="Installation and Getting Started"
+             >next</a> |</li>
+        <li class="right" >
+          <a href="index.html" title="Welcome to pyrimidine’s world of genetic algorithm"
+             >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="">pyrimidine: a universal framework for genetic algorithm</a></li> 
       </ul>

diff --git a/docs/build/html/Install.html b/docs/build/html/Install.html
@@ -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="Release History" href="Release%20History.html" />
+    <link rel="prev" title="pyrimidine: a universal framework for genetic algorithm" href="Home.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]>
@@ -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="Release%20History.html" title="Release History"
+             accesskey="N">next</a> |</li>
+        <li class="right" >
+          <a href="Home.html" title="pyrimidine: a universal framework for genetic algorithm"
+             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="">Installation and Getting Started</a></li> 
       </ul>
@@ -88,6 +96,16 @@ <h3><a href="index.html">Table of Contents</a></h3>
 </ul>
 
   </div>
+  <div>
+    <h4>Previous topic</h4>
+    <p class="topless"><a href="Home.html"
+                          title="previous chapter">pyrimidine: a universal framework for genetic algorithm</a></p>
+  </div>
+  <div>
+    <h4>Next topic</h4>
+    <p class="topless"><a href="Release%20History.html"
+                          title="next chapter">Release History</a></p>
+  </div>
   <div role="note" aria-label="source link">
     <h3>This Page</h3>
     <ul class="this-page-menu">
@@ -118,6 +136,12 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
+        <li class="right" >
+          <a href="Release%20History.html" title="Release History"
+             >next</a> |</li>
+        <li class="right" >
+          <a href="Home.html" title="pyrimidine: a universal framework for genetic algorithm"
+             >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="">Installation and Getting Started</a></li> 
       </ul>

diff --git a/docs/build/html/Media.html b/docs/build/html/Media.html
@@ -13,7 +13,7 @@
     <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="pyrimidine" href="Modules.html" />
+    <link rel="next" title="Modules of pyrimidine" href="Modules.html" />
     <link rel="prev" title="Developers" href="Developers.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" />
@@ -33,7 +33,7 @@ <h3>Navigation</h3>
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
         <li class="right" >
-          <a href="Modules.html" title="pyrimidine"
+          <a href="Modules.html" title="Modules of pyrimidine"
              accesskey="N">next</a> |</li>
         <li class="right" >
           <a href="Developers.html" title="Developers"
@@ -126,7 +126,7 @@ <h4>Previous topic</h4>
   <div>
     <h4>Next topic</h4>
     <p class="topless"><a href="Modules.html"
-                          title="next chapter">pyrimidine</a></p>
+                          title="next chapter">Modules of <cite>pyrimidine</cite></a></p>
   </div>
   <div role="note" aria-label="source link">
     <h3>This Page</h3>
@@ -159,7 +159,7 @@ <h3>Navigation</h3>
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
         <li class="right" >
-          <a href="Modules.html" title="pyrimidine"
+          <a href="Modules.html" title="Modules of pyrimidine"
              >next</a> |</li>
         <li class="right" >
           <a href="Developers.html" title="Developers"