update documentation to version 2.0

.yardopts

@@ -3,4 +3,4 @@
 --default-return ""
 --title "FSelector Documentation"
 --no-private
---files README.md,LICENCE lib
+--files README.md,LICENSE lib

doc/Array.html

@@ -6,7 +6,7 @@
 <title>
   Class: Array
 
-    &mdash; Documentation by YARD 0.7.5
+    &mdash; FSelector Documentation
 
 </title>
 
@@ -138,6 +138,29 @@ <h2>
     <span class="summary_desc"><div class='inline'><p>average (mean).</p>
 </div></span>
 
+</li>
+
+
+        <li class="public ">
+  <span class="summary_signature">
+
+      <a href="#pearson_r-instance_method" title="#pearson_r (instance method)">- <strong>pearson_r</strong>(v) </a>
+
+
+
+  </span>
+
+
+
+
+
+
+
+
+    <span class="summary_desc"><div class='inline'><p>pearson&#39;s correlation coefficient
+two vectors must be of the same length.</p>
+</div></span>
+
 </li>
 
 
@@ -188,7 +211,7 @@ <h2>
         <li class="public ">
   <span class="summary_signature">
 
-      <a href="#to_scale-instance_method" title="#to_scale (instance method)">- (Object) <strong>to_scale</strong>(min = 0.0, max = 1.0) </a>
+      <a href="#to_scale-instance_method" title="#to_scale (instance method)">- <strong>to_scale</strong>(min = 0.0, max = 1.0) </a>
 
 
 
@@ -232,7 +255,7 @@ <h2>
         <li class="public ">
   <span class="summary_signature">
 
-      <a href="#to_zscore-instance_method" title="#to_zscore (instance method)">- (Object) <strong>to_zscore</strong> </a>
+      <a href="#to_zscore-instance_method" title="#to_zscore (instance method)">- <strong>to_zscore</strong> </a>
 
 
 
@@ -339,6 +362,71 @@ <h3>Returns:</h3>
     </td>
   </tr>
 </table>
+</div>
+
+      <div class="method_details ">
+  <p class="signature " id="pearson_r-instance_method">
+
+    - <strong>pearson_r</strong>(v) 
+
+
+
+</p><div class="docstring">
+  <div class="discussion">
+    <p>pearson&#39;s correlation coefficient
+two vectors must be of the same length</p>
+
+
+  </div>
+</div>
+<div class="tags">
+
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+77
+78
+79
+80
+81
+82
+83
+84
+85
+86
+87
+88
+89
+90
+91
+92</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/fselector/util.rb', line 77</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_pearson_r'>pearson_r</span><span class='lparen'>(</span><span class='id identifier rubyid_v'>v</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_sm'>sm</span><span class='comma'>,</span> <span class='id identifier rubyid_vm'>vm</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_ave'>ave</span><span class='comma'>,</span> <span class='id identifier rubyid_v'>v</span><span class='period'>.</span><span class='id identifier rubyid_ave'>ave</span>
+  <span class='id identifier rubyid_a'>a</span><span class='comma'>,</span> <span class='id identifier rubyid_b'>b</span><span class='comma'>,</span> <span class='id identifier rubyid_c'>c</span> <span class='op'>=</span> <span class='int'>00</span><span class='comma'>,</span> <span class='float'>0.0</span><span class='comma'>,</span> <span class='float'>0.0</span>
+
+  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_each_with_index'>each_with_index</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_s'>s</span><span class='comma'>,</span> <span class='id identifier rubyid_i'>i</span><span class='op'>|</span>
+    <span class='id identifier rubyid_a'>a</span> <span class='op'>+=</span> <span class='lparen'>(</span><span class='id identifier rubyid_s'>s</span><span class='op'>-</span><span class='id identifier rubyid_sm'>sm</span><span class='rparen'>)</span><span class='op'>*</span><span class='lparen'>(</span><span class='id identifier rubyid_v'>v</span><span class='lbracket'>[</span><span class='id identifier rubyid_i'>i</span><span class='rbracket'>]</span><span class='op'>-</span><span class='id identifier rubyid_vm'>vm</span><span class='rparen'>)</span>
+    <span class='id identifier rubyid_b'>b</span> <span class='op'>+=</span> <span class='lparen'>(</span><span class='id identifier rubyid_s'>s</span><span class='op'>-</span><span class='id identifier rubyid_sm'>sm</span><span class='rparen'>)</span><span class='op'>**</span><span class='int'>2</span>
+    <span class='id identifier rubyid_c'>c</span> <span class='op'>+=</span> <span class='lparen'>(</span><span class='id identifier rubyid_v'>v</span><span class='lbracket'>[</span><span class='id identifier rubyid_i'>i</span><span class='rbracket'>]</span><span class='op'>-</span><span class='id identifier rubyid_vm'>vm</span><span class='rparen'>)</span><span class='op'>**</span><span class='int'>2</span>
+  <span class='kw'>end</span>
+
+  <span class='kw'>if</span> <span class='id identifier rubyid_b'>b</span><span class='period'>.</span><span class='id identifier rubyid_zero?'>zero?</span> <span class='kw'>or</span> <span class='id identifier rubyid_c'>c</span><span class='period'>.</span><span class='id identifier rubyid_zero?'>zero?</span>
+    <span class='kw'>return</span> <span class='float'>0.0</span>
+  <span class='kw'>else</span>
+    <span class='kw'>return</span> <span class='id identifier rubyid_a'>a</span> <span class='op'>/</span> <span class='const'>Math</span><span class='period'>.</span><span class='id identifier rubyid_sqrt'>sqrt</span><span class='lparen'>(</span><span class='id identifier rubyid_b'>b</span><span class='rparen'>)</span> <span class='op'>/</span> <span class='const'>Math</span><span class='period'>.</span><span class='id identifier rubyid_sqrt'>sqrt</span><span class='lparen'>(</span><span class='id identifier rubyid_c'>c</span><span class='rparen'>)</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
 </div>
 
       <div class="method_details ">
@@ -454,7 +542,7 @@ <h3>Returns:</h3>
       <div class="method_details ">
   <p class="signature " id="to_scale-instance_method">
 
-    - (<tt>Object</tt>) <strong>to_scale</strong>(min = 0.0, max = 1.0) 
+    - <strong>to_scale</strong>(min = 0.0, max = 1.0) 
 
 
 
@@ -575,7 +663,7 @@ <h3>Returns:</h3>
       <div class="method_details ">
   <p class="signature " id="to_zscore-instance_method">
 
-    - (<tt>Object</tt>) <strong>to_zscore</strong> 
+    - <strong>to_zscore</strong> 
 
 
 
@@ -684,7 +772,7 @@ <h3>Returns:</h3>
 </div>
 
     <div id="footer">
-  Generated on Tue Feb 28 15:56:03 2012 by 
+  Generated on Mon Apr  2 15:37:30 2012 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.7.5 (ruby-1.9.3).
 </div>

doc/Discretilizer.html

@@ -6,7 +6,7 @@
 <title>
   Module: Discretilizer
 
-    &mdash; Documentation by YARD 0.7.5
+    &mdash; FSelector Documentation
 
 </title>
 
@@ -109,7 +109,7 @@ <h2>
         <li class="public ">
   <span class="summary_signature">
 
-      <a href="#discretize_chimerge%21-instance_method" title="#discretize_chimerge! (instance method)">- (Object) <strong>discretize_chimerge!</strong>(chisq) </a>
+      <a href="#discretize_by_chimerge%21-instance_method" title="#discretize_by_chimerge! (instance method)">- <strong>discretize_by_chimerge!</strong>(chisq) </a>
 
 
 
@@ -131,7 +131,7 @@ <h2>
         <li class="public ">
   <span class="summary_signature">
 
-      <a href="#discretize_equal_frequency%21-instance_method" title="#discretize_equal_frequency! (instance method)">- (Object) <strong>discretize_equal_frequency!</strong>(n_interval) </a>
+      <a href="#discretize_by_equal_frequency%21-instance_method" title="#discretize_by_equal_frequency! (instance method)">- <strong>discretize_by_equal_frequency!</strong>(n_interval) </a>
 
 
 
@@ -153,7 +153,7 @@ <h2>
         <li class="public ">
   <span class="summary_signature">
 
-      <a href="#discretize_equal_width%21-instance_method" title="#discretize_equal_width! (instance method)">- (Object) <strong>discretize_equal_width!</strong>(n_interval) </a>
+      <a href="#discretize_by_equal_width%21-instance_method" title="#discretize_by_equal_width! (instance method)">- <strong>discretize_by_equal_width!</strong>(n_interval) </a>
 
 
 
@@ -182,9 +182,9 @@ <h2>Instance Method Details</h2>
 
 
       <div class="method_details first">
-  <p class="signature first" id="discretize_chimerge!-instance_method">
+  <p class="signature first" id="discretize_by_chimerge!-instance_method">
 
-    - (<tt>Object</tt>) <strong>discretize_chimerge!</strong>(chisq) 
+    - <strong>discretize_by_chimerge!</strong>(chisq) 
 
 
 
@@ -341,7 +341,7 @@ <h3>Parameters:</h3>
     <td>
       <pre class="code"><span class="info file"># File 'lib/fselector/algo_continuous/discretizer.rb', line 87</span>
 
-<span class='kw'>def</span> <span class='id identifier rubyid_discretize_chimerge!'>discretize_chimerge!</span><span class='lparen'>(</span><span class='id identifier rubyid_chisq'>chisq</span><span class='rparen'>)</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_discretize_by_chimerge!'>discretize_by_chimerge!</span><span class='lparen'>(</span><span class='id identifier rubyid_chisq'>chisq</span><span class='rparen'>)</span>
   <span class='comment'># chisq = 4.60 # for iris::Sepal.Length
 </span>  <span class='comment'># for intialization
 </span>  <span class='id identifier rubyid_hzero'>hzero</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
@@ -441,9 +441,9 @@ <h3>Parameters:</h3>
 </div>
 
       <div class="method_details ">
-  <p class="signature " id="discretize_equal_frequency!-instance_method">
+  <p class="signature " id="discretize_by_equal_frequency!-instance_method">
 
-    - (<tt>Object</tt>) <strong>discretize_equal_frequency!</strong>(n_interval) 
+    - <strong>discretize_by_equal_frequency!</strong>(n_interval) 
 
 
 
@@ -518,7 +518,7 @@ <h3>Parameters:</h3>
     <td>
       <pre class="code"><span class="info file"># File 'lib/fselector/algo_continuous/discretizer.rb', line 42</span>
 
-<span class='kw'>def</span> <span class='id identifier rubyid_discretize_equal_frequency!'>discretize_equal_frequency!</span><span class='lparen'>(</span><span class='id identifier rubyid_n_interval'>n_interval</span><span class='rparen'>)</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_discretize_by_equal_frequency!'>discretize_by_equal_frequency!</span><span class='lparen'>(</span><span class='id identifier rubyid_n_interval'>n_interval</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_n_interval'>n_interval</span> <span class='op'>=</span> <span class='int'>1</span> <span class='kw'>if</span> <span class='id identifier rubyid_n_interval'>n_interval</span> <span class='op'>&lt;</span> <span class='int'>1</span> <span class='comment'># at least one interval
 </span>  
   <span class='comment'># first determine the boundaries
@@ -549,9 +549,9 @@ <h3>Parameters:</h3>
 </div>
 
       <div class="method_details ">
-  <p class="signature " id="discretize_equal_width!-instance_method">
+  <p class="signature " id="discretize_by_equal_width!-instance_method">
 
-    - (<tt>Object</tt>) <strong>discretize_equal_width!</strong>(n_interval) 
+    - <strong>discretize_by_equal_width!</strong>(n_interval) 
 
 
 
@@ -626,7 +626,7 @@ <h3>Parameters:</h3>
     <td>
       <pre class="code"><span class="info file"># File 'lib/fselector/algo_continuous/discretizer.rb', line 10</span>
 
-<span class='kw'>def</span> <span class='id identifier rubyid_discretize_equal_width!'>discretize_equal_width!</span><span class='lparen'>(</span><span class='id identifier rubyid_n_interval'>n_interval</span><span class='rparen'>)</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_discretize_by_equal_width!'>discretize_by_equal_width!</span><span class='lparen'>(</span><span class='id identifier rubyid_n_interval'>n_interval</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_n_interval'>n_interval</span> <span class='op'>=</span> <span class='int'>1</span> <span class='kw'>if</span> <span class='id identifier rubyid_n_interval'>n_interval</span> <span class='op'>&lt;</span> <span class='int'>1</span> <span class='comment'># at least one interval
 </span>  
   <span class='comment'># first determine min and max for each feature
@@ -661,7 +661,7 @@ <h3>Parameters:</h3>
 </div>
 
     <div id="footer">
-  Generated on Tue Feb 28 15:56:04 2012 by 
+  Generated on Mon Apr  2 15:37:32 2012 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.7.5 (ruby-1.9.3).
 </div>