svn commit: r737161 - in /commons/proper/math/trunk/src/java/org/apache/commons/math: analysis/solvers/ linear/ ode/ ode/nonstiff/ stat/regression/

[lu...@apache.org]

Author: luc
Date: Fri Jan 23 11:34:32 2009
New Revision: 737161

URL: http://svn.apache.org/viewvc?rev=737161&view=rev
Log:
various javadoc fixes

Modified:
    commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/solvers/MullerSolver.java
    commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/solvers/UnivariateRealSolver.java
    commons/proper/math/trunk/src/java/org/apache/commons/math/linear/EigenDecomposition.java
    commons/proper/math/trunk/src/java/org/apache/commons/math/linear/EigenDecompositionImpl.java
    commons/proper/math/trunk/src/java/org/apache/commons/math/linear/LUDecomposition.java
    commons/proper/math/trunk/src/java/org/apache/commons/math/linear/QRDecompositionImpl.java
    commons/proper/math/trunk/src/java/org/apache/commons/math/linear/SingularValueDecompositionImpl.java
    commons/proper/math/trunk/src/java/org/apache/commons/math/ode/ODEIntegrator.java
    commons/proper/math/trunk/src/java/org/apache/commons/math/ode/nonstiff/AdamsBashforthIntegrator.java
    commons/proper/math/trunk/src/java/org/apache/commons/math/ode/nonstiff/AdamsMoultonIntegrator.java
    commons/proper/math/trunk/src/java/org/apache/commons/math/ode/nonstiff/MultistepIntegrator.java
    commons/proper/math/trunk/src/java/org/apache/commons/math/stat/regression/OLSMultipleLinearRegression.java

Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/solvers/MullerSolver.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/solvers/MullerSolver.java?rev=737161&r1=737160&r2=737161&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/solvers/MullerSolver.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/solvers/MullerSolver.java Fri Jan 23 11:34:32 2009
@@ -240,7 +240,7 @@
      * @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

Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/solvers/UnivariateRealSolver.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/solvers/UnivariateRealSolver.java?rev=737161&r1=737160&r2=737161&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/solvers/UnivariateRealSolver.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/solvers/UnivariateRealSolver.java Fri Jan 23 11:34:32 2009
@@ -71,7 +71,7 @@
      * 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 @@
      * 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

Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/linear/EigenDecomposition.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/linear/EigenDecomposition.java?rev=737161&r1=737160&r2=737161&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/linear/EigenDecomposition.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/linear/EigenDecomposition.java Fri Jan 23 11:34:32 2009
@@ -58,7 +58,8 @@
      * <p>Real eigenvalues are on the diagonal while complex values are on
      * 2x2 blocks { {real +imaginary}, {-imaginary, real} }.</p>
      * @return the D matrix
-     * @see #getEigenValues()
+     * @see #getRealEigenvalues()
+     * @see #getImagEigenvalues()
      */
     RealMatrix getD();
 

Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/linear/EigenDecompositionImpl.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/linear/EigenDecompositionImpl.java?rev=737161&r1=737160&r2=737161&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/linear/EigenDecompositionImpl.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/linear/EigenDecompositionImpl.java Fri Jan 23 11:34:32 2009
@@ -38,9 +38,7 @@
  * the upper part of the matrix, the part below the diagonal is not accessed at all.</p>
  * <p>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.</p>
+ * {@link #getV()}, {@link #getVT()}, {@link #getSolver()} methods is called.</p>
  * <p>This implementation is based on Inderjit Singh Dhillon thesis
  * <a href="http://www.cs.utexas.edu/users/inderjit/public_papers/thesis.pdf">A
  * New O(n<sup>2</sup>) Algorithm for the Symmetric Tridiagonal Eigenvalue/Eigenvector
@@ -156,8 +154,6 @@
 
     /**
      * Calculates the eigen decomposition of the given symmetric matrix. 
-     * <p>Calling this constructor is equivalent to first call the no-arguments
-     * constructor and then call {@link #decompose(RealMatrix)}.</p>
      * @param matrix The <strong>symmetric</strong> 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 @@
 
     /**
      * Calculates the eigen decomposition of the given tridiagonal symmetric matrix. 
-     * <p>Calling this constructor is equivalent to first call the no-arguments
-     * constructor and then call {@link #decompose(double[], double[])}.</p>
      * @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 @@
     /**
      * Return the determinant of the matrix
      * @return determinant of the matrix
-     * @see #isNonSingular()
      */
     public double getDeterminant() {
         double determinant = 1;

Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/linear/LUDecomposition.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/linear/LUDecomposition.java?rev=737161&r1=737160&r2=737161&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/linear/LUDecomposition.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/linear/LUDecomposition.java Fri Jan 23 11:34:32 2009
@@ -74,7 +74,7 @@
     /**
      * Returns the pivot permutation vector.
      * @return the pivot permutation vector
-     * @see #getPermutation()
+     * @see #getP()
      */
     int[] getPivot();
 

Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/linear/QRDecompositionImpl.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/linear/QRDecompositionImpl.java?rev=737161&r1=737160&r2=737161&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/linear/QRDecompositionImpl.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/linear/QRDecompositionImpl.java Fri Jan 23 11:34:32 2009
@@ -68,8 +68,6 @@
 
     /**
      * Calculates the QR-decomposition of the given matrix. 
-     * <p>Calling this constructor is equivalent to first call the no-arguments
-     * constructor and then call {@link #decompose(RealMatrix)}.</p>
      * @param matrix The matrix to decompose.
      */
     public QRDecompositionImpl(RealMatrix matrix) {

Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/linear/SingularValueDecompositionImpl.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/linear/SingularValueDecompositionImpl.java?rev=737161&r1=737160&r2=737161&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/linear/SingularValueDecompositionImpl.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/linear/SingularValueDecompositionImpl.java Fri Jan 23 11:34:32 2009
@@ -80,8 +80,6 @@
 
     /**
      * Calculates the Singular Value Decomposition of the given matrix. 
-     * <p>Calling this constructor is equivalent to first call the no-arguments
-     * constructor and then call {@link #decompose(RealMatrix)}.</p>
      * @param matrix The matrix to decompose.
      * @exception InvalidMatrixException (wrapping a {@link ConvergenceException}
      * if algorithm fails to converge

Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/ode/ODEIntegrator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/ODEIntegrator.java?rev=737161&r1=737160&r2=737161&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/ode/ODEIntegrator.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/ode/ODEIntegrator.java Fri Jan 23 11:34:32 2009
@@ -98,7 +98,7 @@
      * differential equations} problem) if the value of the current step that
      * is attempted is needed.</p>
      * <p>The result is undefined if the method is called outside of
-     * calls to {@link #integrate}</p>
+     * calls to <code>integrate</code>.</p>
      * @return current value of the step start time t<sub>i</sub>
      */
     double getCurrentStepStart();
@@ -109,7 +109,7 @@
      * differential equations} problem) if the signed value of the current stepsize
      * that is tried is needed.</p>
      * <p>The result is undefined if the method is called outside of
-     * calls to {@link #integrate}</p>
+     * calls to <code>integrate</code>.</p>
      * @return current signed value of the stepsize
      */
     double getCurrentSignedStepsize();

Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/ode/nonstiff/AdamsBashforthIntegrator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/nonstiff/AdamsBashforthIntegrator.java?rev=737161&r1=737160&r2=737161&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/ode/nonstiff/AdamsBashforthIntegrator.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/ode/nonstiff/AdamsBashforthIntegrator.java Fri Jan 23 11:34:32 2009
@@ -52,7 +52,6 @@
  * provided by the {@link AdamsMoultonIntegrator AdamsMoultonIntegrator} class.</p>
  *
  * @see AdamsMoultonIntegrator
- * @see BDFIntegrator
  * @version $Revision$ $Date$
  * @since 2.0
  */

Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/ode/nonstiff/AdamsMoultonIntegrator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/nonstiff/AdamsMoultonIntegrator.java?rev=737161&r1=737160&r2=737161&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/ode/nonstiff/AdamsMoultonIntegrator.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/ode/nonstiff/AdamsMoultonIntegrator.java Fri Jan 23 11:34:32 2009
@@ -52,7 +52,6 @@
  * provided by the {@link AdamsBashforthIntegrator AdamsBashforthIntegrator} class.</p>
  *
  * @see AdamsBashforthIntegrator
- * @see BDFIntegrator
  * @version $Revision$ $Date$
  * @since 2.0
  */

Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/ode/nonstiff/MultistepIntegrator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/nonstiff/MultistepIntegrator.java?rev=737161&r1=737160&r2=737161&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/ode/nonstiff/MultistepIntegrator.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/ode/nonstiff/MultistepIntegrator.java Fri Jan 23 11:34:32 2009
@@ -40,7 +40,6 @@
  *
  * @see AdamsBashforthIntegrator
  * @see AdamsMoultonIntegrator
- * @see BDFIntegrator
  * @version $Revision$ $Date$
  * @since 2.0
  */

Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/stat/regression/OLSMultipleLinearRegression.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/stat/regression/OLSMultipleLinearRegression.java?rev=737161&r1=737160&r2=737161&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/stat/regression/OLSMultipleLinearRegression.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/stat/regression/OLSMultipleLinearRegression.java Fri Jan 23 11:34:32 2009
@@ -59,9 +59,13 @@
     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);