macop.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364
  1. <!DOCTYPE html>
  2. <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
  3. <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
  4. <head>
  5. <meta charset="utf-8">
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <title>Documentation &mdash; macop v0.1.4 documentation</title>
  8. <script type="text/javascript" src="_static/js/modernizr.min.js"></script>
  9. <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
  10. <script type="text/javascript" src="_static/jquery.js"></script>
  11. <script type="text/javascript" src="_static/underscore.js"></script>
  12. <script type="text/javascript" src="_static/doctools.js"></script>
  13. <script type="text/javascript" src="_static/language_data.js"></script>
  14. <script type="text/javascript" src="_static/js/theme.js"></script>
  15. <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  16. <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
  17. <link rel="index" title="Index" href="genindex.html" />
  18. <link rel="search" title="Search" href="search.html" />
  19. <link rel="next" title="macop.algorithms.Algorithm" href="macop/macop.algorithms.Algorithm.html" />
  20. <link rel="prev" title="Description" href="description.html" />
  21. </head>
  22. <body class="wy-body-for-nav">
  23. <div class="wy-grid-for-nav">
  24. <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  25. <div class="wy-side-scroll">
  26. <div class="wy-side-nav-search" >
  27. <a href="index.html" class="icon icon-home"> macop
  28. </a>
  29. <div class="version">
  30. 0.1.4
  31. </div>
  32. <div role="search">
  33. <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
  34. <input type="text" name="q" placeholder="Search docs" />
  35. <input type="hidden" name="check_keywords" value="yes" />
  36. <input type="hidden" name="area" value="default" />
  37. </form>
  38. </div>
  39. </div>
  40. <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  41. <p class="caption"><span class="caption-text">Contents:</span></p>
  42. <ul class="current">
  43. <li class="toctree-l1"><a class="reference internal" href="description.html">Description</a></li>
  44. <li class="toctree-l1 current"><a class="current reference internal" href="#">Documentation</a><ul>
  45. <li class="toctree-l2"><a class="reference internal" href="#macop">macop</a></li>
  46. <li class="toctree-l2"><a class="reference internal" href="#macop-algorithms">macop.algorithms</a><ul>
  47. <li class="toctree-l3"><a class="reference internal" href="macop/macop.algorithms.Algorithm.html">macop.algorithms.Algorithm</a></li>
  48. <li class="toctree-l3"><a class="reference internal" href="macop/macop.algorithms.IteratedLocalSearch.html">macop.algorithms.IteratedLocalSearch</a></li>
  49. <li class="toctree-l3"><a class="reference internal" href="macop/macop.algorithms.LocalSearch.html">macop.algorithms.LocalSearch</a></li>
  50. </ul>
  51. </li>
  52. <li class="toctree-l2"><a class="reference internal" href="#macop-checkpoints">macop.checkpoints</a><ul>
  53. <li class="toctree-l3"><a class="reference internal" href="macop/macop.checkpoints.BasicCheckpoint.html">macop.checkpoints.BasicCheckpoint</a></li>
  54. <li class="toctree-l3"><a class="reference internal" href="macop/macop.checkpoints.Checkpoint.html">macop.checkpoints.Checkpoint</a></li>
  55. </ul>
  56. </li>
  57. <li class="toctree-l2"><a class="reference internal" href="#macop-evaluators">macop.evaluators</a><ul>
  58. <li class="toctree-l3"><a class="reference internal" href="macop/macop.evaluators.EvaluatorExample.html">macop.evaluators.EvaluatorExample</a></li>
  59. </ul>
  60. </li>
  61. <li class="toctree-l2"><a class="reference internal" href="#macop-operators">macop.operators</a><ul>
  62. <li class="toctree-l3"><a class="reference internal" href="macop/macop.operators.crossovers.Crossover.html">macop.operators.crossovers.Crossover</a></li>
  63. <li class="toctree-l3"><a class="reference internal" href="macop/macop.operators.crossovers.RandomSplitCrossover.html">macop.operators.crossovers.RandomSplitCrossover</a></li>
  64. <li class="toctree-l3"><a class="reference internal" href="macop/macop.operators.crossovers.SimpleCrossover.html">macop.operators.crossovers.SimpleCrossover</a></li>
  65. <li class="toctree-l3"><a class="reference internal" href="macop/macop.operators.mutators.Mutation.html">macop.operators.mutators.Mutation</a></li>
  66. <li class="toctree-l3"><a class="reference internal" href="macop/macop.operators.mutators.SimpleBinaryMutation.html">macop.operators.mutators.SimpleBinaryMutation</a></li>
  67. <li class="toctree-l3"><a class="reference internal" href="macop/macop.operators.mutators.SimpleMutation.html">macop.operators.mutators.SimpleMutation</a></li>
  68. <li class="toctree-l3"><a class="reference internal" href="macop/macop.operators.policies.Policy.html">macop.operators.policies.Policy</a></li>
  69. <li class="toctree-l3"><a class="reference internal" href="macop/macop.operators.policies.RandomPolicy.html">macop.operators.policies.RandomPolicy</a></li>
  70. <li class="toctree-l3"><a class="reference internal" href="macop/macop.operators.Operator.html">macop.operators.Operator</a></li>
  71. </ul>
  72. </li>
  73. <li class="toctree-l2"><a class="reference internal" href="#macop-solution">macop.solution</a><ul>
  74. <li class="toctree-l3"><a class="reference internal" href="macop/macop.solutions.BinarySolution.html">macop.solutions.BinarySolution</a></li>
  75. <li class="toctree-l3"><a class="reference internal" href="macop/macop.solutions.CombinatoryIntegerSolution.html">macop.solutions.CombinatoryIntegerSolution</a></li>
  76. <li class="toctree-l3"><a class="reference internal" href="macop/macop.solutions.IntegerSolution.html">macop.solutions.IntegerSolution</a></li>
  77. <li class="toctree-l3"><a class="reference internal" href="macop/macop.solutions.Solution.html">macop.solutions.Solution</a></li>
  78. </ul>
  79. </li>
  80. </ul>
  81. </li>
  82. <li class="toctree-l1"><a class="reference internal" href="examples.html">Some examples</a></li>
  83. <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
  84. </ul>
  85. </div>
  86. </div>
  87. </nav>
  88. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  89. <nav class="wy-nav-top" aria-label="top navigation">
  90. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  91. <a href="index.html">macop</a>
  92. </nav>
  93. <div class="wy-nav-content">
  94. <div class="rst-content">
  95. <div role="navigation" aria-label="breadcrumbs navigation">
  96. <ul class="wy-breadcrumbs">
  97. <li><a href="index.html">Docs</a> &raquo;</li>
  98. <li>Documentation</li>
  99. <li class="wy-breadcrumbs-aside">
  100. <a href="https://github.com/prise-3d/macop/blob/master/docs/source/macop.rst" class="fa fa-github"> Edit on GitHub</a>
  101. </li>
  102. </ul>
  103. <hr/>
  104. </div>
  105. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  106. <div itemprop="articleBody">
  107. <div class="section" id="documentation">
  108. <h1>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h1>
  109. <div class="section" id="macop">
  110. <h2>macop<a class="headerlink" href="#macop" title="Permalink to this headline">¶</a></h2>
  111. </div>
  112. <div class="section" id="macop-algorithms">
  113. <h2>macop.algorithms<a class="headerlink" href="#macop-algorithms" title="Permalink to this headline">¶</a></h2>
  114. <table class="longtable docutils align-default">
  115. <colgroup>
  116. <col style="width: 10%" />
  117. <col style="width: 90%" />
  118. </colgroup>
  119. <tbody>
  120. <tr class="row-odd"><td><p><a class="reference internal" href="macop/macop.algorithms.Algorithm.html#module-macop.algorithms.Algorithm" title="macop.algorithms.Algorithm"><code class="xref py py-obj docutils literal notranslate"><span class="pre">macop.algorithms.Algorithm</span></code></a></p></td>
  121. <td><p>Abstract Algorithm class used as basic algorithm implementation with some specific initialization</p></td>
  122. </tr>
  123. <tr class="row-even"><td><p><a class="reference internal" href="macop/macop.algorithms.IteratedLocalSearch.html#module-macop.algorithms.IteratedLocalSearch" title="macop.algorithms.IteratedLocalSearch"><code class="xref py py-obj docutils literal notranslate"><span class="pre">macop.algorithms.IteratedLocalSearch</span></code></a></p></td>
  124. <td><p>Iterated Local Search Algorithm implementation</p></td>
  125. </tr>
  126. <tr class="row-odd"><td><p><a class="reference internal" href="macop/macop.algorithms.LocalSearch.html#module-macop.algorithms.LocalSearch" title="macop.algorithms.LocalSearch"><code class="xref py py-obj docutils literal notranslate"><span class="pre">macop.algorithms.LocalSearch</span></code></a></p></td>
  127. <td><p>Local Search algorithm</p></td>
  128. </tr>
  129. </tbody>
  130. </table>
  131. </div>
  132. <div class="section" id="macop-checkpoints">
  133. <h2>macop.checkpoints<a class="headerlink" href="#macop-checkpoints" title="Permalink to this headline">¶</a></h2>
  134. <table class="longtable docutils align-default">
  135. <colgroup>
  136. <col style="width: 10%" />
  137. <col style="width: 90%" />
  138. </colgroup>
  139. <tbody>
  140. <tr class="row-odd"><td><p><a class="reference internal" href="macop/macop.checkpoints.BasicCheckpoint.html#module-macop.checkpoints.BasicCheckpoint" title="macop.checkpoints.BasicCheckpoint"><code class="xref py py-obj docutils literal notranslate"><span class="pre">macop.checkpoints.BasicCheckpoint</span></code></a></p></td>
  141. <td><p></p></td>
  142. </tr>
  143. <tr class="row-even"><td><p><a class="reference internal" href="macop/macop.checkpoints.Checkpoint.html#module-macop.checkpoints.Checkpoint" title="macop.checkpoints.Checkpoint"><code class="xref py py-obj docutils literal notranslate"><span class="pre">macop.checkpoints.Checkpoint</span></code></a></p></td>
  144. <td><p>Abstract Checkpoint class</p></td>
  145. </tr>
  146. </tbody>
  147. </table>
  148. </div>
  149. <div class="section" id="macop-evaluators">
  150. <h2>macop.evaluators<a class="headerlink" href="#macop-evaluators" title="Permalink to this headline">¶</a></h2>
  151. <table class="longtable docutils align-default">
  152. <colgroup>
  153. <col style="width: 10%" />
  154. <col style="width: 90%" />
  155. </colgroup>
  156. <tbody>
  157. <tr class="row-odd"><td><p><a class="reference internal" href="macop/macop.evaluators.EvaluatorExample.html#module-macop.evaluators.EvaluatorExample" title="macop.evaluators.EvaluatorExample"><code class="xref py py-obj docutils literal notranslate"><span class="pre">macop.evaluators.EvaluatorExample</span></code></a></p></td>
  158. <td><p></p></td>
  159. </tr>
  160. </tbody>
  161. </table>
  162. </div>
  163. <div class="section" id="macop-operators">
  164. <h2>macop.operators<a class="headerlink" href="#macop-operators" title="Permalink to this headline">¶</a></h2>
  165. <table class="longtable docutils align-default">
  166. <colgroup>
  167. <col style="width: 10%" />
  168. <col style="width: 90%" />
  169. </colgroup>
  170. <tbody>
  171. <tr class="row-odd"><td><p><a class="reference internal" href="macop/macop.operators.crossovers.Crossover.html#module-macop.operators.crossovers.Crossover" title="macop.operators.crossovers.Crossover"><code class="xref py py-obj docutils literal notranslate"><span class="pre">macop.operators.crossovers.Crossover</span></code></a></p></td>
  172. <td><p></p></td>
  173. </tr>
  174. <tr class="row-even"><td><p><a class="reference internal" href="macop/macop.operators.crossovers.RandomSplitCrossover.html#module-macop.operators.crossovers.RandomSplitCrossover" title="macop.operators.crossovers.RandomSplitCrossover"><code class="xref py py-obj docutils literal notranslate"><span class="pre">macop.operators.crossovers.RandomSplitCrossover</span></code></a></p></td>
  175. <td><p></p></td>
  176. </tr>
  177. <tr class="row-odd"><td><p><a class="reference internal" href="macop/macop.operators.crossovers.SimpleCrossover.html#module-macop.operators.crossovers.SimpleCrossover" title="macop.operators.crossovers.SimpleCrossover"><code class="xref py py-obj docutils literal notranslate"><span class="pre">macop.operators.crossovers.SimpleCrossover</span></code></a></p></td>
  178. <td><p></p></td>
  179. </tr>
  180. <tr class="row-even"><td><p><a class="reference internal" href="macop/macop.operators.mutators.Mutation.html#module-macop.operators.mutators.Mutation" title="macop.operators.mutators.Mutation"><code class="xref py py-obj docutils literal notranslate"><span class="pre">macop.operators.mutators.Mutation</span></code></a></p></td>
  181. <td><p></p></td>
  182. </tr>
  183. <tr class="row-odd"><td><p><a class="reference internal" href="macop/macop.operators.mutators.SimpleBinaryMutation.html#module-macop.operators.mutators.SimpleBinaryMutation" title="macop.operators.mutators.SimpleBinaryMutation"><code class="xref py py-obj docutils literal notranslate"><span class="pre">macop.operators.mutators.SimpleBinaryMutation</span></code></a></p></td>
  184. <td><p></p></td>
  185. </tr>
  186. <tr class="row-even"><td><p><a class="reference internal" href="macop/macop.operators.mutators.SimpleMutation.html#module-macop.operators.mutators.SimpleMutation" title="macop.operators.mutators.SimpleMutation"><code class="xref py py-obj docutils literal notranslate"><span class="pre">macop.operators.mutators.SimpleMutation</span></code></a></p></td>
  187. <td><p></p></td>
  188. </tr>
  189. <tr class="row-odd"><td><p><a class="reference internal" href="macop/macop.operators.policies.Policy.html#module-macop.operators.policies.Policy" title="macop.operators.policies.Policy"><code class="xref py py-obj docutils literal notranslate"><span class="pre">macop.operators.policies.Policy</span></code></a></p></td>
  190. <td><p></p></td>
  191. </tr>
  192. <tr class="row-even"><td><p><a class="reference internal" href="macop/macop.operators.policies.RandomPolicy.html#module-macop.operators.policies.RandomPolicy" title="macop.operators.policies.RandomPolicy"><code class="xref py py-obj docutils literal notranslate"><span class="pre">macop.operators.policies.RandomPolicy</span></code></a></p></td>
  193. <td><p></p></td>
  194. </tr>
  195. <tr class="row-odd"><td><p><a class="reference internal" href="macop/macop.operators.Operator.html#module-macop.operators.Operator" title="macop.operators.Operator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">macop.operators.Operator</span></code></a></p></td>
  196. <td><p></p></td>
  197. </tr>
  198. </tbody>
  199. </table>
  200. </div>
  201. <div class="section" id="macop-solution">
  202. <h2>macop.solution<a class="headerlink" href="#macop-solution" title="Permalink to this headline">¶</a></h2>
  203. <table class="longtable docutils align-default">
  204. <colgroup>
  205. <col style="width: 10%" />
  206. <col style="width: 90%" />
  207. </colgroup>
  208. <tbody>
  209. <tr class="row-odd"><td><p><a class="reference internal" href="macop/macop.solutions.BinarySolution.html#module-macop.solutions.BinarySolution" title="macop.solutions.BinarySolution"><code class="xref py py-obj docutils literal notranslate"><span class="pre">macop.solutions.BinarySolution</span></code></a></p></td>
  210. <td><p></p></td>
  211. </tr>
  212. <tr class="row-even"><td><p><a class="reference internal" href="macop/macop.solutions.CombinatoryIntegerSolution.html#module-macop.solutions.CombinatoryIntegerSolution" title="macop.solutions.CombinatoryIntegerSolution"><code class="xref py py-obj docutils literal notranslate"><span class="pre">macop.solutions.CombinatoryIntegerSolution</span></code></a></p></td>
  213. <td><p></p></td>
  214. </tr>
  215. <tr class="row-odd"><td><p><a class="reference internal" href="macop/macop.solutions.IntegerSolution.html#module-macop.solutions.IntegerSolution" title="macop.solutions.IntegerSolution"><code class="xref py py-obj docutils literal notranslate"><span class="pre">macop.solutions.IntegerSolution</span></code></a></p></td>
  216. <td><p></p></td>
  217. </tr>
  218. <tr class="row-even"><td><p><a class="reference internal" href="macop/macop.solutions.Solution.html#module-macop.solutions.Solution" title="macop.solutions.Solution"><code class="xref py py-obj docutils literal notranslate"><span class="pre">macop.solutions.Solution</span></code></a></p></td>
  219. <td><p></p></td>
  220. </tr>
  221. </tbody>
  222. </table>
  223. </div>
  224. </div>
  225. </div>
  226. </div>
  227. <footer>
  228. <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
  229. <a href="macop/macop.algorithms.Algorithm.html" class="btn btn-neutral float-right" title="macop.algorithms.Algorithm" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
  230. <a href="description.html" class="btn btn-neutral float-left" title="Description" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
  231. </div>
  232. <hr/>
  233. <div role="contentinfo">
  234. <p>
  235. &copy; Copyright 2020, Jérôme BUISINE
  236. </p>
  237. </div>
  238. 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>.
  239. </footer>
  240. </div>
  241. </div>
  242. </section>
  243. </div>
  244. <script type="text/javascript">
  245. jQuery(function () {
  246. SphinxRtdTheme.Navigation.enable(true);
  247. });
  248. </script>
  249. </body>
  250. </html>