Return-Path: Delivered-To: apmail-jakarta-commons-dev-archive@www.apache.org Received: (qmail 5263 invoked from network); 29 Feb 2004 21:25:17 -0000 Received: from daedalus.apache.org (HELO mail.apache.org) (208.185.179.12) by minotaur-2.apache.org with SMTP; 29 Feb 2004 21:25:17 -0000 Received: (qmail 67007 invoked by uid 500); 29 Feb 2004 21:24:59 -0000 Delivered-To: apmail-jakarta-commons-dev-archive@jakarta.apache.org Received: (qmail 66927 invoked by uid 500); 29 Feb 2004 21:24:59 -0000 Mailing-List: contact commons-dev-help@jakarta.apache.org; run by ezmlm Precedence: bulk List-Unsubscribe: List-Subscribe: List-Help: List-Post: List-Id: "Jakarta Commons Developers List" Reply-To: "Jakarta Commons Developers List" Delivered-To: mailing list commons-dev@jakarta.apache.org Received: (qmail 66853 invoked by uid 500); 29 Feb 2004 21:24:58 -0000 Received: (qmail 66759 invoked from network); 29 Feb 2004 21:24:58 -0000 Received: from unknown (HELO minotaur.apache.org) (209.237.227.194) by daedalus.apache.org with SMTP; 29 Feb 2004 21:24:58 -0000 Received: (qmail 5038 invoked by uid 1718); 29 Feb 2004 21:25:09 -0000 Date: 29 Feb 2004 21:25:09 -0000 Message-ID: <20040229212509.5037.qmail@minotaur.apache.org> From: psteitz@apache.org To: jakarta-commons-cvs@apache.org Subject: cvs commit: jakarta-commons/math/xdocs/userguide index.xml stat.xml X-Spam-Rating: daedalus.apache.org 1.6.2 0/1000/N X-Spam-Rating: minotaur-2.apache.org 1.6.2 0/1000/N psteitz 2004/02/29 13:25:09 Modified: math/xdocs/userguide index.xml stat.xml Log: Added more content to statistics and distributions user guide. Revision Changes Path 1.7 +2 -2 jakarta-commons/math/xdocs/userguide/index.xml Index: index.xml =================================================================== RCS file: /home/cvs/jakarta-commons/math/xdocs/userguide/index.xml,v retrieving revision 1.6 retrieving revision 1.7 diff -u -r1.6 -r1.7 --- index.xml 29 Feb 2004 18:50:10 -0000 1.6 +++ index.xml 29 Feb 2004 21:25:08 -0000 1.7 @@ -36,7 +36,7 @@
  • 0.5 Dependencies
  • -
  • 1. Statistics +
  • 1. Statistics and Distributions
    • 1.1 Overview
    • 1.2 Univariate statistics
    • 1.9 +63 -6 jakarta-commons/math/xdocs/userguide/stat.xml Index: stat.xml =================================================================== RCS file: /home/cvs/jakarta-commons/math/xdocs/userguide/stat.xml,v retrieving revision 1.8 retrieving revision 1.9 diff -u -r1.8 -r1.9 --- stat.xml 29 Feb 2004 18:50:10 -0000 1.8 +++ stat.xml 29 Feb 2004 21:25:08 -0000 1.9 @@ -23,14 +23,70 @@ The Commons Math User Guide - Statistics -
      +
      -

      This is yet to be written. Any contributions will be greatfully - accepted!

      +

      + The statistics and distributions packages provide frameworks and implementations for + basic univariate statistics, frequency distributions, bivariate regression, t- and chi-square test + statistics and some commonly used probability distributions. +

      -

      This is yet to be written. Any contributions will be gratefully - accepted!

      +

      + The stat package includes a framework and default implementations for the following univariate + statistics: +

        +
      • arithmetic and geometric means
      • +
      • variance and standard deviation
      • +
      • sum, product, log sum, sum of squared values
      • +
      • minimum, maximum, median, and percentiles
      • +
      • skewness and kurtosis
      • +
      • first, second, third and fourth moments
      • +
      +

      +

      + With the exception of percentiles and the median, all of these statistics can be computed without + maintaining the full list of input data values in memory. The stat package provides interfaces and + implementations that do not require value storage as well as implementations that operate on arrays + of stored values. +

      +

      + The top level interface is + + org.apache.commons.math.stat.univariate.UnivariateStatistic. This interface, implemented by + all statistics, consists of evaluate() methods that take double[] arrays as arguments and return + the value of the statistic. This interface is extended by + + org.apache.commons.math.stat.univariate.StorelessUnivariateStatistic, which adds increment(), + getResult() and associated methods to support "storageless" implementations that + maintain counters, sums or other state information as values are added using the increment() + method. +

      +

      + Abstract implementations of the top level interfaces are provided in + + org.apache.commons.math.stat.univariate.AbstractUnivariateStatistic and + + org.apache.commons.math.stat.univariate.AbstractStorelessUnivariateStatistic respectively. +

      +

      + Each statistic is implemented as a separate class, in one of the subpackages (moment, rank, summary) and + each extends one of the abstract classes above (depending on whether or not value storage is required to + compute the statistic). + There are several ways to instantiate and use statistics. Statistics can be instantiated and used directly, but it is + generally more convenient to access them using the provided aggregates: + + + + +
      AggregateStatistics IncludedValues stored?
      + org.apache.commons.math.stat.DescriptiveStatisticsAllYes
      + org.apache.commons.math.stat.SummaryStatisticsmin, max, mean, geometric mean, n, sum, sum of squares, standard deviation, varianceNo
      + TODO: add code sample + There is also a utility class, + org.apache.commons.math.stat.StatUtils, that provides static methods for computing statistics + from double[] arrays. +

      This is yet to be written. Any contributions will be gratefully @@ -73,6 +129,7 @@ FcreateFDistribution

      Numerator degrees of freedom
      Denominator degrees of freedom
      GammacreateGammaDistribution
      Alpha
      Beta
      HypergeometriccreateHypogeometricDistribution
      Population size
      Number of successes in population
      Sample size
      + Normal (Gaussian)createNormalDistribution
      Mean
      Standard Deviation
      tcreateTDistribution
      Degrees of freedom

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