macop.algorithms.mono.HillClimberFirstImprovment.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320
  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.mono.HillClimberFirstImprovment &mdash; macop v1.0.2 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.HillClimberBestImprovment" href="macop.algorithms.mono.HillClimberBestImprovment.html" />
  20. <link rel="prev" title="macop.algorithms.mono.IteratedLocalSearch" href="macop.algorithms.mono.IteratedLocalSearch.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.2
  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 current"><a class="current reference internal" href="#">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"><a class="reference internal" href="macop.algorithms.multi.MOSubProblem.html">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.mono.HillClimberFirstImprovment</li>
  79. <li class="wy-breadcrumbs-aside">
  80. <a href="https://github.com/prise-3d/macop/blob/master/docs/source/macop/macop.algorithms.mono.HillClimberFirstImprovment.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.mono.HillClimberFirstImprovment">
  88. <span id="macop-algorithms-mono-hillclimberfirstimprovment"></span><h1>macop.algorithms.mono.HillClimberFirstImprovment<a class="headerlink" href="#module-macop.algorithms.mono.HillClimberFirstImprovment" title="Permalink to this headline">¶</a></h1>
  89. <p>Hill Climber First Improvment algorithm starting from new solution and explore using neighborhood and loop over the best one obtained from neighborhood search space</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.mono.HillClimberFirstImprovment.HillClimberFirstImprovment" title="macop.algorithms.mono.HillClimberFirstImprovment.HillClimberFirstImprovment"><code class="xref py py-obj docutils literal notranslate"><span class="pre">HillClimberFirstImprovment</span></code></a>(initalizer, …)</p></td>
  98. <td><p>Hill Climber First Improvment used as quick exploration optimisation algorithm</p></td>
  99. </tr>
  100. </tbody>
  101. </table>
  102. <dl class="class">
  103. <dt id="macop.algorithms.mono.HillClimberFirstImprovment.HillClimberFirstImprovment">
  104. <em class="property">class </em><code class="sig-prename descclassname">macop.algorithms.mono.HillClimberFirstImprovment.</code><code class="sig-name descname">HillClimberFirstImprovment</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/mono/HillClimberFirstImprovment.html#HillClimberFirstImprovment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.algorithms.mono.HillClimberFirstImprovment.HillClimberFirstImprovment" title="Permalink to this definition">¶</a></dt>
  105. <dd><p>Hill Climber First Improvment used as quick exploration optimisation algorithm</p>
  106. <p>This algorithm do a neighborhood exploration of a new generated solution (by doing operation on the current solution obtained) in order to find a better solution from the neighborhood space.
  107. Then replace the current solution by the first one from the neighbordhood space which is better than the current solution.
  108. Do these steps until a number of evaluation (stopping criterion) is reached.</p>
  109. <dl class="attribute">
  110. <dt id="macop.algorithms.mono.HillClimberFirstImprovment.HillClimberFirstImprovment.initalizer">
  111. <code class="sig-name descname">initalizer</code><a class="headerlink" href="#macop.algorithms.mono.HillClimberFirstImprovment.HillClimberFirstImprovment.initalizer" title="Permalink to this definition">¶</a></dt>
  112. <dd><p>{function} – basic function strategy to initialize solution</p>
  113. </dd></dl>
  114. <dl class="attribute">
  115. <dt id="macop.algorithms.mono.HillClimberFirstImprovment.HillClimberFirstImprovment.evaluator">
  116. <code class="sig-name descname">evaluator</code><a class="headerlink" href="#macop.algorithms.mono.HillClimberFirstImprovment.HillClimberFirstImprovment.evaluator" title="Permalink to this definition">¶</a></dt>
  117. <dd><p>{function} – basic function in order to obtained fitness (mono or multiple objectives)</p>
  118. </dd></dl>
  119. <dl class="attribute">
  120. <dt id="macop.algorithms.mono.HillClimberFirstImprovment.HillClimberFirstImprovment.operators">
  121. <code class="sig-name descname">operators</code><a class="headerlink" href="#macop.algorithms.mono.HillClimberFirstImprovment.HillClimberFirstImprovment.operators" title="Permalink to this definition">¶</a></dt>
  122. <dd><p>{[Operator]} – list of operator to use when launching algorithm</p>
  123. </dd></dl>
  124. <dl class="attribute">
  125. <dt id="macop.algorithms.mono.HillClimberFirstImprovment.HillClimberFirstImprovment.policy">
  126. <code class="sig-name descname">policy</code><a class="headerlink" href="#macop.algorithms.mono.HillClimberFirstImprovment.HillClimberFirstImprovment.policy" title="Permalink to this definition">¶</a></dt>
  127. <dd><p>{Policy} – Policy class implementation strategy to select operators</p>
  128. </dd></dl>
  129. <dl class="attribute">
  130. <dt id="macop.algorithms.mono.HillClimberFirstImprovment.HillClimberFirstImprovment.validator">
  131. <code class="sig-name descname">validator</code><a class="headerlink" href="#macop.algorithms.mono.HillClimberFirstImprovment.HillClimberFirstImprovment.validator" title="Permalink to this definition">¶</a></dt>
  132. <dd><p>{function} – basic function to check if solution is valid or not under some constraints</p>
  133. </dd></dl>
  134. <dl class="attribute">
  135. <dt id="macop.algorithms.mono.HillClimberFirstImprovment.HillClimberFirstImprovment.maximise">
  136. <code class="sig-name descname">maximise</code><a class="headerlink" href="#macop.algorithms.mono.HillClimberFirstImprovment.HillClimberFirstImprovment.maximise" title="Permalink to this definition">¶</a></dt>
  137. <dd><p>{bool} – specify kind of optimisation problem</p>
  138. </dd></dl>
  139. <dl class="attribute">
  140. <dt id="macop.algorithms.mono.HillClimberFirstImprovment.HillClimberFirstImprovment.currentSolution">
  141. <code class="sig-name descname">currentSolution</code><a class="headerlink" href="#macop.algorithms.mono.HillClimberFirstImprovment.HillClimberFirstImprovment.currentSolution" title="Permalink to this definition">¶</a></dt>
  142. <dd><p>{Solution} – current solution managed for current evaluation</p>
  143. </dd></dl>
  144. <dl class="attribute">
  145. <dt id="macop.algorithms.mono.HillClimberFirstImprovment.HillClimberFirstImprovment.bestSolution">
  146. <code class="sig-name descname">bestSolution</code><a class="headerlink" href="#macop.algorithms.mono.HillClimberFirstImprovment.HillClimberFirstImprovment.bestSolution" title="Permalink to this definition">¶</a></dt>
  147. <dd><p>{Solution} – best solution found so far during running algorithm</p>
  148. </dd></dl>
  149. <dl class="attribute">
  150. <dt id="macop.algorithms.mono.HillClimberFirstImprovment.HillClimberFirstImprovment.callbacks">
  151. <code class="sig-name descname">callbacks</code><a class="headerlink" href="#macop.algorithms.mono.HillClimberFirstImprovment.HillClimberFirstImprovment.callbacks" title="Permalink to this definition">¶</a></dt>
  152. <dd><p>{[Callback]} – list of Callback class implementation to do some instructions every number of evaluations and <cite>load</cite> when initializing algorithm</p>
  153. </dd></dl>
  154. <dl class="method">
  155. <dt id="macop.algorithms.mono.HillClimberFirstImprovment.HillClimberFirstImprovment.run">
  156. <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/mono/HillClimberFirstImprovment.html#HillClimberFirstImprovment.run"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.algorithms.mono.HillClimberFirstImprovment.HillClimberFirstImprovment.run" title="Permalink to this definition">¶</a></dt>
  157. <dd><p>Run the local search algorithm</p>
  158. <dl class="field-list simple">
  159. <dt class="field-odd">Parameters</dt>
  160. <dd class="field-odd"><p><strong>evaluations</strong> – {int} – number of Local search evaluations</p>
  161. </dd>
  162. <dt class="field-even">Returns</dt>
  163. <dd class="field-even"><p>{Solution} – best solution found</p>
  164. </dd>
  165. </dl>
  166. </dd></dl>
  167. </dd></dl>
  168. </div>
  169. </div>
  170. </div>
  171. <footer>
  172. <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
  173. <a href="macop.algorithms.mono.HillClimberBestImprovment.html" class="btn btn-neutral float-right" title="macop.algorithms.mono.HillClimberBestImprovment" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
  174. <a href="macop.algorithms.mono.IteratedLocalSearch.html" class="btn btn-neutral float-left" title="macop.algorithms.mono.IteratedLocalSearch" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
  175. </div>
  176. <hr/>
  177. <div role="contentinfo">
  178. <p>
  179. &copy; Copyright 2020, Jérôme BUISINE
  180. </p>
  181. </div>
  182. 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>.
  183. </footer>
  184. </div>
  185. </div>
  186. </section>
  187. </div>
  188. <script type="text/javascript">
  189. jQuery(function () {
  190. SphinxRtdTheme.Navigation.enable(true);
  191. });
  192. </script>
  193. </body>
  194. </html>