You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by ki...@apache.org on 2017/05/10 09:14:11 UTC

[math] Fix all PMD issues (missing Javadocs for class fields)

Repository: commons-math
Updated Branches:
  refs/heads/master 1b80dc496 -> 5d87a8895


Fix all PMD issues (missing Javadocs for class fields)


Project: http://git-wip-us.apache.org/repos/asf/commons-math/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-math/commit/5d87a889
Tree: http://git-wip-us.apache.org/repos/asf/commons-math/tree/5d87a889
Diff: http://git-wip-us.apache.org/repos/asf/commons-math/diff/5d87a889

Branch: refs/heads/master
Commit: 5d87a8895298058c573d39f6c482a80a84919ff3
Parents: 1b80dc4
Author: Bruno P. Kinoshita <br...@yahoo.com.br>
Authored: Wed May 10 21:13:58 2017 +1200
Committer: Bruno P. Kinoshita <br...@yahoo.com.br>
Committed: Wed May 10 21:13:58 2017 +1200

----------------------------------------------------------------------
 .../commons/math4/distribution/AbstractIntegerDistribution.java   | 3 +++
 .../commons/math4/distribution/AbstractRealDistribution.java      | 3 +++
 .../org/apache/commons/math4/distribution/BetaDistribution.java   | 3 +++
 .../commons/math4/distribution/ExponentialDistribution.java       | 3 +++
 .../org/apache/commons/math4/distribution/GammaDistribution.java  | 3 +++
 .../apache/commons/math4/distribution/LogNormalDistribution.java  | 3 +++
 .../org/apache/commons/math4/distribution/NormalDistribution.java | 3 +++
 .../org/apache/commons/math4/distribution/ParetoDistribution.java | 3 +++
 .../apache/commons/math4/distribution/PoissonDistribution.java    | 3 +++
 .../commons/math4/distribution/UniformIntegerDistribution.java    | 3 +++
 .../commons/math4/distribution/UniformRealDistribution.java       | 3 +++
 .../org/apache/commons/math4/distribution/ZipfDistribution.java   | 3 +++
 12 files changed, 36 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/commons-math/blob/5d87a889/src/main/java/org/apache/commons/math4/distribution/AbstractIntegerDistribution.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math4/distribution/AbstractIntegerDistribution.java b/src/main/java/org/apache/commons/math4/distribution/AbstractIntegerDistribution.java
index df0bee5..add433e 100644
--- 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 abstract class AbstractIntegerDistribution implements IntegerDistribution
     @Override
     public IntegerDistribution.Sampler createSampler(final UniformRandomProvider rng) {
         return new IntegerDistribution.Sampler() {
+            /**
+             * Inversion method distribution sampler.
+             */
             private final DiscreteSampler sampler =
                 new InverseTransformDiscreteSampler(rng, createICPF());
 

http://git-wip-us.apache.org/repos/asf/commons-math/blob/5d87a889/src/main/java/org/apache/commons/math4/distribution/AbstractRealDistribution.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math4/distribution/AbstractRealDistribution.java b/src/main/java/org/apache/commons/math4/distribution/AbstractRealDistribution.java
index b2a0956..27800a6 100644
--- 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 abstract class AbstractRealDistribution
     @Override
     public RealDistribution.Sampler createSampler(final UniformRandomProvider rng) {
         return new RealDistribution.Sampler() {
+            /**
+             * Inversion method distribution sampler.
+             */
             private final ContinuousSampler sampler =
                 new InverseTransformContinuousSampler(rng, createICPF());
 

http://git-wip-us.apache.org/repos/asf/commons-math/blob/5d87a889/src/main/java/org/apache/commons/math4/distribution/BetaDistribution.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math4/distribution/BetaDistribution.java b/src/main/java/org/apache/commons/math4/distribution/BetaDistribution.java
index 025d655..aaf89d8 100644
--- 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 class BetaDistribution extends AbstractRealDistribution {
     @Override
     public RealDistribution.Sampler createSampler(final UniformRandomProvider rng) {
         return new RealDistribution.Sampler() {
+            /**
+             * Beta distribution sampler.
+             */
             private final ContinuousSampler sampler =
                 new ChengBetaSampler(rng, alpha, beta);
 

http://git-wip-us.apache.org/repos/asf/commons-math/blob/5d87a889/src/main/java/org/apache/commons/math4/distribution/ExponentialDistribution.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math4/distribution/ExponentialDistribution.java b/src/main/java/org/apache/commons/math4/distribution/ExponentialDistribution.java
index 449fb5b..6ee541c 100644
--- 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 class ExponentialDistribution extends AbstractRealDistribution {
     @Override
     public RealDistribution.Sampler createSampler(final UniformRandomProvider rng) {
         return new RealDistribution.Sampler() {
+            /**
+             * Exponential distribution sampler.
+             */
             private final ContinuousSampler sampler =
                 new AhrensDieterExponentialSampler(rng, mean);
 

http://git-wip-us.apache.org/repos/asf/commons-math/blob/5d87a889/src/main/java/org/apache/commons/math4/distribution/GammaDistribution.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math4/distribution/GammaDistribution.java b/src/main/java/org/apache/commons/math4/distribution/GammaDistribution.java
index 1f9d5ee..29ad268 100644
--- 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 class GammaDistribution extends AbstractRealDistribution {
     @Override
     public RealDistribution.Sampler createSampler(final UniformRandomProvider rng) {
         return new RealDistribution.Sampler() {
+            /**
+             * Gamma distribution sampler.
+             */
             private final ContinuousSampler sampler =
                 new AhrensDieterMarsagliaTsangGammaSampler(rng, scale, shape);
 

http://git-wip-us.apache.org/repos/asf/commons-math/blob/5d87a889/src/main/java/org/apache/commons/math4/distribution/LogNormalDistribution.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math4/distribution/LogNormalDistribution.java b/src/main/java/org/apache/commons/math4/distribution/LogNormalDistribution.java
index 67c1194..b5d4bf0 100644
--- 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 class LogNormalDistribution extends AbstractRealDistribution {
     @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);
 

http://git-wip-us.apache.org/repos/asf/commons-math/blob/5d87a889/src/main/java/org/apache/commons/math4/distribution/NormalDistribution.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math4/distribution/NormalDistribution.java b/src/main/java/org/apache/commons/math4/distribution/NormalDistribution.java
index 3de0852..da4c65c 100644
--- 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 class NormalDistribution extends AbstractRealDistribution {
     @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);

http://git-wip-us.apache.org/repos/asf/commons-math/blob/5d87a889/src/main/java/org/apache/commons/math4/distribution/ParetoDistribution.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math4/distribution/ParetoDistribution.java b/src/main/java/org/apache/commons/math4/distribution/ParetoDistribution.java
index b4bff1c..e2b350e 100644
--- 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 class ParetoDistribution extends AbstractRealDistribution {
     @Override
     public RealDistribution.Sampler createSampler(final UniformRandomProvider rng) {
         return new RealDistribution.Sampler() {
+            /**
+             * Pareto distribution sampler.
+             */
             private final ContinuousSampler sampler =
                 new InverseTransformParetoSampler(rng, scale, shape);
 

http://git-wip-us.apache.org/repos/asf/commons-math/blob/5d87a889/src/main/java/org/apache/commons/math4/distribution/PoissonDistribution.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math4/distribution/PoissonDistribution.java b/src/main/java/org/apache/commons/math4/distribution/PoissonDistribution.java
index a39a73f..ba18f1e 100644
--- 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 class PoissonDistribution extends AbstractIntegerDistribution {
     @Override
     public IntegerDistribution.Sampler createSampler(final UniformRandomProvider rng) {
         return new IntegerDistribution.Sampler() {
+            /**
+             * Poisson distribution sampler.
+             */
             private final DiscreteSampler sampler =
                 new PoissonSampler(rng, mean);
 

http://git-wip-us.apache.org/repos/asf/commons-math/blob/5d87a889/src/main/java/org/apache/commons/math4/distribution/UniformIntegerDistribution.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math4/distribution/UniformIntegerDistribution.java b/src/main/java/org/apache/commons/math4/distribution/UniformIntegerDistribution.java
index cf2a72c..83ab4f2 100644
--- 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 class UniformIntegerDistribution extends AbstractIntegerDistribution {
     @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);
 

http://git-wip-us.apache.org/repos/asf/commons-math/blob/5d87a889/src/main/java/org/apache/commons/math4/distribution/UniformRealDistribution.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math4/distribution/UniformRealDistribution.java b/src/main/java/org/apache/commons/math4/distribution/UniformRealDistribution.java
index ce1b1e0..be033e3 100644
--- 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 class UniformRealDistribution extends AbstractRealDistribution {
     @Override
     public RealDistribution.Sampler createSampler(final UniformRandomProvider rng) {
         return new RealDistribution.Sampler() {
+            /**
+             * Uniform distribution sampler.
+             */
             private final ContinuousSampler sampler =
                 new ContinuousUniformSampler(rng, lower, upper);
 

http://git-wip-us.apache.org/repos/asf/commons-math/blob/5d87a889/src/main/java/org/apache/commons/math4/distribution/ZipfDistribution.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math4/distribution/ZipfDistribution.java b/src/main/java/org/apache/commons/math4/distribution/ZipfDistribution.java
index 911e692..569d51b 100644
--- 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 class ZipfDistribution extends AbstractIntegerDistribution {
     @Override
     public IntegerDistribution.Sampler createSampler(final UniformRandomProvider rng) {
         return new IntegerDistribution.Sampler() {
+            /**
+             * Zipf distribution sampler.
+             */
             private final DiscreteSampler sampler =
                 new RejectionInversionZipfSampler(rng, numberOfElements, exponent);