macop.algorithms.multi.MOSubProblem.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329
  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.MOSubProblem &mdash; macop v1.0.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.callbacks.BasicCheckpoint" href="macop.callbacks.BasicCheckpoint.html" />
  20. <link rel="prev" title="macop.algorithms.multi.MOEAD" href="macop.algorithms.multi.MOEAD.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. 1.0.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="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.HillClimberFirstImprovment.html">macop.algorithms.mono.HillClimberFirstImprovment</a></li>
  50. <li class="toctree-l3"><a class="reference internal" href="macop.algorithms.mono.HillClimberBestImprovment.html">macop.algorithms.mono.HillClimberBestImprovment</a></li>
  51. <li class="toctree-l3"><a class="reference internal" href="macop.algorithms.multi.MOEAD.html">macop.algorithms.multi.MOEAD</a></li>
  52. <li class="toctree-l3 current"><a class="current reference internal" href="#">macop.algorithms.multi.MOSubProblem</a></li>
  53. </ul>
  54. </li>
  55. <li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-callbacks">macop.callbacks</a></li>
  56. <li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-evaluators">macop.evaluators</a></li>
  57. <li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-operators">macop.operators</a></li>
  58. <li class="toctree-l2"><a class="reference internal" href="../macop.html#macop-solution">macop.solution</a></li>
  59. </ul>
  60. </li>
  61. <li class="toctree-l1"><a class="reference internal" href="../examples.html">Some examples</a></li>
  62. <li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
  63. </ul>
  64. </div>
  65. </div>
  66. </nav>
  67. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  68. <nav class="wy-nav-top" aria-label="top navigation">
  69. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  70. <a href="../index.html">macop</a>
  71. </nav>
  72. <div class="wy-nav-content">
  73. <div class="rst-content">
  74. <div role="navigation" aria-label="breadcrumbs navigation">
  75. <ul class="wy-breadcrumbs">
  76. <li><a href="../index.html">Docs</a> &raquo;</li>
  77. <li><a href="../macop.html">Documentation</a> &raquo;</li>
  78. <li>macop.algorithms.multi.MOSubProblem</li>
  79. <li class="wy-breadcrumbs-aside">
  80. <a href="https://github.com/prise-3d/macop/blob/master/docs/source/macop/macop.algorithms.multi.MOSubProblem.rst" class="fa fa-github"> Edit on GitHub</a>
  81. </li>
  82. </ul>
  83. <hr/>
  84. </div>
  85. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  86. <div itemprop="articleBody">
  87. <div class="section" id="module-macop.algorithms.multi.MOSubProblem">
  88. <span id="macop-algorithms-multi-mosubproblem"></span><h1>macop.algorithms.multi.MOSubProblem<a class="headerlink" href="#module-macop.algorithms.multi.MOSubProblem" title="Permalink to this headline">¶</a></h1>
  89. <p>MOEAD sub problem algorithm class</p>
  90. <p class="rubric">Classes</p>
  91. <table class="longtable docutils align-default">
  92. <colgroup>
  93. <col style="width: 10%" />
  94. <col style="width: 90%" />
  95. </colgroup>
  96. <tbody>
  97. <tr class="row-odd"><td><p><a class="reference internal" href="#macop.algorithms.multi.MOSubProblem.MOSubProblem" title="macop.algorithms.multi.MOSubProblem.MOSubProblem"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MOSubProblem</span></code></a>(index, weights, initalizer, …)</p></td>
  98. <td><p>Specific MO sub problem used into MOEAD</p></td>
  99. </tr>
  100. </tbody>
  101. </table>
  102. <dl class="class">
  103. <dt id="macop.algorithms.multi.MOSubProblem.MOSubProblem">
  104. <em class="property">class </em><code class="sig-prename descclassname">macop.algorithms.multi.MOSubProblem.</code><code class="sig-name descname">MOSubProblem</code><span class="sig-paren">(</span><em class="sig-param">index</em>, <em class="sig-param">weights</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/MOSubProblem.html#MOSubProblem"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.algorithms.multi.MOSubProblem.MOSubProblem" title="Permalink to this definition">¶</a></dt>
  105. <dd><p>Specific MO sub problem used into MOEAD</p>
  106. <dl class="attribute">
  107. <dt id="macop.algorithms.multi.MOSubProblem.MOSubProblem.index">
  108. <code class="sig-name descname">index</code><a class="headerlink" href="#macop.algorithms.multi.MOSubProblem.MOSubProblem.index" title="Permalink to this definition">¶</a></dt>
  109. <dd><p>{int} – sub problem index</p>
  110. </dd></dl>
  111. <dl class="attribute">
  112. <dt id="macop.algorithms.multi.MOSubProblem.MOSubProblem.weights">
  113. <code class="sig-name descname">weights</code><a class="headerlink" href="#macop.algorithms.multi.MOSubProblem.MOSubProblem.weights" title="Permalink to this definition">¶</a></dt>
  114. <dd><p>{[float]} – sub problems objectives weights</p>
  115. </dd></dl>
  116. <dl class="attribute">
  117. <dt id="macop.algorithms.multi.MOSubProblem.MOSubProblem.initalizer">
  118. <code class="sig-name descname">initalizer</code><a class="headerlink" href="#macop.algorithms.multi.MOSubProblem.MOSubProblem.initalizer" title="Permalink to this definition">¶</a></dt>
  119. <dd><p>{function} – basic function strategy to initialize solution</p>
  120. </dd></dl>
  121. <dl class="attribute">
  122. <dt id="macop.algorithms.multi.MOSubProblem.MOSubProblem.evaluator">
  123. <code class="sig-name descname">evaluator</code><a class="headerlink" href="#macop.algorithms.multi.MOSubProblem.MOSubProblem.evaluator" title="Permalink to this definition">¶</a></dt>
  124. <dd><p>{function} – basic function in order to obtained fitness (mono or multiple objectives)</p>
  125. </dd></dl>
  126. <dl class="attribute">
  127. <dt id="macop.algorithms.multi.MOSubProblem.MOSubProblem.operators">
  128. <code class="sig-name descname">operators</code><a class="headerlink" href="#macop.algorithms.multi.MOSubProblem.MOSubProblem.operators" title="Permalink to this definition">¶</a></dt>
  129. <dd><p>{[Operator]} – list of operator to use when launching algorithm</p>
  130. </dd></dl>
  131. <dl class="attribute">
  132. <dt id="macop.algorithms.multi.MOSubProblem.MOSubProblem.policy">
  133. <code class="sig-name descname">policy</code><a class="headerlink" href="#macop.algorithms.multi.MOSubProblem.MOSubProblem.policy" title="Permalink to this definition">¶</a></dt>
  134. <dd><p>{Policy} – Policy class implementation strategy to select operators</p>
  135. </dd></dl>
  136. <dl class="attribute">
  137. <dt id="macop.algorithms.multi.MOSubProblem.MOSubProblem.validator">
  138. <code class="sig-name descname">validator</code><a class="headerlink" href="#macop.algorithms.multi.MOSubProblem.MOSubProblem.validator" title="Permalink to this definition">¶</a></dt>
  139. <dd><p>{function} – basic function to check if solution is valid or not under some constraints</p>
  140. </dd></dl>
  141. <dl class="attribute">
  142. <dt id="macop.algorithms.multi.MOSubProblem.MOSubProblem.maximise">
  143. <code class="sig-name descname">maximise</code><a class="headerlink" href="#macop.algorithms.multi.MOSubProblem.MOSubProblem.maximise" title="Permalink to this definition">¶</a></dt>
  144. <dd><p>{bool} – specify kind of optimisation problem</p>
  145. </dd></dl>
  146. <dl class="attribute">
  147. <dt id="macop.algorithms.multi.MOSubProblem.MOSubProblem.currentSolution">
  148. <code class="sig-name descname">currentSolution</code><a class="headerlink" href="#macop.algorithms.multi.MOSubProblem.MOSubProblem.currentSolution" title="Permalink to this definition">¶</a></dt>
  149. <dd><p>{Solution} – current solution managed for current evaluation</p>
  150. </dd></dl>
  151. <dl class="attribute">
  152. <dt id="macop.algorithms.multi.MOSubProblem.MOSubProblem.bestSolution">
  153. <code class="sig-name descname">bestSolution</code><a class="headerlink" href="#macop.algorithms.multi.MOSubProblem.MOSubProblem.bestSolution" title="Permalink to this definition">¶</a></dt>
  154. <dd><p>{Solution} – best solution found so far during running algorithm</p>
  155. </dd></dl>
  156. <dl class="attribute">
  157. <dt id="macop.algorithms.multi.MOSubProblem.MOSubProblem.callbacks">
  158. <code class="sig-name descname">callbacks</code><a class="headerlink" href="#macop.algorithms.multi.MOSubProblem.MOSubProblem.callbacks" title="Permalink to this definition">¶</a></dt>
  159. <dd><p>{[Callback]} – list of Callback class implementation to do some instructions every number of evaluations and <cite>load</cite> when initializing algorithm</p>
  160. </dd></dl>
  161. <dl class="method">
  162. <dt id="macop.algorithms.multi.MOSubProblem.MOSubProblem.run">
  163. <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/MOSubProblem.html#MOSubProblem.run"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.algorithms.multi.MOSubProblem.MOSubProblem.run" title="Permalink to this definition">¶</a></dt>
  164. <dd><p>Run the local search algorithm</p>
  165. <dl class="field-list simple">
  166. <dt class="field-odd">Parameters</dt>
  167. <dd class="field-odd"><p><strong>evaluations</strong> – {int} – number of evaluations</p>
  168. </dd>
  169. <dt class="field-even">Returns</dt>
  170. <dd class="field-even"><p>{Solution} – best solution found</p>
  171. </dd>
  172. </dl>
  173. </dd></dl>
  174. </dd></dl>
  175. </div>
  176. </div>
  177. </div>
  178. <footer>
  179. <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
  180. <a href="macop.callbacks.BasicCheckpoint.html" class="btn btn-neutral float-right" title="macop.callbacks.BasicCheckpoint" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
  181. <a href="macop.algorithms.multi.MOEAD.html" class="btn btn-neutral float-left" title="macop.algorithms.multi.MOEAD" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
  182. </div>
  183. <hr/>
  184. <div role="contentinfo">
  185. <p>
  186. &copy; Copyright 2020, Jérôme BUISINE
  187. </p>
  188. </div>
  189. 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>.
  190. </footer>
  191. </div>
  192. </div>
  193. </section>
  194. </div>
  195. <script type="text/javascript">
  196. jQuery(function () {
  197. SphinxRtdTheme.Navigation.enable(true);
  198. });
  199. </script>
  200. </body>
  201. </html>