commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From pste...@apache.org
Subject cvs commit: jakarta-commons/math/src/java/org/apache/commons/math/stat/univariate/moment Variance.java
Date Wed, 01 Sep 2004 15:53:53 GMT
psteitz     2004/09/01 08:53:53

  Modified:    math/src/java/org/apache/commons/math/stat/univariate/moment
                        Variance.java
  Log:
  Javadoc. Made assumption about precomputed mean explicit.
  
  Revision  Changes    Path
  1.28      +11 -1     jakarta-commons/math/src/java/org/apache/commons/math/stat/univariate/moment/Variance.java
  
  Index: Variance.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/math/src/java/org/apache/commons/math/stat/univariate/moment/Variance.java,v
  retrieving revision 1.27
  retrieving revision 1.28
  diff -u -r1.27 -r1.28
  --- Variance.java	11 Jul 2004 23:39:08 -0000	1.27
  +++ Variance.java	1 Sep 2004 15:53:52 -0000	1.28
  @@ -176,6 +176,11 @@
        * <p>
        * See {@link Variance} for details on the computing algorithm.
        * <p>
  +     * The formula used assumes that the supplied mean value is the arithmetic
  +     * mean of the sample data, not a known population parameter.  This method
  +     * is supplied only to save computation when the mean has already been
  +     * computed.
  +     * <p>
        * Returns 0 for a single-value (i.e. length = 1) sample.
        * <p>
        * Throws <code>IllegalArgumentException</code> if the array is null.
  @@ -218,6 +223,11 @@
        * is empty.
        * <p>
        * See {@link Variance} for details on the computing algorithm.
  +     * <p>
  +     * The formula used assumes that the supplied mean value is the arithmetic
  +     * mean of the sample data, not a known population parameter.  This method
  +     * is supplied only to save computation when the mean has already been
  +     * computed.
        * <p>
        * Returns 0 for a single-value (i.e. length = 1) sample.
        * <p>
  
  
  

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


Mime
View raw message