macop.algorithms.Algorithm.html 21 KB

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