svn commit: r1060430 - in /commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization: BaseMultiStartMultivariateRealOptimizer.java BaseMultiStartMultivariateVectorialOptimizer.java univariate/MultiStartUnivariateRealOptimizer.java

[er...@apache.org]

Author: erans
Date: Tue Jan 18 16:02:30 2011
New Revision: 1060430

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

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

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=1060430&r1=1060429&r2=1060430&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 Tue Jan 18 16:02:30 2011
@@ -60,8 +60,9 @@ public class BaseMultiStartMultivariateR
      * Create a multi-start optimizer from a single-start optimizer.
      *
      * @param optimizer Single-start optimizer to wrap.
-     * @param starts Number of starts to perform, must be >=1. 
-     * Multi-start is disabled if {@code starts == 1}.
+     * @param starts Number of starts to perform. If {@code starts == 1},
+     * the {@link #optimize(int,MultivariateRealFunction,GoalType,double[])
+     * optimize} will return the same solution as {@code optimizer} would.
      * @param generator Random vector generator to use for restarts.
      * @throws NullArgumentException if {@code optimizer} or {@code generator}
      * is {@code 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=1060430&r1=1060429&r2=1060430&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 Tue Jan 18 16:02:30 2011
@@ -60,8 +60,9 @@ public class BaseMultiStartMultivariateV
      * Create a multi-start optimizer from a single-start optimizer.
      *
      * @param optimizer Single-start optimizer to wrap.
-     * @param starts Number of starts to perform, must be >=1. 
-     * Multi-start is disabled if {@code starts == 1}.
+     * @param starts Number of starts to perform. If {@code starts == 1},
+     * the {@link #optimize(int,MultivariateVectorialFunction,double[],double[],double[])
+     * optimize} will return the same solution as {@code optimizer} would.
      * @param generator Random vector generator to use for restarts.
      * @throws NullArgumentException if {@code optimizer} or {@code generator}
      * is {@code null}.

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=1060430&r1=1060429&r2=1060430&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 Tue Jan 18 16:02:30 2011
@@ -62,8 +62,9 @@ public class MultiStartUnivariateRealOpt
      * Create a multi-start optimizer from a single-start optimizer.
      *
      * @param optimizer Single-start optimizer to wrap.
-     * @param starts Number of starts to perform, must be >=1. 
-     * Multi-start is disabled if {@code starts == 1}.
+     * @param starts Number of starts to perform. If {@code starts == 1},
+     * the {@code optimize} methods will return the same solution as
+     * {@code optimizer} would.
      * @param generator Random generator to use for restarts.
      * @throws NullArgumentException if {@code optimizer} or {@code generator}
      * is {@code null}.