From a11930a607333a146d58d93865e1e36c3f9aa07d Mon Sep 17 00:00:00 2001 From: Luc Maisonobe Date: Fri, 23 Jan 2009 19:34:32 +0000 Subject: [PATCH] various javadoc fixes git-svn-id: https://svn.apache.org/repos/asf/commons/proper/math/trunk@737161 13f79535-47bb-0310-9956-ffa450edef68 --- .../commons/math/analysis/solvers/MullerSolver.java | 2 +- .../math/analysis/solvers/UnivariateRealSolver.java | 4 ++-- .../apache/commons/math/linear/EigenDecomposition.java | 3 ++- .../commons/math/linear/EigenDecompositionImpl.java | 9 +-------- .../org/apache/commons/math/linear/LUDecomposition.java | 2 +- .../apache/commons/math/linear/QRDecompositionImpl.java | 2 -- .../math/linear/SingularValueDecompositionImpl.java | 2 -- src/java/org/apache/commons/math/ode/ODEIntegrator.java | 4 ++-- .../math/ode/nonstiff/AdamsBashforthIntegrator.java | 1 - .../math/ode/nonstiff/AdamsMoultonIntegrator.java | 1 - .../commons/math/ode/nonstiff/MultistepIntegrator.java | 1 - .../stat/regression/OLSMultipleLinearRegression.java | 6 +++++- 12 files changed, 14 insertions(+), 23 deletions(-) diff --git a/src/java/org/apache/commons/math/analysis/solvers/MullerSolver.java b/src/java/org/apache/commons/math/analysis/solvers/MullerSolver.java index 354e0dfe3..0b94b7bb0 100644 --- a/src/java/org/apache/commons/math/analysis/solvers/MullerSolver.java +++ b/src/java/org/apache/commons/math/analysis/solvers/MullerSolver.java @@ -240,7 +240,7 @@ public class MullerSolver extends UnivariateRealSolverImpl { * @throws FunctionEvaluationException if an error occurs evaluating the * function * @throws IllegalArgumentException if any parameters are invalid - * @deprecated replaced by {@link #solve2(UnivariateRealFunction, double, double) + * @deprecated replaced by {@link #solve2(UnivariateRealFunction, double, double)} * since 2.0 */ @Deprecated diff --git a/src/java/org/apache/commons/math/analysis/solvers/UnivariateRealSolver.java b/src/java/org/apache/commons/math/analysis/solvers/UnivariateRealSolver.java index bbb52f093..cea586c08 100644 --- a/src/java/org/apache/commons/math/analysis/solvers/UnivariateRealSolver.java +++ b/src/java/org/apache/commons/math/analysis/solvers/UnivariateRealSolver.java @@ -71,7 +71,7 @@ public interface UnivariateRealSolver extends ConvergingAlgorithm { * function * @throws IllegalArgumentException if min > max or the endpoints do not * satisfy the requirements specified by the solver - * @deprecated replaced by {@link #solve(UnivariateRealFunction, double, double) + * @deprecated replaced by {@link #solve(UnivariateRealFunction, double, double)} * since 2.0 */ @Deprecated @@ -112,7 +112,7 @@ public interface UnivariateRealSolver extends ConvergingAlgorithm { * function * @throws IllegalArgumentException if min > max or the arguments do not * satisfy the requirements specified by the solver - * @deprecated replaced by {@link #solve(UnivariateRealFunction, double, double, double) + * @deprecated replaced by {@link #solve(UnivariateRealFunction, double, double, double)} * since 2.0 */ @Deprecated diff --git a/src/java/org/apache/commons/math/linear/EigenDecomposition.java b/src/java/org/apache/commons/math/linear/EigenDecomposition.java index 771b52978..9368b879d 100644 --- a/src/java/org/apache/commons/math/linear/EigenDecomposition.java +++ b/src/java/org/apache/commons/math/linear/EigenDecomposition.java @@ -58,7 +58,8 @@ public interface EigenDecomposition extends Serializable { *

Real eigenvalues are on the diagonal while complex values are on * 2x2 blocks { {real +imaginary}, {-imaginary, real} }.

* @return the D matrix - * @see #getEigenValues() + * @see #getRealEigenvalues() + * @see #getImagEigenvalues() */ RealMatrix getD(); diff --git a/src/java/org/apache/commons/math/linear/EigenDecompositionImpl.java b/src/java/org/apache/commons/math/linear/EigenDecompositionImpl.java index 37498b09c..91b2105b3 100644 --- a/src/java/org/apache/commons/math/linear/EigenDecompositionImpl.java +++ b/src/java/org/apache/commons/math/linear/EigenDecompositionImpl.java @@ -38,9 +38,7 @@ import org.apache.commons.math.util.MathUtils; * the upper part of the matrix, the part below the diagonal is not accessed at all.

*

Eigenvalues are computed as soon as the matrix is decomposed, but eigenvectors * are computed only when required, i.e. only when one of the {@link #getEigenvector(int)}, - * {@link #getV()}, {@link #getVT()}, {@link #getInverse()}, {@link #solve(double[])}, - * {@link #solve(RealMatrix)}, {@link #solve(RealVector)} or {@link #solve(RealVectorImpl)} - * methods is called.

+ * {@link #getV()}, {@link #getVT()}, {@link #getSolver()} methods is called.

*

This implementation is based on Inderjit Singh Dhillon thesis * A * New O(n2) Algorithm for the Symmetric Tridiagonal Eigenvalue/Eigenvector @@ -156,8 +154,6 @@ public class EigenDecompositionImpl implements EigenDecomposition { /** * Calculates the eigen decomposition of the given symmetric matrix. - *

Calling this constructor is equivalent to first call the no-arguments - * constructor and then call {@link #decompose(RealMatrix)}.

* @param matrix The symmetric matrix to decompose. * @param splitTolerance tolerance on the off-diagonal elements relative to the * geometric mean to split the tridiagonal matrix (a suggested value is @@ -182,8 +178,6 @@ public class EigenDecompositionImpl implements EigenDecomposition { /** * Calculates the eigen decomposition of the given tridiagonal symmetric matrix. - *

Calling this constructor is equivalent to first call the no-arguments - * constructor and then call {@link #decompose(double[], double[])}.

* @param main the main diagonal of the matrix (will be copied) * @param secondary the secondary diagonal of the matrix (will be copied) * @param splitTolerance tolerance on the off-diagonal elements relative to the @@ -348,7 +342,6 @@ public class EigenDecompositionImpl implements EigenDecomposition { /** * Return the determinant of the matrix * @return determinant of the matrix - * @see #isNonSingular() */ public double getDeterminant() { double determinant = 1; diff --git a/src/java/org/apache/commons/math/linear/LUDecomposition.java b/src/java/org/apache/commons/math/linear/LUDecomposition.java index da6133325..b59155a91 100644 --- a/src/java/org/apache/commons/math/linear/LUDecomposition.java +++ b/src/java/org/apache/commons/math/linear/LUDecomposition.java @@ -74,7 +74,7 @@ public interface LUDecomposition extends Serializable { /** * Returns the pivot permutation vector. * @return the pivot permutation vector - * @see #getPermutation() + * @see #getP() */ int[] getPivot(); diff --git a/src/java/org/apache/commons/math/linear/QRDecompositionImpl.java b/src/java/org/apache/commons/math/linear/QRDecompositionImpl.java index b209117e7..45acea9ef 100644 --- a/src/java/org/apache/commons/math/linear/QRDecompositionImpl.java +++ b/src/java/org/apache/commons/math/linear/QRDecompositionImpl.java @@ -68,8 +68,6 @@ public class QRDecompositionImpl implements QRDecomposition { /** * Calculates the QR-decomposition of the given matrix. - *

Calling this constructor is equivalent to first call the no-arguments - * constructor and then call {@link #decompose(RealMatrix)}.

* @param matrix The matrix to decompose. */ public QRDecompositionImpl(RealMatrix matrix) { diff --git a/src/java/org/apache/commons/math/linear/SingularValueDecompositionImpl.java b/src/java/org/apache/commons/math/linear/SingularValueDecompositionImpl.java index 1fa79d002..2c361b5e0 100644 --- a/src/java/org/apache/commons/math/linear/SingularValueDecompositionImpl.java +++ b/src/java/org/apache/commons/math/linear/SingularValueDecompositionImpl.java @@ -80,8 +80,6 @@ public class SingularValueDecompositionImpl implements SingularValueDecompositio /** * Calculates the Singular Value Decomposition of the given matrix. - *

Calling this constructor is equivalent to first call the no-arguments - * constructor and then call {@link #decompose(RealMatrix)}.

* @param matrix The matrix to decompose. * @exception InvalidMatrixException (wrapping a {@link ConvergenceException} * if algorithm fails to converge diff --git a/src/java/org/apache/commons/math/ode/ODEIntegrator.java b/src/java/org/apache/commons/math/ode/ODEIntegrator.java index a1fe60d5a..d519eed1e 100644 --- a/src/java/org/apache/commons/math/ode/ODEIntegrator.java +++ b/src/java/org/apache/commons/math/ode/ODEIntegrator.java @@ -98,7 +98,7 @@ public interface ODEIntegrator extends Serializable { * differential equations} problem) if the value of the current step that * is attempted is needed.

*

The result is undefined if the method is called outside of - * calls to {@link #integrate}

+ * calls to integrate.

* @return current value of the step start time ti */ double getCurrentStepStart(); @@ -109,7 +109,7 @@ public interface ODEIntegrator extends Serializable { * differential equations} problem) if the signed value of the current stepsize * that is tried is needed.

*

The result is undefined if the method is called outside of - * calls to {@link #integrate}

+ * calls to integrate.

* @return current signed value of the stepsize */ double getCurrentSignedStepsize(); diff --git a/src/java/org/apache/commons/math/ode/nonstiff/AdamsBashforthIntegrator.java b/src/java/org/apache/commons/math/ode/nonstiff/AdamsBashforthIntegrator.java index f27f61822..93a0854b9 100644 --- a/src/java/org/apache/commons/math/ode/nonstiff/AdamsBashforthIntegrator.java +++ b/src/java/org/apache/commons/math/ode/nonstiff/AdamsBashforthIntegrator.java @@ -52,7 +52,6 @@ import org.apache.commons.math.ode.sampling.StepHandler; * provided by the {@link AdamsMoultonIntegrator AdamsMoultonIntegrator} class.

* * @see AdamsMoultonIntegrator - * @see BDFIntegrator * @version $Revision$ $Date$ * @since 2.0 */ diff --git a/src/java/org/apache/commons/math/ode/nonstiff/AdamsMoultonIntegrator.java b/src/java/org/apache/commons/math/ode/nonstiff/AdamsMoultonIntegrator.java index b01582827..84fc405dc 100644 --- a/src/java/org/apache/commons/math/ode/nonstiff/AdamsMoultonIntegrator.java +++ b/src/java/org/apache/commons/math/ode/nonstiff/AdamsMoultonIntegrator.java @@ -52,7 +52,6 @@ import org.apache.commons.math.ode.sampling.StepHandler; * provided by the {@link AdamsBashforthIntegrator AdamsBashforthIntegrator} class.

* * @see AdamsBashforthIntegrator - * @see BDFIntegrator * @version $Revision$ $Date$ * @since 2.0 */ diff --git a/src/java/org/apache/commons/math/ode/nonstiff/MultistepIntegrator.java b/src/java/org/apache/commons/math/ode/nonstiff/MultistepIntegrator.java index 0688215f8..f9dc879f8 100644 --- a/src/java/org/apache/commons/math/ode/nonstiff/MultistepIntegrator.java +++ b/src/java/org/apache/commons/math/ode/nonstiff/MultistepIntegrator.java @@ -40,7 +40,6 @@ import org.apache.commons.math.ode.sampling.StepNormalizer; * * @see AdamsBashforthIntegrator * @see AdamsMoultonIntegrator - * @see BDFIntegrator * @version $Revision$ $Date$ * @since 2.0 */ diff --git a/src/java/org/apache/commons/math/stat/regression/OLSMultipleLinearRegression.java b/src/java/org/apache/commons/math/stat/regression/OLSMultipleLinearRegression.java index bd34eed07..3dbdd244f 100644 --- a/src/java/org/apache/commons/math/stat/regression/OLSMultipleLinearRegression.java +++ b/src/java/org/apache/commons/math/stat/regression/OLSMultipleLinearRegression.java @@ -59,9 +59,13 @@ public class OLSMultipleLinearRegression extends AbstractMultipleLinearRegressio private QRDecomposition qr = null; /** - * {@inheritDoc} + * Loads model x and y sample data, overriding any previous sample. * * Computes and caches QR decomposition of the X matrix. + * @param y the [n,1] array representing the y sample + * @param x the [n,k] array representing the x sample + * @throws IllegalArgumentException if the x and y array data are not + * compatible for the regression */ public void newSampleData(double[] y, double[][] x) { validateSampleData(x, y);