You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by ah...@apache.org on 2021/02/22 13:54:28 UTC
[commons-statistics] 04/08: Use
DistributionException.NOT_STRICTLY_POSITIVE constant
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 b851856430c3e69241a83f10509c1dbd42ac95f8
Author: aherbert <ah...@apache.org>
AuthorDate: Mon Feb 22 13:44:24 2021 +0000
Use DistributionException.NOT_STRICTLY_POSITIVE constant
Remove the use of NEGATIVE when the value cannot be zero, i.e x <= 0
---
.../statistics/distribution/CauchyDistribution.java | 2 +-
.../statistics/distribution/DistributionException.java | 14 +++++++-------
.../statistics/distribution/ExponentialDistribution.java | 2 +-
.../commons/statistics/distribution/FDistribution.java | 4 ++--
.../commons/statistics/distribution/GammaDistribution.java | 4 ++--
.../statistics/distribution/GumbelDistribution.java | 2 +-
.../distribution/HypergeometricDistribution.java | 2 +-
.../statistics/distribution/LaplaceDistribution.java | 2 +-
.../statistics/distribution/LogNormalDistribution.java | 2 +-
.../statistics/distribution/LogisticDistribution.java | 2 +-
.../statistics/distribution/NakagamiDistribution.java | 2 +-
.../statistics/distribution/NormalDistribution.java | 2 +-
.../statistics/distribution/ParetoDistribution.java | 4 ++--
.../statistics/distribution/PascalDistribution.java | 2 +-
.../statistics/distribution/PoissonDistribution.java | 2 +-
.../commons/statistics/distribution/TDistribution.java | 2 +-
.../statistics/distribution/WeibullDistribution.java | 4 ++--
.../commons/statistics/distribution/ZipfDistribution.java | 4 ++--
18 files changed, 29 insertions(+), 29 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 2967e62..1ef4ae1 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
@@ -35,7 +35,7 @@ public class CauchyDistribution extends AbstractContinuousDistribution {
public CauchyDistribution(double median,
double scale) {
if (scale <= 0) {
- throw new DistributionException(DistributionException.NEGATIVE, scale);
+ throw new DistributionException(DistributionException.NOT_STRICTLY_POSITIVE, scale);
}
this.scale = scale;
this.median = median;
diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/DistributionException.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/DistributionException.java
index bb8747e..4c56c36 100644
--- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/DistributionException.java
+++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/DistributionException.java
@@ -22,23 +22,23 @@ import java.util.Locale;
* Package private exception class with constants for frequently used messages.
*/
class DistributionException extends IllegalArgumentException {
- /** Error message for "too large" condition. */
+ /** Error message for "too large" condition when "x > y". */
static final String TOO_LARGE = "%s > %s";
- /** Error message for "too small" condition. */
+ /** Error message for "too small" condition when "x < y". */
static final String TOO_SMALL = "%s < %s";
- /** Error message for "out of range" condition. */
+ /** Error message for "out of range" condition when "x not in [a, b]". */
static final String OUT_OF_RANGE = "Number %s is out of range [%s, %s]";
/** Error message for "invalid range" condition when "lower >= upper". */
static final String INVALID_RANGE_LOW_GTE_HIGH = "Lower bound %s >= upper bound %s";
/** Error message for "invalid range" condition when "lower > upper". */
static final String INVALID_RANGE_LOW_GT_HIGH = "Lower bound %s > upper bound %s";
- /** Error message for "invalid probability" condition. */
+ /** Error message for "invalid probability" condition when "x not in [0, 1]". */
static final String INVALID_PROBABILITY = "Not a probability: %s is out of range [0, 1]";
- /** Error message for "out of range" condition. */
+ /** Error message for "negative" condition when "x < 0". */
static final String NEGATIVE = "Number %s is negative";
- /** Error message for "not strictly positive" condition. */
+ /** Error message for "not strictly positive" condition when "x <= 0". */
static final String NOT_STRICTLY_POSITIVE = "Number %s is not greater than 0";
- /** Error message for "mismatch" condition. */
+ /** Error message for "mismatch" condition when "x != y". */
static final String MISMATCH = "Expected %s but was %s";
/** Serializable version identifier. */
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 7013213..20e0d88 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
@@ -40,7 +40,7 @@ public class ExponentialDistribution extends AbstractContinuousDistribution {
*/
public ExponentialDistribution(double mean) {
if (mean <= 0) {
- throw new DistributionException(DistributionException.NEGATIVE, mean);
+ throw new DistributionException(DistributionException.NOT_STRICTLY_POSITIVE, mean);
}
this.mean = mean;
logMean = Math.log(mean);
diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/FDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/FDistribution.java
index d8044e7..b96511f 100644
--- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/FDistribution.java
+++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/FDistribution.java
@@ -52,11 +52,11 @@ public class FDistribution extends AbstractContinuousDistribution {
public FDistribution(double numeratorDegreesOfFreedom,
double denominatorDegreesOfFreedom) {
if (numeratorDegreesOfFreedom <= 0) {
- throw new DistributionException(DistributionException.NEGATIVE,
+ throw new DistributionException(DistributionException.NOT_STRICTLY_POSITIVE,
numeratorDegreesOfFreedom);
}
if (denominatorDegreesOfFreedom <= 0) {
- throw new DistributionException(DistributionException.NEGATIVE,
+ throw new DistributionException(DistributionException.NOT_STRICTLY_POSITIVE,
denominatorDegreesOfFreedom);
}
this.numeratorDegreesOfFreedom = numeratorDegreesOfFreedom;
diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/GammaDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/GammaDistribution.java
index 225b19b..5053955 100644
--- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/GammaDistribution.java
+++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/GammaDistribution.java
@@ -100,10 +100,10 @@ public class GammaDistribution extends AbstractContinuousDistribution {
public GammaDistribution(double shape,
double scale) {
if (shape <= 0) {
- throw new DistributionException(DistributionException.NEGATIVE, shape);
+ throw new DistributionException(DistributionException.NOT_STRICTLY_POSITIVE, shape);
}
if (scale <= 0) {
- throw new DistributionException(DistributionException.NEGATIVE, scale);
+ throw new DistributionException(DistributionException.NOT_STRICTLY_POSITIVE, scale);
}
this.shape = shape;
diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/GumbelDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/GumbelDistribution.java
index c1d32ad..6b28c06 100644
--- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/GumbelDistribution.java
+++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/GumbelDistribution.java
@@ -46,7 +46,7 @@ public class GumbelDistribution extends AbstractContinuousDistribution {
public GumbelDistribution(double mu,
double beta) {
if (beta <= 0) {
- throw new DistributionException(DistributionException.NEGATIVE, beta);
+ throw new DistributionException(DistributionException.NOT_STRICTLY_POSITIVE, beta);
}
this.beta = beta;
diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/HypergeometricDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/HypergeometricDistribution.java
index d4674f9..22b8895 100644
--- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/HypergeometricDistribution.java
+++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/HypergeometricDistribution.java
@@ -42,7 +42,7 @@ public class HypergeometricDistribution extends AbstractDiscreteDistribution {
int numberOfSuccesses,
int sampleSize) {
if (populationSize <= 0) {
- throw new DistributionException(DistributionException.NEGATIVE,
+ throw new DistributionException(DistributionException.NOT_STRICTLY_POSITIVE,
populationSize);
}
if (numberOfSuccesses < 0) {
diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/LaplaceDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/LaplaceDistribution.java
index e7d6212..a4fab52 100644
--- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/LaplaceDistribution.java
+++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/LaplaceDistribution.java
@@ -37,7 +37,7 @@ public class LaplaceDistribution extends AbstractContinuousDistribution {
public LaplaceDistribution(double mu,
double beta) {
if (beta <= 0) {
- throw new DistributionException(DistributionException.NEGATIVE, beta);
+ throw new DistributionException(DistributionException.NOT_STRICTLY_POSITIVE, beta);
}
this.mu = mu;
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 1059032..584bdd5 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
@@ -65,7 +65,7 @@ public class LogNormalDistribution extends AbstractContinuousDistribution {
public LogNormalDistribution(double scale,
double shape) {
if (shape <= 0) {
- throw new DistributionException(DistributionException.NEGATIVE, shape);
+ throw new DistributionException(DistributionException.NOT_STRICTLY_POSITIVE, shape);
}
this.scale = scale;
diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/LogisticDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/LogisticDistribution.java
index 11d3509..0480206 100644
--- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/LogisticDistribution.java
+++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/LogisticDistribution.java
@@ -43,7 +43,7 @@ public class LogisticDistribution extends AbstractContinuousDistribution {
public LogisticDistribution(double mu,
double scale) {
if (scale <= 0) {
- throw new DistributionException(DistributionException.NEGATIVE,
+ throw new DistributionException(DistributionException.NOT_STRICTLY_POSITIVE,
scale);
}
diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/NakagamiDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/NakagamiDistribution.java
index 6f7ca56..da925fb 100644
--- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/NakagamiDistribution.java
+++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/NakagamiDistribution.java
@@ -49,7 +49,7 @@ public class NakagamiDistribution extends AbstractContinuousDistribution {
throw new DistributionException(DistributionException.TOO_SMALL, mu, MIN_SHAPE);
}
if (omega <= 0) {
- throw new DistributionException(DistributionException.NEGATIVE, omega);
+ throw new DistributionException(DistributionException.NOT_STRICTLY_POSITIVE, omega);
}
this.mu = mu;
diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/NormalDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/NormalDistribution.java
index 3abeded..6817a6f 100644
--- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/NormalDistribution.java
+++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/NormalDistribution.java
@@ -47,7 +47,7 @@ public class NormalDistribution extends AbstractContinuousDistribution {
public NormalDistribution(double mean,
double sd) {
if (sd <= 0) {
- throw new DistributionException(DistributionException.NEGATIVE, sd);
+ throw new DistributionException(DistributionException.NOT_STRICTLY_POSITIVE, sd);
}
this.mean = mean;
diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/ParetoDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/ParetoDistribution.java
index 052b034..eb45bd5 100644
--- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/ParetoDistribution.java
+++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/ParetoDistribution.java
@@ -53,11 +53,11 @@ public class ParetoDistribution extends AbstractContinuousDistribution {
public ParetoDistribution(double scale,
double shape) {
if (scale <= 0) {
- throw new DistributionException(DistributionException.NEGATIVE, scale);
+ throw new DistributionException(DistributionException.NOT_STRICTLY_POSITIVE, scale);
}
if (shape <= 0) {
- throw new DistributionException(DistributionException.NEGATIVE, shape);
+ throw new DistributionException(DistributionException.NOT_STRICTLY_POSITIVE, shape);
}
this.scale = scale;
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 6660481..d2cdfdc 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
@@ -70,7 +70,7 @@ public class PascalDistribution extends AbstractDiscreteDistribution {
public PascalDistribution(int r,
double p) {
if (r <= 0) {
- throw new DistributionException(DistributionException.NEGATIVE,
+ throw new DistributionException(DistributionException.NOT_STRICTLY_POSITIVE,
r);
}
if (p < 0 ||
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 91f3426..a1cd928 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
@@ -63,7 +63,7 @@ public class PoissonDistribution extends AbstractDiscreteDistribution {
double epsilon,
int maxIterations) {
if (p <= 0) {
- throw new DistributionException(DistributionException.NEGATIVE, p);
+ throw new DistributionException(DistributionException.NOT_STRICTLY_POSITIVE, p);
}
mean = p;
this.epsilon = epsilon;
diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/TDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/TDistribution.java
index 6e69b33..612a89c 100644
--- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/TDistribution.java
+++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/TDistribution.java
@@ -50,7 +50,7 @@ public class TDistribution extends AbstractContinuousDistribution {
*/
public TDistribution(double degreesOfFreedom) {
if (degreesOfFreedom <= 0) {
- throw new DistributionException(DistributionException.NEGATIVE,
+ throw new DistributionException(DistributionException.NOT_STRICTLY_POSITIVE,
degreesOfFreedom);
}
this.degreesOfFreedom = degreesOfFreedom;
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 3640325..d79c001 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
@@ -48,11 +48,11 @@ public class WeibullDistribution extends AbstractContinuousDistribution {
public WeibullDistribution(double alpha,
double beta) {
if (alpha <= 0) {
- throw new DistributionException(DistributionException.NEGATIVE,
+ throw new DistributionException(DistributionException.NOT_STRICTLY_POSITIVE,
alpha);
}
if (beta <= 0) {
- throw new DistributionException(DistributionException.NEGATIVE,
+ throw new DistributionException(DistributionException.NOT_STRICTLY_POSITIVE,
beta);
}
scale = beta;
diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/ZipfDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/ZipfDistribution.java
index 3bc8506..c104438 100644
--- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/ZipfDistribution.java
+++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/ZipfDistribution.java
@@ -55,11 +55,11 @@ public class ZipfDistribution extends AbstractDiscreteDistribution {
public ZipfDistribution(int numberOfElements,
double exponent) {
if (numberOfElements <= 0) {
- throw new DistributionException(DistributionException.NEGATIVE,
+ throw new DistributionException(DistributionException.NOT_STRICTLY_POSITIVE,
numberOfElements);
}
if (exponent <= 0) {
- throw new DistributionException(DistributionException.NEGATIVE,
+ throw new DistributionException(DistributionException.NOT_STRICTLY_POSITIVE,
exponent);
}