Apache
/
commons-math
mirror of https://github.com/apache/commons-math.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

improved javadoc according to Phil's changes in the implementation class 

added the missing getGeometricMean method

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/math/trunk@620289 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Luc Maisonobe 2008-02-10 16:25:34 +00:00
parent 9e0d00dc7e
commit 513804d9d4
1 changed files with 48 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
src/java/org/apache/commons/math/stat/descriptive/StatisticalMultivariateSummary.java
View File

@ -30,10 +30,12 @@ public interface StatisticalMultivariateSummary {
* @return The dimension of the data
*/
public int getDimension();
/**
* Returns the <a href="http://www.xycoon.com/arithmetic_mean.htm">
* arithmetic mean </a> of the available values
* @return The mean or null if no values have been added.
/**
* Returns an array whose ith entry is the mean of the
* ith entries of the arrays that have been added using
* {@link #addValue(double[])}
*
* @return the array of component means
*/
public abstract double[] getMean();
/**
@ -42,21 +44,29 @@ public interface StatisticalMultivariateSummary {
* or a zeroed matrix for a single value set.
*/
public abstract RealMatrix getCovariance();
/**
* Returns the standard deviation of the available values.
* @return The standard deviation, null if no values have been added
* or a zeroed array for a single value set.
/**
* Returns an array whose ith entry is the standard deviation of the
* ith entries of the arrays that have been added using
* {@link #addValue(double[])}
*
* @return the array of component standard deviations
*/
public abstract double[] getStandardDeviation();
/**
* Returns the maximum of the available values
* @return The max or null if no values have been added.
/**
* Returns an array whose ith entry is the maximum of the
* ith entries of the arrays that have been added using
* {@link #addValue(double[])}
*
* @return the array of component maxima
*/
public abstract double[] getMax();
/**
* Returns the minimum of the available values
* @return The min or null if no values have been added.
*/
/**
* Returns an array whose ith entry is the minimum of the
* ith entries of the arrays that have been added using
* {@link #addValue(double[])}
*
* @return the array of component minima
*/
public abstract double[] getMin();
/**
* Returns the number of available values
@ -64,18 +74,35 @@ public interface StatisticalMultivariateSummary {
*/
public abstract long getN();
/**
* Returns the sum of the values that have been added.
* @return The sum or null if no values have been added
* Returns an array whose ith entry is the geometric mean of the
* ith entries of the arrays that have been added using
* {@link #addValue(double[])}
*
* @return the array of component geometric means
*/
public double[] getGeometricMean();
/**
* Returns an array whose ith entry is the sum of the
* ith entries of the arrays that have been added using
* {@link #addValue(double[])}
*
* @return the array of component sums
*/
public abstract double[] getSum();
/**
* Returns the sum of the squares of the values that have been added.
* @return The sum or null if no values have been added
* Returns an array whose ith entry is the sum of squares of the
* ith entries of the arrays that have been added using
* {@link #addValue(double[])}
*
* @return the array of component sums of squares
*/
public abstract double[] getSumSq();
/**
* Returns the sum of the logarithms of the values that have been added.
* @return The sum or null if no values have been added
* Returns an array whose ith entry is the sum of logs of the
* ith entries of the arrays that have been added using
* {@link #addValue(double[])}
*
* @return the array of component log sums
*/
public abstract double[] getSumLog();
}