commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From l..@apache.org
Subject svn commit: r780674 - in /commons/proper/math/trunk/src/java/org/apache/commons/math: ./ fraction/ linear/ optimization/ optimization/general/ optimization/linear/ util/
Date Mon, 01 Jun 2009 15:10:55 GMT
Author: luc
Date: Mon Jun  1 15:10:55 2009
New Revision: 780674

URL: http://svn.apache.org/viewvc?rev=780674&view=rev
Log:
fixed javadoc warnings

Modified:
    commons/proper/math/trunk/src/java/org/apache/commons/math/MathException.java
    commons/proper/math/trunk/src/java/org/apache/commons/math/fraction/AbstractFormat.java
    commons/proper/math/trunk/src/java/org/apache/commons/math/linear/DenseFieldMatrix.java
    commons/proper/math/trunk/src/java/org/apache/commons/math/linear/FieldMatrixImpl.java
    commons/proper/math/trunk/src/java/org/apache/commons/math/linear/FieldVector.java
    commons/proper/math/trunk/src/java/org/apache/commons/math/linear/FieldVectorImpl.java
    commons/proper/math/trunk/src/java/org/apache/commons/math/linear/SparseFieldVector.java
    commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/DifferentiableMultivariateVectorialOptimizer.java
    commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/LeastSquaresConverter.java
    commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateRealOptimizer.java
    commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateVectorialOptimizer.java
    commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/MultiStartUnivariateRealOptimizer.java
    commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/VectorialConvergenceChecker.java
    commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/general/GaussNewtonOptimizer.java
    commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/general/NonLinearConjugateGradientOptimizer.java
    commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/linear/LinearOptimizer.java
    commons/proper/math/trunk/src/java/org/apache/commons/math/util/DefaultTransformer.java

Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/MathException.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/MathException.java?rev=780674&r1=780673&r2=780674&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/MathException.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/MathException.java Mon Jun
 1 15:10:55 2009
@@ -29,7 +29,7 @@
 * <p>
 * Supports nesting, emulating JDK 1.4 behavior if necessary.</p>
 * <p>
-* Adapted from {@link org.apache.commons.collections.FunctorException}.</p>
+* Adapted from <a href="http://commons.apache.org/collections/api-release/org/apache/commons/collections/FunctorException.html"/>.</p>
 * 
 * @version $Revision$ $Date$
 */

Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/fraction/AbstractFormat.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/fraction/AbstractFormat.java?rev=780674&r1=780673&r2=780674&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/fraction/AbstractFormat.java
(original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/fraction/AbstractFormat.java
Mon Jun  1 15:10:55 2009
@@ -185,7 +185,7 @@
      * @param position On input: an alignment field, if desired. On output: the
      *            offsets of the alignment field
      * @return a reference to the appended buffer
-     * @see {@link #format(Object, StringBuffer, FieldPosition)}
+     * @see #format(Object, StringBuffer, FieldPosition)
      */
     @Override
     public StringBuffer format(final double value,
@@ -202,7 +202,7 @@
      * @param position On input: an alignment field, if desired. On output: the
      *            offsets of the alignment field
      * @return a reference to the appended buffer
-     * @see {@link #format(Object, StringBuffer, FieldPosition)}
+     * @see #format(Object, StringBuffer, FieldPosition)
      */
     @Override
     public StringBuffer format(final long value,

Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/linear/DenseFieldMatrix.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/linear/DenseFieldMatrix.java?rev=780674&r1=780673&r2=780674&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/linear/DenseFieldMatrix.java
(original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/linear/DenseFieldMatrix.java
Mon Jun  1 15:10:55 2009
@@ -122,7 +122,7 @@
      *
      * @exception IllegalArgumentException if <code>blockData</code> shape is
      * inconsistent with block layout
-     * @see #DenseFieldMatrix(int, int, T[][], boolean)
+     * @see #DenseFieldMatrix(int, int, FieldElement[][], boolean)
      */
     public DenseFieldMatrix(final T[][] rawData)
         throws IllegalArgumentException {
@@ -141,8 +141,8 @@
      * @exception IllegalArgumentException if <code>blockData</code> shape is
      * inconsistent with block layout
      * @see #createBlocksLayout(Field, int, int)
-     * @see #toBlocksLayout(T[][])
-     * @see #DenseFieldMatrix(T[][])
+     * @see #toBlocksLayout(FieldElement[][])
+     * @see #DenseFieldMatrix(FieldElement[][])
      */
     public DenseFieldMatrix(final int rows, final int columns,
                             final T[][] blockData, final boolean copyArray)
@@ -194,7 +194,8 @@
      * <p>
      * This method creates an array in blocks layout from an input array in raw layout.
      * It can be used to provide the array argument of the {@link
-     * DenseFieldMatrix#DenseFieldMatrix(int, int, T[][], boolean)} constructor.
+     * DenseFieldMatrix#DenseFieldMatrix(int, int, FieldElement[][], boolean)}
+     * constructor.
      * </p>
      * @param <T> the type of the field elements
      * @param rawData data array in raw layout
@@ -202,7 +203,7 @@
      * @exception IllegalArgumentException if <code>rawData</code> is not rectangular
      *  (not all rows have the same length)
      * @see #createBlocksLayout(Field, int, int)
-     * @see #DenseFieldMatrix(int, int, T[][], boolean)
+     * @see #DenseFieldMatrix(int, int, FieldElement[][], boolean)
      */
     public static <T extends FieldElement<T>> T[][] toBlocksLayout(final T[][]
rawData)
         throws IllegalArgumentException {
@@ -254,15 +255,16 @@
      * Create a data array in blocks layout.
      * <p>
      * This method can be used to create the array argument of the {@link
-     * DenseFieldMatrix#DenseFieldMatrix(int, int, T[][], boolean)} constructor.
+     * DenseFieldMatrix#DenseFieldMatrix(int, int, FieldElement[][], boolean)}
+     * constructor.
      * </p>
      * @param <T> the type of the field elements
      * @param field field to which the elements belong
      * @param rows  the number of rows in the new matrix
      * @param columns  the number of columns in the new matrix
      * @return a new data array in blocks layout
-     * @see #toBlocksLayout(T[][])
-     * @see #DenseFieldMatrix(int, int, T[][], boolean)
+     * @see #toBlocksLayout(FieldElement[][])
+     * @see #DenseFieldMatrix(int, int, FieldElement[][], boolean)
      */
     public static <T extends FieldElement<T>> T[][] createBlocksLayout(final
Field<T> field,
                                                                        final int rows, final
int columns) {

Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/linear/FieldMatrixImpl.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/linear/FieldMatrixImpl.java?rev=780674&r1=780673&r2=780674&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/linear/FieldMatrixImpl.java
(original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/linear/FieldMatrixImpl.java
Mon Jun  1 15:10:55 2009
@@ -70,14 +70,14 @@
      * Create a new FieldMatrix<T> using the input array as the underlying
      * data array.
      * <p>The input array is copied, not referenced. This constructor has
-     * the same effect as calling {@link #FieldMatrixImpl(T[][], boolean)}
+     * the same effect as calling {@link #FieldMatrixImpl(FieldElement[][], boolean)}
      * with the second argument set to <code>true</code>.</p>
      *
      * @param d data for new matrix
      * @throws IllegalArgumentException if <code>d</code> is not rectangular
      *  (not all rows have the same length) or empty
      * @throws NullPointerException if <code>d</code> is null
-     * @see #FieldMatrixImpl(T[][], boolean)
+     * @see #FieldMatrixImpl(FieldElement[][], boolean)
      */
     public FieldMatrixImpl(final T[][] d)
         throws IllegalArgumentException, NullPointerException {
@@ -98,7 +98,7 @@
      * @throws IllegalArgumentException if <code>d</code> is not rectangular
      *  (not all rows have the same length) or empty
      * @throws NullPointerException if <code>d</code> is null
-     * @see #FieldMatrixImpl(T[][])
+     * @see #FieldMatrixImpl(FieldElement[][])
      */
     public FieldMatrixImpl(final T[][] d, final boolean copyArray)
         throws IllegalArgumentException, NullPointerException {

Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/linear/FieldVector.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/linear/FieldVector.java?rev=780674&r1=780673&r2=780674&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/linear/FieldVector.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/linear/FieldVector.java Mon
Jun  1 15:10:55 2009
@@ -329,7 +329,7 @@
      * @param v vector containing the values to set.
      * @exception MatrixIndexException if the index is
      * inconsistent with vector size
-     * @see #setSubVector(int, T[])
+     * @see #setSubVector(int, FieldElement[])
      */
     void setSubVector(int index, FieldVector<T> v)
         throws MatrixIndexException;

Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/linear/FieldVectorImpl.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/linear/FieldVectorImpl.java?rev=780674&r1=780673&r2=780674&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/linear/FieldVectorImpl.java
(original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/linear/FieldVectorImpl.java
Mon Jun  1 15:10:55 2009
@@ -55,8 +55,8 @@
      * <p>Zero-length vectors may be used to initialized construction of vectors
      * by data gathering. We start with zero-length and use either the {@link
      * #FieldVectorImpl(FieldVectorImpl, FieldVectorImpl)} constructor
-     * or one of the <code>append</code> methods ({@link #append(double)}, {@link
-     * #append(T[])}, {@link #append(FieldVectorImpl)}) to gather data
+     * or one of the <code>append</code> methods ({@link #append(FieldElement[])},
+     * {@link #add(FieldVector)}, {@link #append(FieldVectorImpl)}) to gather data
      * into this vector.</p>
      * @param field field to which the elements belong
      */
@@ -113,7 +113,7 @@
      * it will be referenced
      * @throws IllegalArgumentException if <code>d</code> is empty
      * @throws NullPointerException if <code>d</code> is null
-     * @see #FieldVectorImpl(T[])
+     * @see #FieldVectorImpl(FieldElement[])
      */
     public FieldVectorImpl(T[] d, boolean copyArray)
         throws NullPointerException, IllegalArgumentException {

Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/linear/SparseFieldVector.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/linear/SparseFieldVector.java?rev=780674&r1=780673&r2=780674&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/linear/SparseFieldVector.java
(original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/linear/SparseFieldVector.java
Mon Jun  1 15:10:55 2009
@@ -47,10 +47,10 @@
      * Build a 0-length vector.
      * <p>Zero-length vectors may be used to initialize construction of vectors
      * by data gathering. We start with zero-length and use either the {@link
-     * #SparseFieldVector(SparseFieldVector<T>, int)} constructor
-     * or one of the <code>append</code> method ({@link #append(Field<T>)},
{@link
-     * #append(Field<T>[])}, {@link #append(FieldVector)}) to gather data
-     * into this vector.</p>
+     * #SparseFieldVector(SparseFieldVector, int)} constructor
+     * or one of the <code>append</code> method ({@link #append(FieldElement)},
+     * {@link #append(FieldElement[])}, {@link #append(FieldVector)},
+     * {@link #append(SparseFieldVector)}) to gather data into this vector.</p>
      * @param field field to which the elements belong
      */
     public SparseFieldVector(Field<T> field) {
@@ -164,7 +164,11 @@
         return res;
     }
 
-    /** {@inheritDoc} */
+    /**
+     * Construct a vector by appending a vector to this vector.
+     * @param v vector to append to this one.
+     * @return a new vector
+     */
     public FieldVector<T> append(SparseFieldVector<T> v) {
         SparseFieldVector<T> res = new SparseFieldVector<T>(this, v.getDimension());
         OpenIntToFieldHashMap<T>.Iterator iter = v.entries.iterator();

Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/DifferentiableMultivariateVectorialOptimizer.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/DifferentiableMultivariateVectorialOptimizer.java?rev=780674&r1=780673&r2=780674&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/DifferentiableMultivariateVectorialOptimizer.java
(original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/DifferentiableMultivariateVectorialOptimizer.java
Mon Jun  1 15:10:55 2009
@@ -53,8 +53,9 @@
     /** Get the number of evaluations of the objective function.
      * <p>
      * The number of evaluation correspond to the last call to the
-     * {@link #optimize(ObjectiveFunction, GoalType, double[]) optimize}
-     * method. It is 0 if the method has not been called yet.
+     * {@link #optimize(DifferentiableMultivariateVectorialFunction,
+     * double[], double[], double[]) optimize} method. It is 0 if
+     * the method has not been called yet.
      * </p>
      * @return number of evaluations of the objective function
      */
@@ -63,8 +64,9 @@
     /** Get the number of evaluations of the objective function jacobian .
      * <p>
      * The number of evaluation correspond to the last call to the
-     * {@link #optimize(ObjectiveFunction, GoalType, double[]) optimize}
-     * method. It is 0 if the method has not been called yet.
+     * {@link #optimize(DifferentiableMultivariateVectorialFunction,
+     * double[], double[], double[]) optimize} method. It is 0 if
+     * the method has not been called yet.
      * </p>
      * @return number of evaluations of the objective function jacobian
      */

Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/LeastSquaresConverter.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/LeastSquaresConverter.java?rev=780674&r1=780673&r2=780674&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/LeastSquaresConverter.java
(original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/LeastSquaresConverter.java
Mon Jun  1 15:10:55 2009
@@ -106,7 +106,7 @@
      * @param weights weights to apply to the residuals
      * @exception IllegalArgumentException if the observations vector and the weights
      * vector dimensions don't match (objective function dimension is checked only when
-     * the {@link #objective} method is called)
+     * the {@link #value(double[])} method is called)
      */
     public LeastSquaresConverter(final MultivariateVectorialFunction function,
                                  final double[] observations, final double[] weights)
@@ -139,7 +139,7 @@
      * @param scale scaling matrix
      * @exception IllegalArgumentException if the observations vector and the scale
      * matrix dimensions don't match (objective function dimension is checked only when
-     * the {@link #objective} method is called)
+     * the {@link #value(double[])} method is called)
      */
     public LeastSquaresConverter(final MultivariateVectorialFunction function,
                                  final double[] observations, final RealMatrix scale)

Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateRealOptimizer.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateRealOptimizer.java?rev=780674&r1=780673&r2=780674&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateRealOptimizer.java
(original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateRealOptimizer.java
Mon Jun  1 15:10:55 2009
@@ -24,7 +24,6 @@
 import org.apache.commons.math.FunctionEvaluationException;
 import org.apache.commons.math.MathRuntimeException;
 import org.apache.commons.math.analysis.DifferentiableMultivariateRealFunction;
-import org.apache.commons.math.analysis.MultivariateRealFunction;
 import org.apache.commons.math.random.RandomVectorGenerator;
 
 /** 
@@ -90,14 +89,15 @@
     }
 
     /** Get all the optima found during the last call to {@link
-     * #optimize(MultivariateRealFunction, GoalType, double[]) optimize}.
+     * #optimize(DifferentiableMultivariateRealFunction, GoalType, double[])
+     * optimize}.
      * <p>The optimizer stores all the optima found during a set of
-     * restarts. The {@link #optimize(MultivariateRealFunction, GoalType,
-     * double[]) optimize} method returns the best point only. This
+     * restarts. The {@link #optimize(DifferentiableMultivariateRealFunction,
+     * GoalType, double[]) optimize} method returns the best point only. This
      * method returns all the points found at the end of each starts,
      * including the best one already returned by the {@link
-     * #optimize(MultivariateRealFunction, GoalType, double[]) optimize}
-     * method.
+     * #optimize(DifferentiableMultivariateRealFunction, GoalType, double[])
+     * optimize} method.
      * </p>
      * <p>
      * The returned array as one element for each start as specified
@@ -106,13 +106,13 @@
      * objective value (i.e in ascending order if minimizing and in
      * descending order if maximizing), followed by and null elements
      * corresponding to the runs that did not converge. This means all
-     * elements will be null if the {@link #optimize(MultivariateRealFunction,
+     * elements will be null if the {@link #optimize(DifferentiableMultivariateRealFunction,
      * GoalType, double[]) optimize} method did throw a {@link
      * ConvergenceException ConvergenceException}). This also means that
      * if the first element is non null, it is the best point found across
      * all starts.</p>
      * @return array containing the optima
-     * @exception IllegalStateException if {@link #optimize(MultivariateRealFunction,
+     * @exception IllegalStateException if {@link #optimize(DifferentiableMultivariateRealFunction,
      * GoalType, double[]) optimize} has not been called
      */
     public RealPointValuePair[] getOptima() throws IllegalStateException {

Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateVectorialOptimizer.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateVectorialOptimizer.java?rev=780674&r1=780673&r2=780674&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateVectorialOptimizer.java
(original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/MultiStartDifferentiableMultivariateVectorialOptimizer.java
Mon Jun  1 15:10:55 2009
@@ -24,7 +24,6 @@
 import org.apache.commons.math.FunctionEvaluationException;
 import org.apache.commons.math.MathRuntimeException;
 import org.apache.commons.math.analysis.DifferentiableMultivariateVectorialFunction;
-import org.apache.commons.math.analysis.MultivariateRealFunction;
 import org.apache.commons.math.random.RandomVectorGenerator;
 
 /** 
@@ -91,14 +90,15 @@
     }
 
     /** Get all the optima found during the last call to {@link
-     * #optimize(MultivariateRealFunction, GoalType, double[]) optimize}.
+     * #optimize(DifferentiableMultivariateVectorialFunction,
+     * double[], double[], double[]) optimize}.
      * <p>The optimizer stores all the optima found during a set of
-     * restarts. The {@link #optimize(MultivariateRealFunction, GoalType,
-     * double[]) optimize} method returns the best point only. This
-     * method returns all the points found at the end of each starts,
-     * including the best one already returned by the {@link
-     * #optimize(MultivariateRealFunction, GoalType, double[]) optimize}
-     * method.
+     * restarts. The {@link #optimize(DifferentiableMultivariateVectorialFunction,
+     * double[], double[], double[]) optimize} method returns the
+     * best point only. This method returns all the points found at the
+     * end of each starts, including the best one already returned by the {@link
+     * #optimize(DifferentiableMultivariateVectorialFunction, double[],
+     * double[], double[]) optimize} method.
      * </p>
      * <p>
      * The returned array as one element for each start as specified
@@ -107,14 +107,14 @@
      * objective value (i.e in ascending order if minimizing and in
      * descending order if maximizing), followed by and null elements
      * corresponding to the runs that did not converge. This means all
-     * elements will be null if the {@link #optimize(MultivariateRealFunction,
-     * GoalType, double[]) optimize} method did throw a {@link
+     * elements will be null if the {@link #optimize(DifferentiableMultivariateVectorialFunction,
+     * double[], double[], double[]) optimize} method did throw a {@link
      * ConvergenceException ConvergenceException}). This also means that
      * if the first element is non null, it is the best point found across
      * all starts.</p>
      * @return array containing the optima
-     * @exception IllegalStateException if {@link #optimize(MultivariateRealFunction,
-     * GoalType, double[]) optimize} has not been called
+     * @exception IllegalStateException if {@link #optimize(DifferentiableMultivariateVectorialFunction,
+     * double[], double[], double[]) optimize} has not been called
      */
     public VectorialPointValuePair[] getOptima() throws IllegalStateException {
         if (optima == null) {

Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/MultiStartUnivariateRealOptimizer.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/MultiStartUnivariateRealOptimizer.java?rev=780674&r1=780673&r2=780674&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/MultiStartUnivariateRealOptimizer.java
(original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/MultiStartUnivariateRealOptimizer.java
Mon Jun  1 15:10:55 2009
@@ -22,7 +22,6 @@
 import org.apache.commons.math.ConvergenceException;
 import org.apache.commons.math.FunctionEvaluationException;
 import org.apache.commons.math.MathRuntimeException;
-import org.apache.commons.math.analysis.MultivariateRealFunction;
 import org.apache.commons.math.analysis.UnivariateRealFunction;
 import org.apache.commons.math.random.RandomGenerator;
 
@@ -140,13 +139,13 @@
     }
 
     /** Get all the optima found during the last call to {@link
-     * #optimize(MultivariateRealFunction, GoalType, double[]) optimize}.
+     * #optimize(UnivariateRealFunction, GoalType, double, double) optimize}.
      * <p>The optimizer stores all the optima found during a set of
-     * restarts. The {@link #optimize(MultivariateRealFunction, GoalType,
-     * double[]) optimize} method returns the best point only. This
+     * restarts. The {@link #optimize(UnivariateRealFunction, GoalType,
+     * double, double) optimize} method returns the best point only. This
      * method returns all the points found at the end of each starts,
      * including the best one already returned by the {@link
-     * #optimize(MultivariateRealFunction, GoalType, double[]) optimize}
+     * #optimize(UnivariateRealFunction, GoalType, double, double) optimize}
      * method.
      * </p>
      * <p>
@@ -156,14 +155,14 @@
      * objective value (i.e in ascending order if minimizing and in
      * descending order if maximizing), followed by and null elements
      * corresponding to the runs that did not converge. This means all
-     * elements will be null if the {@link #optimize(MultivariateRealFunction,
-     * GoalType, double[]) optimize} method did throw a {@link
+     * elements will be null if the {@link #optimize(UnivariateRealFunction,
+     * GoalType, double, double) optimize} method did throw a {@link
      * ConvergenceException ConvergenceException}). This also means that
      * if the first element is non null, it is the best point found across
      * all starts.</p>
      * @return array containing the optima
-     * @exception IllegalStateException if {@link #optimize(MultivariateRealFunction,
-     * GoalType, double[]) optimize} has not been called
+     * @exception IllegalStateException if {@link #optimize(UnivariateRealFunction,
+     * GoalType, double, double) optimize} has not been called
      */
     public double[] getOptima() throws IllegalStateException {
         if (optima == null) {

Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/VectorialConvergenceChecker.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/VectorialConvergenceChecker.java?rev=780674&r1=780673&r2=780674&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/VectorialConvergenceChecker.java
(original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/VectorialConvergenceChecker.java
Mon Jun  1 15:10:55 2009
@@ -17,8 +17,8 @@
 
 package org.apache.commons.math.optimization;
 
-/** This interface specifies how to check if an {@link VectorialOptimizer optimization
- * algorithm} has converged.
+/** This interface specifies how to check if a {@link
+ * DifferentiableMultivariateVectorialOptimizer optimization algorithm} has converged.
  *
  * <p>Deciding if convergence has been reached is a problem-dependent issue. The
  * user should provide a class implementing this interface to allow the optimization

Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/general/GaussNewtonOptimizer.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/general/GaussNewtonOptimizer.java?rev=780674&r1=780673&r2=780674&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/general/GaussNewtonOptimizer.java
(original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/general/GaussNewtonOptimizer.java
Mon Jun  1 15:10:55 2009
@@ -53,7 +53,7 @@
     /** Simple constructor with default settings.
      * <p>The convergence check is set to a {@link SimpleVectorialValueChecker}
      * and the maximal number of evaluation is set to
-     * {@link AbstractLinearOptimizer#DEFAULT_MAX_ITERATIONS}.
+     * {@link AbstractLeastSquaresOptimizer#DEFAULT_MAX_ITERATIONS}.
      * @param useLU if true, the normal equations will be solved using LU
      * decomposition, otherwise they will be solved using QR decomposition
      */

Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/general/NonLinearConjugateGradientOptimizer.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/general/NonLinearConjugateGradientOptimizer.java?rev=780674&r1=780673&r2=780674&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/general/NonLinearConjugateGradientOptimizer.java
(original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/general/NonLinearConjugateGradientOptimizer.java
Mon Jun  1 15:10:55 2009
@@ -64,11 +64,11 @@
 
     /** Simple constructor with default settings.
      * <p>The convergence check is set to a {@link SimpleVectorialValueChecker}
-     * and the maximal number of evaluation is set to
-     * {@link AbstractLinearOptimizer#DEFAULT_MAX_EVALUATIONS}.
+     * and the maximal number of iterations is set to
+     * {@link AbstractScalarDifferentiableOptimizer#DEFAULT_MAX_ITERATIONS}.
      * @param updateFormula formula to use for updating the &beta; parameter,
-     * must be one of {@link UpdateFormula#FLETCHER_REEVES} or {@link
-     * UpdateFormula#POLAK_RIBIERE}
+     * must be one of {@link ConjugateGradientFormula#FLETCHER_REEVES} or {@link
+     * ConjugateGradientFormula#POLAK_RIBIERE}
      */
     public NonLinearConjugateGradientOptimizer(final ConjugateGradientFormula updateFormula)
{
         this.updateFormula = updateFormula;

Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/linear/LinearOptimizer.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/linear/LinearOptimizer.java?rev=780674&r1=780673&r2=780674&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/linear/LinearOptimizer.java
(original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/linear/LinearOptimizer.java
Mon Jun  1 15:10:55 2009
@@ -20,7 +20,6 @@
 import java.io.Serializable;
 import java.util.Collection;
 
-import org.apache.commons.math.analysis.DifferentiableMultivariateRealFunction;
 import org.apache.commons.math.optimization.GoalType;
 import org.apache.commons.math.optimization.OptimizationException;
 import org.apache.commons.math.optimization.RealPointValuePair;
@@ -67,7 +66,7 @@
     /** Get the number of iterations realized by the algorithm.
      * <p>
      * The number of evaluations corresponds to the last call to the
-     * {@link #optimize(DifferentiableMultivariateRealFunction, GoalType, double[]) optimize}
+     * {@link #optimize(LinearObjectiveFunction, Collection, GoalType, boolean) optimize}
      * method. It is 0 if the method has not been called yet.
      * </p>
      * @return number of iterations

Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/util/DefaultTransformer.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/util/DefaultTransformer.java?rev=780674&r1=780673&r2=780674&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/util/DefaultTransformer.java
(original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/util/DefaultTransformer.java
Mon Jun  1 15:10:55 2009
@@ -23,7 +23,7 @@
 
 /**
  * A Default NumberTransformer for java.lang.Numbers and Numeric Strings. This 
- * provides some simple conversion capabilities to turn any java/lang.Number 
+ * provides some simple conversion capabilities to turn any java.lang.Number 
  * into a primitive double or to turn a String representation of a Number into 
  * a double.
  *
@@ -41,7 +41,7 @@
      * @return a double primitive representation of the Object o.
      * @throws org.apache.commons.math.MathException If it cannot successfully 
      * be transformed or is null.
-     * @see org.apache.commons.collections.Transformer#transform(java.lang.Object)
+     * @see <a href="http://commons.apache.org/collections/api-release/org/apache/commons/collections/Transformer.html"/>
      */
     public double transform(Object o) throws MathException{
 



Mime
View raw message