macop.algorithms.multi.MOEAD.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370
  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.multi.MOEAD &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.multi.MOSubProblem" href="macop.algorithms.multi.MOSubProblem.html" />
  20. <link rel="prev" title="macop.algorithms.mono.LocalSearch" href="macop.algorithms.mono.LocalSearch.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"><a class="reference internal" href="macop.algorithms.Algorithm.html">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 current"><a class="current reference internal" href="#">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.multi.MOEAD</li>
  78. <li class="wy-breadcrumbs-aside">
  79. <a href="https://github.com/prise-3d/macop/blob/master/docs/source/macop/macop.algorithms.multi.MOEAD.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.multi.MOEAD">
  87. <span id="macop-algorithms-multi-moead"></span><h1>macop.algorithms.multi.MOEAD<a class="headerlink" href="#module-macop.algorithms.multi.MOEAD" title="Permalink to this headline">¶</a></h1>
  88. <p>Multi-Ojective Evolutionary Algorithm with Scalar Decomposition algorithm</p>
  89. <p class="rubric">Functions</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><code class="xref py py-obj docutils literal notranslate"><span class="pre">moEvaluator</span></code>(_solution, _evaluator, _weights)</p></td>
  97. <td><p></p></td>
  98. </tr>
  99. </tbody>
  100. </table>
  101. <p class="rubric">Classes</p>
  102. <table class="longtable docutils align-default">
  103. <colgroup>
  104. <col style="width: 10%" />
  105. <col style="width: 90%" />
  106. </colgroup>
  107. <tbody>
  108. <tr class="row-odd"><td><p><a class="reference internal" href="#macop.algorithms.multi.MOEAD.MOEAD" title="macop.algorithms.multi.MOEAD.MOEAD"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MOEAD</span></code></a>(_mu, _T, _initalizer, _evaluator, …)</p></td>
  109. <td><p>Multi-Ojective Evolutionary Algorithm with Scalar Decomposition</p></td>
  110. </tr>
  111. </tbody>
  112. </table>
  113. <dl class="class">
  114. <dt id="macop.algorithms.multi.MOEAD.MOEAD">
  115. <em class="property">class </em><code class="sig-prename descclassname">macop.algorithms.multi.MOEAD.</code><code class="sig-name descname">MOEAD</code><span class="sig-paren">(</span><em class="sig-param">_mu</em>, <em class="sig-param">_T</em>, <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/multi/MOEAD.html#MOEAD"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.algorithms.multi.MOEAD.MOEAD" title="Permalink to this definition">¶</a></dt>
  116. <dd><p>Multi-Ojective Evolutionary Algorithm with Scalar Decomposition</p>
  117. <dl class="attribute">
  118. <dt id="macop.algorithms.multi.MOEAD.MOEAD.mu">
  119. <code class="sig-name descname">mu</code><a class="headerlink" href="#macop.algorithms.multi.MOEAD.MOEAD.mu" title="Permalink to this definition">¶</a></dt>
  120. <dd><p>{int} – number of sub problems</p>
  121. </dd></dl>
  122. <dl class="attribute">
  123. <dt id="macop.algorithms.multi.MOEAD.MOEAD.T">
  124. <code class="sig-name descname">T</code><a class="headerlink" href="#macop.algorithms.multi.MOEAD.MOEAD.T" title="Permalink to this definition">¶</a></dt>
  125. <dd><p>{[float]} – number of neightbors for each sub problem</p>
  126. </dd></dl>
  127. <dl class="attribute">
  128. <dt id="macop.algorithms.multi.MOEAD.MOEAD.nObjectives">
  129. <code class="sig-name descname">nObjectives</code><a class="headerlink" href="#macop.algorithms.multi.MOEAD.MOEAD.nObjectives" title="Permalink to this definition">¶</a></dt>
  130. <dd><p>{int} – number of objectives (based of number evaluator)</p>
  131. </dd></dl>
  132. <dl class="attribute">
  133. <dt id="macop.algorithms.multi.MOEAD.MOEAD.initalizer">
  134. <code class="sig-name descname">initalizer</code><a class="headerlink" href="#macop.algorithms.multi.MOEAD.MOEAD.initalizer" title="Permalink to this definition">¶</a></dt>
  135. <dd><p>{function} – basic function strategy to initialize solution</p>
  136. </dd></dl>
  137. <dl class="attribute">
  138. <dt id="macop.algorithms.multi.MOEAD.MOEAD.evaluator">
  139. <code class="sig-name descname">evaluator</code><a class="headerlink" href="#macop.algorithms.multi.MOEAD.MOEAD.evaluator" title="Permalink to this definition">¶</a></dt>
  140. <dd><p>{[function]} – list of basic function in order to obtained fitness (multiple objectives)</p>
  141. </dd></dl>
  142. <dl class="attribute">
  143. <dt id="macop.algorithms.multi.MOEAD.MOEAD.operators">
  144. <code class="sig-name descname">operators</code><a class="headerlink" href="#macop.algorithms.multi.MOEAD.MOEAD.operators" title="Permalink to this definition">¶</a></dt>
  145. <dd><p>{[Operator]} – list of operator to use when launching algorithm</p>
  146. </dd></dl>
  147. <dl class="attribute">
  148. <dt id="macop.algorithms.multi.MOEAD.MOEAD.policy">
  149. <code class="sig-name descname">policy</code><a class="headerlink" href="#macop.algorithms.multi.MOEAD.MOEAD.policy" title="Permalink to this definition">¶</a></dt>
  150. <dd><p>{Policy} – Policy class implementation strategy to select operators</p>
  151. </dd></dl>
  152. <dl class="attribute">
  153. <dt id="macop.algorithms.multi.MOEAD.MOEAD.validator">
  154. <code class="sig-name descname">validator</code><a class="headerlink" href="#macop.algorithms.multi.MOEAD.MOEAD.validator" title="Permalink to this definition">¶</a></dt>
  155. <dd><p>{function} – basic function to check if solution is valid or not under some constraints</p>
  156. </dd></dl>
  157. <dl class="attribute">
  158. <dt id="macop.algorithms.multi.MOEAD.MOEAD.maximise">
  159. <code class="sig-name descname">maximise</code><a class="headerlink" href="#macop.algorithms.multi.MOEAD.MOEAD.maximise" title="Permalink to this definition">¶</a></dt>
  160. <dd><p>{bool} – specify kind of optimization problem</p>
  161. </dd></dl>
  162. <dl class="attribute">
  163. <dt id="macop.algorithms.multi.MOEAD.MOEAD.population">
  164. <code class="sig-name descname">population</code><a class="headerlink" href="#macop.algorithms.multi.MOEAD.MOEAD.population" title="Permalink to this definition">¶</a></dt>
  165. <dd><p>[{Solution}] – population of solution, one for each sub problem</p>
  166. </dd></dl>
  167. <dl class="attribute">
  168. <dt id="macop.algorithms.multi.MOEAD.MOEAD.pfPop">
  169. <code class="sig-name descname">pfPop</code><a class="headerlink" href="#macop.algorithms.multi.MOEAD.MOEAD.pfPop" title="Permalink to this definition">¶</a></dt>
  170. <dd><p>[{Solution}] – pareto front population</p>
  171. </dd></dl>
  172. <dl class="attribute">
  173. <dt id="macop.algorithms.multi.MOEAD.MOEAD.weights">
  174. <code class="sig-name descname">weights</code><a class="headerlink" href="#macop.algorithms.multi.MOEAD.MOEAD.weights" title="Permalink to this definition">¶</a></dt>
  175. <dd><p>[[{float}]] – random weights used for custom mu sub problems</p>
  176. </dd></dl>
  177. <dl class="attribute">
  178. <dt id="macop.algorithms.multi.MOEAD.MOEAD.callbacks">
  179. <code class="sig-name descname">callbacks</code><a class="headerlink" href="#macop.algorithms.multi.MOEAD.MOEAD.callbacks" title="Permalink to this definition">¶</a></dt>
  180. <dd><p>{[Callback]} – list of Callback class implementation to do some instructions every number of evaluations and <cite>load</cite> when initializing algorithm</p>
  181. </dd></dl>
  182. <dl class="method">
  183. <dt id="macop.algorithms.multi.MOEAD.MOEAD.end">
  184. <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/multi/MOEAD.html#MOEAD.end"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.algorithms.multi.MOEAD.MOEAD.end" title="Permalink to this definition">¶</a></dt>
  185. <dd><p>Display end message into <cite>run</cite> method</p>
  186. </dd></dl>
  187. <dl class="method">
  188. <dt id="macop.algorithms.multi.MOEAD.MOEAD.initRun">
  189. <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/multi/MOEAD.html#MOEAD.initRun"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.algorithms.multi.MOEAD.MOEAD.initRun" title="Permalink to this definition">¶</a></dt>
  190. <dd><p>Method which initialiazes or re-initializes the whole algorithm context specifically for MOEAD</p>
  191. </dd></dl>
  192. <dl class="method">
  193. <dt id="macop.algorithms.multi.MOEAD.MOEAD.progress">
  194. <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/multi/MOEAD.html#MOEAD.progress"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.algorithms.multi.MOEAD.MOEAD.progress" title="Permalink to this definition">¶</a></dt>
  195. <dd><p>Log progress and apply callbacks if necessary</p>
  196. </dd></dl>
  197. <dl class="method">
  198. <dt id="macop.algorithms.multi.MOEAD.MOEAD.run">
  199. <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/multi/MOEAD.html#MOEAD.run"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.algorithms.multi.MOEAD.MOEAD.run" title="Permalink to this definition">¶</a></dt>
  200. <dd><p>Run the local search algorithm</p>
  201. <dl class="field-list simple">
  202. <dt class="field-odd">Parameters</dt>
  203. <dd class="field-odd"><p><strong>_evaluations</strong> – {int} – number of Local search evaluations</p>
  204. </dd>
  205. <dt class="field-even">Returns</dt>
  206. <dd class="field-even"><p>{Solution} – best solution found</p>
  207. </dd>
  208. </dl>
  209. </dd></dl>
  210. </dd></dl>
  211. </div>
  212. </div>
  213. </div>
  214. <footer>
  215. <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
  216. <a href="macop.algorithms.multi.MOSubProblem.html" class="btn btn-neutral float-right" title="macop.algorithms.multi.MOSubProblem" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
  217. <a href="macop.algorithms.mono.LocalSearch.html" class="btn btn-neutral float-left" title="macop.algorithms.mono.LocalSearch" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
  218. </div>
  219. <hr/>
  220. <div role="contentinfo">
  221. <p>
  222. &copy; Copyright 2020, Jérôme BUISINE
  223. </p>
  224. </div>
  225. 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>.
  226. </footer>
  227. </div>
  228. </div>
  229. </section>
  230. </div>
  231. <script type="text/javascript">
  232. jQuery(function () {
  233. SphinxRtdTheme.Navigation.enable(true);
  234. });
  235. </script>
  236. </body>
  237. </html>