genindex.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435
  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>Index &mdash; macop v0.1.3 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="#" />
  18. <link rel="search" title="Search" href="search.html" />
  19. </head>
  20. <body class="wy-body-for-nav">
  21. <div class="wy-grid-for-nav">
  22. <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  23. <div class="wy-side-scroll">
  24. <div class="wy-side-nav-search" >
  25. <a href="index.html" class="icon icon-home"> macop
  26. </a>
  27. <div class="version">
  28. 0.1.3
  29. </div>
  30. <div role="search">
  31. <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
  32. <input type="text" name="q" placeholder="Search docs" />
  33. <input type="hidden" name="check_keywords" value="yes" />
  34. <input type="hidden" name="area" value="default" />
  35. </form>
  36. </div>
  37. </div>
  38. <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  39. <p class="caption"><span class="caption-text">Contents:</span></p>
  40. <ul>
  41. <li class="toctree-l1"><a class="reference internal" href="description.html">Description</a></li>
  42. <li class="toctree-l1"><a class="reference internal" href="macop.html">Documentation</a></li>
  43. <li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
  44. <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
  45. </ul>
  46. </div>
  47. </div>
  48. </nav>
  49. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  50. <nav class="wy-nav-top" aria-label="top navigation">
  51. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  52. <a href="index.html">macop</a>
  53. </nav>
  54. <div class="wy-nav-content">
  55. <div class="rst-content">
  56. <div role="navigation" aria-label="breadcrumbs navigation">
  57. <ul class="wy-breadcrumbs">
  58. <li><a href="index.html">Docs</a> &raquo;</li>
  59. <li>Index</li>
  60. <li class="wy-breadcrumbs-aside">
  61. <a href="https://github.com/prise-3d/macop/blob/master/docs/source/genindex" class="fa fa-github"> Edit on GitHub</a>
  62. </li>
  63. </ul>
  64. <hr/>
  65. </div>
  66. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  67. <div itemprop="articleBody">
  68. <h1 id="index">Index</h1>
  69. <div class="genindex-jumpbox">
  70. <a href="#_"><strong>_</strong></a>
  71. | <a href="#A"><strong>A</strong></a>
  72. | <a href="#B"><strong>B</strong></a>
  73. | <a href="#C"><strong>C</strong></a>
  74. | <a href="#E"><strong>E</strong></a>
  75. | <a href="#G"><strong>G</strong></a>
  76. | <a href="#I"><strong>I</strong></a>
  77. | <a href="#K"><strong>K</strong></a>
  78. | <a href="#L"><strong>L</strong></a>
  79. | <a href="#M"><strong>M</strong></a>
  80. | <a href="#O"><strong>O</strong></a>
  81. | <a href="#P"><strong>P</strong></a>
  82. | <a href="#R"><strong>R</strong></a>
  83. | <a href="#S"><strong>S</strong></a>
  84. | <a href="#U"><strong>U</strong></a>
  85. | <a href="#V"><strong>V</strong></a>
  86. </div>
  87. <h2 id="_">_</h2>
  88. <table style="width: 100%" class="indextable genindextable"><tr>
  89. <td style="width: 33%; vertical-align: top;"><ul>
  90. <li><a href="macop/macop.algorithms.Algorithm.html#macop.algorithms.Algorithm.Algorithm._checkpoint">_checkpoint (macop.algorithms.Algorithm.Algorithm attribute)</a>
  91. </li>
  92. <li><a href="macop/macop.algorithms.Algorithm.html#macop.algorithms.Algorithm.Algorithm._class">_class (macop.algorithms.Algorithm.Algorithm attribute)</a>
  93. </li>
  94. </ul></td>
  95. <td style="width: 33%; vertical-align: top;"><ul>
  96. <li><a href="macop/macop.algorithms.Algorithm.html#macop.algorithms.Algorithm.Algorithm._every">_every (macop.algorithms.Algorithm.Algorithm attribute)</a>
  97. </li>
  98. <li><a href="macop/macop.algorithms.Algorithm.html#macop.algorithms.Algorithm.Algorithm._filepath">_filepath (macop.algorithms.Algorithm.Algorithm attribute)</a>
  99. </li>
  100. </ul></td>
  101. </tr></table>
  102. <h2 id="A">A</h2>
  103. <table style="width: 100%" class="indextable genindextable"><tr>
  104. <td style="width: 33%; vertical-align: top;"><ul>
  105. <li><a href="macop/macop.algorithms.Algorithm.html#macop.algorithms.Algorithm.Algorithm.addCheckpoint">addCheckpoint() (macop.algorithms.Algorithm.Algorithm method)</a>
  106. </li>
  107. </ul></td>
  108. <td style="width: 33%; vertical-align: top;"><ul>
  109. <li><a href="macop/macop.algorithms.Algorithm.html#macop.algorithms.Algorithm.Algorithm">Algorithm (class in macop.algorithms.Algorithm)</a>
  110. </li>
  111. </ul></td>
  112. </tr></table>
  113. <h2 id="B">B</h2>
  114. <table style="width: 100%" class="indextable genindextable"><tr>
  115. <td style="width: 33%; vertical-align: top;"><ul>
  116. <li><a href="macop/macop.algorithms.Algorithm.html#macop.algorithms.Algorithm.Algorithm.bestSolution">bestSolution (macop.algorithms.Algorithm.Algorithm attribute)</a>
  117. </li>
  118. </ul></td>
  119. </tr></table>
  120. <h2 id="C">C</h2>
  121. <table style="width: 100%" class="indextable genindextable"><tr>
  122. <td style="width: 33%; vertical-align: top;"><ul>
  123. <li><a href="macop/macop.algorithms.Algorithm.html#macop.algorithms.Algorithm.Algorithm.checkpoint">checkpoint (macop.algorithms.Algorithm.Algorithm attribute)</a>
  124. </li>
  125. </ul></td>
  126. <td style="width: 33%; vertical-align: top;"><ul>
  127. <li><a href="macop/macop.algorithms.Algorithm.html#macop.algorithms.Algorithm.Algorithm.currentSolution">currentSolution (macop.algorithms.Algorithm.Algorithm attribute)</a>
  128. </li>
  129. </ul></td>
  130. </tr></table>
  131. <h2 id="E">E</h2>
  132. <table style="width: 100%" class="indextable genindextable"><tr>
  133. <td style="width: 33%; vertical-align: top;"><ul>
  134. <li><a href="macop/macop.algorithms.Algorithm.html#macop.algorithms.Algorithm.Algorithm.evaluate">evaluate() (macop.algorithms.Algorithm.Algorithm method)</a>
  135. </li>
  136. </ul></td>
  137. <td style="width: 33%; vertical-align: top;"><ul>
  138. <li><a href="macop/macop.algorithms.Algorithm.html#macop.algorithms.Algorithm.Algorithm.evaluator">evaluator (macop.algorithms.Algorithm.Algorithm attribute)</a>
  139. </li>
  140. </ul></td>
  141. </tr></table>
  142. <h2 id="G">G</h2>
  143. <table style="width: 100%" class="indextable genindextable"><tr>
  144. <td style="width: 33%; vertical-align: top;"><ul>
  145. <li><a href="macop/macop.algorithms.Algorithm.html#macop.algorithms.Algorithm.Algorithm.getGlobalEvaluation">getGlobalEvaluation() (macop.algorithms.Algorithm.Algorithm method)</a>
  146. </li>
  147. </ul></td>
  148. </tr></table>
  149. <h2 id="I">I</h2>
  150. <table style="width: 100%" class="indextable genindextable"><tr>
  151. <td style="width: 33%; vertical-align: top;"><ul>
  152. <li><a href="macop/macop.algorithms.Algorithm.html#macop.algorithms.Algorithm.Algorithm.increaseEvaluation">increaseEvaluation() (macop.algorithms.Algorithm.Algorithm method)</a>
  153. </li>
  154. <li><a href="macop/macop.algorithms.Algorithm.html#macop.algorithms.Algorithm.Algorithm.initalizer">initalizer (macop.algorithms.Algorithm.Algorithm attribute)</a>
  155. </li>
  156. </ul></td>
  157. <td style="width: 33%; vertical-align: top;"><ul>
  158. <li><a href="macop/macop.algorithms.Algorithm.html#macop.algorithms.Algorithm.Algorithm.initRun">initRun() (macop.algorithms.Algorithm.Algorithm method)</a>
  159. </li>
  160. <li><a href="macop/macop.algorithms.Algorithm.html#macop.algorithms.Algorithm.Algorithm.isBetter">isBetter() (macop.algorithms.Algorithm.Algorithm method)</a>
  161. </li>
  162. <li><a href="macop/macop.algorithms.IteratedLocalSearch.html#macop.algorithms.IteratedLocalSearch.IteratedLocalSearch">IteratedLocalSearch (class in macop.algorithms.IteratedLocalSearch)</a>
  163. </li>
  164. </ul></td>
  165. </tr></table>
  166. <h2 id="K">K</h2>
  167. <table style="width: 100%" class="indextable genindextable"><tr>
  168. <td style="width: 33%; vertical-align: top;"><ul>
  169. <li><a href="macop/macop.operators.Operator.html#macop.operators.Operator.KindOperator">KindOperator (class in macop.operators.Operator)</a>
  170. </li>
  171. </ul></td>
  172. </tr></table>
  173. <h2 id="L">L</h2>
  174. <table style="width: 100%" class="indextable genindextable"><tr>
  175. <td style="width: 33%; vertical-align: top;"><ul>
  176. <li><a href="macop/macop.algorithms.LocalSearch.html#macop.algorithms.LocalSearch.LocalSearch">LocalSearch (class in macop.algorithms.LocalSearch)</a>
  177. </li>
  178. </ul></td>
  179. </tr></table>
  180. <h2 id="M">M</h2>
  181. <table style="width: 100%" class="indextable genindextable"><tr>
  182. <td style="width: 33%; vertical-align: top;"><ul>
  183. <li><a href="macop/macop.algorithms.Algorithm.html#module-macop.algorithms.Algorithm">macop.algorithms.Algorithm (module)</a>
  184. </li>
  185. <li><a href="macop/macop.algorithms.IteratedLocalSearch.html#module-macop.algorithms.IteratedLocalSearch">macop.algorithms.IteratedLocalSearch (module)</a>
  186. </li>
  187. <li><a href="macop/macop.algorithms.LocalSearch.html#module-macop.algorithms.LocalSearch">macop.algorithms.LocalSearch (module)</a>
  188. </li>
  189. <li><a href="macop/macop.checkpoints.BasicCheckpoint.html#module-macop.checkpoints.BasicCheckpoint">macop.checkpoints.BasicCheckpoint (module)</a>
  190. </li>
  191. <li><a href="macop/macop.checkpoints.Checkpoint.html#module-macop.checkpoints.Checkpoint">macop.checkpoints.Checkpoint (module)</a>
  192. </li>
  193. <li><a href="macop/macop.evaluators.EvaluatorExample.html#module-macop.evaluators.EvaluatorExample">macop.evaluators.EvaluatorExample (module)</a>
  194. </li>
  195. <li><a href="macop/macop.operators.crossovers.Crossover.html#module-macop.operators.crossovers.Crossover">macop.operators.crossovers.Crossover (module)</a>
  196. </li>
  197. <li><a href="macop/macop.operators.crossovers.RandomSplitCrossover.html#module-macop.operators.crossovers.RandomSplitCrossover">macop.operators.crossovers.RandomSplitCrossover (module)</a>
  198. </li>
  199. <li><a href="macop/macop.operators.crossovers.SimpleCrossover.html#module-macop.operators.crossovers.SimpleCrossover">macop.operators.crossovers.SimpleCrossover (module)</a>
  200. </li>
  201. <li><a href="macop/macop.operators.mutators.Mutation.html#module-macop.operators.mutators.Mutation">macop.operators.mutators.Mutation (module)</a>
  202. </li>
  203. </ul></td>
  204. <td style="width: 33%; vertical-align: top;"><ul>
  205. <li><a href="macop/macop.operators.mutators.SimpleBinaryMutation.html#module-macop.operators.mutators.SimpleBinaryMutation">macop.operators.mutators.SimpleBinaryMutation (module)</a>
  206. </li>
  207. <li><a href="macop/macop.operators.mutators.SimpleMutation.html#module-macop.operators.mutators.SimpleMutation">macop.operators.mutators.SimpleMutation (module)</a>
  208. </li>
  209. <li><a href="macop/macop.operators.Operator.html#module-macop.operators.Operator">macop.operators.Operator (module)</a>
  210. </li>
  211. <li><a href="macop/macop.operators.policies.Policy.html#module-macop.operators.policies.Policy">macop.operators.policies.Policy (module)</a>
  212. </li>
  213. <li><a href="macop/macop.operators.policies.RandomPolicy.html#module-macop.operators.policies.RandomPolicy">macop.operators.policies.RandomPolicy (module)</a>
  214. </li>
  215. <li><a href="macop/macop.solutions.BinarySolution.html#module-macop.solutions.BinarySolution">macop.solutions.BinarySolution (module)</a>
  216. </li>
  217. <li><a href="macop/macop.solutions.CombinatoryIntegerSolution.html#module-macop.solutions.CombinatoryIntegerSolution">macop.solutions.CombinatoryIntegerSolution (module)</a>
  218. </li>
  219. <li><a href="macop/macop.solutions.IntegerSolution.html#module-macop.solutions.IntegerSolution">macop.solutions.IntegerSolution (module)</a>
  220. </li>
  221. <li><a href="macop/macop.solutions.Solution.html#module-macop.solutions.Solution">macop.solutions.Solution (module)</a>
  222. </li>
  223. <li><a href="macop/macop.algorithms.Algorithm.html#macop.algorithms.Algorithm.Algorithm.maximise">maximise (macop.algorithms.Algorithm.Algorithm attribute)</a>
  224. </li>
  225. </ul></td>
  226. </tr></table>
  227. <h2 id="O">O</h2>
  228. <table style="width: 100%" class="indextable genindextable"><tr>
  229. <td style="width: 33%; vertical-align: top;"><ul>
  230. <li><a href="macop/macop.algorithms.Algorithm.html#macop.algorithms.Algorithm.Algorithm.operators">operators (macop.algorithms.Algorithm.Algorithm attribute)</a>
  231. </li>
  232. </ul></td>
  233. </tr></table>
  234. <h2 id="P">P</h2>
  235. <table style="width: 100%" class="indextable genindextable"><tr>
  236. <td style="width: 33%; vertical-align: top;"><ul>
  237. <li><a href="macop/macop.algorithms.Algorithm.html#macop.algorithms.Algorithm.Algorithm.parent">parent (macop.algorithms.Algorithm.Algorithm attribute)</a>
  238. </li>
  239. </ul></td>
  240. <td style="width: 33%; vertical-align: top;"><ul>
  241. <li><a href="macop/macop.algorithms.Algorithm.html#macop.algorithms.Algorithm.Algorithm.policy">policy (macop.algorithms.Algorithm.Algorithm attribute)</a>
  242. </li>
  243. </ul></td>
  244. </tr></table>
  245. <h2 id="R">R</h2>
  246. <table style="width: 100%" class="indextable genindextable"><tr>
  247. <td style="width: 33%; vertical-align: top;"><ul>
  248. <li><a href="macop/macop.algorithms.Algorithm.html#macop.algorithms.Algorithm.Algorithm.resume">resume() (macop.algorithms.Algorithm.Algorithm method)</a>
  249. </li>
  250. <li><a href="macop/macop.algorithms.Algorithm.html#macop.algorithms.Algorithm.Algorithm.run">run() (macop.algorithms.Algorithm.Algorithm method)</a>
  251. <ul>
  252. <li><a href="macop/macop.algorithms.IteratedLocalSearch.html#macop.algorithms.IteratedLocalSearch.IteratedLocalSearch.run">(macop.algorithms.IteratedLocalSearch.IteratedLocalSearch method)</a>
  253. </li>
  254. <li><a href="macop/macop.algorithms.LocalSearch.html#macop.algorithms.LocalSearch.LocalSearch.run">(macop.algorithms.LocalSearch.LocalSearch method)</a>
  255. </li>
  256. </ul></li>
  257. </ul></td>
  258. </tr></table>
  259. <h2 id="S">S</h2>
  260. <table style="width: 100%" class="indextable genindextable"><tr>
  261. <td style="width: 33%; vertical-align: top;"><ul>
  262. <li><a href="macop/macop.algorithms.Algorithm.html#macop.algorithms.Algorithm.Algorithm.setCheckpoint">setCheckpoint() (macop.algorithms.Algorithm.Algorithm method)</a>
  263. </li>
  264. </ul></td>
  265. <td style="width: 33%; vertical-align: top;"><ul>
  266. <li><a href="macop/macop.algorithms.Algorithm.html#macop.algorithms.Algorithm.Algorithm.stop">stop() (macop.algorithms.Algorithm.Algorithm method)</a>
  267. </li>
  268. </ul></td>
  269. </tr></table>
  270. <h2 id="U">U</h2>
  271. <table style="width: 100%" class="indextable genindextable"><tr>
  272. <td style="width: 33%; vertical-align: top;"><ul>
  273. <li><a href="macop/macop.algorithms.Algorithm.html#macop.algorithms.Algorithm.Algorithm.update">update() (macop.algorithms.Algorithm.Algorithm method)</a>
  274. </li>
  275. </ul></td>
  276. </tr></table>
  277. <h2 id="V">V</h2>
  278. <table style="width: 100%" class="indextable genindextable"><tr>
  279. <td style="width: 33%; vertical-align: top;"><ul>
  280. <li><a href="macop/macop.algorithms.Algorithm.html#macop.algorithms.Algorithm.Algorithm.validator">validator (macop.algorithms.Algorithm.Algorithm attribute)</a>
  281. </li>
  282. </ul></td>
  283. </tr></table>
  284. </div>
  285. </div>
  286. <footer>
  287. <hr/>
  288. <div role="contentinfo">
  289. <p>
  290. &copy; Copyright 2020, Jérôme BUISINE
  291. </p>
  292. </div>
  293. 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>.
  294. </footer>
  295. </div>
  296. </div>
  297. </section>
  298. </div>
  299. <script type="text/javascript">
  300. jQuery(function () {
  301. SphinxRtdTheme.Navigation.enable(true);
  302. });
  303. </script>
  304. </body>
  305. </html>