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 2026/08/22 13:09:37 UTC
(commons-rng) 01/02: Add summary javadoc checkstyle rule
This is an automated email from the ASF dual-hosted git repository.
asf-gitbox-commits pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-rng.git
commit 261a2d6c376a6e3023ebacdbf84a105403a0ae18
Author: Alex Herbert <ah...@apache.org>
AuthorDate: Sat Aug 22 14:04:24 2026 +0100
Add summary javadoc checkstyle rule
---
.../commons/rng/UniformRandomProviderSupport.java | 8 +++++
.../commons/rng/core/source32/JDKRandom.java | 2 ++
.../apache/commons/rng/core/source64/TwoCmres.java | 14 ++++++++
.../commons/rng/core/util/NumberFactory.java | 2 ++
.../commons/rng/core/util/RandomStreams.java | 2 ++
.../commons/rng/sampling/CollectionSampler.java | 2 ++
.../commons/rng/sampling/CombinationSampler.java | 2 ++
.../commons/rng/sampling/CompositeSamplers.java | 24 ++++++++++++++
.../DiscreteProbabilityCollectionSampler.java | 2 ++
.../commons/rng/sampling/PermutationSampler.java | 4 +++
.../commons/rng/sampling/UnitSphereSampler.java | 12 +++++++
.../AhrensDieterExponentialSampler.java | 2 ++
.../AhrensDieterMarsagliaTsangGammaSampler.java | 14 ++++++++
.../distribution/BoxMullerGaussianSampler.java | 2 ++
.../sampling/distribution/ChengBetaSampler.java | 14 ++++++++
.../distribution/ContinuousUniformSampler.java | 4 +++
.../sampling/distribution/DirichletSampler.java | 6 ++++
.../distribution/DiscreteUniformSampler.java | 16 +++++++++
.../FastLoadedDiceRollerDiscreteSampler.java | 2 ++
.../rng/sampling/distribution/GaussianSampler.java | 2 ++
.../sampling/distribution/GeometricSampler.java | 4 +++
.../distribution/GuideTableDiscreteSampler.java | 2 ++
.../InverseTransformParetoSampler.java | 4 +++
.../distribution/KempSmallMeanPoissonSampler.java | 2 ++
.../distribution/LargeMeanPoissonSampler.java | 24 ++++++++++++++
.../rng/sampling/distribution/LevySampler.java | 4 +++
.../sampling/distribution/LogNormalSampler.java | 4 +++
.../MarsagliaTsangWangDiscreteSampler.java | 20 ++++++++++++
.../rng/sampling/distribution/PoissonSampler.java | 2 ++
.../sampling/distribution/PoissonSamplerCache.java | 4 +++
.../RejectionInversionZipfSampler.java | 8 ++++-
.../distribution/SmallMeanPoissonSampler.java | 2 ++
.../rng/sampling/distribution/StableSampler.java | 38 ++++++++++++++++++++++
.../rng/sampling/distribution/TSampler.java | 8 +++++
.../sampling/distribution/UniformLongSampler.java | 16 +++++++++
.../rng/sampling/distribution/ZigguratSampler.java | 8 +++++
.../commons/rng/sampling/shape/BoxSampler.java | 16 +++++++++
.../commons/rng/sampling/shape/LineSampler.java | 20 ++++++++++++
.../rng/sampling/shape/TetrahedronSampler.java | 6 ++++
.../rng/sampling/shape/TriangleSampler.java | 16 +++++++++
.../rng/sampling/shape/UnitBallSampler.java | 10 ++++++
.../apache/commons/rng/simple/RandomSource.java | 4 +++
.../commons/rng/simple/internal/SeedUtils.java | 2 ++
src/conf/checkstyle/checkstyle.xml | 1 +
44 files changed, 360 insertions(+), 1 deletion(-)
diff --git a/commons-rng-client-api/src/main/java/org/apache/commons/rng/UniformRandomProviderSupport.java b/commons-rng-client-api/src/main/java/org/apache/commons/rng/UniformRandomProviderSupport.java
index b6f9175d..ae71a6d4 100644
--- a/commons-rng-client-api/src/main/java/org/apache/commons/rng/UniformRandomProviderSupport.java
+++ b/commons-rng-client-api/src/main/java/org/apache/commons/rng/UniformRandomProviderSupport.java
@@ -506,6 +506,8 @@ final class UniformRandomProviderSupport {
private final SplittableUniformRandomProvider rng;
/**
+ * Constructs a new instance.
+ *
* @param start Start position of the stream (inclusive).
* @param end Upper limit of the stream (exclusive).
* @param source Source of randomness used to initialise the new instances.
@@ -571,6 +573,8 @@ final class UniformRandomProviderSupport {
private final ToIntFunction<SplittableUniformRandomProvider> gen;
/**
+ * Constructs a new instance.
+ *
* @param start Start position of the stream (inclusive).
* @param end Upper limit of the stream (exclusive).
* @param source Source of randomness.
@@ -636,6 +640,8 @@ final class UniformRandomProviderSupport {
private final ToLongFunction<SplittableUniformRandomProvider> gen;
/**
+ * Constructs a new instance.
+ *
* @param start Start position of the stream (inclusive).
* @param end Upper limit of the stream (exclusive).
* @param source Source of randomness.
@@ -701,6 +707,8 @@ final class UniformRandomProviderSupport {
private final ToDoubleFunction<SplittableUniformRandomProvider> gen;
/**
+ * Constructs a new instance.
+ *
* @param start Start position of the stream (inclusive).
* @param end Upper limit of the stream (exclusive).
* @param source Source of randomness.
diff --git a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/JDKRandom.java b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/JDKRandom.java
index 8a457139..0be23689 100644
--- a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/JDKRandom.java
+++ b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/JDKRandom.java
@@ -59,6 +59,8 @@ public class JDKRandom extends IntProvider {
*/
private static final class ValidatingObjectInputStream extends ObjectInputStream {
/**
+ * Constructs a new instance.
+ *
* @param in Input stream
* @throws IOException Signals that an I/O exception has occurred.
*/
diff --git a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/TwoCmres.java b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/TwoCmres.java
index a9e97d19..249bf12a 100644
--- a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/TwoCmres.java
+++ b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/TwoCmres.java
@@ -134,6 +134,8 @@ public class TwoCmres extends LongProvider {
}
/**
+ * Set the seed.
+ *
* @param seed Seed.
*/
private void setSeedInternal(int seed) {
@@ -176,6 +178,8 @@ public class TwoCmres extends LongProvider {
private final int rotate;
/**
+ * Constructs a new instance.
+ *
* @param multiply Multiplier.
* @param rotate Positive number. Must be in {@code [0, 64]}.
* @param start Cycle start.
@@ -196,6 +200,8 @@ public class TwoCmres extends LongProvider {
}
/**
+ * Gets the multiply.
+ *
* @return the multiplier.
*/
long getMultiply() {
@@ -203,6 +209,8 @@ public class TwoCmres extends LongProvider {
}
/**
+ * Gets the start.
+ *
* @return the cycle start.
*/
int getStart() {
@@ -210,6 +218,8 @@ public class TwoCmres extends LongProvider {
}
/**
+ * Transform the state.
+ *
* @param state Current state.
* @return the new state.
*/
@@ -252,6 +262,8 @@ public class TwoCmres extends LongProvider {
}
/**
+ * The number of subcycle generators.
+ *
* @return the number of subcycle generators.
*/
int numberOfSubcycleGenerators() {
@@ -259,6 +271,8 @@ public class TwoCmres extends LongProvider {
}
/**
+ * Gets the generator at the index.
+ *
* @param index Index into the list of available generators.
* @return the subcycle generator entry at index {@code index}.
*/
diff --git a/commons-rng-core/src/main/java/org/apache/commons/rng/core/util/NumberFactory.java b/commons-rng-core/src/main/java/org/apache/commons/rng/core/util/NumberFactory.java
index 07ef5e92..94640615 100644
--- a/commons-rng-core/src/main/java/org/apache/commons/rng/core/util/NumberFactory.java
+++ b/commons-rng-core/src/main/java/org/apache/commons/rng/core/util/NumberFactory.java
@@ -398,6 +398,8 @@ public final class NumberFactory {
}
/**
+ * Check the size.
+ *
* @param expected Expected value.
* @param actual Actual value.
* @throws IllegalArgumentException if {@code expected != actual}.
diff --git a/commons-rng-core/src/main/java/org/apache/commons/rng/core/util/RandomStreams.java b/commons-rng-core/src/main/java/org/apache/commons/rng/core/util/RandomStreams.java
index f8bfb60e..f74264de 100644
--- a/commons-rng-core/src/main/java/org/apache/commons/rng/core/util/RandomStreams.java
+++ b/commons-rng-core/src/main/java/org/apache/commons/rng/core/util/RandomStreams.java
@@ -195,6 +195,8 @@ public final class RandomStreams {
private final SeededObjectFactory<T> factory;
/**
+ * Constructs a new instance.
+ *
* @param start Start position of the stream (inclusive).
* @param end Upper limit of the stream (exclusive).
* @param source Source of randomness used to initialise the new instances.
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/CollectionSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/CollectionSampler.java
index 183cfae4..a7e82f9b 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/CollectionSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/CollectionSampler.java
@@ -52,6 +52,8 @@ public class CollectionSampler<T> implements SharedStateObjectSampler<T> {
}
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param collection Collection to be sampled.
*/
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/CombinationSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/CombinationSampler.java
index 5e1c22a6..61f5f563 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/CombinationSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/CombinationSampler.java
@@ -90,6 +90,8 @@ public class CombinationSampler implements SharedStateObjectSampler<int[]> {
}
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param source Source to copy.
*/
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/CompositeSamplers.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/CompositeSamplers.java
index 9ea142fb..edda8886 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/CompositeSamplers.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/CompositeSamplers.java
@@ -135,6 +135,8 @@ public final class CompositeSamplers {
private final double[] probabilities;
/**
+ * Constructs a new instance.
+ *
* @param sampler Sampler of the discrete distribution.
* @param factory Factory to create a new discrete sampler.
* @param probabilities Probabilities of the discrete distribution.
@@ -304,6 +306,8 @@ public final class CompositeSamplers {
private final S sampler;
/**
+ * Constructs a new instance.
+ *
* @param weight the weight
* @param sampler the sampler
* @throws IllegalArgumentException if {@code weight} is negative, infinite or {@code NaN}.
@@ -352,6 +356,8 @@ public final class CompositeSamplers {
}
/**
+ * Constructs a new instance.
+ *
* @param specialisation Specialisation of the sampler.
* @param compositeFactory Factory to create the final composite sampler.
*/
@@ -571,6 +577,8 @@ public final class CompositeSamplers {
protected final List<S> samplers;
/**
+ * Constructs a new instance.
+ *
* @param discreteSampler Continuous sampler to choose the individual sampler to sample.
* @param samplers Collection of samplers to be sampled from.
*/
@@ -627,6 +635,8 @@ public final class CompositeSamplers {
extends CompositeSampler<ObjectSampler<T>>
implements ObjectSampler<T> {
/**
+ * Constructs a new instance.
+ *
* @param discreteSampler Discrete sampler to choose the individual sampler to sample.
* @param samplers Collection of samplers to be sampled from.
*/
@@ -684,6 +694,8 @@ public final class CompositeSamplers {
extends CompositeSampler<SharedStateObjectSampler<T>>
implements SharedStateObjectSampler<T> {
/**
+ * Constructs a new instance.
+ *
* @param discreteSampler Discrete sampler to choose the individual sampler to sample.
* @param samplers Collection of samplers to be sampled from.
*/
@@ -728,6 +740,8 @@ public final class CompositeSamplers {
extends CompositeSampler<DiscreteSampler>
implements DiscreteSampler {
/**
+ * Constructs a new instance.
+ *
* @param discreteSampler Discrete sampler to choose the individual sampler to sample.
* @param samplers Collection of samplers to be sampled from.
*/
@@ -766,6 +780,8 @@ public final class CompositeSamplers {
extends CompositeSampler<SharedStateDiscreteSampler>
implements SharedStateDiscreteSampler {
/**
+ * Constructs a new instance.
+ *
* @param discreteSampler Discrete sampler to choose the individual sampler to sample.
* @param samplers Collection of samplers to be sampled from.
*/
@@ -810,6 +826,8 @@ public final class CompositeSamplers {
extends CompositeSampler<ContinuousSampler>
implements ContinuousSampler {
/**
+ * Constructs a new instance.
+ *
* @param discreteSampler Continuous sampler to choose the individual sampler to sample.
* @param samplers Collection of samplers to be sampled from.
*/
@@ -848,6 +866,8 @@ public final class CompositeSamplers {
extends CompositeSampler<SharedStateContinuousSampler>
implements SharedStateContinuousSampler {
/**
+ * Constructs a new instance.
+ *
* @param discreteSampler Continuous sampler to choose the individual sampler to sample.
* @param samplers Collection of samplers to be sampled from.
*/
@@ -892,6 +912,8 @@ public final class CompositeSamplers {
extends CompositeSampler<LongSampler>
implements LongSampler {
/**
+ * Constructs a new instance.
+ *
* @param discreteSampler Long sampler to choose the individual sampler to sample.
* @param samplers Collection of samplers to be sampled from.
*/
@@ -930,6 +952,8 @@ public final class CompositeSamplers {
extends CompositeSampler<SharedStateLongSampler>
implements SharedStateLongSampler {
/**
+ * Constructs a new instance.
+ *
* @param discreteSampler Long sampler to choose the individual sampler to sample.
* @param samplers Collection of samplers to be sampled from.
*/
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/DiscreteProbabilityCollectionSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/DiscreteProbabilityCollectionSampler.java
index 44be33d5..0b231c35 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/DiscreteProbabilityCollectionSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/DiscreteProbabilityCollectionSampler.java
@@ -89,6 +89,8 @@ public class DiscreteProbabilityCollectionSampler<T> implements SharedStateObjec
}
/**
+ * Constructs a new instance.
+ *
* @param items Collection to be sampled.
* @param sampler Sampler for the probabilities.
*/
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/PermutationSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/PermutationSampler.java
index a301de5e..41de2e3a 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/PermutationSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/PermutationSampler.java
@@ -60,6 +60,8 @@ public class PermutationSampler implements SharedStateObjectSampler<int[]> {
}
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param source Source to copy.
*/
@@ -78,6 +80,8 @@ public class PermutationSampler implements SharedStateObjectSampler<int[]> {
}
/**
+ * {@inheritDoc}
+ *
* @return a random permutation.
* @see #PermutationSampler(UniformRandomProvider,int,int)
*/
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/UnitSphereSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/UnitSphereSampler.java
index bdcef4ac..1776cea3 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/UnitSphereSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/UnitSphereSampler.java
@@ -62,6 +62,8 @@ public class UnitSphereSampler implements SharedStateObjectSampler<double[]> {
private final UniformRandomProvider rng;
/**
+ * Constructs a new instance.
+ *
* @param rng Source of randomness.
*/
UnitSphereSampler1D(UniformRandomProvider rng) {
@@ -92,6 +94,8 @@ public class UnitSphereSampler implements SharedStateObjectSampler<double[]> {
private final NormalizedGaussianSampler sampler;
/**
+ * Constructs a new instance.
+ *
* @param rng Source of randomness.
*/
UnitSphereSampler2D(UniformRandomProvider rng) {
@@ -128,6 +132,8 @@ public class UnitSphereSampler implements SharedStateObjectSampler<double[]> {
private final NormalizedGaussianSampler sampler;
/**
+ * Constructs a new instance.
+ *
* @param rng Source of randomness.
*/
UnitSphereSampler3D(UniformRandomProvider rng) {
@@ -166,6 +172,8 @@ public class UnitSphereSampler implements SharedStateObjectSampler<double[]> {
private final NormalizedGaussianSampler sampler;
/**
+ * Constructs a new instance.
+ *
* @param rng Source of randomness.
* @param dimension Space dimension.
*/
@@ -246,6 +254,8 @@ public class UnitSphereSampler implements SharedStateObjectSampler<double[]> {
}
/**
+ * {@inheritDoc}
+ *
* @return a random normalized Cartesian vector.
* @since 1.4
*/
@@ -255,6 +265,8 @@ public class UnitSphereSampler implements SharedStateObjectSampler<double[]> {
}
/**
+ * Create a sample.
+ *
* @return a random normalized Cartesian vector.
* @deprecated Use {@link #sample()}.
*/
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/AhrensDieterExponentialSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/AhrensDieterExponentialSampler.java
index 2e1d6af6..a2af51a2 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/AhrensDieterExponentialSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/AhrensDieterExponentialSampler.java
@@ -87,6 +87,8 @@ public class AhrensDieterExponentialSampler
}
/**
+ * Constructs a new instance.
+ *
* @param mean Mean.
* @param rng Generator of uniformly distributed random numbers.
*/
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/AhrensDieterMarsagliaTsangGammaSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/AhrensDieterMarsagliaTsangGammaSampler.java
index e0788d1e..42687f3b 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/AhrensDieterMarsagliaTsangGammaSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/AhrensDieterMarsagliaTsangGammaSampler.java
@@ -70,6 +70,8 @@ public class AhrensDieterMarsagliaTsangGammaSampler
protected final double theta;
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param alpha Alpha parameter of the distribution.
* @param theta Theta parameter of the distribution.
@@ -86,6 +88,8 @@ public class AhrensDieterMarsagliaTsangGammaSampler
}
/**
+ * Constructs a new instance.
+ *
* @param alpha Alpha parameter of the distribution.
* @param theta Theta parameter of the distribution.
* @param rng Generator of uniformly distributed random numbers.
@@ -99,6 +103,8 @@ public class AhrensDieterMarsagliaTsangGammaSampler
}
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param source Source to copy.
*/
@@ -134,6 +140,8 @@ public class AhrensDieterMarsagliaTsangGammaSampler
private final double bGSOptim;
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param alpha Alpha parameter of the distribution.
* @param theta Theta parameter of the distribution.
@@ -149,6 +157,8 @@ public class AhrensDieterMarsagliaTsangGammaSampler
}
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param source Source to copy.
*/
@@ -220,6 +230,8 @@ public class AhrensDieterMarsagliaTsangGammaSampler
private final NormalizedGaussianSampler gaussian;
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param alpha Alpha parameter of the distribution.
* @param theta Theta parameter of the distribution.
@@ -236,6 +248,8 @@ public class AhrensDieterMarsagliaTsangGammaSampler
}
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param source Source to copy.
*/
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/BoxMullerGaussianSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/BoxMullerGaussianSampler.java
index 2361c3fd..e7dcdb97 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/BoxMullerGaussianSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/BoxMullerGaussianSampler.java
@@ -65,6 +65,8 @@ public class BoxMullerGaussianSampler
}
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param mean Mean of the Gaussian distribution.
* @param standardDeviation Standard deviation of the Gaussian distribution.
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/ChengBetaSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/ChengBetaSampler.java
index 4e42097a..80b30b40 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/ChengBetaSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/ChengBetaSampler.java
@@ -77,6 +77,8 @@ public class ChengBetaSampler
protected final double logAlpha;
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param aIsAlphaShape true if {@code a} is the beta distribution alpha shape parameter.
* @param a Distribution first shape parameter.
@@ -92,6 +94,8 @@ public class ChengBetaSampler
}
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param source Source to copy.
*/
@@ -146,6 +150,8 @@ public class ChengBetaSampler
private final double gamma;
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param aIsAlphaShape true if {@code a} is the beta distribution alpha shape parameter.
* @param a min(alpha, beta) shape parameter.
@@ -158,6 +164,8 @@ public class ChengBetaSampler
}
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param source Source to copy.
*/
@@ -226,6 +234,8 @@ public class ChengBetaSampler
private final double k2;
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param aIsAlphaShape true if {@code a} is the beta distribution alpha shape parameter.
* @param a max(alpha, beta) shape parameter.
@@ -244,6 +254,8 @@ public class ChengBetaSampler
}
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param source Source to copy.
*/
@@ -319,6 +331,8 @@ public class ChengBetaSampler
}
/**
+ * Constructs a new instance.
+ *
* @param delegate Beta sampler.
*/
private ChengBetaSampler(SharedStateContinuousSampler delegate) {
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/ContinuousUniformSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/ContinuousUniformSampler.java
index 52b4940e..b144ef86 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/ContinuousUniformSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/ContinuousUniformSampler.java
@@ -47,6 +47,8 @@ public class ContinuousUniformSampler
*/
private static final class OpenIntervalContinuousUniformSampler extends ContinuousUniformSampler {
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param lo Lower bound.
* @param hi Higher bound.
@@ -80,6 +82,8 @@ public class ContinuousUniformSampler
*/
private static final class OpenIntervalContinuousUniformSampler01 extends ContinuousUniformSampler {
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
*/
OpenIntervalContinuousUniformSampler01(UniformRandomProvider rng) {
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/DirichletSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/DirichletSampler.java
index 23c5274e..0776ca93 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/DirichletSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/DirichletSampler.java
@@ -48,6 +48,8 @@ public abstract class DirichletSampler implements SharedStateObjectSampler<doubl
private final SharedStateContinuousSampler[] samplers;
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param samplers Samplers for each category.
*/
@@ -89,6 +91,8 @@ public abstract class DirichletSampler implements SharedStateObjectSampler<doubl
private final SharedStateContinuousSampler sampler;
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param k Number of categories.
* @param sampler Sampler for the categories.
@@ -118,6 +122,8 @@ public abstract class DirichletSampler implements SharedStateObjectSampler<doubl
}
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
*/
DirichletSampler(UniformRandomProvider rng) {
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/DiscreteUniformSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/DiscreteUniformSampler.java
index 5bcb1b4a..836169aa 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/DiscreteUniformSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/DiscreteUniformSampler.java
@@ -66,6 +66,8 @@ public class DiscreteUniformSampler
protected final UniformRandomProvider rng;
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
*/
AbstractDiscreteUniformSampler(UniformRandomProvider rng) {
@@ -87,6 +89,8 @@ public class DiscreteUniformSampler
private final int value;
/**
+ * Constructs a new instance.
+ *
* @param value The value.
*/
FixedDiscreteUniformSampler(int value) {
@@ -126,6 +130,8 @@ public class DiscreteUniformSampler
private final int shift;
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param range Maximum range of the sample (exclusive).
* Must be a power of 2 greater than 2^0.
@@ -137,6 +143,8 @@ public class DiscreteUniformSampler
}
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param source Source to copy.
*/
@@ -183,6 +191,8 @@ public class DiscreteUniformSampler
private final long threshold;
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param range Maximum range of the sample (exclusive).
*/
@@ -196,6 +206,8 @@ public class DiscreteUniformSampler
}
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param source Source to copy.
*/
@@ -251,6 +263,8 @@ public class DiscreteUniformSampler
private final int upper;
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param lower Lower bound (inclusive) of the distribution.
* @param upper Upper bound (inclusive) of the distribution.
@@ -295,6 +309,8 @@ public class DiscreteUniformSampler
private final SharedStateDiscreteSampler sampler;
/**
+ * Constructs a new instance.
+ *
* @param offset The offset for the sample.
* @param sampler The discrete sampler.
*/
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/FastLoadedDiceRollerDiscreteSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/FastLoadedDiceRollerDiscreteSampler.java
index ffeca8ae..d84ce81c 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/FastLoadedDiceRollerDiscreteSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/FastLoadedDiceRollerDiscreteSampler.java
@@ -102,6 +102,8 @@ public abstract class FastLoadedDiceRollerDiscreteSampler
private final int sampleValue;
/**
+ * Constructs a new instance.
+ *
* @param sampleValue Sample value.
*/
FixedValueDiscreteSampler(int sampleValue) {
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/GaussianSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/GaussianSampler.java
index 8a4880d3..cdbacdd8 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/GaussianSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/GaussianSampler.java
@@ -59,6 +59,8 @@ public class GaussianSampler implements SharedStateContinuousSampler {
}
/**
+ * Constructs a new instance.
+ *
* @param mean Mean of the Gaussian distribution.
* @param standardDeviation Standard deviation of the Gaussian distribution.
* @param normalized Generator of N(0,1) Gaussian distributed random numbers.
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/GeometricSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/GeometricSampler.java
index 33cf1a21..b1efcdc9 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/GeometricSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/GeometricSampler.java
@@ -108,6 +108,8 @@ public final class GeometricSampler {
private final SharedStateContinuousSampler exponentialSampler;
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers
* @param exponentialMean The mean of the related exponential distribution (must be
* strictly positive finite)
@@ -118,6 +120,8 @@ public final class GeometricSampler {
}
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers
* @param source Source to copy.
*/
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/GuideTableDiscreteSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/GuideTableDiscreteSampler.java
index 18e614e1..7d38aaad 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/GuideTableDiscreteSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/GuideTableDiscreteSampler.java
@@ -63,6 +63,8 @@ public final class GuideTableDiscreteSampler
private final int[] guideTable;
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param cumulativeProbabilities The cumulative probability table ({@code f(x)}).
* @param guideTable The inverse cumulative probability guide table.
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/InverseTransformParetoSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/InverseTransformParetoSampler.java
index c078b9e6..db3b91d6 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/InverseTransformParetoSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/InverseTransformParetoSampler.java
@@ -57,6 +57,8 @@ public class InverseTransformParetoSampler
}
/**
+ * Constructs a new instance.
+ *
* @param scale Scale of the distribution.
* @param shape Shape of the distribution.
* @param rng Generator of uniformly distributed random numbers.
@@ -78,6 +80,8 @@ public class InverseTransformParetoSampler
}
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param source Source to copy.
*/
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/KempSmallMeanPoissonSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/KempSmallMeanPoissonSampler.java
index e2bec87a..b0d43c83 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/KempSmallMeanPoissonSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/KempSmallMeanPoissonSampler.java
@@ -60,6 +60,8 @@ public final class KempSmallMeanPoissonSampler
private final double mean;
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param p0 Probability of the Poisson sample {@code p(x=0)}.
* @param mean Mean.
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/LargeMeanPoissonSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/LargeMeanPoissonSampler.java
index 4b22e433..10b95d1b 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/LargeMeanPoissonSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/LargeMeanPoissonSampler.java
@@ -150,6 +150,8 @@ public class LargeMeanPoissonSampler
}
/**
+ * Constructs a new instance.
+ *
* @param mean Mean.
* @param rng Generator of uniformly distributed random numbers.
*/
@@ -221,6 +223,8 @@ public class LargeMeanPoissonSampler
}
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param source Source to copy.
*/
@@ -448,6 +452,8 @@ public class LargeMeanPoissonSampler
}
/**
+ * Gets the lambda.
+ *
* @return algorithm constant {@code lambda}
*/
double getLambdaRaw() {
@@ -455,6 +461,8 @@ public class LargeMeanPoissonSampler
}
/**
+ * Gets the log lambda.
+ *
* @return algorithm constant {@code logLambda}
*/
double getLogLambda() {
@@ -462,6 +470,8 @@ public class LargeMeanPoissonSampler
}
/**
+ * Gets the log lambda factorial.
+ *
* @return algorithm constant {@code logLambdaFactorial}
*/
double getLogLambdaFactorial() {
@@ -469,6 +479,8 @@ public class LargeMeanPoissonSampler
}
/**
+ * Gets the delta.
+ *
* @return algorithm constant {@code delta}
*/
double getDelta() {
@@ -476,6 +488,8 @@ public class LargeMeanPoissonSampler
}
/**
+ * Gets the half delta.
+ *
* @return algorithm constant {@code halfDelta}
*/
double getHalfDelta() {
@@ -483,6 +497,8 @@ public class LargeMeanPoissonSampler
}
/**
+ * Gets the sqrt lambda plus half delta.
+ *
* @return algorithm constant {@code sqrtLambdaPlusHalfDelta}
*/
double getSqrtLambdaPlusHalfDelta() {
@@ -490,6 +506,8 @@ public class LargeMeanPoissonSampler
}
/**
+ * Gets the constant twolpd.
+ *
* @return algorithm constant {@code twolpd}
*/
double getTwolpd() {
@@ -497,6 +515,8 @@ public class LargeMeanPoissonSampler
}
/**
+ * Gets the constant p1.
+ *
* @return algorithm constant {@code p1}
*/
double getP1() {
@@ -504,6 +524,8 @@ public class LargeMeanPoissonSampler
}
/**
+ * Gets the constant p2.
+ *
* @return algorithm constant {@code p2}
*/
double getP2() {
@@ -511,6 +533,8 @@ public class LargeMeanPoissonSampler
}
/**
+ * Gets the constant c1.
+ *
* @return algorithm constant {@code c1}
*/
double getC1() {
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/LevySampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/LevySampler.java
index 91c274c7..20425288 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/LevySampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/LevySampler.java
@@ -35,6 +35,8 @@ public final class LevySampler implements SharedStateContinuousSampler {
private final UniformRandomProvider rng;
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param location Location of the Lévy distribution.
* @param scale Scale of the Lévy distribution.
@@ -49,6 +51,8 @@ public final class LevySampler implements SharedStateContinuousSampler {
}
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param source Source to copy.
*/
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/LogNormalSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/LogNormalSampler.java
index 3c97bc06..2f0e055a 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/LogNormalSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/LogNormalSampler.java
@@ -49,6 +49,8 @@ public class LogNormalSampler implements SharedStateContinuousSampler {
}
/**
+ * Constructs a new instance.
+ *
* @param mu Mean of the natural logarithm of the distribution values.
* @param sigma Standard deviation of the natural logarithm of the distribution values.
* @param gaussian N(0,1) generator.
@@ -62,6 +64,8 @@ public class LogNormalSampler implements SharedStateContinuousSampler {
}
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param source Source to copy.
*/
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/MarsagliaTsangWangDiscreteSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/MarsagliaTsangWangDiscreteSampler.java
index 6987d8c0..30c6d11f 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/MarsagliaTsangWangDiscreteSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/MarsagliaTsangWangDiscreteSampler.java
@@ -97,6 +97,8 @@ public final class MarsagliaTsangWangDiscreteSampler {
private final String distributionName;
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param distributionName Distribution name.
*/
@@ -107,6 +109,8 @@ public final class MarsagliaTsangWangDiscreteSampler {
}
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param source Source to copy.
*/
@@ -153,6 +157,8 @@ public final class MarsagliaTsangWangDiscreteSampler {
private final byte[] table5;
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param distributionName Distribution name.
* @param prob The probabilities.
@@ -209,6 +215,8 @@ public final class MarsagliaTsangWangDiscreteSampler {
}
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param source Source to copy.
*/
@@ -299,6 +307,8 @@ public final class MarsagliaTsangWangDiscreteSampler {
private final short[] table5;
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param distributionName Distribution name.
* @param prob The probabilities.
@@ -355,6 +365,8 @@ public final class MarsagliaTsangWangDiscreteSampler {
}
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param source Source to copy.
*/
@@ -442,6 +454,8 @@ public final class MarsagliaTsangWangDiscreteSampler {
private final int[] table5;
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param distributionName Distribution name.
* @param prob The probabilities.
@@ -497,6 +511,8 @@ public final class MarsagliaTsangWangDiscreteSampler {
}
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param source Source to copy.
*/
@@ -909,6 +925,8 @@ public final class MarsagliaTsangWangDiscreteSampler {
private final int result;
/**
+ * Constructs a new instance.
+ *
* @param result Result.
*/
MarsagliaTsangWangFixedResultBinomialSampler(int result) {
@@ -949,6 +967,8 @@ public final class MarsagliaTsangWangDiscreteSampler {
private final SharedStateDiscreteSampler sampler;
/**
+ * Constructs a new instance.
+ *
* @param trials Number of trials.
* @param sampler Binomial distribution sampler.
*/
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/PoissonSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/PoissonSampler.java
index 7a4e3c37..e253fe6c 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/PoissonSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/PoissonSampler.java
@@ -78,6 +78,8 @@ public class PoissonSampler
}
/**
+ * Constructs a new instance.
+ *
* @param delegate Poisson sampler.
*/
private PoissonSampler(SharedStateDiscreteSampler delegate) {
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/PoissonSamplerCache.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/PoissonSamplerCache.java
index ada00fa9..6198cbe3 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/PoissonSamplerCache.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/PoissonSamplerCache.java
@@ -91,6 +91,8 @@ public class PoissonSamplerCache {
}
/**
+ * Constructs a new instance.
+ *
* @param minMean The minimum mean covered by the cache.
* @param maxMean The maximum mean covered by the cache.
* @param ignored Ignored value.
@@ -115,6 +117,8 @@ public class PoissonSamplerCache {
}
/**
+ * Constructs a new instance.
+ *
* @param minN The minimum N covered by the cache where {@code N = (int)Math.floor(mean)}.
* @param maxN The maximum N covered by the cache where {@code N = (int)Math.floor(mean)}.
* @param states The precomputed states.
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/RejectionInversionZipfSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/RejectionInversionZipfSampler.java
index 1c6dc97f..e769801c 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/RejectionInversionZipfSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/RejectionInversionZipfSampler.java
@@ -61,6 +61,8 @@ public class RejectionInversionZipfSampler
private final UniformRandomProvider rng;
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param numberOfElements Number of elements (must be {@code > 0}).
* @param exponent Exponent (must be {@code > 0}).
@@ -78,6 +80,8 @@ public class RejectionInversionZipfSampler
}
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param source Source to copy.
*/
@@ -291,7 +295,9 @@ public class RejectionInversionZipfSampler
}
/**
- * Rejection inversion sampling method for a discrete, bounded Zipf
+ * {@inheritDoc}
+ *
+ * <p>Rejection inversion sampling method for a discrete, bounded Zipf
* distribution that is based on the method described in
* <blockquote>
* Wolfgang Hörmann and Gerhard Derflinger.
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/SmallMeanPoissonSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/SmallMeanPoissonSampler.java
index acbb90c9..aa3037c7 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/SmallMeanPoissonSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/SmallMeanPoissonSampler.java
@@ -82,6 +82,8 @@ public class SmallMeanPoissonSampler
}
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param source Source to copy.
*/
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/StableSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/StableSampler.java
index 50115a38..214671ff 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/StableSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/StableSampler.java
@@ -223,6 +223,8 @@ public abstract class StableSampler implements SharedStateContinuousSampler {
private final ContinuousSampler expSampler;
/**
+ * Constructs a new instance.
+ *
* @param rng Underlying source of randomness
*/
BaseStableSampler(UniformRandomProvider rng) {
@@ -307,6 +309,8 @@ public abstract class StableSampler implements SharedStateContinuousSampler {
private final double delta;
/**
+ * Constructs a new instance.
+ *
* @param sampler Normalized stable sampler.
* @param gamma Scale parameter. Must be strictly positive.
* @param delta Location parameter.
@@ -352,6 +356,8 @@ public abstract class StableSampler implements SharedStateContinuousSampler {
private final double mean;
/**
+ * Constructs a new instance.
+ *
* @param rng Underlying source of randomness
* @param gamma Scale parameter. Must be strictly positive.
* @param delta Location parameter.
@@ -367,6 +373,8 @@ public abstract class StableSampler implements SharedStateContinuousSampler {
}
/**
+ * Constructs a new instance.
+ *
* @param rng Underlying source of randomness
* @param source Source to copy.
*/
@@ -399,6 +407,8 @@ public abstract class StableSampler implements SharedStateContinuousSampler {
private final double delta;
/**
+ * Constructs a new instance.
+ *
* @param rng Underlying source of randomness
* @param gamma Scale parameter. Must be strictly positive.
* @param delta Location parameter.
@@ -410,6 +420,8 @@ public abstract class StableSampler implements SharedStateContinuousSampler {
}
/**
+ * Constructs a new instance.
+ *
* @param rng Underlying source of randomness
* @param source Source to copy.
*/
@@ -456,6 +468,8 @@ public abstract class StableSampler implements SharedStateContinuousSampler {
private final double delta;
/**
+ * Constructs a new instance.
+ *
* @param rng Underlying source of randomness
* @param gamma Scale parameter. Must be strictly positive.
* @param delta Location parameter.
@@ -468,6 +482,8 @@ public abstract class StableSampler implements SharedStateContinuousSampler {
}
/**
+ * Constructs a new instance.
+ *
* @param rng Underlying source of randomness
* @param source Source to copy.
*/
@@ -539,6 +555,8 @@ public abstract class StableSampler implements SharedStateContinuousSampler {
protected final double upper;
/**
+ * Constructs a new instance.
+ *
* @param rng Underlying source of randomness
* @param alpha Stability parameter. Must be in the interval {@code (0, 2]}.
* @param beta Skewness parameter. Must be in the interval {@code [-1, 1]}.
@@ -591,6 +609,8 @@ public abstract class StableSampler implements SharedStateContinuousSampler {
}
/**
+ * Constructs a new instance.
+ *
* @param rng Underlying source of randomness
* @param source Source to copy.
*/
@@ -725,6 +745,8 @@ public abstract class StableSampler implements SharedStateContinuousSampler {
private final double tau;
/**
+ * Constructs a new instance.
+ *
* @param rng Underlying source of randomness
* @param alpha Stability parameter. Must be in the interval {@code (0, 2]}.
* @param beta Skewness parameter. Must be in the interval {@code [-1, 1]}.
@@ -737,6 +759,8 @@ public abstract class StableSampler implements SharedStateContinuousSampler {
}
/**
+ * Constructs a new instance.
+ *
* @param rng Underlying source of randomness
* @param source Source to copy.
*/
@@ -884,6 +908,8 @@ public abstract class StableSampler implements SharedStateContinuousSampler {
private final double tau;
/**
+ * Constructs a new instance.
+ *
* @param rng Underlying source of randomness
* @param beta Skewness parameter. Must be in the interval {@code [-1, 1]}.
*/
@@ -893,6 +919,8 @@ public abstract class StableSampler implements SharedStateContinuousSampler {
}
/**
+ * Constructs a new instance.
+ *
* @param rng Underlying source of randomness
* @param source Source to copy.
*/
@@ -962,6 +990,8 @@ public abstract class StableSampler implements SharedStateContinuousSampler {
protected final double epsDiv1mEps;
/**
+ * Constructs a new instance.
+ *
* @param rng Underlying source of randomness
* @param alpha Stability parameter. Must be in the interval {@code (0, 2]}.
*/
@@ -974,6 +1004,8 @@ public abstract class StableSampler implements SharedStateContinuousSampler {
}
/**
+ * Constructs a new instance.
+ *
* @param rng Underlying source of randomness
* @param source Source to copy.
*/
@@ -1041,6 +1073,8 @@ public abstract class StableSampler implements SharedStateContinuousSampler {
*/
static class Beta0CMSStableSampler extends Beta0WeronStableSampler {
/**
+ * Constructs a new instance.
+ *
* @param rng Underlying source of randomness
* @param alpha Stability parameter. Must be in the interval {@code (0, 2]}.
*/
@@ -1049,6 +1083,8 @@ public abstract class StableSampler implements SharedStateContinuousSampler {
}
/**
+ * Constructs a new instance.
+ *
* @param rng Underlying source of randomness
* @param source Source to copy.
*/
@@ -1259,6 +1295,8 @@ public abstract class StableSampler implements SharedStateContinuousSampler {
}
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
*/
StableSampler(UniformRandomProvider rng) {
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/TSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/TSampler.java
index 8ad74a41..a209752a 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/TSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/TSampler.java
@@ -63,6 +63,8 @@ public abstract class TSampler implements SharedStateContinuousSampler {
private final DoubleUnaryOperator powm1;
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param v Degrees of freedom.
*/
@@ -82,6 +84,8 @@ public abstract class TSampler implements SharedStateContinuousSampler {
}
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param source Source to copy.
*/
@@ -148,6 +152,8 @@ public abstract class TSampler implements SharedStateContinuousSampler {
private final NormalizedGaussianSampler sampler;
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
*/
NormalTSampler(UniformRandomProvider rng) {
@@ -170,6 +176,8 @@ public abstract class TSampler implements SharedStateContinuousSampler {
}
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
*/
TSampler(UniformRandomProvider rng) {
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/UniformLongSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/UniformLongSampler.java
index 04409151..f9a14805 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/UniformLongSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/UniformLongSampler.java
@@ -43,6 +43,8 @@ public abstract class UniformLongSampler implements SharedStateLongSampler {
private final long value;
/**
+ * Constructs a new instance.
+ *
* @param value The value.
*/
FixedUniformLongSampler(long value) {
@@ -81,6 +83,8 @@ public abstract class UniformLongSampler implements SharedStateLongSampler {
private final int shift;
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param range Maximum range of the sample (exclusive).
* Must be a power of 2 greater than 2^0.
@@ -92,6 +96,8 @@ public abstract class UniformLongSampler implements SharedStateLongSampler {
}
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param source Source to copy.
*/
@@ -130,6 +136,8 @@ public abstract class UniformLongSampler implements SharedStateLongSampler {
private final long limit;
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param range Maximum range of the sample (exclusive).
*/
@@ -152,6 +160,8 @@ public abstract class UniformLongSampler implements SharedStateLongSampler {
}
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param source Source to copy.
*/
@@ -195,6 +205,8 @@ public abstract class UniformLongSampler implements SharedStateLongSampler {
private final long upper;
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param lower Lower bound (inclusive) of the distribution.
* @param upper Upper bound (inclusive) of the distribution.
@@ -238,6 +250,8 @@ public abstract class UniformLongSampler implements SharedStateLongSampler {
private final UniformLongSampler sampler;
/**
+ * Constructs a new instance.
+ *
* @param offset The offset for the sample.
* @param sampler The discrete sampler.
*/
@@ -266,6 +280,8 @@ public abstract class UniformLongSampler implements SharedStateLongSampler {
}
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
*/
UniformLongSampler(UniformRandomProvider rng) {
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/ZigguratSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/ZigguratSampler.java
index 600e96f0..e48d2c0d 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/ZigguratSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/ZigguratSampler.java
@@ -538,6 +538,8 @@ public abstract class ZigguratSampler implements SharedStateContinuousSampler {
private final double mean;
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
* @param mean Mean.
*/
@@ -558,6 +560,8 @@ public abstract class ZigguratSampler implements SharedStateContinuousSampler {
}
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
*/
Exponential(UniformRandomProvider rng) {
@@ -1036,6 +1040,8 @@ public abstract class ZigguratSampler implements SharedStateContinuousSampler {
private final SharedStateContinuousSampler exponential;
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
*/
private NormalizedGaussian(UniformRandomProvider rng) {
@@ -1191,6 +1197,8 @@ public abstract class ZigguratSampler implements SharedStateContinuousSampler {
}
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers.
*/
ZigguratSampler(UniformRandomProvider rng) {
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/shape/BoxSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/shape/BoxSampler.java
index d93efa4d..ef54a788 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/shape/BoxSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/shape/BoxSampler.java
@@ -61,6 +61,8 @@ public abstract class BoxSampler implements SharedStateObjectSampler<double[]> {
private final double by;
/**
+ * Constructs a new instance.
+ *
* @param rng Source of randomness.
* @param a Bound a.
* @param b Bound b.
@@ -74,6 +76,8 @@ public abstract class BoxSampler implements SharedStateObjectSampler<double[]> {
}
/**
+ * Constructs a new instance.
+ *
* @param rng Source of randomness.
* @param source Source to copy.
*/
@@ -116,6 +120,8 @@ public abstract class BoxSampler implements SharedStateObjectSampler<double[]> {
private final double bz;
/**
+ * Constructs a new instance.
+ *
* @param rng Source of randomness.
* @param a Bound a.
* @param b Bound b.
@@ -131,6 +137,8 @@ public abstract class BoxSampler implements SharedStateObjectSampler<double[]> {
}
/**
+ * Constructs a new instance.
+ *
* @param rng Source of randomness.
* @param source Source to copy.
*/
@@ -167,6 +175,8 @@ public abstract class BoxSampler implements SharedStateObjectSampler<double[]> {
private final double[] b;
/**
+ * Constructs a new instance.
+ *
* @param rng Source of randomness.
* @param a Bound a.
* @param b Bound b.
@@ -179,6 +189,8 @@ public abstract class BoxSampler implements SharedStateObjectSampler<double[]> {
}
/**
+ * Constructs a new instance.
+ *
* @param rng Source of randomness.
* @param source Source to copy.
*/
@@ -205,6 +217,8 @@ public abstract class BoxSampler implements SharedStateObjectSampler<double[]> {
}
/**
+ * Constructs a new instance.
+ *
* @param rng Source of randomness.
*/
BoxSampler(UniformRandomProvider rng) {
@@ -212,6 +226,8 @@ public abstract class BoxSampler implements SharedStateObjectSampler<double[]> {
}
/**
+ * {@inheritDoc}
+ *
* @return a random Cartesian coordinate within the box.
*/
@Override
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/shape/LineSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/shape/LineSampler.java
index 830b83ba..cbb30776 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/shape/LineSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/shape/LineSampler.java
@@ -62,6 +62,8 @@ public abstract class LineSampler implements SharedStateObjectSampler<double[]>
private final double bx;
/**
+ * Constructs a new instance.
+ *
* @param rng Source of randomness.
* @param a The first vertex.
* @param b The second vertex.
@@ -73,6 +75,8 @@ public abstract class LineSampler implements SharedStateObjectSampler<double[]>
}
/**
+ * Constructs a new instance.
+ *
* @param rng Source of randomness.
* @param source Source to copy.
*/
@@ -108,6 +112,8 @@ public abstract class LineSampler implements SharedStateObjectSampler<double[]>
private final double by;
/**
+ * Constructs a new instance.
+ *
* @param rng Source of randomness.
* @param a The first vertex.
* @param b The second vertex.
@@ -121,6 +127,8 @@ public abstract class LineSampler implements SharedStateObjectSampler<double[]>
}
/**
+ * Constructs a new instance.
+ *
* @param rng Source of randomness.
* @param source Source to copy.
*/
@@ -163,6 +171,8 @@ public abstract class LineSampler implements SharedStateObjectSampler<double[]>
private final double bz;
/**
+ * Constructs a new instance.
+ *
* @param rng Source of randomness.
* @param a The first vertex.
* @param b The second vertex.
@@ -178,6 +188,8 @@ public abstract class LineSampler implements SharedStateObjectSampler<double[]>
}
/**
+ * Constructs a new instance.
+ *
* @param rng Source of randomness.
* @param source Source to copy.
*/
@@ -214,6 +226,8 @@ public abstract class LineSampler implements SharedStateObjectSampler<double[]>
private final double[] b;
/**
+ * Constructs a new instance.
+ *
* @param rng Source of randomness.
* @param a The first vertex.
* @param b The second vertex.
@@ -226,6 +240,8 @@ public abstract class LineSampler implements SharedStateObjectSampler<double[]>
}
/**
+ * Constructs a new instance.
+ *
* @param rng Source of randomness.
* @param source Source to copy.
*/
@@ -252,6 +268,8 @@ public abstract class LineSampler implements SharedStateObjectSampler<double[]>
}
/**
+ * Constructs a new instance.
+ *
* @param rng Source of randomness.
*/
LineSampler(UniformRandomProvider rng) {
@@ -259,6 +277,8 @@ public abstract class LineSampler implements SharedStateObjectSampler<double[]>
}
/**
+ * {@inheritDoc}
+ *
* @return a random Cartesian coordinate on the line.
*/
@Override
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/shape/TetrahedronSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/shape/TetrahedronSampler.java
index c476dc7b..3fa0dcfb 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/shape/TetrahedronSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/shape/TetrahedronSampler.java
@@ -69,6 +69,8 @@ public class TetrahedronSampler implements SharedStateObjectSampler<double[]> {
private final UniformRandomProvider rng;
/**
+ * Constructs a new instance.
+ *
* @param rng Source of randomness.
* @param a The first vertex.
* @param b The second vertex.
@@ -85,6 +87,8 @@ public class TetrahedronSampler implements SharedStateObjectSampler<double[]> {
}
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers
* @param source Source to copy.
*/
@@ -98,6 +102,8 @@ public class TetrahedronSampler implements SharedStateObjectSampler<double[]> {
}
/**
+ * {@inheritDoc}
+ *
* @return a random Cartesian point within the tetrahedron.
*/
@Override
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/shape/TriangleSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/shape/TriangleSampler.java
index ce3ed858..7710b5ec 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/shape/TriangleSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/shape/TriangleSampler.java
@@ -97,6 +97,8 @@ public abstract class TriangleSampler implements SharedStateObjectSampler<double
private final double cy;
/**
+ * Constructs a new instance.
+ *
* @param rng Source of randomness.
* @param a The first vertex.
* @param b The second vertex.
@@ -113,6 +115,8 @@ public abstract class TriangleSampler implements SharedStateObjectSampler<double
}
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers
* @param source Source to copy.
*/
@@ -163,6 +167,8 @@ public abstract class TriangleSampler implements SharedStateObjectSampler<double
private final double cz;
/**
+ * Constructs a new instance.
+ *
* @param rng Source of randomness.
* @param a The first vertex.
* @param b The second vertex.
@@ -182,6 +188,8 @@ public abstract class TriangleSampler implements SharedStateObjectSampler<double
}
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers
* @param source Source to copy.
*/
@@ -223,6 +231,8 @@ public abstract class TriangleSampler implements SharedStateObjectSampler<double
private final double[] c;
/**
+ * Constructs a new instance.
+ *
* @param rng Source of randomness.
* @param a The first vertex.
* @param b The second vertex.
@@ -237,6 +247,8 @@ public abstract class TriangleSampler implements SharedStateObjectSampler<double
}
/**
+ * Constructs a new instance.
+ *
* @param rng Generator of uniformly distributed random numbers
* @param source Source to copy.
*/
@@ -264,6 +276,8 @@ public abstract class TriangleSampler implements SharedStateObjectSampler<double
}
/**
+ * Constructs a new instance.
+ *
* @param rng Source of randomness.
*/
TriangleSampler(UniformRandomProvider rng) {
@@ -271,6 +285,8 @@ public abstract class TriangleSampler implements SharedStateObjectSampler<double
}
/**
+ * {@inheritDoc}
+ *
* @return a random Cartesian coordinate within the triangle.
*/
@Override
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/shape/UnitBallSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/shape/UnitBallSampler.java
index c7c12565..6f189359 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/shape/UnitBallSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/shape/UnitBallSampler.java
@@ -59,6 +59,8 @@ public abstract class UnitBallSampler implements SharedStateObjectSampler<double
private final UniformRandomProvider rng;
/**
+ * Constructs a new instance.
+ *
* @param rng Source of randomness.
*/
UnitBallSampler1D(UniformRandomProvider rng) {
@@ -84,6 +86,8 @@ public abstract class UnitBallSampler implements SharedStateObjectSampler<double
private final UniformRandomProvider rng;
/**
+ * Constructs a new instance.
+ *
* @param rng Source of randomness.
*/
UnitBallSampler2D(UniformRandomProvider rng) {
@@ -120,6 +124,8 @@ public abstract class UnitBallSampler implements SharedStateObjectSampler<double
private final ContinuousSampler exp;
/**
+ * Constructs a new instance.
+ *
* @param rng Source of randomness.
*/
UnitBallSampler3D(UniformRandomProvider rng) {
@@ -163,6 +169,8 @@ public abstract class UnitBallSampler implements SharedStateObjectSampler<double
private final ContinuousSampler exp;
/**
+ * Constructs a new instance.
+ *
* @param rng Source of randomness.
* @param dimension Space dimension.
*/
@@ -207,6 +215,8 @@ public abstract class UnitBallSampler implements SharedStateObjectSampler<double
public UnitBallSampler() {}
/**
+ * {@inheritDoc}
+ *
* @return a random Cartesian coordinate within the unit n-ball.
*/
@Override
diff --git a/commons-rng-simple/src/main/java/org/apache/commons/rng/simple/RandomSource.java b/commons-rng-simple/src/main/java/org/apache/commons/rng/simple/RandomSource.java
index 0749021d..5f3f624e 100644
--- a/commons-rng-simple/src/main/java/org/apache/commons/rng/simple/RandomSource.java
+++ b/commons-rng-simple/src/main/java/org/apache/commons/rng/simple/RandomSource.java
@@ -693,6 +693,8 @@ public enum RandomSource {
private final ProviderBuilder.RandomSourceInternal internalIdentifier;
/**
+ * Constructs a new instance.
+ *
* @param id Internal identifier.
*/
RandomSource(ProviderBuilder.RandomSourceInternal id) {
@@ -700,6 +702,8 @@ public enum RandomSource {
}
/**
+ * Gets the internal identifier.
+ *
* @return the internal identifier.
*/
ProviderBuilder.RandomSourceInternal getInternalIdentifier() {
diff --git a/commons-rng-simple/src/main/java/org/apache/commons/rng/simple/internal/SeedUtils.java b/commons-rng-simple/src/main/java/org/apache/commons/rng/simple/internal/SeedUtils.java
index 2575a8aa..3553f1d4 100644
--- a/commons-rng-simple/src/main/java/org/apache/commons/rng/simple/internal/SeedUtils.java
+++ b/commons-rng-simple/src/main/java/org/apache/commons/rng/simple/internal/SeedUtils.java
@@ -59,6 +59,8 @@ final class SeedUtils {
private int counter;
/**
+ * Constructs a new instance.
+ *
* @param rng Source of randomness.
*/
UnsignedByteProvider(UniformRandomProvider rng) {
diff --git a/src/conf/checkstyle/checkstyle.xml b/src/conf/checkstyle/checkstyle.xml
index 66161d38..c7a40ce7 100644
--- a/src/conf/checkstyle/checkstyle.xml
+++ b/src/conf/checkstyle/checkstyle.xml
@@ -92,6 +92,7 @@
<module name="JavadocMethod" />
<module name="JavadocType" />
<module name="JavadocVariable" />
+ <module name="SummaryJavadoc" />
<module name="MissingJavadocMethod">
<property name="scope" value="private"/>
</module>