Apache/commons-math
1
0
Fork 0
mirror of https://github.com/apache/commons-math.git synced 2025-02-10 12:06:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

Javadoc fixes.

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/math/trunk@419103 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Phil Steitz 2006-07-04 21:08:47 +00:00
parent ac13472bb0
commit 4d0b96e980
2 changed files with 14 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/java/org/apache/commons/math/linear/QRDecomposition.java
View File

@ -22,16 +22,22 @@ package org.apache.commons.math.linear;
* *
* @see <a href="http://mathworld.wolfram.com/QRDecomposition.html">MathWorld</a> * @see <a href="http://mathworld.wolfram.com/QRDecomposition.html">MathWorld</a>
* @see <a href="http://en.wikipedia.org/wiki/QR_decomposition">Wikipedia</a> * @see <a href="http://en.wikipedia.org/wiki/QR_decomposition">Wikipedia</a>
*
* @version $Revision$ $Date$
*/ */
public interface QRDecomposition { public interface QRDecomposition {
/** /**
* Returns the matrix R of the decomposition. * Returns the matrix R of the decomposition.
*
* @return the R matrix
*/ */
public abstract RealMatrix getR(); 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(); public abstract RealMatrix getQ();
} }

8
src/java/org/apache/commons/math/linear/QRDecompositionImpl.java
View File

@ -27,6 +27,8 @@ package org.apache.commons.math.linear;
* *
* @see <a href="http://mathworld.wolfram.com/QRDecomposition.html">MathWorld</a> * @see <a href="http://mathworld.wolfram.com/QRDecomposition.html">MathWorld</a>
* @see <a href="http://en.wikipedia.org/wiki/QR_decomposition">Wikipedia</a> * @see <a href="http://en.wikipedia.org/wiki/QR_decomposition">Wikipedia</a>
*
* @version $Revision$ $Date$
*/ */
public class QRDecompositionImpl implements QRDecomposition { public class QRDecompositionImpl implements QRDecomposition {
@ -57,7 +59,7 @@ public class QRDecompositionImpl implements QRDecomposition {
/** /**
* Calculates the QR decomposition of the given matrix. * Calculates the QR decomposition of the given matrix.
* *
* @param matrix The matrix to factorize. * @param matrix The matrix to decompose.
*/ */
public QRDecompositionImpl(RealMatrix matrix) { public QRDecompositionImpl(RealMatrix matrix) {
m = matrix.getRowDimension(); m = matrix.getRowDimension();
@ -128,6 +130,8 @@ public class QRDecompositionImpl implements QRDecomposition {
/** /**
* Returns the matrix R of the QR-decomposition. * Returns the matrix R of the QR-decomposition.
*
* @return the R matrix
*/ */
public RealMatrix getR() public RealMatrix getR()
{ {
@ -147,6 +151,8 @@ public class QRDecompositionImpl implements QRDecomposition {
/** /**
* Returns the matrix Q of the QR-decomposition. * Returns the matrix Q of the QR-decomposition.
*
* @return the Q matrix
*/ */
public RealMatrix getQ() public RealMatrix getQ()
{ {