Author: psteitz
Date: Tue Jul 4 14:08:47 2006
New Revision: 419103
URL: http://svn.apache.org/viewvc?rev=419103&view=rev
Log:
Javadoc fixes.
Modified:
jakarta/commons/proper/math/trunk/src/java/org/apache/commons/math/linear/QRDecomposition.java
jakarta/commons/proper/math/trunk/src/java/org/apache/commons/math/linear/QRDecompositionImpl.java
Modified:
jakarta/commons/proper/math/trunk/src/java/org/apache/commons/math/linear/QRDecomposition.java
URL:
http://svn.apache.org/viewvc/jakarta/commons/proper/math/trunk/src/java/org/apache/commons/math/linear/QRDecomposition.java?rev=419103&r1=419102&r2=419103&view=diff
==============================================================================
---
jakarta/commons/proper/math/trunk/src/java/org/apache/commons/math/linear/QRDecomposition.java
(original)
+++
jakarta/commons/proper/math/trunk/src/java/org/apache/commons/math/linear/QRDecomposition.java
Tue Jul 4 14:08:47 2006
@@ -22,16 +22,22 @@
*
* @see <a
href="http://mathworld.wolfram.com/QRDecomposition.html";>MathWorld</a>
* @see <a href="http://en.wikipedia.org/wiki/QR_decomposition";>Wikipedia</a>
+ *
+ * @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();
}
Modified:
jakarta/commons/proper/math/trunk/src/java/org/apache/commons/math/linear/QRDecompositionImpl.java
URL:
http://svn.apache.org/viewvc/jakarta/commons/proper/math/trunk/src/java/org/apache/commons/math/linear/QRDecompositionImpl.java?rev=419103&r1=419102&r2=419103&view=diff
==============================================================================
---
jakarta/commons/proper/math/trunk/src/java/org/apache/commons/math/linear/QRDecompositionImpl.java
(original)
+++
jakarta/commons/proper/math/trunk/src/java/org/apache/commons/math/linear/QRDecompositionImpl.java
Tue Jul 4 14:08:47 2006
@@ -27,6 +27,8 @@
*
* @see <a
href="http://mathworld.wolfram.com/QRDecomposition.html";>MathWorld</a>
* @see <a href="http://en.wikipedia.org/wiki/QR_decomposition";>Wikipedia</a>
+ *
+ * @version $Revision$ $Date$
*/
public class QRDecompositionImpl implements QRDecomposition {
@@ -57,7 +59,7 @@
/**
* 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 @@
/**
* Returns the matrix R of the QR-decomposition.
+ *
+ * @return the R matrix
*/
public RealMatrix getR()
{
@@ -147,6 +151,8 @@
/**
* Returns the matrix Q of the QR-decomposition.
+ *
+ * @return the Q matrix
*/
public RealMatrix getQ()
{
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
