commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From t.@apache.org
Subject svn commit: r1591835 [1/2] - in /commons/proper/math/trunk/src/main/java/org/apache/commons/math3: ./ complex/ geometry/enclosing/ geometry/euclidean/threed/ geometry/partitioning/ geometry/partitioning/utilities/ geometry/spherical/twod/ optim/ optimi...
Date Fri, 02 May 2014 09:04:02 GMT
Author: tn
Date: Fri May  2 09:04:01 2014
New Revision: 1591835

URL: http://svn.apache.org/r1591835
Log:
Revert javadoc changes after discussion on the mailinglist.

Modified:
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/RealFieldElement.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/complex/Complex.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/enclosing/WelzlEncloser.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/euclidean/threed/FieldRotation.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/euclidean/threed/FieldVector3D.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/euclidean/threed/Rotation.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/euclidean/threed/Vector3D.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/Embedding.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/utilities/OrderedTuple.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/spherical/twod/SphericalPolygonsSet.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optim/BaseMultiStartMultivariateOptimizer.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optim/ConvergenceChecker.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optim/InitialGuess.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optim/SimpleBounds.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optim/SimpleValueChecker.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optim/SimpleVectorValueChecker.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optim/package-info.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/BaseMultivariateMultiStartOptimizer.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/BaseMultivariateVectorMultiStartOptimizer.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/ConvergenceChecker.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/InitialGuess.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/LeastSquaresConverter.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/SimpleBounds.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/SimplePointChecker.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/SimpleValueChecker.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/SimpleVectorValueChecker.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/Target.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/Weight.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/fitting/CurveFitter.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/fitting/HarmonicFitter.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/general/AbstractLeastSquaresOptimizer.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/general/LevenbergMarquardtOptimizer.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/package-info.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/univariate/BrentOptimizer.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/univariate/SimpleUnivariateValueChecker.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/univariate/UnivariateMultiStartOptimizer.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/util/ArithmeticUtils.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/util/Combinations.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/util/CombinatoricsUtils.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/util/ContinuedFraction.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/util/FastMath.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/util/MathArrays.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/util/MathUtils.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/util/Pair.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/util/Precision.java
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/util/ResizableDoubleArray.java

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/RealFieldElement.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/RealFieldElement.java?rev=1591835&r1=1591834&r2=1591835&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/RealFieldElement.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/RealFieldElement.java Fri May  2 09:04:01 2014
@@ -53,7 +53,7 @@ public interface RealFieldElement<T> ext
 
     /** '&divide;' operator.
      * @param a right hand side parameter of the operator
-     * @return this&divide;a
+     * @return this&divides;a
      */
     T divide(double a);
 
@@ -89,7 +89,7 @@ public interface RealFieldElement<T> ext
     T floor();
 
     /** Get the whole number that is the nearest to the instance, or the even one if x is exactly half way between two integers.
-     * @return a double number r such that r is an integer r - 0.5 &le; this &le; r + 0.5
+     * @return a double number r such that r is an integer r - 0.5 <= this <= r + 0.5
      */
     T rint();
 
@@ -131,7 +131,7 @@ public interface RealFieldElement<T> ext
 
     /**
      * Returns the hypotenuse of a triangle with sides {@code this} and {@code y}
-     * - sqrt(<i>this</i><sup>2</sup>&nbsp;+<i>y</i><sup>2</sup>)
+     * - sqrt(<i>this</i><sup>2</sup>&nbsp;+<i>y</i><sup>2</sup>)<br/>
      * avoiding intermediate overflow or underflow.
      *
      * <ul>

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/complex/Complex.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/complex/Complex.java?rev=1591835&r1=1591834&r2=1591835&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/complex/Complex.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/complex/Complex.java Fri May  2 09:04:01 2014
@@ -32,7 +32,7 @@ import org.apache.commons.math3.util.Pre
 /**
  * Representation of a Complex number, i.e. a number which has both a
  * real and imaginary part.
- * <p>
+ * <br/>
  * Implementations of arithmetic operations handle {@code NaN} and
  * infinite values according to the rules for {@link java.lang.Double}, i.e.
  * {@link #equals} is an equivalence relation for all instances that have
@@ -50,7 +50,7 @@ import org.apache.commons.math3.util.Pre
  * equals for primitive double} in {@link org.apache.commons.math3.util.Precision}
  * conforms with IEEE-754 while this class conforms with the standard behavior
  * for Java object types.
- * <p>
+ * <br/>
  * Implements Serializable since 2.0
  *
  * @version $Id$
@@ -144,7 +144,7 @@ public class Complex implements FieldEle
      *   (a + bi) + (c + di) = (a+c) + (b+d)i
      *  </code>
      * </pre>
-     * <p>
+     * <br/>
      * If either {@code this} or {@code addend} has a {@code NaN} value in
      * either part, {@link #NaN} is returned; otherwise {@code Infinite}
      * and {@code NaN} values are returned in the parts of the result
@@ -183,10 +183,10 @@ public class Complex implements FieldEle
      /**
      * Return the conjugate of this complex number.
      * The conjugate of {@code a + bi} is {@code a - bi}.
-     * <p>
+     * <br/>
      * {@link #NaN} is returned if either the real or imaginary
      * part of this Complex number equals {@code Double.NaN}.
-     * <p>
+     * <br/>
      * If the imaginary part is infinite, and the real part is not
      * {@code NaN}, the returned value has infinite imaginary part
      * of the opposite sign, e.g. the conjugate of
@@ -217,7 +217,7 @@ public class Complex implements FieldEle
      * <a href="http://doi.acm.org/10.1145/1039813.1039814">
      * prescaling of operands</a> to limit the effects of overflows and
      * underflows in the computation.
-     * <p>
+     * <br/>
      * {@code Infinite} and {@code NaN} values are handled according to the
      * following rules, applied in the order presented:
      * <ul>
@@ -508,12 +508,12 @@ public class Complex implements FieldEle
      * </pre>
      * Returns {@link #NaN} if either {@code this} or {@code factor} has one or
      * more {@code NaN} parts.
-     * <p>
+     * <br/>
      * Returns {@link #INF} if neither {@code this} nor {@code factor} has one
      * or more {@code NaN} parts and if either {@code this} or {@code factor}
      * has one or more infinite parts (same result is returned regardless of
      * the sign of the components).
-     * <p>
+     * <br/>
      * Returns finite values in components of the result per the definitional
      * formula in all remaining cases.
      *
@@ -724,10 +724,10 @@ public class Complex implements FieldEle
      * where the (real) functions on the right-hand side are
      * {@link FastMath#sin}, {@link FastMath#cos},
      * {@link FastMath#cosh} and {@link FastMath#sinh}.
-     * <p>
+     * <br/>
      * Returns {@link Complex#NaN} if either real or imaginary part of the
      * input argument is {@code NaN}.
-     * <p>
+     * <br/>
      * Infinite values in real or imaginary parts of the input may result in
      * infinite or NaN values returned in parts of the result.
      * <pre>

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/enclosing/WelzlEncloser.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/enclosing/WelzlEncloser.java?rev=1591835&r1=1591834&r2=1591835&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/enclosing/WelzlEncloser.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/enclosing/WelzlEncloser.java Fri May  2 09:04:01 2014
@@ -32,10 +32,10 @@ import org.apache.commons.math3.geometry
  * href="http://www.inf.ethz.ch/personal/gaertner/texts/own_work/esa99_final.pdf">Fast and
  * Robust Smallest Enclosing Balls</a>, by Bernd Gärtner and further modified in
  * paper <a
- * href="http://www.idt.mdh.se/kurser/ct3340/ht12/MINICONFERENCE/FinalPapers/ircse12_submission_30.pdf">
+ * href=http://www.idt.mdh.se/kurser/ct3340/ht12/MINICONFERENCE/FinalPapers/ircse12_submission_30.pdf">
  * Efficient Computation of Smallest Enclosing Balls in Three Dimensions</a> by Linus Källberg
  * to avoid performing local copies of data have been included.
- *
+ * </p>
  * @param <S> Space type.
  * @param <P> Point type.
  * @version $Id$

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/euclidean/threed/FieldRotation.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/euclidean/threed/FieldRotation.java?rev=1591835&r1=1591834&r2=1591835&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/euclidean/threed/FieldRotation.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/euclidean/threed/FieldRotation.java Fri May  2 09:04:01 2014
@@ -19,8 +19,8 @@ package org.apache.commons.math3.geometr
 
 import java.io.Serializable;
 
-import org.apache.commons.math3.Field;
 import org.apache.commons.math3.RealFieldElement;
+import org.apache.commons.math3.Field;
 import org.apache.commons.math3.exception.MathArithmeticException;
 import org.apache.commons.math3.exception.MathIllegalArgumentException;
 import org.apache.commons.math3.exception.util.LocalizedFormats;
@@ -1158,7 +1158,9 @@ public class FieldRotation<T extends Rea
      * or very different. It is mathematically defined as the angle of
      * the rotation r that prepended to one of the rotations gives the other
      * one:</p>
-     * <code>r<sub>1</sub>(r) = r<sub>2</sub></code>
+     * <pre>
+     *        r<sub>1</sub>(r) = r<sub>2</sub>
+     * </pre>
      * <p>This distance is an angle between 0 and &pi;. Its value is the smallest
      * possible upper bound of the angle in radians between r<sub>1</sub>(v)
      * and r<sub>2</sub>(v) for all possible vectors v. This upper bound is

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/euclidean/threed/FieldVector3D.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/euclidean/threed/FieldVector3D.java?rev=1591835&r1=1591834&r2=1591835&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/euclidean/threed/FieldVector3D.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/euclidean/threed/FieldVector3D.java Fri May  2 09:04:01 2014
@@ -539,7 +539,7 @@ public class FieldVector3D<T extends Rea
      *   Vector3D k = u.normalize();
      *   Vector3D i = k.orthogonal();
      *   Vector3D j = Vector3D.crossProduct(k, i);
-     * </code></pre>
+     * </code></pre></p>
      * @return a new normalized vector orthogonal to the instance
      * @exception MathArithmeticException if the norm of the instance is null
      */

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/euclidean/threed/Rotation.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/euclidean/threed/Rotation.java?rev=1591835&r1=1591834&r2=1591835&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/euclidean/threed/Rotation.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/euclidean/threed/Rotation.java Fri May  2 09:04:01 2014
@@ -1029,7 +1029,9 @@ public class Rotation implements Seriali
    * or very different. It is mathematically defined as the angle of
    * the rotation r that prepended to one of the rotations gives the other
    * one:</p>
-   * <code>r<sub>1</sub>(r) = r<sub>2</sub></code>
+   * <pre>
+   *        r<sub>1</sub>(r) = r<sub>2</sub>
+   * </pre>
    * <p>This distance is an angle between 0 and &pi;. Its value is the smallest
    * possible upper bound of the angle in radians between r<sub>1</sub>(v)
    * and r<sub>2</sub>(v) for all possible vectors v. This upper bound is

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/euclidean/threed/Vector3D.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/euclidean/threed/Vector3D.java?rev=1591835&r1=1591834&r2=1591835&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/euclidean/threed/Vector3D.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/euclidean/threed/Vector3D.java Fri May  2 09:04:01 2014
@@ -313,7 +313,7 @@ public class Vector3D implements Seriali
      *   Vector3D k = u.normalize();
      *   Vector3D i = k.orthogonal();
      *   Vector3D j = Vector3D.crossProduct(k, i);
-     * </code></pre>
+     * </code></pre></p>
      * @return a new normalized vector orthogonal to the instance
      * @exception MathArithmeticException if the norm of the instance is null
      */

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/Embedding.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/Embedding.java?rev=1591835&r1=1591834&r2=1591835&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/Embedding.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/Embedding.java Fri May  2 09:04:01 2014
@@ -20,28 +20,30 @@ import org.apache.commons.math3.geometry
 import org.apache.commons.math3.geometry.Space;
 
 /** This interface defines mappers between a space and one of its sub-spaces.
- * <p>
- * Sub-spaces are the lower dimensions subsets of a n-dimensions
+
+ * <p>Sub-spaces are the lower dimensions subsets of a n-dimensions
  * space. The (n-1)-dimension sub-spaces are specific sub-spaces known
  * as {@link Hyperplane hyperplanes}. This interface can be used regardless
  * of the dimensions differences. As an example, {@link
  * org.apache.commons.math3.geometry.euclidean.threed.Line Line} in 3D
- * implements Embedding&lt;{@link
- * org.apache.commons.math3.geometry.euclidean.threed.Vector3D Vector3D}, {@link
- * org.apache.commons.math3.geometry.euclidean.oned.Vector1D Vector1D}&gt;, i.e. it
- * maps directly dimensions 3 and 1.
- * <p>
- * In the 3D euclidean space, hyperplanes are 2D planes, and the 1D
- * sub-spaces are lines.
+ * implements Embedding<{@link
+ * org.apache.commons.math3.geometry.euclidean.threed.Vector3D Vector3D}, {link
+ * org.apache.commons.math3.geometry.euclidean.oned.Vector1D Vector1D>, i.e. it
+ * maps directly dimensions 3 and 1.</p>
+
+ * <p>In the 3D euclidean space, hyperplanes are 2D planes, and the 1D
+ * sub-spaces are lines.</p>
+
  * <p>
  * Note that this interface is <em>not</em> intended to be implemented
  * by Apache Commons Math users, it is only intended to be implemented
  * within the library itself. New methods may be added even for minor
  * versions, which breaks compatibility for external implementations.
- *
+ * </p>
+
  * @param <S> Type of the embedding space.
  * @param <T> Type of the embedded sub-space.
- *
+
  * @see Hyperplane
  * @version $Id$
  * @since 3.0

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/utilities/OrderedTuple.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/utilities/OrderedTuple.java?rev=1591835&r1=1591834&r2=1591835&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/utilities/OrderedTuple.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/partitioning/utilities/OrderedTuple.java Fri May  2 09:04:01 2014
@@ -44,7 +44,7 @@ import org.apache.commons.math3.util.Fas
  * given range. This is depicted in dimension 2 by the following
  * picture:</p>
  *
- * <img src="doc-files/OrderedTuple.png" alt="OrderedTuple">
+ * <img src="doc-files/OrderedTuple.png" />
  *
  * <p>This picture shows a set of 100000 random 2-D pairs having their
  * first component between -50 and +150 and their second component

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/spherical/twod/SphericalPolygonsSet.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/spherical/twod/SphericalPolygonsSet.java?rev=1591835&r1=1591834&r2=1591835&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/spherical/twod/SphericalPolygonsSet.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/geometry/spherical/twod/SphericalPolygonsSet.java Fri May  2 09:04:01 2014
@@ -431,7 +431,7 @@ public class SphericalPolygonsSet extend
      * <pre>
      *   // compute region, plus an enclosing spherical cap
      *   SphericalPolygonsSet complexShape = ...;
-     *   EnclosingBall&lt;Sphere2D, S2Point&gt; cap = complexShape.getEnclosingCap();
+     *   EnclosingBall<Sphere2D, S2Point> cap = complexShape.getEnclosingCap();
      *
      *   // check lots of points
      *   for (Vector3D p : points) {

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optim/BaseMultiStartMultivariateOptimizer.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optim/BaseMultiStartMultivariateOptimizer.java?rev=1591835&r1=1591834&r2=1591835&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optim/BaseMultiStartMultivariateOptimizer.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optim/BaseMultiStartMultivariateOptimizer.java Fri May  2 09:04:01 2014
@@ -23,7 +23,7 @@ import org.apache.commons.math3.random.R
 
 /**
  * Base class multi-start optimizer for a multivariate function.
- * <p>
+ * <br/>
  * This class wraps an optimizer in order to use it several times in
  * turn with different starting points (trying to avoid being trapped
  * in a local extremum when looking for a global one).
@@ -102,7 +102,7 @@ public abstract class BaseMultiStartMult
      * restarts. The {@code 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 {@code optimize} method.
-     * <p>
+     * <br/>
      * The returned array as one element for each start as specified
      * in the constructor. It is ordered with the results from the
      * runs that did converge first, sorted from best to worst
@@ -113,7 +113,7 @@ public abstract class BaseMultiStartMult
      * an exception.
      * This also means that if the first element is not {@code null}, it is
      * the best point found across all starts.
-     * <p>
+     * <br/>
      * The behaviour is undefined if this method is called before
      * {@code optimize}; it will likely throw {@code NullPointerException}.
      *

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optim/ConvergenceChecker.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optim/ConvergenceChecker.java?rev=1591835&r1=1591834&r2=1591835&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optim/ConvergenceChecker.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optim/ConvergenceChecker.java Fri May  2 09:04:01 2014
@@ -20,11 +20,11 @@ package org.apache.commons.math3.optim;
 /**
  * This interface specifies how to check if an optimization algorithm has
  * converged.
- * <p>
+ * <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.
- * <p>
+ * <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

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optim/InitialGuess.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optim/InitialGuess.java?rev=1591835&r1=1591834&r2=1591835&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optim/InitialGuess.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optim/InitialGuess.java Fri May  2 09:04:01 2014
@@ -19,7 +19,7 @@ package org.apache.commons.math3.optim;
 
 /**
  * Starting point (first guess) of the optimization procedure.
- * <p>
+ * <br/>
  * Immutable class.
  *
  * @version $Id$

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optim/SimpleBounds.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optim/SimpleBounds.java?rev=1591835&r1=1591834&r2=1591835&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optim/SimpleBounds.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optim/SimpleBounds.java Fri May  2 09:04:01 2014
@@ -22,7 +22,7 @@ import java.util.Arrays;
  * Simple optimization constraints: lower and upper bounds.
  * The valid range of the parameters is an interval that can be infinite
  * (in one or both directions).
- * <p>
+ * <br/>
  * Immutable class.
  *
  * @version $Id$

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optim/SimpleValueChecker.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optim/SimpleValueChecker.java?rev=1591835&r1=1591834&r2=1591835&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optim/SimpleValueChecker.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optim/SimpleValueChecker.java Fri May  2 09:04:01 2014
@@ -28,7 +28,7 @@ import org.apache.commons.math3.exceptio
  * difference between the objective function values is smaller than a
  * threshold or if either the absolute difference between the objective
  * function values is smaller than another threshold.
- * <p>
+ * <br/>
  * The {@link #converged(int,PointValuePair,PointValuePair) converged}
  * method will also return {@code true} if the number of iterations has been set
  * (see {@link #SimpleValueChecker(double,double,int) this constructor}).

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optim/SimpleVectorValueChecker.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optim/SimpleVectorValueChecker.java?rev=1591835&r1=1591834&r2=1591835&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optim/SimpleVectorValueChecker.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optim/SimpleVectorValueChecker.java Fri May  2 09:04:01 2014
@@ -28,7 +28,7 @@ import org.apache.commons.math3.exceptio
  * difference between the objective function values is smaller than a
  * threshold or if either the absolute difference between the objective
  * function values is smaller than another threshold for all vectors elements.
- * <p>
+ * <br/>
  * The {@link #converged(int,PointVectorValuePair,PointVectorValuePair) converged}
  * method will also return {@code true} if the number of iterations has been set
  * (see {@link #SimpleVectorValueChecker(double,double,int) this constructor}).

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optim/package-info.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optim/package-info.java?rev=1591835&r1=1591834&r2=1591835&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optim/package-info.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optim/package-info.java Fri May  2 09:04:01 2014
@@ -17,54 +17,61 @@
 
 /**
  * <p>
- * Generally, optimizers are algorithms that will either
- * {@link org.apache.commons.math3.optim.nonlinear.scalar.GoalType#MINIMIZE minimize} or
- * {@link org.apache.commons.math3.optim.nonlinear.scalar.GoalType#MAXIMIZE maximize}
- * a scalar function, called the
- * {@link org.apache.commons.math3.optim.nonlinear.scalar.ObjectiveFunction <em>objective
- * function</em>}.
- * <p>
- * For some scalar objective functions the gradient can be computed (analytically
- * or numerically). Algorithms that use this knowledge are defined in the
- * {@link org.apache.commons.math3.optim.nonlinear.scalar.gradient} package.
- * The algorithms that do not need this additional information are located in
- * the {@link org.apache.commons.math3.optim.nonlinear.scalar.noderiv} package.
- * <p>
- * Some problems are solved more efficiently by algorithms that, instead of an
- * objective function, need access to a
- * {@link org.apache.commons.math3.optim.nonlinear.vector.ModelFunction
- * <em>model function</em>}: such a model predicts a set of values which the
- * algorithm tries to match with a set of given
- * {@link org.apache.commons.math3.optim.nonlinear.vector.Target target values}.
- * Those algorithms are located in the
- * {@link org.apache.commons.math3.optim.nonlinear.vector} package.
- * <p>
- * Algorithms that also require the
- * {@link org.apache.commons.math3.optim.nonlinear.vector.ModelFunctionJacobian
- * Jacobian matrix of the model} are located in the
- * {@link org.apache.commons.math3.optim.nonlinear.vector.jacobian} package.
- * <p>
- * The {@link org.apache.commons.math3.optim.nonlinear.vector.jacobian.AbstractLeastSquaresOptimizer
- * non-linear least-squares optimizers} are a specialization of the the latter,
- * that minimize the distance (called <em>cost</em> or <em>&chi;<sup>2</sup></em>)
- * between model and observations.
- * <p>
- * For cases where the Jacobian cannot be provided, a utility class will
- * {@link org.apache.commons.math3.optim.nonlinear.scalar.LeastSquaresConverter
- * convert} a (vector) model into a (scalar) objective function.
- * <p>
- * This package provides common functionality for the optimization algorithms.
- * Abstract classes ({@link org.apache.commons.math3.optim.BaseOptimizer} and
- * {@link org.apache.commons.math3.optim.BaseMultivariateOptimizer}) contain
- * boiler-plate code for storing {@link org.apache.commons.math3.optim.MaxEval
- * evaluations} and {@link org.apache.commons.math3.optim.MaxIter iterations}
- * counters and a user-defined
- * {@link org.apache.commons.math3.optim.ConvergenceChecker convergence checker}.
- * <p>
- * For each of the optimizer types, there is a special implementation that
- * wraps an optimizer instance and provides a "multi-start" feature: it calls
- * the underlying optimizer several times with different starting points and
- * returns the best optimum found, or all optima if so desired.
- * This could be useful to avoid being trapped in a local extremum.
+ *  Generally, optimizers are algorithms that will either
+ *  {@link org.apache.commons.math3.optim.nonlinear.scalar.GoalType#MINIMIZE minimize} or
+ *  {@link org.apache.commons.math3.optim.nonlinear.scalar.GoalType#MAXIMIZE maximize}
+ *  a scalar function, called the
+ *  {@link org.apache.commons.math3.optim.nonlinear.scalar.ObjectiveFunction <em>objective
+ *  function</em>}.
+ *  <br/>
+ *  For some scalar objective functions the gradient can be computed (analytically
+ *  or numerically). Algorithms that use this knowledge are defined in the
+ *  {@link org.apache.commons.math3.optim.nonlinear.scalar.gradient} package.
+ *  The algorithms that do not need this additional information are located in
+ *  the {@link org.apache.commons.math3.optim.nonlinear.scalar.noderiv} package.
+ * </p>
+ *
+ * <p>
+ *  Some problems are solved more efficiently by algorithms that, instead of an
+ *  objective function, need access to a
+ *  {@link org.apache.commons.math3.optim.nonlinear.vector.ModelFunction
+ *  <em>model function</em>}: such a model predicts a set of values which the
+ *  algorithm tries to match with a set of given
+ *  {@link org.apache.commons.math3.optim.nonlinear.vector.Target target values}.
+ *  Those algorithms are located in the
+ *  {@link org.apache.commons.math3.optim.nonlinear.vector} package.
+ *  <br/>
+ *  Algorithms that also require the
+ *  {@link org.apache.commons.math3.optim.nonlinear.vector.ModelFunctionJacobian
+ *  Jacobian matrix of the model} are located in the
+ *  {@link org.apache.commons.math3.optim.nonlinear.vector.jacobian} package.
+ *  <br/>
+ *  The {@link org.apache.commons.math3.optim.nonlinear.vector.jacobian.AbstractLeastSquaresOptimizer
+ *  non-linear least-squares optimizers} are a specialization of the the latter,
+ *  that minimize the distance (called <em>cost</em> or <em>&chi;<sup>2</sup></em>)
+ *  between model and observations.
+ *  <br/>
+ *  For cases where the Jacobian cannot be provided, a utility class will
+ *  {@link org.apache.commons.math3.optim.nonlinear.scalar.LeastSquaresConverter
+ *  convert} a (vector) model into a (scalar) objective function.
+ * </p>
+ *
+ * <p>
+ *  This package provides common functionality for the optimization algorithms.
+ *  Abstract classes ({@link org.apache.commons.math3.optim.BaseOptimizer} and
+ *  {@link org.apache.commons.math3.optim.BaseMultivariateOptimizer}) contain
+ *  boiler-plate code for storing {@link org.apache.commons.math3.optim.MaxEval
+ *  evaluations} and {@link org.apache.commons.math3.optim.MaxIter iterations}
+ *  counters and a user-defined
+ *  {@link org.apache.commons.math3.optim.ConvergenceChecker convergence checker}.
+ * </p>
+ *
+ * <p>
+ *  For each of the optimizer types, there is a special implementation that
+ *  wraps an optimizer instance and provides a "multi-start" feature: it calls
+ *  the underlying optimizer several times with different starting points and
+ *  returns the best optimum found, or all optima if so desired.
+ *  This could be useful to avoid being trapped in a local extremum.
+ * </p>
  */
 package org.apache.commons.math3.optim;

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/BaseMultivariateMultiStartOptimizer.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/BaseMultivariateMultiStartOptimizer.java?rev=1591835&r1=1591834&r2=1591835&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/BaseMultivariateMultiStartOptimizer.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/BaseMultivariateMultiStartOptimizer.java Fri May  2 09:04:01 2014
@@ -94,7 +94,7 @@ public class BaseMultivariateMultiStartO
      * returns all the points found at the end of each starts,
      * including the best one already returned by the {@link
      * #optimize(int,MultivariateFunction,GoalType,double[]) optimize} method.
-     * <p>
+     * <br/>
      * The returned array as one element for each start as specified
      * in the constructor. It is ordered with the results from the
      * runs that did converge first, sorted from best to worst

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/BaseMultivariateVectorMultiStartOptimizer.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/BaseMultivariateVectorMultiStartOptimizer.java?rev=1591835&r1=1591834&r2=1591835&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/BaseMultivariateVectorMultiStartOptimizer.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/BaseMultivariateVectorMultiStartOptimizer.java Fri May  2 09:04:01 2014
@@ -94,7 +94,7 @@ public class BaseMultivariateVectorMulti
      * returns all the points found at the end of each starts, including
      * the best one already returned by the {@link
      * #optimize(int,MultivariateVectorFunction,double[],double[],double[]) optimize} method.
-     * <p>
+     * <br/>
      * The returned array as one element for each start as specified
      * in the constructor. It is ordered with the results from the
      * runs that did converge first, sorted from best to worst

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/ConvergenceChecker.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/ConvergenceChecker.java?rev=1591835&r1=1591834&r2=1591835&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/ConvergenceChecker.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/ConvergenceChecker.java Fri May  2 09:04:01 2014
@@ -20,11 +20,11 @@ package org.apache.commons.math3.optimiz
 /**
  * This interface specifies how to check if an optimization algorithm has
  * converged.
- * <p>
+ * <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.
- * <p>
+ * <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

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/InitialGuess.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/InitialGuess.java?rev=1591835&r1=1591834&r2=1591835&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/InitialGuess.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/InitialGuess.java Fri May  2 09:04:01 2014
@@ -19,7 +19,7 @@ package org.apache.commons.math3.optimiz
 
 /**
  * Starting point (first guess) of the optimization procedure.
- * <p>
+ * <br/>
  * Immutable class.
  *
  * @version $Id$

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/LeastSquaresConverter.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/LeastSquaresConverter.java?rev=1591835&r1=1591834&r2=1591835&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/LeastSquaresConverter.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/LeastSquaresConverter.java Fri May  2 09:04:01 2014
@@ -85,10 +85,9 @@ public class LeastSquaresConverter imple
      * <p>
      * The scalar objective function value is computed as:
      * <pre>
-     * <code>
      * objective = &sum;weight<sub>i</sub>(observation<sub>i</sub>-objective<sub>i</sub>)<sup>2</sup>
-     * </code>
      * </pre>
+     * </p>
      * <p>
      * Weights can be used for example to combine residuals with different standard
      * deviations. As an example, consider a residuals array in which even elements
@@ -97,11 +96,12 @@ public class LeastSquaresConverter imple
      * In this case, the weights array should be initialized with value
      * 1.0/(0.01<sup>2</sup>) in the even elements and 1.0/(15.0<sup>2</sup>) in the
      * odd elements (i.e. reciprocals of variances).
+     * </p>
      * <p>
      * The array computed by the objective function, the observations array and the
      * weights array must have consistent sizes or a {@link DimensionMismatchException}
      * will be triggered while computing the scalar objective.
-     *
+     * </p>
      * @param function vectorial residuals function to wrap
      * @param observations observations to be compared to objective function to compute residuals
      * @param weights weights to apply to the residuals
@@ -124,15 +124,14 @@ public class LeastSquaresConverter imple
      * <p>
      * The scalar objective function value is computed as:
      * <pre>
-     * <code>
      * objective = y<sup>T</sup>y with y = scale&times;(observation-objective)
-     * </code>
      * </pre>
+     * </p>
      * <p>
      * The array computed by the objective function, the observations array and the
      * the scaling matrix must have consistent sizes or a {@link DimensionMismatchException}
      * will be triggered while computing the scalar objective.
-     *
+     * </p>
      * @param function vectorial residuals function to wrap
      * @param observations observations to be compared to objective function to compute residuals
      * @param scale scaling matrix

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/SimpleBounds.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/SimpleBounds.java?rev=1591835&r1=1591834&r2=1591835&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/SimpleBounds.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/SimpleBounds.java Fri May  2 09:04:01 2014
@@ -21,7 +21,7 @@ package org.apache.commons.math3.optimiz
  * Simple optimization constraints: lower and upper bounds.
  * The valid range of the parameters is an interval that can be infinite
  * (in one or both directions).
- * <p>
+ * <br/>
  * Immutable class.
  *
  * @version $Id$

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/SimplePointChecker.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/SimplePointChecker.java?rev=1591835&r1=1591834&r2=1591835&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/SimplePointChecker.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/SimplePointChecker.java Fri May  2 09:04:01 2014
@@ -29,7 +29,7 @@ import org.apache.commons.math3.exceptio
  * difference between each point coordinate are smaller than a threshold
  * or if either the absolute difference between the point coordinates are
  * smaller than another threshold.
- * <p>
+ * <br/>
  * The {@link #converged(int,Pair,Pair) converged} method will also return
  * {@code true} if the number of iterations has been set (see
  * {@link #SimplePointChecker(double,double,int) this constructor}).

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/SimpleValueChecker.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/SimpleValueChecker.java?rev=1591835&r1=1591834&r2=1591835&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/SimpleValueChecker.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/SimpleValueChecker.java Fri May  2 09:04:01 2014
@@ -28,7 +28,7 @@ import org.apache.commons.math3.exceptio
  * difference between the objective function values is smaller than a
  * threshold or if either the absolute difference between the objective
  * function values is smaller than another threshold.
- * <p>
+ * <br/>
  * The {@link #converged(int,PointValuePair,PointValuePair) converged}
  * method will also return {@code true} if the number of iterations has been set
  * (see {@link #SimpleValueChecker(double,double,int) this constructor}).

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/SimpleVectorValueChecker.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/SimpleVectorValueChecker.java?rev=1591835&r1=1591834&r2=1591835&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/SimpleVectorValueChecker.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/SimpleVectorValueChecker.java Fri May  2 09:04:01 2014
@@ -28,7 +28,7 @@ import org.apache.commons.math3.exceptio
  * difference between the objective function values is smaller than a
  * threshold or if either the absolute difference between the objective
  * function values is smaller than another threshold for all vectors elements.
- * <p>
+ * <br/>
  * The {@link #converged(int,PointVectorValuePair,PointVectorValuePair) converged}
  * method will also return {@code true} if the number of iterations has been set
  * (see {@link #SimpleVectorValueChecker(double,double,int) this constructor}).

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/Target.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/Target.java?rev=1591835&r1=1591834&r2=1591835&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/Target.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/Target.java Fri May  2 09:04:01 2014
@@ -21,7 +21,7 @@ package org.apache.commons.math3.optimiz
  * Target of the optimization procedure.
  * They are the values which the objective vector function must reproduce
  * When the parameters of the model have been optimized.
- * <p>
+ * <br/>
  * Immutable class.
  *
  * @version $Id$

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/Weight.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/Weight.java?rev=1591835&r1=1591834&r2=1591835&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/Weight.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/Weight.java Fri May  2 09:04:01 2014
@@ -23,7 +23,7 @@ import org.apache.commons.math3.linear.N
 
 /**
  * Weight matrix of the residuals between model and observations.
- * <p>
+ * <br/>
  * Immutable class.
  *
  * @version $Id$

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/fitting/CurveFitter.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/fitting/CurveFitter.java?rev=1591835&r1=1591834&r2=1591835&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/fitting/CurveFitter.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/fitting/CurveFitter.java Fri May  2 09:04:01 2014
@@ -30,7 +30,7 @@ import org.apache.commons.math3.optimiza
 import org.apache.commons.math3.optimization.PointVectorValuePair;
 
 /** Fitter for parametric univariate real functions y = f(x).
- * <p>
+ * <br/>
  * When a univariate real function y = f(x) does depend on some
  * unknown parameters p<sub>0</sub>, p<sub>1</sub> ... p<sub>n-1</sub>,
  * this class can be used to find these parameters. It does this

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/fitting/HarmonicFitter.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/fitting/HarmonicFitter.java?rev=1591835&r1=1591834&r2=1591835&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/fitting/HarmonicFitter.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/fitting/HarmonicFitter.java Fri May  2 09:04:01 2014
@@ -17,17 +17,17 @@
 
 package org.apache.commons.math3.optimization.fitting;
 
+import org.apache.commons.math3.optimization.DifferentiableMultivariateVectorOptimizer;
 import org.apache.commons.math3.analysis.function.HarmonicOscillator;
-import org.apache.commons.math3.exception.MathIllegalStateException;
-import org.apache.commons.math3.exception.NumberIsTooSmallException;
 import org.apache.commons.math3.exception.ZeroException;
+import org.apache.commons.math3.exception.NumberIsTooSmallException;
+import org.apache.commons.math3.exception.MathIllegalStateException;
 import org.apache.commons.math3.exception.util.LocalizedFormats;
-import org.apache.commons.math3.optimization.DifferentiableMultivariateVectorOptimizer;
 import org.apache.commons.math3.util.FastMath;
 
 /**
  * Class that implements a curve fitting specialized for sinusoids.
- * <p>
+ *
  * Harmonic fitting is a very simple case of curve fitting. The
  * estimated coefficients are the amplitude a, the pulsation &omega; and
  * the phase &phi;: <code>f (t) = a cos (&omega; t + &phi;)</code>. They are

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/general/AbstractLeastSquaresOptimizer.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/general/AbstractLeastSquaresOptimizer.java?rev=1591835&r1=1591834&r2=1591835&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/general/AbstractLeastSquaresOptimizer.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/general/AbstractLeastSquaresOptimizer.java Fri May  2 09:04:01 2014
@@ -25,19 +25,19 @@ import org.apache.commons.math3.exceptio
 import org.apache.commons.math3.exception.NumberIsTooSmallException;
 import org.apache.commons.math3.exception.util.LocalizedFormats;
 import org.apache.commons.math3.linear.ArrayRealVector;
-import org.apache.commons.math3.linear.DecompositionSolver;
+import org.apache.commons.math3.linear.RealMatrix;
 import org.apache.commons.math3.linear.DiagonalMatrix;
-import org.apache.commons.math3.linear.EigenDecomposition;
+import org.apache.commons.math3.linear.DecompositionSolver;
 import org.apache.commons.math3.linear.MatrixUtils;
 import org.apache.commons.math3.linear.QRDecomposition;
-import org.apache.commons.math3.linear.RealMatrix;
-import org.apache.commons.math3.optimization.ConvergenceChecker;
-import org.apache.commons.math3.optimization.DifferentiableMultivariateVectorOptimizer;
-import org.apache.commons.math3.optimization.InitialGuess;
+import org.apache.commons.math3.linear.EigenDecomposition;
 import org.apache.commons.math3.optimization.OptimizationData;
-import org.apache.commons.math3.optimization.PointVectorValuePair;
+import org.apache.commons.math3.optimization.InitialGuess;
 import org.apache.commons.math3.optimization.Target;
 import org.apache.commons.math3.optimization.Weight;
+import org.apache.commons.math3.optimization.ConvergenceChecker;
+import org.apache.commons.math3.optimization.DifferentiableMultivariateVectorOptimizer;
+import org.apache.commons.math3.optimization.PointVectorValuePair;
 import org.apache.commons.math3.optimization.direct.BaseAbstractMultivariateVectorOptimizer;
 import org.apache.commons.math3.util.FastMath;
 
@@ -45,7 +45,7 @@ import org.apache.commons.math3.util.Fas
  * Base class for implementing least squares optimizers.
  * It handles the boilerplate methods associated to thresholds settings,
  * Jacobian and error estimation.
- * <p>
+ * <br/>
  * This class constructs the Jacobian matrix of the function argument in method
  * {@link BaseAbstractMultivariateVectorOptimizer#optimize(int,
  * org.apache.commons.math3.analysis.MultivariateVectorFunction,OptimizationData[])
@@ -288,7 +288,7 @@ public abstract class AbstractLeastSquar
 
     /**
      * Get the covariance matrix of the optimized parameters.
-     * <p>
+     * <br/>
      * Note that this operation involves the inversion of the
      * <code>J<sup>T</sup>J</code> matrix, where {@code J} is the
      * Jacobian matrix.
@@ -310,7 +310,7 @@ public abstract class AbstractLeastSquar
 
     /**
      * Get the covariance matrix of the optimized parameters.
-     * <p>
+     * <br/>
      * Note that this operation involves the inversion of the
      * <code>J<sup>T</sup>J</code> matrix, where {@code J} is the
      * Jacobian matrix.

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/general/LevenbergMarquardtOptimizer.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/general/LevenbergMarquardtOptimizer.java?rev=1591835&r1=1591834&r2=1591835&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/general/LevenbergMarquardtOptimizer.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/general/LevenbergMarquardtOptimizer.java Fri May  2 09:04:01 2014
@@ -20,11 +20,11 @@ import java.util.Arrays;
 
 import org.apache.commons.math3.exception.ConvergenceException;
 import org.apache.commons.math3.exception.util.LocalizedFormats;
-import org.apache.commons.math3.linear.RealMatrix;
-import org.apache.commons.math3.optimization.ConvergenceChecker;
 import org.apache.commons.math3.optimization.PointVectorValuePair;
-import org.apache.commons.math3.util.FastMath;
+import org.apache.commons.math3.optimization.ConvergenceChecker;
+import org.apache.commons.math3.linear.RealMatrix;
 import org.apache.commons.math3.util.Precision;
+import org.apache.commons.math3.util.FastMath;
 
 
 /**
@@ -52,9 +52,9 @@ import org.apache.commons.math3.util.Pre
  * </ul>
  * The redistribution policy for MINPACK is available <a
  * href="http://www.netlib.org/minpack/disclaimer">here</a>, for convenience, it
- * is reproduced below.
+ * is reproduced below.</p>
  *
- * <table border="0" width="80%" cellpadding="10" align="center" bgcolor="#E0E0E0" summary="Copyright">
+ * <table border="0" width="80%" cellpadding="10" align="center" bgcolor="#E0E0E0">
  * <tr><td>
  *    Minpack Copyright Notice (1999) University of Chicago.
  *    All rights reserved
@@ -99,7 +99,7 @@ import org.apache.commons.math3.util.Pre
  *     (INCLUDING NEGLIGENCE OR STRICT LIABILITY), OR OTHERWISE,
  *     EVEN IF ANY OF SAID PARTIES HAS BEEN WARNED OF THE
  *     POSSIBILITY OF SUCH LOSS OR DAMAGES.</strong></li>
- * </ol></td></tr>
+ * <ol></td></tr>
  * </table>
  * @version $Id$
  * @deprecated As of 3.1 (to be removed in 4.0).

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/package-info.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/package-info.java?rev=1591835&r1=1591834&r2=1591835&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/package-info.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/package-info.java Fri May  2 09:04:01 2014
@@ -16,11 +16,12 @@
  */
 /**
  * <h2>All classes and sub-packages of this package are deprecated.</h2>
- * <h3>Please use their replacements, to be found under:</h3>
+ * <h3>Please use their replacements, to be found under
  *  <ul>
  *   <li>{@link org.apache.commons.math3.optim}</li>
  *   <li>{@link org.apache.commons.math3.fitting}</li>
  *  </ul>
+ * </h3>
  *
  * <p>
  * This package provides common interfaces for the optimization algorithms
@@ -53,6 +54,7 @@
  *      org.apache.commons.math3.analysis.differentiation.MultivariateDifferentiableVectorFunction
  *      multivariate differentiable vectorial functions}</li>
  * </ul>
+ * </p>
  *
  * <p>
  * Despite there are only four types of supported optimizers, it is possible to optimize a

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/univariate/BrentOptimizer.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/univariate/BrentOptimizer.java?rev=1591835&r1=1591834&r2=1591835&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/univariate/BrentOptimizer.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/univariate/BrentOptimizer.java Fri May  2 09:04:01 2014
@@ -16,12 +16,12 @@
  */
 package org.apache.commons.math3.optimization.univariate;
 
-import org.apache.commons.math3.exception.NotStrictlyPositiveException;
+import org.apache.commons.math3.util.Precision;
+import org.apache.commons.math3.util.FastMath;
 import org.apache.commons.math3.exception.NumberIsTooSmallException;
+import org.apache.commons.math3.exception.NotStrictlyPositiveException;
 import org.apache.commons.math3.optimization.ConvergenceChecker;
 import org.apache.commons.math3.optimization.GoalType;
-import org.apache.commons.math3.util.FastMath;
-import org.apache.commons.math3.util.Precision;
 
 /**
  * For a function defined on some interval {@code (lo, hi)}, this class
@@ -30,7 +30,7 @@ import org.apache.commons.math3.util.Pre
  * It implements Richard Brent's algorithm (from his book "Algorithms for
  * Minimization without Derivatives", p. 79) for finding minima of real
  * univariate functions.
- * <p>
+ * <br/>
  * This code is an adaptation, partly based on the Python code from SciPy
  * (module "optimize.py" v0.5); the original algorithm is also modified
  * <ul>

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/univariate/SimpleUnivariateValueChecker.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/univariate/SimpleUnivariateValueChecker.java?rev=1591835&r1=1591834&r2=1591835&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/univariate/SimpleUnivariateValueChecker.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/univariate/SimpleUnivariateValueChecker.java Fri May  2 09:04:01 2014
@@ -17,9 +17,9 @@
 
 package org.apache.commons.math3.optimization.univariate;
 
+import org.apache.commons.math3.util.FastMath;
 import org.apache.commons.math3.exception.NotStrictlyPositiveException;
 import org.apache.commons.math3.optimization.AbstractConvergenceChecker;
-import org.apache.commons.math3.util.FastMath;
 
 /**
  * Simple implementation of the
@@ -30,7 +30,7 @@ import org.apache.commons.math3.util.Fas
  * difference between the objective function values is smaller than a
  * threshold or if either the absolute difference between the objective
  * function values is smaller than another threshold.
- * <p>
+ * <br/>
  * The {@link #converged(int,UnivariatePointValuePair,UnivariatePointValuePair)
  * converged} method will also return {@code true} if the number of iterations
  * has been set (see {@link #SimpleUnivariateValueChecker(double,double,int)

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/univariate/UnivariateMultiStartOptimizer.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/univariate/UnivariateMultiStartOptimizer.java?rev=1591835&r1=1591834&r2=1591835&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/univariate/UnivariateMultiStartOptimizer.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/univariate/UnivariateMultiStartOptimizer.java Fri May  2 09:04:01 2014
@@ -25,14 +25,14 @@ import org.apache.commons.math3.exceptio
 import org.apache.commons.math3.exception.NotStrictlyPositiveException;
 import org.apache.commons.math3.exception.NullArgumentException;
 import org.apache.commons.math3.exception.util.LocalizedFormats;
-import org.apache.commons.math3.optimization.ConvergenceChecker;
-import org.apache.commons.math3.optimization.GoalType;
 import org.apache.commons.math3.random.RandomGenerator;
+import org.apache.commons.math3.optimization.GoalType;
+import org.apache.commons.math3.optimization.ConvergenceChecker;
 
 /**
  * Special implementation of the {@link UnivariateOptimizer} interface
  * adding multi-start features to an existing optimizer.
- * <p>
+ *
  * This class wraps a classical optimizer to use it several times in
  * turn with different starting points in order to avoid being trapped
  * into a local extremum when looking for a global one.
@@ -113,7 +113,7 @@ public class UnivariateMultiStartOptimiz
      * found at the end of each starts, including the best one already
      * returned by the {@link #optimize(int,UnivariateFunction,GoalType,double,double) optimize}
      * method.
-     * <p>
+     * <br/>
      * The returned array as one element for each start as specified
      * in the constructor. It is ordered with the results from the
      * runs that did converge first, sorted from best to worst

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/util/ArithmeticUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/util/ArithmeticUtils.java?rev=1591835&r1=1591834&r2=1591835&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/util/ArithmeticUtils.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/util/ArithmeticUtils.java Fri May  2 09:04:01 2014
@@ -85,7 +85,7 @@ public final class ArithmeticUtils {
      * {@code  < Long.MAX_VALUE} is 66. If the computed value exceeds
      * {@code Long.MAX_VALUE} an {@code ArithMeticException} is
      * thrown.</li>
-     * </ul>
+     * </ul></p>
      *
      * @param n the size of the set
      * @param k the size of the subsets to be counted
@@ -114,10 +114,10 @@ public final class ArithmeticUtils {
      * <li> {@code 0 <= k <= n } (otherwise
      * {@code IllegalArgumentException} is thrown)</li>
      * <li> The result is small enough to fit into a {@code double}. The
-     * largest value of {@code n} for which all coefficients are &lt;
+     * largest value of {@code n} for which all coefficients are <
      * Double.MAX_VALUE is 1029. If the computed value exceeds Double.MAX_VALUE,
      * Double.POSITIVE_INFINITY is returned</li>
-     * </ul>
+     * </ul></p>
      *
      * @param n the size of the set
      * @param k the size of the subsets to be counted
@@ -145,7 +145,7 @@ public final class ArithmeticUtils {
      * <ul>
      * <li> {@code 0 <= k <= n } (otherwise
      * {@code IllegalArgumentException} is thrown)</li>
-     * </ul>
+     * </ul></p>
      *
      * @param n the size of the set
      * @param k the size of the subsets to be counted
@@ -172,10 +172,11 @@ public final class ArithmeticUtils {
      * <li> {@code n >= 0} (otherwise
      * {@code IllegalArgumentException} is thrown)</li>
      * <li> The result is small enough to fit into a {@code long}. The
-     * largest value of {@code n} for which {@code n!} &lt;
+     * largest value of {@code n} for which {@code n!} <
      * Long.MAX_VALUE} is 20. If the computed value exceeds {@code Long.MAX_VALUE}
      * an {@code ArithMeticException } is thrown.</li>
      * </ul>
+     * </p>
      *
      * @param n argument
      * @return {@code n!}
@@ -228,7 +229,7 @@ public final class ArithmeticUtils {
      * numbers, using a modified version of the "binary gcd" method.
      * See Knuth 4.5.2 algorithm B.
      * The algorithm is due to Josef Stein (1961).
-     * <p>
+     * <br/>
      * Special cases:
      * <ul>
      *  <li>The invocations
@@ -315,7 +316,7 @@ public final class ArithmeticUtils {
      * and modulo operations.
      * See Knuth 4.5.2 algorithm B.
      * The algorithm is due to Josef Stein (1961).
-     * <p>
+     * <br/>
      * Special cases:
      * <ul>
      *  <li>The result of {@code gcd(x, x)}, {@code gcd(0, x)} and

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/util/Combinations.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/util/Combinations.java?rev=1591835&r1=1591834&r2=1591835&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/util/Combinations.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/util/Combinations.java Fri May  2 09:04:01 2014
@@ -16,14 +16,13 @@
  */
 package org.apache.commons.math3.util;
 
-import java.io.Serializable;
-import java.util.Arrays;
-import java.util.Comparator;
 import java.util.Iterator;
+import java.util.Comparator;
+import java.util.Arrays;
 import java.util.NoSuchElementException;
-
-import org.apache.commons.math3.exception.DimensionMismatchException;
+import java.io.Serializable;
 import org.apache.commons.math3.exception.MathInternalError;
+import org.apache.commons.math3.exception.DimensionMismatchException;
 import org.apache.commons.math3.exception.OutOfRangeException;
 
 /**
@@ -62,7 +61,8 @@ public class Combinations implements Ite
      * For example, {@code new Combinations(4, 2).iterator()} returns
      * an iterator that will generate the following sequence of arrays
      * on successive calls to
-     * {@code next()}: {@code [0, 1], [0, 2], [1, 2], [0, 3], [1, 3], [2, 3]}
+     * {@code next()}:<br/>
+     * {@code [0, 1], [0, 2], [1, 2], [0, 3], [1, 3], [2, 3]}
      * </p>
      * If {@code k == 0} an iterator containing an empty array is returned;
      * if {@code k == n} an iterator containing [0, ..., n - 1] is returned.
@@ -89,7 +89,8 @@ public class Combinations implements Ite
      * For example, {@code new Combinations(4, 2).iterator()} returns
      * an iterator that will generate the following sequence of arrays
      * on successive calls to
-     * {@code next()}: {@code [0, 1], [0, 2], [1, 2], [0, 3], [1, 3], [2, 3]}
+     * {@code next()}:<br/>
+     * {@code [0, 1], [0, 2], [1, 2], [0, 3], [1, 3], [2, 3]}
      * </p>
      * If {@code k == 0} an iterator containing an empty array is returned;
      * if {@code k == n} an iterator containing [0, ..., n - 1] is returned.

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/util/CombinatoricsUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/util/CombinatoricsUtils.java?rev=1591835&r1=1591834&r2=1591835&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/util/CombinatoricsUtils.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/util/CombinatoricsUtils.java Fri May  2 09:04:01 2014
@@ -67,7 +67,7 @@ public final class CombinatoricsUtils {
      * {@code  < Long.MAX_VALUE} is 66. If the computed value exceeds
      * {@code Long.MAX_VALUE} an {@code ArithMeticException} is
      * thrown.</li>
-     * </ul>
+     * </ul></p>
      *
      * @param n the size of the set
      * @param k the size of the subsets to be counted
@@ -145,10 +145,10 @@ public final class CombinatoricsUtils {
      * <li> {@code 0 <= k <= n } (otherwise
      * {@code IllegalArgumentException} is thrown)</li>
      * <li> The result is small enough to fit into a {@code double}. The
-     * largest value of {@code n} for which all coefficients are &lt;
+     * largest value of {@code n} for which all coefficients are <
      * Double.MAX_VALUE is 1029. If the computed value exceeds Double.MAX_VALUE,
      * Double.POSITIVE_INFINITY is returned</li>
-     * </ul>
+     * </ul></p>
      *
      * @param n the size of the set
      * @param k the size of the subsets to be counted
@@ -193,7 +193,7 @@ public final class CombinatoricsUtils {
      * <ul>
      * <li> {@code 0 <= k <= n } (otherwise
      * {@code IllegalArgumentException} is thrown)</li>
-     * </ul>
+     * </ul></p>
      *
      * @param n the size of the set
      * @param k the size of the subsets to be counted
@@ -261,10 +261,11 @@ public final class CombinatoricsUtils {
      * <li> {@code n >= 0} (otherwise
      * {@code IllegalArgumentException} is thrown)</li>
      * <li> The result is small enough to fit into a {@code long}. The
-     * largest value of {@code n} for which {@code n!} &lt;
+     * largest value of {@code n} for which {@code n!} <
      * Long.MAX_VALUE} is 20. If the computed value exceeds {@code Long.MAX_VALUE}
      * an {@code ArithMeticException } is thrown.</li>
      * </ul>
+     * </p>
      *
      * @param n argument
      * @return {@code n!}
@@ -340,7 +341,7 @@ public final class CombinatoricsUtils {
      * <p>
      * The preconditions are {@code 0 <= k <= n } (otherwise
      * {@code NotPositiveException} is thrown)
-     *
+     * </p>
      * @param n the size of the set
      * @param k the number of non-empty subsets
      * @return {@code S(n,k)}
@@ -425,7 +426,8 @@ public final class CombinatoricsUtils {
      * they are visited in lexicographic order with significance from right to
      * left. For example, combinationsIterator(4, 2) returns an Iterator that
      * will generate the following sequence of arrays on successive calls to
-     * {@code next()}: {@code [0, 1], [0, 2], [1, 2], [0, 3], [1, 3], [2, 3]}
+     * {@code next()}:<br/>
+     * {@code [0, 1], [0, 2], [1, 2], [0, 3], [1, 3], [2, 3]}
      * </p>
      * If {@code k == 0} an Iterator containing an empty array is returned and
      * if {@code k == n} an Iterator containing [0, ..., n -1] is returned.

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/util/ContinuedFraction.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/util/ContinuedFraction.java?rev=1591835&r1=1591834&r2=1591835&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/util/ContinuedFraction.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/util/ContinuedFraction.java Fri May  2 09:04:01 2014
@@ -23,12 +23,14 @@ import org.apache.commons.math3.exceptio
 /**
  * Provides a generic means to evaluate continued fractions.  Subclasses simply
  * provided the a and b coefficients to evaluate the continued fraction.
+ *
  * <p>
  * References:
  * <ul>
  * <li><a href="http://mathworld.wolfram.com/ContinuedFraction.html">
  * Continued Fraction</a></li>
  * </ul>
+ * </p>
  *
  * @version $Id$
  */
@@ -109,6 +111,7 @@ public abstract class ContinuedFraction 
      * </ul>
      * <b>Note:</b> the implementation uses the terms a<sub>i</sub> and b<sub>i</sub> as defined in
      * <a href="http://mathworld.wolfram.com/ContinuedFraction.html">Continued Fraction @ MathWorld</a>.
+     * </p>
      *
      * @param x the evaluation point.
      * @param epsilon maximum error allowed.

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/util/FastMath.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/util/FastMath.java?rev=1591835&r1=1591834&r2=1591835&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/util/FastMath.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/util/FastMath.java Fri May  2 09:04:01 2014
@@ -27,11 +27,13 @@ import java.io.PrintStream;
  * {@code Math.cbrt(y)}), user can directly change the class and use the
  * methods as is (using {@code FastMath.sin(x)} or {@code FastMath.cbrt(y)}
  * in the previous example).
+ * </p>
  * <p>
  * FastMath speed is achieved by relying heavily on optimizing compilers
  * to native code present in many JVMs today and use of large tables.
  * The larger tables are lazily initialised on first use, so that the setup
  * time does not penalise methods that don't need them.
+ * </p>
  * <p>
  * Note that FastMath is
  * extensively used inside Apache Commons Math, so by calling some algorithms,
@@ -40,6 +42,7 @@ import java.io.PrintStream;
  * Performance figures for a specific JVM and hardware can be evaluated by
  * running the FastMathTestPerformance tests in the test directory of the source
  * distribution.
+ * </p>
  * <p>
  * FastMath accuracy should be mostly independent of the JVM as it relies only
  * on IEEE-754 basic operations and on embedded tables. Almost all operations
@@ -48,6 +51,7 @@ import java.io.PrintStream;
  * guarantee for <em>every</em> double numbers input (see William Kahan's <a
  * href="http://en.wikipedia.org/wiki/Rounding#The_table-maker.27s_dilemma">Table
  * Maker's Dilemma</a>).
+ * </p>
  * <p>
  * FastMath additionally implements the following methods not found in Math/StrictMath:
  * <ul>
@@ -69,7 +73,7 @@ import java.io.PrintStream;
  * <li>{@link #nextUp(float)}</li>
  * <li>{@link #scalb(float, int)}</li>
  * </ul>
- *
+ * </p>
  * @version $Id$
  * @since 2.2
  */
@@ -3233,7 +3237,7 @@ public class FastMath {
      * <li>+MIN_VALUE</li>
      * <li>+MAX_VALUE</li>
      * <li>+INFINITY</li>
-     * </ul>
+     * <li></li>
      * <p>
      * If arguments compare equal, then the second argument is returned.
      * <p>
@@ -3289,7 +3293,7 @@ public class FastMath {
      * <li>+MIN_VALUE</li>
      * <li>+MAX_VALUE</li>
      * <li>+INFINITY</li>
-     * </ul>
+     * <li></li>
      * <p>
      * If arguments compare equal, then the second argument is returned.
      * <p>
@@ -3333,7 +3337,7 @@ public class FastMath {
 
     /** Get the largest whole number smaller than x.
      * @param x number from which floor is requested
-     * @return a double number f such that f is an integer f &le; x &lt; f + 1.0
+     * @return a double number f such that f is an integer f <= x < f + 1.0
      */
     public static double floor(double x) {
         long y;
@@ -3360,7 +3364,7 @@ public class FastMath {
 
     /** Get the smallest whole number larger than x.
      * @param x number from which ceil is requested
-     * @return a double number c such that c is an integer c - 1.0 &lt; x &le; c
+     * @return a double number c such that c is an integer c - 1.0 < x <= c
      */
     public static double ceil(double x) {
         double y;
@@ -3385,7 +3389,7 @@ public class FastMath {
 
     /** Get the whole number that is the nearest to x, or the even one if x is exactly half way between two integers.
      * @param x number from which nearest whole number is requested
-     * @return a double number r such that r is an integer r - 0.5 &le; x &le; r + 0.5
+     * @return a double number r such that r is an integer r - 0.5 <= x <= r + 0.5
      */
     public static double rint(double x) {
         double y = floor(x);
@@ -3560,7 +3564,7 @@ public class FastMath {
 
     /**
      * Returns the hypotenuse of a triangle with sides {@code x} and {@code y}
-     * - sqrt(<i>x</i><sup>2</sup>&nbsp;+<i>y</i><sup>2</sup>)
+     * - sqrt(<i>x</i><sup>2</sup>&nbsp;+<i>y</i><sup>2</sup>)<br/>
      * avoiding intermediate overflow or underflow.
      *
      * <ul>

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/util/MathArrays.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/util/MathArrays.java?rev=1591835&r1=1591834&r2=1591835&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/util/MathArrays.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/util/MathArrays.java Fri May  2 09:04:01 2014
@@ -25,6 +25,8 @@ import java.util.Comparator;
 import java.util.List;
 
 import org.apache.commons.math3.Field;
+import org.apache.commons.math3.random.RandomGenerator;
+import org.apache.commons.math3.random.Well19937c;
 import org.apache.commons.math3.distribution.UniformIntegerDistribution;
 import org.apache.commons.math3.exception.DimensionMismatchException;
 import org.apache.commons.math3.exception.MathArithmeticException;
@@ -37,8 +39,6 @@ import org.apache.commons.math3.exceptio
 import org.apache.commons.math3.exception.NullArgumentException;
 import org.apache.commons.math3.exception.NumberIsTooLargeException;
 import org.apache.commons.math3.exception.util.LocalizedFormats;
-import org.apache.commons.math3.random.RandomGenerator;
-import org.apache.commons.math3.random.Well19937c;
 
 /**
  * Arrays utilities.
@@ -95,9 +95,9 @@ public class MathArrays {
     }
 
     /**
-     * Multiply each element of an array by a value.
-     * <p>
-     * The array is modified in place (no copy is created).
+     * <p>Multiply each element of an array by a value.</p>
+     *
+     * <p>The array is modified in place (no copy is created).</p>
      *
      * @param arr Array to scale
      * @param val Scalar
@@ -490,7 +490,7 @@ public class MathArrays {
     }
 
     /**
-     * Check that all entries of the input array are &ge; 0.
+     * Check that all entries of the input array are >= 0.
      *
      * @param in Array to be tested
      * @throws NotPositiveException if any array entries are less than 0.
@@ -506,7 +506,7 @@ public class MathArrays {
     }
 
     /**
-     * Check all entries of the input array are &ge; 0.
+     * Check all entries of the input array are >= 0.
      *
      * @param in Array to be tested
      * @throws NotPositiveException if any array entries are less than 0.
@@ -526,12 +526,12 @@ public class MathArrays {
     /**
      * Returns the Cartesian norm (2-norm), handling both overflow and underflow.
      * Translation of the minpack enorm subroutine.
-     * <p>
+     *
      * The redistribution policy for MINPACK is available
      * <a href="http://www.netlib.org/minpack/disclaimer">here</a>, for
-     * convenience, it is reproduced below.
-     * <p>
-     * <table border="0" width="80%" cellpadding="10" align="center" bgcolor="#E0E0E0" summary="Copyright">
+     * convenience, it is reproduced below.</p>
+     *
+     * <table border="0" width="80%" cellpadding="10" align="center" bgcolor="#E0E0E0">
      * <tr><td>
      *    Minpack Copyright Notice (1999) University of Chicago.
      *    All rights reserved
@@ -576,7 +576,7 @@ public class MathArrays {
      *     (INCLUDING NEGLIGENCE OR STRICT LIABILITY), OR OTHERWISE,
      *     EVEN IF ANY OF SAID PARTIES HAS BEEN WARNED OF THE
      *     POSSIBILITY OF SUCH LOSS OR DAMAGES.</strong></li>
-     * </ol></td></tr>
+     * <ol></td></tr>
      * </table>
      *
      * @param v Vector of doubles.
@@ -804,7 +804,7 @@ public class MathArrays {
      * <code>a<sub>i</sub> b<sub>i</sub></code> to high accuracy.
      * It does so by using specific multiplication and addition algorithms to
      * preserve accuracy and reduce cancellation effects.
-     * <p>
+     * <br/>
      * It is based on the 2005 paper
      * <a href="http://citeseerx.ist.psu.edu/viewdoc/summary?doi=10.1.1.2.1547">
      * Accurate Sum and Dot Product</a> by Takeshi Ogita, Siegfried M. Rump,
@@ -1277,7 +1277,7 @@ public class MathArrays {
      * Normalizes an array to make it sum to a specified value.
      * Returns the result of the transformation
      * <pre>
-     *    x |-&gt; x * normalizedSum / sum
+     *    x |-> x * normalizedSum / sum
      * </pre>
      * applied to each non-NaN element x of the input array, where sum is the
      * sum of the non-NaN entries in the input array.
@@ -1458,7 +1458,7 @@ public class MathArrays {
 
     /**
      * Shuffle the entries of the given array, using the
-     * <a href="http://en.wikipedia.org/wiki/Fisher-Yates_shuffle#The_modern_algorithm">
+     * <a href="http://en.wikipedia.org/wiki/Fisher–Yates_shuffle#The_modern_algorithm">
      * Fisher–Yates</a> algorithm.
      * The {@code start} and {@code pos} parameters select which portion
      * of the array is randomized and which is left untouched.
@@ -1557,8 +1557,9 @@ public class MathArrays {
      * positive length</li>
      * <li>throws <code>MathIllegalArgumentException</code> if the array is null or
      * or the indices are invalid</li>
-     * <li>returns <code>false</code> if the array is non-null, but <code>length</code> is 0.</li>
-     * </ul>
+     * <li>returns <code>false</li> if the array is non-null, but
+     * <code>length</code> is 0.
+     * </ul></p>
      *
      * @param values the input array
      * @param begin index of the first array element to include
@@ -1581,9 +1582,9 @@ public class MathArrays {
      * non-negative length</li>
      * <li>throws <code>IllegalArgumentException</code> if the array is null or
      * or the indices are invalid</li>
-     * <li>returns <code>false</code> if the array is non-null, but
-     * <code>length</code> is 0 unless <code>allowEmpty</code> is <code>true</code></li>
-     * </ul>
+     * <li>returns <code>false</li> if the array is non-null, but
+     * <code>length</code> is 0 unless <code>allowEmpty</code> is <code>true</code>
+     * </ul></p>
      *
      * @param values the input array
      * @param begin index of the first array element to include
@@ -1638,9 +1639,9 @@ public class MathArrays {
      *     <li>the weights array contains negative values</li>
      *     <li>the start and length arguments do not determine a valid array</li></ul>
      * </li>
-     * <li>returns <code>false</code> if the array is non-null, but
-     * <code>length</code> is 0.</li>
-     * </ul>
+     * <li>returns <code>false</li> if the array is non-null, but
+     * <code>length</code> is 0.
+     * </ul></p>
      *
      * @param values the input array
      * @param weights the weights array
@@ -1675,9 +1676,9 @@ public class MathArrays {
      *     <li>the weights array contains negative values</li>
      *     <li>the start and length arguments do not determine a valid array</li></ul>
      * </li>
-     * <li>returns <code>false</code> if the array is non-null, but
-     * <code>length</code> is 0 unless <code>allowEmpty</code> is <code>true</code>.</li>
-     * </ul>
+     * <li>returns <code>false</li> if the array is non-null, but
+     * <code>length</code> is 0 unless <code>allowEmpty</code> is <code>true</code>.
+     * </ul></p>
      *
      * @param values the input array.
      * @param weights the weights array.

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/util/MathUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/util/MathUtils.java?rev=1591835&r1=1591834&r2=1591835&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/util/MathUtils.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/util/MathUtils.java Fri May  2 09:04:01 2014
@@ -84,9 +84,9 @@ public final class MathUtils {
      * Normalize an angle in a 2&pi; wide interval around a center value.
      * <p>This method has three main uses:</p>
      * <ul>
-     *   <li>normalize an angle between 0 and 2&pi;:<br>
+     *   <li>normalize an angle between 0 and 2&pi;:<br/>
      *       {@code a = MathUtils.normalizeAngle(a, FastMath.PI);}</li>
-     *   <li>normalize an angle between -&pi; and +&pi;<br>
+     *   <li>normalize an angle between -&pi; and +&pi;<br/>
      *       {@code a = MathUtils.normalizeAngle(a, 0.0);}</li>
      *   <li>compute the angle between two defining angular positions:<br>
      *       {@code angle = MathUtils.normalizeAngle(end, start) - start;}</li>
@@ -104,14 +104,14 @@ public final class MathUtils {
      }
 
     /**
-     * Reduce {@code |a - offset|} to the primary interval
-     * {@code [0, |period|)}.
-     * <p>
-     * Specifically, the value returned is <br>
-     * {@code a - |period| * floor((a - offset) / |period|) - offset}.
-     * <p>
-     * If any of the parameters are {@code NaN} or infinite, the result is
-     * {@code NaN}.
+     * <p>Reduce {@code |a - offset|} to the primary interval
+     * {@code [0, |period|)}.</p>
+     *
+     * <p>Specifically, the value returned is <br/>
+     * {@code a - |period| * floor((a - offset) / |period|) - offset}.</p>
+     *
+     * <p>If any of the parameters are {@code NaN} or infinite, the result is
+     * {@code NaN}.</p>
      *
      * @param a Value to reduce.
      * @param period Period.

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/util/Pair.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/util/Pair.java?rev=1591835&r1=1591834&r2=1591835&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/util/Pair.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/util/Pair.java Fri May  2 09:04:01 2014
@@ -18,7 +18,7 @@ package org.apache.commons.math3.util;
 
 /**
  * Generic pair.
- * <p>
+ * <br/>
  * Although the instances of this class are immutable, it is impossible
  * to ensure that the references passed to the constructor will not be
  * modified by the caller.



Mime
View raw message