Corrected typos in some Javadoc comments.

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/math/trunk@979458 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Gilles Sadowski 2010-07-26 21:45:26 +00:00
parent 1bc1ca5843
commit e0723d16df
5 changed files with 16 additions and 15 deletions

View File

@ -64,9 +64,9 @@ public interface BaseMultivariateRealOptimizer<T extends MultivariateRealFunctio
/** /**
* Get the number of iterations realized by the algorithm. * Get the number of iterations realized by the algorithm.
* The number of evaluations corresponds to the last call to the * The number of iterations corresponds to the last call to the
* {@link #optimize(MultivariateRealFunction, GoalType, double[]) optimize} * {@code optimize} method. It is 0 if the method has not been
* method. It is 0 if the method has not been called yet. * called yet.
* *
* @return the number of iterations. * @return the number of iterations.
*/ */
@ -74,10 +74,9 @@ public interface BaseMultivariateRealOptimizer<T extends MultivariateRealFunctio
/** /**
* Get the number of evaluations of the objective function. * Get the number of evaluations of the objective function.
*
* The number of evaluations corresponds to the last call to the * The number of evaluations corresponds to the last call to the
* {@link #optimize(T, GoalType, double[]) optimize} * {@code optimize} method. It is 0 if the method has not been
* method. It is 0 if the method has not been called yet. * called yet.
* *
* @return the number of evaluations of the objective function. * @return the number of evaluations of the objective function.
*/ */

View File

@ -21,10 +21,12 @@ import org.apache.commons.math.FunctionEvaluationException;
import org.apache.commons.math.analysis.DifferentiableMultivariateRealFunction; import org.apache.commons.math.analysis.DifferentiableMultivariateRealFunction;
/** /**
* This interface represents an optimization algorithm for {@link DifferentiableMultivariateRealFunction * This interface represents an optimization algorithm for
* scalar differentiable objective functions}. * {@link DifferentiableMultivariateRealFunction scalar differentiable objective
* <p>Optimization algorithms find the input point set that either {@link GoalType * functions}.
* maximize or minimize} an objective function.</p> * Optimization algorithms find the input point set that either {@link GoalType
* maximize or minimize} an objective function.
*
* @see MultivariateRealOptimizer * @see MultivariateRealOptimizer
* @see DifferentiableMultivariateVectorialOptimizer * @see DifferentiableMultivariateVectorialOptimizer
* @version $Revision$ $Date$ * @version $Revision$ $Date$
@ -35,8 +37,8 @@ public interface DifferentiableMultivariateRealOptimizer
/** /**
* Get the number of evaluations of the objective function gradient. * Get the number of evaluations of the objective function gradient.
* The number of evaluations corresponds to the last call to the * The number of evaluations corresponds to the last call to the
* {@link #optimize(DifferentiableMultivariateRealFunction, GoalType, double[]) optimize} * {@code optimize} method (see {@link BaseMultivariateRealOptimizer}).
* method. It is 0 if the method has not been called yet. * It is 0 if the method has not been called yet.
* *
* @return the number of evaluations of the objective function gradient. * @return the number of evaluations of the objective function gradient.
*/ */

View File

@ -70,7 +70,7 @@ public abstract class AbstractScalarDifferentiableOptimizer
*/ */
protected AbstractScalarDifferentiableOptimizer() {} protected AbstractScalarDifferentiableOptimizer() {}
/** /**
* @param convergenceChecker Convergence checker. * @param checker Convergence checker.
* @param maxIterations Maximum number of iterations. * @param maxIterations Maximum number of iterations.
* @param maxEvaluations Maximum number of evaluations. * @param maxEvaluations Maximum number of evaluations.
*/ */

View File

@ -48,7 +48,7 @@ public abstract class AbstractScalarOptimizer
*/ */
protected AbstractScalarOptimizer() {} protected AbstractScalarOptimizer() {}
/** /**
* @param convergenceChecker Convergence checker. * @param checker Convergence checker.
* @param maxIterations Maximum number of iterations. * @param maxIterations Maximum number of iterations.
* @param maxEvaluations Maximum number of evaluations. * @param maxEvaluations Maximum number of evaluations.
*/ */

View File

@ -78,7 +78,7 @@ public abstract class BaseAbstractScalarOptimizer<T extends MultivariateRealFunc
DEFAULT_MAX_EVALUATIONS); DEFAULT_MAX_EVALUATIONS);
} }
/** /**
* @param convergenceChecker Convergence checker. * @param checker Convergence checker.
* @param maxIterations Maximum number of iterations. * @param maxIterations Maximum number of iterations.
* @param maxEvaluations Maximum number of evaluations. * @param maxEvaluations Maximum number of evaluations.
*/ */