macop.algorithms.mono.LocalSearch.html 12 KB

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