svn commit: r1306148 - /commons/proper/math/trunk/src/main/java/org/apache/commons/math3/linear/JacobiPreconditioner.java

[ce...@apache.org]

Author: celestin
Date: Wed Mar 28 04:05:59 2012
New Revision: 1306148

URL: http://svn.apache.org/viewvc?rev=1306148&view=rev
Log:
Changed o.a.c.m3.linear.JacobiPreconditioner according to MATH-771.

Modified:
    commons/proper/math/trunk/src/main/java/org/apache/commons/math3/linear/JacobiPreconditioner.java

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math3/linear/JacobiPreconditioner.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/linear/JacobiPreconditioner.java?rev=1306148&r1=1306147&r2=1306148&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math3/linear/JacobiPreconditioner.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math3/linear/JacobiPreconditioner.java Wed Mar 28 04:05:59 2012
@@ -21,10 +21,7 @@ import org.apache.commons.math3.analysis
 /**
  * This class implements the standard Jacobi (diagonal) preconditioner. For a
  * matrix A<sub>ij</sub>, this preconditioner is
- * M = diag(A<sub>11</sub>, A<sub>22</sub>, &hellip;).
- * {@link #create(RealLinearOperator)} returns the <em>inverse</em> of this
- * preconditioner,
- * M<sup>-1</sup> = diag(1 / A<sub>11</sub>, 1 / A<sub>22</sub>, &hellip;)
+ * M = diag(1 / A<sub>11</sub>, 1 / A<sub>22</sub>, &hellip;).
  *
  * @version $Id$
  * @since 3.0
@@ -55,8 +52,8 @@ public class JacobiPreconditioner extend
      * some time). With matrices, direct entry access is carried out.
      *
      * @param a the linear operator for which the preconditioner should be built
-     * @return the inverse of the preconditioner made of the inverse of the
-     * diagonal coefficients of the specified linear operator
+     * @return the diagonal preconditioner made of the inverse of the diagonal
+     * coefficients of the specified linear operator
      * @throws NonSquareOperatorException if {@code a} is not square
      */
     public static JacobiPreconditioner create(final RealLinearOperator a)
@@ -97,7 +94,7 @@ public class JacobiPreconditioner extend
     /** {@inheritDoc} */
     @Override
     public RealVector operate(final RealVector x) {
-        // Dimension check is carried out by ebeMultiply
+        // Dimension check is carried out by ebeDivide
         return x.ebeDivide(diag);
     }
 
@@ -106,7 +103,7 @@ public class JacobiPreconditioner extend
      * precisely, this method returns
      * P = diag(1 / &radic;A<sub>11</sub>, 1 / &radic;A<sub>22</sub>, &hellip;).
      *
-     * @return the square root of {@code this} operator
+     * @return the square root of {@code this} preconditioner
      */
     public RealLinearOperator sqrt(){
         final RealVector sqrtDiag = diag.map(new Sqrt());