macop.algorithms.Algorithm.html 21 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>macop.algorithms.Algorithm &mdash; macop v0.1.6 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.mono.IteratedLocalSearch" href="macop.algorithms.mono.IteratedLocalSearch.html" />
  20. <link rel="prev" title="Documentation" href="../macop.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.6
  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="reference internal" href="../macop.html">Documentation</a><ul class="current">
  45. <li class="toctree-l2"><a class="reference internal" href="../macop.html#macop">macop</a></li>
  46. <li class="toctree-l2 current"><a class="reference internal" href="../macop.html#macop-algorithms">macop.algorithms</a><ul class="current">
  47. <li class="toctree-l3 current"><a class="current reference internal" href="#">macop.algorithms.Algorithm</a></li>
  48. <li class="toctree-l3"><a class="reference internal" href="macop.algorithms.mono.IteratedLocalSearch.html">macop.algorithms.mono.IteratedLocalSearch</a></li>
  49. <li class="toctree-l3"><a class="reference internal" href="macop.algorithms.mono.LocalSearch.html">macop.algorithms.mono.LocalSearch</a></li>
  50. </ul>
  51. </li>
  52. <li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-callbacks">macop.callbacks</a></li>
  53. <li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-evaluators">macop.evaluators</a></li>
  54. <li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-operators">macop.operators</a></li>
  55. <li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-solution">macop.solution</a></li>
  56. </ul>
  57. </li>
  58. <li class="toctree-l1"><a class="reference internal" href="../examples.html">Some examples</a></li>
  59. <li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
  60. </ul>
  61. </div>
  62. </div>
  63. </nav>
  64. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  65. <nav class="wy-nav-top" aria-label="top navigation">
  66. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  67. <a href="../index.html">macop</a>
  68. </nav>
  69. <div class="wy-nav-content">
  70. <div class="rst-content">
  71. <div role="navigation" aria-label="breadcrumbs navigation">
  72. <ul class="wy-breadcrumbs">
  73. <li><a href="../index.html">Docs</a> &raquo;</li>
  74. <li><a href="../macop.html">Documentation</a> &raquo;</li>
  75. <li>macop.algorithms.Algorithm</li>
  76. <li class="wy-breadcrumbs-aside">
  77. <a href="https://github.com/prise-3d/macop/blob/master/docs/source/macop/macop.algorithms.Algorithm.rst" class="fa fa-github"> Edit on GitHub</a>
  78. </li>
  79. </ul>
  80. <hr/>
  81. </div>
  82. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  83. <div itemprop="articleBody">
  84. <div class="section" id="module-macop.algorithms.Algorithm">
  85. <span id="macop-algorithms-algorithm"></span><h1>macop.algorithms.Algorithm<a class="headerlink" href="#module-macop.algorithms.Algorithm" title="Permalink to this headline">¶</a></h1>
  86. <p>Abstract Algorithm class used as basic algorithm implementation with some specific initialization</p>
  87. <p class="rubric">Classes</p>
  88. <table class="longtable docutils align-default">
  89. <colgroup>
  90. <col style="width: 10%" />
  91. <col style="width: 90%" />
  92. </colgroup>
  93. <tbody>
  94. <tr class="row-odd"><td><p><a class="reference internal" href="#macop.algorithms.Algorithm.Algorithm" title="macop.algorithms.Algorithm.Algorithm"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Algorithm</span></code></a>(_initalizer, _evaluator, …[, …])</p></td>
  95. <td><p>Algorithm class used as basic algorithm</p></td>
  96. </tr>
  97. </tbody>
  98. </table>
  99. <dl class="class">
  100. <dt id="macop.algorithms.Algorithm.Algorithm">
  101. <em class="property">class </em><code class="sig-prename descclassname">macop.algorithms.Algorithm.</code><code class="sig-name descname">Algorithm</code><span class="sig-paren">(</span><em class="sig-param">_initalizer</em>, <em class="sig-param">_evaluator</em>, <em class="sig-param">_operators</em>, <em class="sig-param">_policy</em>, <em class="sig-param">_validator</em>, <em class="sig-param">_maximise=True</em>, <em class="sig-param">_parent=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/macop/algorithms/Algorithm.html#Algorithm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.algorithms.Algorithm.Algorithm" title="Permalink to this definition">¶</a></dt>
  102. <dd><p>Algorithm class used as basic algorithm</p>
  103. <dl class="attribute">
  104. <dt id="macop.algorithms.Algorithm.Algorithm.initalizer">
  105. <code class="sig-name descname">initalizer</code><a class="headerlink" href="#macop.algorithms.Algorithm.Algorithm.initalizer" title="Permalink to this definition">¶</a></dt>
  106. <dd><p>{function} – basic function strategy to initialize solution</p>
  107. </dd></dl>
  108. <dl class="attribute">
  109. <dt id="macop.algorithms.Algorithm.Algorithm.evaluator">
  110. <code class="sig-name descname">evaluator</code><a class="headerlink" href="#macop.algorithms.Algorithm.Algorithm.evaluator" title="Permalink to this definition">¶</a></dt>
  111. <dd><p>{function} – basic function in order to obtained fitness (mono or multiple objectives)</p>
  112. </dd></dl>
  113. <dl class="attribute">
  114. <dt id="macop.algorithms.Algorithm.Algorithm.operators">
  115. <code class="sig-name descname">operators</code><a class="headerlink" href="#macop.algorithms.Algorithm.Algorithm.operators" title="Permalink to this definition">¶</a></dt>
  116. <dd><p>{[Operator]} – list of operator to use when launching algorithm</p>
  117. </dd></dl>
  118. <dl class="attribute">
  119. <dt id="macop.algorithms.Algorithm.Algorithm.policy">
  120. <code class="sig-name descname">policy</code><a class="headerlink" href="#macop.algorithms.Algorithm.Algorithm.policy" title="Permalink to this definition">¶</a></dt>
  121. <dd><p>{Policy} – Policy class implementation strategy to select operators</p>
  122. </dd></dl>
  123. <dl class="attribute">
  124. <dt id="macop.algorithms.Algorithm.Algorithm.validator">
  125. <code class="sig-name descname">validator</code><a class="headerlink" href="#macop.algorithms.Algorithm.Algorithm.validator" title="Permalink to this definition">¶</a></dt>
  126. <dd><p>{function} – basic function to check if solution is valid or not under some constraints</p>
  127. </dd></dl>
  128. <dl class="attribute">
  129. <dt id="macop.algorithms.Algorithm.Algorithm.maximise">
  130. <code class="sig-name descname">maximise</code><a class="headerlink" href="#macop.algorithms.Algorithm.Algorithm.maximise" title="Permalink to this definition">¶</a></dt>
  131. <dd><p>{bool} – specify kind of optimization problem</p>
  132. </dd></dl>
  133. <dl class="attribute">
  134. <dt id="macop.algorithms.Algorithm.Algorithm.currentSolution">
  135. <code class="sig-name descname">currentSolution</code><a class="headerlink" href="#macop.algorithms.Algorithm.Algorithm.currentSolution" title="Permalink to this definition">¶</a></dt>
  136. <dd><p>{Solution} – current solution managed for current evaluation</p>
  137. </dd></dl>
  138. <dl class="attribute">
  139. <dt id="macop.algorithms.Algorithm.Algorithm.bestSolution">
  140. <code class="sig-name descname">bestSolution</code><a class="headerlink" href="#macop.algorithms.Algorithm.Algorithm.bestSolution" title="Permalink to this definition">¶</a></dt>
  141. <dd><p>{Solution} – best solution found so far during running algorithm</p>
  142. </dd></dl>
  143. <dl class="attribute">
  144. <dt id="macop.algorithms.Algorithm.Algorithm.callbacks">
  145. <code class="sig-name descname">callbacks</code><a class="headerlink" href="#macop.algorithms.Algorithm.Algorithm.callbacks" title="Permalink to this definition">¶</a></dt>
  146. <dd><p>{[Callback]} – list of Callback class implementation to do some instructions every number of evaluations and when initializing algorithm</p>
  147. </dd></dl>
  148. <dl class="attribute">
  149. <dt id="macop.algorithms.Algorithm.Algorithm.parent">
  150. <code class="sig-name descname">parent</code><a class="headerlink" href="#macop.algorithms.Algorithm.Algorithm.parent" title="Permalink to this definition">¶</a></dt>
  151. <dd><p>{Algorithm} – parent algorithm reference in case of inner Algorithm instance (optional)</p>
  152. </dd></dl>
  153. <dl class="method">
  154. <dt id="macop.algorithms.Algorithm.Algorithm.addCallback">
  155. <code class="sig-name descname">addCallback</code><span class="sig-paren">(</span><em class="sig-param">_callback</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/macop/algorithms/Algorithm.html#Algorithm.addCallback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.algorithms.Algorithm.Algorithm.addCallback" title="Permalink to this definition">¶</a></dt>
  156. <dd><p>Add new callback to algorithm specifying usefull parameters</p>
  157. <dl class="field-list simple">
  158. <dt class="field-odd">Parameters</dt>
  159. <dd class="field-odd"><p><strong>_callback</strong> – {Callback} – specific Callback instance</p>
  160. </dd>
  161. </dl>
  162. </dd></dl>
  163. <dl class="method">
  164. <dt id="macop.algorithms.Algorithm.Algorithm.end">
  165. <code class="sig-name descname">end</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/macop/algorithms/Algorithm.html#Algorithm.end"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.algorithms.Algorithm.Algorithm.end" title="Permalink to this definition">¶</a></dt>
  166. <dd><p>Display end message into <cite>run</cite> method</p>
  167. </dd></dl>
  168. <dl class="method">
  169. <dt id="macop.algorithms.Algorithm.Algorithm.evaluate">
  170. <code class="sig-name descname">evaluate</code><span class="sig-paren">(</span><em class="sig-param">_solution</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/macop/algorithms/Algorithm.html#Algorithm.evaluate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.algorithms.Algorithm.Algorithm.evaluate" title="Permalink to this definition">¶</a></dt>
  171. <dd><p>Evaluate a solution using evaluator passed when intialize algorithm</p>
  172. <dl class="field-list simple">
  173. <dt class="field-odd">Parameters</dt>
  174. <dd class="field-odd"><p><strong>solution</strong> – {Solution} – solution to evaluate</p>
  175. </dd>
  176. <dt class="field-even">Returns</dt>
  177. <dd class="field-even"><p>fitness score of solution which is not already evaluated or changed</p>
  178. </dd>
  179. </dl>
  180. <div class="admonition note">
  181. <p class="admonition-title">Note</p>
  182. <p>if multi-objective problem this method can be updated using array of <cite>evaluator</cite></p>
  183. </div>
  184. </dd></dl>
  185. <dl class="method">
  186. <dt id="macop.algorithms.Algorithm.Algorithm.getGlobalEvaluation">
  187. <code class="sig-name descname">getGlobalEvaluation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/macop/algorithms/Algorithm.html#Algorithm.getGlobalEvaluation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.algorithms.Algorithm.Algorithm.getGlobalEvaluation" title="Permalink to this definition">¶</a></dt>
  188. <dd><p>Get the global number of evaluation (if inner algorithm)</p>
  189. <dl class="field-list simple">
  190. <dt class="field-odd">Returns</dt>
  191. <dd class="field-odd"><p>{int} – current global number of evaluation</p>
  192. </dd>
  193. </dl>
  194. </dd></dl>
  195. <dl class="method">
  196. <dt id="macop.algorithms.Algorithm.Algorithm.getGlobalMaxEvaluation">
  197. <code class="sig-name descname">getGlobalMaxEvaluation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/macop/algorithms/Algorithm.html#Algorithm.getGlobalMaxEvaluation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.algorithms.Algorithm.Algorithm.getGlobalMaxEvaluation" title="Permalink to this definition">¶</a></dt>
  198. <dd><p>Get the global max number of evaluation (if inner algorithm)</p>
  199. <dl class="field-list simple">
  200. <dt class="field-odd">Returns</dt>
  201. <dd class="field-odd"><p>{int} – current global max number of evaluation</p>
  202. </dd>
  203. </dl>
  204. </dd></dl>
  205. <dl class="method">
  206. <dt id="macop.algorithms.Algorithm.Algorithm.increaseEvaluation">
  207. <code class="sig-name descname">increaseEvaluation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/macop/algorithms/Algorithm.html#Algorithm.increaseEvaluation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.algorithms.Algorithm.Algorithm.increaseEvaluation" title="Permalink to this definition">¶</a></dt>
  208. <dd><p>Increase number of evaluation once a solution is evaluated</p>
  209. </dd></dl>
  210. <dl class="method">
  211. <dt id="macop.algorithms.Algorithm.Algorithm.initRun">
  212. <code class="sig-name descname">initRun</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/macop/algorithms/Algorithm.html#Algorithm.initRun"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.algorithms.Algorithm.Algorithm.initRun" title="Permalink to this definition">¶</a></dt>
  213. <dd><p>Initialize the current solution and best solution</p>
  214. </dd></dl>
  215. <dl class="method">
  216. <dt id="macop.algorithms.Algorithm.Algorithm.isBetter">
  217. <code class="sig-name descname">isBetter</code><span class="sig-paren">(</span><em class="sig-param">_solution</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/macop/algorithms/Algorithm.html#Algorithm.isBetter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.algorithms.Algorithm.Algorithm.isBetter" title="Permalink to this definition">¶</a></dt>
  218. <dd><p>Check if solution is better than best found</p>
  219. <dl class="field-list simple">
  220. <dt class="field-odd">Parameters</dt>
  221. <dd class="field-odd"><p><strong>solution</strong> – {Solution} – solution to compare with best one</p>
  222. </dd>
  223. <dt class="field-even">Returns</dt>
  224. <dd class="field-even"><p>{bool} – <cite>True</cite> if better</p>
  225. </dd>
  226. </dl>
  227. </dd></dl>
  228. <dl class="method">
  229. <dt id="macop.algorithms.Algorithm.Algorithm.progress">
  230. <code class="sig-name descname">progress</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/macop/algorithms/Algorithm.html#Algorithm.progress"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.algorithms.Algorithm.Algorithm.progress" title="Permalink to this definition">¶</a></dt>
  231. <dd><p>Log progress and apply callbacks if necessary</p>
  232. </dd></dl>
  233. <dl class="method">
  234. <dt id="macop.algorithms.Algorithm.Algorithm.resume">
  235. <code class="sig-name descname">resume</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/macop/algorithms/Algorithm.html#Algorithm.resume"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.algorithms.Algorithm.Algorithm.resume" title="Permalink to this definition">¶</a></dt>
  236. <dd><p>Resume algorithm using Callback instances</p>
  237. </dd></dl>
  238. <dl class="method">
  239. <dt id="macop.algorithms.Algorithm.Algorithm.run">
  240. <code class="sig-name descname">run</code><span class="sig-paren">(</span><em class="sig-param">_evaluations</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/macop/algorithms/Algorithm.html#Algorithm.run"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.algorithms.Algorithm.Algorithm.run" title="Permalink to this definition">¶</a></dt>
  241. <dd><p>Run the specific algorithm following number of evaluations to find optima</p>
  242. </dd></dl>
  243. <dl class="method">
  244. <dt id="macop.algorithms.Algorithm.Algorithm.setCheckpoint">
  245. <code class="sig-name descname">setCheckpoint</code><span class="sig-paren">(</span><em class="sig-param">_callback</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/macop/algorithms/Algorithm.html#Algorithm.setCheckpoint"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.algorithms.Algorithm.Algorithm.setCheckpoint" title="Permalink to this definition">¶</a></dt>
  246. <dd><p>Set checkpoint instance directly
  247. :param _callback: {Callback} – Callback instance used for checkpoint</p>
  248. </dd></dl>
  249. <dl class="method">
  250. <dt id="macop.algorithms.Algorithm.Algorithm.stop">
  251. <code class="sig-name descname">stop</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/macop/algorithms/Algorithm.html#Algorithm.stop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.algorithms.Algorithm.Algorithm.stop" title="Permalink to this definition">¶</a></dt>
  252. <dd><p>Global stopping criteria (check for inner algorithm too)</p>
  253. </dd></dl>
  254. <dl class="method">
  255. <dt id="macop.algorithms.Algorithm.Algorithm.update">
  256. <code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param">_solution</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/macop/algorithms/Algorithm.html#Algorithm.update"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.algorithms.Algorithm.Algorithm.update" title="Permalink to this definition">¶</a></dt>
  257. <dd><p>Apply update function to solution using specific <cite>policy</cite>
  258. Check if solution is valid after modification and returns it</p>
  259. <dl class="field-list simple">
  260. <dt class="field-odd">Parameters</dt>
  261. <dd class="field-odd"><p><strong>solution</strong> – {Solution} – solution to update using current policy</p>
  262. </dd>
  263. <dt class="field-even">Returns</dt>
  264. <dd class="field-even"><p>{Solution} – updated solution obtained by the selected operator</p>
  265. </dd>
  266. </dl>
  267. </dd></dl>
  268. </dd></dl>
  269. </div>
  270. </div>
  271. </div>
  272. <footer>
  273. <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
  274. <a href="macop.algorithms.mono.IteratedLocalSearch.html" class="btn btn-neutral float-right" title="macop.algorithms.mono.IteratedLocalSearch" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
  275. <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>
  276. </div>
  277. <hr/>
  278. <div role="contentinfo">
  279. <p>
  280. &copy; Copyright 2020, Jérôme BUISINE
  281. </p>
  282. </div>
  283. 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>.
  284. </footer>
  285. </div>
  286. </div>
  287. </section>
  288. </div>
  289. <script type="text/javascript">
  290. jQuery(function () {
  291. SphinxRtdTheme.Navigation.enable(true);
  292. });
  293. </script>
  294. </body>
  295. </html>