From 4d0b96e98084ba0be8d3755cbbb7c9804b58c39b Mon Sep 17 00:00:00 2001 From: Phil Steitz Date: Tue, 4 Jul 2006 21:08:47 +0000 Subject: [PATCH] Javadoc fixes. git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/math/trunk@419103 13f79535-47bb-0310-9956-ffa450edef68 --- .../org/apache/commons/math/linear/QRDecomposition.java | 8 +++++++- .../apache/commons/math/linear/QRDecompositionImpl.java | 8 +++++++- 2 files changed, 14 insertions(+), 2 deletions(-) diff --git a/src/java/org/apache/commons/math/linear/QRDecomposition.java b/src/java/org/apache/commons/math/linear/QRDecomposition.java index 99a066e83..28076a83b 100644 --- a/src/java/org/apache/commons/math/linear/QRDecomposition.java +++ b/src/java/org/apache/commons/math/linear/QRDecomposition.java @@ -22,16 +22,22 @@ package org.apache.commons.math.linear; * * @see MathWorld * @see Wikipedia + * + * @version $Revision$ $Date$ */ public interface QRDecomposition { /** * Returns the matrix R of the decomposition. + * + * @return the R matrix */ public abstract RealMatrix getR(); /** - * Returbs the matrix Q of the decomposition. + * Returns the matrix Q of the decomposition. + * + * @return the Q matrix */ public abstract RealMatrix getQ(); } diff --git a/src/java/org/apache/commons/math/linear/QRDecompositionImpl.java b/src/java/org/apache/commons/math/linear/QRDecompositionImpl.java index 01cb054cb..c41a36120 100644 --- a/src/java/org/apache/commons/math/linear/QRDecompositionImpl.java +++ b/src/java/org/apache/commons/math/linear/QRDecompositionImpl.java @@ -27,6 +27,8 @@ package org.apache.commons.math.linear; * * @see MathWorld * @see Wikipedia + * + * @version $Revision$ $Date$ */ public class QRDecompositionImpl implements QRDecomposition { @@ -57,7 +59,7 @@ public class QRDecompositionImpl implements QRDecomposition { /** * Calculates the QR decomposition of the given matrix. * - * @param matrix The matrix to factorize. + * @param matrix The matrix to decompose. */ public QRDecompositionImpl(RealMatrix matrix) { m = matrix.getRowDimension(); @@ -128,6 +130,8 @@ public class QRDecompositionImpl implements QRDecomposition { /** * Returns the matrix R of the QR-decomposition. + * + * @return the R matrix */ public RealMatrix getR() { @@ -147,6 +151,8 @@ public class QRDecompositionImpl implements QRDecomposition { /** * Returns the matrix Q of the QR-decomposition. + * + * @return the Q matrix */ public RealMatrix getQ() {