Public Types | Public Member Functions | Protected Attributes
Eigen::HouseholderQR< _MatrixType > Class Template Reference

Householder QR decomposition of a matrix. More...

#include <HouseholderQR.h>

List of all members.

Public Types

enum  {
  RowsAtCompileTime = MatrixType::RowsAtCompileTime, ColsAtCompileTime = MatrixType::ColsAtCompileTime, Options = MatrixType::Options, MaxRowsAtCompileTime = MatrixType::MaxRowsAtCompileTime,
  MaxColsAtCompileTime = MatrixType::MaxColsAtCompileTime
}
typedef
internal::plain_diag_type
< MatrixType >::type 
HCoeffsType
typedef HouseholderSequence
< MatrixType, HCoeffsType >
::ConjugateReturnType 
HouseholderSequenceType
typedef MatrixType::Index Index
typedef Matrix< Scalar,
RowsAtCompileTime,
RowsAtCompileTime,(MatrixType::Flags
&RowMajorBit)?RowMajor:ColMajor,
MaxRowsAtCompileTime,
MaxRowsAtCompileTime
MatrixQType
typedef _MatrixType MatrixType
typedef MatrixType::RealScalar RealScalar
typedef
internal::plain_row_type
< MatrixType >::type 
RowVectorType
typedef MatrixType::Scalar Scalar

Public Member Functions

MatrixType::RealScalar absDeterminant () const
Index cols () const
HouseholderQRcompute (const MatrixType &matrix)
const HCoeffsTypehCoeffs () const
HouseholderSequenceType householderQ () const
 HouseholderQR ()
 Default Constructor.
 HouseholderQR (Index rows, Index cols)
 Default Constructor with memory preallocation.
 HouseholderQR (const MatrixType &matrix)
MatrixType::RealScalar logAbsDeterminant () const
const MatrixTypematrixQR () const
Index rows () const
template<typename Rhs >
const internal::solve_retval
< HouseholderQR, Rhs > 
solve (const MatrixBase< Rhs > &b) const

Protected Attributes

HCoeffsType m_hCoeffs
bool m_isInitialized
MatrixType m_qr
RowVectorType m_temp

Detailed Description

template<typename _MatrixType>
class Eigen::HouseholderQR< _MatrixType >

Householder QR decomposition of a matrix.

Parameters:
MatrixTypethe type of the matrix of which we are computing the QR decomposition

This class performs a QR decomposition of a matrix A into matrices Q and R such that

\[ \mathbf{A} = \mathbf{Q} \, \mathbf{R} \]

by using Householder transformations. Here, Q a unitary matrix and R an upper triangular matrix. The result is stored in a compact way compatible with LAPACK.

Note that no pivoting is performed. This is not a rank-revealing decomposition. If you want that feature, use FullPivHouseholderQR or ColPivHouseholderQR instead.

This Householder QR decomposition is faster, but less numerically stable and less feature-full than FullPivHouseholderQR or ColPivHouseholderQR.

See also:
MatrixBase::householderQr()

Definition at line 42 of file HouseholderQR.h.


Member Typedef Documentation

template<typename _MatrixType>
typedef internal::plain_diag_type<MatrixType>::type Eigen::HouseholderQR< _MatrixType >::HCoeffsType

Definition at line 58 of file HouseholderQR.h.

Definition at line 60 of file HouseholderQR.h.

template<typename _MatrixType>
typedef MatrixType::Index Eigen::HouseholderQR< _MatrixType >::Index

Definition at line 56 of file HouseholderQR.h.

template<typename _MatrixType>
typedef Matrix<Scalar, RowsAtCompileTime, RowsAtCompileTime, (MatrixType::Flags&RowMajorBit) ? RowMajor : ColMajor, MaxRowsAtCompileTime, MaxRowsAtCompileTime> Eigen::HouseholderQR< _MatrixType >::MatrixQType

Definition at line 57 of file HouseholderQR.h.

template<typename _MatrixType>
typedef _MatrixType Eigen::HouseholderQR< _MatrixType >::MatrixType

Definition at line 46 of file HouseholderQR.h.

template<typename _MatrixType>
typedef MatrixType::RealScalar Eigen::HouseholderQR< _MatrixType >::RealScalar

Definition at line 55 of file HouseholderQR.h.

template<typename _MatrixType>
typedef internal::plain_row_type<MatrixType>::type Eigen::HouseholderQR< _MatrixType >::RowVectorType

Definition at line 59 of file HouseholderQR.h.

template<typename _MatrixType>
typedef MatrixType::Scalar Eigen::HouseholderQR< _MatrixType >::Scalar

Definition at line 54 of file HouseholderQR.h.


Member Enumeration Documentation

template<typename _MatrixType>
anonymous enum
Enumerator:
RowsAtCompileTime 
ColsAtCompileTime 
Options 
MaxRowsAtCompileTime 
MaxColsAtCompileTime 

Definition at line 47 of file HouseholderQR.h.


Constructor & Destructor Documentation

template<typename _MatrixType>
Eigen::HouseholderQR< _MatrixType >::HouseholderQR ( ) [inline]

Default Constructor.

The default constructor is useful in cases in which the user intends to perform decompositions via HouseholderQR::compute(const MatrixType&).

Definition at line 68 of file HouseholderQR.h.

template<typename _MatrixType>
Eigen::HouseholderQR< _MatrixType >::HouseholderQR ( Index  rows,
Index  cols 
) [inline]

Default Constructor with memory preallocation.

Like the default constructor but with preallocation of the internal data according to the specified problem size.

See also:
HouseholderQR()

Definition at line 76 of file HouseholderQR.h.

template<typename _MatrixType>
Eigen::HouseholderQR< _MatrixType >::HouseholderQR ( const MatrixType matrix) [inline]

Definition at line 82 of file HouseholderQR.h.


Member Function Documentation

template<typename MatrixType >
MatrixType::RealScalar Eigen::HouseholderQR< MatrixType >::absDeterminant ( ) const
Returns:
the absolute value of the determinant of the matrix of which *this is the QR decomposition. It has only linear complexity (that is, O(n) where n is the dimension of the square matrix) as the QR decomposition has already been computed.
Note:
This is only for square matrices.
Warning:
a determinant can be very big or small, so for matrices of large enough dimension, there is a risk of overflow/underflow. One way to work around that is to use logAbsDeterminant() instead.
See also:
logAbsDeterminant(), MatrixBase::determinant()

Definition at line 174 of file HouseholderQR.h.

template<typename _MatrixType>
Index Eigen::HouseholderQR< _MatrixType >::cols ( void  ) const [inline]

Definition at line 163 of file HouseholderQR.h.

template<typename MatrixType >
HouseholderQR< MatrixType > & Eigen::HouseholderQR< MatrixType >::compute ( const MatrixType matrix)

Definition at line 313 of file HouseholderQR.h.

template<typename _MatrixType>
const HCoeffsType& Eigen::HouseholderQR< _MatrixType >::hCoeffs ( ) const [inline]

Definition at line 164 of file HouseholderQR.h.

template<typename _MatrixType>
HouseholderSequenceType Eigen::HouseholderQR< _MatrixType >::householderQ ( void  ) const [inline]

Definition at line 116 of file HouseholderQR.h.

template<typename MatrixType >
MatrixType::RealScalar Eigen::HouseholderQR< MatrixType >::logAbsDeterminant ( ) const
Returns:
the natural log of the absolute value of the determinant of the matrix of which *this is the QR decomposition. It has only linear complexity (that is, O(n) where n is the dimension of the square matrix) as the QR decomposition has already been computed.
Note:
This is only for square matrices.
This method is useful to work around the risk of overflow/underflow that's inherent to determinant computation.
See also:
absDeterminant(), MatrixBase::determinant()

Definition at line 182 of file HouseholderQR.h.

template<typename _MatrixType>
const MatrixType& Eigen::HouseholderQR< _MatrixType >::matrixQR ( ) const [inline]
Returns:
a reference to the matrix where the Householder QR decomposition is stored in a LAPACK-compatible way.

Definition at line 125 of file HouseholderQR.h.

template<typename _MatrixType>
Index Eigen::HouseholderQR< _MatrixType >::rows ( void  ) const [inline]

Definition at line 162 of file HouseholderQR.h.

template<typename _MatrixType>
template<typename Rhs >
const internal::solve_retval<HouseholderQR, Rhs> Eigen::HouseholderQR< _MatrixType >::solve ( const MatrixBase< Rhs > &  b) const [inline]

This method finds a solution x to the equation Ax=b, where A is the matrix of which *this is the QR decomposition, if any exists.

Parameters:
bthe right-hand-side of the equation to solve.
Returns:
a solution.
Note:
The case where b is a matrix is not yet implemented. Also, this code is space inefficient.

Example:

Output:

Definition at line 110 of file HouseholderQR.h.


Member Data Documentation

template<typename _MatrixType>
HCoeffsType Eigen::HouseholderQR< _MatrixType >::m_hCoeffs [protected]

Definition at line 168 of file HouseholderQR.h.

template<typename _MatrixType>
bool Eigen::HouseholderQR< _MatrixType >::m_isInitialized [protected]

Definition at line 170 of file HouseholderQR.h.

template<typename _MatrixType>
MatrixType Eigen::HouseholderQR< _MatrixType >::m_qr [protected]

Definition at line 167 of file HouseholderQR.h.

template<typename _MatrixType>
RowVectorType Eigen::HouseholderQR< _MatrixType >::m_temp [protected]

Definition at line 169 of file HouseholderQR.h.


The documentation for this class was generated from the following file:


win_eigen
Author(s): Daniel Stonier
autogenerated on Wed Sep 16 2015 07:12:53