Mailing-List: contact commits-help@commons.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@commons.apache.org
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Subject: svn commit: r1003352 - in
 /commons/proper/math/trunk/src/main/java/org/apache/commons/math:
 optimization/ optimization/univariate/ util/
Date: Fri, 01 Oct 2010 01:55:28 -0000
To: commits@commons.apache.org
From: sebb@apache.org
Message-Id: <20101001015529.02D372388A02@eris.apache.org>

Author: sebb
Date: Fri Oct  1 01:55:28 2010
New Revision: 1003352

URL: http://svn.apache.org/viewvc?rev=1003352&view=rev
Log:
Javadoc fixes

Modified:
    commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/BaseMultiStartMultivariateRealOptimizer.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/BaseMultiStartMultivariateVectorialOptimizer.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/univariate/MultiStartUnivariateRealOptimizer.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math/util/MultidimensionalCounter.java

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/BaseMultiStartMultivariateRealOptimizer.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/BaseMultiStartMultivariateRealOptimizer.java?rev=1003352&r1=1003351&r2=1003352&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/BaseMultiStartMultivariateRealOptimizer.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/BaseMultiStartMultivariateRealOptimizer.java Fri Oct  1 01:55:28 2010
@@ -74,13 +74,13 @@ public class BaseMultiStartMultivariateR
 
     /**
      * Get all the optima found during the last call to {@link
-     * #optimize(FUNC,GoalType,double[]) optimize}.
+     * #optimize(MultivariateRealFunction,GoalType,double[]) optimize}.
      * The optimizer stores all the optima found during a set of
-     * restarts. The {@link #optimize(FUNC,GoalType,double[])
+     * 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(FUNC,GoalType,double[]) optimize} method.
+     * #optimize(MultivariateRealFunction,GoalType,double[]) optimize} method.
      * <br/>
      * The returned array as one element for each start as specified
      * in the constructor. It is ordered with the results from the
@@ -88,14 +88,14 @@ public class BaseMultiStartMultivariateR
      * 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(FUNC,GoalType,double[])
+     * elements will be null if the {@link #optimize(MultivariateRealFunction,GoalType,double[])
      * optimize} method did throw a {@link ConvergenceException}).
      * This also means that if the first element is not {@code null}, it
      * is the best point found across all starts.
      *
      * @return an array containing the optima.
      * @throws MathIllegalStateException if {@link
-     * #optimize(FUNC,GoalType,double[]) optimize} has not been called.
+     * #optimize(MultivariateRealFunction,GoalType,double[]) optimize} has not been called.
      */
     public RealPointValuePair[] getOptima() {
         if (optima == null) {

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/BaseMultiStartMultivariateVectorialOptimizer.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/BaseMultiStartMultivariateVectorialOptimizer.java?rev=1003352&r1=1003351&r2=1003352&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/BaseMultiStartMultivariateVectorialOptimizer.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/BaseMultiStartMultivariateVectorialOptimizer.java Fri Oct  1 01:55:28 2010
@@ -73,13 +73,13 @@ public class BaseMultiStartMultivariateV
 
     /**
      * Get all the optima found during the last call to {@link
-     * #optimize(FUNC,double[],double[],double[]) optimize}.
+     * #optimize(MultivariateVectorialFunction,double[],double[],double[]) optimize}.
      * The optimizer stores all the optima found during a set of
-     * restarts. The {@link #optimize(FUNC,double[],double[],double[])
+     * restarts. The {@link #optimize(MultivariateVectorialFunction,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(FUNC,double[],double[],double[]) optimize} method.
+     * #optimize(MultivariateVectorialFunction,double[],double[],double[]) optimize} method.
      * <br/>
      * The returned array as one element for each start as specified
      * in the constructor. It is ordered with the results from the
@@ -88,14 +88,14 @@ public class BaseMultiStartMultivariateV
      * 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(FUNC,double[],double[],double[]) optimize} method did
+     * #optimize(MultivariateVectorialFunction,double[],double[],double[]) optimize} method did
      * throw a {@link ConvergenceException}). This also means that if
      * the first element is not {@code null}, it is the best point found
      * across all starts.
      *
      * @return array containing the optima
      * @throws MathIllegalStateException if {@link
-     * #optimize(FUNC,double[],double[],double[]) optimize} has not been
+     * #optimize(MultivariateVectorialFunction,double[],double[],double[]) optimize} has not been
      * called.
      */
     public VectorialPointValuePair[] getOptima() {

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/univariate/MultiStartUnivariateRealOptimizer.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/univariate/MultiStartUnivariateRealOptimizer.java?rev=1003352&r1=1003351&r2=1003352&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/univariate/MultiStartUnivariateRealOptimizer.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/univariate/MultiStartUnivariateRealOptimizer.java Fri Oct  1 01:55:28 2010
@@ -106,12 +106,12 @@ public class MultiStartUnivariateRealOpt
 
     /**
      * Get all the optima found during the last call to {@link
-     * #optimize(FUNC,GoalType,double,double) optimize}.
+     * #optimize(UnivariateRealFunction,GoalType,double,double) optimize}.
      * The optimizer stores all the optima found during a set of
-     * restarts. The {@link #optimize(FUNC,GoalType,double,double) optimize}
+     * 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(FUNC,GoalType,double,double) optimize}
+     * returned by the {@link #optimize(UnivariateRealFunction,GoalType,double,double) optimize}
      * method.
      * <br/>
      * The returned array as one element for each start as specified
@@ -121,14 +121,14 @@ public class MultiStartUnivariateRealOpt
      * descending order if maximizing), followed by {@code null} elements
      * corresponding to the runs that did not converge. This means all
      * elements will be {@code null} if the {@link
-     * #optimize(FUNC,GoalType,double,double) optimize} method did throw a
+     * #optimize(UnivariateRealFunction,GoalType,double,double) optimize} method did throw a
      * {@link ConvergenceException}). This also means that if the first
      * element is not {@code null}, it is the best point found across all
      * starts.
      *
      * @return an array containing the optima.
      * @throws MathIllegalStateException if {@link
-     * #optimize(FUNC,GoalType,double,double) optimize} has not been called.
+     * #optimize(UnivariateRealFunction,GoalType,double,double) optimize} has not been called.
      */
     public UnivariateRealPointValuePair[] getOptima() {
         if (optima == null) {

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math/util/MultidimensionalCounter.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math/util/MultidimensionalCounter.java?rev=1003352&r1=1003351&r2=1003352&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math/util/MultidimensionalCounter.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math/util/MultidimensionalCounter.java Fri Oct  1 01:55:28 2010
@@ -148,7 +148,7 @@ public class MultidimensionalCounter imp
         }
 
         /**
-         * @throws UnsupportedOperationException.
+         * @throws UnsupportedOperationException
          */
         public void remove() {
             throw new UnsupportedOperationException();