svn commit: r1096473 - /commons/proper/math/trunk/src/main/java/org/apache/commons/math/linear/CholeskyDecomposition.java

[lu...@apache.org]

Author: luc
Date: Mon Apr 25 13:31:47 2011
New Revision: 1096473

URL: http://svn.apache.org/viewvc?rev=1096473&view=rev
Log:
expand javadoc to explain what Cholesky decomposition is

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

Modified: commons/proper/math/trunk/src/main/java/org/apache/commons/math/linear/CholeskyDecomposition.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math/linear/CholeskyDecomposition.java?rev=1096473&r1=1096472&r2=1096473&view=diff
==============================================================================
--- commons/proper/math/trunk/src/main/java/org/apache/commons/math/linear/CholeskyDecomposition.java (original)
+++ commons/proper/math/trunk/src/main/java/org/apache/commons/math/linear/CholeskyDecomposition.java Mon Apr 25 13:31:47 2011
@@ -21,6 +21,9 @@ package org.apache.commons.math.linear;
 /**
  * An interface to classes that implement an algorithm to calculate the
  * Cholesky decomposition of a real symmetric positive-definite matrix.
+ * <p>The Cholesky decomposition of a real symmetric positive-definite
+ * matrix A consists of a lower triangular matrix L with same size that
+ * satisfy: A = LL<sup>T</sup>Q = I). In a sense, this is the square root of A.</p>
  * <p>This interface is based on the class with similar name from the
  * <a href="http://math.nist.gov/javanumerics/jama/">JAMA</a> library, with the
  * following changes:</p>