commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From l..@apache.org
Subject [5/7] [math] Added missing javadoc.
Date Tue, 03 Nov 2015 20:37:11 GMT
Added missing javadoc.

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

Branch: refs/heads/MATH_3_X
Commit: 85dd630c0c9928cb311db00ed8f22907ab7d43cd
Parents: 99cbfc2
Author: Luc Maisonobe <luc@apache.org>
Authored: Tue Nov 3 20:52:28 2015 +0100
Committer: Luc Maisonobe <luc@apache.org>
Committed: Tue Nov 3 20:52:28 2015 +0100

----------------------------------------------------------------------
 .../commons/math3/analysis/FunctionUtils.java   |  2 ++
 .../IterativeLegendreGaussIntegrator.java       |  1 +
 .../interpolation/BicubicInterpolator.java      |  1 +
 .../BicubicSplineInterpolatingFunction.java     |  5 +++++
 .../interpolation/TricubicInterpolator.java     |  1 +
 .../UnivariatePeriodicInterpolator.java         |  1 +
 .../analysis/polynomials/PolynomialsUtils.java  |  1 +
 .../distribution/AbstractRealDistribution.java  |  2 +-
 .../distribution/ConstantRealDistribution.java  |  1 +
 .../math3/distribution/GumbelDistribution.java  |  1 +
 .../math3/distribution/LaplaceDistribution.java |  1 +
 .../distribution/LogisticDistribution.java      |  1 +
 .../distribution/NakagamiDistribution.java      |  1 +
 .../distribution/TriangularDistribution.java    |  1 +
 .../distribution/UniformRealDistribution.java   |  1 +
 .../math3/fitting/AbstractCurveFitter.java      |  1 +
 .../commons/math3/fitting/CurveFitter.java      |  1 +
 .../math3/fitting/GaussianCurveFitter.java      |  3 +++
 .../commons/math3/fitting/GaussianFitter.java   |  3 +++
 .../leastsquares/GaussNewtonOptimizer.java      |  1 +
 .../leastsquares/LeastSquaresFactory.java       |  3 +++
 .../math3/genetics/AbstractListChromosome.java  |  1 +
 .../math3/genetics/BinaryChromosome.java        |  1 +
 .../commons/math3/genetics/ChromosomePair.java  |  1 +
 .../commons/math3/genetics/RandomKey.java       |  1 +
 .../math3/genetics/TournamentSelection.java     |  1 +
 .../math3/geometry/euclidean/twod/Line.java     | 22 ++++++++++++++++----
 .../euclidean/twod/hull/MonotoneChain.java      |  2 ++
 .../geometry/partitioning/AbstractRegion.java   |  1 +
 .../evaluation/SumOfClusterVariances.java       |  1 +
 .../commons/math3/ode/events/EventState.java    |  1 +
 .../math3/optim/linear/LinearConstraint.java    |  2 ++
 .../optim/linear/LinearObjectiveFunction.java   |  2 ++
 .../math3/optim/linear/Relationship.java        |  1 +
 .../math3/optim/linear/SimplexTableau.java      |  2 ++
 .../optim/nonlinear/scalar/LineSearch.java      |  1 +
 .../scalar/MultiStartMultivariateOptimizer.java |  1 +
 .../scalar/noderiv/BOBYQAOptimizer.java         | 15 ++++++++++++-
 .../scalar/noderiv/SimplexOptimizer.java        |  2 ++
 .../MultiStartMultivariateVectorOptimizer.java  |  3 +++
 .../MultiStartUnivariateOptimizer.java          |  1 +
 .../BaseMultivariateMultiStartOptimizer.java    |  1 +
 ...seMultivariateVectorMultiStartOptimizer.java |  1 +
 .../optimization/direct/BOBYQAOptimizer.java    | 15 ++++++++++++-
 .../optimization/direct/PowellOptimizer.java    |  1 +
 .../optimization/direct/SimplexOptimizer.java   |  2 ++
 .../math3/optimization/fitting/CurveFitter.java |  1 +
 .../optimization/fitting/GaussianFitter.java    |  3 +++
 .../optimization/linear/LinearConstraint.java   |  2 ++
 .../linear/LinearObjectiveFunction.java         |  2 ++
 .../math3/optimization/linear/Relationship.java |  1 +
 .../optimization/linear/SimplexTableau.java     |  2 ++
 .../UnivariateMultiStartOptimizer.java          |  1 +
 .../org/apache/commons/math3/special/Beta.java  |  2 ++
 .../org/apache/commons/math3/special/Gamma.java |  2 ++
 .../stat/correlation/KendallsCorrelation.java   |  1 +
 .../descriptive/rank/PSquarePercentile.java     |  1 +
 .../apache/commons/math3/util/MathArrays.java   |  2 ++
 .../org/apache/commons/math3/util/Pair.java     |  1 +
 59 files changed, 129 insertions(+), 7 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/analysis/FunctionUtils.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/analysis/FunctionUtils.java b/src/main/java/org/apache/commons/math3/analysis/FunctionUtils.java
index 2bc1c48..d7f9d70 100644
--- a/src/main/java/org/apache/commons/math3/analysis/FunctionUtils.java
+++ b/src/main/java/org/apache/commons/math3/analysis/FunctionUtils.java
@@ -559,6 +559,7 @@ public class FunctionUtils {
                 };
             }
 
+            /** {@inheritDoc} */
             public MultivariateVectorFunction gradient() {
                 return new MultivariateVectorFunction() {
                     /** {@inheritDoc} */
@@ -680,6 +681,7 @@ public class FunctionUtils {
                 return f.value(x);
             }
 
+            /** {@inheritDoc} */
             public MultivariateMatrixFunction jacobian() {
                 return new MultivariateMatrixFunction() {
                     /** {@inheritDoc} */

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/analysis/integration/IterativeLegendreGaussIntegrator.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/analysis/integration/IterativeLegendreGaussIntegrator.java b/src/main/java/org/apache/commons/math3/analysis/integration/IterativeLegendreGaussIntegrator.java
index b7c6b81..86be02c 100644
--- a/src/main/java/org/apache/commons/math3/analysis/integration/IterativeLegendreGaussIntegrator.java
+++ b/src/main/java/org/apache/commons/math3/analysis/integration/IterativeLegendreGaussIntegrator.java
@@ -158,6 +158,7 @@ public class IterativeLegendreGaussIntegrator
         throws TooManyEvaluationsException {
         // Function to be integrated is stored in the base class.
         final UnivariateFunction f = new UnivariateFunction() {
+                /** {@inheritDoc} */
                 public double value(double x)
                     throws MathIllegalArgumentException, TooManyEvaluationsException {
                     return computeObjectiveValue(x);

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/analysis/interpolation/BicubicInterpolator.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/analysis/interpolation/BicubicInterpolator.java b/src/main/java/org/apache/commons/math3/analysis/interpolation/BicubicInterpolator.java
index 82ab44e..4aebdff 100644
--- a/src/main/java/org/apache/commons/math3/analysis/interpolation/BicubicInterpolator.java
+++ b/src/main/java/org/apache/commons/math3/analysis/interpolation/BicubicInterpolator.java
@@ -96,6 +96,7 @@ public class BicubicInterpolator
         // Create the interpolating function.
         return new BicubicInterpolatingFunction(xval, yval, fval,
                                                 dFdX, dFdY, d2FdXdY) {
+            /** {@inheritDoc} */
             @Override
             public boolean isValidPoint(double x, double y) {
                 if (x < xval[1] ||

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/analysis/interpolation/BicubicSplineInterpolatingFunction.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/analysis/interpolation/BicubicSplineInterpolatingFunction.java b/src/main/java/org/apache/commons/math3/analysis/interpolation/BicubicSplineInterpolatingFunction.java
index 7056094..8f1771a 100644
--- a/src/main/java/org/apache/commons/math3/analysis/interpolation/BicubicSplineInterpolatingFunction.java
+++ b/src/main/java/org/apache/commons/math3/analysis/interpolation/BicubicSplineInterpolatingFunction.java
@@ -497,6 +497,7 @@ class BicubicSplineFunction implements BivariateFunction {
             }
 
             partialDerivativeX = new BivariateFunction() {
+                    /** {@inheritDoc} */
                     public double value(double x, double y)  {
                         final double x2 = x * x;
                         final double[] pX = {0, 1, x, x2};
@@ -509,6 +510,7 @@ class BicubicSplineFunction implements BivariateFunction {
                     }
                 };
             partialDerivativeY = new BivariateFunction() {
+                    /** {@inheritDoc} */
                     public double value(double x, double y)  {
                         final double x2 = x * x;
                         final double x3 = x2 * x;
@@ -521,6 +523,7 @@ class BicubicSplineFunction implements BivariateFunction {
                     }
                 };
             partialDerivativeXX = new BivariateFunction() {
+                    /** {@inheritDoc} */
                     public double value(double x, double y)  {
                         final double[] pX = {0, 0, 1, x};
 
@@ -532,6 +535,7 @@ class BicubicSplineFunction implements BivariateFunction {
                     }
                 };
             partialDerivativeYY = new BivariateFunction() {
+                    /** {@inheritDoc} */
                     public double value(double x, double y)  {
                         final double x2 = x * x;
                         final double x3 = x2 * x;
@@ -543,6 +547,7 @@ class BicubicSplineFunction implements BivariateFunction {
                     }
                 };
             partialDerivativeXY = new BivariateFunction() {
+                    /** {@inheritDoc} */
                     public double value(double x, double y)  {
                         final double x2 = x * x;
                         final double[] pX = {0, 1, x, x2};

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/analysis/interpolation/TricubicInterpolator.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/analysis/interpolation/TricubicInterpolator.java b/src/main/java/org/apache/commons/math3/analysis/interpolation/TricubicInterpolator.java
index 531e736..ec9e3bb 100644
--- a/src/main/java/org/apache/commons/math3/analysis/interpolation/TricubicInterpolator.java
+++ b/src/main/java/org/apache/commons/math3/analysis/interpolation/TricubicInterpolator.java
@@ -124,6 +124,7 @@ public class TricubicInterpolator
                                                  dFdX, dFdY, dFdZ,
                                                  d2FdXdY, d2FdXdZ, d2FdYdZ,
                                                  d3FdXdYdZ) {
+            /** {@inheritDoc} */
             @Override
             public boolean isValidPoint(double x, double y, double z) {
                 if (x < xval[1] ||

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/analysis/interpolation/UnivariatePeriodicInterpolator.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/analysis/interpolation/UnivariatePeriodicInterpolator.java b/src/main/java/org/apache/commons/math3/analysis/interpolation/UnivariatePeriodicInterpolator.java
index 6b788b1..88760f5 100644
--- a/src/main/java/org/apache/commons/math3/analysis/interpolation/UnivariatePeriodicInterpolator.java
+++ b/src/main/java/org/apache/commons/math3/analysis/interpolation/UnivariatePeriodicInterpolator.java
@@ -115,6 +115,7 @@ public class UnivariatePeriodicInterpolator
 
         final UnivariateFunction f = interpolator.interpolate(x, y);
         return new UnivariateFunction() {
+            /** {@inheritDoc} */
             public double value(final double x) throws MathIllegalArgumentException {
                 return f.value(MathUtils.reduce(x, period, offset));
             }

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/analysis/polynomials/PolynomialsUtils.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/analysis/polynomials/PolynomialsUtils.java b/src/main/java/org/apache/commons/math3/analysis/polynomials/PolynomialsUtils.java
index 3f7cfec..5604149 100644
--- a/src/main/java/org/apache/commons/math3/analysis/polynomials/PolynomialsUtils.java
+++ b/src/main/java/org/apache/commons/math3/analysis/polynomials/PolynomialsUtils.java
@@ -104,6 +104,7 @@ public class PolynomialsUtils {
     public static PolynomialFunction createChebyshevPolynomial(final int degree) {
         return buildPolynomial(degree, CHEBYSHEV_COEFFICIENTS,
                 new RecurrenceCoefficientsGenerator() {
+            /** Fixed recurrence coefficients. */
             private final BigFraction[] coeffs = { BigFraction.ZERO, BigFraction.TWO, BigFraction.ONE };
             /** {@inheritDoc} */
             public BigFraction[] generate(int k) {

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/distribution/AbstractRealDistribution.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/distribution/AbstractRealDistribution.java b/src/main/java/org/apache/commons/math3/distribution/AbstractRealDistribution.java
index e3b1fac..fb894b6 100644
--- a/src/main/java/org/apache/commons/math3/distribution/AbstractRealDistribution.java
+++ b/src/main/java/org/apache/commons/math3/distribution/AbstractRealDistribution.java
@@ -196,7 +196,7 @@ implements RealDistribution, Serializable {
         }
 
         final UnivariateFunction toSolve = new UnivariateFunction() {
-
+            /** {@inheritDoc} */
             public double value(final double x) {
                 return cumulativeProbability(x) - p;
             }

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/distribution/ConstantRealDistribution.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/distribution/ConstantRealDistribution.java b/src/main/java/org/apache/commons/math3/distribution/ConstantRealDistribution.java
index 0dbb6aa..8f345a1 100644
--- a/src/main/java/org/apache/commons/math3/distribution/ConstantRealDistribution.java
+++ b/src/main/java/org/apache/commons/math3/distribution/ConstantRealDistribution.java
@@ -52,6 +52,7 @@ public class ConstantRealDistribution extends AbstractRealDistribution {
         return x < value ? 0 : 1;
     }
 
+    /** {@inheritDoc} */
     @Override
     public double inverseCumulativeProbability(final double p)
             throws OutOfRangeException {

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/distribution/GumbelDistribution.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/distribution/GumbelDistribution.java b/src/main/java/org/apache/commons/math3/distribution/GumbelDistribution.java
index 85dbedd..0475f1e 100644
--- a/src/main/java/org/apache/commons/math3/distribution/GumbelDistribution.java
+++ b/src/main/java/org/apache/commons/math3/distribution/GumbelDistribution.java
@@ -116,6 +116,7 @@ public class GumbelDistribution extends AbstractRealDistribution {
         return FastMath.exp(-FastMath.exp(-z));
     }
 
+    /** {@inheritDoc} */
     @Override
     public double inverseCumulativeProbability(double p) throws OutOfRangeException {
         if (p < 0.0 || p > 1.0) {

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/distribution/LaplaceDistribution.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/distribution/LaplaceDistribution.java b/src/main/java/org/apache/commons/math3/distribution/LaplaceDistribution.java
index 0514bff..6204906 100644
--- a/src/main/java/org/apache/commons/math3/distribution/LaplaceDistribution.java
+++ b/src/main/java/org/apache/commons/math3/distribution/LaplaceDistribution.java
@@ -109,6 +109,7 @@ public class LaplaceDistribution extends AbstractRealDistribution {
         }
     }
 
+    /** {@inheritDoc} */
     @Override
     public double inverseCumulativeProbability(double p) throws OutOfRangeException {
         if (p < 0.0 || p > 1.0) {

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/distribution/LogisticDistribution.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/distribution/LogisticDistribution.java b/src/main/java/org/apache/commons/math3/distribution/LogisticDistribution.java
index 59313f5..5b7520e 100644
--- a/src/main/java/org/apache/commons/math3/distribution/LogisticDistribution.java
+++ b/src/main/java/org/apache/commons/math3/distribution/LogisticDistribution.java
@@ -110,6 +110,7 @@ public class LogisticDistribution extends AbstractRealDistribution {
         return 1.0 / (1.0 + FastMath.exp(-z));
     }
 
+    /** {@inheritDoc} */
     @Override
     public double inverseCumulativeProbability(double p) throws OutOfRangeException {
         if (p < 0.0 || p > 1.0) {

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/distribution/NakagamiDistribution.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/distribution/NakagamiDistribution.java b/src/main/java/org/apache/commons/math3/distribution/NakagamiDistribution.java
index 2b1f81f..b612191 100644
--- a/src/main/java/org/apache/commons/math3/distribution/NakagamiDistribution.java
+++ b/src/main/java/org/apache/commons/math3/distribution/NakagamiDistribution.java
@@ -130,6 +130,7 @@ public class NakagamiDistribution extends AbstractRealDistribution {
         return omega;
     }
 
+    /** {@inheritDoc} */
     @Override
     protected double getSolverAbsoluteAccuracy() {
         return inverseAbsoluteAccuracy;

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/distribution/TriangularDistribution.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/distribution/TriangularDistribution.java b/src/main/java/org/apache/commons/math3/distribution/TriangularDistribution.java
index 1a81ecb..17a0232 100644
--- a/src/main/java/org/apache/commons/math3/distribution/TriangularDistribution.java
+++ b/src/main/java/org/apache/commons/math3/distribution/TriangularDistribution.java
@@ -262,6 +262,7 @@ public class TriangularDistribution extends AbstractRealDistribution {
         return true;
     }
 
+    /** {@inheritDoc} */
     @Override
     public double inverseCumulativeProbability(double p)
         throws OutOfRangeException {

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/distribution/UniformRealDistribution.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/distribution/UniformRealDistribution.java b/src/main/java/org/apache/commons/math3/distribution/UniformRealDistribution.java
index 10c7712..7786a48 100644
--- a/src/main/java/org/apache/commons/math3/distribution/UniformRealDistribution.java
+++ b/src/main/java/org/apache/commons/math3/distribution/UniformRealDistribution.java
@@ -159,6 +159,7 @@ public class UniformRealDistribution extends AbstractRealDistribution {
         return (x - lower) / (upper - lower);
     }
 
+    /** {@inheritDoc} */
     @Override
     public double inverseCumulativeProbability(final double p)
             throws OutOfRangeException {

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/fitting/AbstractCurveFitter.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/fitting/AbstractCurveFitter.java b/src/main/java/org/apache/commons/math3/fitting/AbstractCurveFitter.java
index 6f39c23..53b148b 100644
--- a/src/main/java/org/apache/commons/math3/fitting/AbstractCurveFitter.java
+++ b/src/main/java/org/apache/commons/math3/fitting/AbstractCurveFitter.java
@@ -133,6 +133,7 @@ public abstract class AbstractCurveFitter {
          */
         public MultivariateMatrixFunction getModelFunctionJacobian() {
             return new MultivariateMatrixFunction() {
+                /** {@inheritDoc} */
                 public double[][] value(double[] p) {
                     final int len = points.length;
                     final double[][] jacobian = new double[len][];

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/fitting/CurveFitter.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/fitting/CurveFitter.java b/src/main/java/org/apache/commons/math3/fitting/CurveFitter.java
index 239d9e8..5c0fb02 100644
--- a/src/main/java/org/apache/commons/math3/fitting/CurveFitter.java
+++ b/src/main/java/org/apache/commons/math3/fitting/CurveFitter.java
@@ -218,6 +218,7 @@ public class CurveFitter<T extends ParametricUnivariateFunction> {
          */
         public ModelFunctionJacobian getModelFunctionJacobian() {
             return new ModelFunctionJacobian(new MultivariateMatrixFunction() {
+                    /** {@inheritDoc} */
                     public double[][] value(double[] point) {
                         final double[][] jacobian = new double[observations.size()][];
                         int i = 0;

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/fitting/GaussianCurveFitter.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/fitting/GaussianCurveFitter.java b/src/main/java/org/apache/commons/math3/fitting/GaussianCurveFitter.java
index 9a4617b..14fed4c 100644
--- a/src/main/java/org/apache/commons/math3/fitting/GaussianCurveFitter.java
+++ b/src/main/java/org/apache/commons/math3/fitting/GaussianCurveFitter.java
@@ -72,6 +72,7 @@ import org.apache.commons.math3.util.FastMath;
 public class GaussianCurveFitter extends AbstractCurveFitter {
     /** Parametric function to be fitted. */
     private static final Gaussian.Parametric FUNCTION = new Gaussian.Parametric() {
+            /** {@inheritDoc} */
             @Override
             public double value(double x, double ... p) {
                 double v = Double.POSITIVE_INFINITY;
@@ -83,6 +84,7 @@ public class GaussianCurveFitter extends AbstractCurveFitter {
                 return v;
             }
 
+            /** {@inheritDoc} */
             @Override
             public double[] gradient(double x, double ... p) {
                 double[] v = { Double.POSITIVE_INFINITY,
@@ -249,6 +251,7 @@ public class GaussianCurveFitter extends AbstractCurveFitter {
             final List<WeightedObservedPoint> observations = new ArrayList<WeightedObservedPoint>(unsorted);
 
             final Comparator<WeightedObservedPoint> cmp = new Comparator<WeightedObservedPoint>() {
+                /** {@inheritDoc} */
                 public int compare(WeightedObservedPoint p1,
                                    WeightedObservedPoint p2) {
                     if (p1 == null && p2 == null) {

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/fitting/GaussianFitter.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/fitting/GaussianFitter.java b/src/main/java/org/apache/commons/math3/fitting/GaussianFitter.java
index 87c515b..60c6e1f 100644
--- a/src/main/java/org/apache/commons/math3/fitting/GaussianFitter.java
+++ b/src/main/java/org/apache/commons/math3/fitting/GaussianFitter.java
@@ -81,6 +81,7 @@ public class GaussianFitter extends CurveFitter<Gaussian.Parametric> {
      */
     public double[] fit(double[] initialGuess) {
         final Gaussian.Parametric f = new Gaussian.Parametric() {
+                /** {@inheritDoc} */
                 @Override
                 public double value(double x, double ... p) {
                     double v = Double.POSITIVE_INFINITY;
@@ -92,6 +93,7 @@ public class GaussianFitter extends CurveFitter<Gaussian.Parametric> {
                     return v;
                 }
 
+                /** {@inheritDoc} */
                 @Override
                 public double[] gradient(double x, double ... p) {
                     double[] v = { Double.POSITIVE_INFINITY,
@@ -183,6 +185,7 @@ public class GaussianFitter extends CurveFitter<Gaussian.Parametric> {
             final WeightedObservedPoint[] observations = unsorted.clone();
             final Comparator<WeightedObservedPoint> cmp
                 = new Comparator<WeightedObservedPoint>() {
+                /** {@inheritDoc} */
                 public int compare(WeightedObservedPoint p1,
                                    WeightedObservedPoint p2) {
                     if (p1 == null && p2 == null) {

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/fitting/leastsquares/GaussNewtonOptimizer.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/fitting/leastsquares/GaussNewtonOptimizer.java b/src/main/java/org/apache/commons/math3/fitting/leastsquares/GaussNewtonOptimizer.java
index 6c1c3e7..8157706 100644
--- a/src/main/java/org/apache/commons/math3/fitting/leastsquares/GaussNewtonOptimizer.java
+++ b/src/main/java/org/apache/commons/math3/fitting/leastsquares/GaussNewtonOptimizer.java
@@ -247,6 +247,7 @@ public class GaussNewtonOptimizer implements LeastSquaresOptimizer {
         }
     }
 
+    /** {@inheritDoc} */
     @Override
     public String toString() {
         return "GaussNewtonOptimizer{" +

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/fitting/leastsquares/LeastSquaresFactory.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/fitting/leastsquares/LeastSquaresFactory.java b/src/main/java/org/apache/commons/math3/fitting/leastsquares/LeastSquaresFactory.java
index d483c26..db1d6ea 100644
--- a/src/main/java/org/apache/commons/math3/fitting/leastsquares/LeastSquaresFactory.java
+++ b/src/main/java/org/apache/commons/math3/fitting/leastsquares/LeastSquaresFactory.java
@@ -192,6 +192,7 @@ public class LeastSquaresFactory {
                                                    final RealMatrix weights) {
         final RealMatrix weightSquareRoot = squareRoot(weights);
         return new LeastSquaresAdapter(problem) {
+            /** {@inheritDoc} */
             @Override
             public Evaluation evaluate(final RealVector point) {
                 return new DenseWeightedEvaluation(super.evaluate(point), weightSquareRoot);
@@ -226,6 +227,7 @@ public class LeastSquaresFactory {
                                                        final Incrementor counter) {
         return new LeastSquaresAdapter(problem) {
 
+            /** {@inheritDoc} */
             public Evaluation evaluate(final RealVector point) {
                 counter.incrementCount();
                 return super.evaluate(point);
@@ -244,6 +246,7 @@ public class LeastSquaresFactory {
      */
     public static ConvergenceChecker<Evaluation> evaluationChecker(final ConvergenceChecker<PointVectorValuePair> checker) {
         return new ConvergenceChecker<Evaluation>() {
+            /** {@inheritDoc} */
             public boolean converged(final int iteration,
                                      final Evaluation previous,
                                      final Evaluation current) {

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/genetics/AbstractListChromosome.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/genetics/AbstractListChromosome.java b/src/main/java/org/apache/commons/math3/genetics/AbstractListChromosome.java
index 60450ba..0cb6b0c 100644
--- a/src/main/java/org/apache/commons/math3/genetics/AbstractListChromosome.java
+++ b/src/main/java/org/apache/commons/math3/genetics/AbstractListChromosome.java
@@ -98,6 +98,7 @@ public abstract class AbstractListChromosome<T> extends Chromosome {
      */
     public abstract AbstractListChromosome<T> newFixedLengthChromosome(final List<T> chromosomeRepresentation);
 
+    /** {@inheritDoc} */
     @Override
     public String toString() {
         return String.format("(f=%s %s)", getFitness(), getRepresentation());

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/genetics/BinaryChromosome.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/genetics/BinaryChromosome.java b/src/main/java/org/apache/commons/math3/genetics/BinaryChromosome.java
index 47d317c..4c1ebb4 100644
--- a/src/main/java/org/apache/commons/math3/genetics/BinaryChromosome.java
+++ b/src/main/java/org/apache/commons/math3/genetics/BinaryChromosome.java
@@ -73,6 +73,7 @@ public abstract class BinaryChromosome extends AbstractListChromosome<Integer> {
         return rList;
     }
 
+    /** {@inheritDoc} */
     @Override
     protected boolean isSame(Chromosome another) {
         // type check

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/genetics/ChromosomePair.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/genetics/ChromosomePair.java b/src/main/java/org/apache/commons/math3/genetics/ChromosomePair.java
index ef8769d..b0491bf 100644
--- a/src/main/java/org/apache/commons/math3/genetics/ChromosomePair.java
+++ b/src/main/java/org/apache/commons/math3/genetics/ChromosomePair.java
@@ -58,6 +58,7 @@ public class ChromosomePair {
         return second;
     }
 
+    /** {@inheritDoc} */
     @Override
     public String toString() {
         return String.format("(%s,%s)", getFirst(), getSecond());

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/genetics/RandomKey.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/genetics/RandomKey.java b/src/main/java/org/apache/commons/math3/genetics/RandomKey.java
index 52db4a7..f33c91f 100644
--- a/src/main/java/org/apache/commons/math3/genetics/RandomKey.java
+++ b/src/main/java/org/apache/commons/math3/genetics/RandomKey.java
@@ -277,6 +277,7 @@ public abstract class RandomKey<T> extends AbstractListChromosome<Double> implem
         return Arrays.asList(res);
     }
 
+    /** {@inheritDoc} */
     @Override
     public String toString() {
         return String.format("(f=%s pi=(%s))", getFitness(), baseSeqPermutation);

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/genetics/TournamentSelection.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/genetics/TournamentSelection.java b/src/main/java/org/apache/commons/math3/genetics/TournamentSelection.java
index 95051ee..788e734 100644
--- a/src/main/java/org/apache/commons/math3/genetics/TournamentSelection.java
+++ b/src/main/java/org/apache/commons/math3/genetics/TournamentSelection.java
@@ -74,6 +74,7 @@ public class TournamentSelection implements SelectionPolicy {
         }
         // auxiliary population
         ListPopulation tournamentPopulation = new ListPopulation(this.arity) {
+            /** {@inheritDoc} */
             public Population nextGeneration() {
                 // not useful here
                 return null;

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/geometry/euclidean/twod/Line.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/geometry/euclidean/twod/Line.java b/src/main/java/org/apache/commons/math3/geometry/euclidean/twod/Line.java
index e367278..c300fa1 100644
--- a/src/main/java/org/apache/commons/math3/geometry/euclidean/twod/Line.java
+++ b/src/main/java/org/apache/commons/math3/geometry/euclidean/twod/Line.java
@@ -491,18 +491,32 @@ public class Line implements Hyperplane<Euclidean2D>, Embedding<Euclidean2D, Euc
      */
     private static class LineTransform implements Transform<Euclidean2D, Euclidean1D> {
 
-        // CHECKSTYLE: stop JavadocVariable check
+        /** Transform factor between input abscissa and output abscissa. */
         private double cXX;
-        private double cXY;
-        private double cX1;
+
+        /** Transform factor between input abscissa and output ordinate. */
         private double cYX;
+
+        /** Transform factor between input ordinate and output abscissa. */
+        private double cXY;
+
+        /** Transform factor between input ordinate and output ordinate. */
         private double cYY;
+
+        /** Transform addendum for output abscissa. */
+        private double cX1;
+
+        /** Transform addendum for output ordinate. */
         private double cY1;
 
+        /** cXY * cY1 - cYY * cX1. */
         private double c1Y;
+
+        /** cXX * cY1 - cYX * cX1. */
         private double c1X;
+
+        /** cXX * cYY - cYX * cXY. */
         private double c11;
-        // CHECKSTYLE: resume JavadocVariable check
 
         /** Build an affine line transform from a n {@code AffineTransform}.
          * @param cXX transform factor between input abscissa and output abscissa

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/geometry/euclidean/twod/hull/MonotoneChain.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/geometry/euclidean/twod/hull/MonotoneChain.java b/src/main/java/org/apache/commons/math3/geometry/euclidean/twod/hull/MonotoneChain.java
index a811dda..4421344 100644
--- a/src/main/java/org/apache/commons/math3/geometry/euclidean/twod/hull/MonotoneChain.java
+++ b/src/main/java/org/apache/commons/math3/geometry/euclidean/twod/hull/MonotoneChain.java
@@ -73,6 +73,7 @@ public class MonotoneChain extends AbstractConvexHullGenerator2D {
         super(includeCollinearPoints, tolerance);
     }
 
+    /** {@inheritDoc} */
     @Override
     public Collection<Vector2D> findHullVertices(final Collection<Vector2D> points) {
 
@@ -80,6 +81,7 @@ public class MonotoneChain extends AbstractConvexHullGenerator2D {
 
         // sort the points in increasing order on the x-axis
         Collections.sort(pointsSortedByXAxis, new Comparator<Vector2D>() {
+            /** {@inheritDoc} */
             public int compare(final Vector2D o1, final Vector2D o2) {
                 final double tolerance = getTolerance();
                 // need to take the tolerance value into account, otherwise collinear points

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/geometry/partitioning/AbstractRegion.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/geometry/partitioning/AbstractRegion.java b/src/main/java/org/apache/commons/math3/geometry/partitioning/AbstractRegion.java
index c92637a..d901ab4 100644
--- a/src/main/java/org/apache/commons/math3/geometry/partitioning/AbstractRegion.java
+++ b/src/main/java/org/apache/commons/math3/geometry/partitioning/AbstractRegion.java
@@ -110,6 +110,7 @@ public abstract class AbstractRegion<S extends Space, T extends Space> implement
             // (we don't want equal size elements to be removed, so
             // we use a trick to fool the TreeSet)
             final TreeSet<SubHyperplane<S>> ordered = new TreeSet<SubHyperplane<S>>(new Comparator<SubHyperplane<S>>() {
+                /** {@inheritDoc} */
                 public int compare(final SubHyperplane<S> o1, final SubHyperplane<S> o2) {
                     final double size1 = o1.getSize();
                     final double size2 = o2.getSize();

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/ml/clustering/evaluation/SumOfClusterVariances.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/ml/clustering/evaluation/SumOfClusterVariances.java b/src/main/java/org/apache/commons/math3/ml/clustering/evaluation/SumOfClusterVariances.java
index 4051c11..b5b249c 100644
--- a/src/main/java/org/apache/commons/math3/ml/clustering/evaluation/SumOfClusterVariances.java
+++ b/src/main/java/org/apache/commons/math3/ml/clustering/evaluation/SumOfClusterVariances.java
@@ -45,6 +45,7 @@ public class SumOfClusterVariances<T extends Clusterable> extends ClusterEvaluat
         super(measure);
     }
 
+    /** {@inheritDoc} */
     @Override
     public double score(final List<? extends Cluster<T>> clusters) {
         double varianceSum = 0.0;

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/ode/events/EventState.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/ode/events/EventState.java b/src/main/java/org/apache/commons/math3/ode/events/EventState.java
index b838654..9e9da8d 100644
--- a/src/main/java/org/apache/commons/math3/ode/events/EventState.java
+++ b/src/main/java/org/apache/commons/math3/ode/events/EventState.java
@@ -236,6 +236,7 @@ public class EventState {
             final double h = dt / n;
 
             final UnivariateFunction f = new UnivariateFunction() {
+                /** {@inheritDoc} */
                 public double value(final double t) throws LocalMaxCountExceededException {
                     try {
                         interpolator.setInterpolatedTime(t);

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/optim/linear/LinearConstraint.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/optim/linear/LinearConstraint.java b/src/main/java/org/apache/commons/math3/optim/linear/LinearConstraint.java
index ae5a28a..b9fa390 100644
--- a/src/main/java/org/apache/commons/math3/optim/linear/LinearConstraint.java
+++ b/src/main/java/org/apache/commons/math3/optim/linear/LinearConstraint.java
@@ -182,6 +182,7 @@ public class LinearConstraint implements Serializable {
         return value;
     }
 
+    /** {@inheritDoc} */
     @Override
     public boolean equals(Object other) {
         if (this == other) {
@@ -196,6 +197,7 @@ public class LinearConstraint implements Serializable {
         return false;
     }
 
+    /** {@inheritDoc} */
     @Override
     public int hashCode() {
         return relationship.hashCode() ^

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/optim/linear/LinearObjectiveFunction.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/optim/linear/LinearObjectiveFunction.java b/src/main/java/org/apache/commons/math3/optim/linear/LinearObjectiveFunction.java
index dc4f429..6cff81f 100644
--- a/src/main/java/org/apache/commons/math3/optim/linear/LinearObjectiveFunction.java
+++ b/src/main/java/org/apache/commons/math3/optim/linear/LinearObjectiveFunction.java
@@ -105,6 +105,7 @@ public class LinearObjectiveFunction
         return coefficients.dotProduct(point) + constantTerm;
     }
 
+    /** {@inheritDoc} */
     @Override
     public boolean equals(Object other) {
         if (this == other) {
@@ -118,6 +119,7 @@ public class LinearObjectiveFunction
         return false;
     }
 
+    /** {@inheritDoc} */
     @Override
     public int hashCode() {
         return Double.valueOf(constantTerm).hashCode() ^ coefficients.hashCode();

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/optim/linear/Relationship.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/optim/linear/Relationship.java b/src/main/java/org/apache/commons/math3/optim/linear/Relationship.java
index 5e28a58..f88c938 100644
--- a/src/main/java/org/apache/commons/math3/optim/linear/Relationship.java
+++ b/src/main/java/org/apache/commons/math3/optim/linear/Relationship.java
@@ -41,6 +41,7 @@ public enum Relationship {
         this.stringValue = stringValue;
     }
 
+    /** {@inheritDoc} */
     @Override
     public String toString() {
         return stringValue;

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/optim/linear/SimplexTableau.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/optim/linear/SimplexTableau.java b/src/main/java/org/apache/commons/math3/optim/linear/SimplexTableau.java
index 57ffcd9..31e71d2 100644
--- a/src/main/java/org/apache/commons/math3/optim/linear/SimplexTableau.java
+++ b/src/main/java/org/apache/commons/math3/optim/linear/SimplexTableau.java
@@ -651,6 +651,7 @@ class SimplexTableau implements Serializable {
         return tableau.getData();
     }
 
+    /** {@inheritDoc} */
     @Override
     public boolean equals(Object other) {
 
@@ -673,6 +674,7 @@ class SimplexTableau implements Serializable {
       return false;
     }
 
+    /** {@inheritDoc} */
     @Override
     public int hashCode() {
         return Boolean.valueOf(restrictToNonNegative).hashCode() ^

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/optim/nonlinear/scalar/LineSearch.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/optim/nonlinear/scalar/LineSearch.java b/src/main/java/org/apache/commons/math3/optim/nonlinear/scalar/LineSearch.java
index e4f0c91..4a630a2 100644
--- a/src/main/java/org/apache/commons/math3/optim/nonlinear/scalar/LineSearch.java
+++ b/src/main/java/org/apache/commons/math3/optim/nonlinear/scalar/LineSearch.java
@@ -112,6 +112,7 @@ public class LineSearch {
                                            final double[] direction) {
         final int n = startPoint.length;
         final UnivariateFunction f = new UnivariateFunction() {
+                /** {@inheritDoc} */
                 public double value(double alpha) {
                     final double[] x = new double[n];
                     for (int i = 0; i < n; i++) {

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/optim/nonlinear/scalar/MultiStartMultivariateOptimizer.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/optim/nonlinear/scalar/MultiStartMultivariateOptimizer.java b/src/main/java/org/apache/commons/math3/optim/nonlinear/scalar/MultiStartMultivariateOptimizer.java
index 704c9aa..86dcd70 100644
--- a/src/main/java/org/apache/commons/math3/optim/nonlinear/scalar/MultiStartMultivariateOptimizer.java
+++ b/src/main/java/org/apache/commons/math3/optim/nonlinear/scalar/MultiStartMultivariateOptimizer.java
@@ -93,6 +93,7 @@ public class MultiStartMultivariateOptimizer
      */
     private Comparator<PointValuePair> getPairComparator() {
         return new Comparator<PointValuePair>() {
+            /** {@inheritDoc} */
             public int compare(final PointValuePair o1,
                                final PointValuePair o2) {
                 if (o1 == null) {

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/optim/nonlinear/scalar/noderiv/BOBYQAOptimizer.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/optim/nonlinear/scalar/noderiv/BOBYQAOptimizer.java b/src/main/java/org/apache/commons/math3/optim/nonlinear/scalar/noderiv/BOBYQAOptimizer.java
index 5d3d229..78d5ea7 100644
--- a/src/main/java/org/apache/commons/math3/optim/nonlinear/scalar/noderiv/BOBYQAOptimizer.java
+++ b/src/main/java/org/apache/commons/math3/optim/nonlinear/scalar/noderiv/BOBYQAOptimizer.java
@@ -54,18 +54,29 @@ public class BOBYQAOptimizer
     public static final double DEFAULT_INITIAL_RADIUS = 10.0;
     /** Default value for {@link #stoppingTrustRegionRadius}: {@value} . */
     public static final double DEFAULT_STOPPING_RADIUS = 1E-8;
-
+    /** Constant 0. */
     private static final double ZERO = 0d;
+    /** Constant 1. */
     private static final double ONE = 1d;
+    /** Constant 2. */
     private static final double TWO = 2d;
+    /** Constant 10. */
     private static final double TEN = 10d;
+    /** Constant 16. */
     private static final double SIXTEEN = 16d;
+    /** Constant 250. */
     private static final double TWO_HUNDRED_FIFTY = 250d;
+    /** Constant -1. */
     private static final double MINUS_ONE = -ONE;
+    /** Constant 1/2. */
     private static final double HALF = ONE / 2;
+    /** Constant 1/4. */
     private static final double ONE_OVER_FOUR = ONE / 4;
+    /** Constant 1/8. */
     private static final double ONE_OVER_EIGHT = ONE / 8;
+    /** Constant 1/10. */
     private static final double ONE_OVER_TEN = ONE / 10;
+    /** Constant 1/1000. */
     private static final double ONE_OVER_A_THOUSAND = ONE / 1000;
 
     /**
@@ -2447,8 +2458,10 @@ public class BOBYQAOptimizer
      * If the path becomes explored, it should just be removed from the code.
      */
     private static class PathIsExploredException extends RuntimeException {
+        /** Serializable UID. */
         private static final long serialVersionUID = 745350979634801853L;
 
+        /** Message string. */
         private static final String PATH_IS_EXPLORED
             = "If this exception is thrown, just remove it from the code";
 

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/optim/nonlinear/scalar/noderiv/SimplexOptimizer.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/optim/nonlinear/scalar/noderiv/SimplexOptimizer.java b/src/main/java/org/apache/commons/math3/optim/nonlinear/scalar/noderiv/SimplexOptimizer.java
index 3b44358..4bb6b64 100644
--- a/src/main/java/org/apache/commons/math3/optim/nonlinear/scalar/noderiv/SimplexOptimizer.java
+++ b/src/main/java/org/apache/commons/math3/optim/nonlinear/scalar/noderiv/SimplexOptimizer.java
@@ -130,6 +130,7 @@ public class SimplexOptimizer extends MultivariateOptimizer {
         // evaluations counter.
         final MultivariateFunction evalFunc
             = new MultivariateFunction() {
+                /** {@inheritDoc} */
                 public double value(double[] point) {
                     return computeObjectiveValue(point);
                 }
@@ -138,6 +139,7 @@ public class SimplexOptimizer extends MultivariateOptimizer {
         final boolean isMinim = getGoalType() == GoalType.MINIMIZE;
         final Comparator<PointValuePair> comparator
             = new Comparator<PointValuePair>() {
+            /** {@inheritDoc} */
             public int compare(final PointValuePair o1,
                                final PointValuePair o2) {
                 final double v1 = o1.getValue();

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/optim/nonlinear/vector/MultiStartMultivariateVectorOptimizer.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/optim/nonlinear/vector/MultiStartMultivariateVectorOptimizer.java b/src/main/java/org/apache/commons/math3/optim/nonlinear/vector/MultiStartMultivariateVectorOptimizer.java
index 1095057..2cebf79 100644
--- a/src/main/java/org/apache/commons/math3/optim/nonlinear/vector/MultiStartMultivariateVectorOptimizer.java
+++ b/src/main/java/org/apache/commons/math3/optim/nonlinear/vector/MultiStartMultivariateVectorOptimizer.java
@@ -97,9 +97,12 @@ public class MultiStartMultivariateVectorOptimizer
      */
     private Comparator<PointVectorValuePair> getPairComparator() {
         return new Comparator<PointVectorValuePair>() {
+            /** Observed value to be matched. */
             private final RealVector target = new ArrayRealVector(optimizer.getTarget(), false);
+            /** Observations weights. */
             private final RealMatrix weight = optimizer.getWeight();
 
+            /** {@inheritDoc} */
             public int compare(final PointVectorValuePair o1,
                                final PointVectorValuePair o2) {
                 if (o1 == null) {

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/optim/univariate/MultiStartUnivariateOptimizer.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/optim/univariate/MultiStartUnivariateOptimizer.java b/src/main/java/org/apache/commons/math3/optim/univariate/MultiStartUnivariateOptimizer.java
index 07e7daf..d12ec97 100644
--- a/src/main/java/org/apache/commons/math3/optim/univariate/MultiStartUnivariateOptimizer.java
+++ b/src/main/java/org/apache/commons/math3/optim/univariate/MultiStartUnivariateOptimizer.java
@@ -210,6 +210,7 @@ public class MultiStartUnivariateOptimizer
      */
     private void sortPairs(final GoalType goal) {
         Arrays.sort(optima, new Comparator<UnivariatePointValuePair>() {
+                /** {@inheritDoc} */
                 public int compare(final UnivariatePointValuePair o1,
                                    final UnivariatePointValuePair o2) {
                     if (o1 == null) {

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/optimization/BaseMultivariateMultiStartOptimizer.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/optimization/BaseMultivariateMultiStartOptimizer.java b/src/main/java/org/apache/commons/math3/optimization/BaseMultivariateMultiStartOptimizer.java
index 53c2a7a..4060129 100644
--- a/src/main/java/org/apache/commons/math3/optimization/BaseMultivariateMultiStartOptimizer.java
+++ b/src/main/java/org/apache/commons/math3/optimization/BaseMultivariateMultiStartOptimizer.java
@@ -175,6 +175,7 @@ public class BaseMultivariateMultiStartOptimizer<FUNC extends MultivariateFuncti
      */
     private void sortPairs(final GoalType goal) {
         Arrays.sort(optima, new Comparator<PointValuePair>() {
+                /** {@inheritDoc} */
                 public int compare(final PointValuePair o1,
                                    final PointValuePair o2) {
                     if (o1 == null) {

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/optimization/BaseMultivariateVectorMultiStartOptimizer.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/optimization/BaseMultivariateVectorMultiStartOptimizer.java b/src/main/java/org/apache/commons/math3/optimization/BaseMultivariateVectorMultiStartOptimizer.java
index d69b13f..7df3019 100644
--- a/src/main/java/org/apache/commons/math3/optimization/BaseMultivariateVectorMultiStartOptimizer.java
+++ b/src/main/java/org/apache/commons/math3/optimization/BaseMultivariateVectorMultiStartOptimizer.java
@@ -181,6 +181,7 @@ public class BaseMultivariateVectorMultiStartOptimizer<FUNC extends Multivariate
     private void sortPairs(final double[] target,
                            final double[] weights) {
         Arrays.sort(optima, new Comparator<PointVectorValuePair>() {
+                /** {@inheritDoc} */
                 public int compare(final PointVectorValuePair o1,
                                    final PointVectorValuePair o2) {
                     if (o1 == null) {

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/optimization/direct/BOBYQAOptimizer.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/optimization/direct/BOBYQAOptimizer.java b/src/main/java/org/apache/commons/math3/optimization/direct/BOBYQAOptimizer.java
index 3b02370..b05c3ff 100644
--- a/src/main/java/org/apache/commons/math3/optimization/direct/BOBYQAOptimizer.java
+++ b/src/main/java/org/apache/commons/math3/optimization/direct/BOBYQAOptimizer.java
@@ -59,18 +59,29 @@ public class BOBYQAOptimizer
     public static final double DEFAULT_INITIAL_RADIUS = 10.0;
     /** Default value for {@link #stoppingTrustRegionRadius}: {@value} . */
     public static final double DEFAULT_STOPPING_RADIUS = 1E-8;
-
+    /** Constant 0. */
     private static final double ZERO = 0d;
+    /** Constant 1. */
     private static final double ONE = 1d;
+    /** Constant 2. */
     private static final double TWO = 2d;
+    /** Constant 10. */
     private static final double TEN = 10d;
+    /** Constant 16. */
     private static final double SIXTEEN = 16d;
+    /** Constant 250. */
     private static final double TWO_HUNDRED_FIFTY = 250d;
+    /** Constant -1. */
     private static final double MINUS_ONE = -ONE;
+    /** Constant 1/2. */
     private static final double HALF = ONE / 2;
+    /** Constant 1/4. */
     private static final double ONE_OVER_FOUR = ONE / 4;
+    /** Constant 1/8. */
     private static final double ONE_OVER_EIGHT = ONE / 8;
+    /** Constant 1/10. */
     private static final double ONE_OVER_TEN = ONE / 10;
+    /** Constant 1/1000. */
     private static final double ONE_OVER_A_THOUSAND = ONE / 1000;
 
     /**
@@ -2452,8 +2463,10 @@ public class BOBYQAOptimizer
      * If the path becomes explored, it should just be removed from the code.
      */
     private static class PathIsExploredException extends RuntimeException {
+        /** Serializable UID. */
         private static final long serialVersionUID = 745350979634801853L;
 
+        /** Message string. */
         private static final String PATH_IS_EXPLORED
             = "If this exception is thrown, just remove it from the code";
 

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/optimization/direct/PowellOptimizer.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/optimization/direct/PowellOptimizer.java b/src/main/java/org/apache/commons/math3/optimization/direct/PowellOptimizer.java
index 28190e1..8f5dd2b 100644
--- a/src/main/java/org/apache/commons/math3/optimization/direct/PowellOptimizer.java
+++ b/src/main/java/org/apache/commons/math3/optimization/direct/PowellOptimizer.java
@@ -330,6 +330,7 @@ public class PowellOptimizer
         public UnivariatePointValuePair search(final double[] p, final double[] d) {
             final int n = p.length;
             final UnivariateFunction f = new UnivariateFunction() {
+                    /** {@inheritDoc} */
                     public double value(double alpha) {
                         final double[] x = new double[n];
                         for (int i = 0; i < n; i++) {

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/optimization/direct/SimplexOptimizer.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/optimization/direct/SimplexOptimizer.java b/src/main/java/org/apache/commons/math3/optimization/direct/SimplexOptimizer.java
index 8333342..8136704 100644
--- a/src/main/java/org/apache/commons/math3/optimization/direct/SimplexOptimizer.java
+++ b/src/main/java/org/apache/commons/math3/optimization/direct/SimplexOptimizer.java
@@ -187,6 +187,7 @@ public class SimplexOptimizer
         // evaluations counter.
         final MultivariateFunction evalFunc
             = new MultivariateFunction() {
+                /** {@inheritDoc} */
                 public double value(double[] point) {
                     return computeObjectiveValue(point);
                 }
@@ -195,6 +196,7 @@ public class SimplexOptimizer
         final boolean isMinim = getGoalType() == GoalType.MINIMIZE;
         final Comparator<PointValuePair> comparator
             = new Comparator<PointValuePair>() {
+            /** {@inheritDoc} */
             public int compare(final PointValuePair o1,
                                final PointValuePair o2) {
                 final double v1 = o1.getValue();

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/optimization/fitting/CurveFitter.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/optimization/fitting/CurveFitter.java b/src/main/java/org/apache/commons/math3/optimization/fitting/CurveFitter.java
index dce5bc7..26e39f5 100644
--- a/src/main/java/org/apache/commons/math3/optimization/fitting/CurveFitter.java
+++ b/src/main/java/org/apache/commons/math3/optimization/fitting/CurveFitter.java
@@ -214,6 +214,7 @@ public class CurveFitter<T extends ParametricUnivariateFunction> {
         /** {@inheritDoc} */
         public MultivariateMatrixFunction jacobian() {
             return new MultivariateMatrixFunction() {
+                /** {@inheritDoc} */
                 public double[][] value(double[] point) {
                     final double[][] jacobian = new double[observations.size()][];
 

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/optimization/fitting/GaussianFitter.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/optimization/fitting/GaussianFitter.java b/src/main/java/org/apache/commons/math3/optimization/fitting/GaussianFitter.java
index b1bfe7d..375f12e 100644
--- a/src/main/java/org/apache/commons/math3/optimization/fitting/GaussianFitter.java
+++ b/src/main/java/org/apache/commons/math3/optimization/fitting/GaussianFitter.java
@@ -82,6 +82,7 @@ public class GaussianFitter extends CurveFitter<Gaussian.Parametric> {
      */
     public double[] fit(double[] initialGuess) {
         final Gaussian.Parametric f = new Gaussian.Parametric() {
+                /** {@inheritDoc} */
                 @Override
                 public double value(double x, double ... p) {
                     double v = Double.POSITIVE_INFINITY;
@@ -93,6 +94,7 @@ public class GaussianFitter extends CurveFitter<Gaussian.Parametric> {
                     return v;
                 }
 
+                /** {@inheritDoc} */
                 @Override
                 public double[] gradient(double x, double ... p) {
                     double[] v = { Double.POSITIVE_INFINITY,
@@ -184,6 +186,7 @@ public class GaussianFitter extends CurveFitter<Gaussian.Parametric> {
             final WeightedObservedPoint[] observations = unsorted.clone();
             final Comparator<WeightedObservedPoint> cmp
                 = new Comparator<WeightedObservedPoint>() {
+                /** {@inheritDoc} */
                 public int compare(WeightedObservedPoint p1,
                                    WeightedObservedPoint p2) {
                     if (p1 == null && p2 == null) {

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/optimization/linear/LinearConstraint.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/optimization/linear/LinearConstraint.java b/src/main/java/org/apache/commons/math3/optimization/linear/LinearConstraint.java
index 4e1966c..b3d70d4 100644
--- a/src/main/java/org/apache/commons/math3/optimization/linear/LinearConstraint.java
+++ b/src/main/java/org/apache/commons/math3/optimization/linear/LinearConstraint.java
@@ -185,6 +185,7 @@ public class LinearConstraint implements Serializable {
         return value;
     }
 
+    /** {@inheritDoc} */
     @Override
     public boolean equals(Object other) {
 
@@ -201,6 +202,7 @@ public class LinearConstraint implements Serializable {
       return false;
     }
 
+    /** {@inheritDoc} */
     @Override
     public int hashCode() {
         return relationship.hashCode() ^

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/optimization/linear/LinearObjectiveFunction.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/optimization/linear/LinearObjectiveFunction.java b/src/main/java/org/apache/commons/math3/optimization/linear/LinearObjectiveFunction.java
index 5755f5e..824a139 100644
--- a/src/main/java/org/apache/commons/math3/optimization/linear/LinearObjectiveFunction.java
+++ b/src/main/java/org/apache/commons/math3/optimization/linear/LinearObjectiveFunction.java
@@ -102,6 +102,7 @@ public class LinearObjectiveFunction implements Serializable {
         return coefficients.dotProduct(point) + constantTerm;
     }
 
+    /** {@inheritDoc} */
     @Override
     public boolean equals(Object other) {
 
@@ -117,6 +118,7 @@ public class LinearObjectiveFunction implements Serializable {
       return false;
     }
 
+    /** {@inheritDoc} */
     @Override
     public int hashCode() {
         return Double.valueOf(constantTerm).hashCode() ^ coefficients.hashCode();

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/optimization/linear/Relationship.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/optimization/linear/Relationship.java b/src/main/java/org/apache/commons/math3/optimization/linear/Relationship.java
index 3b1adc0..b1ca087 100644
--- a/src/main/java/org/apache/commons/math3/optimization/linear/Relationship.java
+++ b/src/main/java/org/apache/commons/math3/optimization/linear/Relationship.java
@@ -44,6 +44,7 @@ public enum Relationship {
         this.stringValue = stringValue;
     }
 
+    /** {@inheritDoc} */
     @Override
     public String toString() {
         return stringValue;

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/optimization/linear/SimplexTableau.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/optimization/linear/SimplexTableau.java b/src/main/java/org/apache/commons/math3/optimization/linear/SimplexTableau.java
index ebc703a..321f8c0 100644
--- a/src/main/java/org/apache/commons/math3/optimization/linear/SimplexTableau.java
+++ b/src/main/java/org/apache/commons/math3/optimization/linear/SimplexTableau.java
@@ -575,6 +575,7 @@ class SimplexTableau implements Serializable {
         return tableau.getData();
     }
 
+    /** {@inheritDoc} */
     @Override
     public boolean equals(Object other) {
 
@@ -597,6 +598,7 @@ class SimplexTableau implements Serializable {
       return false;
     }
 
+    /** {@inheritDoc} */
     @Override
     public int hashCode() {
         return Boolean.valueOf(restrictToNonNegative).hashCode() ^

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/optimization/univariate/UnivariateMultiStartOptimizer.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/optimization/univariate/UnivariateMultiStartOptimizer.java b/src/main/java/org/apache/commons/math3/optimization/univariate/UnivariateMultiStartOptimizer.java
index 6606d33..f63beb2 100644
--- a/src/main/java/org/apache/commons/math3/optimization/univariate/UnivariateMultiStartOptimizer.java
+++ b/src/main/java/org/apache/commons/math3/optimization/univariate/UnivariateMultiStartOptimizer.java
@@ -185,6 +185,7 @@ public class UnivariateMultiStartOptimizer<FUNC extends UnivariateFunction>
      */
     private void sortPairs(final GoalType goal) {
         Arrays.sort(optima, new Comparator<UnivariatePointValuePair>() {
+                /** {@inheritDoc} */
                 public int compare(final UnivariatePointValuePair o1,
                                    final UnivariatePointValuePair o2) {
                     if (o1 == null) {

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/special/Beta.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/special/Beta.java b/src/main/java/org/apache/commons/math3/special/Beta.java
index fc316e9..7bfcea5 100644
--- a/src/main/java/org/apache/commons/math3/special/Beta.java
+++ b/src/main/java/org/apache/commons/math3/special/Beta.java
@@ -197,6 +197,7 @@ public class Beta {
         } else {
             ContinuedFraction fraction = new ContinuedFraction() {
 
+                /** {@inheritDoc} */
                 @Override
                 protected double getB(int n, double x) {
                     double ret;
@@ -213,6 +214,7 @@ public class Beta {
                     return ret;
                 }
 
+                /** {@inheritDoc} */
                 @Override
                 protected double getA(int n, double x) {
                     return 1.0;

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/special/Gamma.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/special/Gamma.java b/src/main/java/org/apache/commons/math3/special/Gamma.java
index aaa561b..5b4d923 100644
--- a/src/main/java/org/apache/commons/math3/special/Gamma.java
+++ b/src/main/java/org/apache/commons/math3/special/Gamma.java
@@ -402,11 +402,13 @@ public class Gamma {
             // create continued fraction
             ContinuedFraction cf = new ContinuedFraction() {
 
+                /** {@inheritDoc} */
                 @Override
                 protected double getA(int n, double x) {
                     return ((2.0 * n) + 1.0) - a + x;
                 }
 
+                /** {@inheritDoc} */
                 @Override
                 protected double getB(int n, double x) {
                     return n * (a - n);

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/stat/correlation/KendallsCorrelation.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/stat/correlation/KendallsCorrelation.java b/src/main/java/org/apache/commons/math3/stat/correlation/KendallsCorrelation.java
index 42f4094..d38cf71 100644
--- a/src/main/java/org/apache/commons/math3/stat/correlation/KendallsCorrelation.java
+++ b/src/main/java/org/apache/commons/math3/stat/correlation/KendallsCorrelation.java
@@ -168,6 +168,7 @@ public class KendallsCorrelation {
         }
 
         Arrays.sort(pairs, new Comparator<Pair<Double, Double>>() {
+            /** {@inheritDoc} */
             public int compare(Pair<Double, Double> pair1, Pair<Double, Double> pair2) {
                 int compareFirst = pair1.getFirst().compareTo(pair2.getFirst());
                 return compareFirst != 0 ? compareFirst : pair1.getSecond().compareTo(pair2.getSecond());

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/stat/descriptive/rank/PSquarePercentile.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/stat/descriptive/rank/PSquarePercentile.java b/src/main/java/org/apache/commons/math3/stat/descriptive/rank/PSquarePercentile.java
index 1a51d3b..b8bc274 100644
--- a/src/main/java/org/apache/commons/math3/stat/descriptive/rank/PSquarePercentile.java
+++ b/src/main/java/org/apache/commons/math3/stat/descriptive/rank/PSquarePercentile.java
@@ -829,6 +829,7 @@ public class PSquarePercentile extends AbstractStorelessUnivariateStatistic
             return result;
         }
 
+        /** {@inheritDoc} */
         @Override
         public int hashCode() {
             return Arrays.hashCode(new double[] {markerHeight, intMarkerPosition,

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/util/MathArrays.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/util/MathArrays.java b/src/main/java/org/apache/commons/math3/util/MathArrays.java
index 9bb01b4..c199be5 100644
--- a/src/main/java/org/apache/commons/math3/util/MathArrays.java
+++ b/src/main/java/org/apache/commons/math3/util/MathArrays.java
@@ -846,11 +846,13 @@ public class MathArrays {
         final Comparator<PairDoubleInteger> comp
             = dir == MathArrays.OrderDirection.INCREASING ?
             new Comparator<PairDoubleInteger>() {
+            /** {@inheritDoc} */
             public int compare(PairDoubleInteger o1,
                                PairDoubleInteger o2) {
                 return Double.compare(o1.getKey(), o2.getKey());
             }
         } : new Comparator<PairDoubleInteger>() {
+            /** {@inheritDoc} */
             public int compare(PairDoubleInteger o1,
                                PairDoubleInteger o2) {
                 return Double.compare(o2.getKey(), o1.getKey());

http://git-wip-us.apache.org/repos/asf/commons-math/blob/85dd630c/src/main/java/org/apache/commons/math3/util/Pair.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/util/Pair.java b/src/main/java/org/apache/commons/math3/util/Pair.java
index ecdca37..d447b9b 100644
--- a/src/main/java/org/apache/commons/math3/util/Pair.java
+++ b/src/main/java/org/apache/commons/math3/util/Pair.java
@@ -133,6 +133,7 @@ public class Pair<K, V> {
         return result;
     }
 
+    /** {@inheritDoc} */
     @Override
     public String toString() {
         return "[" + getKey() + ", " + getValue() + "]";


Mime
View raw message