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

Fixed javadoc errors introduced in r1003512 (post 2.2 release). JIRA: MATH-587

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/math/trunk@1134948 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Phil Steitz 2011-06-12 17:19:49 +00:00
parent 61c5342b50
commit 72858b8447
5 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/main/java/org/apache/commons/math/distribution/AbstractIntegerDistribution.java
View File

@ -51,7 +51,7 @@ public abstract class AbstractIntegerDistribution extends AbstractDistribution
/**
* 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 AbstractIntegerDistribution extends AbstractDistribution
/**
* 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 AbstractIntegerDistribution extends AbstractDistribution
/**
* 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.
*

2
src/main/java/org/apache/commons/math/distribution/BinomialDistributionImpl.java
View File

@ -100,7 +100,7 @@ public class BinomialDistributionImpl extends AbstractIntegerDistribution
}
/**
* 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.

2
src/main/java/org/apache/commons/math/distribution/HypergeometricDistributionImpl.java
View File

@ -87,7 +87,7 @@ public class HypergeometricDistributionImpl extends AbstractIntegerDistribution
}
/**
* 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.

8
src/main/java/org/apache/commons/math/distribution/IntegerDistribution.java
View File

@ -37,7 +37,7 @@ public interface IntegerDistribution extends DiscreteDistribution {
/**
* 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 extends DiscreteDistribution {
/**
* 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 extends DiscreteDistribution {
/**
* 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 extends DiscreteDistribution {
* 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.

6
src/main/java/org/apache/commons/math/distribution/PascalDistributionImpl.java
View File

@ -100,7 +100,7 @@ public class PascalDistributionImpl extends AbstractIntegerDistribution
}
/**
* 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 extends AbstractIntegerDistribution
/**
* 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}.