<!DOCTYPE html PUBLIC “-//W3C//DTD XHTML 1.0 Transitional//EN”

"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns=“www.w3.org/1999/xhtml” xml:lang=“en” lang=“en”>

<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>

Class: NEAT::NeatOb

  &mdash; Documentation by YARD 0.8.7.3

</title>

<link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />

<link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />

<script type=“text/javascript” charset=“utf-8”>

hasFrames = window.top.frames.main ? true : false;
relpath = '../';
framesUrl = "../frames.html#!" + escape(window.location.href);

</script>

<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>

<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>

</head>
<body>
  <div id="header">
    <div id="menu">

  <a href="../_index.html">Index (N)</a> &raquo;
  <span class='title'><span class='object_link'><a href="../NEAT.html" title="NEAT (module)">NEAT</a></span></span>
   &raquo; 
  <span class="title">NeatOb</span>

<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>

</div>

  <div id="search">

<a class="full_list_link" id="class_list_link"
    href="../class_list.html">
  Class List
</a>

<a class="full_list_link" id="method_list_link"
    href="../method_list.html">
  Method List
</a>

<a class="full_list_link" id="file_list_link"
    href="../file_list.html">
  File List
</a>

</div>

  <div class="clear"></div>
</div>

<iframe id="search_frame"></iframe>

<div id="content"><h1>Class: NEAT::NeatOb

</h1>

<dl class=“box”>

<dt class="r1">Inherits:</dt>
<dd class="r1">
  <span class="inheritName">Object</span>

    <ul class="fullTree">
      <li>Object</li>

        <li class="next">NEAT::NeatOb</li>

    </ul>
    <a href="#" class="inheritanceTree">show all</a>

  </dd>

  <dt class="r2">Includes:</dt>
  <dd class="r2">DeepDive</dd>

<dt class="r1 last">Defined in:</dt>
<dd class="r1 last">lib/rubyneat/rubyneat.rb</dd>

</dl> <div class=“clear”></div>

<h2>Overview</h2><div class=“docstring”>

<div class="discussion">

<p>Basis of all NEAT objects</p>

</div>

</div> <div class=“tags”>

</div><div id=“subclasses”>

<h2>Direct Known Subclasses</h2>
<p class="children"><span class='object_link'><a href="Controller.html" title="NEAT::Controller (class)">Controller</a></span>, <span class='object_link'><a href="Controller/NeatSettings.html" title="NEAT::Controller::NeatSettings (class)">Controller::NeatSettings</a></span>, <span class='object_link'><a href="Critter.html" title="NEAT::Critter (class)">Critter</a></span>, <span class='object_link'><a href="Critter/Genotype.html" title="NEAT::Critter::Genotype (class)">Critter::Genotype</a></span>, <span class='object_link'><a href="Critter/Genotype/Gene.html" title="NEAT::Critter::Genotype::Gene (class)">Critter::Genotype::Gene</a></span>, <span class='object_link'><a href="Critter/Phenotype.html" title="NEAT::Critter::Phenotype (class)">Critter::Phenotype</a></span>, <span class='object_link'><a href="Evolver/CritterOp.html" title="NEAT::Evolver::CritterOp (class)">Evolver::CritterOp</a></span>, <span class='object_link'><a href="Graph/DependencyResolver.html" title="NEAT::Graph::DependencyResolver (class)">Graph::DependencyResolver</a></span>, <span class='object_link'><a href="Neuron.html" title="NEAT::Neuron (class)">Neuron</a></span>, <span class='object_link'><a href="Operator.html" title="NEAT::Operator (class)">Operator</a></span>, <span class='object_link'><a href="Population.html" title="NEAT::Population (class)">Population</a></span>, <span class='object_link'><a href="Trait.html" title="NEAT::Trait (class)">Trait</a></span></p>

</div>

<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
<ul class="summary">

    <li class="public ">
<span class="summary_signature">

    <a href="#controller-instance_method" title="#controller (instance method)">- (Object) <strong>controller</strong> </a>

</span>

    <span class="note title readonly">readonly</span>

  <span class="summary_desc"><div class='inline'>

<p>Who&#39;s your daddy?.</p> </div></span>

</li>

    <li class="public ">
<span class="summary_signature">

    <a href="#name-instance_method" title="#name (instance method)">- (Object) <strong>name</strong> </a>

</span>

    <span class="note title readonly">readonly</span>

  <span class="summary_desc"><div class='inline'>

<p>Designation of this particular object instance.</p> </div></span>

</li>

</ul>

  <h2>
    Class Method Summary
    <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
  </h2>

  <ul class="summary">

      <li class="public ">
<span class="summary_signature">

    <a href="#log-class_method" title="log (class method)">+ (Object) <strong>log</strong> </a>

</span>

  <span class="summary_desc"><div class='inline'></div></span>

</li>

  </ul>

  <h2>
    Instance Method Summary
    <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
  </h2>

  <ul class="summary">

      <li class="public ">
<span class="summary_signature">

    <a href="#initialize-instance_method" title="#initialize (instance method)">- (NeatOb) <strong>initialize</strong>(controller = nil, name = nil) </a>

</span>

  <span class="note title constructor">constructor</span>

  <span class="summary_desc"><div class='inline'>

<p>Initializer for all NEAT objects.</p> </div></span>

</li>

      <li class="public ">
<span class="summary_signature">

    <a href="#log-instance_method" title="#log (instance method)">- (Object) <strong>log</strong> </a>

</span>

  <span class="summary_desc"><div class='inline'></div></span>

</li>

      <li class="public ">
<span class="summary_signature">

    <a href="#to_s-instance_method" title="#to_s (instance method)">- (Object) <strong>to_s</strong> </a>

</span>

  <span class="summary_desc"><div class='inline'></div></span>

</li>

  </ul>

<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>

  <div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">

  - (<tt><span class='object_link'><a href="" title="NEAT::NeatOb (class)">NeatOb</a></span></tt>) <strong>initialize</strong>(controller = nil, name = nil)

</h3><div class=“docstring”>

<div class="discussion">

<p>Initializer for all NEAT objects. Requires that the controller object is specified for all classes with the exception of the Controller itself or the Controller&#39;s NeatSettings.</p>

</div>

</div> <div class=“tags”>

</div><table class=“source_code”>

<tr>
  <td>
    <pre class="lines">

99 100 101 102 103 104 105 106 107 108 109 110 111</pre>

</td>
<td>
  <pre class="code"><span class="info file"># File 'lib/rubyneat/rubyneat.rb', line 99</span>

<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_controller'>controller</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_name'>name</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>

<span class='ivar'>@name</span> <span class='op'>=</span> <span class='kw'>unless</span> <span class='id identifier rubyid_name'>name</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
          <span class='id identifier rubyid_name'>name</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span>
        <span class='kw'>else</span>
          <span class='const'>NEAT</span><span class='op'>::</span><span class='id identifier rubyid_random_name_generator'>random_name_generator</span>
        <span class='kw'>end</span>
<span class='kw'>unless</span> <span class='id identifier rubyid_controller'>controller</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
  <span class='ivar'>@controller</span> <span class='op'>=</span> <span class='id identifier rubyid_controller'>controller</span>
<span class='kw'>else</span>
  <span class='id identifier rubyid_raise'>raise</span> <span class='const'>NeatException</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Controller Needed!</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>unless</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Controller</span><span class='rparen'>)</span> <span class='kw'>or</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Controller</span><span class='op'>::</span><span class='const'>NeatSettings</span><span class='rparen'>)</span>
  <span class='ivar'>@controller</span> <span class='op'>=</span> <span class='kw'>self</span> <span class='kw'>unless</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>Controller</span><span class='op'>::</span><span class='const'>NeatSettings</span>
<span class='kw'>end</span>

<span class='kw'>end</span></pre>

  </td>
</tr>

</table> </div>

</div>

<div id="instance_attr_details" class="attr_details">
  <h2>Instance Attribute Details</h2>

    <span id=""></span>
    <div class="method_details first">
<h3 class="signature first" id="controller-instance_method">

  - (<tt>Object</tt>) <strong>controller</strong>  <span class="extras">(readonly)</span>

</h3><div class=“docstring”>

<div class="discussion">

<p>Who&#39;s your daddy?</p>

</div>

</div> <div class=“tags”>

</div><table class=“source_code”>

<tr>
  <td>
    <pre class="lines">

90 91 92</pre>

</td>
<td>
  <pre class="code"><span class="info file"># File 'lib/rubyneat/rubyneat.rb', line 90</span>

<span class='kw'>def</span> <span class='id identifier rubyid_controller'>controller</span>

<span class='ivar'>@controller</span>

<span class='kw'>end</span></pre>

  </td>
</tr>

</table> </div>

    <span id=""></span>
    <div class="method_details ">
<h3 class="signature " id="name-instance_method">

  - (<tt>Object</tt>) <strong>name</strong>  <span class="extras">(readonly)</span>

</h3><div class=“docstring”>

<div class="discussion">

<p>Designation of this particular object instance</p>

</div>

</div> <div class=“tags”>

</div><table class=“source_code”>

<tr>
  <td>
    <pre class="lines">

87 88 89</pre>

</td>
<td>
  <pre class="code"><span class="info file"># File 'lib/rubyneat/rubyneat.rb', line 87</span>

<span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>

<span class='ivar'>@name</span>

<span class='kw'>end</span></pre>

  </td>
</tr>

</table> </div>

</div>

<div id="class_method_details" class="method_details_list">
  <h2>Class Method Details</h2>

    <div class="method_details first">
<h3 class="signature first" id="log-class_method">

  + (<tt>Object</tt>) <strong>log</strong>

</h3><table class=“source_code”>

<tr>
  <td>
    <pre class="lines">

93</pre>

</td>
<td>
  <pre class="code"><span class="info file"># File 'lib/rubyneat/rubyneat.rb', line 93</span>

<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_log'>log</span> <span class='semicolon'>;</span> <span class='gvar'>$log</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>

  </td>
</tr>

</table> </div>

</div>

<div id="instance_method_details" class="method_details_list">
  <h2>Instance Method Details</h2>

    <div class="method_details first">
<h3 class="signature first" id="log-instance_method">

  - (<tt>Object</tt>) <strong>log</strong>

</h3><table class=“source_code”>

<tr>
  <td>
    <pre class="lines">

92</pre>

</td>
<td>
  <pre class="code"><span class="info file"># File 'lib/rubyneat/rubyneat.rb', line 92</span>

<span class='kw'>def</span> <span class='id identifier rubyid_log'>log</span> <span class='semicolon'>;</span> <span class='gvar'>$log</span> <span class='semicolon'>;</span> <span class='kw'>end</span></pre>

  </td>
</tr>

</table> </div>

    <div class="method_details ">
<h3 class="signature " id="to_s-instance_method">

  - (<tt>Object</tt>) <strong>to_s</strong>

</h3><table class=“source_code”>

<tr>
  <td>
    <pre class="lines">

113 114 115</pre>

</td>
<td>
  <pre class="code"><span class="info file"># File 'lib/rubyneat/rubyneat.rb', line 113</span>

<span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span>

<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>%s&lt;%s&gt;</span><span class='tstring_end'>&quot;</span></span> <span class='op'>%</span> <span class='lbracket'>[</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='comma'>,</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='rbracket'>]</span>

<span class='kw'>end</span></pre>

  </td>
</tr>

</table> </div>

</div>

</div>

  <div id="footer">
Generated on Sun Mar 16 16:36:52 2014 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.3 (ruby-2.1.1).

</div>

</body>

</html>