Return-Path:
Delivered-To: apmail-commons-commits-archive@locus.apache.org
Received: (qmail 66627 invoked from network); 5 Oct 2008 15:37:13 -0000
Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.2)
by minotaur.apache.org with SMTP; 5 Oct 2008 15:37:13 -0000
Received: (qmail 2923 invoked by uid 500); 5 Oct 2008 15:37:10 -0000
Delivered-To: apmail-commons-commits-archive@commons.apache.org
Received: (qmail 2847 invoked by uid 500); 5 Oct 2008 15:37:10 -0000
Mailing-List: contact commits-help@commons.apache.org; run by ezmlm
Precedence: bulk
List-Help:
List-Unsubscribe:
List-Post:
List-Id:
Reply-To: dev@commons.apache.org
Delivered-To: mailing list commits@commons.apache.org
Received: (qmail 2838 invoked by uid 99); 5 Oct 2008 15:37:10 -0000
Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136)
by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 05 Oct 2008 08:37:10 -0700
X-ASF-Spam-Status: No, hits=-1998.7 required=10.0
tests=ALL_TRUSTED,DNS_FROM_DOB,DNS_FROM_SECURITYSAGE,RCVD_IN_DOB
X-Spam-Check-By: apache.org
Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4)
by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 05 Oct 2008 15:36:15 +0000
Received: by eris.apache.org (Postfix, from userid 65534)
id 25BE723888A0; Sun, 5 Oct 2008 08:36:21 -0700 (PDT)
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Subject: svn commit: r701809 -
/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/linear/TriDiagonalTransformer.java
Date: Sun, 05 Oct 2008 15:36:21 -0000
To: commits@commons.apache.org
From: luc@apache.org
X-Mailer: svnmailer-1.0.8
Message-Id: <20081005153621.25BE723888A0@eris.apache.org>
X-Virus-Checked: Checked by ClamAV on apache.org
Author: luc
Date: Sun Oct 5 08:36:20 2008
New Revision: 701809
URL: http://svn.apache.org/viewvc?rev=701809&view=rev
Log:
improved javadoc
Modified:
commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/linear/TriDiagonalTransformer.java
Modified: commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/linear/TriDiagonalTransformer.java
URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/linear/TriDiagonalTransformer.java?rev=701809&r1=701808&r2=701809&view=diff
==============================================================================
--- commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/linear/TriDiagonalTransformer.java (original)
+++ commons/proper/math/branches/MATH_2_0/src/java/org/apache/commons/math/linear/TriDiagonalTransformer.java Sun Oct 5 08:36:20 2008
@@ -21,16 +21,17 @@
import java.util.Arrays;
/**
- * Class transforming a symmetrical matrix to tri-diagonal shape.
+ * Class transforming a symmetrical matrix to tridiagonal shape.
* A symmetrical m × m matrix A can be written as the product of three matrices:
* A = Q × T × QT with Q an orthogonal matrix and T a symmetrical
- * tri-diagonal matrix. Both Q and T are m × m matrices.
- * Transformation to tri-diagonal shape is often not a goal by itself, but it is
+ * tridiagonal matrix. Both Q and T are m × m matrices.
+ * This implementation only uses the upper part of the matrix, the part below the
+ * diagonal is not accessed at all.
+ * Transformation to tridiagonal shape is often not a goal by itself, but it is
* an intermediate step in more general decomposition algorithms like {@link
- * EigenValuesDecomposition Eigen Values Decomposition}. This class is therefore
- * intended for internal use by the library and is not public. As a consequence of
- * this explicitly limited scope, many methods directly returns references to
- * internal arrays, not copies.
+ * EigenDecomposition eigen decomposition}. This class is therefore intended for internal
+ * use by the library and is not public. As a consequence of this explicitly limited scope,
+ * many methods directly returns references to internal arrays, not copies.
* @version $Revision$ $Date$
* @since 2.0
*/
@@ -58,7 +59,7 @@
private RealMatrix cachedT;
/**
- * Build the transformation to tri-diagonal shape of a symmetrical matrix.
+ * Build the transformation to tridiagonal shape of a symmetrical matrix.
* The specified matrix is assumed to be symmetrical without any check.
* Only the upper triangular part of the matrix is used.
* @param matrix the symmetrical matrix to transform.
@@ -67,7 +68,7 @@
public TriDiagonalTransformer(RealMatrix matrix)
throws InvalidMatrixException {
if (!matrix.isSquare()) {
- throw new InvalidMatrixException("transformation to tri-diagonal requires that the matrix be square");
+ throw new InvalidMatrixException("transformation to tridiagonal requires that the matrix be square");
}
final int m = matrix.getRowDimension();
@@ -140,7 +141,7 @@
}
/**
- * Returns the tri-diagonal matrix T of the transform.
+ * Returns the tridiagonal matrix T of the transform.
* @return the T matrix
*/
public RealMatrix getT() {
@@ -201,7 +202,7 @@
}
/**
- * Transform original matrix to tri-diagonal form.
+ * Transform original matrix to tridiagonal form.
* Transformation is done using Householder transforms.
*/
private void transform() {