macop.evaluators.discrete.mono.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286
  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.evaluators.discrete.mono &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.evaluators.discrete.multi" href="macop.evaluators.discrete.multi.html" />
  21. <link rel="prev" title="macop.evaluators.base" href="macop.evaluators.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 current"><a class="reference internal" href="../api.html#macop-evaluators">macop.evaluators</a><ul class="current">
  50. <li class="toctree-l3"><a class="reference internal" href="macop.evaluators.base.html">macop.evaluators.base</a></li>
  51. <li class="toctree-l3 current"><a class="current reference internal" href="#">macop.evaluators.discrete.mono</a></li>
  52. <li class="toctree-l3"><a class="reference internal" href="macop.evaluators.discrete.multi.html">macop.evaluators.discrete.multi</a></li>
  53. </ul>
  54. </li>
  55. <li class="toctree-l2"><a class="reference internal" href="../api.html#macop-operators">macop.operators</a></li>
  56. <li class="toctree-l2"><a class="reference internal" href="../api.html#macop-policies">macop.policies</a></li>
  57. <li class="toctree-l2"><a class="reference internal" href="../api.html#macop-solution">macop.solution</a></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.evaluators.discrete.mono</li>
  80. <li class="wy-breadcrumbs-aside">
  81. <a href="https://github.com/prise-3d/macop/blob/master/docs/source/macop/macop.evaluators.discrete.mono.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.evaluators.discrete.mono">
  89. <span id="macop-evaluators-discrete-mono"></span><h1>macop.evaluators.discrete.mono<a class="headerlink" href="#module-macop.evaluators.discrete.mono" title="Permalink to this headline">¶</a></h1>
  90. <p>Knapsack evaluators classes</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.evaluators.discrete.mono.KnapsackEvaluator" title="macop.evaluators.discrete.mono.KnapsackEvaluator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">KnapsackEvaluator</span></code></a>(data)</p></td>
  99. <td><p>Knapsack evaluator class which enables to compute solution using specific <cite>_data</cite></p></td>
  100. </tr>
  101. </tbody>
  102. </table>
  103. <dl class="class">
  104. <dt id="macop.evaluators.discrete.mono.KnapsackEvaluator">
  105. <em class="property">class </em><code class="sig-prename descclassname">macop.evaluators.discrete.mono.</code><code class="sig-name descname">KnapsackEvaluator</code><span class="sig-paren">(</span><em class="sig-param">data</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/macop/evaluators/discrete/mono.html#KnapsackEvaluator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.evaluators.discrete.mono.KnapsackEvaluator" title="Permalink to this definition">¶</a></dt>
  106. <dd><p>Knapsack evaluator class which enables to compute solution using specific <cite>_data</cite></p>
  107. <ul class="simple">
  108. <li><p>stores into its <cite>_data</cite> dictionary attritute required measures when computing a knapsack solution</p></li>
  109. <li><p><cite>_data[‘worths’]</cite> stores knapsack objects worths information</p></li>
  110. <li><p><cite>compute</cite> method enables to compute and associate a score to a given knapsack solution</p></li>
  111. </ul>
  112. <p>Example:</p>
  113. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">random</span>
  114. <span class="gp">&gt;&gt;&gt; </span><span class="c1"># binary solution import</span>
  115. <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>
  116. <span class="gp">&gt;&gt;&gt; </span><span class="c1"># evaluator import</span>
  117. <span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">macop.evaluators.discrete.mono</span> <span class="kn">import</span> <span class="n">KnapsackEvaluator</span>
  118. <span class="gp">&gt;&gt;&gt; </span><span class="n">solution_data</span> <span class="o">=</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">0</span><span class="p">]</span>
  119. <span class="gp">&gt;&gt;&gt; </span><span class="n">size</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">solution_data</span><span class="p">)</span>
  120. <span class="gp">&gt;&gt;&gt; </span><span class="n">solution</span> <span class="o">=</span> <span class="n">BinarySolution</span><span class="p">(</span><span class="n">solution_data</span><span class="p">,</span> <span class="n">size</span><span class="p">)</span>
  121. <span class="gp">&gt;&gt;&gt; </span><span class="c1"># evaluator initialization (worths objects passed into data)</span>
  122. <span class="gp">&gt;&gt;&gt; </span><span class="n">worths</span> <span class="o">=</span> <span class="p">[</span> <span class="n">random</span><span class="o">.</span><span class="n">randint</span><span class="p">(</span><span class="mi">5</span><span class="p">,</span> <span class="mi">20</span><span class="p">)</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">size</span><span class="p">)</span> <span class="p">]</span>
  123. <span class="gp">&gt;&gt;&gt; </span><span class="n">evaluator</span> <span class="o">=</span> <span class="n">KnapsackEvaluator</span><span class="p">(</span><span class="n">data</span><span class="o">=</span><span class="p">{</span><span class="s1">&#39;worths&#39;</span><span class="p">:</span> <span class="n">worths</span><span class="p">})</span>
  124. <span class="gp">&gt;&gt;&gt; </span><span class="c1"># compute solution score</span>
  125. <span class="gp">&gt;&gt;&gt; </span><span class="n">evaluator</span><span class="o">.</span><span class="n">compute</span><span class="p">(</span><span class="n">solution</span><span class="p">)</span>
  126. <span class="go">40</span>
  127. </pre></div>
  128. </div>
  129. <dl class="method">
  130. <dt id="macop.evaluators.discrete.mono.KnapsackEvaluator.compute">
  131. <code class="sig-name descname">compute</code><span class="sig-paren">(</span><em class="sig-param">solution</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/macop/evaluators/discrete/mono.html#KnapsackEvaluator.compute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.evaluators.discrete.mono.KnapsackEvaluator.compute" title="Permalink to this definition">¶</a></dt>
  132. <dd><p>Apply the computation of fitness from solution</p>
  133. <dl class="field-list simple">
  134. <dt class="field-odd">Parameters</dt>
  135. <dd class="field-odd"><p><strong>solution</strong> – {Solution} – Solution instance</p>
  136. </dd>
  137. <dt class="field-even">Returns</dt>
  138. <dd class="field-even"><p>{float} – fitness score of solution</p>
  139. </dd>
  140. </dl>
  141. </dd></dl>
  142. </dd></dl>
  143. </div>
  144. </div>
  145. </div>
  146. <footer>
  147. <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
  148. <a href="macop.evaluators.discrete.multi.html" class="btn btn-neutral float-right" title="macop.evaluators.discrete.multi" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
  149. <a href="macop.evaluators.base.html" class="btn btn-neutral float-left" title="macop.evaluators.base" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
  150. </div>
  151. <hr/>
  152. <div role="contentinfo">
  153. <p>
  154. &copy; Copyright 2020, Jérôme BUISINE
  155. </p>
  156. </div>
  157. 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>.
  158. </footer>
  159. </div>
  160. </div>
  161. </section>
  162. </div>
  163. <script type="text/javascript">
  164. jQuery(function () {
  165. SphinxRtdTheme.Navigation.enable(true);
  166. });
  167. </script>
  168. </body>
  169. </html>