Author: erans
Date: Mon Jul 26 21:45:26 2010
New Revision: 979458
URL: http://svn.apache.org/viewvc?rev=979458&view=rev
Log:
Corrected typos in some Javadoc comments.
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/BaseMultivariateRealOptimizer.java
commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/DifferentiableMultivariateRealOptimizer.java
commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/general/AbstractScalarDifferentiableOptimizer.java
commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/general/AbstractScalarOptimizer.java
commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/general/BaseAbstractScalarOptimizer.java
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/BaseMultivariateRealOptimizer.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/BaseMultivariateRealOptimizer.java?rev=979458&r1=979457&r2=979458&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/BaseMultivariateRealOptimizer.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/BaseMultivariateRealOptimizer.java
Mon Jul 26 21:45:26 2010
@@ -64,9 +64,9 @@ public interface BaseMultivariateRealOpt
/**
* Get the number of iterations realized by the algorithm.
- * The number of evaluations corresponds to the last call to the
- * {...@link #optimize(MultivariateRealFunction, GoalType, double[])
optimize}
- * method. It is 0 if the method has not been called yet.
+ * The number of iterations corresponds to the last call to the
+ * {...@code optimize} method. It is 0 if the method has not been
+ * called yet.
*
* @return the number of iterations.
*/
@@ -74,10 +74,9 @@ public interface BaseMultivariateRealOpt
/**
* Get the number of evaluations of the objective function.
- *
* The number of evaluations corresponds to the last call to the
- * {...@link #optimize(T, GoalType, double[]) optimize}
- * method. It is 0 if the method has not been called yet.
+ * {...@code optimize} method. It is 0 if the method has not been
+ * called yet.
*
* @return the number of evaluations of the objective function.
*/
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/DifferentiableMultivariateRealOptimizer.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/DifferentiableMultivariateRealOptimizer.java?rev=979458&r1=979457&r2=979458&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/DifferentiableMultivariateRealOptimizer.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/DifferentiableMultivariateRealOptimizer.java
Mon Jul 26 21:45:26 2010
@@ -21,10 +21,12 @@ import org.apache.commons.math.FunctionE
import org.apache.commons.math.analysis.DifferentiableMultivariateRealFunction;
/**
- * This interface represents an optimization algorithm for {...@link
DifferentiableMultivariateRealFunction
- * scalar differentiable objective functions}.
- * <p>Optimization algorithms find the input point set that either {...@link
GoalType
- * maximize or minimize} an objective function.</p>
+ * This interface represents an optimization algorithm for
+ * {...@link DifferentiableMultivariateRealFunction scalar differentiable
objective
+ * functions}.
+ * Optimization algorithms find the input point set that either {...@link
GoalType
+ * maximize or minimize} an objective function.
+ *
* @see MultivariateRealOptimizer
* @see DifferentiableMultivariateVectorialOptimizer
* @version $Revision$ $Date$
@@ -35,8 +37,8 @@ public interface DifferentiableMultivari
/**
* Get the number of evaluations of the objective function gradient.
* The number of evaluations corresponds to the last call to the
- * {...@link #optimize(DifferentiableMultivariateRealFunction, GoalType,
double[]) optimize}
- * method. It is 0 if the method has not been called yet.
+ * {...@code optimize} method (see {...@link
BaseMultivariateRealOptimizer}).
+ * It is 0 if the method has not been called yet.
*
* @return the number of evaluations of the objective function gradient.
*/
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/general/AbstractScalarDifferentiableOptimizer.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/general/AbstractScalarDifferentiableOptimizer.java?rev=979458&r1=979457&r2=979458&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/general/AbstractScalarDifferentiableOptimizer.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/general/AbstractScalarDifferentiableOptimizer.java
Mon Jul 26 21:45:26 2010
@@ -70,7 +70,7 @@ public abstract class AbstractScalarDiff
*/
protected AbstractScalarDifferentiableOptimizer() {}
/**
- * @param convergenceChecker Convergence checker.
+ * @param checker Convergence checker.
* @param maxIterations Maximum number of iterations.
* @param maxEvaluations Maximum number of evaluations.
*/
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/general/AbstractScalarOptimizer.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/general/AbstractScalarOptimizer.java?rev=979458&r1=979457&r2=979458&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/general/AbstractScalarOptimizer.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/general/AbstractScalarOptimizer.java
Mon Jul 26 21:45:26 2010
@@ -48,7 +48,7 @@ public abstract class AbstractScalarOpti
*/
protected AbstractScalarOptimizer() {}
/**
- * @param convergenceChecker Convergence checker.
+ * @param checker Convergence checker.
* @param maxIterations Maximum number of iterations.
* @param maxEvaluations Maximum number of evaluations.
*/
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/general/BaseAbstractScalarOptimizer.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/general/BaseAbstractScalarOptimizer.java?rev=979458&r1=979457&r2=979458&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/general/BaseAbstractScalarOptimizer.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/general/BaseAbstractScalarOptimizer.java
Mon Jul 26 21:45:26 2010
@@ -78,7 +78,7 @@ public abstract class BaseAbstractScalar
DEFAULT_MAX_EVALUATIONS);
}
/**
- * @param convergenceChecker Convergence checker.
+ * @param checker Convergence checker.
* @param maxIterations Maximum number of iterations.
* @param maxEvaluations Maximum number of evaluations.
*/
