Browse Source

start of new documentation explanation

Jérôme BUISINE 2 months ago
parent
commit
1bb5cb9f48
81 changed files with 1414 additions and 272 deletions
  1. 2 2
      LICENSE
  2. BIN
      docs/build/doctrees/api.doctree
  3. BIN
      docs/build/doctrees/documentations/index.doctree
  4. BIN
      docs/build/doctrees/documentations/introduction.doctree
  5. BIN
      docs/build/doctrees/documentations/problem.doctree
  6. BIN
      docs/build/doctrees/documentations/solutions.doctree
  7. BIN
      docs/build/doctrees/environment.pickle
  8. BIN
      docs/build/doctrees/index.doctree
  9. BIN
      docs/build/doctrees/macop.doctree
  10. BIN
      docs/build/html/_images/knapsack_problem.png
  11. BIN
      docs/build/html/_images/logo_macop1.png
  12. 2 1
      docs/build/html/_modules/index.html
  13. 2 1
      docs/build/html/_modules/macop/algorithms/base.html
  14. 2 1
      docs/build/html/_modules/macop/algorithms/mono.html
  15. 2 1
      docs/build/html/_modules/macop/algorithms/multi.html
  16. 2 1
      docs/build/html/_modules/macop/callbacks/base.html
  17. 2 1
      docs/build/html/_modules/macop/callbacks/classicals.html
  18. 2 1
      docs/build/html/_modules/macop/callbacks/multi.html
  19. 2 1
      docs/build/html/_modules/macop/callbacks/policies.html
  20. 2 1
      docs/build/html/_modules/macop/evaluators/base.html
  21. 2 1
      docs/build/html/_modules/macop/evaluators/discrete/mono.html
  22. 2 1
      docs/build/html/_modules/macop/evaluators/discrete/multi.html
  23. 2 1
      docs/build/html/_modules/macop/operators/base.html
  24. 2 1
      docs/build/html/_modules/macop/operators/discrete/crossovers.html
  25. 2 1
      docs/build/html/_modules/macop/operators/discrete/mutators.html
  26. 2 1
      docs/build/html/_modules/macop/policies/base.html
  27. 2 1
      docs/build/html/_modules/macop/policies/classicals.html
  28. 2 1
      docs/build/html/_modules/macop/policies/reinforcement.html
  29. 2 1
      docs/build/html/_modules/macop/solutions/base.html
  30. 2 1
      docs/build/html/_modules/macop/solutions/discrete.html
  31. 2 1
      docs/build/html/_modules/macop/utils/progress.html
  32. 1 1
      docs/build/html/_sources/macop.rst.txt
  33. 18 0
      docs/build/html/_sources/documentations/index.rst.txt
  34. 14 0
      docs/build/html/_sources/documentations/introduction.rst.txt
  35. 42 0
      docs/build/html/_sources/documentations/problem.rst.txt
  36. 3 0
      docs/build/html/_sources/documentations/solutions.rst.txt
  37. 3 2
      docs/build/html/_sources/index.rst.txt
  38. BIN
      docs/build/html/_static/documentation/knapsack_problem.png
  39. 7 6
      docs/build/html/macop.html
  40. 2 1
      docs/build/html/contributing.html
  41. 4 3
      docs/build/html/description.html
  42. 230 0
      docs/build/html/documentations/index.html
  43. 231 0
      docs/build/html/documentations/introduction.html
  44. 253 0
      docs/build/html/documentations/problem.html
  45. 221 0
      docs/build/html/documentations/solutions.html
  46. 4 3
      docs/build/html/examples.html
  47. 2 1
      docs/build/html/genindex.html
  48. 5 3
      docs/build/html/index.html
  49. 13 12
      docs/build/html/macop/macop.algorithms.base.html
  50. 11 10
      docs/build/html/macop/macop.algorithms.mono.html
  51. 11 10
      docs/build/html/macop/macop.algorithms.multi.html
  52. 11 10
      docs/build/html/macop/macop.callbacks.base.html
  53. 11 10
      docs/build/html/macop/macop.callbacks.classicals.html
  54. 11 10
      docs/build/html/macop/macop.callbacks.multi.html
  55. 11 10
      docs/build/html/macop/macop.callbacks.policies.html
  56. 11 10
      docs/build/html/macop/macop.evaluators.base.html
  57. 11 10
      docs/build/html/macop/macop.evaluators.discrete.mono.html
  58. 11 10
      docs/build/html/macop/macop.evaluators.discrete.multi.html
  59. 11 10
      docs/build/html/macop/macop.operators.base.html
  60. 11 10
      docs/build/html/macop/macop.operators.continuous.crossovers.html
  61. 11 10
      docs/build/html/macop/macop.operators.continuous.mutators.html
  62. 11 10
      docs/build/html/macop/macop.operators.discrete.crossovers.html
  63. 11 10
      docs/build/html/macop/macop.operators.discrete.mutators.html
  64. 11 10
      docs/build/html/macop/macop.policies.base.html
  65. 11 10
      docs/build/html/macop/macop.policies.classicals.html
  66. 11 10
      docs/build/html/macop/macop.policies.reinforcement.html
  67. 11 10
      docs/build/html/macop/macop.solutions.base.html
  68. 11 10
      docs/build/html/macop/macop.solutions.continuous.html
  69. 11 10
      docs/build/html/macop/macop.solutions.discrete.html
  70. 13 12
      docs/build/html/macop/macop.utils.progress.html
  71. BIN
      docs/build/html/objects.inv
  72. 2 1
      docs/build/html/py-modindex.html
  73. 2 1
      docs/build/html/search.html
  74. 1 1
      docs/build/html/searchindex.js
  75. BIN
      docs/source/_static/documentation/knapsack_problem.png
  76. 1 1
      docs/source/macop.rst
  77. 18 0
      docs/source/documentations/index.rst
  78. 14 0
      docs/source/documentations/introduction.rst
  79. 42 0
      docs/source/documentations/problem.rst
  80. 3 0
      docs/source/documentations/solutions.rst
  81. 3 2
      docs/source/index.rst

+ 2 - 2
LICENSE

@@ -1,8 +1,8 @@
 MIT License
-Copyright (c) <year> <copyright holders>
+Copyright (c) 2020 Jérôme Buisine
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

BIN
docs/build/doctrees/api.doctree


BIN
docs/build/doctrees/documentations/index.doctree


BIN
docs/build/doctrees/documentations/introduction.doctree


BIN
docs/build/doctrees/documentations/problem.doctree


BIN
docs/build/doctrees/documentations/solutions.doctree


BIN
docs/build/doctrees/environment.pickle


BIN
docs/build/doctrees/index.doctree


BIN
docs/build/doctrees/macop.doctree


BIN
docs/build/html/_images/knapsack_problem.png


BIN
docs/build/html/_images/logo_macop1.png


+ 2 - 1
docs/build/html/_modules/index.html

@@ -86,7 +86,8 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../description.html">Description</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../macop.html">Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../api.html">API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
 </ul>

+ 2 - 1
docs/build/html/_modules/macop/algorithms/base.html

@@ -86,7 +86,8 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../description.html">Description</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../macop.html">Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../api.html">API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../contributing.html">Contributing</a></li>
 </ul>

+ 2 - 1
docs/build/html/_modules/macop/algorithms/mono.html

@@ -86,7 +86,8 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../description.html">Description</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../macop.html">Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../api.html">API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../contributing.html">Contributing</a></li>
 </ul>

+ 2 - 1
docs/build/html/_modules/macop/algorithms/multi.html

@@ -86,7 +86,8 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../description.html">Description</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../macop.html">Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../api.html">API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../contributing.html">Contributing</a></li>
 </ul>

+ 2 - 1
docs/build/html/_modules/macop/callbacks/base.html

@@ -86,7 +86,8 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../description.html">Description</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../macop.html">Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../api.html">API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../contributing.html">Contributing</a></li>
 </ul>

+ 2 - 1
docs/build/html/_modules/macop/callbacks/classicals.html

@@ -86,7 +86,8 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../description.html">Description</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../macop.html">Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../api.html">API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../contributing.html">Contributing</a></li>
 </ul>

+ 2 - 1
docs/build/html/_modules/macop/callbacks/multi.html

@@ -86,7 +86,8 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../description.html">Description</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../macop.html">Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../api.html">API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../contributing.html">Contributing</a></li>
 </ul>

+ 2 - 1
docs/build/html/_modules/macop/callbacks/policies.html

@@ -86,7 +86,8 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../description.html">Description</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../macop.html">Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../api.html">API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../contributing.html">Contributing</a></li>
 </ul>

+ 2 - 1
docs/build/html/_modules/macop/evaluators/base.html

@@ -86,7 +86,8 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../description.html">Description</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../macop.html">Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../api.html">API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../contributing.html">Contributing</a></li>
 </ul>

+ 2 - 1
docs/build/html/_modules/macop/evaluators/discrete/mono.html

@@ -86,7 +86,8 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../../description.html">Description</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../../macop.html">Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../../api.html">API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../../documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../contributing.html">Contributing</a></li>
 </ul>

+ 2 - 1
docs/build/html/_modules/macop/evaluators/discrete/multi.html

@@ -86,7 +86,8 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../../description.html">Description</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../../macop.html">Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../../api.html">API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../../documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../contributing.html">Contributing</a></li>
 </ul>

+ 2 - 1
docs/build/html/_modules/macop/operators/base.html

@@ -86,7 +86,8 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../description.html">Description</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../macop.html">Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../api.html">API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../contributing.html">Contributing</a></li>
 </ul>

+ 2 - 1
docs/build/html/_modules/macop/operators/discrete/crossovers.html

@@ -86,7 +86,8 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../../description.html">Description</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../../macop.html">Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../../api.html">API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../../documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../contributing.html">Contributing</a></li>
 </ul>

+ 2 - 1
docs/build/html/_modules/macop/operators/discrete/mutators.html

@@ -86,7 +86,8 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../../description.html">Description</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../../macop.html">Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../../api.html">API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../../documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../../contributing.html">Contributing</a></li>
 </ul>

+ 2 - 1
docs/build/html/_modules/macop/policies/base.html

@@ -86,7 +86,8 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../description.html">Description</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../macop.html">Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../api.html">API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../contributing.html">Contributing</a></li>
 </ul>

+ 2 - 1
docs/build/html/_modules/macop/policies/classicals.html

@@ -86,7 +86,8 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../description.html">Description</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../macop.html">Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../api.html">API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../contributing.html">Contributing</a></li>
 </ul>

+ 2 - 1
docs/build/html/_modules/macop/policies/reinforcement.html

@@ -86,7 +86,8 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../description.html">Description</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../macop.html">Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../api.html">API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../contributing.html">Contributing</a></li>
 </ul>

+ 2 - 1
docs/build/html/_modules/macop/solutions/base.html

@@ -86,7 +86,8 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../description.html">Description</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../macop.html">Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../api.html">API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../contributing.html">Contributing</a></li>
 </ul>

+ 2 - 1
docs/build/html/_modules/macop/solutions/discrete.html

@@ -86,7 +86,8 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../description.html">Description</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../macop.html">Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../api.html">API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../contributing.html">Contributing</a></li>
 </ul>

+ 2 - 1
docs/build/html/_modules/macop/utils/progress.html

@@ -86,7 +86,8 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../description.html">Description</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../macop.html">Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../api.html">API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../contributing.html">Contributing</a></li>
 </ul>

+ 1 - 1
docs/build/html/_sources/macop.rst.txt

@@ -1,4 +1,4 @@
-Documentation
+API
 =============
 
 macop

+ 18 - 0
docs/build/html/_sources/documentations/index.rst.txt

@@ -0,0 +1,18 @@
+Documentation
+==============
+
+.. image:: ../_static/logo_macop.png
+   :width: 300 px
+   :align: center
+
+This documentation will allow a user who wishes to use the Macop optimisation package to understand both how it works and offers examples of how to implement specific needs.
+
+It will gradually take up the major ideas developed within `Macop` to allow for rapid development. You can navigate directly via the menu available below to access a specific part of the documentation.
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Contents:
+
+   introduction
+   problem
+   solutions

File diff suppressed because it is too large
+ 14 - 0
docs/build/html/_sources/documentations/introduction.rst.txt


+ 42 - 0
docs/build/html/_sources/documentations/problem.rst.txt

@@ -0,0 +1,42 @@
+2. Problem instance
+===================
+
+
+In this tutorial, we introduce the way of using `macop` and running your algorithm quickly.
+
+2.1 Problem definition
+~~~~~~~~~~~~~~~~~~~~~~
+
+.. image:: ../_static/documentation/knapsack_problem.png
+   :width:  300 px
+   :align: center
+
+
+
+
+
+2.2 Problem implementation
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Hence, we define our problem in Python:
+
+- value of each component of knapsack
+- weight associated to each of these components (objects)
+
+.. code:: python
+    
+    """
+    imports part
+    """
+    import random
+
+    """
+    Problem definition
+    """
+    random.seed(42)
+
+    elements_score = [ random.randint(1, 20) for _ in range(30) ] # value of each object
+    elements_weight = [ random.randint(5, 25) for _ in range(30) ] # weight of each object
+
+First of all we need to define the kind of solution which best represent the problem. As example, we use the well known knapsack problem using 30 objects (solution size of 30).
+

+ 3 - 0
docs/build/html/_sources/documentations/solutions.rst.txt

@@ -0,0 +1,3 @@
+3. Solutions
+=============
+

+ 3 - 2
docs/build/html/_sources/index.rst.txt

@@ -2,7 +2,7 @@ Minimalist And Customisable Optimisation Package
 ================================================
 
 .. image:: _static/logo_macop.png
-   :width: 450 px
+   :width: 300 px
    :align: center
 
 What's `macop` ?
@@ -15,7 +15,8 @@ What's `macop` ?
    :caption: Contents:
 
    description
-   macop
+   api
+   documentations/index
    examples
    contributing
 

BIN
docs/build/html/_static/documentation/knapsack_problem.png


+ 7 - 6
docs/build/html/macop.html

@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>Documentation &mdash; macop v1.0.5 documentation</title>
+  <title>API &mdash; macop v1.0.5 documentation</title>
   
 
   
@@ -88,7 +88,7 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="description.html">Description</a></li>
-<li class="toctree-l1 current"><a class="current reference internal" href="#">Documentation</a><ul>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">API</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#macop">macop</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#macop-algorithms">macop.algorithms</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="macop/macop.algorithms.base.html">macop.algorithms.base</a></li>
@@ -135,6 +135,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
 </ul>
@@ -182,14 +183,14 @@
     
       <li><a href="index.html">Docs</a> &raquo;</li>
         
-      <li>Documentation</li>
+      <li>API</li>
     
     
       <li class="wy-breadcrumbs-aside">
         
             
             
-              <a href="https://github.com/prise-3d/macop/blob/master/docs/source/macop.rst" class="fa fa-github"> Edit on GitHub</a>
+              <a href="https://github.com/prise-3d/macop/blob/master/docs/source/api.rst" class="fa fa-github"> Edit on GitHub</a>
             
           
         
@@ -203,8 +204,8 @@
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
             
-  <div class="section" id="documentation">
-<h1>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h1>
+  <div class="section" id="api">
+<h1>API<a class="headerlink" href="#api" title="Permalink to this headline">¶</a></h1>
 <div class="section" id="macop">
 <h2>macop<a class="headerlink" href="#macop" title="Permalink to this headline">¶</a></h2>
 </div>

+ 2 - 1
docs/build/html/contributing.html

@@ -87,7 +87,8 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="description.html">Description</a></li>
-<li class="toctree-l1"><a class="reference internal" href="macop.html">Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="api.html">API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="examples.html">Some examples</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Contributing</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#using-github">Using GitHub</a></li>

+ 4 - 3
docs/build/html/description.html

@@ -36,7 +36,7 @@
   <link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="Documentation" href="macop.html" />
+    <link rel="next" title="API" href="api.html" />
     <link rel="prev" title="Minimalist And Customisable Optimisation Package" href="index.html" /> 
 </head>
 
@@ -92,7 +92,8 @@
 <li class="toctree-l2"><a class="reference internal" href="#installation">Installation</a></li>
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="macop.html">Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="api.html">API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
 </ul>
@@ -185,7 +186,7 @@
   
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
       
-        <a href="macop.html" class="btn btn-neutral float-right" title="Documentation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
+        <a href="api.html" class="btn btn-neutral float-right" title="API" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
       
       
         <a href="index.html" class="btn btn-neutral float-left" title="Minimalist And Customisable Optimisation Package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

+ 230 - 0
docs/build/html/documentations/index.html

@@ -0,0 +1,230 @@
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+  <meta charset="utf-8">
+  
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  
+  <title>Documentation &mdash; macop v1.0.5 documentation</title>
+  
+
+  
+  
+  
+  
+
+  
+  <script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
+  
+    
+      <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
+        <script type="text/javascript" src="../_static/jquery.js"></script>
+        <script type="text/javascript" src="../_static/underscore.js"></script>
+        <script type="text/javascript" src="../_static/doctools.js"></script>
+        <script type="text/javascript" src="../_static/language_data.js"></script>
+    
+    <script type="text/javascript" src="../_static/js/theme.js"></script>
+
+    
+
+  
+  <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+  <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+  <link rel="stylesheet" href="../_static/css/custom.css" type="text/css" />
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" />
+    <link rel="next" title="1. Introduction" href="introduction.html" />
+    <link rel="prev" title="macop.utils.progress" href="../macop/macop.utils.progress.html" /> 
+</head>
+
+<body class="wy-body-for-nav">
+
+   
+  <div class="wy-grid-for-nav">
+    
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+          
+
+          
+            <a href="../index.html" class="icon icon-home"> macop
+          
+
+          
+          </a>
+
+          
+            
+            
+              <div class="version">
+                1.0.5
+              </div>
+            
+          
+
+          
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+
+          
+        </div>
+
+        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+          
+            
+            
+              
+            
+            
+              <p class="caption"><span class="caption-text">Contents:</span></p>
+<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="../description.html">Description</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../api.html">API</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Documentation</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="introduction.html">1. Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="problem.html">2. Problem instance</a></li>
+<li class="toctree-l2"><a class="reference internal" href="solutions.html">3. Solutions</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../examples.html">Some examples</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
+</ul>
+
+            
+          
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+      
+      <nav class="wy-nav-top" aria-label="top navigation">
+        
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../index.html">macop</a>
+        
+      </nav>
+
+
+      <div class="wy-nav-content">
+        
+        <div class="rst-content">
+        
+          
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+  <ul class="wy-breadcrumbs">
+    
+      <li><a href="../index.html">Docs</a> &raquo;</li>
+        
+      <li>Documentation</li>
+    
+    
+      <li class="wy-breadcrumbs-aside">
+        
+            
+            
+              <a href="https://github.com/prise-3d/macop/blob/master/docs/source/documentations/index.rst" class="fa fa-github"> Edit on GitHub</a>
+            
+          
+        
+      </li>
+    
+  </ul>
+
+  
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+            
+  <div class="section" id="documentation">
+<h1>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h1>
+<a class="reference internal image-reference" href="../_images/logo_macop1.png"><img alt="../_images/logo_macop1.png" class="align-center" src="../_images/logo_macop1.png" style="width: 300px;" /></a>
+<p>This documentation will allow a user who wishes to use the Macop optimisation package to understand both how it works and offers examples of how to implement specific needs.</p>
+<p>It will gradually take up the major ideas developed within <cite>Macop</cite> to allow for rapid development. You can navigate directly via the menu available below to access a specific part of the documentation.</p>
+<div class="toctree-wrapper compound">
+<p class="caption"><span class="caption-text">Contents:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="introduction.html">1. Introduction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="problem.html">2. Problem instance</a></li>
+<li class="toctree-l1"><a class="reference internal" href="solutions.html">3. Solutions</a></li>
+</ul>
+</div>
+</div>
+
+
+           </div>
+           
+          </div>
+          <footer>
+  
+    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+      
+        <a href="introduction.html" class="btn btn-neutral float-right" title="1. Introduction" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
+      
+      
+        <a href="../macop/macop.utils.progress.html" class="btn btn-neutral float-left" title="macop.utils.progress" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+      
+    </div>
+  
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>
+        &copy; Copyright 2020, Jérôme BUISINE
+
+    </p>
+  </div>
+  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 
+
+</footer>
+
+        </div>
+      </div>
+
+    </section>
+
+  </div>
+  
+
+
+  <script type="text/javascript">
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script>
+
+  
+  
+    
+   
+
+</body>
+</html>

File diff suppressed because it is too large
+ 231 - 0
docs/build/html/documentations/introduction.html


File diff suppressed because it is too large
+ 253 - 0
docs/build/html/documentations/problem.html


+ 221 - 0
docs/build/html/documentations/solutions.html

@@ -0,0 +1,221 @@
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+  <meta charset="utf-8">
+  
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  
+  <title>3. Solutions &mdash; macop v1.0.5 documentation</title>
+  
+
+  
+  
+  
+  
+
+  
+  <script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
+  
+    
+      <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
+        <script type="text/javascript" src="../_static/jquery.js"></script>
+        <script type="text/javascript" src="../_static/underscore.js"></script>
+        <script type="text/javascript" src="../_static/doctools.js"></script>
+        <script type="text/javascript" src="../_static/language_data.js"></script>
+    
+    <script type="text/javascript" src="../_static/js/theme.js"></script>
+
+    
+
+  
+  <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+  <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+  <link rel="stylesheet" href="../_static/css/custom.css" type="text/css" />
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" />
+    <link rel="next" title="Some examples" href="../examples.html" />
+    <link rel="prev" title="2. Problem instance" href="problem.html" /> 
+</head>
+
+<body class="wy-body-for-nav">
+
+   
+  <div class="wy-grid-for-nav">
+    
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+          
+
+          
+            <a href="../index.html" class="icon icon-home"> macop
+          
+
+          
+          </a>
+
+          
+            
+            
+              <div class="version">
+                1.0.5
+              </div>
+            
+          
+
+          
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+
+          
+        </div>
+
+        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+          
+            
+            
+              
+            
+            
+              <p class="caption"><span class="caption-text">Contents:</span></p>
+<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="../description.html">Description</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../api.html">API</a></li>
+<li class="toctree-l1 current"><a class="reference internal" href="index.html">Documentation</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="introduction.html">1. Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal" href="problem.html">2. Problem instance</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">3. Solutions</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="../examples.html">Some examples</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
+</ul>
+
+            
+          
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+      
+      <nav class="wy-nav-top" aria-label="top navigation">
+        
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../index.html">macop</a>
+        
+      </nav>
+
+
+      <div class="wy-nav-content">
+        
+        <div class="rst-content">
+        
+          
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+  <ul class="wy-breadcrumbs">
+    
+      <li><a href="../index.html">Docs</a> &raquo;</li>
+        
+          <li><a href="index.html">Documentation</a> &raquo;</li>
+        
+      <li>3. Solutions</li>
+    
+    
+      <li class="wy-breadcrumbs-aside">
+        
+            
+            
+              <a href="https://github.com/prise-3d/macop/blob/master/docs/source/documentations/solutions.rst" class="fa fa-github"> Edit on GitHub</a>
+            
+          
+        
+      </li>
+    
+  </ul>
+
+  
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+            
+  <div class="section" id="solutions">
+<h1>3. Solutions<a class="headerlink" href="#solutions" title="Permalink to this headline">¶</a></h1>
+</div>
+
+
+           </div>
+           
+          </div>
+          <footer>
+  
+    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+      
+        <a href="../examples.html" class="btn btn-neutral float-right" title="Some examples" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
+      
+      
+        <a href="problem.html" class="btn btn-neutral float-left" title="2. Problem instance" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+      
+    </div>
+  
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>
+        &copy; Copyright 2020, Jérôme BUISINE
+
+    </p>
+  </div>
+  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 
+
+</footer>
+
+        </div>
+      </div>
+
+    </section>
+
+  </div>
+  
+
+
+  <script type="text/javascript">
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script>
+
+  
+  
+    
+   
+
+</body>
+</html>

+ 4 - 3
docs/build/html/examples.html

@@ -37,7 +37,7 @@
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="Contributing" href="contributing.html" />
-    <link rel="prev" title="macop.utils.progress" href="macop/macop.utils.progress.html" /> 
+    <link rel="prev" title="3. Solutions" href="documentations/solutions.html" /> 
 </head>
 
 <body class="wy-body-for-nav">
@@ -88,7 +88,8 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="description.html">Description</a></li>
-<li class="toctree-l1"><a class="reference internal" href="macop.html">Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="api.html">API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="documentations/index.html">Documentation</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Some examples</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#some-information">1. Some information</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="#implemented-algorithms">1.1 Implemented algorithms</a></li>
@@ -752,7 +753,7 @@ This is an example, we based our function using classical weighted sum, we can a
         <a href="contributing.html" class="btn btn-neutral float-right" title="Contributing" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
       
       
-        <a href="macop/macop.utils.progress.html" class="btn btn-neutral float-left" title="macop.utils.progress" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+        <a href="documentations/solutions.html" class="btn btn-neutral float-left" title="3. Solutions" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
       
     </div>
   

+ 2 - 1
docs/build/html/genindex.html

@@ -87,7 +87,8 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="description.html">Description</a></li>
-<li class="toctree-l1"><a class="reference internal" href="macop.html">Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="api.html">API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
 </ul>

+ 5 - 3
docs/build/html/index.html

@@ -87,7 +87,8 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="description.html">Description</a></li>
-<li class="toctree-l1"><a class="reference internal" href="macop.html">Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="api.html">API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
 </ul>
@@ -158,7 +159,7 @@
             
   <div class="section" id="minimalist-and-customisable-optimisation-package">
 <h1>Minimalist And Customisable Optimisation Package<a class="headerlink" href="#minimalist-and-customisable-optimisation-package" title="Permalink to this headline">¶</a></h1>
-<a class="reference internal image-reference" href="_images/logo_macop.png"><img alt="_images/logo_macop.png" class="align-center" src="_images/logo_macop.png" style="width: 450px;" /></a>
+<a class="reference internal image-reference" href="_images/logo_macop.png"><img alt="_images/logo_macop.png" class="align-center" src="_images/logo_macop.png" style="width: 300px;" /></a>
 </div>
 <div class="section" id="what-s-macop">
 <h1>What’s <cite>macop</cite> ?<a class="headerlink" href="#what-s-macop" title="Permalink to this headline">¶</a></h1>
@@ -167,7 +168,8 @@
 <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="description.html">Description</a></li>
-<li class="toctree-l1"><a class="reference internal" href="macop.html">Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="api.html">API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
 </ul>

+ 13 - 12
docs/build/html/macop/macop.algorithms.base.html

@@ -37,7 +37,7 @@
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
     <link rel="next" title="macop.algorithms.mono" href="macop.algorithms.mono.html" />
-    <link rel="prev" title="Documentation" href="../macop.html" /> 
+    <link rel="prev" title="API" href="../api.html" /> 
 </head>
 
 <body class="wy-body-for-nav">
@@ -88,22 +88,23 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="../description.html">Description</a></li>
-<li class="toctree-l1 current"><a class="reference internal" href="../macop.html">Documentation</a><ul class="current">
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop">macop</a></li>
-<li class="toctree-l2 current"><a class="reference internal" href="../macop.html#macop-algorithms">macop.algorithms</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop">macop</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="../api.html#macop-algorithms">macop.algorithms</a><ul class="current">
 <li class="toctree-l3 current"><a class="current reference internal" href="#">macop.algorithms.base</a></li>
 <li class="toctree-l3"><a class="reference internal" href="macop.algorithms.mono.html">macop.algorithms.mono</a></li>
 <li class="toctree-l3"><a class="reference internal" href="macop.algorithms.multi.html">macop.algorithms.multi</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-callbacks">macop.callbacks</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-evaluators">macop.evaluators</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-operators">macop.operators</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-policies">macop.policies</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-solution">macop.solution</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-utils">macop.utils</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-callbacks">macop.callbacks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-evaluators">macop.evaluators</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-operators">macop.operators</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-policies">macop.policies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-solution">macop.solution</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-utils">macop.utils</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
 </ul>
@@ -151,7 +152,7 @@
     
       <li><a href="../index.html">Docs</a> &raquo;</li>
         
-          <li><a href="../macop.html">Documentation</a> &raquo;</li>
+          <li><a href="../api.html">API</a> &raquo;</li>
         
       <li>macop.algorithms.base</li>
     
@@ -419,7 +420,7 @@ Check if solution is valid after modification and returns it</p>
         <a href="macop.algorithms.mono.html" class="btn btn-neutral float-right" title="macop.algorithms.mono" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
       
       
-        <a href="../macop.html" class="btn btn-neutral float-left" title="Documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+        <a href="../api.html" class="btn btn-neutral float-left" title="API" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
       
     </div>
   

+ 11 - 10
docs/build/html/macop/macop.algorithms.mono.html

@@ -88,22 +88,23 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="../description.html">Description</a></li>
-<li class="toctree-l1 current"><a class="reference internal" href="../macop.html">Documentation</a><ul class="current">
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop">macop</a></li>
-<li class="toctree-l2 current"><a class="reference internal" href="../macop.html#macop-algorithms">macop.algorithms</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop">macop</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="../api.html#macop-algorithms">macop.algorithms</a><ul class="current">
 <li class="toctree-l3"><a class="reference internal" href="macop.algorithms.base.html">macop.algorithms.base</a></li>
 <li class="toctree-l3 current"><a class="current reference internal" href="#">macop.algorithms.mono</a></li>
 <li class="toctree-l3"><a class="reference internal" href="macop.algorithms.multi.html">macop.algorithms.multi</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-callbacks">macop.callbacks</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-evaluators">macop.evaluators</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-operators">macop.operators</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-policies">macop.policies</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-solution">macop.solution</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-utils">macop.utils</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-callbacks">macop.callbacks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-evaluators">macop.evaluators</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-operators">macop.operators</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-policies">macop.policies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-solution">macop.solution</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-utils">macop.utils</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
 </ul>
@@ -151,7 +152,7 @@
     
       <li><a href="../index.html">Docs</a> &raquo;</li>
         
-          <li><a href="../macop.html">Documentation</a> &raquo;</li>
+          <li><a href="../api.html">API</a> &raquo;</li>
         
       <li>macop.algorithms.mono</li>
     

+ 11 - 10
docs/build/html/macop/macop.algorithms.multi.html

@@ -88,22 +88,23 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="../description.html">Description</a></li>
-<li class="toctree-l1 current"><a class="reference internal" href="../macop.html">Documentation</a><ul class="current">
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop">macop</a></li>
-<li class="toctree-l2 current"><a class="reference internal" href="../macop.html#macop-algorithms">macop.algorithms</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop">macop</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="../api.html#macop-algorithms">macop.algorithms</a><ul class="current">
 <li class="toctree-l3"><a class="reference internal" href="macop.algorithms.base.html">macop.algorithms.base</a></li>
 <li class="toctree-l3"><a class="reference internal" href="macop.algorithms.mono.html">macop.algorithms.mono</a></li>
 <li class="toctree-l3 current"><a class="current reference internal" href="#">macop.algorithms.multi</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-callbacks">macop.callbacks</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-evaluators">macop.evaluators</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-operators">macop.operators</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-policies">macop.policies</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-solution">macop.solution</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-utils">macop.utils</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-callbacks">macop.callbacks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-evaluators">macop.evaluators</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-operators">macop.operators</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-policies">macop.policies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-solution">macop.solution</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-utils">macop.utils</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
 </ul>
@@ -151,7 +152,7 @@
     
       <li><a href="../index.html">Docs</a> &raquo;</li>
         
-          <li><a href="../macop.html">Documentation</a> &raquo;</li>
+          <li><a href="../api.html">API</a> &raquo;</li>
         
       <li>macop.algorithms.multi</li>
     

+ 11 - 10
docs/build/html/macop/macop.callbacks.base.html

@@ -88,23 +88,24 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="../description.html">Description</a></li>
-<li class="toctree-l1 current"><a class="reference internal" href="../macop.html">Documentation</a><ul class="current">
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop">macop</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-algorithms">macop.algorithms</a></li>
-<li class="toctree-l2 current"><a class="reference internal" href="../macop.html#macop-callbacks">macop.callbacks</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop">macop</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-algorithms">macop.algorithms</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="../api.html#macop-callbacks">macop.callbacks</a><ul class="current">
 <li class="toctree-l3 current"><a class="current reference internal" href="#">macop.callbacks.base</a></li>
 <li class="toctree-l3"><a class="reference internal" href="macop.callbacks.classicals.html">macop.callbacks.classicals</a></li>
 <li class="toctree-l3"><a class="reference internal" href="macop.callbacks.multi.html">macop.callbacks.multi</a></li>
 <li class="toctree-l3"><a class="reference internal" href="macop.callbacks.policies.html">macop.callbacks.policies</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-evaluators">macop.evaluators</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-operators">macop.operators</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-policies">macop.policies</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-solution">macop.solution</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-utils">macop.utils</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-evaluators">macop.evaluators</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-operators">macop.operators</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-policies">macop.policies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-solution">macop.solution</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-utils">macop.utils</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
 </ul>
@@ -152,7 +153,7 @@
     
       <li><a href="../index.html">Docs</a> &raquo;</li>
         
-          <li><a href="../macop.html">Documentation</a> &raquo;</li>
+          <li><a href="../api.html">API</a> &raquo;</li>
         
       <li>macop.callbacks.base</li>
     

+ 11 - 10
docs/build/html/macop/macop.callbacks.classicals.html

@@ -88,23 +88,24 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="../description.html">Description</a></li>
-<li class="toctree-l1 current"><a class="reference internal" href="../macop.html">Documentation</a><ul class="current">
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop">macop</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-algorithms">macop.algorithms</a></li>
-<li class="toctree-l2 current"><a class="reference internal" href="../macop.html#macop-callbacks">macop.callbacks</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop">macop</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-algorithms">macop.algorithms</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="../api.html#macop-callbacks">macop.callbacks</a><ul class="current">
 <li class="toctree-l3"><a class="reference internal" href="macop.callbacks.base.html">macop.callbacks.base</a></li>
 <li class="toctree-l3 current"><a class="current reference internal" href="#">macop.callbacks.classicals</a></li>
 <li class="toctree-l3"><a class="reference internal" href="macop.callbacks.multi.html">macop.callbacks.multi</a></li>
 <li class="toctree-l3"><a class="reference internal" href="macop.callbacks.policies.html">macop.callbacks.policies</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-evaluators">macop.evaluators</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-operators">macop.operators</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-policies">macop.policies</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-solution">macop.solution</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-utils">macop.utils</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-evaluators">macop.evaluators</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-operators">macop.operators</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-policies">macop.policies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-solution">macop.solution</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-utils">macop.utils</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
 </ul>
@@ -152,7 +153,7 @@
     
       <li><a href="../index.html">Docs</a> &raquo;</li>
         
-          <li><a href="../macop.html">Documentation</a> &raquo;</li>
+          <li><a href="../api.html">API</a> &raquo;</li>
         
       <li>macop.callbacks.classicals</li>
     

+ 11 - 10
docs/build/html/macop/macop.callbacks.multi.html

@@ -88,23 +88,24 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="../description.html">Description</a></li>
-<li class="toctree-l1 current"><a class="reference internal" href="../macop.html">Documentation</a><ul class="current">
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop">macop</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-algorithms">macop.algorithms</a></li>
-<li class="toctree-l2 current"><a class="reference internal" href="../macop.html#macop-callbacks">macop.callbacks</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop">macop</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-algorithms">macop.algorithms</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="../api.html#macop-callbacks">macop.callbacks</a><ul class="current">
 <li class="toctree-l3"><a class="reference internal" href="macop.callbacks.base.html">macop.callbacks.base</a></li>
 <li class="toctree-l3"><a class="reference internal" href="macop.callbacks.classicals.html">macop.callbacks.classicals</a></li>
 <li class="toctree-l3 current"><a class="current reference internal" href="#">macop.callbacks.multi</a></li>
 <li class="toctree-l3"><a class="reference internal" href="macop.callbacks.policies.html">macop.callbacks.policies</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-evaluators">macop.evaluators</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-operators">macop.operators</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-policies">macop.policies</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-solution">macop.solution</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-utils">macop.utils</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-evaluators">macop.evaluators</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-operators">macop.operators</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-policies">macop.policies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-solution">macop.solution</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-utils">macop.utils</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
 </ul>
@@ -152,7 +153,7 @@
     
       <li><a href="../index.html">Docs</a> &raquo;</li>
         
-          <li><a href="../macop.html">Documentation</a> &raquo;</li>
+          <li><a href="../api.html">API</a> &raquo;</li>
         
       <li>macop.callbacks.multi</li>
     

+ 11 - 10
docs/build/html/macop/macop.callbacks.policies.html

@@ -88,23 +88,24 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="../description.html">Description</a></li>
-<li class="toctree-l1 current"><a class="reference internal" href="../macop.html">Documentation</a><ul class="current">
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop">macop</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-algorithms">macop.algorithms</a></li>
-<li class="toctree-l2 current"><a class="reference internal" href="../macop.html#macop-callbacks">macop.callbacks</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop">macop</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-algorithms">macop.algorithms</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="../api.html#macop-callbacks">macop.callbacks</a><ul class="current">
 <li class="toctree-l3"><a class="reference internal" href="macop.callbacks.base.html">macop.callbacks.base</a></li>
 <li class="toctree-l3"><a class="reference internal" href="macop.callbacks.classicals.html">macop.callbacks.classicals</a></li>
 <li class="toctree-l3"><a class="reference internal" href="macop.callbacks.multi.html">macop.callbacks.multi</a></li>
 <li class="toctree-l3 current"><a class="current reference internal" href="#">macop.callbacks.policies</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-evaluators">macop.evaluators</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-operators">macop.operators</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-policies">macop.policies</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-solution">macop.solution</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-utils">macop.utils</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-evaluators">macop.evaluators</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-operators">macop.operators</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-policies">macop.policies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-solution">macop.solution</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-utils">macop.utils</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
 </ul>
@@ -152,7 +153,7 @@
     
       <li><a href="../index.html">Docs</a> &raquo;</li>
         
-          <li><a href="../macop.html">Documentation</a> &raquo;</li>
+          <li><a href="../api.html">API</a> &raquo;</li>
         
       <li>macop.callbacks.policies</li>
     

+ 11 - 10
docs/build/html/macop/macop.evaluators.base.html

@@ -88,22 +88,23 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="../description.html">Description</a></li>
-<li class="toctree-l1 current"><a class="reference internal" href="../macop.html">Documentation</a><ul class="current">
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop">macop</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-algorithms">macop.algorithms</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-callbacks">macop.callbacks</a></li>
-<li class="toctree-l2 current"><a class="reference internal" href="../macop.html#macop-evaluators">macop.evaluators</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop">macop</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-algorithms">macop.algorithms</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-callbacks">macop.callbacks</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="../api.html#macop-evaluators">macop.evaluators</a><ul class="current">
 <li class="toctree-l3 current"><a class="current reference internal" href="#">macop.evaluators.base</a></li>
 <li class="toctree-l3"><a class="reference internal" href="macop.evaluators.discrete.mono.html">macop.evaluators.discrete.mono</a></li>
 <li class="toctree-l3"><a class="reference internal" href="macop.evaluators.discrete.multi.html">macop.evaluators.discrete.multi</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-operators">macop.operators</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-policies">macop.policies</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-solution">macop.solution</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-utils">macop.utils</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-operators">macop.operators</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-policies">macop.policies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-solution">macop.solution</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-utils">macop.utils</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
 </ul>
@@ -151,7 +152,7 @@
     
       <li><a href="../index.html">Docs</a> &raquo;</li>
         
-          <li><a href="../macop.html">Documentation</a> &raquo;</li>
+          <li><a href="../api.html">API</a> &raquo;</li>
         
       <li>macop.evaluators.base</li>
     

+ 11 - 10
docs/build/html/macop/macop.evaluators.discrete.mono.html

@@ -88,22 +88,23 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="../description.html">Description</a></li>
-<li class="toctree-l1 current"><a class="reference internal" href="../macop.html">Documentation</a><ul class="current">
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop">macop</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-algorithms">macop.algorithms</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-callbacks">macop.callbacks</a></li>
-<li class="toctree-l2 current"><a class="reference internal" href="../macop.html#macop-evaluators">macop.evaluators</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop">macop</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-algorithms">macop.algorithms</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-callbacks">macop.callbacks</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="../api.html#macop-evaluators">macop.evaluators</a><ul class="current">
 <li class="toctree-l3"><a class="reference internal" href="macop.evaluators.base.html">macop.evaluators.base</a></li>
 <li class="toctree-l3 current"><a class="current reference internal" href="#">macop.evaluators.discrete.mono</a></li>
 <li class="toctree-l3"><a class="reference internal" href="macop.evaluators.discrete.multi.html">macop.evaluators.discrete.multi</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-operators">macop.operators</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-policies">macop.policies</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-solution">macop.solution</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-utils">macop.utils</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-operators">macop.operators</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-policies">macop.policies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-solution">macop.solution</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-utils">macop.utils</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
 </ul>
@@ -151,7 +152,7 @@
     
       <li><a href="../index.html">Docs</a> &raquo;</li>
         
-          <li><a href="../macop.html">Documentation</a> &raquo;</li>
+          <li><a href="../api.html">API</a> &raquo;</li>
         
       <li>macop.evaluators.discrete.mono</li>
     

+ 11 - 10
docs/build/html/macop/macop.evaluators.discrete.multi.html

@@ -88,22 +88,23 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="../description.html">Description</a></li>
-<li class="toctree-l1 current"><a class="reference internal" href="../macop.html">Documentation</a><ul class="current">
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop">macop</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-algorithms">macop.algorithms</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-callbacks">macop.callbacks</a></li>
-<li class="toctree-l2 current"><a class="reference internal" href="../macop.html#macop-evaluators">macop.evaluators</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop">macop</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-algorithms">macop.algorithms</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-callbacks">macop.callbacks</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="../api.html#macop-evaluators">macop.evaluators</a><ul class="current">
 <li class="toctree-l3"><a class="reference internal" href="macop.evaluators.base.html">macop.evaluators.base</a></li>
 <li class="toctree-l3"><a class="reference internal" href="macop.evaluators.discrete.mono.html">macop.evaluators.discrete.mono</a></li>
 <li class="toctree-l3 current"><a class="current reference internal" href="#">macop.evaluators.discrete.multi</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-operators">macop.operators</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-policies">macop.policies</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-solution">macop.solution</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-utils">macop.utils</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-operators">macop.operators</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-policies">macop.policies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-solution">macop.solution</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-utils">macop.utils</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
 </ul>
@@ -151,7 +152,7 @@
     
       <li><a href="../index.html">Docs</a> &raquo;</li>
         
-          <li><a href="../macop.html">Documentation</a> &raquo;</li>
+          <li><a href="../api.html">API</a> &raquo;</li>
         
       <li>macop.evaluators.discrete.multi</li>
     

+ 11 - 10
docs/build/html/macop/macop.operators.base.html

@@ -88,12 +88,12 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="../description.html">Description</a></li>
-<li class="toctree-l1 current"><a class="reference internal" href="../macop.html">Documentation</a><ul class="current">
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop">macop</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-algorithms">macop.algorithms</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-callbacks">macop.callbacks</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-evaluators">macop.evaluators</a></li>
-<li class="toctree-l2 current"><a class="reference internal" href="../macop.html#macop-operators">macop.operators</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop">macop</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-algorithms">macop.algorithms</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-callbacks">macop.callbacks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-evaluators">macop.evaluators</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="../api.html#macop-operators">macop.operators</a><ul class="current">
 <li class="toctree-l3 current"><a class="current reference internal" href="#">macop.operators.base</a></li>
 <li class="toctree-l3"><a class="reference internal" href="macop.operators.discrete.mutators.html">macop.operators.discrete.mutators</a></li>
 <li class="toctree-l3"><a class="reference internal" href="macop.operators.discrete.crossovers.html">macop.operators.discrete.crossovers</a></li>
@@ -101,11 +101,12 @@
 <li class="toctree-l3"><a class="reference internal" href="macop.operators.continuous.crossovers.html">macop.operators.continuous.crossovers</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-policies">macop.policies</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-solution">macop.solution</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-utils">macop.utils</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-policies">macop.policies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-solution">macop.solution</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-utils">macop.utils</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
 </ul>
@@ -153,7 +154,7 @@
     
       <li><a href="../index.html">Docs</a> &raquo;</li>
         
-          <li><a href="../macop.html">Documentation</a> &raquo;</li>
+          <li><a href="../api.html">API</a> &raquo;</li>
         
       <li>macop.operators.base</li>
     

+ 11 - 10
docs/build/html/macop/macop.operators.continuous.crossovers.html

@@ -88,12 +88,12 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="../description.html">Description</a></li>
-<li class="toctree-l1 current"><a class="reference internal" href="../macop.html">Documentation</a><ul class="current">
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop">macop</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-algorithms">macop.algorithms</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-callbacks">macop.callbacks</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-evaluators">macop.evaluators</a></li>
-<li class="toctree-l2 current"><a class="reference internal" href="../macop.html#macop-operators">macop.operators</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop">macop</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-algorithms">macop.algorithms</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-callbacks">macop.callbacks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-evaluators">macop.evaluators</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="../api.html#macop-operators">macop.operators</a><ul class="current">
 <li class="toctree-l3"><a class="reference internal" href="macop.operators.base.html">macop.operators.base</a></li>
 <li class="toctree-l3"><a class="reference internal" href="macop.operators.discrete.mutators.html">macop.operators.discrete.mutators</a></li>
 <li class="toctree-l3"><a class="reference internal" href="macop.operators.discrete.crossovers.html">macop.operators.discrete.crossovers</a></li>
@@ -101,11 +101,12 @@
 <li class="toctree-l3 current"><a class="current reference internal" href="#">macop.operators.continuous.crossovers</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-policies">macop.policies</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-solution">macop.solution</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-utils">macop.utils</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-policies">macop.policies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-solution">macop.solution</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-utils">macop.utils</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
 </ul>
@@ -153,7 +154,7 @@
     
       <li><a href="../index.html">Docs</a> &raquo;</li>
         
-          <li><a href="../macop.html">Documentation</a> &raquo;</li>
+          <li><a href="../api.html">API</a> &raquo;</li>
         
       <li>macop.operators.continuous.crossovers</li>
     

+ 11 - 10
docs/build/html/macop/macop.operators.continuous.mutators.html

@@ -88,12 +88,12 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="../description.html">Description</a></li>
-<li class="toctree-l1 current"><a class="reference internal" href="../macop.html">Documentation</a><ul class="current">
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop">macop</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-algorithms">macop.algorithms</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-callbacks">macop.callbacks</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-evaluators">macop.evaluators</a></li>
-<li class="toctree-l2 current"><a class="reference internal" href="../macop.html#macop-operators">macop.operators</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop">macop</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-algorithms">macop.algorithms</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-callbacks">macop.callbacks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-evaluators">macop.evaluators</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="../api.html#macop-operators">macop.operators</a><ul class="current">
 <li class="toctree-l3"><a class="reference internal" href="macop.operators.base.html">macop.operators.base</a></li>
 <li class="toctree-l3"><a class="reference internal" href="macop.operators.discrete.mutators.html">macop.operators.discrete.mutators</a></li>
 <li class="toctree-l3"><a class="reference internal" href="macop.operators.discrete.crossovers.html">macop.operators.discrete.crossovers</a></li>
@@ -101,11 +101,12 @@
 <li class="toctree-l3"><a class="reference internal" href="macop.operators.continuous.crossovers.html">macop.operators.continuous.crossovers</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-policies">macop.policies</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-solution">macop.solution</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-utils">macop.utils</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-policies">macop.policies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-solution">macop.solution</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-utils">macop.utils</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
 </ul>
@@ -153,7 +154,7 @@
     
       <li><a href="../index.html">Docs</a> &raquo;</li>
         
-          <li><a href="../macop.html">Documentation</a> &raquo;</li>
+          <li><a href="../api.html">API</a> &raquo;</li>
         
       <li>macop.operators.continuous.mutators</li>
     

+ 11 - 10
docs/build/html/macop/macop.operators.discrete.crossovers.html

@@ -88,12 +88,12 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="../description.html">Description</a></li>
-<li class="toctree-l1 current"><a class="reference internal" href="../macop.html">Documentation</a><ul class="current">
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop">macop</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-algorithms">macop.algorithms</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-callbacks">macop.callbacks</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-evaluators">macop.evaluators</a></li>
-<li class="toctree-l2 current"><a class="reference internal" href="../macop.html#macop-operators">macop.operators</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop">macop</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-algorithms">macop.algorithms</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-callbacks">macop.callbacks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-evaluators">macop.evaluators</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="../api.html#macop-operators">macop.operators</a><ul class="current">
 <li class="toctree-l3"><a class="reference internal" href="macop.operators.base.html">macop.operators.base</a></li>
 <li class="toctree-l3"><a class="reference internal" href="macop.operators.discrete.mutators.html">macop.operators.discrete.mutators</a></li>
 <li class="toctree-l3 current"><a class="current reference internal" href="#">macop.operators.discrete.crossovers</a></li>
@@ -101,11 +101,12 @@
 <li class="toctree-l3"><a class="reference internal" href="macop.operators.continuous.crossovers.html">macop.operators.continuous.crossovers</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-policies">macop.policies</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-solution">macop.solution</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-utils">macop.utils</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-policies">macop.policies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-solution">macop.solution</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-utils">macop.utils</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
 </ul>
@@ -153,7 +154,7 @@
     
       <li><a href="../index.html">Docs</a> &raquo;</li>
         
-          <li><a href="../macop.html">Documentation</a> &raquo;</li>
+          <li><a href="../api.html">API</a> &raquo;</li>
         
       <li>macop.operators.discrete.crossovers</li>
     

+ 11 - 10
docs/build/html/macop/macop.operators.discrete.mutators.html

@@ -88,12 +88,12 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="../description.html">Description</a></li>
-<li class="toctree-l1 current"><a class="reference internal" href="../macop.html">Documentation</a><ul class="current">
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop">macop</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-algorithms">macop.algorithms</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-callbacks">macop.callbacks</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-evaluators">macop.evaluators</a></li>
-<li class="toctree-l2 current"><a class="reference internal" href="../macop.html#macop-operators">macop.operators</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop">macop</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-algorithms">macop.algorithms</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-callbacks">macop.callbacks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-evaluators">macop.evaluators</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="../api.html#macop-operators">macop.operators</a><ul class="current">
 <li class="toctree-l3"><a class="reference internal" href="macop.operators.base.html">macop.operators.base</a></li>
 <li class="toctree-l3 current"><a class="current reference internal" href="#">macop.operators.discrete.mutators</a></li>
 <li class="toctree-l3"><a class="reference internal" href="macop.operators.discrete.crossovers.html">macop.operators.discrete.crossovers</a></li>
@@ -101,11 +101,12 @@
 <li class="toctree-l3"><a class="reference internal" href="macop.operators.continuous.crossovers.html">macop.operators.continuous.crossovers</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-policies">macop.policies</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-solution">macop.solution</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-utils">macop.utils</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-policies">macop.policies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-solution">macop.solution</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-utils">macop.utils</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
 </ul>
@@ -153,7 +154,7 @@
     
       <li><a href="../index.html">Docs</a> &raquo;</li>
         
-          <li><a href="../macop.html">Documentation</a> &raquo;</li>
+          <li><a href="../api.html">API</a> &raquo;</li>
         
       <li>macop.operators.discrete.mutators</li>
     

+ 11 - 10
docs/build/html/macop/macop.policies.base.html

@@ -88,22 +88,23 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="../description.html">Description</a></li>
-<li class="toctree-l1 current"><a class="reference internal" href="../macop.html">Documentation</a><ul class="current">
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop">macop</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-algorithms">macop.algorithms</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-callbacks">macop.callbacks</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-evaluators">macop.evaluators</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-operators">macop.operators</a></li>
-<li class="toctree-l2 current"><a class="reference internal" href="../macop.html#macop-policies">macop.policies</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop">macop</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-algorithms">macop.algorithms</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-callbacks">macop.callbacks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-evaluators">macop.evaluators</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-operators">macop.operators</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="../api.html#macop-policies">macop.policies</a><ul class="current">
 <li class="toctree-l3 current"><a class="current reference internal" href="#">macop.policies.base</a></li>
 <li class="toctree-l3"><a class="reference internal" href="macop.policies.classicals.html">macop.policies.classicals</a></li>
 <li class="toctree-l3"><a class="reference internal" href="macop.policies.reinforcement.html">macop.policies.reinforcement</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-solution">macop.solution</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-utils">macop.utils</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-solution">macop.solution</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-utils">macop.utils</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
 </ul>
@@ -151,7 +152,7 @@
     
       <li><a href="../index.html">Docs</a> &raquo;</li>
         
-          <li><a href="../macop.html">Documentation</a> &raquo;</li>
+          <li><a href="../api.html">API</a> &raquo;</li>
         
       <li>macop.policies.base</li>
     

+ 11 - 10
docs/build/html/macop/macop.policies.classicals.html

@@ -88,22 +88,23 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="../description.html">Description</a></li>
-<li class="toctree-l1 current"><a class="reference internal" href="../macop.html">Documentation</a><ul class="current">
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop">macop</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-algorithms">macop.algorithms</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-callbacks">macop.callbacks</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-evaluators">macop.evaluators</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-operators">macop.operators</a></li>
-<li class="toctree-l2 current"><a class="reference internal" href="../macop.html#macop-policies">macop.policies</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop">macop</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-algorithms">macop.algorithms</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-callbacks">macop.callbacks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-evaluators">macop.evaluators</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-operators">macop.operators</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="../api.html#macop-policies">macop.policies</a><ul class="current">
 <li class="toctree-l3"><a class="reference internal" href="macop.policies.base.html">macop.policies.base</a></li>
 <li class="toctree-l3 current"><a class="current reference internal" href="#">macop.policies.classicals</a></li>
 <li class="toctree-l3"><a class="reference internal" href="macop.policies.reinforcement.html">macop.policies.reinforcement</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-solution">macop.solution</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-utils">macop.utils</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-solution">macop.solution</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-utils">macop.utils</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
 </ul>
@@ -151,7 +152,7 @@
     
       <li><a href="../index.html">Docs</a> &raquo;</li>
         
-          <li><a href="../macop.html">Documentation</a> &raquo;</li>
+          <li><a href="../api.html">API</a> &raquo;</li>
         
       <li>macop.policies.classicals</li>
     

+ 11 - 10
docs/build/html/macop/macop.policies.reinforcement.html

@@ -88,22 +88,23 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="../description.html">Description</a></li>
-<li class="toctree-l1 current"><a class="reference internal" href="../macop.html">Documentation</a><ul class="current">
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop">macop</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-algorithms">macop.algorithms</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-callbacks">macop.callbacks</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-evaluators">macop.evaluators</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-operators">macop.operators</a></li>
-<li class="toctree-l2 current"><a class="reference internal" href="../macop.html#macop-policies">macop.policies</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop">macop</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-algorithms">macop.algorithms</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-callbacks">macop.callbacks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-evaluators">macop.evaluators</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-operators">macop.operators</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="../api.html#macop-policies">macop.policies</a><ul class="current">
 <li class="toctree-l3"><a class="reference internal" href="macop.policies.base.html">macop.policies.base</a></li>
 <li class="toctree-l3"><a class="reference internal" href="macop.policies.classicals.html">macop.policies.classicals</a></li>
 <li class="toctree-l3 current"><a class="current reference internal" href="#">macop.policies.reinforcement</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-solution">macop.solution</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-utils">macop.utils</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-solution">macop.solution</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-utils">macop.utils</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
 </ul>
@@ -151,7 +152,7 @@
     
       <li><a href="../index.html">Docs</a> &raquo;</li>
         
-          <li><a href="../macop.html">Documentation</a> &raquo;</li>
+          <li><a href="../api.html">API</a> &raquo;</li>
         
       <li>macop.policies.reinforcement</li>
     

+ 11 - 10
docs/build/html/macop/macop.solutions.base.html

@@ -88,22 +88,23 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="../description.html">Description</a></li>
-<li class="toctree-l1 current"><a class="reference internal" href="../macop.html">Documentation</a><ul class="current">
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop">macop</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-algorithms">macop.algorithms</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-callbacks">macop.callbacks</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-evaluators">macop.evaluators</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-operators">macop.operators</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-policies">macop.policies</a></li>
-<li class="toctree-l2 current"><a class="reference internal" href="../macop.html#macop-solution">macop.solution</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop">macop</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-algorithms">macop.algorithms</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-callbacks">macop.callbacks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-evaluators">macop.evaluators</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-operators">macop.operators</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-policies">macop.policies</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="../api.html#macop-solution">macop.solution</a><ul class="current">
 <li class="toctree-l3 current"><a class="current reference internal" href="#">macop.solutions.base</a></li>
 <li class="toctree-l3"><a class="reference internal" href="macop.solutions.discrete.html">macop.solutions.discrete</a></li>
 <li class="toctree-l3"><a class="reference internal" href="macop.solutions.continuous.html">macop.solutions.continuous</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-utils">macop.utils</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-utils">macop.utils</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
 </ul>
@@ -151,7 +152,7 @@
     
       <li><a href="../index.html">Docs</a> &raquo;</li>
         
-          <li><a href="../macop.html">Documentation</a> &raquo;</li>
+          <li><a href="../api.html">API</a> &raquo;</li>
         
       <li>macop.solutions.base</li>
     

+ 11 - 10
docs/build/html/macop/macop.solutions.continuous.html

@@ -88,22 +88,23 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="../description.html">Description</a></li>
-<li class="toctree-l1 current"><a class="reference internal" href="../macop.html">Documentation</a><ul class="current">
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop">macop</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-algorithms">macop.algorithms</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-callbacks">macop.callbacks</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-evaluators">macop.evaluators</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-operators">macop.operators</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-policies">macop.policies</a></li>
-<li class="toctree-l2 current"><a class="reference internal" href="../macop.html#macop-solution">macop.solution</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop">macop</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-algorithms">macop.algorithms</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-callbacks">macop.callbacks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-evaluators">macop.evaluators</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-operators">macop.operators</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-policies">macop.policies</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="../api.html#macop-solution">macop.solution</a><ul class="current">
 <li class="toctree-l3"><a class="reference internal" href="macop.solutions.base.html">macop.solutions.base</a></li>
 <li class="toctree-l3"><a class="reference internal" href="macop.solutions.discrete.html">macop.solutions.discrete</a></li>
 <li class="toctree-l3 current"><a class="current reference internal" href="#">macop.solutions.continuous</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-utils">macop.utils</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-utils">macop.utils</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
 </ul>
@@ -151,7 +152,7 @@
     
       <li><a href="../index.html">Docs</a> &raquo;</li>
         
-          <li><a href="../macop.html">Documentation</a> &raquo;</li>
+          <li><a href="../api.html">API</a> &raquo;</li>
         
       <li>macop.solutions.continuous</li>
     

+ 11 - 10
docs/build/html/macop/macop.solutions.discrete.html

@@ -88,22 +88,23 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="../description.html">Description</a></li>
-<li class="toctree-l1 current"><a class="reference internal" href="../macop.html">Documentation</a><ul class="current">
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop">macop</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-algorithms">macop.algorithms</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-callbacks">macop.callbacks</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-evaluators">macop.evaluators</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-operators">macop.operators</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-policies">macop.policies</a></li>
-<li class="toctree-l2 current"><a class="reference internal" href="../macop.html#macop-solution">macop.solution</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop">macop</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-algorithms">macop.algorithms</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-callbacks">macop.callbacks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-evaluators">macop.evaluators</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-operators">macop.operators</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-policies">macop.policies</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="../api.html#macop-solution">macop.solution</a><ul class="current">
 <li class="toctree-l3"><a class="reference internal" href="macop.solutions.base.html">macop.solutions.base</a></li>
 <li class="toctree-l3 current"><a class="current reference internal" href="#">macop.solutions.discrete</a></li>
 <li class="toctree-l3"><a class="reference internal" href="macop.solutions.continuous.html">macop.solutions.continuous</a></li>
 </ul>
 </li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-utils">macop.utils</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-utils">macop.utils</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
 </ul>
@@ -151,7 +152,7 @@
     
       <li><a href="../index.html">Docs</a> &raquo;</li>
         
-          <li><a href="../macop.html">Documentation</a> &raquo;</li>
+          <li><a href="../api.html">API</a> &raquo;</li>
         
       <li>macop.solutions.discrete</li>
     

+ 13 - 12
docs/build/html/macop/macop.utils.progress.html

@@ -36,7 +36,7 @@
   <link rel="stylesheet" href="../_static/css/custom.css" type="text/css" />
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
-    <link rel="next" title="Some examples" href="../examples.html" />
+    <link rel="next" title="Documentation" href="../documentations/index.html" />
     <link rel="prev" title="macop.solutions.continuous" href="macop.solutions.continuous.html" /> 
 </head>
 
@@ -88,20 +88,21 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="../description.html">Description</a></li>
-<li class="toctree-l1 current"><a class="reference internal" href="../macop.html">Documentation</a><ul class="current">
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop">macop</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-algorithms">macop.algorithms</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-callbacks">macop.callbacks</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-evaluators">macop.evaluators</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-operators">macop.operators</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-policies">macop.policies</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-solution">macop.solution</a></li>
-<li class="toctree-l2 current"><a class="reference internal" href="../macop.html#macop-utils">macop.utils</a><ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop">macop</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-algorithms">macop.algorithms</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-callbacks">macop.callbacks</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-evaluators">macop.evaluators</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-operators">macop.operators</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-policies">macop.policies</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-solution">macop.solution</a></li>
+<li class="toctree-l2 current"><a class="reference internal" href="../api.html#macop-utils">macop.utils</a><ul class="current">
 <li class="toctree-l3 current"><a class="current reference internal" href="#">macop.utils.progress</a></li>
 </ul>
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="../documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
 </ul>
@@ -149,7 +150,7 @@
     
       <li><a href="../index.html">Docs</a> &raquo;</li>
         
-          <li><a href="../macop.html">Documentation</a> &raquo;</li>
+          <li><a href="../api.html">API</a> &raquo;</li>
         
       <li>macop.utils.progress</li>
     
@@ -261,7 +262,7 @@
   
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
       
-        <a href="../examples.html" class="btn btn-neutral float-right" title="Some examples" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
+        <a href="../documentations/index.html" class="btn btn-neutral float-right" title="Documentation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
       
       
         <a href="macop.solutions.continuous.html" class="btn btn-neutral float-left" title="macop.solutions.continuous" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

BIN
docs/build/html/objects.inv


+ 2 - 1
docs/build/html/py-modindex.html

@@ -89,7 +89,8 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="description.html">Description</a></li>
-<li class="toctree-l1"><a class="reference internal" href="macop.html">Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="api.html">API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
 </ul>

+ 2 - 1
docs/build/html/search.html

@@ -87,7 +87,8 @@
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="description.html">Description</a></li>
-<li class="toctree-l1"><a class="reference internal" href="macop.html">Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="api.html">API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="documentations/index.html">Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="examples.html">Some examples</a></li>
 <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
 </ul>

File diff suppressed because it is too large
+ 1 - 1
docs/build/html/searchindex.js


BIN
docs/source/_static/documentation/knapsack_problem.png


+ 1 - 1
docs/source/macop.rst

@@ -1,4 +1,4 @@
-Documentation
+API
 =============
 
 macop

+ 18 - 0
docs/source/documentations/index.rst

@@ -0,0 +1,18 @@
+Documentation
+==============
+
+.. image:: ../_static/logo_macop.png
+   :width: 300 px
+   :align: center
+
+This documentation will allow a user who wishes to use the Macop optimisation package to understand both how it works and offers examples of how to implement specific needs.
+
+It will gradually take up the major ideas developed within `Macop` to allow for rapid development. You can navigate directly via the menu available below to access a specific part of the documentation.
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Contents:
+
+   introduction
+   problem
+   solutions

File diff suppressed because it is too large
+ 14 - 0
docs/source/documentations/introduction.rst


+ 42 - 0
docs/source/documentations/problem.rst

@@ -0,0 +1,42 @@
+2. Problem instance
+===================
+
+
+In this tutorial, we introduce the way of using `macop` and running your algorithm quickly.
+
+2.1 Problem definition
+~~~~~~~~~~~~~~~~~~~~~~
+
+.. image:: ../_static/documentation/knapsack_problem.png
+   :width:  300 px
+   :align: center
+
+
+
+
+
+2.2 Problem implementation
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Hence, we define our problem in Python:
+
+- value of each component of knapsack
+- weight associated to each of these components (objects)
+
+.. code:: python
+    
+    """
+    imports part
+    """
+    import random
+
+    """
+    Problem definition
+    """
+    random.seed(42)
+
+    elements_score = [ random.randint(1, 20) for _ in range(30) ] # value of each object
+    elements_weight = [ random.randint(5, 25) for _ in range(30) ] # weight of each object
+
+First of all we need to define the kind of solution which best represent the problem. As example, we use the well known knapsack problem using 30 objects (solution size of 30).
+

+ 3 - 0
docs/source/documentations/solutions.rst

@@ -0,0 +1,3 @@
+3. Solutions
+=============
+

+ 3 - 2
docs/source/index.rst

@@ -2,7 +2,7 @@ Minimalist And Customisable Optimisation Package
 ================================================
 
 .. image:: _static/logo_macop.png
-   :width: 450 px
+   :width: 300 px
    :align: center
 
 What's `macop` ?
@@ -15,7 +15,8 @@ What's `macop` ?
    :caption: Contents:
 
    description
-   macop
+   api
+   documentations/index
    examples
    contributing