svn commit: r1573341 - /commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optim/nonlinear/scalar/LineSearch.java

[er...@apache.org]

Author: erans
Date: Sun Mar  2 19:38:47 2014
New Revision: 1573341

URL: http://svn.apache.org/r1573341
Log:
MATH-1092
Javadoc.

Modified:
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optim/nonlinear/scalar/LineSearch.java

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optim/nonlinear/scalar/LineSearch.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optim/nonlinear/scalar/LineSearch.java?rev=1573341&r1=1573340&r2=1573341&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optim/nonlinear/scalar/LineSearch.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optim/nonlinear/scalar/LineSearch.java Sun Mar  2 19:38:47 2014
@@ -69,8 +69,8 @@ public class LineSearch {
      * tolerances to check the domain (point) values, not the function
      * values.
      * The {@code relativeTolerance} and {@code absoluteTolerance}
-     * arguments are thus passed to a custom checker that will use
-     * the function values.
+     * arguments are thus passed to a {@link SimpleUnivariateValueChecker
+     * custom checker} that will use the function values.
      *
      * @param optimizer Optimizer on behalf of which the line search
      * be performed.
@@ -78,9 +78,9 @@ public class LineSearch {
      * computeObjectiveValue} method will be called by the
      * {@link #search(double[],double[]) search} method.
      * @param relativeTolerance Search will stop when the function relative
-     * difference between successive iterations is smaller than this value.
+     * difference between successive iterations is below this value.
      * @param absoluteTolerance Search will stop when the function absolute
-     * difference between successive iterations is smaller than this value.
+     * difference between successive iterations is below this value.
      * @param initialBracketingRange Extent of the initial interval used to
      * find an interval that brackets the optimum.
      * If the optimized function varies a lot in the vicinity of the optimum,