LocalSearch.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262
  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.LocalSearch &mdash; macop v0.1.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. </head>
  20. <body class="wy-body-for-nav">
  21. <div class="wy-grid-for-nav">
  22. <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  23. <div class="wy-side-scroll">
  24. <div class="wy-side-nav-search" >
  25. <a href="../../../index.html" class="icon icon-home"> macop
  26. </a>
  27. <div class="version">
  28. 0.1.4
  29. </div>
  30. <div role="search">
  31. <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
  32. <input type="text" name="q" placeholder="Search docs" />
  33. <input type="hidden" name="check_keywords" value="yes" />
  34. <input type="hidden" name="area" value="default" />
  35. </form>
  36. </div>
  37. </div>
  38. <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  39. <p class="caption"><span class="caption-text">Contents:</span></p>
  40. <ul>
  41. <li class="toctree-l1"><a class="reference internal" href="../../../description.html">Description</a></li>
  42. <li class="toctree-l1"><a class="reference internal" href="../../../macop.html">Documentation</a></li>
  43. <li class="toctree-l1"><a class="reference internal" href="../../../examples.html">Some examples</a></li>
  44. <li class="toctree-l1"><a class="reference internal" href="../../../contributing.html">Contributing</a></li>
  45. </ul>
  46. </div>
  47. </div>
  48. </nav>
  49. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  50. <nav class="wy-nav-top" aria-label="top navigation">
  51. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  52. <a href="../../../index.html">macop</a>
  53. </nav>
  54. <div class="wy-nav-content">
  55. <div class="rst-content">
  56. <div role="navigation" aria-label="breadcrumbs navigation">
  57. <ul class="wy-breadcrumbs">
  58. <li><a href="../../../index.html">Docs</a> &raquo;</li>
  59. <li><a href="../../index.html">Module code</a> &raquo;</li>
  60. <li>macop.algorithms.LocalSearch</li>
  61. <li class="wy-breadcrumbs-aside">
  62. </li>
  63. </ul>
  64. <hr/>
  65. </div>
  66. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  67. <div itemprop="articleBody">
  68. <h1>Source code for macop.algorithms.LocalSearch</h1><div class="highlight"><pre>
  69. <span></span><span class="sd">&quot;&quot;&quot;Local Search algorithm</span>
  70. <span class="sd">&quot;&quot;&quot;</span>
  71. <span class="c1"># main imports</span>
  72. <span class="kn">import</span> <span class="nn">logging</span>
  73. <span class="c1"># module imports</span>
  74. <span class="kn">from</span> <span class="nn">.Algorithm</span> <span class="kn">import</span> <span class="n">Algorithm</span>
  75. <div class="viewcode-block" id="LocalSearch"><a class="viewcode-back" href="../../../macop/macop.algorithms.LocalSearch.html#macop.algorithms.LocalSearch.LocalSearch">[docs]</a><span class="k">class</span> <span class="nc">LocalSearch</span><span class="p">(</span><span class="n">Algorithm</span><span class="p">):</span>
  76. <span class="sd">&quot;&quot;&quot;Local Search used as exploitation optimization algorithm</span>
  77. <span class="sd"> Attributes:</span>
  78. <span class="sd"> initalizer: {function} -- basic function strategy to initialize solution</span>
  79. <span class="sd"> evaluator: {function} -- basic function in order to obtained fitness (mono or multiple objectives)</span>
  80. <span class="sd"> operators: {[Operator]} -- list of operator to use when launching algorithm</span>
  81. <span class="sd"> policy: {Policy} -- Policy class implementation strategy to select operators</span>
  82. <span class="sd"> validator: {function} -- basic function to check if solution is valid or not under some constraints</span>
  83. <span class="sd"> maximise: {bool} -- specify kind of optimization problem </span>
  84. <span class="sd"> currentSolution: {Solution} -- current solution managed for current evaluation</span>
  85. <span class="sd"> bestSolution: {Solution} -- best solution found so far during running algorithm</span>
  86. <span class="sd"> checkpoint: {Checkpoint} -- Checkpoint class implementation to keep track of algorithm and restart</span>
  87. <span class="sd"> &quot;&quot;&quot;</span>
  88. <div class="viewcode-block" id="LocalSearch.run"><a class="viewcode-back" href="../../../macop/macop.algorithms.LocalSearch.html#macop.algorithms.LocalSearch.LocalSearch.run">[docs]</a> <span class="k">def</span> <span class="nf">run</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">_evaluations</span><span class="p">):</span>
  89. <span class="sd">&quot;&quot;&quot;</span>
  90. <span class="sd"> Run the local search algorithm</span>
  91. <span class="sd"> Attributes:</span>
  92. <span class="sd"> _evaluations: {int} -- number of Local search evaluations</span>
  93. <span class="sd"> </span>
  94. <span class="sd"> Returns:</span>
  95. <span class="sd"> {Solution} -- best solution found</span>
  96. <span class="sd"> &quot;&quot;&quot;</span>
  97. <span class="c1"># by default use of mother method to initialize variables</span>
  98. <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">_evaluations</span><span class="p">)</span>
  99. <span class="n">solutionSize</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">bestSolution</span><span class="o">.</span><span class="n">size</span>
  100. <span class="c1"># local search algorithm implementation</span>
  101. <span class="k">while</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">stop</span><span class="p">():</span>
  102. <span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">solutionSize</span><span class="p">):</span>
  103. <span class="c1"># update solution using policy</span>
  104. <span class="n">newSolution</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">bestSolution</span><span class="p">)</span>
  105. <span class="c1"># if better solution than currently, replace it</span>
  106. <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">isBetter</span><span class="p">(</span><span class="n">newSolution</span><span class="p">):</span>
  107. <span class="bp">self</span><span class="o">.</span><span class="n">bestSolution</span> <span class="o">=</span> <span class="n">newSolution</span>
  108. <span class="c1"># increase number of evaluations</span>
  109. <span class="bp">self</span><span class="o">.</span><span class="n">increaseEvaluation</span><span class="p">()</span>
  110. <span class="bp">self</span><span class="o">.</span><span class="n">progress</span><span class="p">()</span>
  111. <span class="n">logging</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">&quot;---- Current </span><span class="si">%s</span><span class="s2"> - SCORE </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span>
  112. <span class="p">(</span><span class="n">newSolution</span><span class="p">,</span> <span class="n">newSolution</span><span class="o">.</span><span class="n">fitness</span><span class="p">()))</span>
  113. <span class="c1"># stop algorithm if necessary</span>
  114. <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">stop</span><span class="p">():</span>
  115. <span class="k">break</span>
  116. <span class="n">logging</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">&quot;End of </span><span class="si">%s</span><span class="s2">, best solution found </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span>
  117. <span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="vm">__name__</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">bestSolution</span><span class="p">))</span>
  118. <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">bestSolution</span></div></div>
  119. </pre></div>
  120. </div>
  121. </div>
  122. <footer>
  123. <hr/>
  124. <div role="contentinfo">
  125. <p>
  126. &copy; Copyright 2020, Jérôme BUISINE
  127. </p>
  128. </div>
  129. 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>.
  130. </footer>
  131. </div>
  132. </div>
  133. </section>
  134. </div>
  135. <script type="text/javascript">
  136. jQuery(function () {
  137. SphinxRtdTheme.Navigation.enable(true);
  138. });
  139. </script>
  140. </body>
  141. </html>