This is an automated email from the ASF dual-hosted git repository.
aherbert pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-statistics.git
commit e50b70d897ed15b7eeaeb41a4b59af3cb9bd4f60
Author: aherbert <aherb...@apache.org>
AuthorDate: Wed Nov 30 11:59:45 2022 +0000
Javadoc link to Double NaN or infinity constants
---
.../commons/statistics/distribution/CauchyDistribution.java | 8 ++++----
.../commons/statistics/distribution/ContinuousDistribution.java | 4 ++--
.../commons/statistics/distribution/DiscreteDistribution.java | 8 ++++----
.../commons/statistics/distribution/ExponentialDistribution.java | 4 ++--
.../commons/statistics/distribution/GeometricDistribution.java | 2 +-
.../commons/statistics/distribution/LogNormalDistribution.java | 4 ++--
.../commons/statistics/distribution/PascalDistribution.java | 2 +-
.../commons/statistics/distribution/PoissonDistribution.java | 2 +-
.../commons/statistics/distribution/WeibullDistribution.java | 4 ++--
9 files changed, 19 insertions(+), 19 deletions(-)
diff --git
a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/CauchyDistribution.java
b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/CauchyDistribution.java
index 068a617..000bc14 100644
---
a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/CauchyDistribution.java
+++
b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/CauchyDistribution.java
@@ -120,8 +120,8 @@ public final class CauchyDistribution extends
AbstractContinuousDistribution {
/**
* {@inheritDoc}
*
- * <p>Returns {@code Double.NEGATIVE_INFINITY} when {@code p == 0}
- * and {@code Double.POSITIVE_INFINITY} when {@code p == 1}.
+ * <p>Returns {@link Double#NEGATIVE_INFINITY} when {@code p == 0}
+ * and {@link Double#POSITIVE_INFINITY} when {@code p == 1}.
*/
@Override
public double inverseCumulativeProbability(double p) {
@@ -137,8 +137,8 @@ public final class CauchyDistribution extends
AbstractContinuousDistribution {
/**
* {@inheritDoc}
*
- * <p>Returns {@code Double.NEGATIVE_INFINITY} when {@code p == 1}
- * and {@code Double.POSITIVE_INFINITY} when {@code p == 0}.
+ * <p>Returns {@link Double#NEGATIVE_INFINITY} when {@code p == 1}
+ * and {@link Double#POSITIVE_INFINITY} when {@code p == 0}.
*/
@Override
public double inverseSurvivalProbability(double p) {
diff --git
a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/ContinuousDistribution.java
b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/ContinuousDistribution.java
index 31583fb..d8b328f 100644
---
a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/ContinuousDistribution.java
+++
b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/ContinuousDistribution.java
@@ -28,8 +28,8 @@ public interface ContinuousDistribution {
* evaluated at the specified point {@code x}.
* In general, the PDF is the derivative of the {@link
#cumulativeProbability(double) CDF}.
* If the derivative does not exist at {@code x}, then an appropriate
- * replacement should be returned, e.g. {@code Double.POSITIVE_INFINITY},
- * {@code Double.NaN}, or the limit inferior or limit superior of the
+ * replacement should be returned, e.g. {@link Double#POSITIVE_INFINITY},
+ * {@link Double#NaN}, or the limit inferior or limit superior of the
* difference quotient.
*
* @param x Point at which the PDF is evaluated.
diff --git
a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/DiscreteDistribution.java
b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/DiscreteDistribution.java
index ebb23ef..815cb94 100644
---
a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/DiscreteDistribution.java
+++
b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/DiscreteDistribution.java
@@ -119,7 +119,7 @@ public interface DiscreteDistribution {
* \end{cases} \]
*
* <p>If the result exceeds the range of the data type {@code int},
- * then {@code Integer.MIN_VALUE} or {@code Integer.MAX_VALUE} is returned.
+ * then {@link Integer#MIN_VALUE} or {@link Integer#MAX_VALUE} is returned.
* In this case the result of {@link #cumulativeProbability(int)
cumulativeProbability(x)}
* called using the returned {@code p}-quantile may not compute the
original {@code p}.
*
@@ -141,7 +141,7 @@ public interface DiscreteDistribution {
* \end{cases} \]
*
* <p>If the result exceeds the range of the data type {@code int},
- * then {@code Integer.MIN_VALUE} or {@code Integer.MAX_VALUE} is returned.
+ * then {@link Integer#MIN_VALUE} or {@link Integer#MAX_VALUE} is returned.
* In this case the result of {@link #survivalProbability(int)
survivalProbability(x)}
* called using the returned {@code (1-p)}-quantile may not compute the
original {@code p}.
*
@@ -176,7 +176,7 @@ public interface DiscreteDistribution {
* This method must return the same value as
* {@code inverseCumulativeProbability(0)}, i.e.
* \( \inf \{ x \in \mathbb Z : P(X \le x) \gt 0 \} \).
- * By convention, {@code Integer.MIN_VALUE} should be substituted
+ * By convention, {@link Integer#MIN_VALUE} should be substituted
* for negative infinity.
*
* @return the lower bound of the support.
@@ -188,7 +188,7 @@ public interface DiscreteDistribution {
* This method must return the same value as
* {@code inverseCumulativeProbability(1)}, i.e.
* \( \inf \{ x \in \mathbb Z : P(X \le x) = 1 \} \).
- * By convention, {@code Integer.MAX_VALUE} should be substituted
+ * By convention, {@link Integer#MAX_VALUE} should be substituted
* for positive infinity.
*
* @return the upper bound of the support.
diff --git
a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/ExponentialDistribution.java
b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/ExponentialDistribution.java
index 945a5d5..4416b74 100644
---
a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/ExponentialDistribution.java
+++
b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/ExponentialDistribution.java
@@ -110,7 +110,7 @@ public final class ExponentialDistribution extends
AbstractContinuousDistributio
* {@inheritDoc}
*
* <p>Returns {@code 0} when {@code p == 0} and
- * {@code Double.POSITIVE_INFINITY} when {@code p == 1}.
+ * {@link Double#POSITIVE_INFINITY} when {@code p == 1}.
*/
@Override
public double inverseCumulativeProbability(double p) {
@@ -126,7 +126,7 @@ public final class ExponentialDistribution extends
AbstractContinuousDistributio
* {@inheritDoc}
*
* <p>Returns {@code 0} when {@code p == 1} and
- * {@code Double.POSITIVE_INFINITY} when {@code p == 0}.
+ * {@link Double#POSITIVE_INFINITY} when {@code p == 0}.
*/
@Override
public double inverseSurvivalProbability(double p) {
diff --git
a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/GeometricDistribution.java
b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/GeometricDistribution.java
index 882fd02..bbe53cd 100644
---
a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/GeometricDistribution.java
+++
b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/GeometricDistribution.java
@@ -245,7 +245,7 @@ public final class GeometricDistribution extends
AbstractDiscreteDistribution {
* <p>The upper bound of the support is positive infinity except for the
* probability parameter {@code p = 1.0}.
*
- * @return {@code Integer.MAX_VALUE} or 0.
+ * @return {@link Integer#MAX_VALUE} or 0.
*/
@Override
public int getSupportUpperBound() {
diff --git
a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/LogNormalDistribution.java
b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/LogNormalDistribution.java
index a3d5dfd..622e8f3 100644
---
a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/LogNormalDistribution.java
+++
b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/LogNormalDistribution.java
@@ -168,9 +168,9 @@ public final class LogNormalDistribution extends
AbstractContinuousDistribution
* <ul>
* <li>{@code 0} if {@code x <= 0},</li>
* <li>{@code 0} if {@code ln(x) - mu < 0} and {@code mu - ln(x) > 40 *
s}, as
- * in these cases the actual value is within {@code Double.MIN_VALUE} of 0,
+ * in these cases the actual value is within {@link Double#MIN_VALUE} of 0,
* <li>{@code 1} if {@code ln(x) - mu >= 0} and {@code ln(x) - mu > 40 *
s},
- * as in these cases the actual value is within {@code Double.MIN_VALUE} of
+ * as in these cases the actual value is within {@link Double#MIN_VALUE} of
* 1,</li>
* <li>{@code 0.5 + 0.5 * erf((ln(x) - mu) / (s * sqrt(2))} otherwise.</li>
* </ul>
diff --git
a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/PascalDistribution.java
b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/PascalDistribution.java
index 7b73b90..bd10d45 100644
---
a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/PascalDistribution.java
+++
b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/PascalDistribution.java
@@ -224,7 +224,7 @@ public final class PascalDistribution extends
AbstractDiscreteDistribution {
* <p>The upper bound of the support is positive infinity except for the
* probability parameter {@code p = 1.0}.
*
- * @return {@code Integer.MAX_VALUE} or 0.
+ * @return {@link Integer#MAX_VALUE} or 0.
*/
@Override
public int getSupportUpperBound() {
diff --git
a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/PoissonDistribution.java
b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/PoissonDistribution.java
index 1ad278c..eb64670 100644
---
a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/PoissonDistribution.java
+++
b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/PoissonDistribution.java
@@ -141,7 +141,7 @@ public final class PoissonDistribution extends
AbstractDiscreteDistribution {
*
* <p>The upper bound of the support is always positive infinity.
*
- * @return {@code Integer.MAX_VALUE}
+ * @return {@link Integer#MAX_VALUE}
*/
@Override
public int getSupportUpperBound() {
diff --git
a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/WeibullDistribution.java
b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/WeibullDistribution.java
index a66f18a..ac7dd88 100644
---
a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/WeibullDistribution.java
+++
b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/WeibullDistribution.java
@@ -201,7 +201,7 @@ public final class WeibullDistribution extends
AbstractContinuousDistribution {
* {@inheritDoc}
*
* <p>Returns {@code 0} when {@code p == 0} and
- * {@code Double.POSITIVE_INFINITY} when {@code p == 1}.
+ * {@link Double#POSITIVE_INFINITY} when {@code p == 1}.
*/
@Override
public double inverseCumulativeProbability(double p) {
@@ -218,7 +218,7 @@ public final class WeibullDistribution extends
AbstractContinuousDistribution {
* {@inheritDoc}
*
* <p>Returns {@code 0} when {@code p == 1} and
- * {@code Double.POSITIVE_INFINITY} when {@code p == 0}.
+ * {@link Double#POSITIVE_INFINITY} when {@code p == 0}.
*/
@Override
public double inverseSurvivalProbability(double p) {
