macop.solutions.discrete.html 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409
  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.solutions.discrete &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.solutions.continuous" href="macop.solutions.continuous.html" />
  21. <link rel="prev" title="macop.solutions.base" href="macop.solutions.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"><a class="reference internal" href="../api.html#macop-operators">macop.operators</a></li>
  51. <li class="toctree-l2"><a class="reference internal" href="../api.html#macop-policies">macop.policies</a></li>
  52. <li class="toctree-l2 current"><a class="reference internal" href="../api.html#macop-solution">macop.solution</a><ul class="current">
  53. <li class="toctree-l3"><a class="reference internal" href="macop.solutions.base.html">macop.solutions.base</a></li>
  54. <li class="toctree-l3 current"><a class="current reference internal" href="#">macop.solutions.discrete</a></li>
  55. <li class="toctree-l3"><a class="reference internal" href="macop.solutions.continuous.html">macop.solutions.continuous</a></li>
  56. </ul>
  57. </li>
  58. <li class="toctree-l2"><a class="reference internal" href="../api.html#macop-utils">macop.utils</a></li>
  59. </ul>
  60. </li>
  61. <li class="toctree-l1"><a class="reference internal" href="../documentations/index.html">Documentation</a></li>
  62. <li class="toctree-l1"><a class="reference internal" href="../examples.html">Some examples</a></li>
  63. <li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
  64. </ul>
  65. </div>
  66. </div>
  67. </nav>
  68. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  69. <nav class="wy-nav-top" aria-label="top navigation">
  70. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  71. <a href="../index.html">macop</a>
  72. </nav>
  73. <div class="wy-nav-content">
  74. <div class="rst-content">
  75. <div role="navigation" aria-label="breadcrumbs navigation">
  76. <ul class="wy-breadcrumbs">
  77. <li><a href="../index.html">Docs</a> &raquo;</li>
  78. <li><a href="../api.html">API</a> &raquo;</li>
  79. <li>macop.solutions.discrete</li>
  80. <li class="wy-breadcrumbs-aside">
  81. <a href="https://github.com/prise-3d/macop/blob/master/docs/source/macop/macop.solutions.discrete.rst" class="fa fa-github"> Edit on GitHub</a>
  82. </li>
  83. </ul>
  84. <hr/>
  85. </div>
  86. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  87. <div itemprop="articleBody">
  88. <div class="section" id="module-macop.solutions.discrete">
  89. <span id="macop-solutions-discrete"></span><h1>macop.solutions.discrete<a class="headerlink" href="#module-macop.solutions.discrete" title="Permalink to this headline">¶</a></h1>
  90. <p>Discrete solution classes implementations</p>
  91. <p class="rubric">Classes</p>
  92. <table class="longtable docutils align-default">
  93. <colgroup>
  94. <col style="width: 10%" />
  95. <col style="width: 90%" />
  96. </colgroup>
  97. <tbody>
  98. <tr class="row-odd"><td><p><a class="reference internal" href="#macop.solutions.discrete.BinarySolution" title="macop.solutions.discrete.BinarySolution"><code class="xref py py-obj docutils literal notranslate"><span class="pre">BinarySolution</span></code></a>(data, size)</p></td>
  99. <td><p>Binary integer solution class</p></td>
  100. </tr>
  101. <tr class="row-even"><td><p><a class="reference internal" href="#macop.solutions.discrete.CombinatoryIntegerSolution" title="macop.solutions.discrete.CombinatoryIntegerSolution"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CombinatoryIntegerSolution</span></code></a>(data, size)</p></td>
  102. <td><p>Combinatory integer solution class</p></td>
  103. </tr>
  104. <tr class="row-odd"><td><p><a class="reference internal" href="#macop.solutions.discrete.IntegerSolution" title="macop.solutions.discrete.IntegerSolution"><code class="xref py py-obj docutils literal notranslate"><span class="pre">IntegerSolution</span></code></a>(data, size)</p></td>
  105. <td><p>Integer solution class</p></td>
  106. </tr>
  107. </tbody>
  108. </table>
  109. <dl class="class">
  110. <dt id="macop.solutions.discrete.BinarySolution">
  111. <em class="property">class </em><code class="sig-prename descclassname">macop.solutions.discrete.</code><code class="sig-name descname">BinarySolution</code><span class="sig-paren">(</span><em class="sig-param">data</em>, <em class="sig-param">size</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/macop/solutions/discrete.html#BinarySolution"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.solutions.discrete.BinarySolution" title="Permalink to this definition">¶</a></dt>
  112. <dd><p>Binary integer solution class</p>
  113. <ul class="simple">
  114. <li><p>store solution as a binary array (example: [0, 1, 0, 1, 1])</p></li>
  115. <li><p>associated size is the size of the array</p></li>
  116. <li><p>mainly use for selecting or not an element in a list of valuable objects</p></li>
  117. </ul>
  118. <dl class="attribute">
  119. <dt id="macop.solutions.discrete.BinarySolution.data">
  120. <code class="sig-name descname">data</code><a class="headerlink" href="#macop.solutions.discrete.BinarySolution.data" title="Permalink to this definition">¶</a></dt>
  121. <dd><p>{ndarray} – array of binary values</p>
  122. </dd></dl>
  123. <dl class="attribute">
  124. <dt id="macop.solutions.discrete.BinarySolution.size">
  125. <code class="sig-name descname">size</code><a class="headerlink" href="#macop.solutions.discrete.BinarySolution.size" title="Permalink to this definition">¶</a></dt>
  126. <dd><p>{int} – size of binary array values</p>
  127. </dd></dl>
  128. <dl class="attribute">
  129. <dt id="macop.solutions.discrete.BinarySolution.score">
  130. <code class="sig-name descname">score</code><a class="headerlink" href="#macop.solutions.discrete.BinarySolution.score" title="Permalink to this definition">¶</a></dt>
  131. <dd><p>{float} – fitness score value</p>
  132. </dd></dl>
  133. <dl class="method">
  134. <dt id="macop.solutions.discrete.BinarySolution.random">
  135. <em class="property">static </em><code class="sig-name descname">random</code><span class="sig-paren">(</span><em class="sig-param">size</em>, <em class="sig-param">validator=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/macop/solutions/discrete.html#BinarySolution.random"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.solutions.discrete.BinarySolution.random" title="Permalink to this definition">¶</a></dt>
  136. <dd><p>Intialize binary array with use of validator to generate valid random solution</p>
  137. <dl class="field-list simple">
  138. <dt class="field-odd">Parameters</dt>
  139. <dd class="field-odd"><ul class="simple">
  140. <li><p><strong>size</strong> – {int} – expected solution size to generate</p></li>
  141. <li><p><strong>validator</strong> – {function} – specific function which validates or not a solution (if None, not validation is applied)</p></li>
  142. </ul>
  143. </dd>
  144. <dt class="field-even">Returns</dt>
  145. <dd class="field-even"><p>{BinarySolution} – new generated binary solution</p>
  146. </dd>
  147. </dl>
  148. <p>Example:</p>
  149. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><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>
  150. <span class="gp">&gt;&gt;&gt; </span><span class="n">validator</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">solution</span><span class="p">:</span> <span class="kc">True</span> <span class="k">if</span> <span class="nb">sum</span><span class="p">(</span><span class="n">solution</span><span class="o">.</span><span class="n">_data</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">5</span> <span class="k">else</span> <span class="kc">False</span>
  151. <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">10</span><span class="p">,</span> <span class="n">validator</span><span class="p">)</span>
  152. <span class="gp">&gt;&gt;&gt; </span><span class="nb">sum</span><span class="p">(</span><span class="n">solution</span><span class="o">.</span><span class="n">_data</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">5</span>
  153. <span class="go">True</span>
  154. </pre></div>
  155. </div>
  156. </dd></dl>
  157. </dd></dl>
  158. <dl class="class">
  159. <dt id="macop.solutions.discrete.CombinatoryIntegerSolution">
  160. <em class="property">class </em><code class="sig-prename descclassname">macop.solutions.discrete.</code><code class="sig-name descname">CombinatoryIntegerSolution</code><span class="sig-paren">(</span><em class="sig-param">data</em>, <em class="sig-param">size</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/macop/solutions/discrete.html#CombinatoryIntegerSolution"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.solutions.discrete.CombinatoryIntegerSolution" title="Permalink to this definition">¶</a></dt>
  161. <dd><p>Combinatory integer solution class</p>
  162. <ul class="simple">
  163. <li><p>store solution as a binary array (example: [0, 1, 0, 1, 1])</p></li>
  164. <li><p>associated size is the size of the array</p></li>
  165. <li><p>mainly use for selecting or not an element in a list of valuable objects</p></li>
  166. </ul>
  167. <dl class="attribute">
  168. <dt id="macop.solutions.discrete.CombinatoryIntegerSolution.data">
  169. <code class="sig-name descname">data</code><a class="headerlink" href="#macop.solutions.discrete.CombinatoryIntegerSolution.data" title="Permalink to this definition">¶</a></dt>
  170. <dd><p>{ndarray} – array of integer values</p>
  171. </dd></dl>
  172. <dl class="attribute">
  173. <dt id="macop.solutions.discrete.CombinatoryIntegerSolution.size">
  174. <code class="sig-name descname">size</code><a class="headerlink" href="#macop.solutions.discrete.CombinatoryIntegerSolution.size" title="Permalink to this definition">¶</a></dt>
  175. <dd><p>{int} – size of integer array values</p>
  176. </dd></dl>
  177. <dl class="attribute">
  178. <dt id="macop.solutions.discrete.CombinatoryIntegerSolution.score">
  179. <code class="sig-name descname">score</code><a class="headerlink" href="#macop.solutions.discrete.CombinatoryIntegerSolution.score" title="Permalink to this definition">¶</a></dt>
  180. <dd><p>{float} – fitness score value</p>
  181. </dd></dl>
  182. <dl class="method">
  183. <dt id="macop.solutions.discrete.CombinatoryIntegerSolution.random">
  184. <em class="property">static </em><code class="sig-name descname">random</code><span class="sig-paren">(</span><em class="sig-param">size</em>, <em class="sig-param">validator=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/macop/solutions/discrete.html#CombinatoryIntegerSolution.random"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.solutions.discrete.CombinatoryIntegerSolution.random" title="Permalink to this definition">¶</a></dt>
  185. <dd><p>Intialize combinatory integer array with use of validator to generate valid random solution</p>
  186. <dl class="field-list simple">
  187. <dt class="field-odd">Parameters</dt>
  188. <dd class="field-odd"><ul class="simple">
  189. <li><p><strong>size</strong> – {int} – expected solution size to generate</p></li>
  190. <li><p><strong>validator</strong> – {function} – specific function which validates or not a solution (if None, not validation is applied)</p></li>
  191. </ul>
  192. </dd>
  193. <dt class="field-even">Returns</dt>
  194. <dd class="field-even"><p>{CombinatoryIntegerSolution} – new generated combinatory integer solution</p>
  195. </dd>
  196. </dl>
  197. <p>Example:</p>
  198. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><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">CombinatoryIntegerSolution</span>
  199. <span class="gp">&gt;&gt;&gt; </span><span class="n">validator</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">solution</span><span class="p">:</span> <span class="kc">True</span> <span class="k">if</span> <span class="nb">sum</span><span class="p">(</span><span class="n">solution</span><span class="o">.</span><span class="n">_data</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">5</span> <span class="k">else</span> <span class="kc">False</span>
  200. <span class="gp">&gt;&gt;&gt; </span><span class="n">solution</span> <span class="o">=</span> <span class="n">CombinatoryIntegerSolution</span><span class="o">.</span><span class="n">random</span><span class="p">(</span><span class="mi">5</span><span class="p">,</span> <span class="n">validator</span><span class="p">)</span>
  201. <span class="gp">&gt;&gt;&gt; </span><span class="nb">sum</span><span class="p">(</span><span class="n">solution</span><span class="o">.</span><span class="n">_data</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">5</span>
  202. <span class="go">True</span>
  203. </pre></div>
  204. </div>
  205. </dd></dl>
  206. </dd></dl>
  207. <dl class="class">
  208. <dt id="macop.solutions.discrete.IntegerSolution">
  209. <em class="property">class </em><code class="sig-prename descclassname">macop.solutions.discrete.</code><code class="sig-name descname">IntegerSolution</code><span class="sig-paren">(</span><em class="sig-param">data</em>, <em class="sig-param">size</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/macop/solutions/discrete.html#IntegerSolution"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.solutions.discrete.IntegerSolution" title="Permalink to this definition">¶</a></dt>
  210. <dd><p>Integer solution class</p>
  211. <dl class="attribute">
  212. <dt id="macop.solutions.discrete.IntegerSolution.data">
  213. <code class="sig-name descname">data</code><a class="headerlink" href="#macop.solutions.discrete.IntegerSolution.data" title="Permalink to this definition">¶</a></dt>
  214. <dd><p>{ndarray} – array of binary values</p>
  215. </dd></dl>
  216. <dl class="attribute">
  217. <dt id="macop.solutions.discrete.IntegerSolution.size">
  218. <code class="sig-name descname">size</code><a class="headerlink" href="#macop.solutions.discrete.IntegerSolution.size" title="Permalink to this definition">¶</a></dt>
  219. <dd><p>{int} – size of binary array values</p>
  220. </dd></dl>
  221. <dl class="attribute">
  222. <dt id="macop.solutions.discrete.IntegerSolution.score">
  223. <code class="sig-name descname">score</code><a class="headerlink" href="#macop.solutions.discrete.IntegerSolution.score" title="Permalink to this definition">¶</a></dt>
  224. <dd><p>{float} – fitness score value</p>
  225. </dd></dl>
  226. <dl class="method">
  227. <dt id="macop.solutions.discrete.IntegerSolution.random">
  228. <em class="property">static </em><code class="sig-name descname">random</code><span class="sig-paren">(</span><em class="sig-param">size</em>, <em class="sig-param">validator=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/macop/solutions/discrete.html#IntegerSolution.random"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.solutions.discrete.IntegerSolution.random" title="Permalink to this definition">¶</a></dt>
  229. <dd><p>Intialize integer array with use of validator to generate valid random solution</p>
  230. <dl class="field-list simple">
  231. <dt class="field-odd">Parameters</dt>
  232. <dd class="field-odd"><ul class="simple">
  233. <li><p><strong>size</strong> – {int} – expected solution size to generate</p></li>
  234. <li><p><strong>validator</strong> – {function} – specific function which validates or not a solution (if None, not validation is applied)</p></li>
  235. </ul>
  236. </dd>
  237. <dt class="field-even">Returns</dt>
  238. <dd class="field-even"><p>{IntegerSolution} – new generated integer solution</p>
  239. </dd>
  240. </dl>
  241. <p>Example:</p>
  242. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><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">IntegerSolution</span>
  243. <span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
  244. <span class="gp">&gt;&gt;&gt; </span><span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">seed</span><span class="p">(</span><span class="mi">42</span><span class="p">)</span>
  245. <span class="gp">&gt;&gt;&gt; </span><span class="n">validator</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">solution</span><span class="p">:</span> <span class="kc">True</span> <span class="k">if</span> <span class="nb">sum</span><span class="p">(</span><span class="n">solution</span><span class="o">.</span><span class="n">_data</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">5</span> <span class="k">else</span> <span class="kc">False</span>
  246. <span class="gp">&gt;&gt;&gt; </span><span class="n">solution</span> <span class="o">=</span> <span class="n">IntegerSolution</span><span class="o">.</span><span class="n">random</span><span class="p">(</span><span class="mi">5</span><span class="p">,</span> <span class="n">validator</span><span class="p">)</span>
  247. <span class="gp">&gt;&gt;&gt; </span><span class="nb">sum</span><span class="p">(</span><span class="n">solution</span><span class="o">.</span><span class="n">_data</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">10</span>
  248. <span class="go">True</span>
  249. </pre></div>
  250. </div>
  251. </dd></dl>
  252. </dd></dl>
  253. </div>
  254. </div>
  255. </div>
  256. <footer>
  257. <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
  258. <a href="macop.solutions.continuous.html" class="btn btn-neutral float-right" title="macop.solutions.continuous" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
  259. <a href="macop.solutions.base.html" class="btn btn-neutral float-left" title="macop.solutions.base" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
  260. </div>
  261. <hr/>
  262. <div role="contentinfo">
  263. <p>
  264. &copy; Copyright 2020, Jérôme BUISINE
  265. </p>
  266. </div>
  267. 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>.
  268. </footer>
  269. </div>
  270. </div>
  271. </section>
  272. </div>
  273. <script type="text/javascript">
  274. jQuery(function () {
  275. SphinxRtdTheme.Navigation.enable(true);
  276. });
  277. </script>
  278. </body>
  279. </html>