Apache
/
commons-math
mirror of https://github.com/apache/commons-math.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[MATH-1055] Fixed some invalid links inside javadoc and added missing deprecated annotations, thanks to Sean Owen. 

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/math/trunk@1538354 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Thomas Neidhart 2013-11-03 12:48:40 +00:00
parent ac8a587829
commit 534dd69069
12 changed files with 25 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/changes/changes.xml
View File

@ -51,6 +51,9 @@ If the output is not quite correct, check for invisible trailing spaces!
</properties>
<body>
<release version="3.3" date="TBD" description="TBD">
<action dev="tn" type="fix" issue="MATH-1055" due-to="Sean Owen">
Fixed some invalid links inside javadoc and added missing deprecated annotations.
</action>
<action dev="tn" type="add" issue="MATH-983">
Added a graphical overview of available continuous distributions to the userguide.
</action>

2
src/main/java/org/apache/commons/math3/fitting/HarmonicFitter.java
View File

@ -260,7 +260,7 @@ public class HarmonicFitter extends CurveFitter<HarmonicOscillator.Parametric> {
/**
* Estimate a first guess of the amplitude and angular frequency.
* This method assumes that the {@link #sortObservations()} method
* This method assumes that the {@link #sortObservations(WeightedObservedPoint[])} method
* has been called previously.
*
* @param observations Observations, sorted w.r.t. abscissa.

1
src/main/java/org/apache/commons/math3/ode/JacobianMatrices.java
View File

@ -429,7 +429,6 @@ public class JacobianMatrices {
/** Wrap a {@link FirstOrderDifferentialEquations} into a {@link MainStateJacobianProvider}.
* @param ode original ODE problem, without jacobians computation skill
* @param hY step sizes to compute the jacobian df/dy
* @see JacobianMatrices#setMainStateSteps(double[])
* @exception DimensionMismatchException if there is a dimension mismatch between
* the steps array {@code hY} and the equation dimension
*/

2
src/main/java/org/apache/commons/math3/optimization/fitting/HarmonicFitter.java
View File

@ -260,7 +260,7 @@ public class HarmonicFitter extends CurveFitter<HarmonicOscillator.Parametric> {
/**
* Estimate a first guess of the amplitude and angular frequency.
* This method assumes that the {@link #sortObservations()} method
* This method assumes that the {@link #sortObservations(WeightedObservedPoint[])} method
* has been called previously.
*
* @param observations Observations, sorted w.r.t. abscissa.

6
src/main/java/org/apache/commons/math3/special/Beta.java
View File

@ -257,7 +257,7 @@ public class Beta {
/**
* Returns the value of log Γ(a + b) for 1 ≤ a, b ≤ 2. Based on the
* <em>NSWC Library of Mathematics Subroutines</em> double precision
* implementation, {@code DGSMLN}. In {@link BetaTest#testLogGammaSum()},
* implementation, {@code DGSMLN}. In {@code BetaTest.testLogGammaSum()},
* this private method is accessed through reflection.
*
* @param a First argument.
@ -290,7 +290,7 @@ public class Beta {
* Returns the value of log[Γ(b) / Γ(a + b)] for a ≥ 0 and b ≥ 10. Based on
* the <em>NSWC Library of Mathematics Subroutines</em> double precision
* implementation, {@code DLGDIV}. In
* {@link BetaTest#testLogGammaMinusLogGammaSum()}, this private method is
* {@code BetaTest.testLogGammaMinusLogGammaSum()}, this private method is
* accessed through reflection.
*
* @param a First argument.
@ -377,7 +377,7 @@ public class Beta {
* Returns the value of Δ(p) + Δ(q) - Δ(p + q), with p, q ≥ 10. Based on
* the <em>NSWC Library of Mathematics Subroutines</em> double precision
* implementation, {@code DBCORR}. In
* {@link BetaTest#testSumDeltaMinusDeltaSum()}, this private method is
* {@code BetaTest.testSumDeltaMinusDeltaSum()}, this private method is
* accessed through reflection.
*
* @param p First argument.

8
src/main/java/org/apache/commons/math3/stat/descriptive/AbstractUnivariateStatistic.java
View File

@ -151,7 +151,7 @@ public abstract class AbstractUnivariateStatistic
* @param length the number of elements to include
* @return true if the parameters are valid and designate a subarray of positive length
* @throws MathIllegalArgumentException if the indices are invalid or the array is null
* @deprecated 3.3 Use {@link MathArrays#test(double[], int, int)} instead
* @deprecated 3.3 Use {@link MathArrays#verifyValues(double[], int, int)} instead
*/
@Deprecated
protected boolean test(
@ -181,7 +181,7 @@ public abstract class AbstractUnivariateStatistic
* @return true if the parameters are valid
* @throws MathIllegalArgumentException if the indices are invalid or the array is null
* @since 3.0
* @deprecated 3.3 Use {@link MathArrays#test(double[], int, int, boolean)} instead
* @deprecated 3.3 Use {@link MathArrays#verifyValues(double[], int, int, boolean)} instead
*/
@Deprecated
protected boolean test(final double[] values, final int begin,
@ -217,7 +217,7 @@ public abstract class AbstractUnivariateStatistic
* @return true if the parameters are valid and designate a subarray of positive length
* @throws MathIllegalArgumentException if the indices are invalid or the array is null
* @since 2.1
* @deprecated 3.3 Use {@link MathArrays#test(double[], double[], int, int)} instead
* @deprecated 3.3 Use {@link MathArrays#verifyValues(double[], double[], int, int)} instead
*/
@Deprecated
protected boolean test(
@ -260,7 +260,7 @@ public abstract class AbstractUnivariateStatistic
* the weights array contains NaN, infinite or negative elements, or there
* are no positive weights.
* @since 3.0
* @deprecated 3.3 Use {@link MathArrays#test(double[], double[], int, int, boolean)} instead
* @deprecated 3.3 Use {@link MathArrays#verifyValues(double[], double[], int, int, boolean)} instead
*/
@Deprecated
protected boolean test(final double[] values, final double[] weights,

7
src/main/java/org/apache/commons/math3/util/ArithmeticUtils.java
View File

@ -96,6 +96,7 @@ public final class ArithmeticUtils {
* represented by a long integer.
* @deprecated use {@link CombinatoricsUtils#binomialCoefficient(int, int)}
*/
@Deprecated
public static long binomialCoefficient(final int n, final int k)
throws NotPositiveException, NumberIsTooLargeException, MathArithmeticException {
return CombinatoricsUtils.binomialCoefficient(n, k);
@ -127,6 +128,7 @@ public final class ArithmeticUtils {
* represented by a long integer.
* @deprecated use {@link CombinatoricsUtils#binomialCoefficientDouble(int, int)}
*/
@Deprecated
public static double binomialCoefficientDouble(final int n, final int k)
throws NotPositiveException, NumberIsTooLargeException, MathArithmeticException {
return CombinatoricsUtils.binomialCoefficientDouble(n, k);
@ -154,6 +156,7 @@ public final class ArithmeticUtils {
* represented by a long integer.
* @deprecated use {@link CombinatoricsUtils#binomialCoefficientLog(int, int)}
*/
@Deprecated
public static double binomialCoefficientLog(final int n, final int k)
throws NotPositiveException, NumberIsTooLargeException, MathArithmeticException {
return CombinatoricsUtils.binomialCoefficientLog(n, k);
@ -184,6 +187,7 @@ public final class ArithmeticUtils {
* large to fit in a {@code long}.
* @deprecated use {@link CombinatoricsUtils#factorial(int)}
*/
@Deprecated
public static long factorial(final int n) throws NotPositiveException, MathArithmeticException {
return CombinatoricsUtils.factorial(n);
}
@ -202,6 +206,7 @@ public final class ArithmeticUtils {
* @throws NotPositiveException if {@code n < 0}.
* @deprecated use {@link CombinatoricsUtils#factorialDouble(int)}
*/
@Deprecated
public static double factorialDouble(final int n) throws NotPositiveException {
return CombinatoricsUtils.factorialDouble(n);
}
@ -214,6 +219,7 @@ public final class ArithmeticUtils {
* @throws NotPositiveException if {@code n < 0}.
* @deprecated use {@link CombinatoricsUtils#factorialLog(int)}
*/
@Deprecated
public static double factorialLog(final int n) throws NotPositiveException {
return CombinatoricsUtils.factorialLog(n);
}
@ -864,6 +870,7 @@ public final class ArithmeticUtils {
* @since 3.1
* @deprecated use {@link CombinatoricsUtils#stirlingS2(int, int)}
*/
@Deprecated
public static long stirlingS2(final int n, final int k)
throws NotPositiveException, NumberIsTooLargeException, MathArithmeticException {
return CombinatoricsUtils.stirlingS2(n, k);

2
src/main/java/org/apache/commons/math3/util/Combinations.java
View File

@ -322,7 +322,7 @@ public class Combinations implements Iterable<int[]> {
/**
* Defines the lexicographic ordering of combinations, using
* the {@link #lexNorm(int[],int)} method.
* the {@link #lexNorm(int[])} method.
*/
private static class LexicographicComparator
implements Comparator<int[]>, Serializable {

2
src/test/java/org/apache/commons/math3/analysis/integration/MidPointIntegratorTest.java
View File

@ -31,7 +31,7 @@ import org.junit.Test;
* Test runs show that for a default relative accuracy of 1E-6, it generally
* takes 10 to 15 iterations for the integral to converge.
*
* @version $Id: MidPointIntegratorTest.java 1374632 2012-08-18 18:11:11Z luc $
* @version $Id$
*/
public final class MidPointIntegratorTest {

2
src/test/java/org/apache/commons/math3/special/BetaTest.java
View File

@ -170,7 +170,7 @@ public class BetaTest {
}
/**
* Reference data for the {@link Gamma#logGammaSum(double, double)}
* Reference data for the {@link #logGammaSum(double, double)}
* function. This data was generated with the following
* <a href="http://maxima.sourceforge.net/">Maxima</a> script.
*

2
src/test/java/org/apache/commons/math3/stat/CertifiedDataTest.java
View File

@ -96,8 +96,6 @@ public class CertifiedDataTest {
/**
* loads a DescriptiveStatistics off of a test file
* @param file
* @param statistical summary
*/
private void loadStats(String resource, Object u) throws Exception {

12
src/test/java/org/apache/commons/math3/transform/RealTransformerAbstractTest.java
View File

@ -99,9 +99,7 @@ public abstract class RealTransformerAbstractTest {
/**
* Returns a function for the accuracy check of
* {@link RealTransformer#transform(UnivariateFunction, double, double, int)}
* and
* {@link RealTransformer#inverseTransform(UnivariateFunction, double, double, int)}.
* {@link RealTransformer#transform(UnivariateFunction, double, double, int, TransformType)}.
* This function should be valid. In other words, none of the above methods
* should throw an exception when passed this function.
*
@ -111,9 +109,7 @@ public abstract class RealTransformerAbstractTest {
/**
* Returns a sampling lower bound for the accuracy check of
* {@link RealTransformer#transform(UnivariateFunction, double, double, int)}
* and
* {@link RealTransformer#inverseTransform(UnivariateFunction, double, double, int)}.
* {@link RealTransformer#transform(UnivariateFunction, double, double, int, TransformType)}.
* This lower bound should be valid. In other words, none of the above
* methods should throw an exception when passed this bound.
*
@ -123,9 +119,7 @@ public abstract class RealTransformerAbstractTest {
/**
* Returns a sampling upper bound for the accuracy check of
* {@link RealTransformer#transform(UnivariateFunction, double, double, int)}
* and
* {@link RealTransformer#inverseTransform(UnivariateFunction, double, double, int)}.
* {@link RealTransformer#transform(UnivariateFunction, double, double, int, TransformType)}.
* This upper bound should be valid. In other words, none of the above
* methods should throw an exception when passed this bound.
*