Author: luc
Date: Tue Oct 9 10:04:36 2012
New Revision: 1395937
URL: http://svn.apache.org/viewvc?rev=1395937&view=rev
Log:
Fixed javadoc warnings.
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/analysis/differentiation/DerivativeStructure.java
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/analysis/differentiation/package-info.java
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/analysis/solvers/NewtonSolver.java
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/direct/CMAESOptimizer.java
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/package-info.java
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/random/RandomDataImpl.java
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/special/Gamma.java
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/analysis/differentiation/DerivativeStructure.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/analysis/differentiation/DerivativeStructure.java?rev=1395937&r1=1395936&r2=1395937&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/analysis/differentiation/DerivativeStructure.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/analysis/differentiation/DerivativeStructure.java
Tue Oct 9 10:04:36 2012
@@ -49,7 +49,7 @@ import org.apache.commons.math3.util.Fas
* DerivativeStructure}-based instances. This method is simpler but may be
limited in
* the accuracy and derivation orders and may be computationally intensive
(this is
* typically the case for {@link FiniteDifferencesDifferentiator finite
differences
- * differentiator).</p>
+ * differentiator}.</p>
* <p>Instances of this class are guaranteed to be immutable.</p>
* @see DSCompiler
* @version $Id$
@@ -435,7 +435,6 @@ public class DerivativeStructure impleme
/** Compute the signum of the instance.
* The signum is -1 for negative numbers, +1 for positive numbers and 0
otherwise
- * @param a number on which evaluation is done
* @return -1.0, -0.0, +0.0, +1.0 or NaN depending on sign of a
*/
public DerivativeStructure signum() {
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/analysis/differentiation/package-info.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/analysis/differentiation/package-info.java?rev=1395937&r1=1395936&r2=1395937&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/analysis/differentiation/package-info.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/analysis/differentiation/package-info.java
Tue Oct 9 10:04:36 2012
@@ -19,20 +19,23 @@
* <p>
* This package holds the main interfaces and basic building block classes
* dealing with differentiation.
- * The core class is {@link DerivativeStructure} which holds the value and
- * the differentials of a function. This class handles some arbitrary number
- * of free parameters and arbitrary derivation order. It is used both as
- * the input and the output type for the {@link
UnivariateDifferentiableFunction}
- * interface. Any differentiable function should implement this interface.
+ * The core class is {@link
org.apache.commons.math3.analysis.differentiation.DerivativeStructure
+ * DerivativeStructure} which holds the value and the differentials of a
function. This class
+ * handles some arbitrary number of free parameters and arbitrary derivation
order. It is used
+ * both as the input and the output type for the {@link
+ *
org.apache.commons.math3.analysis.differentiation.UnivariateDifferentiableFunction
+ * UnivariateDifferentiableFunction} interface. Any differentiable function
should implement this
+ * interface.
* </p>
* <p>
- * The {@link UnivariateFunctionDifferentiator} interface defines a way to
differentiation
- * a simple {@link org.apache.commons.math3.analysis.UnivariateFunction
- * univariate function} and get a {@link differential function}.
+ * The {@link
org.apache.commons.math3.analysis.differentiation.UnivariateFunctionDifferentiator
+ * UnivariateFunctionDifferentiator} interface defines a way to
differentiation a simple {@link
+ * org.apache.commons.math3.analysis.UnivariateFunction UnivariateFunction}
and get a {@link
+ *
org.apache.commons.math3.analysis.differentiation.UnivariateDifferentiableFunction
+ * UnivariateDifferentiableFunction}.
* </p>
* <p>
- * Similar interfaces also exist for multivariate functions and for vector or
- * matrix valued functions.
+ * Similar interfaces also exist for multivariate functions and for vector
or matrix valued functions.
* </p>
*
*/
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/analysis/solvers/NewtonSolver.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/analysis/solvers/NewtonSolver.java?rev=1395937&r1=1395936&r2=1395937&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/analysis/solvers/NewtonSolver.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/analysis/solvers/NewtonSolver.java
Tue Oct 9 10:04:36 2012
@@ -27,7 +27,7 @@ import org.apache.commons.math3.exceptio
* <p>
* The function should be continuous but not necessarily smooth.</p>
*
- * @deprecated as of 3.1, replaced by {@link NewtonRaphsonSolverTest}
+ * @deprecated as of 3.1, replaced by {@link NewtonRaphsonSolver}
* @version $Id$
*/
@Deprecated
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/direct/CMAESOptimizer.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/direct/CMAESOptimizer.java?rev=1395937&r1=1395936&r2=1395937&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/direct/CMAESOptimizer.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/direct/CMAESOptimizer.java
Tue Oct 9 10:04:36 2012
@@ -77,7 +77,8 @@ import org.apache.commons.math3.util.Mat
*
* When simple constraints (boundaries) are used, care must be taken that the
* difference between the upper and lower bounds does not overflow; should it
- * be the case, a {@link NumberIsTooLargeException} will be thrown by the
+ * be the case, a {@link
org.apache.commons.math3.exception.NumberIsTooLargeException
+ * NumberIsTooLargeException} will be thrown by the
* {@link BaseAbstractMultivariateSimpleBoundsOptimizer#optimize(int,
* MultivariateFunction,GoalType,double[],double[],double[]) optimize} method.
*
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/package-info.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/package-info.java?rev=1395937&r1=1395936&r2=1395937&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/package-info.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/package-info.java
Tue Oct 9 10:04:36 2012
@@ -40,12 +40,12 @@
* multivariate real functions}</li>
* <li>{@link
org.apache.commons.math3.optimization.MultivariateDifferentiableOptimizer
* MultivariateDifferentiableOptimizer} for {@link
- * org.apache.commons.math3.analysis.MultivariateDifferentiableFunction
- * differentiable multivariate real functions}</li>
- * <li>{@link
org.apache.commons.math3.optimization.DifferentiableMultivariateVectorOptimizer
+ *
org.apache.commons.math3.analysis.differentiation.MultivariateDifferentiableFunction
+ * multivariate differentiable real functions}</li>
+ * <li>{@link
org.apache.commons.math3.optimization.MultivariateDifferentiableVectorOptimizer
* MultivariateDifferentiableVectorOptimizer} for {@link
- *
org.apache.commons.math3.analysis.DifferentiableMultivariateVectorFunction
- * differentiable multivariate vectorial functions}</li>
+ *
org.apache.commons.math3.analysis.differentiation.MultivariateDifferentiableVectorFunction
+ * multivariate differentiable vectorial functions}</li>
* </ul>
* </p>
*
@@ -70,3 +70,5 @@
*
*/
package org.apache.commons.math3.optimization;
+import
org.apache.commons.math3.analysis.differentiation.MultivariateDifferentiableVectorFunction;
+
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/random/RandomDataImpl.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/random/RandomDataImpl.java?rev=1395937&r1=1395936&r2=1395937&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/random/RandomDataImpl.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/random/RandomDataImpl.java
Tue Oct 9 10:04:36 2012
@@ -256,7 +256,7 @@ public class RandomDataImpl implements R
}
/**
- * Generates a random value from the {@link BetaDistribution Beta
Distribution}.
+ * Generates a random value from the {@link
org.apache.commons.math3.distribution.BetaDistribution Beta Distribution}.
* This implementation uses {@link #nextInversionDeviate(RealDistribution)
inversion}
* to generate random values.
*
@@ -270,7 +270,7 @@ public class RandomDataImpl implements R
}
/**
- * Generates a random value from the {@link BinomialDistribution Binomial
Distribution}.
+ * Generates a random value from the {@link
org.apache.commons.math3.distribution.BinomialDistribution Binomial
Distribution}.
* This implementation uses {@link #nextInversionDeviate(RealDistribution)
inversion}
* to generate random values.
*
@@ -284,7 +284,7 @@ public class RandomDataImpl implements R
}
/**
- * Generates a random value from the {@link CauchyDistribution Cauchy
Distribution}.
+ * Generates a random value from the {@link
org.apache.commons.math3.distribution.CauchyDistribution Cauchy Distribution}.
* This implementation uses {@link #nextInversionDeviate(RealDistribution)
inversion}
* to generate random values.
*
@@ -298,7 +298,7 @@ public class RandomDataImpl implements R
}
/**
- * Generates a random value from the {@link ChiSquaredDistribution
ChiSquare Distribution}.
+ * Generates a random value from the {@link
org.apache.commons.math3.distribution.ChiSquaredDistribution ChiSquare
Distribution}.
* This implementation uses {@link #nextInversionDeviate(RealDistribution)
inversion}
* to generate random values.
*
@@ -311,7 +311,7 @@ public class RandomDataImpl implements R
}
/**
- * Generates a random value from the {@link FDistribution F Distribution}.
+ * Generates a random value from the {@link
org.apache.commons.math3.distribution.FDistribution F Distribution}.
* This implementation uses {@link #nextInversionDeviate(RealDistribution)
inversion}
* to generate random values.
*
@@ -354,7 +354,7 @@ public class RandomDataImpl implements R
}
/**
- * Generates a random value from the {@link HypergeometricDistribution
Hypergeometric Distribution}.
+ * Generates a random value from the {@link
org.apache.commons.math3.distribution.HypergeometricDistribution Hypergeometric
Distribution}.
* This implementation uses {@link
#nextInversionDeviate(IntegerDistribution) inversion}
* to generate random values.
*
@@ -374,7 +374,7 @@ public class RandomDataImpl implements R
}
/**
- * Generates a random value from the {@link PascalDistribution Pascal
Distribution}.
+ * Generates a random value from the {@link
org.apache.commons.math3.distribution.PascalDistribution Pascal Distribution}.
* This implementation uses {@link
#nextInversionDeviate(IntegerDistribution) inversion}
* to generate random values.
*
@@ -392,7 +392,7 @@ public class RandomDataImpl implements R
}
/**
- * Generates a random value from the {@link TDistribution T Distribution}.
+ * Generates a random value from the {@link
org.apache.commons.math3.distribution.TDistribution T Distribution}.
* This implementation uses {@link #nextInversionDeviate(RealDistribution)
inversion}
* to generate random values.
*
@@ -406,7 +406,7 @@ public class RandomDataImpl implements R
}
/**
- * Generates a random value from the {@link WeibullDistribution Weibull
Distribution}.
+ * Generates a random value from the {@link
org.apache.commons.math3.distribution.WeibullDistribution Weibull Distribution}.
* This implementation uses {@link #nextInversionDeviate(RealDistribution)
inversion}
* to generate random values.
*
@@ -422,7 +422,7 @@ public class RandomDataImpl implements R
}
/**
- * Generates a random value from the {@link ZipfDistribution Zipf
Distribution}.
+ * Generates a random value from the {@link
org.apache.commons.math3.distribution.ZipfDistribution Zipf Distribution}.
* This implementation uses {@link
#nextInversionDeviate(IntegerDistribution) inversion}
* to generate random values.
*
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/special/Gamma.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/special/Gamma.java?rev=1395937&r1=1395936&r2=1395937&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/special/Gamma.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/special/Gamma.java
Tue Oct 9 10:04:36 2012
@@ -497,7 +497,7 @@ public class Gamma {
* {@code gamma(x) = sqrt(2 * pi) / x * (x + g + 0.5) ^ (x + 0.5)
* * exp(-x - g - 0.5) * lanczos(x)},
* </center>
- * where {@code g} is a constant, returned by {@link #getLanczosG()}.
+ * where {@code g} is the Lanczos constant.
* </p>
*
* @param x Argument.
