Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > by-pkgid > 763d6289e1351f2d34257ce697a3ccb7 > files > 664

biopython-doc-1.47-2mdv2008.1.x86_64.rpm

<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>Bio.GA.Selection.RouletteWheel.RouletteWheelSelection</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="Bio-module.html">Package&nbsp;Bio</a> ::
        <a href="Bio.GA-module.html">Package&nbsp;GA</a> ::
        <a href="Bio.GA.Selection-module.html">Package&nbsp;Selection</a> ::
        <a href="Bio.GA.Selection.RouletteWheel-module.html">Module&nbsp;RouletteWheel</a> ::
        Class&nbsp;RouletteWheelSelection
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="Bio.GA.Selection.RouletteWheel.RouletteWheelSelection-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class RouletteWheelSelection</h1><p class="nomargin-top"><span class="codelink"><a href="Bio.GA.Selection.RouletteWheel-pysrc.html#RouletteWheelSelection">source&nbsp;code</a></span></p>
<pre class="base-tree">
<a href="Bio.GA.Selection.Abstract.AbstractSelection-class.html">Abstract.AbstractSelection</a> --+
                             |
                            <strong class="uidshort">RouletteWheelSelection</strong>
</pre>

<hr />
<p>Roulette wheel selection proportional to individuals fitness.</p>
  <p>The implements a roulette wheel selector that selects individuals from
  the population, and performs mutation and crossover on the selected 
  individuals.</p>

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="Bio.GA.Selection.RouletteWheel.RouletteWheelSelection-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">mutator</span>,
        <span class="summary-sig-arg">crossover</span>,
        <span class="summary-sig-arg">repairer</span>=<span class="summary-sig-default">None</span>)</span><br />
      Initialize the selector.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Bio.GA.Selection.RouletteWheel-pysrc.html#RouletteWheelSelection.__init__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="Bio.GA.Selection.RouletteWheel.RouletteWheelSelection-class.html#select" class="summary-sig-name">select</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">population</span>)</span><br />
      Perform selection on the population based using a Roulette model.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Bio.GA.Selection.RouletteWheel-pysrc.html#RouletteWheelSelection.select">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="Bio.GA.Selection.RouletteWheel.RouletteWheelSelection-class.html#_set_up_wheel" class="summary-sig-name" onclick="show_private();">_set_up_wheel</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">population</span>)</span><br />
      Set up the roulette wheel based on the fitnesses.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Bio.GA.Selection.RouletteWheel-pysrc.html#RouletteWheelSelection._set_up_wheel">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="Bio.GA.Selection.Abstract.AbstractSelection-class.html">Abstract.AbstractSelection</a></code></b>:
      <code><a href="Bio.GA.Selection.Abstract.AbstractSelection-class.html#mutate_and_crossover">mutate_and_crossover</a></code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">mutator</span>,
        <span class="sig-arg">crossover</span>,
        <span class="sig-arg">repairer</span>=<span class="sig-default">None</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="Bio.GA.Selection.RouletteWheel-pysrc.html#RouletteWheelSelection.__init__">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Initialize the selector.</p>
  <p>Arguments:</p>
  <p>o mutator -- A Mutation object which will perform mutation on an 
  individual.</p>
  <p>o crossover -- A Crossover object which will take two individuals and 
  produce two new individuals which may have had crossover occur.</p>
  <p>o repairer -- A class which can do repair on rearranged genomes to 
  eliminate infeasible individuals. If set at None, so repair will be 
  done.</p>
  <dl class="fields">
    <dt>Overrides:
        <a href="Bio.GA.Selection.Abstract.AbstractSelection-class.html#__init__">Abstract.AbstractSelection.__init__</a>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="select"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">select</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">population</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="Bio.GA.Selection.RouletteWheel-pysrc.html#RouletteWheelSelection.select">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Perform selection on the population based using a Roulette model.</p>
  <p>Arguments:</p>
  <p>o population -- A population of organisms on which we will perform 
  selection. The individuals are assumed to have fitness values which are 
  due to their current genome.</p>
  <dl class="fields">
    <dt>Overrides:
        <a href="Bio.GA.Selection.Abstract.AbstractSelection-class.html#select">Abstract.AbstractSelection.select</a>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="_set_up_wheel"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_set_up_wheel</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">population</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="Bio.GA.Selection.RouletteWheel-pysrc.html#RouletteWheelSelection._set_up_wheel">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Set up the roulette wheel based on the fitnesses.</p>
  <p>This creates a fitness proportional 'wheel' that will be used for 
  selecting based on random numbers.</p>
  <p>Returns:</p>
  <p>o A dictionary where the keys are the 'high' value that an individual 
  will be selected. The low value is determined by the previous key in a 
  sorted list of keys. For instance, if we have a sorted list of keys 
  like:</p>
  <p>[.1, .3, .7, 1]</p>
  <p>Then the individual whose key is .1 will be selected if a number 
  between 0 and .1 is chosen, the individual whose key is .3 will be 
  selected if the number is between .1 and .3, and so on.</p>
  <p>The values of the dictionary are the organism instances.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Mon Sep 15 09:26:34 2008
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>