You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by ps...@apache.org on 2008/02/03 06:54:06 UTC
svn commit: r617953 [1/3] - in
/commons/proper/math/trunk/src/java/org/apache/commons/math: distribution/
fraction/ linear/ stat/ stat/descriptive/ stat/descriptive/moment/
stat/descriptive/rank/ stat/descriptive/summary/ stat/inference/
stat/regressio...
Author: psteitz
Date: Sat Feb 2 21:54:00 2008
New Revision: 617953
URL: http://svn.apache.org/viewvc?rev=617953&view=rev
Log:
Javadoc only. Added missing </p>'s
Modified:
commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/AbstractDistribution.java
commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/BinomialDistributionImpl.java
commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/CauchyDistribution.java
commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/CauchyDistributionImpl.java
commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/ChiSquaredDistributionImpl.java
commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/ExponentialDistributionImpl.java
commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/FDistributionImpl.java
commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/GammaDistributionImpl.java
commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/IntegerDistribution.java
commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/NormalDistribution.java
commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/NormalDistributionImpl.java
commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/PascalDistributionImpl.java
commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/PoissonDistributionImpl.java
commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/TDistributionImpl.java
commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/WeibullDistributionImpl.java
commons/proper/math/trunk/src/java/org/apache/commons/math/fraction/Fraction.java
commons/proper/math/trunk/src/java/org/apache/commons/math/fraction/ProperFractionFormat.java
commons/proper/math/trunk/src/java/org/apache/commons/math/linear/BigMatrix.java
commons/proper/math/trunk/src/java/org/apache/commons/math/linear/BigMatrixImpl.java
commons/proper/math/trunk/src/java/org/apache/commons/math/linear/RealMatrix.java
commons/proper/math/trunk/src/java/org/apache/commons/math/linear/RealMatrixImpl.java
commons/proper/math/trunk/src/java/org/apache/commons/math/stat/Frequency.java
commons/proper/math/trunk/src/java/org/apache/commons/math/stat/StatUtils.java
commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/AbstractStorelessUnivariateStatistic.java
commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/AbstractUnivariateStatistic.java
commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/DescriptiveStatistics.java
commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/StorelessUnivariateStatistic.java
commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/UnivariateStatistic.java
commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/FirstMoment.java
commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/FourthMoment.java
commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/GeometricMean.java
commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/Kurtosis.java
commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/Mean.java
commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/SecondMoment.java
commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/Skewness.java
commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/StandardDeviation.java
commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/ThirdMoment.java
commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/Variance.java
commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/rank/Max.java
commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/rank/Median.java
commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/rank/Min.java
commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/rank/Percentile.java
commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/summary/Product.java
commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/summary/Sum.java
commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/summary/SumOfLogs.java
commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/summary/SumOfSquares.java
commons/proper/math/trunk/src/java/org/apache/commons/math/stat/inference/ChiSquareTest.java
commons/proper/math/trunk/src/java/org/apache/commons/math/stat/inference/TTest.java
commons/proper/math/trunk/src/java/org/apache/commons/math/stat/inference/TTestImpl.java
commons/proper/math/trunk/src/java/org/apache/commons/math/stat/inference/UnknownDistributionChiSquareTest.java
commons/proper/math/trunk/src/java/org/apache/commons/math/stat/regression/SimpleRegression.java
commons/proper/math/trunk/src/java/org/apache/commons/math/transform/FastCosineTransformer.java
commons/proper/math/trunk/src/java/org/apache/commons/math/transform/FastFourierTransformer.java
commons/proper/math/trunk/src/java/org/apache/commons/math/transform/FastSineTransformer.java
commons/proper/math/trunk/src/java/org/apache/commons/math/util/ContinuedFraction.java
commons/proper/math/trunk/src/java/org/apache/commons/math/util/MathUtils.java
commons/proper/math/trunk/src/java/org/apache/commons/math/util/ResizableDoubleArray.java
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/AbstractDistribution.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/AbstractDistribution.java?rev=617953&r1=617952&r2=617953&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/AbstractDistribution.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/AbstractDistribution.java Sat Feb 2 21:54:00 2008
@@ -42,9 +42,9 @@
* For a random variable X whose values are distributed according
* to this distribution, this method returns P(x0 ≤ X ≤ x1).
* <p>
- * The default implementation uses the identity
+ * The default implementation uses the identity</p>
* <p>
- * P(x0 ≤ X ≤ x1) = P(X ≤ x1) - P(X ≤ x0)
+ * P(x0 ≤ X ≤ x1) = P(X ≤ x1) - P(X ≤ x0) </p>
*
* @param x0 the (inclusive) lower bound
* @param x1 the (inclusive) upper bound
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/BinomialDistributionImpl.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/BinomialDistributionImpl.java?rev=617953&r1=617952&r2=617953&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/BinomialDistributionImpl.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/BinomialDistributionImpl.java Sat Feb 2 21:54:00 2008
@@ -166,7 +166,7 @@
* that P(X ≤ x) ≤ <code>p</code>.
* <p>
* Returns <code>-1</code> for p=0 and <code>Integer.MAX_VALUE</code> for
- * p=1.
+ * p=1.</p>
*
* @param p the desired probability
* @return the largest x such that P(X ≤ x) <= p
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/CauchyDistribution.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/CauchyDistribution.java?rev=617953&r1=617952&r2=617953&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/CauchyDistribution.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/CauchyDistribution.java Sat Feb 2 21:54:00 2008
@@ -21,7 +21,7 @@
* Cauchy Distribution.
*
* <p>
- * References:<p>
+ * References:
* <ul>
* <li><a href="http://mathworld.wolfram.com/CauchyDistribution.html">
* Cauchy Distribution</a></li>
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/CauchyDistributionImpl.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/CauchyDistributionImpl.java?rev=617953&r1=617952&r2=617953&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/CauchyDistributionImpl.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/CauchyDistributionImpl.java Sat Feb 2 21:54:00 2008
@@ -87,7 +87,7 @@
* that P(X < x) = <code>p</code>.
* <p>
* Returns <code>Double.NEGATIVE_INFINITY</code> for p=0 and
- * <code>Double.POSITIVE_INFINITY</code> for p=1.
+ * <code>Double.POSITIVE_INFINITY</code> for p=1.</p>
*
* @param p the desired probability
* @return x, such that P(X < x) = <code>p</code>
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/ChiSquaredDistributionImpl.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/ChiSquaredDistributionImpl.java?rev=617953&r1=617952&r2=617953&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/ChiSquaredDistributionImpl.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/ChiSquaredDistributionImpl.java Sat Feb 2 21:54:00 2008
@@ -86,7 +86,7 @@
* For this distribution, X, this method returns the critical point x, such
* that P(X < x) = <code>p</code>.
* <p>
- * Returns 0 for p=0 and <code>Double.POSITIVE_INFINITY</code> for p=1.
+ * Returns 0 for p=0 and <code>Double.POSITIVE_INFINITY</code> for p=1.</p>
*
* @param p the desired probability
* @return x, such that P(X < x) = <code>p</code>
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/ExponentialDistributionImpl.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/ExponentialDistributionImpl.java?rev=617953&r1=617952&r2=617953&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/ExponentialDistributionImpl.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/ExponentialDistributionImpl.java Sat Feb 2 21:54:00 2008
@@ -92,7 +92,7 @@
* For this distribution, X, this method returns the critical point x, such
* that P(X < x) = <code>p</code>.
* <p>
- * Returns 0 for p=0 and <code>Double.POSITIVE_INFINITY</code> for p=1.
+ * Returns 0 for p=0 and <code>Double.POSITIVE_INFINITY</code> for p=1.</p>
*
* @param p the desired probability
* @return x, such that P(X < x) = <code>p</code>
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/FDistributionImpl.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/FDistributionImpl.java?rev=617953&r1=617952&r2=617953&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/FDistributionImpl.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/FDistributionImpl.java Sat Feb 2 21:54:00 2008
@@ -86,7 +86,7 @@
* For this distribution, X, this method returns the critical point x, such
* that P(X < x) = <code>p</code>.
* <p>
- * Returns 0 for p=0 and <code>Double.POSITIVE_INFINITY</code> for p=1.
+ * Returns 0 for p=0 and <code>Double.POSITIVE_INFINITY</code> for p=1.</p>
*
* @param p the desired probability
* @return x, such that P(X < x) = <code>p</code>
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/GammaDistributionImpl.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/GammaDistributionImpl.java?rev=617953&r1=617952&r2=617953&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/GammaDistributionImpl.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/GammaDistributionImpl.java Sat Feb 2 21:54:00 2008
@@ -82,7 +82,7 @@
* For this distribution, X, this method returns the critical point x, such
* that P(X < x) = <code>p</code>.
* <p>
- * Returns 0 for p=0 and <code>Double.POSITIVE_INFINITY</code> for p=1.
+ * Returns 0 for p=0 and <code>Double.POSITIVE_INFINITY</code> for p=1.</p>
*
* @param p the desired probability
* @return x, such that P(X < x) = <code>p</code>
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/IntegerDistribution.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/IntegerDistribution.java?rev=617953&r1=617952&r2=617953&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/IntegerDistribution.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/IntegerDistribution.java Sat Feb 2 21:54:00 2008
@@ -72,7 +72,7 @@
* P(X ≤ M) =1, then <code>M</code> is returned by
* <code>inverseCumulativeProbability(1).</code>
* If there is no such value, <code>M, Integer.MAX_VALUE</code> is
- * returned.</li></ul>
+ * returned.</li></ul></p>
*
* @param p the cumulative probability.
* @return the largest x such that P(X ≤ x) <= p
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/NormalDistribution.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/NormalDistribution.java?rev=617953&r1=617952&r2=617953&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/NormalDistribution.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/NormalDistribution.java Sat Feb 2 21:54:00 2008
@@ -21,7 +21,7 @@
* Normal (Gauss) Distribution.
*
* <p>
- * References:<p>
+ * References:</p><p>
* <ul>
* <li><a href="http://mathworld.wolfram.com/NormalDistribution.html">
* Normal Distribution</a></li>
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/NormalDistributionImpl.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/NormalDistributionImpl.java?rev=617953&r1=617952&r2=617953&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/NormalDistributionImpl.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/NormalDistributionImpl.java Sat Feb 2 21:54:00 2008
@@ -125,7 +125,7 @@
* that P(X < x) = <code>p</code>.
* <p>
* Returns <code>Double.NEGATIVE_INFINITY</code> for p=0 and
- * <code>Double.POSITIVE_INFINITY</code> for p=1.
+ * <code>Double.POSITIVE_INFINITY</code> for p=1.</p>
*
* @param p the desired probability
* @return x, such that P(X < x) = <code>p</code>
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/PascalDistributionImpl.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/PascalDistributionImpl.java?rev=617953&r1=617952&r2=617953&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/PascalDistributionImpl.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/PascalDistributionImpl.java Sat Feb 2 21:54:00 2008
@@ -159,7 +159,7 @@
* P(X ≤ x) ≤ <code>p</code>.
* <p>
* Returns <code>-1</code> for p=0 and <code>Integer.MAX_VALUE</code>
- * for p=1.
+ * for p=1.</p>
* @param p the desired probability
* @return the largest x such that P(X ≤ x) <= p
* @throws MathException if the inverse cumulative probability can not be
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/PoissonDistributionImpl.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/PoissonDistributionImpl.java?rev=617953&r1=617952&r2=617953&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/PoissonDistributionImpl.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/PoissonDistributionImpl.java Sat Feb 2 21:54:00 2008
@@ -135,7 +135,7 @@
* distribution is used to approximate the Poisson distribution.
* <p>
* The computation uses "half-correction" -- evaluating the normal
- * distribution function at <code>x + 0.5</code>
+ * distribution function at <code>x + 0.5</code></p>
*
* @param x the upper bound, inclusive
* @return the distribution function value calculated using a normal approximation
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/TDistributionImpl.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/TDistributionImpl.java?rev=617953&r1=617952&r2=617953&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/TDistributionImpl.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/TDistributionImpl.java Sat Feb 2 21:54:00 2008
@@ -97,7 +97,7 @@
* that P(X < x) = <code>p</code>.
* <p>
* Returns <code>Double.NEGATIVE_INFINITY</code> for p=0 and
- * <code>Double.POSITIVE_INFINITY</code> for p=1.
+ * <code>Double.POSITIVE_INFINITY</code> for p=1.</p>
*
* @param p the desired probability
* @return x, such that P(X < x) = <code>p</code>
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/WeibullDistributionImpl.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/WeibullDistributionImpl.java?rev=617953&r1=617952&r2=617953&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/WeibullDistributionImpl.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/distribution/WeibullDistributionImpl.java Sat Feb 2 21:54:00 2008
@@ -86,7 +86,7 @@
* that P(X < x) = <code>p</code>.
* <p>
* Returns <code>Double.NEGATIVE_INFINITY</code> for p=0 and
- * <code>Double.POSITIVE_INFINITY</code> for p=1.
+ * <code>Double.POSITIVE_INFINITY</code> for p=1.</p>
*
* @param p the desired probability
* @return x, such that P(X < x) = <code>p</code>
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/fraction/Fraction.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/fraction/Fraction.java?rev=617953&r1=617952&r2=617953&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/fraction/Fraction.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/fraction/Fraction.java Sat Feb 2 21:54:00 2008
@@ -106,7 +106,7 @@
* - a valid maxDenominator value and the epsilon value set to zero
* (that way epsilon only has effect if there is an exact match before
* the maxDenominator value is reached).
- * <p>
+ * </p><p>
*
* It has been done this way so that the same code can be (re)used for both
* scenarios. However this could be confusing to users if it were part of
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/fraction/ProperFractionFormat.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/fraction/ProperFractionFormat.java?rev=617953&r1=617952&r2=617953&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/fraction/ProperFractionFormat.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/fraction/ProperFractionFormat.java Sat Feb 2 21:54:00 2008
@@ -28,7 +28,7 @@
* <p>
* Minus signs are only allowed in the whole number part - i.e.,
* "-3 1/2" is legitimate and denotes -7/2, but "-3 -1/2" is invalid and
- * will result in a <code>ParseException</code>.
+ * will result in a <code>ParseException</code>.</p>
*
* @since 1.1
* @version $Revision$ $Date$
@@ -122,7 +122,7 @@
* <p>
* Minus signs are only allowed in the whole number part - i.e.,
* "-3 1/2" is legitimate and denotes -7/2, but "-3 -1/2" is invalid and
- * will result in a <code>ParseException</code>.
+ * will result in a <code>ParseException</code>.</p>
*
* @param source the string to parse
* @param pos input/ouput parsing parameter.
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/linear/BigMatrix.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/linear/BigMatrix.java?rev=617953&r1=617952&r2=617953&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/linear/BigMatrix.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/linear/BigMatrix.java Sat Feb 2 21:54:00 2008
@@ -24,7 +24,7 @@
* BigDecimal representations for the entries.
* <p>
* Matrix element indexing is 0-based -- e.g., <code>getEntry(0, 0)</code>
- * returns the element in the first row, first column of the matrix.
+ * returns the element in the first row, first column of the matrix.</p>
*
* @version $Revision$ $Date$
*/
@@ -170,7 +170,7 @@
* Returns the entries in row number <code>row</code> as an array.
* <p>
* Row indices start at 0. A <code>MatrixIndexException</code> is thrown
- * unless <code>0 <= row < rowDimension.</code>
+ * unless <code>0 <= row < rowDimension.</code></p>
*
* @param row the row to be fetched
* @return array of entries in the row
@@ -183,7 +183,7 @@
* of double values.
* <p>
* Row indices start at 0. A <code>MatrixIndexException</code> is thrown
- * unless <code>0 <= row < rowDimension.</code>
+ * unless <code>0 <= row < rowDimension.</code></p>
*
* @param row the row to be fetched
* @return array of entries in the row
@@ -195,7 +195,7 @@
* Returns the entries in column number <code>col</code> as an array.
* <p>
* Column indices start at 0. A <code>MatrixIndexException</code> is thrown
- * unless <code>0 <= column < columnDimension.</code>
+ * unless <code>0 <= column < columnDimension.</code></p>
*
* @param col the column to be fetched
* @return array of entries in the column
@@ -208,7 +208,7 @@
* of double values.
* <p>
* Column indices start at 0. A <code>MatrixIndexException</code> is thrown
- * unless <code>0 <= column < columnDimension.</code>
+ * unless <code>0 <= column < columnDimension.</code></p>
*
* @param col the column to be fetched
* @return array of entries in the column
@@ -224,7 +224,7 @@
* <li><code>0 <= row < rowDimension</code></li>
* <li><code> 0 <= column < columnDimension</code></li>
* </ul>
- * otherwise a <code>MatrixIndexException</code> is thrown.
+ * otherwise a <code>MatrixIndexException</code> is thrown.</p>
*
* @param row row location of entry to be fetched
* @param column column location of entry to be fetched
@@ -241,7 +241,7 @@
* <li><code>0 <= row < rowDimension</code></li>
* <li><code> 0 <= column < columnDimension</code></li>
* </ul>
- * otherwise a <code>MatrixIndexException</code> is thrown.
+ * otherwise a <code>MatrixIndexException</code> is thrown.</p>
*
* @param row row location of entry to be fetched
* @param column column location of entry to be fetched
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/linear/BigMatrixImpl.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/linear/BigMatrixImpl.java?rev=617953&r1=617952&r2=617953&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/linear/BigMatrixImpl.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/linear/BigMatrixImpl.java Sat Feb 2 21:54:00 2008
@@ -29,7 +29,7 @@
* <li>solve</li>
* <li>isSingular</li>
* <li>getDeterminant</li>
- * <li>inverse</li> </ul>
+ * <li>inverse</li> </ul></p>
* <p>
* <strong>Usage notes</strong>:<br>
* <ul><li>
@@ -43,7 +43,8 @@
* <li>
* As specified in the {@link BigMatrix} interface, matrix element indexing
* is 0-based -- e.g., <code>getEntry(0, 0)</code>
- * returns the element in the first row, first column of the matrix.</li></ul>
+ * returns the element in the first row, first column of the matrix.</li></ul></p>
+ *
* @version $Revision$ $Date$
*/
public class BigMatrixImpl implements BigMatrix, Serializable {
@@ -106,7 +107,7 @@
* Create a new BigMatrix using the <code>data</code> as the underlying
* data array.
* <p>
- * The input array is copied, not referenced.
+ * The input array is copied, not referenced.</p>
*
* @param d data for new matrix
* @throws IllegalArgumentException if <code>d</code> is not rectangular
@@ -122,7 +123,7 @@
* Create a new BigMatrix using the <code>data</code> as the underlying
* data array.
* <p>
- * The input array is copied, not referenced.
+ * The input array is copied, not referenced.</p>
*
* @param d data for new matrix
* @throws IllegalArgumentException if <code>d</code> is not rectangular
@@ -185,7 +186,7 @@
* data for the unique column of the <code>v.length x 1</code> matrix
* created.
* <p>
- * The input array is copied, not referenced.
+ * The input array is copied, not referenced.</p>
*
* @param v column vector holding data for new matrix
*/
@@ -329,7 +330,7 @@
/**
* Returns matrix entries as a two-dimensional array.
* <p>
- * Makes a fresh copy of the underlying data.
+ * Makes a fresh copy of the underlying data.</p>
*
* @return 2-dimensional array of entries
*/
@@ -341,7 +342,7 @@
* Returns matrix entries as a two-dimensional array.
* <p>
* Makes a fresh copy of the underlying data converted to
- * <code>double</code> values.
+ * <code>double</code> values.</p>
*
* @return 2-dimensional array of entries
*/
@@ -360,7 +361,7 @@
/**
* Returns a reference to the underlying data array.
* <p>
- * Does not make a fresh copy of the underlying data.
+ * Does not make a fresh copy of the underlying data.</p>
*
* @return 2-dimensional array of entries
*/
@@ -503,7 +504,7 @@
* 1 2 3 4
* 5 3 4 8
* 9 5 6 2
- * </pre>
+ * </pre></p>
*
* @param subMatrix array containing the submatrix replacement data
* @param row row coordinate of the top, left element to be replaced
@@ -595,7 +596,7 @@
* Returns the entries in row number <code>row</code> as an array.
* <p>
* Row indices start at 0. A <code>MatrixIndexException</code> is thrown
- * unless <code>0 <= row < rowDimension.</code>
+ * unless <code>0 <= row < rowDimension.</code></p>
*
* @param row the row to be fetched
* @return array of entries in the row
@@ -616,7 +617,7 @@
* of double values.
* <p>
* Row indices start at 0. A <code>MatrixIndexException</code> is thrown
- * unless <code>0 <= row < rowDimension.</code>
+ * unless <code>0 <= row < rowDimension.</code></p>
*
* @param row the row to be fetched
* @return array of entries in the row
@@ -638,7 +639,7 @@
* Returns the entries in column number <code>col</code> as an array.
* <p>
* Column indices start at 0. A <code>MatrixIndexException</code> is thrown
- * unless <code>0 <= column < columnDimension.</code>
+ * unless <code>0 <= column < columnDimension.</code></p>
*
* @param col the column to be fetched
* @return array of entries in the column
@@ -661,7 +662,7 @@
* of double values.
* <p>
* Column indices start at 0. A <code>MatrixIndexException</code> is thrown
- * unless <code>0 <= column < columnDimension.</code>
+ * unless <code>0 <= column < columnDimension.</code></p>
*
* @param col the column to be fetched
* @return array of entries in the column
@@ -687,7 +688,7 @@
* <li><code>0 <= row < rowDimension</code></li>
* <li><code> 0 <= column < columnDimension</code></li>
* </ul>
- * otherwise a <code>MatrixIndexException</code> is thrown.
+ * otherwise a <code>MatrixIndexException</code> is thrown.</p>
*
* @param row row location of entry to be fetched
* @param column column location of entry to be fetched
@@ -710,7 +711,7 @@
* <li><code>0 <= row < rowDimension</code></li>
* <li><code> 0 <= column < columnDimension</code></li>
* </ul>
- * otherwise a <code>MatrixIndexException</code> is thrown.
+ * otherwise a <code>MatrixIndexException</code> is thrown.</p>
*
* @param row row location of entry to be fetched
* @param column column location of entry to be fetched
@@ -1007,14 +1008,14 @@
* <p>
* <strong>Implementation Note</strong>:<br>
* Uses <a href="http://www.damtp.cam.ac.uk/user/fdl/people/sd/lectures/nummeth98/linear.htm">
- * Crout's algortithm</a>, with partial pivoting.
+ * Crout's algortithm</a>, with partial pivoting.</p>
* <p>
* <strong>Usage Note</strong>:<br>
* This method should rarely be invoked directly. Its only use is
* to force recomputation of the LU decomposition when changes have been
* made to the underlying data using direct array references. Changes
* made using setXxx methods will trigger recomputation when needed
- * automatically.
+ * automatically.</p>
*
* @throws InvalidMatrixException if the matrix is non-square or singular.
*/
@@ -1194,7 +1195,7 @@
* The matrix returned is a compact representation of the LU decomposition.
* Elements below the main diagonal correspond to entries of the "L" matrix;
* elements on and above the main diagonal correspond to entries of the "U"
- * matrix.
+ * matrix.</p>
* <p>
* Example: <pre>
*
@@ -1206,7 +1207,7 @@
*
* The L and U matrices satisfy the matrix equation LU = permuteRows(this), <br>
* where permuteRows reorders the rows of the matrix to follow the order determined
- * by the <a href=#getPermutation()>permutation</a> property.
+ * by the <a href=#getPermutation()>permutation</a> property.</p>
*
* @return LU decomposition matrix
* @throws InvalidMatrixException if the matrix is non-square or singular.
@@ -1224,9 +1225,9 @@
* <p>
* Example:
* permutation = [1, 2, 0] means current 2nd row is first, current third row is second
- * and current first row is last.
+ * and current first row is last.</p>
* <p>
- * Returns a fresh copy of the array.
+ * Returns a fresh copy of the array.</p>
*
* @return the permutation
*/
@@ -1256,7 +1257,7 @@
/**
* Replaces data with a fresh copy of the input array.
* <p>
- * Verifies that the input array is rectangular and non-empty.
+ * Verifies that the input array is rectangular and non-empty.</p>
*
* @param in data to copy in
* @throws IllegalArgumentException if input array is emtpy or not
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/linear/RealMatrix.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/linear/RealMatrix.java?rev=617953&r1=617952&r2=617953&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/linear/RealMatrix.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/linear/RealMatrix.java Sat Feb 2 21:54:00 2008
@@ -21,7 +21,7 @@
* Interface defining a real-valued matrix with basic algebraic operations.
* <p>
* Matrix element indexing is 0-based -- e.g., <code>getEntry(0, 0)</code>
- * returns the element in the first row, first column of the matrix.
+ * returns the element in the first row, first column of the matrix.</p>
*
* @version $Revision$ $Date$
*/
@@ -153,7 +153,7 @@
* Returns the entries in row number <code>row</code> as an array.
* <p>
* Row indices start at 0. A <code>MatrixIndexException</code> is thrown
- * unless <code>0 <= row < rowDimension.</code>
+ * unless <code>0 <= row < rowDimension.</code></p>
*
* @param row the row to be fetched
* @return array of entries in the row
@@ -165,7 +165,7 @@
* Returns the entries in column number <code>col</code> as an array.
* <p>
* Column indices start at 0. A <code>MatrixIndexException</code> is thrown
- * unless <code>0 <= column < columnDimension.</code>
+ * unless <code>0 <= column < columnDimension.</code></p>
*
* @param col the column to be fetched
* @return array of entries in the column
@@ -181,7 +181,7 @@
* <li><code>0 <= row < rowDimension</code></li>
* <li><code> 0 <= column < columnDimension</code></li>
* </ul>
- * otherwise a <code>MatrixIndexException</code> is thrown.
+ * otherwise a <code>MatrixIndexException</code> is thrown.</p>
*
* @param row row location of entry to be fetched
* @param column column location of entry to be fetched
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/linear/RealMatrixImpl.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/linear/RealMatrixImpl.java?rev=617953&r1=617952&r2=617953&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/linear/RealMatrixImpl.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/linear/RealMatrixImpl.java Sat Feb 2 21:54:00 2008
@@ -31,7 +31,7 @@
* <li>solve</li>
* <li>isSingular</li>
* <li>getDeterminant</li>
- * <li>inverse</li> </ul>
+ * <li>inverse</li> </ul></p>
* <p>
* <strong>Usage notes</strong>:<br>
* <ul><li>
@@ -45,6 +45,7 @@
* As specified in the {@link RealMatrix} interface, matrix element indexing
* is 0-based -- e.g., <code>getEntry(0, 0)</code>
* returns the element in the first row, first column of the matrix.</li></ul>
+ * </p>
*
* @version $Revision$ $Date$
*/
@@ -97,7 +98,7 @@
* Create a new RealMatrix using the input array as the underlying
* data array.
* <p>
- * The input array is copied, not referenced.
+ * The input array is copied, not referenced.</p>
*
* @param d data for new matrix
* @throws IllegalArgumentException if <code>data</code> is not rectangular
@@ -114,7 +115,7 @@
* data for the unique column of the <code>v.length x 1</code> matrix
* created.
* <p>
- * The input array is copied, not referenced.
+ * The input array is copied, not referenced.</p>
*
* @param v column vector holding data for new matrix
*/
@@ -258,7 +259,7 @@
/**
* Returns matrix entries as a two-dimensional array.
* <p>
- * Makes a fresh copy of the underlying data.
+ * Makes a fresh copy of the underlying data.</p>
*
* @return 2-dimensional array of entries
*/
@@ -269,7 +270,7 @@
/**
* Returns a reference to the underlying data array.
* <p>
- * Does not make a fresh copy of the underlying data.
+ * Does not make a fresh copy of the underlying data.</p>
*
* @return 2-dimensional array of entries
*/
@@ -372,7 +373,7 @@
* 1 2 3 4
* 5 3 4 8
* 9 5 6 2
- * </pre>
+ * </pre></p>
*
* @param subMatrix array containing the submatrix replacement data
* @param row row coordinate of the top, left element to be replaced
@@ -464,7 +465,7 @@
* Returns the entries in row number <code>row</code> as an array.
* <p>
* Row indices start at 0. A <code>MatrixIndexException</code> is thrown
- * unless <code>0 <= row < rowDimension.</code>
+ * unless <code>0 <= row < rowDimension.</code></p>
*
* @param row the row to be fetched
* @return array of entries in the row
@@ -484,7 +485,7 @@
* Returns the entries in column number <code>col</code> as an array.
* <p>
* Column indices start at 0. A <code>MatrixIndexException</code> is thrown
- * unless <code>0 <= column < columnDimension.</code>
+ * unless <code>0 <= column < columnDimension.</code></p>
*
* @param col the column to be fetched
* @return array of entries in the column
@@ -510,7 +511,7 @@
* <li><code>0 <= row < rowDimension</code></li>
* <li><code> 0 <= column < columnDimension</code></li>
* </ul>
- * otherwise a <code>MatrixIndexException</code> is thrown.
+ * otherwise a <code>MatrixIndexException</code> is thrown.</p>
*
* @param row row location of entry to be fetched
* @param column column location of entry to be fetched
@@ -760,14 +761,14 @@
* <p>
* <strong>Implementation Note</strong>:<br>
* Uses <a href="http://www.damtp.cam.ac.uk/user/fdl/people/sd/lectures/nummeth98/linear.htm">
- * Crout's algorithm</a>, with partial pivoting.
+ * Crout's algorithm</a>, with partial pivoting.</p>
* <p>
* <strong>Usage Note</strong>:<br>
* This method should rarely be invoked directly. Its only use is
* to force recomputation of the LU decomposition when changes have been
* made to the underlying data using direct array references. Changes
* made using setXxx methods will trigger recomputation when needed
- * automatically.
+ * automatically.</p>
*
* @throws InvalidMatrixException if the matrix is non-square or singular.
*/
@@ -946,7 +947,7 @@
* The matrix returned is a compact representation of the LU decomposition.
* Elements below the main diagonal correspond to entries of the "L" matrix;
* elements on and above the main diagonal correspond to entries of the "U"
- * matrix.
+ * matrix.</p>
* <p>
* Example: <pre>
*
@@ -958,7 +959,7 @@
*
* The L and U matrices satisfy the matrix equation LU = permuteRows(this), <br>
* where permuteRows reorders the rows of the matrix to follow the order determined
- * by the <a href=#getPermutation()>permutation</a> property.
+ * by the <a href=#getPermutation()>permutation</a> property.</p>
*
* @return LU decomposition matrix
* @throws InvalidMatrixException if the matrix is non-square or singular.
@@ -976,9 +977,9 @@
* <p>
* Example:
* permutation = [1, 2, 0] means current 2nd row is first, current third row is second
- * and current first row is last.
+ * and current first row is last.</p>
* <p>
- * Returns a fresh copy of the array.
+ * Returns a fresh copy of the array.</p>
*
* @return the permutation
*/
@@ -1008,7 +1009,7 @@
/**
* Replaces data with a fresh copy of the input array.
* <p>
- * Verifies that the input array is rectangular and non-empty
+ * Verifies that the input array is rectangular and non-empty.</p>
*
* @param in data to copy in
* @throws IllegalArgumentException if input array is empty or not
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/stat/Frequency.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/stat/Frequency.java?rev=617953&r1=617952&r2=617953&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/stat/Frequency.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/stat/Frequency.java Sat Feb 2 21:54:00 2008
@@ -27,14 +27,14 @@
* <p>
* Accepts int, long, char or Object values. New values added must be
* comparable to those that have been added, otherwise the add method will
- * throw an IllegalArgumentException.
+ * throw an IllegalArgumentException.</p>
* <p>
* Integer values (int, long, Integer, Long) are not distinguished by type --
* i.e. <code>addValue(new Long(2)), addValue(2), addValue(2l)</code> all have
- * the same effect (similarly for arguments to <code>getCount,</code> etc.).
+ * the same effect (similarly for arguments to <code>getCount,</code> etc.).</p>
* <p>
* The values are ordered using the default (natural order), unless a
- * <code>Comparator</code> is supplied in the constructor.
+ * <code>Comparator</code> is supplied in the constructor.</p>
*
* @version $Revision$ $Date$
*/
@@ -157,7 +157,7 @@
* <p>
* If added values are itegral (i.e., integers, longs, Integers, or Longs),
* they are converted to Longs when they are added, so the objects returned
- * by the Iterator will in this case be Longs.
+ * by the Iterator will in this case be Longs.</p>
*
* @return values Iterator
*/
@@ -239,7 +239,7 @@
* Returns the percentage of values that are equal to v
* (as a proportion between 0 and 1).
* <p>
- * Returns <code>Double.NaN</code> if no values have been added.
+ * Returns <code>Double.NaN</code> if no values have been added.</p>
*
* @param v the value to lookup
* @return the proportion of values equal to v
@@ -252,7 +252,7 @@
}
/**
- * Returns the percentage of values that are equal to v
+ * Returns the percentage of values that are equal to v
* (as a proportion between 0 and 1).
*
* @param v the value to lookup
@@ -263,7 +263,7 @@
}
/**
- * Returns the percentage of values that are equal to v
+ * Returns the percentage of values that are equal to v
* (as a proportion between 0 and 1).
*
* @param v the value to lookup
@@ -289,7 +289,7 @@
/**
* Returns the cumulative frequency of values less than or equal to v.
* <p>
- * Returns 0 if v is not comparable to the values set.
+ * Returns 0 if v is not comparable to the values set.</p>
*
* @param v the value to lookup.
* @return the proportion of values equal to v
@@ -339,7 +339,7 @@
/**
* Returns the cumulative frequency of values less than or equal to v.
* <p>
- * Returns 0 if v is not comparable to the values set.
+ * Returns 0 if v is not comparable to the values set.</p>
*
* @param v the value to lookup
* @return the proportion of values equal to v
@@ -351,7 +351,7 @@
/**
* Returns the cumulative frequency of values less than or equal to v.
* <p>
- * Returns 0 if v is not comparable to the values set.
+ * Returns 0 if v is not comparable to the values set.</p>
*
* @param v the value to lookup
* @return the proportion of values equal to v
@@ -363,7 +363,7 @@
/**
* Returns the cumulative frequency of values less than or equal to v.
* <p>
- * Returns 0 if v is not comparable to the values set.
+ * Returns 0 if v is not comparable to the values set.</p>
*
* @param v the value to lookup
* @return the proportion of values equal to v
@@ -374,13 +374,13 @@
//----------------------------------------------------------------------------------------------
- /**
+ /**
* Returns the cumulative percentage of values less than or equal to v
* (as a proportion between 0 and 1).
* <p>
* Returns <code>Double.NaN</code> if no values have been added.
* Returns 0 if at least one value has been added, but v is not comparable
- * to the values set.
+ * to the values set.</p>
*
* @param v the value to lookup
* @return the proportion of values less than or equal to v
@@ -396,7 +396,7 @@
* Returns the cumulative percentage of values less than or equal to v
* (as a proportion between 0 and 1).
* <p>
- * Returns 0 if v is not comparable to the values set.
+ * Returns 0 if v is not comparable to the values set.</p>
*
* @param v the value to lookup
* @return the proportion of values less than or equal to v
@@ -409,7 +409,7 @@
* Returns the cumulative percentage of values less than or equal to v
* (as a proportion between 0 and 1).
* <p>
- * Returns 0 if v is not comparable to the values set.
+ * Returns 0 if v is not comparable to the values set.</p>
*
* @param v the value to lookup
* @return the proportion of values less than or equal to v
@@ -422,7 +422,7 @@
* Returns the cumulative percentage of values less than or equal to v
* (as a proportion between 0 and 1).
* <p>
- * Returns 0 if v is not comparable to the values set.
+ * Returns 0 if v is not comparable to the values set.</p>
*
* @param v the value to lookup
* @return the proportion of values less than or equal to v
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/stat/StatUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/stat/StatUtils.java?rev=617953&r1=617952&r2=617953&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/stat/StatUtils.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/stat/StatUtils.java Sat Feb 2 21:54:00 2008
@@ -77,7 +77,7 @@
* <code>Double.NaN</code> if the array is empty.
* <p>
* Throws <code>IllegalArgumentException</code> if the input array
- * is null.
+ * is null.</p>
*
* @param values array of values to sum
* @return the sum of the values or <code>Double.NaN</code> if the array
@@ -93,7 +93,7 @@
* the input array, or <code>Double.NaN</code> if the designated subarray
* is empty.
* <p>
- * Throws <code>IllegalArgumentException</code> if the array is null.
+ * Throws <code>IllegalArgumentException</code> if the array is null.</p>
*
* @param values the input array
* @param begin index of the first array element to include
@@ -111,7 +111,7 @@
* Returns the sum of the squares of the entries in the input array, or
* <code>Double.NaN</code> if the array is empty.
* <p>
- * Throws <code>IllegalArgumentException</code> if the array is null.
+ * Throws <code>IllegalArgumentException</code> if the array is null.</p>
*
* @param values input array
* @return the sum of the squared values or <code>Double.NaN</code> if the
@@ -127,7 +127,7 @@
* the input array, or <code>Double.NaN</code> if the designated subarray
* is empty.
* <p>
- * Throws <code>IllegalArgumentException</code> if the array is null.
+ * Throws <code>IllegalArgumentException</code> if the array is null.</p>
*
* @param values the input array
* @param begin index of the first array element to include
@@ -145,7 +145,7 @@
* Returns the product of the entries in the input array, or
* <code>Double.NaN</code> if the array is empty.
* <p>
- * Throws <code>IllegalArgumentException</code> if the array is null.
+ * Throws <code>IllegalArgumentException</code> if the array is null.</p>
*
* @param values the input array
* @return the product of the values or Double.NaN if the array is empty
@@ -160,7 +160,7 @@
* the input array, or <code>Double.NaN</code> if the designated subarray
* is empty.
* <p>
- * Throws <code>IllegalArgumentException</code> if the array is null.
+ * Throws <code>IllegalArgumentException</code> if the array is null.</p>
*
* @param values the input array
* @param begin index of the first array element to include
@@ -178,9 +178,10 @@
* Returns the sum of the natural logs of the entries in the input array, or
* <code>Double.NaN</code> if the array is empty.
* <p>
- * Throws <code>IllegalArgumentException</code> if the array is null.
+ * Throws <code>IllegalArgumentException</code> if the array is null.</p>
* <p>
* See {@link org.apache.commons.math.stat.descriptive.summary.SumOfLogs}.
+ * </p>
*
* @param values the input array
* @return the sum of the natural logs of the values or Double.NaN if
@@ -196,9 +197,10 @@
* the input array, or <code>Double.NaN</code> if the designated subarray
* is empty.
* <p>
- * Throws <code>IllegalArgumentException</code> if the array is null.
+ * Throws <code>IllegalArgumentException</code> if the array is null.</p>
* <p>
- * See {@link org.apache.commons.math.stat.descriptive.summary.SumOfLogs}.
+ * See {@link org.apache.commons.math.stat.descriptive.summary.SumOfLogs}.
+ * </p>
*
* @param values the input array
* @param begin index of the first array element to include
@@ -217,10 +219,10 @@
* Returns the arithmetic mean of the entries in the input array, or
* <code>Double.NaN</code> if the array is empty.
* <p>
- * Throws <code>IllegalArgumentException</code> if the array is null.
+ * Throws <code>IllegalArgumentException</code> if the array is null.</p>
* <p>
* See {@link org.apache.commons.math.stat.descriptive.moment.Mean} for
- * details on the computing algorithm.
+ * details on the computing algorithm.</p>
*
* @param values the input array
* @return the mean of the values or Double.NaN if the array is empty
@@ -235,10 +237,10 @@
* the input array, or <code>Double.NaN</code> if the designated subarray
* is empty.
* <p>
- * Throws <code>IllegalArgumentException</code> if the array is null.
+ * Throws <code>IllegalArgumentException</code> if the array is null.</p>
* <p>
* See {@link org.apache.commons.math.stat.descriptive.moment.Mean} for
- * details on the computing algorithm.
+ * details on the computing algorithm.</p>
*
* @param values the input array
* @param begin index of the first array element to include
@@ -256,10 +258,10 @@
* Returns the geometric mean of the entries in the input array, or
* <code>Double.NaN</code> if the array is empty.
* <p>
- * Throws <code>IllegalArgumentException</code> if the array is null.
+ * Throws <code>IllegalArgumentException</code> if the array is null.</p>
* <p>
* See {@link org.apache.commons.math.stat.descriptive.moment.GeometricMean}
- * for details on the computing algorithm.
+ * for details on the computing algorithm.</p>
*
* @param values the input array
* @return the geometric mean of the values or Double.NaN if the array is empty
@@ -274,10 +276,10 @@
* the input array, or <code>Double.NaN</code> if the designated subarray
* is empty.
* <p>
- * Throws <code>IllegalArgumentException</code> if the array is null.
+ * Throws <code>IllegalArgumentException</code> if the array is null.</p>
* <p>
* See {@link org.apache.commons.math.stat.descriptive.moment.GeometricMean}
- * for details on the computing algorithm.
+ * for details on the computing algorithm.</p>
*
* @param values the input array
* @param begin index of the first array element to include
@@ -297,11 +299,11 @@
* <code>Double.NaN</code> if the array is empty.
* <p>
* See {@link org.apache.commons.math.stat.descriptive.moment.Variance} for
- * details on the computing algorithm.
+ * details on the computing algorithm.</p>
* <p>
- * Returns 0 for a single-value (i.e. length = 1) sample.
+ * Returns 0 for a single-value (i.e. length = 1) sample.</p>
* <p>
- * Throws <code>IllegalArgumentException</code> if the array is null.
+ * Throws <code>IllegalArgumentException</code> if the array is null.</p>
*
* @param values the input array
* @return the variance of the values or Double.NaN if the array is empty
@@ -317,12 +319,12 @@
* is empty.
* <p>
* See {@link org.apache.commons.math.stat.descriptive.moment.Variance} for
- * details on the computing algorithm.
+ * details on the computing algorithm.</p>
* <p>
- * Returns 0 for a single-value (i.e. length = 1) sample.
+ * Returns 0 for a single-value (i.e. length = 1) sample.</p>
* <p>
* Throws <code>IllegalArgumentException</code> if the array is null or the
- * array index parameters are not valid.
+ * array index parameters are not valid.</p>
*
* @param values the input array
* @param begin index of the first array element to include
@@ -342,17 +344,17 @@
* <code>Double.NaN</code> if the designated subarray is empty.
* <p>
* See {@link org.apache.commons.math.stat.descriptive.moment.Variance} for
- * details on the computing algorithm.
+ * details on the computing algorithm.</p>
* <p>
* The formula used assumes that the supplied mean value is the arithmetic
* mean of the sample data, not a known population parameter. This method
* is supplied only to save computation when the mean has already been
- * computed.
+ * computed.</p>
* <p>
- * Returns 0 for a single-value (i.e. length = 1) sample.
+ * Returns 0 for a single-value (i.e. length = 1) sample.</p>
* <p>
* Throws <code>IllegalArgumentException</code> if the array is null or the
- * array index parameters are not valid.
+ * array index parameters are not valid.</p>
*
* @param values the input array
* @param mean the precomputed mean value
@@ -373,16 +375,16 @@
* is empty.
* <p>
* See {@link org.apache.commons.math.stat.descriptive.moment.Variance} for
- * details on the computing algorithm.
+ * details on the computing algorithm.</p>
* <p>
* The formula used assumes that the supplied mean value is the arithmetic
* mean of the sample data, not a known population parameter. This method
* is supplied only to save computation when the mean has already been
- * computed.
+ * computed.</p>
* <p>
- * Returns 0 for a single-value (i.e. length = 1) sample.
+ * Returns 0 for a single-value (i.e. length = 1) sample.</p>
* <p>
- * Throws <code>IllegalArgumentException</code> if the array is null.
+ * Throws <code>IllegalArgumentException</code> if the array is null.</p>
*
* @param values the input array
* @param mean the precomputed mean value
@@ -397,14 +399,14 @@
* Returns the maximum of the entries in the input array, or
* <code>Double.NaN</code> if the array is empty.
* <p>
- * Throws <code>IllegalArgumentException</code> if the array is null.
+ * Throws <code>IllegalArgumentException</code> if the array is null.</p>
* <p>
* <ul>
* <li>The result is <code>NaN</code> iff all values are <code>NaN</code>
* (i.e. <code>NaN</code> values have no impact on the value of the statistic).</li>
* <li>If any of the values equals <code>Double.POSITIVE_INFINITY</code>,
* the result is <code>Double.POSITIVE_INFINITY.</code></li>
- * </ul>
+ * </ul></p>
*
* @param values the input array
* @return the maximum of the values or Double.NaN if the array is empty
@@ -420,14 +422,14 @@
* is empty.
* <p>
* Throws <code>IllegalArgumentException</code> if the array is null or
- * the array index parameters are not valid.
+ * the array index parameters are not valid.</p>
* <p>
* <ul>
* <li>The result is <code>NaN</code> iff all values are <code>NaN</code>
* (i.e. <code>NaN</code> values have no impact on the value of the statistic).</li>
* <li>If any of the values equals <code>Double.POSITIVE_INFINITY</code>,
* the result is <code>Double.POSITIVE_INFINITY.</code></li>
- * </ul>
+ * </ul></p>
*
* @param values the input array
* @param begin index of the first array element to include
@@ -445,14 +447,14 @@
* Returns the minimum of the entries in the input array, or
* <code>Double.NaN</code> if the array is empty.
* <p>
- * Throws <code>IllegalArgumentException</code> if the array is null.
+ * Throws <code>IllegalArgumentException</code> if the array is null.</p>
* <p>
* <ul>
* <li>The result is <code>NaN</code> iff all values are <code>NaN</code>
* (i.e. <code>NaN</code> values have no impact on the value of the statistic).</li>
* <li>If any of the values equals <code>Double.NEGATIVE_INFINITY</code>,
* the result is <code>Double.NEGATIVE_INFINITY.</code></li>
- * </ul>
+ * </ul> </p>
*
* @param values the input array
* @return the minimum of the values or Double.NaN if the array is empty
@@ -468,14 +470,14 @@
* is empty.
* <p>
* Throws <code>IllegalArgumentException</code> if the array is null or
- * the array index parameters are not valid.
+ * the array index parameters are not valid.</p>
* <p>
* <ul>
* <li>The result is <code>NaN</code> iff all values are <code>NaN</code>
* (i.e. <code>NaN</code> values have no impact on the value of the statistic).</li>
* <li>If any of the values equals <code>Double.NEGATIVE_INFINITY</code>,
* the result is <code>Double.NEGATIVE_INFINITY.</code></li>
- * </ul>
+ * </ul></p>
*
* @param values the input array
* @param begin index of the first array element to include
@@ -495,16 +497,16 @@
* <p>
* <ul>
* <li>Returns <code>Double.NaN</code> if <code>values</code> has length
- * <code>0</code></li>
+ * <code>0</code></li></p>
* <li>Returns (for any value of <code>p</code>) <code>values[0]</code>
* if <code>values</code> has length <code>1</code></li>
* <li>Throws <code>IllegalArgumentException</code> if <code>values</code>
* is null or p is not a valid quantile value (p must be greater than 0
* and less than or equal to 100)</li>
- * </ul>
+ * </ul></p>
* <p>
* See {@link org.apache.commons.math.stat.descriptive.rank.Percentile} for
- * a description of the percentile estimation algorithm used.
+ * a description of the percentile estimation algorithm used.</p>
*
* @param values input array of values
* @param p the percentile value to compute
@@ -530,10 +532,10 @@
* is null , <code>begin</code> or <code>length</code> is invalid, or
* <code>p</code> is not a valid quantile value (p must be greater than 0
* and less than or equal to 100)</li>
- * </ul>
+ * </ul></p>
* <p>
* See {@link org.apache.commons.math.stat.descriptive.rank.Percentile} for
- * a description of the percentile estimation algorithm used.
+ * a description of the percentile estimation algorithm used.</p>
*
* @param values array of input values
* @param p the percentile to compute
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/AbstractStorelessUnivariateStatistic.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/AbstractStorelessUnivariateStatistic.java?rev=617953&r1=617952&r2=617953&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/AbstractStorelessUnivariateStatistic.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/AbstractStorelessUnivariateStatistic.java Sat Feb 2 21:54:00 2008
@@ -24,9 +24,9 @@
* Abstract implementation of the {@link StorelessUnivariateStatistic} interface.
* <p>
* Provides default <code>evaluate()</code> and <code>incrementAll(double[])<code>
- * implementations.
+ * implementations.</p>
* <p>
- * <strong>Note that these implementations are not synchronized.</strong>
+ * <strong>Note that these implementations are not synchronized.</strong></p>
*
* @version $Revision$ $Date$
*/
@@ -44,13 +44,13 @@
* <p>
* Note that this implementation changes the internal state of the
* statistic. Its side effects are the same as invoking {@link #clear} and
- * then {@link #incrementAll(double[])}.
+ * then {@link #incrementAll(double[])}.</p>
* <p>
* Implementations may override this method with a more efficient and
* possibly more accurate implementation that works directly with the
- * input array.
+ * input array.</p>
* <p>
- * If the array is null, an IllegalArgumentException is thrown.
+ * If the array is null, an IllegalArgumentException is thrown.</p>
*
* @see org.apache.commons.math.stat.descriptive.UnivariateStatistic#evaluate(double[])
*/
@@ -68,14 +68,14 @@
* <p>
* Note that this implementation changes the internal state of the
* statistic. Its side effects are the same as invoking {@link #clear} and
- * then {@link #incrementAll(double[], int, int)}.
+ * then {@link #incrementAll(double[], int, int)}.</p>
* <p>
* Implementations may override this method with a more efficient and
* possibly more accurate implementation that works directly with the
- * input array.
+ * input array.</p>
* <p>
* If the array is null or the index parameters are not valid, an
- * IllegalArgumentException is thrown.
+ * IllegalArgumentException is thrown.</p>
*
* @see org.apache.commons.math.stat.descriptive.UnivariateStatistic#evaluate(double[], int, int)
*/
@@ -106,7 +106,7 @@
* This default implementation just calls {@link #increment} in a loop over
* the input array.
* <p>
- * Throws IllegalArgumentException if the input values array is null.
+ * Throws IllegalArgumentException if the input values array is null.</p>
*
* @param values values to add
* @throws IllegalArgumentException if values is null
@@ -123,7 +123,7 @@
* This default implementation just calls {@link #increment} in a loop over
* the specified portion of the input array.
* <p>
- * Throws IllegalArgumentException if the input values array is null.
+ * Throws IllegalArgumentException if the input values array is null.</p>
*
* @param values array holding values to add
* @param begin index of the first array element to add
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/AbstractUnivariateStatistic.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/AbstractUnivariateStatistic.java?rev=617953&r1=617952&r2=617953&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/AbstractUnivariateStatistic.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/AbstractUnivariateStatistic.java Sat Feb 2 21:54:00 2008
@@ -24,10 +24,10 @@
* <p>
* Provides a default implementation of <code>evaluate(double[]),</code>
* delegating to <code>evaluate(double[], int, int)</code> in the natural way.
+ * </p>
* <p>
* Also includes a <code>test</code> method that performs generic parameter
- * validation for the <code>evaluate</code> methods.
- * <p>
+ * validation for the <code>evaluate</code> methods.</p>
*
* @version $Revision$ $Date$
*/
@@ -61,7 +61,7 @@
* or the indices are invalid</li>
* <li>returns <code>false</li> if the array is non-null, but
* <code>length</code> is 0.
- * </ul>
+ * </ul></p>
*
* @param values the input array
* @param begin index of the first array element to include
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/DescriptiveStatistics.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/DescriptiveStatistics.java?rev=617953&r1=617952&r2=617953&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/DescriptiveStatistics.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/DescriptiveStatistics.java Sat Feb 2 21:54:00 2008
@@ -366,13 +366,13 @@
* <p>
* The implementation provided here follows the first estimation procedure presented
* <a href="http://www.itl.nist.gov/div898/handbook/prc/section2/prc252.htm">here.</a>
- * <p>
+ * </p><p>
* <strong>Preconditions</strong>:<ul>
* <li><code>0 < p < 100</code> (otherwise an
* <code>IllegalArgumentException</code> is thrown)</li>
* <li>at least one value must be stored (returns <code>Double.NaN
* </code> otherwise)</li>
- * </ul>
+ * </ul></p>
*
* @param p the requested percentile (scaled from 0 - 100)
* @return An estimate for the pth percentile of the stored data
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/StorelessUnivariateStatistic.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/StorelessUnivariateStatistic.java?rev=617953&r1=617952&r2=617953&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/StorelessUnivariateStatistic.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/StorelessUnivariateStatistic.java Sat Feb 2 21:54:00 2008
@@ -21,8 +21,9 @@
* {@link #increment} and {@link #incrementAll(double[])} methods for adding
* values and updating internal state.
* <p>
- * This interface is designed to be used for calculating statistics that can be computed in
- * one pass through the data without storing the full array of sample values.
+ * This interface is designed to be used for calculating statistics that can be
+ * computed in one pass through the data without storing the full array of
+ * sample values.</p>
*
* @version $Revision$ $Date$
*/
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/UnivariateStatistic.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/UnivariateStatistic.java?rev=617953&r1=617952&r2=617953&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/UnivariateStatistic.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/UnivariateStatistic.java Sat Feb 2 21:54:00 2008
@@ -23,7 +23,7 @@
* <p>
* Includes "stateless" <code>evaluate</code> methods that take
* <code>double[]</code> arrays as input and return the value of the statistic
- * applied to the input values.
+ * applied to the input values.</p>
*
* @version $Revision$ $Date$
*/
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/FirstMoment.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/FirstMoment.java?rev=617953&r1=617952&r2=617953&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/FirstMoment.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/FirstMoment.java Sat Feb 2 21:54:00 2008
@@ -23,25 +23,25 @@
/**
* Computes the first moment (arithmetic mean). Uses the definitional formula:
* <p>
- * mean = sum(x_i) / n
+ * mean = sum(x_i) / n </p>
* <p>
- * where <code>n</code> is the number of observations.
+ * where <code>n</code> is the number of observations. </p>
* <p>
* To limit numeric errors, the value of the statistic is computed using the
- * following recursive updating algorithm:
+ * following recursive updating algorithm: </p>
* <p>
* <ol>
* <li>Initialize <code>m = </code> the first value</li>
* <li>For each additional value, update using <br>
* <code>m = m + (new value - m) / (number of observations)</code></li>
- * </ol>
+ * </ol></p>
* <p>
- * Returns <code>Double.NaN</code> if the dataset is empty.
+ * Returns <code>Double.NaN</code> if the dataset is empty.</p>
* <p>
* <strong>Note that this implementation is not synchronized.</strong> If
* multiple threads access an instance of this class concurrently, and at least
* one of the threads invokes the <code>increment()</code> or
- * <code>clear()</code> method, it must be synchronized externally.
+ * <code>clear()</code> method, it must be synchronized externally.</p>
*
* @version $Revision$ $Date$
*/
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/FourthMoment.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/FourthMoment.java?rev=617953&r1=617952&r2=617953&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/FourthMoment.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/FourthMoment.java Sat Feb 2 21:54:00 2008
@@ -22,12 +22,12 @@
* Computes a statistic related to the Fourth Central Moment. Specifically,
* what is computed is the sum of
* <p>
- * (x_i - xbar) ^ 4,
+ * (x_i - xbar) ^ 4, </p>
* <p>
* where the x_i are the
- * sample observations and xbar is the sample mean.
+ * sample observations and xbar is the sample mean. </p>
* <p>
- * The following recursive updating formula is used:
+ * The following recursive updating formula is used: </p>
* <p>
* Let <ul>
* <li> dev = (current obs - previous mean) </li>
@@ -35,18 +35,18 @@
* <li> m2 = previous value of {@link ThirdMoment} </li>
* <li> n = number of observations (including current obs) </li>
* </ul>
- * Then
+ * Then </p>
* <p>
* new value = old value - 4 * (dev/n) * m3 + 6 * (dev/n)^2 * m2 + <br>
- * [n^2 - 3 * (n-1)] * dev^4 * (n-1) / n^3
+ * [n^2 - 3 * (n-1)] * dev^4 * (n-1) / n^3 </p>
* <p>
* Returns <code>Double.NaN</code> if no data values have been added and
- * returns <code>0</code> if there is just one value in the data set.
+ * returns <code>0</code> if there is just one value in the data set. </p>
* <p>
* <strong>Note that this implementation is not synchronized.</strong> If
* multiple threads access an instance of this class concurrently, and at least
* one of the threads invokes the <code>increment()</code> or
- * <code>clear()</code> method, it must be synchronized externally.
+ * <code>clear()</code> method, it must be synchronized externally. </p>
*
* @version $Revision$ $Date$
*/
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/GeometricMean.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/GeometricMean.java?rev=617953&r1=617952&r2=617953&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/GeometricMean.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/GeometricMean.java Sat Feb 2 21:54:00 2008
@@ -24,7 +24,7 @@
* geometric mean </a> of the available values.
* <p>
* Uses a {@link SumOfLogs} instance to compute sum of logs and returns
- * <code> exp( 1/n (sum of logs) ).</code> Therefore,
+ * <code> exp( 1/n (sum of logs) ).</code> Therefore, </p>
* <ul>
* <li>If any of values are < 0, the result is <code>NaN.</code></li>
* <li>If all values are non-negative and less than
@@ -33,12 +33,12 @@
* <li>If both <code>Double.POSITIVE_INFINITY</code> and
* <code>Double.NEGATIVE_INFINITY</code> are among the values, the result is
* <code>NaN.</code></li>
- * </ul>
+ * </ul> </p>
* <p>
* <strong>Note that this implementation is not synchronized.</strong> If
* multiple threads access an instance of this class concurrently, and at least
* one of the threads invokes the <code>increment()</code> or
- * <code>clear()</code> method, it must be synchronized externally.
+ * <code>clear()</code> method, it must be synchronized externally.</p>
*
*
* @version $Revision$ $Date$
@@ -87,9 +87,9 @@
* Returns the geometric mean of the entries in the specified portion
* of the input array.
* <p>
- * See {@link GeometricMean} for details on the computing algorithm.
+ * See {@link GeometricMean} for details on the computing algorithm.</p>
* <p>
- * Throws <code>IllegalArgumentException</code> if the array is null.
+ * Throws <code>IllegalArgumentException</code> if the array is null.</p>
*
* @param values input array containing the values
* @param begin first array element to include
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/Kurtosis.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/Kurtosis.java?rev=617953&r1=617952&r2=617953&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/Kurtosis.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/Kurtosis.java Sat Feb 2 21:54:00 2008
@@ -21,20 +21,20 @@
/**
* Computes the Kurtosis of the available values.
* <p>
- * We use the following (unbiased) formula to define kurtosis:
+ * We use the following (unbiased) formula to define kurtosis:</p>
* <p>
* kurtosis = { [n(n+1) / (n -1)(n - 2)(n-3)] sum[(x_i - mean)^4] / std^4 } - [3(n-1)^2 / (n-2)(n-3)]
- * <p>
+ * </p><p>
* where n is the number of values, mean is the {@link Mean} and std is the
- * {@link StandardDeviation}
+ * {@link StandardDeviation}</p>
* <p>
* Note that this statistic is undefined for n < 4. <code>Double.Nan</code>
- * is returned when there is not sufficient data to compute the statistic.
+ * is returned when there is not sufficient data to compute the statistic.</p>
* <p>
* <strong>Note that this implementation is not synchronized.</strong> If
* multiple threads access an instance of this class concurrently, and at least
* one of the threads invokes the <code>increment()</code> or
- * <code>clear()</code> method, it must be synchronized externally.
+ * <code>clear()</code> method, it must be synchronized externally.</p>
*
* @version $Revision$ $Date$
*/
@@ -50,7 +50,7 @@
* Determines whether or not this statistic can be incremented or cleared.
* <p>
* Statistics based on (constructed from) external moments cannot
- * be incremented or cleared.
+ * be incremented or cleared.</p>
*/
protected boolean incMoment;
@@ -129,9 +129,9 @@
* Returns the kurtosis of the entries in the specified portion of the
* input array.
* <p>
- * See {@link Kurtosis} for details on the computing algorithm.
+ * See {@link Kurtosis} for details on the computing algorithm.</p>
* <p>
- * Throws <code>IllegalArgumentException</code> if the array is null.
+ * Throws <code>IllegalArgumentException</code> if the array is null.</p>
*
* @param values the input array
* @param begin index of the first array element to include
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/Mean.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/Mean.java?rev=617953&r1=617952&r2=617953&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/Mean.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/Mean.java Sat Feb 2 21:54:00 2008
@@ -68,7 +68,7 @@
* Determines whether or not this statistic can be incremented or cleared.
* <p>
* Statistics based on (constructed from) external moments cannot
- * be incremented or cleared.
+ * be incremented or cleared.</p>
*/
protected boolean incMoment;
@@ -125,9 +125,9 @@
* the input array, or <code>Double.NaN</code> if the designated subarray
* is empty.
* <p>
- * Throws <code>IllegalArgumentException</code> if the array is null.
+ * Throws <code>IllegalArgumentException</code> if the array is null.</p>
* <p>
- * See {@link Mean} for details on the computing algorithm.
+ * See {@link Mean} for details on the computing algorithm.</p>
*
* @param values the input array
* @param begin index of the first array element to include
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/SecondMoment.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/SecondMoment.java?rev=617953&r1=617952&r2=617953&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/SecondMoment.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/SecondMoment.java Sat Feb 2 21:54:00 2008
@@ -22,23 +22,23 @@
* Computes a statistic related to the Second Central Moment. Specifically,
* what is computed is the sum of squared deviations from the sample mean.
* <p>
- * The following recursive updating formula is used:
+ * The following recursive updating formula is used:</p>
* <p>
* Let <ul>
* <li> dev = (current obs - previous mean) </li>
* <li> n = number of observations (including current obs) </li>
* </ul>
- * Then
+ * Then</p>
* <p>
- * new value = old value + dev^2 * (n -1) / n.
+ * new value = old value + dev^2 * (n -1) / n.</p>
* <p>
* Returns <code>Double.NaN</code> if no data values have been added and
- * returns <code>0</code> if there is just one value in the data set.
+ * returns <code>0</code> if there is just one value in the data set.</p>
* <p>
* <strong>Note that this implementation is not synchronized.</strong> If
* multiple threads access an instance of this class concurrently, and at least
* one of the threads invokes the <code>increment()</code> or
- * <code>clear()</code> method, it must be synchronized externally.
+ * <code>clear()</code> method, it must be synchronized externally.</p>
*
* @version $Revision$ $Date$
*/
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/Skewness.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/Skewness.java?rev=617953&r1=617952&r2=617953&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/Skewness.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/Skewness.java Sat Feb 2 21:54:00 2008
@@ -23,17 +23,17 @@
/**
* Computes the skewness of the available values.
* <p>
- * We use the following (unbiased) formula to define skewness:
+ * We use the following (unbiased) formula to define skewness:</p>
* <p>
- * skewness = [n / (n -1) (n - 2)] sum[(x_i - mean)^3] / std^3
+ * skewness = [n / (n -1) (n - 2)] sum[(x_i - mean)^3] / std^3 </p>
* <p>
* where n is the number of values, mean is the {@link Mean} and std is the
- * {@link StandardDeviation}
+ * {@link StandardDeviation} </p>
* <p>
* <strong>Note that this implementation is not synchronized.</strong> If
* multiple threads access an instance of this class concurrently, and at least
* one of the threads invokes the <code>increment()</code> or
- * <code>clear()</code> method, it must be synchronized externally.
+ * <code>clear()</code> method, it must be synchronized externally. </p>
*
* @version $Revision$ $Date$
*/
@@ -49,7 +49,7 @@
* Determines whether or not this statistic can be incremented or cleared.
* <p>
* Statistics based on (constructed from) external moments cannot
- * be incremented or cleared.
+ * be incremented or cleared.</p>
*/
protected boolean incMoment;
@@ -82,7 +82,7 @@
/**
* Returns the value of the statistic based on the values that have been added.
* <p>
- * See {@link Skewness} for the definition used in the computation.
+ * See {@link Skewness} for the definition used in the computation.</p>
*
* @return the skewness of the available values.
*/
@@ -121,9 +121,9 @@
* Returns the Skewness of the entries in the specifed portion of the
* input array.
* <p>
- * See {@link Skewness} for the definition used in the computation.
+ * See {@link Skewness} for the definition used in the computation.</p>
* <p>
- * Throws <code>IllegalArgumentException</code> if the array is null.
+ * Throws <code>IllegalArgumentException</code> if the array is null.</p>
*
* @param values the input array
* @param begin the index of the first array element to include
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/StandardDeviation.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/StandardDeviation.java?rev=617953&r1=617952&r2=617953&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/StandardDeviation.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/moment/StandardDeviation.java Sat Feb 2 21:54:00 2008
@@ -33,7 +33,7 @@
* <strong>Note that this implementation is not synchronized.</strong> If
* multiple threads access an instance of this class concurrently, and at least
* one of the threads invokes the <code>increment()</code> or
- * <code>clear()</code> method, it must be synchronized externally.
+ * <code>clear()</code> method, it must be synchronized externally.</p>
*
* @version $Revision$ $Date$
*/
@@ -124,11 +124,11 @@
* Returns the Standard Deviation of the entries in the input array, or
* <code>Double.NaN</code> if the array is empty.
* <p>
- * Returns 0 for a single-value (i.e. length = 1) sample.
+ * Returns 0 for a single-value (i.e. length = 1) sample.</p>
* <p>
- * Throws <code>IllegalArgumentException</code> if the array is null.
+ * Throws <code>IllegalArgumentException</code> if the array is null.</p>
* <p>
- * Does not change the internal state of the statistic.
+ * Does not change the internal state of the statistic.</p>
*
* @param values the input array
* @return the standard deviation of the values or Double.NaN if length = 0
@@ -143,11 +143,11 @@
* the input array, or <code>Double.NaN</code> if the designated subarray
* is empty.
* <p>
- * Returns 0 for a single-value (i.e. length = 1) sample.
+ * Returns 0 for a single-value (i.e. length = 1) sample. </p>
* <p>
- * Throws <code>IllegalArgumentException</code> if the array is null.
+ * Throws <code>IllegalArgumentException</code> if the array is null.</p>
* <p>
- * Does not change the internal state of the statistic.
+ * Does not change the internal state of the statistic.</p>
*
* @param values the input array
* @param begin index of the first array element to include
@@ -165,16 +165,16 @@
* the input array, using the precomputed mean value. Returns
* <code>Double.NaN</code> if the designated subarray is empty.
* <p>
- * Returns 0 for a single-value (i.e. length = 1) sample.
+ * Returns 0 for a single-value (i.e. length = 1) sample.</p>
* <p>
* The formula used assumes that the supplied mean value is the arithmetic
* mean of the sample data, not a known population parameter. This method
* is supplied only to save computation when the mean has already been
- * computed.
+ * computed.</p>
* <p>
- * Throws <code>IllegalArgumentException</code> if the array is null.
+ * Throws <code>IllegalArgumentException</code> if the array is null.</p>
* <p>
- * Does not change the internal state of the statistic.
+ * Does not change the internal state of the statistic.</p>
*
* @param values the input array
* @param mean the precomputed mean value
@@ -194,16 +194,16 @@
* the precomputed mean value. Returns
* <code>Double.NaN</code> if the designated subarray is empty.
* <p>
- * Returns 0 for a single-value (i.e. length = 1) sample.
+ * Returns 0 for a single-value (i.e. length = 1) sample.</p>
* <p>
* The formula used assumes that the supplied mean value is the arithmetic
* mean of the sample data, not a known population parameter. This method
* is supplied only to save computation when the mean has already been
- * computed.
+ * computed.</p>
* <p>
- * Throws <code>IllegalArgumentException</code> if the array is null.
+ * Throws <code>IllegalArgumentException</code> if the array is null.</p>
* <p>
- * Does not change the internal state of the statistic.
+ * Does not change the internal state of the statistic.</p>
*
* @param values the input array
* @param mean the precomputed mean value