You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by tn...@apache.org on 2013/10/11 22:53:36 UTC
svn commit: r1531415 - in /commons/proper/math/trunk/src:
main/java/org/apache/commons/math3/stat/inference/BinomialTest.java
test/java/org/apache/commons/math3/stat/inference/BinomialTestTest.java
Author: tn
Date: Fri Oct 11 20:53:36 2013
New Revision: 1531415
URL: http://svn.apache.org/r1531415
Log:
Formatting.
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/stat/inference/BinomialTest.java
commons/proper/math/trunk/src/test/java/org/apache/commons/math3/stat/inference/BinomialTestTest.java
Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/stat/inference/BinomialTest.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/stat/inference/BinomialTest.java?rev=1531415&r1=1531414&r2=1531415&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/stat/inference/BinomialTest.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/stat/inference/BinomialTest.java Fri Oct 11 20:53:36 2013
@@ -26,11 +26,9 @@ import org.apache.commons.math3.exceptio
/**
* Implements binomial test statistics.
- *
* <p>
* Exact test for the statistical significance of deviations from a
* theoretically expected distribution of observations into two categories.
- * </p>
*
* @see <a href="http://en.wikipedia.org/wiki/Binomial_test">Binomial test (Wikipedia)</a>
* @version $Id$
@@ -39,18 +37,15 @@ import org.apache.commons.math3.exceptio
public class BinomialTest {
/**
- * Returns whether the null hypothesis can be rejected with the given
- * confidence level.
- *
+ * Returns whether the null hypothesis can be rejected with the given confidence level.
* <p>
* <strong>Preconditions</strong>:
* <ul>
* <li>Number of trials must be ≥ 0.</li>
* <li>Number of successes must be ≥ 0.</li>
* <li>Number of successes must be ≤ number of trials.</li>
- * <li>Probability must be ≥ 0 and ≤ 1.
+ * <li>Probability must be ≥ 0 and ≤ 1.</li>
* </ul>
- * </p>
*
* @param numberOfTrials number of trials performed
* @param numberOfSuccesses number of successes observed
@@ -58,55 +53,47 @@ public class BinomialTest {
* @param alternativeHypothesis type of hypothesis being evaluated (one- or two-sided)
* @param confidenceLevel confidence level of the test
* @return true if the null hypothesis can be rejected with confidence {@code confidenceLevel}
- * @throws NotPositiveException if {@code numberOfTrials} or {@code numberOfSuccesses}
- * is negative
+ * @throws NotPositiveException if {@code numberOfTrials} or {@code numberOfSuccesses} is negative
* @throws OutOfRangeException if {@code probability} is not between 0 and 1
- * @throws MathIllegalArgumentException if
- * {@code numberOfTrials} < {@code numberOfSuccesses} or if {@code alternateHypothesis}
- * is null.
+ * @throws MathIllegalArgumentException if {@code numberOfTrials} < {@code numberOfSuccesses} or
+ * if {@code alternateHypothesis} is null.
* @see AlternativeHypothesis
*/
public boolean binomialTest(int numberOfTrials, int numberOfSuccesses, double probability,
- AlternativeHypothesis alternativeHypothesis, double confidenceLevel) {
+ AlternativeHypothesis alternativeHypothesis, double confidenceLevel) {
double pValue = binomialTest(numberOfTrials, numberOfSuccesses, probability, alternativeHypothesis);
return pValue < 1 - confidenceLevel;
}
/**
- * Returns the <i>observed significance level</i>, or <a href=
- * "http://www.cas.lancs.ac.uk/glossary_v1.1/hyptest.html#pvalue">
- * p-value</a>, associated with a <a
- * href="http://en.wikipedia.org/wiki/Binomial_test"> Binomial test</a>.
+ * Returns the <i>observed significance level</i>, or
+ * <a href="http://www.cas.lancs.ac.uk/glossary_v1.1/hyptest.html#pvalue">p-value</a>,
+ * associated with a <a href="http://en.wikipedia.org/wiki/Binomial_test"> Binomial test</a>.
* <p>
- * The number returned is the smallest significance level at which one can
- * reject the null hypothesis. The form of the hypothesis depends on
- * {@code alternativeHypothesis}.
- * </p>
+ * The number returned is the smallest significance level at which one can reject the null hypothesis.
+ * The form of the hypothesis depends on {@code alternativeHypothesis}.
* <p>
* <strong>Preconditions</strong>:
* <ul>
* <li>Number of trials must be ≥ 0.</li>
* <li>Number of successes must be ≥ 0.</li>
* <li>Number of successes must be ≤ number of trials.</li>
- * <li>Probability must be ≥ 0 and ≤ 1.
+ * <li>Probability must be ≥ 0 and ≤ 1.</li>
* </ul>
- * </p>
*
* @param numberOfTrials number of trials performed
* @param numberOfSuccesses number of successes observed
* @param probability assumed probability of a single trial under the null hypothesis
* @param alternativeHypothesis type of hypothesis being evaluated (one- or two-sided)
* @return p-value
- * @throws NotPositiveException if {@code numberOfTrials} or {@code numberOfSuccesses}
- * is negative
+ * @throws NotPositiveException if {@code numberOfTrials} or {@code numberOfSuccesses} is negative
* @throws OutOfRangeException if {@code probability} is not between 0 and 1
- * @throws MathIllegalArgumentException if
- * {@code numberOfTrials} < {@code numberOfSuccesses} or if {@code alternateHypothesis}
- * is null.
+ * @throws MathIllegalArgumentException if {@code numberOfTrials} < {@code numberOfSuccesses} or
+ * if {@code alternateHypothesis} is null.
* @see AlternativeHypothesis
*/
public double binomialTest(int numberOfTrials, int numberOfSuccesses, double probability,
- AlternativeHypothesis alternativeHypothesis) {
+ AlternativeHypothesis alternativeHypothesis) {
if (numberOfTrials < 0) {
throw new NotPositiveException(numberOfTrials);
}
Modified: commons/proper/math/trunk/src/test/java/org/apache/commons/math3/stat/inference/BinomialTestTest.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/test/java/org/apache/commons/math3/stat/inference/BinomialTestTest.java?rev=1531415&r1=1531414&r2=1531415&view=diff
==============================================================================
--- commons/proper/math/trunk/src/test/java/org/apache/commons/math3/stat/inference/BinomialTestTest.java (original)
+++ commons/proper/math/trunk/src/test/java/org/apache/commons/math3/stat/inference/BinomialTestTest.java Fri Oct 11 20:53:36 2013
@@ -24,7 +24,6 @@ import org.junit.Test;
/**
* Test cases for the BinomialTest class.
*/
-
public class BinomialTestTest {
protected BinomialTest testStatistic = new BinomialTest();
@@ -64,7 +63,6 @@ public class BinomialTestTest {
} catch (MathIllegalArgumentException e) {
// expected exception;
}
-
}
@Test
@@ -79,6 +77,5 @@ public class BinomialTestTest {
Assert.assertFalse(testStatistic.binomialTest(trials, successes, probability, AlternativeHypothesis.TWO_SIDED, confidenceLevel99));
Assert.assertFalse(testStatistic.binomialTest(trials, successes, probability, AlternativeHypothesis.GREATER_THAN, confidenceLevel99));
Assert.assertFalse(testStatistic.binomialTest(trials, successes, probability, AlternativeHypothesis.LESS_THAN, confidenceLevel95));
-
}
}