Author: psteitz
Date: Sun Jun 12 17:19:49 2011
New Revision: 1134948
URL: http://svn.apache.org/viewvc?rev=1134948&view=rev
Log:
Fixed javadoc errors introduced in r1003512 (post 2.2 release). JIRA: MATH-587
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math/distribution/AbstractIntegerDistribution.java
commons/proper/math/trunk/src/main/java/org/apache/commons/math/distribution/BinomialDistributionImpl.java
commons/proper/math/trunk/src/main/java/org/apache/commons/math/distribution/HypergeometricDistributionImpl.java
commons/proper/math/trunk/src/main/java/org/apache/commons/math/distribution/IntegerDistribution.java
commons/proper/math/trunk/src/main/java/org/apache/commons/math/distribution/PascalDistributionImpl.java
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math/distribution/AbstractIntegerDistribution.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math/distribution/AbstractIntegerDistribution.java?rev=1134948&r1=1134947&r2=1134948&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math/distribution/AbstractIntegerDistribution.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math/distribution/AbstractIntegerDistribution.java
Sun Jun 12 17:19:49 2011
@@ -51,7 +51,7 @@ public abstract class AbstractIntegerDis
/**
* For a random variable {@code X} whose values are distributed according
- * to this distribution, this method returns {@code P(X < x)}. In other
+ * to this distribution, this method returns {@code P(X <= x)}. In other
* words, this method represents the (cumulative) distribution function,
* or CDF, for this distribution.
* If {@code x} does not represent an integer value, the CDF is
@@ -70,7 +70,7 @@ public abstract class AbstractIntegerDis
/**
* For a random variable {@code X} whose values are distributed
* according to this distribution, this method returns
- * {@code P(x0 < X < x1)}.
+ * {@code P(x0 <= X <= x1)}.
*
* @param x0 Inclusive lower bound.
* @param x1 Inclusive upper bound.
@@ -99,7 +99,7 @@ public abstract class AbstractIntegerDis
/**
* For a random variable {@code X} whose values are distributed according
- * to this distribution, this method returns {@code P(X < x)}. In other
+ * to this distribution, this method returns {@code P(X <= x)}. In other
* words, this method represents the probability distribution function,
* or PDF, for this distribution.
*
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math/distribution/BinomialDistributionImpl.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math/distribution/BinomialDistributionImpl.java?rev=1134948&r1=1134947&r2=1134948&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math/distribution/BinomialDistributionImpl.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math/distribution/BinomialDistributionImpl.java
Sun Jun 12 17:19:49 2011
@@ -100,7 +100,7 @@ public class BinomialDistributionImpl ex
}
/**
- * For this distribution, {@code X}, this method returns {@code P(X < x)}.
+ * For this distribution, {@code X}, this method returns {@code P(X <= x)}.
*
* @param x Value at which the PDF is evaluated.
* @return PDF for this distribution.
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math/distribution/HypergeometricDistributionImpl.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math/distribution/HypergeometricDistributionImpl.java?rev=1134948&r1=1134947&r2=1134948&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math/distribution/HypergeometricDistributionImpl.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math/distribution/HypergeometricDistributionImpl.java
Sun Jun 12 17:19:49 2011
@@ -87,7 +87,7 @@ public class HypergeometricDistributionI
}
/**
- * For this distribution, {@code X}, this method returns {@code P(X < x)}.
+ * For this distribution, {@code X}, this method returns {@code P(X <= x)}.
*
* @param x Value at which the PDF is evaluated.
* @return PDF for this distribution.
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math/distribution/IntegerDistribution.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math/distribution/IntegerDistribution.java?rev=1134948&r1=1134947&r2=1134948&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math/distribution/IntegerDistribution.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math/distribution/IntegerDistribution.java
Sun Jun 12 17:19:49 2011
@@ -37,7 +37,7 @@ public interface IntegerDistribution ext
/**
* For a random variable {@code X} whose values are distributed according
- * to this distribution, this method returns {@code P(X < x)}. In other
+ * to this distribution, this method returns {@code P(X <= x)}. In other
* words, this method represents the probability distribution function, or
* PDF for the distribution.
*
@@ -50,7 +50,7 @@ public interface IntegerDistribution ext
/**
* For this distribution, {@code X}, this method returns
- * {@code P(x0 < X < x1)}.
+ * {@code P(x0 <= X <= x1)}.
*
* @param x0 the inclusive, lower bound
* @param x1 the inclusive, upper bound
@@ -63,7 +63,7 @@ public interface IntegerDistribution ext
/**
* For this distribution, {@code X}, this method returns the largest
- * {@code x} such that {@code P(X < x) <= p}.
+ * {@code x} such that {@code P(X <= x) <= p}.
* <br/>
* Note that this definition implies:
* <ul>
@@ -73,7 +73,7 @@ public interface IntegerDistribution ext
* no such value {@code m}, {@code Integer.MIN_VALUE} is returned.
* </li>
* <li> If there is a maximum value, {@code M}, such that
- * {@code P(X < M) = 1}, then {@code M} is returned by
+ * {@code P(X <= M) = 1}, then {@code M} is returned by
* {@code inverseCumulativeProbability(1)}.
* If there is no such value, {@code M}, {@code Integer.MAX_VALUE} is
* returned.
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math/distribution/PascalDistributionImpl.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math/distribution/PascalDistributionImpl.java?rev=1134948&r1=1134947&r2=1134948&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math/distribution/PascalDistributionImpl.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math/distribution/PascalDistributionImpl.java
Sun Jun 12 17:19:49 2011
@@ -100,7 +100,7 @@ public class PascalDistributionImpl exte
}
/**
- * For this distribution, {@code X}, this method returns {@code P(X < x)}.
+ * For this distribution, {@code X}, this method returns {@code P(X <= x)}.
*
* @param x Value at which the PDF is evaluated.
* @return PDF for this distribution.
@@ -140,11 +140,11 @@ public class PascalDistributionImpl exte
/**
* For this distribution, {@code X}, this method returns the largest
- * {@code x}, such that {@code P(X < x) p}.
+ * {@code x}, such that {@code P(X <= x) <= p}.
* It will return -1 when p = 0 and {@code Integer.MAX_VALUE} when p = 1.
*
* @param p Desired probability.
- * @return the largest {@code x} such that {@code P(X < x) <= p}.
+ * @return the largest {@code x} such that {@code P(X <= x) <= p}.
* @throws MathException if the inverse cumulative probability can not be
* computed due to convergence or other numerical errors.
* @throws OutOfRangeException if {@code p < 0} or {@code p > 1}.
