Apache/commons-math
1
0
Fork 0
mirror of https://github.com/apache/commons-math.git synced 2025-02-19 00:20:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fixed exceptions for OneWayAnova interface and impl, removed never thrown MathException.

Browse Source 
JIRA: MATH-488 MATH-459

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/math/trunk@1240310 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Thomas Neidhart 2012-02-03 19:28:49 +00:00
parent ffc89e5baf
commit bd92c73009
2 changed files with 43 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
src/main/java/org/apache/commons/math/stat/inference/OneWayAnova.java
View File

@ -16,7 +16,10 @@
*/ */
package org.apache.commons.math.stat.inference; package org.apache.commons.math.stat.inference;
import org.apache.commons.math.MathException; import org.apache.commons.math.exception.DimensionMismatchException;
import org.apache.commons.math.exception.NullArgumentException;
import org.apache.commons.math.exception.OutOfRangeException;
import java.util.Collection; import java.util.Collection;
/** /**
@ -47,12 +50,13 @@ public interface OneWayAnova {
* @param categoryData <code>Collection</code> of <code>double[]</code> * @param categoryData <code>Collection</code> of <code>double[]</code>
* arrays each containing data for one category * arrays each containing data for one category
* @return Fvalue * @return Fvalue
* @throws IllegalArgumentException if the preconditions are not met * @throws NullArgumentException if <code>categoryData</code> is <code>null</code>
* @throws MathException if the statistic can not be computed do to a * @throws DimensionMismatchException if the length of the <code>categoryData</code>
* convergence or other numerical error. * array is less than 2 or a contained <code>double[]</code> array does not have
* at least two values
*/ */
double anovaFValue(Collection<double[]> categoryData) double anovaFValue(Collection<double[]> categoryData)
throws IllegalArgumentException, MathException; throws NullArgumentException, DimensionMismatchException;
/** /**
* Computes the ANOVA P-value for a collection of <code>double[]</code> * Computes the ANOVA P-value for a collection of <code>double[]</code>
@ -68,12 +72,13 @@ public interface OneWayAnova {
* @param categoryData <code>Collection</code> of <code>double[]</code> * @param categoryData <code>Collection</code> of <code>double[]</code>
* arrays each containing data for one category * arrays each containing data for one category
* @return Pvalue * @return Pvalue
* @throws IllegalArgumentException if the preconditions are not met * @throws NullArgumentException if <code>categoryData</code> is <code>null</code>
* @throws MathException if the statistic can not be computed do to a * @throws DimensionMismatchException if the length of the <code>categoryData</code>
* convergence or other numerical error. * array is less than 2 or a contained <code>double[]</code> array does not have
* at least two values
*/ */
double anovaPValue(Collection<double[]> categoryData) double anovaPValue(Collection<double[]> categoryData)
throws IllegalArgumentException, MathException; throws NullArgumentException, DimensionMismatchException;
/** /**
* Performs an ANOVA test, evaluating the null hypothesis that there * Performs an ANOVA test, evaluating the null hypothesis that there
@ -93,11 +98,13 @@ public interface OneWayAnova {
* @param alpha significance level of the test * @param alpha significance level of the test
* @return true if the null hypothesis can be rejected with * @return true if the null hypothesis can be rejected with
* confidence 1 - alpha * confidence 1 - alpha
* @throws IllegalArgumentException if the preconditions are not met * @throws NullArgumentException if <code>categoryData</code> is <code>null</code>
* @throws MathException if the statistic can not be computed do to a * @throws DimensionMismatchException if the length of the <code>categoryData</code>
* convergence or other numerical error. * array is less than 2 or a contained <code>double[]</code> array does not have
* at least two values
* @throws OutOfRangeException if <code>alpha</code> is not in the range (0, 0.5]
*/ */
boolean anovaTest(Collection<double[]> categoryData, double alpha) boolean anovaTest(Collection<double[]> categoryData, double alpha)
throws IllegalArgumentException, MathException; throws NullArgumentException, DimensionMismatchException, OutOfRangeException;
} }

41
src/main/java/org/apache/commons/math/stat/inference/OneWayAnovaImpl.java
View File

@ -18,9 +18,11 @@ package org.apache.commons.math.stat.inference;
import java.util.Collection; import java.util.Collection;
import org.apache.commons.math.MathException;
import org.apache.commons.math.MathRuntimeException;
import org.apache.commons.math.distribution.FDistribution; import org.apache.commons.math.distribution.FDistribution;
import org.apache.commons.math.exception.DimensionMismatchException;
import org.apache.commons.math.exception.MathIllegalArgumentException;
import org.apache.commons.math.exception.NullArgumentException;
import org.apache.commons.math.exception.OutOfRangeException;
import org.apache.commons.math.exception.util.LocalizedFormats; import org.apache.commons.math.exception.util.LocalizedFormats;
import org.apache.commons.math.stat.descriptive.summary.Sum; import org.apache.commons.math.stat.descriptive.summary.Sum;
import org.apache.commons.math.stat.descriptive.summary.SumOfSquares; import org.apache.commons.math.stat.descriptive.summary.SumOfSquares;
@ -65,7 +67,7 @@ public class OneWayAnovaImpl implements OneWayAnova {
* here</a></p> * here</a></p>
*/ */
public double anovaFValue(Collection<double[]> categoryData) public double anovaFValue(Collection<double[]> categoryData)
throws IllegalArgumentException, MathException { throws MathIllegalArgumentException {
AnovaStats a = anovaStats(categoryData); AnovaStats a = anovaStats(categoryData);
return a.F; return a.F;
} }
@ -81,7 +83,7 @@ public class OneWayAnovaImpl implements OneWayAnova {
* is the commons-math implementation of the F distribution.</p> * is the commons-math implementation of the F distribution.</p>
*/ */
public double anovaPValue(Collection<double[]> categoryData) public double anovaPValue(Collection<double[]> categoryData)
throws IllegalArgumentException, MathException { throws NullArgumentException, DimensionMismatchException {
AnovaStats a = anovaStats(categoryData); AnovaStats a = anovaStats(categoryData);
FDistribution fdist = new FDistribution(a.dfbg, a.dfwg); FDistribution fdist = new FDistribution(a.dfbg, a.dfwg);
return 1.0 - fdist.cumulativeProbability(a.F); return 1.0 - fdist.cumulativeProbability(a.F);
@ -99,11 +101,10 @@ public class OneWayAnovaImpl implements OneWayAnova {
* <p>True is returned iff the estimated p-value is less than alpha.</p> * <p>True is returned iff the estimated p-value is less than alpha.</p>
*/ */
public boolean anovaTest(Collection<double[]> categoryData, double alpha) public boolean anovaTest(Collection<double[]> categoryData, double alpha)
throws IllegalArgumentException, MathException { throws NullArgumentException, DimensionMismatchException, OutOfRangeException {
if ((alpha <= 0) || (alpha > 0.5)) { if ((alpha <= 0) || (alpha > 0.5)) {
throw MathRuntimeException.createIllegalArgumentException( throw new OutOfRangeException(LocalizedFormats.OUT_OF_BOUND_SIGNIFICANCE_LEVEL,
LocalizedFormats.OUT_OF_BOUND_SIGNIFICANCE_LEVEL, alpha, 0, 0.5);
alpha, 0, 0.5);
} }
return anovaPValue(categoryData) < alpha; return anovaPValue(categoryData) < alpha;
} }
@ -115,26 +116,30 @@ public class OneWayAnovaImpl implements OneWayAnova {
* @param categoryData <code>Collection</code> of <code>double[]</code> * @param categoryData <code>Collection</code> of <code>double[]</code>
* arrays each containing data for one category * arrays each containing data for one category
* @return computed AnovaStats * @return computed AnovaStats
* @throws IllegalArgumentException if categoryData does not meet * @throws NullArgumentException if <code>categoryData</code> is <code>null</code>
* preconditions specified in the interface definition * @throws DimensionMismatchException if the length of the <code>categoryData</code>
* @throws MathException if an error occurs computing the Anova stats * array is less than 2 or a contained <code>double[]</code> array does not contain
* at least two values
*/ */
private AnovaStats anovaStats(Collection<double[]> categoryData) private AnovaStats anovaStats(Collection<double[]> categoryData)
throws IllegalArgumentException, MathException { throws NullArgumentException, DimensionMismatchException {
if (categoryData == null) {
throw new NullArgumentException();
}
// check if we have enough categories // check if we have enough categories
if (categoryData.size() < 2) { if (categoryData.size() < 2) {
throw MathRuntimeException.createIllegalArgumentException( throw new DimensionMismatchException(LocalizedFormats.TWO_OR_MORE_CATEGORIES_REQUIRED,
LocalizedFormats.TWO_OR_MORE_CATEGORIES_REQUIRED, categoryData.size(), 2);
categoryData.size());
} }
// check if each category has enough data and all is double[] // check if each category has enough data and all is double[]
for (double[] array : categoryData) { for (double[] array : categoryData) {
if (array.length <= 1) { if (array.length <= 1) {
throw MathRuntimeException.createIllegalArgumentException( throw new DimensionMismatchException(
LocalizedFormats.TWO_OR_MORE_VALUES_IN_CATEGORY_REQUIRED, LocalizedFormats.TWO_OR_MORE_VALUES_IN_CATEGORY_REQUIRED,
array.length); array.length, 2);
} }
} }