Repository: commons-math Updated Branches: refs/heads/master cdf22ce63 -> 53ec46ba2
http://git-wip-us.apache.org/repos/asf/commons-math/blob/53ec46ba/src/main/java/org/apache/commons/math4/util/MathArrays.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/math4/util/MathArrays.java b/src/main/java/org/apache/commons/math4/util/MathArrays.java index 8d1236c..768afd1 100644 --- a/src/main/java/org/apache/commons/math4/util/MathArrays.java +++ b/src/main/java/org/apache/commons/math4/util/MathArrays.java @@ -601,7 +601,7 @@ public class MathArrays { } /** - * Check that all entries of the input array are >= 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. @@ -617,7 +617,7 @@ public class MathArrays { } /** - * Check all entries of the input array are >= 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. @@ -637,12 +637,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"> + * <table style="text-align: center; background-color: #E0E0E0" border="0" width="80%" cellpadding="10" summary="MINPACK redistribution policy"> * <tr><td> * Minpack Copyright Notice (1999) University of Chicago. * All rights reserved @@ -687,7 +687,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. @@ -963,7 +963,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. - * <br/> + * <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, @@ -1411,7 +1411,7 @@ public class MathArrays { * Normalizes an array to make it sum to a specified value. * Returns the result of the transformation * <pre> - * x |-> 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. @@ -1595,15 +1595,14 @@ public class MathArrays { /** * This method is used * to verify that the input parameters designate a subarray of positive length. - * <p> * <ul> * <li>returns <code>true</code> iff the parameters designate a subarray of * positive length</li> * <li>throws <code>MathIllegalArgumentException</code> if the array is null or * or the indices are invalid</li> - * <li>returns <code>false</li> if the array is non-null, but - * <code>length</code> is 0. - * </ul></p> + * <li>returns <code>false</code> if the array is non-null, but + * <code>length</code> is 0.</li> + * </ul> * * @param values the input array * @param begin index of the first array element to include @@ -1620,15 +1619,14 @@ public class MathArrays { /** * This method is used * to verify that the input parameters designate a subarray of positive length. - * <p> * <ul> * <li>returns <code>true</code> iff the parameters designate a subarray of * 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</li> if the array is non-null, but - * <code>length</code> is 0 unless <code>allowEmpty</code> is <code>true</code> - * </ul></p> + * <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> * * @param values the input array * @param begin index of the first array element to include @@ -1670,7 +1668,6 @@ public class MathArrays { * This method is used * to verify that the begin and length parameters designate a subarray of positive length * and the weights are all non-negative, non-NaN, finite, and not all zero. - * <p> * <ul> * <li>returns <code>true</code> iff the parameters designate a subarray of * positive length and the weights array contains legitimate values.</li> @@ -1683,9 +1680,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</li> if the array is non-null, but - * <code>length</code> is 0. - * </ul></p> + * <li>returns <code>false</code> if the array is non-null, but + * <code>length</code> is 0.</li> + * </ul> * * @param values the input array * @param weights the weights array @@ -1707,7 +1704,6 @@ public class MathArrays { * This method is used * to verify that the begin and length parameters designate a subarray of positive length * and the weights are all non-negative, non-NaN, finite, and not all zero. - * <p> * <ul> * <li>returns <code>true</code> iff the parameters designate a subarray of * non-negative length and the weights array contains legitimate values.</li> @@ -1720,9 +1716,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</li> if the array is non-null, but - * <code>length</code> is 0 unless <code>allowEmpty</code> is <code>true</code>. - * </ul></p> + * <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> * * @param values the input array. * @param weights the weights array. http://git-wip-us.apache.org/repos/asf/commons-math/blob/53ec46ba/src/main/java/org/apache/commons/math4/util/MathUtils.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/math4/util/MathUtils.java b/src/main/java/org/apache/commons/math4/util/MathUtils.java index 83b7d10..e42f449 100644 --- a/src/main/java/org/apache/commons/math4/util/MathUtils.java +++ b/src/main/java/org/apache/commons/math4/util/MathUtils.java @@ -89,9 +89,9 @@ public final class MathUtils { * Normalize an angle in a 2π wide interval around a center value. * <p>This method has three main uses:</p> * <ul> - * <li>normalize an angle between 0 and 2π:<br/> + * <li>normalize an angle between 0 and 2π:<br> * {@code a = MathUtils.normalizeAngle(a, FastMath.PI);}</li> - * <li>normalize an angle between -π and +π<br/> + * <li>normalize an angle between -π and +π<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> @@ -134,7 +134,7 @@ public final class MathUtils { * <p>Reduce {@code |a - offset|} to the primary interval * {@code [0, |period|)}.</p> * - * <p>Specifically, the value returned is <br/> + * <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 http://git-wip-us.apache.org/repos/asf/commons-math/blob/53ec46ba/src/main/java/org/apache/commons/math4/util/MultidimensionalCounter.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/math4/util/MultidimensionalCounter.java b/src/main/java/org/apache/commons/math4/util/MultidimensionalCounter.java index c73fe24..861fcd9 100644 --- a/src/main/java/org/apache/commons/math4/util/MultidimensionalCounter.java +++ b/src/main/java/org/apache/commons/math4/util/MultidimensionalCounter.java @@ -156,7 +156,7 @@ public class MultidimensionalCounter implements Iterable<Integer> { } /** - * @throws UnsupportedOperationException + * @throws UnsupportedOperationException always */ @Override public void remove() { http://git-wip-us.apache.org/repos/asf/commons-math/blob/53ec46ba/src/main/java/org/apache/commons/math4/util/Pair.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/math4/util/Pair.java b/src/main/java/org/apache/commons/math4/util/Pair.java index f56de9b..6a9ad86 100644 --- a/src/main/java/org/apache/commons/math4/util/Pair.java +++ b/src/main/java/org/apache/commons/math4/util/Pair.java @@ -18,7 +18,7 @@ package org.apache.commons.math4.util; /** * Generic pair. - * <br/> + * <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. http://git-wip-us.apache.org/repos/asf/commons-math/blob/53ec46ba/src/main/java/org/apache/commons/math4/util/ResizableDoubleArray.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/math4/util/ResizableDoubleArray.java b/src/main/java/org/apache/commons/math4/util/ResizableDoubleArray.java index 87f2ec4..f410512 100644 --- a/src/main/java/org/apache/commons/math4/util/ResizableDoubleArray.java +++ b/src/main/java/org/apache/commons/math4/util/ResizableDoubleArray.java @@ -250,7 +250,7 @@ public class ResizableDoubleArray implements DoubleArray, Serializable { /** * Creates an instance with the specified properties. - * <br/> + * <br> * Throws MathIllegalArgumentException if the following conditions * are not met: * <ul> http://git-wip-us.apache.org/repos/asf/commons-math/blob/53ec46ba/src/test/java/org/apache/commons/math4/fitting/leastsquares/AbstractLeastSquaresOptimizerAbstractTest.java ---------------------------------------------------------------------- diff --git a/src/test/java/org/apache/commons/math4/fitting/leastsquares/AbstractLeastSquaresOptimizerAbstractTest.java b/src/test/java/org/apache/commons/math4/fitting/leastsquares/AbstractLeastSquaresOptimizerAbstractTest.java index a7d7374..1e3a35d 100644 --- a/src/test/java/org/apache/commons/math4/fitting/leastsquares/AbstractLeastSquaresOptimizerAbstractTest.java +++ b/src/test/java/org/apache/commons/math4/fitting/leastsquares/AbstractLeastSquaresOptimizerAbstractTest.java @@ -52,7 +52,7 @@ import static org.hamcrest.CoreMatchers.sameInstance; * href="http://www.netlib.org/minpack/ex/file17";>file17</a> and <a * href="http://www.netlib.org/minpack/ex/file22";>file22</a> test files. The * redistribution policy for MINPACK is available <a href="http://www.netlib.org/minpack/disclaimer";>here</a>. - * <p/> + * <p> * <T> Concrete implementation of an optimizer. * */ http://git-wip-us.apache.org/repos/asf/commons-math/blob/53ec46ba/src/test/java/org/apache/commons/math4/fitting/leastsquares/EvaluationTestValidation.java ---------------------------------------------------------------------- diff --git a/src/test/java/org/apache/commons/math4/fitting/leastsquares/EvaluationTestValidation.java b/src/test/java/org/apache/commons/math4/fitting/leastsquares/EvaluationTestValidation.java index 3c637ae..ad1cbc2 100644 --- a/src/test/java/org/apache/commons/math4/fitting/leastsquares/EvaluationTestValidation.java +++ b/src/test/java/org/apache/commons/math4/fitting/leastsquares/EvaluationTestValidation.java @@ -33,9 +33,9 @@ import java.util.List; * {@link LeastSquaresProblem.Evaluation}, common to the * optimizer implementations in package * {@link org.apache.commons.math4.fitting.leastsquares}. - * <br/> + * <br> * Not enabled by default, as the class name does not end with "Test". - * <br/> + * <br> * Invoke by running * <pre><code> * mvn test -Dtest=EvaluationTestValidation @@ -54,13 +54,13 @@ public class EvaluationTestValidation { * Using a Monte-Carlo procedure, this test checks the error estimations * as provided by the square-root of the diagonal elements of the * covariance matrix. - * <br/> + * <br> * The test generates sets of observations, each sampled from * a Gaussian distribution. - * <br/> + * <br> * The optimization problem solved is defined in class * {@link StraightLineProblem}. - * <br/> + * <br> * The output (on stdout) will be a table summarizing the distribution * of parameters generated by the Monte-Carlo process and by the direct * estimation provided by the diagonal elements of the covariance matrix. @@ -166,10 +166,10 @@ public class EvaluationTestValidation { * and determine the parameter change that will result in the * normalized chi-square becoming larger by one than the value from * the best fit solution. - * <br/> + * <br> * The optimization problem solved is defined in class * {@link StraightLineProblem}. - * <br/> + * <br> * The output (on stdout) will be a list of lines containing: * <ul> * <li>slope of the straight line,</li> http://git-wip-us.apache.org/repos/asf/commons-math/blob/53ec46ba/src/test/java/org/apache/commons/math4/optim/nonlinear/scalar/gradient/NonLinearConjugateGradientOptimizerTest.java ---------------------------------------------------------------------- diff --git a/src/test/java/org/apache/commons/math4/optim/nonlinear/scalar/gradient/NonLinearConjugateGradientOptimizerTest.java b/src/test/java/org/apache/commons/math4/optim/nonlinear/scalar/gradient/NonLinearConjugateGradientOptimizerTest.java index 12b2897..71cfa17 100644 --- a/src/test/java/org/apache/commons/math4/optim/nonlinear/scalar/gradient/NonLinearConjugateGradientOptimizerTest.java +++ b/src/test/java/org/apache/commons/math4/optim/nonlinear/scalar/gradient/NonLinearConjugateGradientOptimizerTest.java @@ -44,7 +44,7 @@ import org.junit.Test; * 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"> + * <table style="text-align: center; background-color: #E0E0E0" border="0" width="80%" cellpadding="10" summary="MINPACK redistribution policy"> * <tr><td> * Minpack Copyright Notice (1999) University of Chicago. * All rights reserved http://git-wip-us.apache.org/repos/asf/commons-math/blob/53ec46ba/src/test/java/org/apache/commons/math4/util/FastMathStrictComparisonTest.java ---------------------------------------------------------------------- diff --git a/src/test/java/org/apache/commons/math4/util/FastMathStrictComparisonTest.java b/src/test/java/org/apache/commons/math4/util/FastMathStrictComparisonTest.java index 38e39ca..4488c42 100644 --- a/src/test/java/org/apache/commons/math4/util/FastMathStrictComparisonTest.java +++ b/src/test/java/org/apache/commons/math4/util/FastMathStrictComparisonTest.java @@ -36,9 +36,9 @@ import org.junit.runners.Parameterized.Parameters; /** * Test to compare FastMath results against StrictMath results for boundary values. * <p> - * Running all tests independently: <br/> - * {@code mvn test -Dtest=FastMathStrictComparisonTest}<br/> - * or just run tests against a single method (e.g. scalb):<br/> + * Running all tests independently: <br> + * {@code mvn test -Dtest=FastMathStrictComparisonTest}<br> + * or just run tests against a single method (e.g. scalb):<br> * {@code mvn test -Dtest=FastMathStrictComparisonTest -DargLine="-DtestMethod=scalb"} */ @SuppressWarnings("boxing") http://git-wip-us.apache.org/repos/asf/commons-math/blob/53ec46ba/src/userguide/java/org/apache/commons/math4/userguide/sofm/ChineseRingsClassifier.java ---------------------------------------------------------------------- diff --git a/src/userguide/java/org/apache/commons/math4/userguide/sofm/ChineseRingsClassifier.java b/src/userguide/java/org/apache/commons/math4/userguide/sofm/ChineseRingsClassifier.java index f6a420b..0aa80b1 100644 --- a/src/userguide/java/org/apache/commons/math4/userguide/sofm/ChineseRingsClassifier.java +++ b/src/userguide/java/org/apache/commons/math4/userguide/sofm/ChineseRingsClassifier.java @@ -50,7 +50,7 @@ import org.apache.commons.math4.exception.MathUnsupportedOperationException; * <li>"before.chinese.U.seq.dat": U-matrix of the SOFM before training</li> * <li>"after.chinese.U.seq.dat": U-matrix of the SOFM after training</li> * <li>"after.chinese.hit.seq.dat": Hit histogram after training</li> - * <ul> + * </ul> */ public class ChineseRingsClassifier { /** SOFM. */
