Fix all PMD issues (missing Javadocs for class fields)

apache · May 10, 2017 · 5d87a88 · 5d87a88
1 parent 1b80dc4
commit 5d87a88
Show file tree

Hide file tree

Showing 12 changed files with 36 additions and 0 deletions.
diff --git a/src/main/java/org/apache/commons/math4/distribution/AbstractIntegerDistribution.java b/src/main/java/org/apache/commons/math4/distribution/AbstractIntegerDistribution.java
@@ -198,6 +198,9 @@ public static int[] sample(int n,
     @Override
     public IntegerDistribution.Sampler createSampler(final UniformRandomProvider rng) {
         return new IntegerDistribution.Sampler() {
+            /**
+             * Inversion method distribution sampler.
+             */
             private final DiscreteSampler sampler =
                 new InverseTransformDiscreteSampler(rng, createICPF());
 

diff --git a/src/main/java/org/apache/commons/math4/distribution/AbstractRealDistribution.java b/src/main/java/org/apache/commons/math4/distribution/AbstractRealDistribution.java
@@ -246,6 +246,9 @@ public static double[] sample(int n,
     @Override
     public RealDistribution.Sampler createSampler(final UniformRandomProvider rng) {
         return new RealDistribution.Sampler() {
+            /**
+             * Inversion method distribution sampler.
+             */
             private final ContinuousSampler sampler =
                 new InverseTransformContinuousSampler(rng, createICPF());
 

diff --git a/src/main/java/org/apache/commons/math4/distribution/BetaDistribution.java b/src/main/java/org/apache/commons/math4/distribution/BetaDistribution.java
@@ -229,6 +229,9 @@ public boolean isSupportConnected() {
     @Override
     public RealDistribution.Sampler createSampler(final UniformRandomProvider rng) {
         return new RealDistribution.Sampler() {
+            /**
+             * Beta distribution sampler.
+             */
             private final ContinuousSampler sampler =
                 new ChengBetaSampler(rng, alpha, beta);
 

diff --git a/src/main/java/org/apache/commons/math4/distribution/ExponentialDistribution.java b/src/main/java/org/apache/commons/math4/distribution/ExponentialDistribution.java
@@ -219,6 +219,9 @@ public boolean isSupportConnected() {
     @Override
     public RealDistribution.Sampler createSampler(final UniformRandomProvider rng) {
         return new RealDistribution.Sampler() {
+            /**
+             * Exponential distribution sampler.
+             */
             private final ContinuousSampler sampler =
                 new AhrensDieterExponentialSampler(rng, mean);
 

diff --git a/src/main/java/org/apache/commons/math4/distribution/GammaDistribution.java b/src/main/java/org/apache/commons/math4/distribution/GammaDistribution.java
@@ -379,6 +379,9 @@ public boolean isSupportConnected() {
     @Override
     public RealDistribution.Sampler createSampler(final UniformRandomProvider rng) {
         return new RealDistribution.Sampler() {
+            /**
+             * Gamma distribution sampler.
+             */
             private final ContinuousSampler sampler =
                 new AhrensDieterMarsagliaTsangGammaSampler(rng, scale, shape);
 

diff --git a/src/main/java/org/apache/commons/math4/distribution/LogNormalDistribution.java b/src/main/java/org/apache/commons/math4/distribution/LogNormalDistribution.java
@@ -294,6 +294,9 @@ public boolean isSupportConnected() {
     @Override
     public RealDistribution.Sampler createSampler(final UniformRandomProvider rng) {
         return new RealDistribution.Sampler() {
+            /**
+             * Log normal distribution sampler.
+             */
             private final ContinuousSampler sampler =
                 new MarsagliaLogNormalSampler(rng, scale, shape);
 

diff --git a/src/main/java/org/apache/commons/math4/distribution/NormalDistribution.java b/src/main/java/org/apache/commons/math4/distribution/NormalDistribution.java
@@ -242,6 +242,9 @@ public boolean isSupportConnected() {
     @Override
     public RealDistribution.Sampler createSampler(final UniformRandomProvider rng) {
         return new RealDistribution.Sampler() {
+            /**
+             * Gaussian distribution sampler.
+             */
             private final ContinuousSampler sampler =
                 new GaussianSampler(new MarsagliaNormalizedGaussianSampler(rng),
                                     mean, standardDeviation);

diff --git a/src/main/java/org/apache/commons/math4/distribution/ParetoDistribution.java b/src/main/java/org/apache/commons/math4/distribution/ParetoDistribution.java
@@ -253,6 +253,9 @@ public boolean isSupportConnected() {
     @Override
     public RealDistribution.Sampler createSampler(final UniformRandomProvider rng) {
         return new RealDistribution.Sampler() {
+            /**
+             * Pareto distribution sampler.
+             */
             private final ContinuousSampler sampler =
                 new InverseTransformParetoSampler(rng, scale, shape);
 

diff --git a/src/main/java/org/apache/commons/math4/distribution/PoissonDistribution.java b/src/main/java/org/apache/commons/math4/distribution/PoissonDistribution.java
@@ -249,6 +249,9 @@ public boolean isSupportConnected() {
     @Override
     public IntegerDistribution.Sampler createSampler(final UniformRandomProvider rng) {
         return new IntegerDistribution.Sampler() {
+            /**
+             * Poisson distribution sampler.
+             */
             private final DiscreteSampler sampler =
                 new PoissonSampler(rng, mean);
 

diff --git a/src/main/java/org/apache/commons/math4/distribution/UniformIntegerDistribution.java b/src/main/java/org/apache/commons/math4/distribution/UniformIntegerDistribution.java
@@ -149,6 +149,9 @@ public boolean isSupportConnected() {
     @Override
     public IntegerDistribution.Sampler createSampler(final UniformRandomProvider rng) {
         return new IntegerDistribution.Sampler() {
+            /**
+             * Discrete uniform distribution sampler.
+             */
             private final DiscreteSampler sampler =
                 new DiscreteUniformSampler(rng, lower, upper);
 

diff --git a/src/main/java/org/apache/commons/math4/distribution/UniformRealDistribution.java b/src/main/java/org/apache/commons/math4/distribution/UniformRealDistribution.java
@@ -164,6 +164,9 @@ public boolean isSupportConnected() {
     @Override
     public RealDistribution.Sampler createSampler(final UniformRandomProvider rng) {
         return new RealDistribution.Sampler() {
+            /**
+             * Uniform distribution sampler.
+             */
             private final ContinuousSampler sampler =
                 new ContinuousUniformSampler(rng, lower, upper);
 

diff --git a/src/main/java/org/apache/commons/math4/distribution/ZipfDistribution.java b/src/main/java/org/apache/commons/math4/distribution/ZipfDistribution.java
@@ -262,6 +262,9 @@ public boolean isSupportConnected() {
     @Override
     public IntegerDistribution.Sampler createSampler(final UniformRandomProvider rng) {
         return new IntegerDistribution.Sampler() {
+            /**
+             * Zipf distribution sampler.
+             */
             private final DiscreteSampler sampler =
                 new RejectionInversionZipfSampler(rng, numberOfElements, exponent);