macop.operators.discrete.mutators.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327
  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.operators.discrete.mutators &mdash; macop v1.0.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="stylesheet" href="../_static/css/custom.css" type="text/css" />
  18. <link rel="index" title="Index" href="../genindex.html" />
  19. <link rel="search" title="Search" href="../search.html" />
  20. <link rel="next" title="macop.operators.discrete.crossovers" href="macop.operators.discrete.crossovers.html" />
  21. <link rel="prev" title="macop.operators.base" href="macop.operators.base.html" />
  22. </head>
  23. <body class="wy-body-for-nav">
  24. <div class="wy-grid-for-nav">
  25. <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  26. <div class="wy-side-scroll">
  27. <div class="wy-side-nav-search" >
  28. <a href="../index.html" class="icon icon-home"> macop
  29. </a>
  30. <div class="version">
  31. 1.0.5
  32. </div>
  33. <div role="search">
  34. <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
  35. <input type="text" name="q" placeholder="Search docs" />
  36. <input type="hidden" name="check_keywords" value="yes" />
  37. <input type="hidden" name="area" value="default" />
  38. </form>
  39. </div>
  40. </div>
  41. <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  42. <p class="caption"><span class="caption-text">Contents:</span></p>
  43. <ul class="current">
  44. <li class="toctree-l1"><a class="reference internal" href="../description.html">Description</a></li>
  45. <li class="toctree-l1 current"><a class="reference internal" href="../api.html">API</a><ul class="current">
  46. <li class="toctree-l2"><a class="reference internal" href="../api.html#macop">macop</a></li>
  47. <li class="toctree-l2"><a class="reference internal" href="../api.html#macop-algorithms">macop.algorithms</a></li>
  48. <li class="toctree-l2"><a class="reference internal" href="../api.html#macop-callbacks">macop.callbacks</a></li>
  49. <li class="toctree-l2"><a class="reference internal" href="../api.html#macop-evaluators">macop.evaluators</a></li>
  50. <li class="toctree-l2 current"><a class="reference internal" href="../api.html#macop-operators">macop.operators</a><ul class="current">
  51. <li class="toctree-l3"><a class="reference internal" href="macop.operators.base.html">macop.operators.base</a></li>
  52. <li class="toctree-l3 current"><a class="current reference internal" href="#">macop.operators.discrete.mutators</a></li>
  53. <li class="toctree-l3"><a class="reference internal" href="macop.operators.discrete.crossovers.html">macop.operators.discrete.crossovers</a></li>
  54. <li class="toctree-l3"><a class="reference internal" href="macop.operators.continuous.mutators.html">macop.operators.continuous.mutators</a></li>
  55. <li class="toctree-l3"><a class="reference internal" href="macop.operators.continuous.crossovers.html">macop.operators.continuous.crossovers</a></li>
  56. </ul>
  57. </li>
  58. <li class="toctree-l2"><a class="reference internal" href="../api.html#macop-policies">macop.policies</a></li>
  59. <li class="toctree-l2"><a class="reference internal" href="../api.html#macop-solution">macop.solution</a></li>
  60. <li class="toctree-l2"><a class="reference internal" href="../api.html#macop-utils">macop.utils</a></li>
  61. </ul>
  62. </li>
  63. <li class="toctree-l1"><a class="reference internal" href="../documentations/index.html">Documentation</a></li>
  64. <li class="toctree-l1"><a class="reference internal" href="../examples.html">Some examples</a></li>
  65. <li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
  66. </ul>
  67. </div>
  68. </div>
  69. </nav>
  70. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  71. <nav class="wy-nav-top" aria-label="top navigation">
  72. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  73. <a href="../index.html">macop</a>
  74. </nav>
  75. <div class="wy-nav-content">
  76. <div class="rst-content">
  77. <div role="navigation" aria-label="breadcrumbs navigation">
  78. <ul class="wy-breadcrumbs">
  79. <li><a href="../index.html">Docs</a> &raquo;</li>
  80. <li><a href="../api.html">API</a> &raquo;</li>
  81. <li>macop.operators.discrete.mutators</li>
  82. <li class="wy-breadcrumbs-aside">
  83. <a href="https://github.com/prise-3d/macop/blob/master/docs/source/macop/macop.operators.discrete.mutators.rst" class="fa fa-github"> Edit on GitHub</a>
  84. </li>
  85. </ul>
  86. <hr/>
  87. </div>
  88. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  89. <div itemprop="articleBody">
  90. <div class="section" id="module-macop.operators.discrete.mutators">
  91. <span id="macop-operators-discrete-mutators"></span><h1>macop.operators.discrete.mutators<a class="headerlink" href="#module-macop.operators.discrete.mutators" title="Permalink to this headline">¶</a></h1>
  92. <p>Mutation implementations for discrete solution</p>
  93. <p class="rubric">Classes</p>
  94. <table class="longtable docutils align-default">
  95. <colgroup>
  96. <col style="width: 10%" />
  97. <col style="width: 90%" />
  98. </colgroup>
  99. <tbody>
  100. <tr class="row-odd"><td><p><a class="reference internal" href="#macop.operators.discrete.mutators.SimpleBinaryMutation" title="macop.operators.discrete.mutators.SimpleBinaryMutation"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SimpleBinaryMutation</span></code></a>()</p></td>
  101. <td><p>Mutation implementation for binary solution, swap bit randomly from solution</p></td>
  102. </tr>
  103. <tr class="row-even"><td><p><a class="reference internal" href="#macop.operators.discrete.mutators.SimpleMutation" title="macop.operators.discrete.mutators.SimpleMutation"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SimpleMutation</span></code></a>()</p></td>
  104. <td><p>Mutation implementation for binary solution, swap two bits randomly from solution</p></td>
  105. </tr>
  106. </tbody>
  107. </table>
  108. <dl class="class">
  109. <dt id="macop.operators.discrete.mutators.SimpleBinaryMutation">
  110. <em class="property">class </em><code class="sig-prename descclassname">macop.operators.discrete.mutators.</code><code class="sig-name descname">SimpleBinaryMutation</code><a class="reference internal" href="../_modules/macop/operators/discrete/mutators.html#SimpleBinaryMutation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.operators.discrete.mutators.SimpleBinaryMutation" title="Permalink to this definition">¶</a></dt>
  111. <dd><p>Mutation implementation for binary solution, swap bit randomly from solution</p>
  112. <dl class="attribute">
  113. <dt id="macop.operators.discrete.mutators.SimpleBinaryMutation.kind">
  114. <code class="sig-name descname">kind</code><a class="headerlink" href="#macop.operators.discrete.mutators.SimpleBinaryMutation.kind" title="Permalink to this definition">¶</a></dt>
  115. <dd><p>{KindOperator} – specify the kind of operator</p>
  116. </dd></dl>
  117. <p>Example:</p>
  118. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="c1"># import of solution and simple binary mutation operator</span>
  119. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">macop.solutions.discrete</span> <span class="kn">import</span> <span class="n">BinarySolution</span>
  120. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">macop.operators.discrete.mutators</span> <span class="kn">import</span> <span class="n">SimpleBinaryMutation</span>
  121. <span class="gp">&gt;&gt;&gt; </span><span class="n">solution</span> <span class="o">=</span> <span class="n">BinarySolution</span><span class="o">.</span><span class="n">random</span><span class="p">(</span><span class="mi">5</span><span class="p">)</span>
  122. <span class="gp">&gt;&gt;&gt; </span><span class="nb">list</span><span class="p">(</span><span class="n">solution</span><span class="o">.</span><span class="n">_data</span><span class="p">)</span>
  123. <span class="go">[0, 1, 0, 0, 0]</span>
  124. <span class="gp">&gt;&gt;&gt; </span><span class="n">mutator</span> <span class="o">=</span> <span class="n">SimpleBinaryMutation</span><span class="p">()</span>
  125. <span class="gp">&gt;&gt;&gt; </span><span class="n">mutation_solution</span> <span class="o">=</span> <span class="n">mutator</span><span class="o">.</span><span class="n">apply</span><span class="p">(</span><span class="n">solution</span><span class="p">)</span>
  126. <span class="gp">&gt;&gt;&gt; </span><span class="nb">list</span><span class="p">(</span><span class="n">mutation_solution</span><span class="o">.</span><span class="n">_data</span><span class="p">)</span>
  127. <span class="go">[1, 1, 0, 0, 0]</span>
  128. </pre></div>
  129. </div>
  130. <dl class="method">
  131. <dt id="macop.operators.discrete.mutators.SimpleBinaryMutation.apply">
  132. <code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">solution</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/macop/operators/discrete/mutators.html#SimpleBinaryMutation.apply"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.operators.discrete.mutators.SimpleBinaryMutation.apply" title="Permalink to this definition">¶</a></dt>
  133. <dd><p>Create new solution based on solution passed as parameter</p>
  134. <dl class="field-list simple">
  135. <dt class="field-odd">Parameters</dt>
  136. <dd class="field-odd"><p><strong>solution</strong> – {Solution} – the solution to use for generating new solution</p>
  137. </dd>
  138. <dt class="field-even">Returns</dt>
  139. <dd class="field-even"><p>{Solution} – new generated solution</p>
  140. </dd>
  141. </dl>
  142. </dd></dl>
  143. </dd></dl>
  144. <dl class="class">
  145. <dt id="macop.operators.discrete.mutators.SimpleMutation">
  146. <em class="property">class </em><code class="sig-prename descclassname">macop.operators.discrete.mutators.</code><code class="sig-name descname">SimpleMutation</code><a class="reference internal" href="../_modules/macop/operators/discrete/mutators.html#SimpleMutation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.operators.discrete.mutators.SimpleMutation" title="Permalink to this definition">¶</a></dt>
  147. <dd><p>Mutation implementation for binary solution, swap two bits randomly from solution</p>
  148. <dl class="attribute">
  149. <dt id="macop.operators.discrete.mutators.SimpleMutation.kind">
  150. <code class="sig-name descname">kind</code><a class="headerlink" href="#macop.operators.discrete.mutators.SimpleMutation.kind" title="Permalink to this definition">¶</a></dt>
  151. <dd><p>{KindOperator} – specify the kind of operator</p>
  152. </dd></dl>
  153. <p>Example:</p>
  154. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="c1"># import of solution and simple mutation operator</span>
  155. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">macop.solutions.discrete</span> <span class="kn">import</span> <span class="n">BinarySolution</span>
  156. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">macop.operators.discrete.mutators</span> <span class="kn">import</span> <span class="n">SimpleMutation</span>
  157. <span class="gp">&gt;&gt;&gt; </span><span class="n">solution</span> <span class="o">=</span> <span class="n">BinarySolution</span><span class="o">.</span><span class="n">random</span><span class="p">(</span><span class="mi">5</span><span class="p">)</span>
  158. <span class="gp">&gt;&gt;&gt; </span><span class="nb">list</span><span class="p">(</span><span class="n">solution</span><span class="o">.</span><span class="n">_data</span><span class="p">)</span>
  159. <span class="go">[1, 0, 0, 0, 1]</span>
  160. <span class="gp">&gt;&gt;&gt; </span><span class="n">mutator</span> <span class="o">=</span> <span class="n">SimpleMutation</span><span class="p">()</span>
  161. <span class="gp">&gt;&gt;&gt; </span><span class="n">mutation_solution</span> <span class="o">=</span> <span class="n">mutator</span><span class="o">.</span><span class="n">apply</span><span class="p">(</span><span class="n">solution</span><span class="p">)</span>
  162. <span class="gp">&gt;&gt;&gt; </span><span class="nb">list</span><span class="p">(</span><span class="n">mutation_solution</span><span class="o">.</span><span class="n">_data</span><span class="p">)</span>
  163. <span class="go">[0, 0, 1, 0, 1]</span>
  164. </pre></div>
  165. </div>
  166. <dl class="method">
  167. <dt id="macop.operators.discrete.mutators.SimpleMutation.apply">
  168. <code class="sig-name descname">apply</code><span class="sig-paren">(</span><em class="sig-param">solution</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/macop/operators/discrete/mutators.html#SimpleMutation.apply"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.operators.discrete.mutators.SimpleMutation.apply" title="Permalink to this definition">¶</a></dt>
  169. <dd><p>Create new solution based on solution passed as parameter</p>
  170. <dl class="field-list simple">
  171. <dt class="field-odd">Parameters</dt>
  172. <dd class="field-odd"><p><strong>solution</strong> – {Solution} – the solution to use for generating new solution</p>
  173. </dd>
  174. <dt class="field-even">Returns</dt>
  175. <dd class="field-even"><p>{Solution} – new generated solution</p>
  176. </dd>
  177. </dl>
  178. </dd></dl>
  179. </dd></dl>
  180. </div>
  181. </div>
  182. </div>
  183. <footer>
  184. <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
  185. <a href="macop.operators.discrete.crossovers.html" class="btn btn-neutral float-right" title="macop.operators.discrete.crossovers" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
  186. <a href="macop.operators.base.html" class="btn btn-neutral float-left" title="macop.operators.base" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
  187. </div>
  188. <hr/>
  189. <div role="contentinfo">
  190. <p>
  191. &copy; Copyright 2020, Jérôme BUISINE
  192. </p>
  193. </div>
  194. 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>.
  195. </footer>
  196. </div>
  197. </div>
  198. </section>
  199. </div>
  200. <script type="text/javascript">
  201. jQuery(function () {
  202. SphinxRtdTheme.Navigation.enable(true);
  203. });
  204. </script>
  205. </body>
  206. </html>