Prise3D
/
Thesis-OptimizationModules


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322
							

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>macop.solutions.base &mdash; macop v1.0.5 documentation</title>
  

  <script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
  
    
      <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
        <script type="text/javascript" src="../_static/jquery.js"></script>
        <script type="text/javascript" src="../_static/underscore.js"></script>
        <script type="text/javascript" src="../_static/doctools.js"></script>
        <script type="text/javascript" src="../_static/language_data.js"></script>
    
    <script type="text/javascript" src="../_static/js/theme.js"></script>

    
  <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  <link rel="stylesheet" href="../_static/css/custom.css" type="text/css" />
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="macop.solutions.discrete" href="macop.solutions.discrete.html" />
    <link rel="prev" title="macop.policies.reinforcement" href="macop.policies.reinforcement.html" /> 
</head>

<body class="wy-body-for-nav">

   
  <div class="wy-grid-for-nav">
    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >
          

            <a href="../index.html" class="icon icon-home"> macop
          

          </a>

          
              <div class="version">
                1.0.5
              </div>
            
          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
              <p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../description.html">Description</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../api.html#macop">macop</a></li>
<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-algorithms">macop.algorithms</a></li>
<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-callbacks">macop.callbacks</a></li>
<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-evaluators">macop.evaluators</a></li>
<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-operators">macop.operators</a></li>
<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-policies">macop.policies</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="../api.html#macop-solution">macop.solution</a><ul class="current">
<li class="toctree-l3 current"><a class="current reference internal" href="#">macop.solutions.base</a></li>
<li class="toctree-l3"><a class="reference internal" href="macop.solutions.discrete.html">macop.solutions.discrete</a></li>
<li class="toctree-l3"><a class="reference internal" href="macop.solutions.continuous.html">macop.solutions.continuous</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../api.html#macop-utils">macop.utils</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../documentations/index.html">Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../examples.html">Some examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
</ul>

            
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../index.html">macop</a>
        
      </nav>


      <div class="wy-nav-content">
        
        <div class="rst-content">
        
          
<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="../index.html">Docs</a> &raquo;</li>
        
          <li><a href="../api.html">API</a> &raquo;</li>
        
      <li>macop.solutions.base</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
              <a href="https://github.com/prise-3d/macop/blob/master/docs/source/macop/macop.solutions.base.rst" class="fa fa-github"> Edit on GitHub</a>
            
          
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="module-macop.solutions.base">
<span id="macop-solutions-base"></span><h1>macop.solutions.base<a class="headerlink" href="#module-macop.solutions.base" title="Permalink to this headline">¶</a></h1>
<p>Abstract solution class</p>
<p class="rubric">Classes</p>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#macop.solutions.base.Solution" title="macop.solutions.base.Solution"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Solution</span></code></a>(data, size)</p></td>
<td><p>Base abstract solution class structure</p></td>
</tr>
</tbody>
</table>
<dl class="class">
<dt id="macop.solutions.base.Solution">
<em class="property">class </em><code class="sig-prename descclassname">macop.solutions.base.</code><code class="sig-name descname">Solution</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/base.html#Solution"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.solutions.base.Solution" title="Permalink to this definition">¶</a></dt>
<dd><p>Base abstract solution class structure</p>
<ul class="simple">
<li><p>stores solution data representation into <cite>data</cite> attribute</p></li>
<li><p>get size (shape) of specific data representation</p></li>
<li><p>stores the score of the solution</p></li>
</ul>
<dl class="method">
<dt id="macop.solutions.base.Solution.clone">
<code class="sig-name descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/macop/solutions/base.html#Solution.clone"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.solutions.base.Solution.clone" title="Permalink to this definition">¶</a></dt>
<dd><p>Clone the current solution and its data, but without keeping evaluated <cite>_score</cite></p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>{Solution} – clone of current solution</p>
</dd>
</dl>
</dd></dl>

<dl class="method">
<dt id="macop.solutions.base.Solution.evaluate">
<code class="sig-name descname">evaluate</code><span class="sig-paren">(</span><em class="sig-param">evaluator</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/macop/solutions/base.html#Solution.evaluate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.solutions.base.Solution.evaluate" title="Permalink to this definition">¶</a></dt>
<dd><p>Evaluate solution using specific <cite>evaluator</cite></p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>_evaluator</strong> – {function} – specific function which computes fitness of solution</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>{float} – fitness score value</p>
</dd>
</dl>
</dd></dl>

<dl class="method">
<dt id="macop.solutions.base.Solution.fitness">
<code class="sig-name descname">fitness</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/macop/solutions/base.html#Solution.fitness"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.solutions.base.Solution.fitness" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns fitness score</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>{float} – fitness score value</p>
</dd>
</dl>
</dd></dl>

<dl class="method">
<dt id="macop.solutions.base.Solution.isValid">
<code class="sig-name descname">isValid</code><span class="sig-paren">(</span><em class="sig-param">validator</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/macop/solutions/base.html#Solution.isValid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.solutions.base.Solution.isValid" title="Permalink to this definition">¶</a></dt>
<dd><p>Use of custom method which validates if solution is valid or not</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>validator</strong> – {function} – specific function which validates or not a solution</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>{bool} – <cite>True</cite> is solution is valid</p>
</dd>
</dl>
</dd></dl>

<dl class="method">
<dt id="macop.solutions.base.Solution.random">
<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/base.html#Solution.random"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#macop.solutions.base.Solution.random" title="Permalink to this definition">¶</a></dt>
<dd><p>Initialize solution using random data with validator</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>size</strong> – {int} – expected solution size to generate</p></li>
<li><p><strong>validator</strong> – {function} – specific function which validates or not a solution (if None, not validation is applied)</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>{Solution} – generated solution</p>
</dd>
</dl>
</dd></dl>

</dd></dl>

</div>


           </div>
           
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="macop.solutions.discrete.html" class="btn btn-neutral float-right" title="macop.solutions.discrete" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="macop.policies.reinforcement.html" class="btn btn-neutral float-left" title="macop.policies.reinforcement" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2020, Jérôme BUISINE

    </p>
  </div>
  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>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  

  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

  
</body>
</html>