You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by ps...@apache.org on 2004/03/21 23:39:56 UTC

cvs commit: jakarta-commons/math/src/java/org/apache/commons/math/stat BivariateRegression.java

psteitz     2004/03/21 14:39:56

  Modified:    math/src/java/org/apache/commons/math/stat
                        BivariateRegression.java
  Log:
  Javadoc
  
  Revision  Changes    Path
  1.15      +11 -7     jakarta-commons/math/src/java/org/apache/commons/math/stat/BivariateRegression.java
  
  Index: BivariateRegression.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/math/src/java/org/apache/commons/math/stat/BivariateRegression.java,v
  retrieving revision 1.14
  retrieving revision 1.15
  diff -u -r1.14 -r1.15
  --- BivariateRegression.java	21 Feb 2004 21:35:15 -0000	1.14
  +++ BivariateRegression.java	21 Mar 2004 22:39:56 -0000	1.15
  @@ -117,9 +117,12 @@
        * <code>data</code>.
        * <p>
        * <code>(data[0][0],data[0][1])</code> will be the first observation, then
  -     * <code>(data[1][0],data[1][1])</code>, etc. <p> 
  -     * 
  -     * This method does not replace data that has already been added.  
  +     * <code>(data[1][0],data[1][1])</code>, etc. 
  +     * <p> 
  +     * This method does not replace data that has already been added.  The
  +     * observations represented by <code>data</code> are added to the existing
  +     * dataset.
  +     * <p> 
        * To replace all data, use <code>clear()</code> before adding the new 
        * data.
        * 
  @@ -154,7 +157,8 @@
   
       /**
        * Returns the "predicted" <code>y</code> value associated with the 
  -     * supplied <code>x</code> value.
  +     * supplied <code>x</code> value,  based on the data that has been
  +     * added to the model when this method is activated.
        * <p>
        * <code> predict(x) = intercept + slope * x </code>
        * <p>
  @@ -264,7 +268,7 @@
        * <strong>Preconditions</strong>: <ul>
        * <li>At least two observations (with at least two different x values)
        * must have been added before invoking this method. If this method is 
  -     * invoked before a model can be estimated, <code>Double,NaN</code> is
  +     * invoked before a model can be estimated, <code>Double.NaN</code> is
        * returned.
        * </li></ul>
        *
  @@ -292,7 +296,7 @@
       }
   
       /**
  -     * Returns <a href="http://www.stt.msu.edu/~xiaoyimi/STT200/Lecture5.pdf">
  +     * Returns <a href="http://mathworld.wolfram.com/CorrelationCoefficient.html">
        * Pearson's product moment correlation coefficient</a>,
        * usually denoted r. 
        * <p>
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org