Householder QR decomposition of a matrix. More...

#include <ForwardDeclarations.h>

Inheritance diagram for Eigen::HouseholderQR< _MatrixType >:

Public Types
enum	{ MaxRowsAtCompileTime = MatrixType::MaxRowsAtCompileTime, MaxColsAtCompileTime = MatrixType::MaxColsAtCompileTime }

typedef SolverBase< HouseholderQR >	Base

typedef internal::plain_diag_type< MatrixType >::type	HCoeffsType

typedef HouseholderSequence< MatrixType, typename internal::remove_all< typename HCoeffsType::ConjugateReturnType >::type >	HouseholderSequenceType

typedef Matrix< Scalar, RowsAtCompileTime, RowsAtCompileTime,(MatrixType::Flags &RowMajorBit) ? RowMajor :ColMajor, MaxRowsAtCompileTime, MaxRowsAtCompileTime >	MatrixQType

typedef _MatrixType	MatrixType

typedef internal::plain_row_type< MatrixType >::type	RowVectorType

Public Types inherited from Eigen::SolverBase< HouseholderQR< _MatrixType > >
enum

typedef internal::conditional< NumTraits< Scalar >::IsComplex, CwiseUnaryOp< internal::scalar_conjugate_op< Scalar >, ConstTransposeReturnType >, ConstTransposeReturnType >::type	AdjointReturnType

typedef EigenBase< HouseholderQR< _MatrixType > >	Base

typedef Scalar	CoeffReturnType

typedef internal::add_const< Transpose< const HouseholderQR< _MatrixType > > >::type	ConstTransposeReturnType

typedef internal::traits< HouseholderQR< _MatrixType > >::Scalar	Scalar

Public Types inherited from Eigen::EigenBase< Derived >
typedef Eigen::Index	Index
	The interface type of indices. More...

typedef internal::traits< Derived >::StorageKind	StorageKind

Public Member Functions
template<typename RhsType , typename DstType >
void	_solve_impl (const RhsType &rhs, DstType &dst) const

template<bool Conjugate, typename RhsType , typename DstType >
void	_solve_impl_transposed (const RhsType &rhs, DstType &dst) const

MatrixType::RealScalar	absDeterminant () const

Index	cols () const

template<typename InputType >
HouseholderQR &	compute (const EigenBase< InputType > &matrix)

const HCoeffsType &	hCoeffs () const

HouseholderSequenceType	householderQ () const

	HouseholderQR ()
	Default Constructor. More...

	HouseholderQR (Index rows, Index cols)
	Default Constructor with memory preallocation. More...

template<typename InputType >
	HouseholderQR (const EigenBase< InputType > &matrix)
	Constructs a QR factorization from a given matrix. More...

template<typename InputType >
	HouseholderQR (EigenBase< InputType > &matrix)
	Constructs a QR factorization from a given matrix. More...

MatrixType::RealScalar	logAbsDeterminant () const

const MatrixType &	matrixQR () const

Index	rows () const

Public Member Functions inherited from Eigen::SolverBase< HouseholderQR< _MatrixType > >
AdjointReturnType	adjoint () const

const Solve< HouseholderQR< _MatrixType >, Rhs >	solve (const MatrixBase< Rhs > &b) const

	SolverBase ()

ConstTransposeReturnType	transpose () const

	~SolverBase ()

Public Member Functions inherited from Eigen::EigenBase< Derived >
template<typename Dest >
EIGEN_DEVICE_FUNC void	addTo (Dest &dst) const

template<typename Dest >
EIGEN_DEVICE_FUNC void	applyThisOnTheLeft (Dest &dst) const

template<typename Dest >
EIGEN_DEVICE_FUNC void	applyThisOnTheRight (Dest &dst) const

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT

EIGEN_DEVICE_FUNC Derived &	const_cast_derived () const

EIGEN_DEVICE_FUNC const Derived &	const_derived () const

EIGEN_DEVICE_FUNC Derived &	derived ()

EIGEN_DEVICE_FUNC const Derived &	derived () const

template<typename Dest >
EIGEN_DEVICE_FUNC void	evalTo (Dest &dst) const

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	size () const EIGEN_NOEXCEPT

template<typename Dest >
EIGEN_DEVICE_FUNC void	subTo (Dest &dst) const

Protected Member Functions
void	computeInPlace ()

Protected Member Functions inherited from Eigen::SolverBase< HouseholderQR< _MatrixType > >
void	_check_solve_assertion (const Rhs &b) const

Static Protected Member Functions
static void	check_template_parameters ()

Protected Attributes
HCoeffsType	m_hCoeffs

bool	m_isInitialized

MatrixType	m_qr

RowVectorType	m_temp

Friends
class	SolverBase< HouseholderQR >

Detailed Description

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

Householder QR decomposition of a matrix.

Template Parameters

_MatrixType the 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.

This class supports the inplace decomposition mechanism.

See also: MatrixBase::householderQr()

Definition at line 273 of file ForwardDeclarations.h.

Member Typedef Documentation

◆ Base

template<typename _MatrixType>

typedef SolverBase<HouseholderQR> Eigen::HouseholderQR< _MatrixType >::Base

Definition at line 62 of file HouseholderQR.h.

◆ HCoeffsType

template<typename _MatrixType>

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

Definition at line 71 of file HouseholderQR.h.

◆ HouseholderSequenceType

template<typename _MatrixType>

typedef HouseholderSequence<MatrixType,typename internal::remove_all<typename HCoeffsType::ConjugateReturnType>::type> Eigen::HouseholderQR< _MatrixType >::HouseholderSequenceType

Definition at line 73 of file HouseholderQR.h.

◆ MatrixQType

template<typename _MatrixType>

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

Definition at line 70 of file HouseholderQR.h.

◆ MatrixType

template<typename _MatrixType>

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

Definition at line 61 of file HouseholderQR.h.

◆ RowVectorType

template<typename _MatrixType>

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

Definition at line 72 of file HouseholderQR.h.

Member Enumeration Documentation

◆ anonymous enum

template<typename _MatrixType>

anonymous enum

Enumerator
MaxRowsAtCompileTime
MaxColsAtCompileTime

Definition at line 66 of file HouseholderQR.h.

Constructor & Destructor Documentation

◆ HouseholderQR() [1/4]

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 81 of file HouseholderQR.h.

◆ HouseholderQR() [2/4]

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 89 of file HouseholderQR.h.

◆ HouseholderQR() [3/4]

template<typename _MatrixType>

template<typename InputType >

Eigen::HouseholderQR< _MatrixType >::HouseholderQR ( const EigenBase< InputType > & matrix )

inlineexplicit

Constructs a QR factorization from a given matrix.

This constructor computes the QR factorization of the matrix matrix by calling the method compute(). It is a short cut for:

HouseholderQR<MatrixType> qr(matrix.rows(), matrix.cols());

qr.compute(matrix);

See also: compute()

Definition at line 108 of file HouseholderQR.h.

◆ HouseholderQR() [4/4]

template<typename _MatrixType>

template<typename InputType >

Eigen::HouseholderQR< _MatrixType >::HouseholderQR ( EigenBase< InputType > & matrix )

inlineexplicit

Constructs a QR factorization from a given matrix.

This overloaded constructor is provided for inplace decomposition when MatrixType is a Eigen::Ref.

See also: HouseholderQR(const EigenBase&)

Definition at line 126 of file HouseholderQR.h.

Member Function Documentation

◆ _solve_impl()

template<typename _MatrixType >

template<typename RhsType , typename DstType >

void Eigen::HouseholderQR< _MatrixType >::_solve_impl	(	const RhsType &	rhs,
		DstType &	dst
	)		const

Definition at line 361 of file HouseholderQR.h.

◆ _solve_impl_transposed()

template<typename _MatrixType >

template<bool Conjugate, typename RhsType , typename DstType >

void Eigen::HouseholderQR< _MatrixType >::_solve_impl_transposed	(	const RhsType &	rhs,
		DstType &	dst
	)		const

Definition at line 379 of file HouseholderQR.h.

◆ absDeterminant()

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 247 of file HouseholderQR.h.

◆ check_template_parameters()

template<typename _MatrixType>

static void Eigen::HouseholderQR< _MatrixType >::check_template_parameters ( )

inlinestaticprotected

Definition at line 233 of file HouseholderQR.h.

◆ cols()

template<typename _MatrixType>

Index Eigen::HouseholderQR< _MatrixType >::cols ( void ) const

inline

Definition at line 215 of file HouseholderQR.h.

◆ compute()

template<typename _MatrixType>

template<typename InputType >

HouseholderQR& Eigen::HouseholderQR< _MatrixType >::compute ( const EigenBase< InputType > & matrix )

inline

Definition at line 179 of file HouseholderQR.h.

◆ computeInPlace()

template<typename MatrixType >

void Eigen::HouseholderQR< MatrixType >::computeInPlace ( )

protected

Performs the QR factorization of the given matrix matrix. The result of the factorization is stored into *this, and a reference to *this is returned.

See also: class HouseholderQR, HouseholderQR(const MatrixType&)

Definition at line 404 of file HouseholderQR.h.

◆ hCoeffs()

template<typename _MatrixType>

const HCoeffsType& Eigen::HouseholderQR< _MatrixType >::hCoeffs ( ) const

inline

Returns: a const reference to the vector of Householder coefficients used to represent the factor Q.

For advanced uses only.

Definition at line 221 of file HouseholderQR.h.

◆ householderQ()

template<typename _MatrixType>

HouseholderSequenceType Eigen::HouseholderQR< _MatrixType >::householderQ ( void ) const

inline

This method returns an expression of the unitary matrix Q as a sequence of Householder transformations.

The returned expression can directly be used to perform matrix products. It can also be assigned to a dense Matrix object. Here is an example showing how to recover the full or thin matrix Q, as well as how to perform matrix products using operator*:

Example:

MatrixXf A(MatrixXf::Random(5,3)), thinQ(MatrixXf::Identity(5,3)), Q;
A.setRandom();
HouseholderQR<MatrixXf> qr(A);
Q = qr.householderQ();
thinQ = qr.householderQ() * thinQ;
std::cout << "The complete unitary matrix Q is:\n" << Q << "\n\n";
std::cout << "The thin matrix Q is:\n" << thinQ << "\n\n";

Output:

Definition at line 163 of file HouseholderQR.h.

◆ logAbsDeterminant()

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 256 of file HouseholderQR.h.

◆ matrixQR()

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 172 of file HouseholderQR.h.

◆ rows()

template<typename _MatrixType>

Index Eigen::HouseholderQR< _MatrixType >::rows ( void ) const

inline

Definition at line 214 of file HouseholderQR.h.

Friends And Related Function Documentation

◆ SolverBase< HouseholderQR >

template<typename _MatrixType>

friend class SolverBase< HouseholderQR >

friend

Definition at line 63 of file HouseholderQR.h.

Member Data Documentation

◆ m_hCoeffs

template<typename _MatrixType>

HCoeffsType Eigen::HouseholderQR< _MatrixType >::m_hCoeffs

protected

Definition at line 241 of file HouseholderQR.h.

◆ m_isInitialized

template<typename _MatrixType>

bool Eigen::HouseholderQR< _MatrixType >::m_isInitialized

protected

Definition at line 243 of file HouseholderQR.h.

◆ m_qr

template<typename _MatrixType>

MatrixType Eigen::HouseholderQR< _MatrixType >::m_qr

protected

Definition at line 240 of file HouseholderQR.h.

◆ m_temp

template<typename _MatrixType>

RowVectorType Eigen::HouseholderQR< _MatrixType >::m_temp

protected

Definition at line 242 of file HouseholderQR.h.

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

Public Types

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Detailed Description

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

Member Typedef Documentation

◆ Base

◆ HCoeffsType

◆ HouseholderSequenceType

◆ MatrixQType

◆ MatrixType

◆ RowVectorType

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ HouseholderQR() [1/4]

◆ HouseholderQR() [2/4]

◆ HouseholderQR() [3/4]

◆ HouseholderQR() [4/4]

Member Function Documentation

◆ _solve_impl()

◆ _solve_impl_transposed()

◆ absDeterminant()

◆ check_template_parameters()

◆ cols()

◆ compute()

◆ computeInPlace()

◆ hCoeffs()

◆ householderQ()

◆ logAbsDeterminant()

◆ matrixQR()

◆ rows()

Friends And Related Function Documentation

◆ SolverBase< HouseholderQR >

Member Data Documentation

◆ m_hCoeffs

◆ m_isInitialized

◆ m_qr

◆ m_temp

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