svn commit: r1243517 - in /commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization: ConvergenceChecker.java SimplePointChecker.java

[er...@apache.org]

Author: erans
Date: Mon Feb 13 14:00:31 2012
New Revision: 1243517

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

Modified:
    commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/ConvergenceChecker.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/SimplePointChecker.java

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/ConvergenceChecker.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/ConvergenceChecker.java?rev=1243517&r1=1243516&r2=1243517&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/ConvergenceChecker.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/ConvergenceChecker.java Mon Feb 13 14:00:31 2012
@@ -20,14 +20,25 @@ package org.apache.commons.math.optimiza
 /**
  * This interface specifies how to check if an optimization algorithm has
  * converged.
+ * <br/>
  * Deciding if convergence has been reached is a problem-dependent issue. The
  * user should provide a class implementing this interface to allow the
  * optimization algorithm to stop its search according to the problem at hand.
+ * <br/>
+ * For convenience, three implementations that fit simple needs are already
+ * provided: {@link SimpleValueChecker}, {@link SimpleVectorValueChecker} and
+ * {@link SimplePointChecker}. The first two consider that convergence is
+ * reached when the objective function value does not change much anymore, it
+ * does not use the point set at all.
+ * The third one considers that convergence is reached when the input point
+ * set does not change much anymore, it does not use objective function value
+ * at all.
  *
  * @param <PAIR> Type of the (point, objective value) pair.
  *
+ * @see org.apache.commons.math.optimization.SimplePointChecker
  * @see org.apache.commons.math.optimization.SimpleValueChecker
- * @see org.apache.commons.math.optimization.SimplePointChecker<PointValuePair>
+ * @see org.apache.commons.math.optimization.SimpleVectorValueChecker
  *
  * @version $Id$
  * @since 3.0

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/SimplePointChecker.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/SimplePointChecker.java?rev=1243517&r1=1243516&r2=1243517&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/SimplePointChecker.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math/optimization/SimplePointChecker.java Mon Feb 13 14:00:31 2012
@@ -30,7 +30,7 @@ import org.apache.commons.math.util.Pair
  * smaller than another threshold.
  *
  * @param <PAIR> Type of the (point, value) pair.
- * @param <V> Type of the "value" part of the pair (not used by this class).
+ * The type of the "value" part of the pair (not used by this class).
  *
  * @version $Id$
  * @since 3.0