svn commit: r728916 - in /commons/proper/math/trunk/src/java/org/apache/commons/math/linear: QRDecomposition.java SingularValueDecomposition.java SingularValueDecompositionImpl.java

[lu...@apache.org]

Author: luc
Date: Tue Dec 23 02:14:49 2008
New Revision: 728916

URL: http://svn.apache.org/viewvc?rev=728916&view=rev
Log:
javadoc improvements

Modified:
    commons/proper/math/trunk/src/java/org/apache/commons/math/linear/QRDecomposition.java
    commons/proper/math/trunk/src/java/org/apache/commons/math/linear/SingularValueDecomposition.java
    commons/proper/math/trunk/src/java/org/apache/commons/math/linear/SingularValueDecompositionImpl.java

Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/linear/QRDecomposition.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/linear/QRDecomposition.java?rev=728916&r1=728915&r2=728916&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/linear/QRDecomposition.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/linear/QRDecomposition.java Tue Dec 23 02:14:49 2008
@@ -26,7 +26,10 @@
  * <a href="http://math.nist.gov/javanumerics/jama/">JAMA</a> library, with the
  * following changes:</p>
  * <ul>
- *   <li>a {@link #getSolver() getSolver} method has been added.</li>
+ *   <li>a {@link #getQT() getQT} method has been added,</li>
+ *   <li>the <code>solve</code> and <code>isFullRank</code> methods have been replaced
+ *   by a {@link #getSolver() getSolver} method and the equivalent methods provided by
+ *   the returned {@link DecompositionSolver}.</li>
  * </ul>
  *   
  * @see <a href="http://mathworld.wolfram.com/QRDecomposition.html">MathWorld</a>
@@ -67,7 +70,7 @@
     RealMatrix getH();
 
     /**
-     * Get a solver for A &times; X = B.
+     * Get a solver for finding the A &times; X = B solution in least square sense.
      * @return a solver
      */
     DecompositionSolver getSolver();

Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/linear/SingularValueDecomposition.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/linear/SingularValueDecomposition.java?rev=728916&r1=728915&r2=728916&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/linear/SingularValueDecomposition.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/linear/SingularValueDecomposition.java Tue Dec 23 02:14:49 2008
@@ -37,7 +37,9 @@
  *   <li>the <code>cond</code> method which has been renamed as {@link
  *   #getConditionNumber() getConditionNumber},</li>
  *   <li>the <code>rank</code> method which has been renamed as {@link #getRank()
- *   getRank}</li>
+ *   getRank},</li>
+ *   <li>a {@link #getUT() getUT} method has been added,</li>
+ *   <li>a {@link #getVT() getVT} method has been added,</li>
  *   <li>a {@link #getSolver() getSolver} method has been added.</li>
  * </ul>
  * @see <a href="http://mathworld.wolfram.com/SingularValueDecomposition.html">MathWorld</a>
@@ -121,7 +123,7 @@
     int getRank();
 
     /**
-     * Get a solver for A &times; X = B.
+     * Get a solver for finding the A &times; X = B solution in least square sense.
      * @return a solver
      */
     DecompositionSolver getSolver();

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=728916&r1=728915&r2=728916&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 Tue Dec 23 02:14:49 2008
@@ -118,7 +118,7 @@
         eigenDecomposition =
             new EigenDecompositionImpl(mainTridiagonal, secondaryTridiagonal,
                                        MathUtils.SAFE_MIN);
-        singularValues = eigenDecomposition.getEigenvalues();
+        singularValues = eigenDecomposition.getRealEigenvalues();
         for (int i = 0; i < singularValues.length; ++i) {
             singularValues[i] = Math.sqrt(singularValues[i]);
         }