Apache
/
commons-math
mirror of https://github.com/apache/commons-math.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

minor javadoc fixes for HessenbergTransformer. 

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/math/trunk@1334644 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Thomas Neidhart 2012-05-06 14:33:32 +00:00
parent 8dcea987fd
commit ada3793d40
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/main/java/org/apache/commons/math3/linear/HessenbergTransformer.java
View File

@ -23,7 +23,7 @@ import org.apache.commons.math3.util.Precision;
/** /**
* Class transforming a general real matrix to Hessenberg form. * Class transforming a general real matrix to Hessenberg form.
* <p>A m &times; m matrix A can be written as the product of three matrices: A = P * <p>A m &times; m matrix A can be written as the product of three matrices: A = P
* &times; H &times; P<sup>T</sup> with P an unitary matrix and H a Hessenberg * &times; H &times; P<sup>T</sup> with P an orthogonal matrix and H a Hessenberg
* matrix. Both P and H are m &times; m matrices.</p> * matrix. Both P and H are m &times; m matrices.</p>
* <p>Transformation to Hessenberg form is often not a goal by itself, but it is an * <p>Transformation to Hessenberg form is often not a goal by itself, but it is an
* intermediate step in more general decomposition algorithms like * intermediate step in more general decomposition algorithms like
@ -54,10 +54,10 @@ class HessenbergTransformer {
/** /**
* Build the transformation to Hessenberg form of a general matrix. * Build the transformation to Hessenberg form of a general matrix.
* *
* @param matrix matrix to transform. * @param matrix matrix to transform
* @throws NonSquareMatrixException if the matrix is not square. * @throws NonSquareMatrixException if the matrix is not square
*/ */
public HessenbergTransformer(RealMatrix matrix) { public HessenbergTransformer(final RealMatrix matrix) {
if (!matrix.isSquare()) { if (!matrix.isSquare()) {
throw new NonSquareMatrixException(matrix.getRowDimension(), throw new NonSquareMatrixException(matrix.getRowDimension(),
matrix.getColumnDimension()); matrix.getColumnDimension());
@ -76,7 +76,7 @@ class HessenbergTransformer {
/** /**
* Returns the matrix P of the transform. * Returns the matrix P of the transform.
* <p>P is an unitary matrix, i.e. its inverse is also its transpose.</p> * <p>P is an orthogonal matrix, i.e. its inverse is also its transpose.</p>
* *
* @return the P matrix * @return the P matrix
*/ */
@ -122,7 +122,7 @@ class HessenbergTransformer {
/** /**
* Returns the transpose of the matrix P of the transform. * Returns the transpose of the matrix P of the transform.
* <p>P is an unitary matrix, i.e. its inverse is also its transpose.</p> * <p>P is an orthogonal matrix, i.e. its inverse is also its transpose.</p>
* *
* @return the transpose of the P matrix * @return the transpose of the P matrix
*/ */