forester/java/src/org/forester/util/DescriptiveStatistics.java

   1 // $Id:
   2 // FORESTER -- software libraries and applications
   3 // for evolutionary biology research and applications.
   4 //
   5 // Copyright (C) 2008-2009 Christian M. Zmasek
   6 // Copyright (C) 2008-2009 Burnham Institute for Medical Research
   7 // All rights reserved
   8 //
   9 // This library is free software; you can redistribute it and/or
  10 // modify it under the terms of the GNU Lesser General Public
  11 // License as published by the Free Software Foundation; either
  12 // version 2.1 of the License, or (at your option) any later version.
  13 //
  14 // This library is distributed in the hope that it will be useful,
  15 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17 // Lesser General Public License for more details.
  18 //
  19 // You should have received a copy of the GNU Lesser General Public
  20 // License along with this library; if not, write to the Free Software
  21 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  22 //
  23 // Contact: phylosoft @ gmail . com
  24 // WWW: www.phylosoft.org/forester
  25
  26 package org.forester.util;
  27
  28 import java.util.List;
  29
  30 public interface DescriptiveStatistics {
  31
  32     public final static String PLUS_MINUS = "" + ( char ) 177;
  33
  34     public abstract void addValue( final double d );
  35
  36     public abstract double arithmeticMean();
  37
  38     public abstract String asSummary();
  39
  40     /**
  41      * Computes the coefficient of variation. Used to express standard deviation
  42      * independent of units of measure.
  43      *
  44      * @return
  45      */
  46     public abstract double coefficientOfVariation();
  47
  48     public abstract double[] getDataAsDoubleArray();
  49
  50     public abstract List<Double> getData();
  51
  52     public abstract double getMax();
  53
  54     public abstract double getMin();
  55
  56     public abstract int getN();
  57
  58     public abstract double getSum();
  59
  60     public abstract String getSummaryAsString();
  61
  62     public abstract double getValue( final int index );
  63
  64     public abstract double median();
  65
  66     public abstract double midrange();
  67
  68     /**
  69      * Determines relationship between the mean and the median. This reflects
  70      * how the data differs from the normal bell shaped distribution.
  71      *
  72      * @return
  73      */
  74     public abstract double pearsonianSkewness();
  75
  76     public abstract double sampleStandardDeviation();
  77
  78     public abstract double sampleStandardUnit( final double value );
  79
  80     public abstract double sampleVariance();
  81
  82     public abstract double standardErrorOfMean();
  83
  84     public abstract double sumDeviations();
  85
  86     @Override
  87     public abstract String toString();
  88
  89     public abstract void setDescription( final String desc );
  90
  91     public abstract String getDescription();
  92 }