<!DOCTYPE html>

<html>
<head>
<meta charset="UTF-8">

<title>class NEAT::Controller::NeatSettings - rubyneat 0.3.4</title>

<link href="../../fonts.css" rel="stylesheet">
<link href="../../rdoc.css" rel="stylesheet">

<script type="text/javascript">
  var rdoc_rel_prefix = "../../";
</script>

<script src="../../js/jquery.js"></script>
<script src="../../js/navigation.js"></script>
<script src="../../js/search_index.js"></script>
<script src="../../js/search.js"></script>
<script src="../../js/searcher.js"></script>
<script src="../../js/darkfish.js"></script>


<body id="top" role="document" class="class">
<nav role="navigation">
  <div id="project-navigation">
    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
  <h2>
    <a href="../../index.html" rel="home">Home</a>
  </h2>

  <div id="table-of-contents-navigation">
    <a href="../../table_of_contents.html#pages">Pages</a>
    <a href="../../table_of_contents.html#classes">Classes</a>
    <a href="../../table_of_contents.html#methods">Methods</a>
  </div>
</div>

    <div id="search-section" role="search" class="project-section initially-hidden">
  <form action="#" method="get" accept-charset="utf-8">
    <div id="search-field-wrapper">
      <input id="search-field" role="combobox" aria-label="Search"
             aria-autocomplete="list" aria-controls="search-results"
             type="text" name="search" placeholder="Search" spellcheck="false"
             title="Type to search, Up and Down to navigate, Enter to load">
    </div>

    <ul id="search-results" aria-label="Search Results"
        aria-busy="false" aria-expanded="false"
        aria-atomic="false" class="initially-hidden"></ul>
  </form>
</div>

  </div>

  

  <div id="class-metadata">
    
    <div id="parent-class-section" class="nav-section">
  <h3>Parent</h3>

  
  <p class="link"><a href="../NeatOb.html">NEAT::NeatOb</a>
  
</div>

    
    
    <!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
  <h3>Methods</h3>

  <ul class="link-list" role="directory">
    
    <li class="calls-super" ><a href="#method-c-new">::new</a>
    
  </ul>
</div>

  </div>
</nav>

<main role="main" aria-labelledby="class-NEAT::Controller::NeatSettings">
  <h1 id="class-NEAT::Controller::NeatSettings" class="class">
    class NEAT::Controller::NeatSettings
  </h1>

  <section class="description">
    
<p>Various parameters affecting evolution. Based somewhat on the C version of
<a href="../../NEAT.html">NEAT</a>. TODO not all of these parameters are
implemented yet!!!</p>

  </section>

  
  
  
  <section id="5Buntitled-5D" class="documentation-section">
    

    

    

    
    <section class="attribute-method-details" class="method-section">
      <header>
        <h3>Attributes</h3>
      </header>

      
      <div id="attribute-i-age_significance" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">age_significance</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        <p>based on the C version of <a href="../../NEAT.html">NEAT</a></p>
        
        </div>
      </div>
      
      <div id="attribute-i-babies_stolen" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">babies_stolen</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        
        
        </div>
      </div>
      
      <div id="attribute-i-compatibility_threshold" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">compatibility_threshold</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        <p>Species compatability threshold</p>
        
        </div>
      </div>
      
      <div id="attribute-i-disjoint_coefficient" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">disjoint_coefficient</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        <p>Speciation coffficient</p>
        
        </div>
      </div>
      
      <div id="attribute-i-dropoff_age" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">dropoff_age</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        <p>Species Peality age for not making progress</p>
        
        </div>
      </div>
      
      <div id="attribute-i-end_sequence_at" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">end_sequence_at</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        
        
        </div>
      </div>
      
      <div id="attribute-i-evolved_substrate_switch" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">evolved_substrate_switch</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        <p>Enable Evolved Substrate HyperNEAT. Meaningless unless <a
href="NeatSettings.html#attribute-i-hyper_switch">#hyper_switch</a> is also
enabled.</p>
        
        </div>
      </div>
      
      <div id="attribute-i-excess_coefficient" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">excess_coefficient</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        <p>Speciation coffficient</p>
        
        </div>
      </div>
      
      <div id="attribute-i-feature_selection_switch" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">feature_selection_switch</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        <p>Enable FS-NEAT</p>
        
        </div>
      </div>
      
      <div id="attribute-i-fitness_cost_per_gene" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">fitness_cost_per_gene</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        
        
        </div>
      </div>
      
      <div id="attribute-i-fitness_cost_per_neuron" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">fitness_cost_per_neuron</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        <p>fitness costs, if given, use in the computation of fitness AFTER the
overall fitness for the applied stimuli have been caclulated.</p>
        
        </div>
      </div>
      
      <div id="attribute-i-hash_on_fitness" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">hash_on_fitness</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        <p>Set to true to returned named parameters as hashes to the fitness function
(the default is to do ordered arrays)</p>
        
        </div>
      </div>
      
      <div id="attribute-i-hyper_switch" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">hyper_switch</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        <p>Enable HyperNEAT. This will result in the critters being interpreted as
CPPNs for substrate weights. Additional setup will be necessary.</p>
        
        </div>
      </div>
      
      <div id="attribute-i-interspecies_mate_rate" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">interspecies_mate_rate</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        <p>Ratio of mating are actually interspecies</p>
        
        </div>
      </div>
      
      <div id="attribute-i-linktrait_mutation_sig" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">linktrait_mutation_sig</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        
        
        </div>
      </div>
      
      <div id="attribute-i-mate_multipoint_avg_prob" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">mate_multipoint_avg_prob</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        
        
        </div>
      </div>
      
      <div id="attribute-i-mate_multipoint_prob" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">mate_multipoint_prob</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        
        
        </div>
      </div>
      
      <div id="attribute-i-mate_only_prob" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">mate_only_prob</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        
        
        </div>
      </div>
      
      <div id="attribute-i-mate_singlepoint_prob" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">mate_singlepoint_prob</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        
        
        </div>
      </div>
      
      <div id="attribute-i-max_generations" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">max_generations</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        <p>Maximum number of generations to run, if given.</p>
        
        </div>
      </div>
      
      <div id="attribute-i-max_population_history" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">max_population_history</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        <p>Maximun number of populations to maintain in the history buffer.</p>
        
        </div>
      </div>
      
      <div id="attribute-i-max_species" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">max_species</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        <p>Max target number of species (will result in the compatability_coeifficient
being adjusted automatically</p>
        
        </div>
      </div>
      
      <div id="attribute-i-mutate_add_gene_prob" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">mutate_add_gene_prob</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        
        
        </div>
      </div>
      
      <div id="attribute-i-mutate_add_neuron_prob" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">mutate_add_neuron_prob</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        
        
        </div>
      </div>
      
      <div id="attribute-i-mutate_change_gene_weights_prob" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">mutate_change_gene_weights_prob</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        <p>For gene weights perturbations and changes (complete overwrites)</p>
        
        </div>
      </div>
      
      <div id="attribute-i-mutate_change_gene_weights_sd" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">mutate_change_gene_weights_sd</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        <p>For gene weights perturbations and changes (complete overwrites)</p>
        
        </div>
      </div>
      
      <div id="attribute-i-mutate_gene_disable_prob" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">mutate_gene_disable_prob</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        
        
        </div>
      </div>
      
      <div id="attribute-i-mutate_gene_reenable_prob" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">mutate_gene_reenable_prob</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        
        
        </div>
      </div>
      
      <div id="attribute-i-mutate_gene_trait_prob" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">mutate_gene_trait_prob</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        
        
        </div>
      </div>
      
      <div id="attribute-i-mutate_neuron_trait_prob" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">mutate_neuron_trait_prob</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        
        
        </div>
      </div>
      
      <div id="attribute-i-mutate_only_prob" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">mutate_only_prob</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        
        
        </div>
      </div>
      
      <div id="attribute-i-mutate_perturb_gene_weights_prob" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">mutate_perturb_gene_weights_prob</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        <p>For gene weights perturbations and changes (complete overwrites)</p>
        
        </div>
      </div>
      
      <div id="attribute-i-mutate_perturb_gene_weights_sd" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">mutate_perturb_gene_weights_sd</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        <p>For gene weights perturbations and changes (complete overwrites)</p>
        
        </div>
      </div>
      
      <div id="attribute-i-mutate_random_trait_prob" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">mutate_random_trait_prob</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        
        
        </div>
      </div>
      
      <div id="attribute-i-mutate_toggle_enable_prob" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">mutate_toggle_enable_prob</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        
        
        </div>
      </div>
      
      <div id="attribute-i-mutdiff_coefficient" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">mutdiff_coefficient</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        
        
        </div>
      </div>
      
      <div id="attribute-i-neuron_trait_mut_sig" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">neuron_trait_mut_sig</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        
        
        </div>
      </div>
      
      <div id="attribute-i-newlink_tries" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">newlink_tries</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        
        
        </div>
      </div>
      
      <div id="attribute-i-population_size" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">population_size</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        <p>If set, will start off at the specified size and  grow to the bigger
population size</p>
        
        </div>
      </div>
      
      <div id="attribute-i-print_every" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">print_every</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        
        
        </div>
      </div>
      
      <div id="attribute-i-real_time_switch" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">real_time_switch</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        <p>Enable RT-NEAT, for gradual evolution suitable for games and other
human-interactive systems.</p>
        
        </div>
      </div>
      
      <div id="attribute-i-recur_only_prob" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">recur_only_prob</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        
        
        </div>
      </div>
      
      <div id="attribute-i-recur_prob" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">recur_prob</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        
        
        </div>
      </div>
      
      <div id="attribute-i-recurrency_switch" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">recurrency_switch</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        <p>If true, allow for recurrent networks.</p>
        
        </div>
      </div>
      
      <div id="attribute-i-smallest_species" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">smallest_species</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        <p>Species smallest population allowed (coalse smaller species into one)</p>
        
        </div>
      </div>
      
      <div id="attribute-i-start_population_size" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">start_population_size</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        <p>If set, will start off at the specified size and  grow to the bigger
population size</p>
        
        </div>
      </div>
      
      <div id="attribute-i-start_sequence_at" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">start_sequence_at</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        
        
        </div>
      </div>
      
      <div id="attribute-i-survival_mininum_per_species" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">survival_mininum_per_species</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        
        
        </div>
      </div>
      
      <div id="attribute-i-survival_threshold" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">survival_threshold</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        <p>factor (0 to 1) of the top percentage of the species that&#39;s allowed to
mate.</p>
        
        </div>
      </div>
      
      <div id="attribute-i-trait_mutation_power" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">trait_mutation_power</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        
        
        </div>
      </div>
      
      <div id="attribute-i-trait_param_mut_prob" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">trait_param_mut_prob</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        
        
        </div>
      </div>
      
      <div id="attribute-i-weigh_mut_power" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">weigh_mut_power</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        
        
        </div>
      </div>
      
      <div id="attribute-i-weight_coefficient" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">weight_coefficient</span><span
            class="attribute-access-type">[RW]</span>
        </div>

        <div class="method-description">
        
        <p>Speciation coffficient</p>
        
        </div>
      </div>
      
    </section>
    

    
     <section id="public-class-5Buntitled-5D-method-details" class="method-section">
       <header>
         <h3>Public Class Methods</h3>
       </header>

    
      <div id="method-c-new" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">new</span><span
            class="method-args">()</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          <p>Set up defaults for mandatory entries.</p>
          
          
            <div class="method-calls-super">
              Calls superclass method
              <a href="../NeatOb.html#method-c-new">NEAT::NeatOb.new</a>
            </div>
          

          
          <div class="method-source-code" id="new-source">
            <pre><span class="ruby-comment"># File lib/rubyneat/rubyneat.rb, line 318</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>
  <span class="ruby-keyword">super</span>
  <span class="ruby-ivar">@start_sequence_at</span> = <span class="ruby-value">0</span>
  <span class="ruby-ivar">@end_sequence_at</span> = <span class="ruby-value">100</span>
  <span class="ruby-ivar">@max_generations</span> = <span class="ruby-value">1000</span>

  <span class="ruby-comment"># Default operators</span>
  <span class="ruby-ivar">@evaluator</span> = <span class="ruby-constant">Evaluator</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword">self</span>
  <span class="ruby-ivar">@expressor</span> = <span class="ruby-constant">Expressor</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword">self</span>
  <span class="ruby-ivar">@evolver</span> = <span class="ruby-constant">Evolver</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword">self</span>
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

        

        
      </div>

    
    </section>
  
  </section>
</main>


<footer id="validator-badges" role="contentinfo">
  <p><a href="http://validator.w3.org/check/referer">Validate</a>
  <p>Generated by <a href="http://rdoc.rubyforge.org">RDoc</a> 4.1.1.
  <p>Based on <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>