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 b265cb6ff034d220ef3fb3edbb7b04591b7c542f Author: Alex Herbert <[email protected]> AuthorDate: Tue Aug 25 14:12:41 2026 +0100 Add summary javadoc --- .../org/apache/commons/statistics/descriptive/Median.java | 2 +- .../commons/statistics/descriptive/NaNTransformers.java | 6 +++--- .../apache/commons/statistics/descriptive/Quantile.java | 2 +- .../commons/statistics/distribution/BetaDistribution.java | 2 +- .../statistics/distribution/BinomialDistribution.java | 2 +- .../statistics/distribution/CauchyDistribution.java | 2 +- .../statistics/distribution/ChiSquaredDistribution.java | 2 +- .../statistics/distribution/ExponentialDistribution.java | 2 +- .../commons/statistics/distribution/FDistribution.java | 2 +- .../statistics/distribution/FoldedNormalDistribution.java | 6 +++--- .../commons/statistics/distribution/GammaDistribution.java | 2 +- .../statistics/distribution/GeometricDistribution.java | 2 +- .../statistics/distribution/GumbelDistribution.java | 2 +- .../distribution/HypergeometricDistribution.java | 2 +- .../statistics/distribution/LaplaceDistribution.java | 2 +- .../commons/statistics/distribution/LevyDistribution.java | 2 +- .../statistics/distribution/LogNormalDistribution.java | 2 +- .../statistics/distribution/LogUniformDistribution.java | 2 +- .../statistics/distribution/LogisticDistribution.java | 2 +- .../statistics/distribution/NakagamiDistribution.java | 2 +- .../statistics/distribution/NormalDistribution.java | 2 +- .../statistics/distribution/ParetoDistribution.java | 2 +- .../statistics/distribution/PascalDistribution.java | 2 +- .../statistics/distribution/PoissonDistribution.java | 2 +- .../commons/statistics/distribution/TDistribution.java | 8 ++++---- .../statistics/distribution/TrapezoidalDistribution.java | 12 ++++++------ .../statistics/distribution/TriangularDistribution.java | 2 +- .../distribution/TruncatedNormalDistribution.java | 2 +- .../distribution/UniformContinuousDistribution.java | 2 +- .../distribution/UniformDiscreteDistribution.java | 2 +- .../statistics/distribution/WeibullDistribution.java | 2 +- .../commons/statistics/distribution/ZipfDistribution.java | 2 +- .../apache/commons/statistics/inference/BinomialTest.java | 2 +- .../apache/commons/statistics/inference/BracketFinder.java | 14 +++++++------- .../commons/statistics/inference/BrentOptimizer.java | 2 +- .../apache/commons/statistics/inference/ChiSquareTest.java | 2 +- .../commons/statistics/inference/FisherExactTest.java | 2 +- .../org/apache/commons/statistics/inference/GTest.java | 2 +- .../org/apache/commons/statistics/inference/Hypergeom.java | 2 +- .../statistics/inference/KolmogorovSmirnovTest.java | 2 +- .../commons/statistics/inference/MannWhitneyUTest.java | 2 +- .../apache/commons/statistics/inference/OneWayAnova.java | 2 +- .../commons/statistics/inference/SquareMatrixSupport.java | 2 +- .../org/apache/commons/statistics/inference/TTest.java | 2 +- .../statistics/inference/UnconditionedExactTest.java | 4 ++-- .../statistics/inference/WilcoxonSignedRankTest.java | 2 +- .../apache/commons/statistics/ranking/NaturalRanking.java | 4 ++-- 47 files changed, 67 insertions(+), 67 deletions(-) diff --git a/commons-statistics-descriptive/src/main/java/org/apache/commons/statistics/descriptive/Median.java b/commons-statistics-descriptive/src/main/java/org/apache/commons/statistics/descriptive/Median.java index 20795803..27ccac2e 100644 --- a/commons-statistics-descriptive/src/main/java/org/apache/commons/statistics/descriptive/Median.java +++ b/commons-statistics-descriptive/src/main/java/org/apache/commons/statistics/descriptive/Median.java @@ -76,7 +76,7 @@ public final class Median { /** Transformer for NaN data. */ private final NaNTransformer nanTransformer; - /** + /** Create an instance. * @param copy Flag to indicate if the data should be copied. * @param nanPolicy NaN policy. */ diff --git a/commons-statistics-descriptive/src/main/java/org/apache/commons/statistics/descriptive/NaNTransformers.java b/commons-statistics-descriptive/src/main/java/org/apache/commons/statistics/descriptive/NaNTransformers.java index 81848e1f..9efaf15c 100644 --- a/commons-statistics-descriptive/src/main/java/org/apache/commons/statistics/descriptive/NaNTransformers.java +++ b/commons-statistics-descriptive/src/main/java/org/apache/commons/statistics/descriptive/NaNTransformers.java @@ -54,7 +54,7 @@ final class NaNTransformers { /** Set to {@code true} to use a copy of the data. */ private final boolean copy; - /** + /** Create an instance. * @param copy Set to {@code true} to use a copy of the data. */ IncludeNaNTransformer(boolean copy) { @@ -81,7 +81,7 @@ final class NaNTransformers { /** Set to {@code true} to use a copy of the data. */ private final boolean copy; - /** + /** Create an instance. * @param copy Set to {@code true} to use a copy of the data. */ ExcludeNaNTransformer(boolean copy) { @@ -125,7 +125,7 @@ final class NaNTransformers { /** Set to {@code true} to use a copy of the data. */ private final boolean copy; - /** + /** Create an instance. * @param copy Set to {@code true} to use a copy of the data. */ ErrorNaNTransformer(boolean copy) { diff --git a/commons-statistics-descriptive/src/main/java/org/apache/commons/statistics/descriptive/Quantile.java b/commons-statistics-descriptive/src/main/java/org/apache/commons/statistics/descriptive/Quantile.java index 2342a3d7..d03b151d 100644 --- a/commons-statistics-descriptive/src/main/java/org/apache/commons/statistics/descriptive/Quantile.java +++ b/commons-statistics-descriptive/src/main/java/org/apache/commons/statistics/descriptive/Quantile.java @@ -107,7 +107,7 @@ public final class Quantile { /** Estimation type used to determine the value from the quantile. */ private final EstimationMethod estimationType; - /** + /** Create an instance. * @param copy Flag to indicate if the data should be copied. * @param nanPolicy NaN policy. * @param estimationType Estimation type used to determine the value from the quantile. 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 d9747e12..95b27969 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 @@ -53,7 +53,7 @@ public final class BetaDistribution extends AbstractContinuousDistribution { /** Cached value for inverse probability function. */ private final double variance; - /** + /** Create an instance. * @param alpha First shape parameter (must be positive). * @param beta Second shape parameter (must be positive). */ 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 b98e91f8..0d2c38dc 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 @@ -49,7 +49,7 @@ public final class BinomialDistribution extends AbstractDiscreteDistribution { /** Cached value for pmf(x=n). */ private final double pmfn; - /** + /** Create an instance. * @param trials Number of trials. * @param p 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 994a89b9..00bebadb 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 @@ -43,7 +43,7 @@ public final class CauchyDistribution extends AbstractContinuousDistribution { /** Density factor (scale^2). */ private final double scale2; - /** + /** Create an instance. * @param location Location parameter. * @param scale Scale parameter. */ 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 e63dc2f8..e69515d2 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 @@ -36,7 +36,7 @@ public final class ChiSquaredDistribution extends AbstractContinuousDistribution /** Internal Gamma distribution. */ private final GammaDistribution gamma; - /** + /** Create an instance. * @param degreesOfFreedom Degrees of freedom. */ private ChiSquaredDistribution(double degreesOfFreedom) { 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 752782e0..924dedf8 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 @@ -46,7 +46,7 @@ public final class ExponentialDistribution extends AbstractContinuousDistributio /** The logarithm of the mean, stored to reduce computing time. */ private final double logMean; - /** + /** Create an instance. * @param mean Mean of this distribution. */ private ExponentialDistribution(double 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 a1c623db..fb78a961 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 @@ -58,7 +58,7 @@ public final class FDistribution extends AbstractContinuousDistribution { /** Cached value for inverse probability function. */ private final double variance; - /** + /** Create an instance. * @param numeratorDegreesOfFreedom Numerator degrees of freedom. * @param denominatorDegreesOfFreedom Denominator degrees of freedom. */ diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/FoldedNormalDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/FoldedNormalDistribution.java index ece46ae9..a8f11026 100644 --- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/FoldedNormalDistribution.java +++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/FoldedNormalDistribution.java @@ -79,7 +79,7 @@ public abstract class FoldedNormalDistribution extends AbstractContinuousDistrib /** Cached value for inverse probability function. */ private final double variance; - /** + /** Create an instance. * @param mu Location parameter. * @param sigma Scale parameter. */ @@ -172,7 +172,7 @@ public abstract class FoldedNormalDistribution extends AbstractContinuousDistrib /** The value of {@code log(sigma) + 0.5 * log(2*PI)} stored for faster computation. */ private final double logSigmaPlusHalfLog2Pi; - /** + /** Create an instance. * @param sigma Scale parameter. */ HalfNormalDistribution(double sigma) { @@ -266,7 +266,7 @@ public abstract class FoldedNormalDistribution extends AbstractContinuousDistrib } } - /** + /** Create an instance. * @param sigma Scale parameter. */ FoldedNormalDistribution(double sigma) { 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 3fbbb0a5..bcc7ae4d 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 @@ -51,7 +51,7 @@ public final class GammaDistribution extends AbstractContinuousDistribution { /** Cached value for inverse probability function. */ private final double variance; - /** + /** Create an instance. * @param shape Shape parameter. * @param scale Scale parameter. */ 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 e91339ff..46bb3eb4 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 @@ -52,7 +52,7 @@ public final class GeometricDistribution extends AbstractDiscreteDistribution { /** Implementation of PMF(x). Assumes that {@code x > 0}. */ private final IntToDoubleFunction pmf; - /** + /** Create an instance. * @param p Probability of success. */ private GeometricDistribution(double p) { 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 d00de784..6c54da4a 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 @@ -52,7 +52,7 @@ public final class GumbelDistribution extends AbstractContinuousDistribution { /** Scale parameter. */ private final double beta; - /** + /** Create an instance. * @param mu Location parameter. * @param beta Scale parameter (must be positive). */ 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 9ac7ae14..c5dae67d 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 @@ -59,7 +59,7 @@ public final class HypergeometricDistribution extends AbstractDiscreteDistributi * Used for the cumulative probability functions. */ private double[] midpoint; - /** + /** Create an instance. * @param populationSize Population size. * @param numberOfSuccesses Number of successes in the population. * @param sampleSize 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 89697c37..bfc98c09 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 @@ -38,7 +38,7 @@ public final class LaplaceDistribution extends AbstractContinuousDistribution { /** log(2 * beta). */ private final double log2beta; - /** + /** Create an instance. * @param mu Location parameter. * @param beta Scale parameter (must be positive). */ 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 a2c3ea3a..11be800a 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 @@ -47,7 +47,7 @@ public final class LevyDistribution extends AbstractContinuousDistribution { /** Half of c (for calculations). */ private final double halfC; - /** + /** Create an instance. * @param mu Location parameter. * @param c Scale parameter. */ 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 8061f8ab..ca41b4d2 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 @@ -54,7 +54,7 @@ public final class LogNormalDistribution extends AbstractContinuousDistribution /** Sigma multiplied by sqrt(2 * pi). */ private final double sigmaSqrt2Pi; - /** + /** Create an instance. * @param mu Mean of the natural logarithm of the distribution values. * @param sigma Standard deviation of the natural logarithm of the distribution values. */ diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/LogUniformDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/LogUniformDistribution.java index a947f08a..f9e135bd 100644 --- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/LogUniformDistribution.java +++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/LogUniformDistribution.java @@ -48,7 +48,7 @@ public final class LogUniformDistribution extends AbstractContinuousDistribution /** log(log(b) - log(a)). */ private final double logLogBmLogA; - /** + /** Create an instance. * @param lower Lower bound of this distribution (inclusive). * @param upper Upper bound of this distribution (inclusive). */ 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 cfa7118c..1cbafbf9 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 @@ -44,7 +44,7 @@ public final class LogisticDistribution extends AbstractContinuousDistribution { /** Logarithm of "scale". */ private final double logScale; - /** + /** Create an instance. * @param mu Location parameter. * @param scale Scale parameter (must be positive). */ 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 571a9a37..08a2af5e 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 @@ -56,7 +56,7 @@ public final class NakagamiDistribution extends AbstractContinuousDistribution { /** Cached value for inverse probability function. */ private final double variance; - /** + /** Create an instance. * @param mu Shape parameter (must be positive). * @param omega Scale parameter (must be positive). Controls the spread of the distribution. */ 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 52f2cf01..9deccee9 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 @@ -62,7 +62,7 @@ public final class NormalDistribution extends AbstractContinuousDistribution { */ private final double sdSqrt2pi; - /** + /** Create an instance. * @param mean Mean for this distribution. * @param sd Standard deviation for this distribution. */ 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 cc02d50b..a61bf9fb 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 @@ -52,7 +52,7 @@ public final class ParetoDistribution extends AbstractContinuousDistribution { /** Implementation of log PDF(x). Assumes that {@code x >= scale}. */ private final DoubleUnaryOperator logpdf; - /** + /** Create an instance. * @param scale Scale parameter (minimum possible value of X). * @param shape Shape parameter (Pareto index). */ 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 acabd68e..1dffce21 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 final class PascalDistribution extends AbstractDiscreteDistribution { * and {@code n} is the number of successes, stored for faster computation. */ private final double probabilityOfSuccessPowNumOfSuccesses; - /** + /** Create an instance. * @param r Number of successes. * @param p Probability of success. */ 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 cb73f56f..fb09600d 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 @@ -42,7 +42,7 @@ public final class PoissonDistribution extends AbstractDiscreteDistribution { /** Mean of the distribution. */ private final double mean; - /** + /** Create an instance. * @param mean Poisson mean. * probabilities. */ 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 c2e5dd50..109de5b3 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 @@ -53,7 +53,7 @@ public abstract class TDistribution extends AbstractContinuousDistribution { * This is immutable and thread-safe and can be used across instances. */ private static final NormalDistribution STANDARD_NORMAL = NormalDistribution.of(0, 1); - /** + /** Create an instance. * @param degreesOfFreedom Degrees of freedom. */ NormalTDistribution(double degreesOfFreedom) { @@ -124,7 +124,7 @@ public abstract class TDistribution extends AbstractContinuousDistribution { /** Cached value for inverse probability function. */ private final double variance; - /** + /** Create an instance. * @param degreesOfFreedom Degrees of freedom. * @param variance Precomputed variance */ @@ -138,7 +138,7 @@ public abstract class TDistribution extends AbstractContinuousDistribution { this.variance = variance; } - /** + /** Compute the variance. * @param degreesOfFreedom Degrees of freedom. * @return the variance */ @@ -225,7 +225,7 @@ public abstract class TDistribution extends AbstractContinuousDistribution { } } - /** + /** Create an instance. * @param degreesOfFreedom Degrees of freedom. */ TDistribution(double degreesOfFreedom) { diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/TrapezoidalDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/TrapezoidalDistribution.java index 0a4cdcbc..b8a02989 100644 --- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/TrapezoidalDistribution.java +++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/TrapezoidalDistribution.java @@ -51,7 +51,7 @@ public abstract class TrapezoidalDistribution extends AbstractContinuousDistribu /** Upper limit of this distribution (inclusive). */ protected final double d; - /** + /** Create an instance. * Specialisation of the trapezoidal distribution used when the distribution simplifies * to an alternative distribution. */ @@ -59,7 +59,7 @@ public abstract class TrapezoidalDistribution extends AbstractContinuousDistribu /** Distribution delegate. */ private final ContinuousDistribution delegate; - /** + /** Create an instance. * @param a Lower limit of this distribution (inclusive). * @param b Start of the trapezoid constant density. * @param c End of the trapezoid constant density. @@ -129,7 +129,7 @@ public abstract class TrapezoidalDistribution extends AbstractContinuousDistribu * <p>This delegates all methods to the triangular distribution. */ private static class TriangularTrapezoidalDistribution extends DelegatedTrapezoidalDistribution { - /** + /** Create an instance. * @param a Lower limit of this distribution (inclusive). * @param b Start/end of the trapezoid constant density (mode). * @param d Upper limit of this distribution (inclusive). @@ -145,7 +145,7 @@ public abstract class TrapezoidalDistribution extends AbstractContinuousDistribu * <p>This delegates all methods to the uniform distribution. */ private static class UniformTrapezoidalDistribution extends DelegatedTrapezoidalDistribution { - /** + /** Create an instance. * @param a Lower limit of this distribution (inclusive). * @param d Upper limit of this distribution (inclusive). */ @@ -173,7 +173,7 @@ public abstract class TrapezoidalDistribution extends AbstractContinuousDistribu /** Survival probability at c. */ private final double sfC; - /** + /** Create an instance. * @param a Lower limit of this distribution (inclusive). * @param b Start of the trapezoid constant density. * @param c End of the trapezoid constant density. @@ -347,7 +347,7 @@ public abstract class TrapezoidalDistribution extends AbstractContinuousDistribu } } - /** + /** Create an instance. * @param a Lower limit of this distribution (inclusive). * @param b Start of the trapezoid constant density. * @param c End of the trapezoid constant density. 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 2a398410..77386cdb 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 @@ -50,7 +50,7 @@ public final class TriangularDistribution extends AbstractContinuousDistribution /** Survival probability at the mode. */ private final double sfMode; - /** + /** Create an instance. * @param a Lower limit of this distribution (inclusive). * @param c Mode of this distribution. * @param b Upper limit of this distribution (inclusive). diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/TruncatedNormalDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/TruncatedNormalDistribution.java index bf0d6137..492a0724 100644 --- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/TruncatedNormalDistribution.java +++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/TruncatedNormalDistribution.java @@ -89,7 +89,7 @@ public final class TruncatedNormalDistribution extends AbstractContinuousDistrib * a probability into the range of the parent normal distribution. */ private final double sfBeta; - /** + /** Create an instance. * @param parent Parent distribution. * @param z Probability of the parent distribution for {@code [lower, upper]}. * @param lower Lower bound (inclusive) of the distribution, can be {@link Double#NEGATIVE_INFINITY}. diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/UniformContinuousDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/UniformContinuousDistribution.java index a38e38a5..74cda00f 100644 --- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/UniformContinuousDistribution.java +++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/UniformContinuousDistribution.java @@ -47,7 +47,7 @@ public final class UniformContinuousDistribution extends AbstractContinuousDistr /** Cache of the log density. */ private final double logPdf; - /** + /** Create an instance. * @param lower Lower bound of this distribution (inclusive). * @param upper Upper bound of this distribution (inclusive). */ diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/UniformDiscreteDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/UniformDiscreteDistribution.java index 387bcbd5..eef7499a 100644 --- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/UniformDiscreteDistribution.java +++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/UniformDiscreteDistribution.java @@ -49,7 +49,7 @@ public final class UniformDiscreteDistribution extends AbstractDiscreteDistribut /** Value of survival probability for x=0. Used in the inverse survival function. */ private final double sf0; - /** + /** Create an instance. * @param lower Lower bound (inclusive) of this distribution. * @param upper Upper bound (inclusive) of this distribution. */ 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 698f7618..07b8d068 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 @@ -55,7 +55,7 @@ public final class WeibullDistribution extends AbstractContinuousDistribution { /** log(shape / scale). */ private final double logShapeOverScale; - /** + /** Create an instance. * @param shape Shape parameter. * @param scale Scale parameter. */ 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 70ac457b..2d670935 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 @@ -46,7 +46,7 @@ public final class ZipfDistribution extends AbstractDiscreteDistribution { /** Cached value of the log of the nth generalized harmonic. */ private final double logNthHarmonic; - /** + /** Create an instance. * @param numberOfElements Number of elements. * @param exponent Exponent. */ diff --git a/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/BinomialTest.java b/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/BinomialTest.java index 2b737a6b..068d44f4 100644 --- a/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/BinomialTest.java +++ b/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/BinomialTest.java @@ -35,7 +35,7 @@ public final class BinomialTest { /** Alternative hypothesis. */ private final AlternativeHypothesis alternative; - /** + /** Create an instance. * @param alternative Alternative hypothesis. */ private BinomialTest(AlternativeHypothesis alternative) { diff --git a/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/BracketFinder.java b/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/BracketFinder.java index 0c904e3d..3d6fdcf3 100644 --- a/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/BracketFinder.java +++ b/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/BracketFinder.java @@ -221,14 +221,14 @@ class BracketFinder { return lo < mid && mid < hi; } - /** + /** Get the evaluations. * @return the number of evaluations. */ int getEvaluations() { return evaluations; } - /** + /** Get the lower bound. * @return the lower bound of the bracket. * @see #getFLo() */ @@ -236,7 +236,7 @@ class BracketFinder { return lo; } - /** + /** Get the function value at the lower bound. * Get function value at {@link #getLo()}. * @return function value at {@link #getLo()} */ @@ -244,7 +244,7 @@ class BracketFinder { return fLo; } - /** + /** Get the higher bound. * @return the higher bound of the bracket. * @see #getFHi() */ @@ -252,7 +252,7 @@ class BracketFinder { return hi; } - /** + /** Get the function value at the higher bound. * Get function value at {@link #getHi()}. * @return function value at {@link #getHi()} */ @@ -260,7 +260,7 @@ class BracketFinder { return fHi; } - /** + /** Get a mid-point. * @return a point in the middle of the bracket. * @see #getFMid() */ @@ -268,7 +268,7 @@ class BracketFinder { return mid; } - /** + /** Get the function value at the mid-point. * Get function value at {@link #getMid()}. * @return function value at {@link #getMid()} */ diff --git a/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/BrentOptimizer.java b/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/BrentOptimizer.java index 0d7b5766..5614a3df 100644 --- a/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/BrentOptimizer.java +++ b/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/BrentOptimizer.java @@ -68,7 +68,7 @@ final class BrentOptimizer { /** Value of the objective function at the point. */ private final double value; - /** + /** Create an instance. * @param point Point. * @param value Value of an objective function at the point. */ diff --git a/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/ChiSquareTest.java b/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/ChiSquareTest.java index 7137fa6b..09983de8 100644 --- a/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/ChiSquareTest.java +++ b/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/ChiSquareTest.java @@ -42,7 +42,7 @@ public final class ChiSquareTest { /** Degrees of freedom adjustment. */ private final int degreesOfFreedomAdjustment; - /** + /** Create an instance. * @param degreesOfFreedomAdjustment Degrees of freedom adjustment. */ private ChiSquareTest(int degreesOfFreedomAdjustment) { diff --git a/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/FisherExactTest.java b/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/FisherExactTest.java index 804dc5c3..c3914646 100644 --- a/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/FisherExactTest.java +++ b/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/FisherExactTest.java @@ -38,7 +38,7 @@ public final class FisherExactTest { /** Alternative hypothesis. */ private final AlternativeHypothesis alternative; - /** + /** Create an instance. * @param alternative Alternative hypothesis. */ private FisherExactTest(AlternativeHypothesis alternative) { diff --git a/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/GTest.java b/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/GTest.java index 8400f617..2e9a38f3 100644 --- a/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/GTest.java +++ b/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/GTest.java @@ -51,7 +51,7 @@ public final class GTest { /** Degrees of freedom adjustment. */ private final int degreesOfFreedomAdjustment; - /** + /** Create an instance. * @param degreesOfFreedomAdjustment Degrees of freedom adjustment. */ private GTest(int degreesOfFreedomAdjustment) { diff --git a/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/Hypergeom.java b/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/Hypergeom.java index 6b520e7e..6592cf8c 100644 --- a/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/Hypergeom.java +++ b/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/Hypergeom.java @@ -51,7 +51,7 @@ class Hypergeom { /** Upper mode. */ private final int m2; - /** + /** Create an instance. * @param populationSize Population size. * @param numberOfSuccesses Number of successes in the population. * @param sampleSize Sample size. diff --git a/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/KolmogorovSmirnovTest.java b/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/KolmogorovSmirnovTest.java index 94cba09f..64d6b893 100644 --- a/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/KolmogorovSmirnovTest.java +++ b/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/KolmogorovSmirnovTest.java @@ -274,7 +274,7 @@ public final class KolmogorovSmirnovTest { } } - /** + /** Create an instance. * @param alternative Alternative hypothesis. * @param method P-value method. * @param strict true to use a strict inequality. diff --git a/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/MannWhitneyUTest.java b/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/MannWhitneyUTest.java index d4bc9d6a..8807a80c 100644 --- a/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/MannWhitneyUTest.java +++ b/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/MannWhitneyUTest.java @@ -114,7 +114,7 @@ public final class MannWhitneyUTest { } } - /** + /** Create an instance. * @param alternative Alternative hypothesis. * @param method P-value method. * @param continuityCorrection true to perform continuity correction. diff --git a/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/OneWayAnova.java b/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/OneWayAnova.java index 643c7b4f..6a9610e3 100644 --- a/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/OneWayAnova.java +++ b/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/OneWayAnova.java @@ -64,7 +64,7 @@ public final class OneWayAnova { /** nO value used to partition the variance. */ private final double nO; - /** + /** Create an instance. * @param dfbg Degrees of freedom in numerator (between groups). * @param dfwg Degrees of freedom in denominator (within groups). * @param msbg Mean square between groups. diff --git a/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/SquareMatrixSupport.java b/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/SquareMatrixSupport.java index 3ca5b820..ae367ebd 100644 --- a/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/SquareMatrixSupport.java +++ b/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/SquareMatrixSupport.java @@ -100,7 +100,7 @@ final class SquareMatrixSupport { /** Matrix scale. */ private final int exp; - /** + /** Create an instance. * @param dimension Matrix dimension. * @param data Matrix data. * @param scale Matrix scale. diff --git a/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/TTest.java b/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/TTest.java index 76d6b8ec..285bbe78 100644 --- a/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/TTest.java +++ b/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/TTest.java @@ -81,7 +81,7 @@ public final class TTest { } } - /** + /** Create an instance. * @param alternative Alternative hypothesis. * @param equalVariances Assume the two samples have the same population variance. * @param mu true value of the mean (or difference in means for a two sample test). diff --git a/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/UnconditionedExactTest.java b/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/UnconditionedExactTest.java index 09a3be1e..2f5abaad 100644 --- a/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/UnconditionedExactTest.java +++ b/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/UnconditionedExactTest.java @@ -222,7 +222,7 @@ public final class UnconditionedExactTest { this.pi = 0.5; } - /** + /** Create an instance. * @param statistic Test statistic. * @param pi Nuisance parameter. * @param p Result p-value. @@ -532,7 +532,7 @@ public final class UnconditionedExactTest { double value(Hypergeom dist, int x); } - /** + /** Create an instance. * @param alternative Alternative hypothesis. * @param method Method to identify more extreme tables. * @param points Number of initial points. diff --git a/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/WilcoxonSignedRankTest.java b/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/WilcoxonSignedRankTest.java index 8a558cf8..af11a4d7 100644 --- a/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/WilcoxonSignedRankTest.java +++ b/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/WilcoxonSignedRankTest.java @@ -105,7 +105,7 @@ public final class WilcoxonSignedRankTest { } } - /** + /** Create an instance. * @param alternative Alternative hypothesis. * @param method P-value method. * @param continuityCorrection true to perform continuity correction. diff --git a/commons-statistics-ranking/src/main/java/org/apache/commons/statistics/ranking/NaturalRanking.java b/commons-statistics-ranking/src/main/java/org/apache/commons/statistics/ranking/NaturalRanking.java index ad3dff8c..25cbeb37 100644 --- a/commons-statistics-ranking/src/main/java/org/apache/commons/statistics/ranking/NaturalRanking.java +++ b/commons-statistics-ranking/src/main/java/org/apache/commons/statistics/ranking/NaturalRanking.java @@ -192,7 +192,7 @@ public class NaturalRanking implements RankingAlgorithm { Objects.requireNonNull(randomIntFunction, NULL_RANDOM_SOURCE)); } - /** + /** Create an instance. * @param nanStrategy NaNStrategy to use. * @param tiesStrategy TiesStrategy to use. * @param randomIntFunction Source of random index data. @@ -471,7 +471,7 @@ public class NaturalRanking implements RankingAlgorithm { /** The list data. Initialised with space to store a tie of 2 values. */ private int[] data = new int[2]; - /** + /** Create an instance. * @param max Maximum size of array to allocate. Can use the length of the parent array * for which this is used to track indices. */
