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 e03ed3b6e3572989f959110b2136655e529e2bc5 Author: aherbert <[email protected]> AuthorDate: Fri Jan 21 16:37:18 2022 +0000 Consistent javadoc for property getters Use 'Gets the X parameter of this distribution'. Removes the use of 'Access the X parameter' for some of the javadocs. Using 'Gets' matches the same usage in the interface for the mean, variance and lower/upper bounds. Removes the use of parameter names within @code tags unless these are defined in the same javadoc, e.g. LogNormalDistribution mu parameter. --- .../apache/commons/statistics/distribution/BetaDistribution.java | 4 ++-- .../commons/statistics/distribution/BinomialDistribution.java | 4 ++-- .../commons/statistics/distribution/CauchyDistribution.java | 8 ++++---- .../commons/statistics/distribution/ChiSquaredDistribution.java | 2 +- .../org/apache/commons/statistics/distribution/FDistribution.java | 4 ++-- .../apache/commons/statistics/distribution/GammaDistribution.java | 8 ++++---- .../commons/statistics/distribution/GeometricDistribution.java | 2 +- .../commons/statistics/distribution/GumbelDistribution.java | 4 ++-- .../statistics/distribution/HypergeometricDistribution.java | 6 +++--- .../commons/statistics/distribution/LaplaceDistribution.java | 4 ++-- .../apache/commons/statistics/distribution/LevyDistribution.java | 8 ++++---- .../commons/statistics/distribution/LogNormalDistribution.java | 8 ++++---- .../commons/statistics/distribution/LogisticDistribution.java | 4 ++-- .../commons/statistics/distribution/NakagamiDistribution.java | 4 ++-- .../commons/statistics/distribution/NormalDistribution.java | 4 ++-- .../commons/statistics/distribution/ParetoDistribution.java | 8 ++++---- .../commons/statistics/distribution/PascalDistribution.java | 4 ++-- .../org/apache/commons/statistics/distribution/TDistribution.java | 2 +- .../commons/statistics/distribution/TriangularDistribution.java | 4 ++-- .../commons/statistics/distribution/WeibullDistribution.java | 8 ++++---- .../apache/commons/statistics/distribution/ZipfDistribution.java | 8 ++++---- 21 files changed, 54 insertions(+), 54 deletions(-) diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/BetaDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/BetaDistribution.java index 8b7b573..7587966 100644 --- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/BetaDistribution.java +++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/BetaDistribution.java @@ -87,7 +87,7 @@ public final class BetaDistribution extends AbstractContinuousDistribution { } /** - * Access the first shape parameter, {@code alpha}. + * Gets the first shape parameter of this distribution. * * @return the first shape parameter. */ @@ -96,7 +96,7 @@ public final class BetaDistribution extends AbstractContinuousDistribution { } /** - * Access the second shape parameter, {@code beta}. + * Gets the second shape parameter of this distribution. * * @return the second shape parameter. */ diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/BinomialDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/BinomialDistribution.java index 54607b6..4b08bde 100644 --- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/BinomialDistribution.java +++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/BinomialDistribution.java @@ -72,7 +72,7 @@ public final class BinomialDistribution extends AbstractDiscreteDistribution { } /** - * Access the number of trials for this distribution. + * Gets the number of trials parameter of this distribution. * * @return the number of trials. */ @@ -81,7 +81,7 @@ public final class BinomialDistribution extends AbstractDiscreteDistribution { } /** - * Access the probability of success for this distribution. + * Gets the probability of success parameter of this distribution. * * @return the probability of success. */ 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 2abf7f5..068a617 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 @@ -72,18 +72,18 @@ public final class CauchyDistribution extends AbstractContinuousDistribution { } /** - * Access the location. + * Gets the location parameter of this distribution. * - * @return the location for this distribution. + * @return the location parameter. */ public double getLocation() { return location; } /** - * Access the scale parameter. + * Gets the scale parameter of this distribution. * - * @return the scale parameter for this distribution. + * @return the scale parameter. */ public double getScale() { return scale; diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/ChiSquaredDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/ChiSquaredDistribution.java index 5e11d74..cf01e31 100644 --- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/ChiSquaredDistribution.java +++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/ChiSquaredDistribution.java @@ -55,7 +55,7 @@ public final class ChiSquaredDistribution extends AbstractContinuousDistribution } /** - * Access the number of degrees of freedom. + * Gets the degrees of freedom parameter of this distribution. * * @return the degrees of freedom. */ 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 c6de7ba..e6d3bc9 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 @@ -112,7 +112,7 @@ public final class FDistribution extends AbstractContinuousDistribution { } /** - * Access the numerator degrees of freedom. + * Gets the numerator degrees of freedom parameter of this distribution. * * @return the numerator degrees of freedom. */ @@ -121,7 +121,7 @@ public final class FDistribution extends AbstractContinuousDistribution { } /** - * Access the denominator degrees of freedom. + * Gets the denominator degrees of freedom parameter of this distribution. * * @return the denominator degrees of freedom. */ 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 13cec75..4a13e72 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 @@ -84,18 +84,18 @@ public final class GammaDistribution extends AbstractContinuousDistribution { } /** - * Returns the shape parameter of {@code this} distribution. + * Gets the shape parameter of this distribution. * - * @return the shape parameter + * @return the shape parameter. */ public double getShape() { return shape; } /** - * Returns the scale parameter of {@code this} distribution. + * Gets the scale parameter of this distribution. * - * @return the scale parameter + * @return the scale parameter. */ public double getScale() { return scale; 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 251ebea..d19b4d8 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 @@ -89,7 +89,7 @@ public final class GeometricDistribution extends AbstractDiscreteDistribution { } /** - * Access the probability of success for this distribution. + * Gets the probability of success parameter of this distribution. * * @return the probability of success. */ 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 ca7f549..ce84287 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 @@ -78,7 +78,7 @@ public final class GumbelDistribution extends AbstractContinuousDistribution { } /** - * Gets the location parameter. + * Gets the location parameter of this distribution. * * @return the location parameter. */ @@ -87,7 +87,7 @@ public final class GumbelDistribution extends AbstractContinuousDistribution { } /** - * Gets the scale parameter. + * Gets the scale parameter of this distribution. * * @return the scale parameter. */ 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 1a5c954..8cbb2c4 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 @@ -133,7 +133,7 @@ public final class HypergeometricDistribution extends AbstractDiscreteDistributi } /** - * Access the population size. + * Gets the population size parameter of this distribution. * * @return the population size. */ @@ -142,7 +142,7 @@ public final class HypergeometricDistribution extends AbstractDiscreteDistributi } /** - * Access the number of successes. + * Gets the number of successes parameter of this distribution. * * @return the number of successes. */ @@ -151,7 +151,7 @@ public final class HypergeometricDistribution extends AbstractDiscreteDistributi } /** - * Access the sample size. + * Gets the sample size parameter of this distribution. * * @return the sample size. */ 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 f115bc4..63c7b53 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 @@ -66,7 +66,7 @@ public final class LaplaceDistribution extends AbstractContinuousDistribution { } /** - * Access the location parameter, {@code mu}. + * Gets the location parameter of this distribution. * * @return the location parameter. */ @@ -75,7 +75,7 @@ public final class LaplaceDistribution extends AbstractContinuousDistribution { } /** - * Access the scale parameter, {@code beta}. + * Gets the scale parameter of this distribution. * * @return the scale parameter. */ diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/LevyDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/LevyDistribution.java index 5d90174..4a8b7ec 100644 --- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/LevyDistribution.java +++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/LevyDistribution.java @@ -76,18 +76,18 @@ public final class LevyDistribution extends AbstractContinuousDistribution { } /** - * Gets the location parameter of the distribution. + * Gets the location parameter of this distribution. * - * @return location parameter of the distribution + * @return the location parameter. */ public double getLocation() { return mu; } /** - * Gets the scale parameter of the distribution. + * Gets the scale parameter of this distribution. * - * @return scale parameter of the distribution + * @return the scale parameter. */ public double getScale() { return c; 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 71247d7..8e667b9 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 @@ -85,22 +85,22 @@ public final class LogNormalDistribution extends AbstractContinuousDistribution } /** - * Returns the mu parameter of this distribution. + * Gets the {@code mu} parameter of this distribution. * This is the mean of the natural logarithm of the distribution values, * not the mean of distribution. * - * @return the mu parameter + * @return the mu parameter. */ public double getMu() { return mu; } /** - * Returns the sigma parameter of this distribution. + * Gets the {@code sigma} parameter of this distribution. * This is the standard deviation of the natural logarithm of the distribution values, * not the standard deviation of distribution. * - * @return the sigma parameter + * @return the sigma parameter. */ public double getSigma() { return sigma; 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 0aca8fb..908c5e9 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 @@ -73,7 +73,7 @@ public final class LogisticDistribution extends AbstractContinuousDistribution { } /** - * Gets the location parameter. + * Gets the location parameter of this distribution. * * @return the location parameter. */ @@ -82,7 +82,7 @@ public final class LogisticDistribution extends AbstractContinuousDistribution { } /** - * Gets the scale parameter. + * Gets the scale parameter of this distribution. * * @return the scale parameter. */ 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 87df97a..df3ccbc 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 @@ -94,7 +94,7 @@ public final class NakagamiDistribution extends AbstractContinuousDistribution { } /** - * Access the shape parameter, {@code mu}. + * Gets the shape parameter of this distribution. * * @return the shape parameter. */ @@ -103,7 +103,7 @@ public final class NakagamiDistribution extends AbstractContinuousDistribution { } /** - * Access the scale parameter, {@code omega}. + * Gets the scale parameter of this distribution. * * @return the scale parameter. */ 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 883757e..940d1ee 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 @@ -99,9 +99,9 @@ public final class NormalDistribution extends AbstractContinuousDistribution { } /** - * Access the standard deviation. + * Gets the standard deviation parameter of this distribution. * - * @return the standard deviation for this distribution. + * @return the standard deviation. */ public double getStandardDeviation() { return standardDeviation; 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 47a4ee2..c771d91 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 @@ -111,20 +111,20 @@ public final class ParetoDistribution extends AbstractContinuousDistribution { } /** - * Returns the scale parameter of this distribution. + * Gets the scale parameter of this distribution. * This is the minimum possible value of X. * - * @return the scale parameter + * @return the scale parameter. */ public double getScale() { return scale; } /** - * Returns the shape parameter of this distribution. + * Gets the shape parameter of this distribution. * This is the Pareto index. * - * @return the shape parameter + * @return the shape parameter. */ public double getShape() { return shape; 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 46dd32f..76fe3fb 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 @@ -109,7 +109,7 @@ public final class PascalDistribution extends AbstractDiscreteDistribution { } /** - * Access the number of successes for this distribution. + * Gets the number of successes parameter of this distribution. * * @return the number of successes. */ @@ -118,7 +118,7 @@ public final class PascalDistribution extends AbstractDiscreteDistribution { } /** - * Access the probability of success for this distribution. + * Gets the probability of success parameter of this distribution. * * @return the probability of success. */ 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 0ce37a1..7c93318 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 @@ -246,7 +246,7 @@ public abstract class TDistribution extends AbstractContinuousDistribution { } /** - * Access the degrees of freedom. + * Gets the degrees of freedom parameter of this distribution. * * @return the degrees of freedom. */ diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/TriangularDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/TriangularDistribution.java index c86af09..aa45825 100644 --- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/TriangularDistribution.java +++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/TriangularDistribution.java @@ -96,9 +96,9 @@ public final class TriangularDistribution extends AbstractContinuousDistribution } /** - * Gets the mode. + * Gets the mode parameter of this distribution. * - * @return the mode of the distribution. + * @return the mode. */ public double getMode() { return c; 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 d0ef1d3..f7be8c0 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 @@ -89,18 +89,18 @@ public final class WeibullDistribution extends AbstractContinuousDistribution { } /** - * Access the shape parameter, {@code alpha}. + * Gets the shape parameter of this distribution. * - * @return the shape parameter, {@code alpha}. + * @return the shape parameter. */ public double getShape() { return shape; } /** - * Access the scale parameter, {@code beta}. + * Gets the scale parameter of this distribution. * - * @return the scale parameter, {@code beta}. + * @return the scale parameter. */ public double getScale() { return scale; 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 c7ceb49..b9933d5 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 @@ -82,18 +82,18 @@ public final class ZipfDistribution extends AbstractDiscreteDistribution { } /** - * Get the number of elements (e.g. corpus size) for the distribution. + * Gets the number of elements parameter of this distribution. * - * @return the number of elements + * @return the number of elements. */ public int getNumberOfElements() { return numberOfElements; } /** - * Get the exponent characterizing the distribution. + * Gets the exponent parameter of this distribution. * - * @return the exponent + * @return the exponent. */ public double getExponent() { return exponent;
