Public Types | Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Friends | List of all members
Eigen::FullPivHouseholderQR Class Reference
Dense linear problems and decompositions » Reference » QR_Module

Householder rank-revealing QR decomposition of a matrix with full pivoting. More...

#include <ForwardDeclarations.h>

Public Types

enum  { MaxRowsAtCompileTime = MatrixType::MaxRowsAtCompileTime, MaxColsAtCompileTime = MatrixType::MaxColsAtCompileTime }
 
typedef SolverBase< FullPivHouseholderQR > Base
 
typedef internal::plain_col_type< MatrixType >::type ColVectorType
 
typedef internal::plain_diag_type< MatrixType >::type HCoeffsType
 
typedef Matrix< StorageIndex, 1, EIGEN_SIZE_MIN_PREFER_DYNAMIC(ColsAtCompileTime, RowsAtCompileTime), RowMajor, 1, EIGEN_SIZE_MIN_PREFER_FIXED(MaxColsAtCompileTime, MaxRowsAtCompileTime)> IntDiagSizeVectorType
 
typedef internal::FullPivHouseholderQRMatrixQReturnType< MatrixType > MatrixQReturnType
 
typedef _MatrixType MatrixType
 
typedef PermutationMatrix< ColsAtCompileTime, MaxColsAtCompileTime > PermutationType
 
typedef MatrixType::PlainObject PlainObject
 
typedef internal::plain_row_type< MatrixType >::type RowVectorType
 

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
 
const PermutationType & colsPermutation () const
 
template<typename InputType >
FullPivHouseholderQR & compute (const EigenBase< InputType > &matrix)
 
template<typename InputType >
FullPivHouseholderQR< MatrixType > & compute (const EigenBase< InputType > &matrix)
 
Index dimensionOfKernel () const
 
 FullPivHouseholderQR ()
 Default Constructor. More...
 
template<typename InputType >
 FullPivHouseholderQR (const EigenBase< InputType > &matrix)
 Constructs a QR factorization from a given matrix. More...
 
template<typename InputType >
 FullPivHouseholderQR (EigenBase< InputType > &matrix)
 Constructs a QR factorization from a given matrix. More...
 
 FullPivHouseholderQR (Index rows, Index cols)
 Default Constructor with memory preallocation. More...
 
const HCoeffsType & hCoeffs () const
 
const Inverse< FullPivHouseholderQR > inverse () const
 
bool isInjective () const
 
bool isInvertible () const
 
bool isSurjective () const
 
MatrixType::RealScalar logAbsDeterminant () const
 
MatrixQReturnType matrixQ (void) const
 
const MatrixType & matrixQR () const
 
RealScalar maxPivot () const
 
Index nonzeroPivots () const
 
Index rank () const
 
Index rows () const
 
const IntDiagSizeVectorType & rowsTranspositions () const
 
FullPivHouseholderQR & setThreshold (const RealScalar &threshold)
 
FullPivHouseholderQR & setThreshold (Default_t)
 
RealScalar threshold () const
 

Protected Member Functions

void computeInPlace ()
 

Static Protected Member Functions

static void check_template_parameters ()
 

Protected Attributes

PermutationType m_cols_permutation
 
IntDiagSizeVectorType m_cols_transpositions
 
Index m_det_pq
 
HCoeffsType m_hCoeffs
 
bool m_isInitialized
 
RealScalar m_maxpivot
 
Index m_nonzero_pivots
 
RealScalar m_precision
 
RealScalar m_prescribedThreshold
 
MatrixType m_qr
 
IntDiagSizeVectorType m_rows_transpositions
 
RowVectorType m_temp
 
bool m_usePrescribedThreshold
 

Friends

class SolverBase< FullPivHouseholderQR >
 

Detailed Description

Householder rank-revealing QR decomposition of a matrix with full pivoting.

Template Parameters
_MatrixTypethe type of the matrix of which we are computing the QR decomposition

This class performs a rank-revealing QR decomposition of a matrix A into matrices P, P', Q and R such that

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

by using Householder transformations. Here, P and P' are permutation matrices, Q a unitary matrix and R an upper triangular matrix.

This decomposition performs a very prudent full pivoting in order to be rank-revealing and achieve optimal numerical stability. The trade-off is that it is slower than HouseholderQR and ColPivHouseholderQR.

This class supports the inplace decomposition mechanism.

See also
MatrixBase::fullPivHouseholderQr()

Definition at line 275 of file ForwardDeclarations.h.

Member Typedef Documentation

◆ Base

typedef SolverBase<FullPivHouseholderQR> Eigen::FullPivHouseholderQR::Base

Definition at line 66 of file FullPivHouseholderQR.h.

◆ ColVectorType

typedef internal::plain_col_type<MatrixType>::type Eigen::FullPivHouseholderQR::ColVectorType

Definition at line 81 of file FullPivHouseholderQR.h.

◆ HCoeffsType

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

Definition at line 75 of file FullPivHouseholderQR.h.

◆ IntDiagSizeVectorType

typedef Matrix<StorageIndex, 1, EIGEN_SIZE_MIN_PREFER_DYNAMIC(ColsAtCompileTime,RowsAtCompileTime), RowMajor, 1, EIGEN_SIZE_MIN_PREFER_FIXED(MaxColsAtCompileTime,MaxRowsAtCompileTime)> Eigen::FullPivHouseholderQR::IntDiagSizeVectorType

Definition at line 78 of file FullPivHouseholderQR.h.

◆ MatrixQReturnType

typedef internal::FullPivHouseholderQRMatrixQReturnType<MatrixType> Eigen::FullPivHouseholderQR::MatrixQReturnType

Definition at line 74 of file FullPivHouseholderQR.h.

◆ MatrixType

typedef _MatrixType Eigen::FullPivHouseholderQR::MatrixType

Definition at line 65 of file FullPivHouseholderQR.h.

◆ PermutationType

typedef PermutationMatrix<ColsAtCompileTime, MaxColsAtCompileTime> Eigen::FullPivHouseholderQR::PermutationType

Definition at line 79 of file FullPivHouseholderQR.h.

◆ PlainObject

typedef MatrixType::PlainObject Eigen::FullPivHouseholderQR::PlainObject

Definition at line 82 of file FullPivHouseholderQR.h.

◆ RowVectorType

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

Definition at line 80 of file FullPivHouseholderQR.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
MaxRowsAtCompileTime 
MaxColsAtCompileTime 

Definition at line 70 of file FullPivHouseholderQR.h.

Constructor & Destructor Documentation

◆ FullPivHouseholderQR() [1/4]

Eigen::FullPivHouseholderQR::FullPivHouseholderQR ( )
inline

Default Constructor.

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

Definition at line 89 of file FullPivHouseholderQR.h.

◆ FullPivHouseholderQR() [2/4]

Eigen::FullPivHouseholderQR::FullPivHouseholderQR ( 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
FullPivHouseholderQR()

Definition at line 105 of file FullPivHouseholderQR.h.

◆ FullPivHouseholderQR() [3/4]

template<typename InputType >
Eigen::FullPivHouseholderQR::FullPivHouseholderQR ( 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:

FullPivHouseholderQR<MatrixType> qr(matrix.rows(), matrix.cols());
qr.compute(matrix);
See also
compute()

Definition at line 128 of file FullPivHouseholderQR.h.

◆ FullPivHouseholderQR() [4/4]

template<typename InputType >
Eigen::FullPivHouseholderQR::FullPivHouseholderQR ( 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
FullPivHouseholderQR(const EigenBase&)

Definition at line 148 of file FullPivHouseholderQR.h.

Member Function Documentation

◆ _solve_impl()

template<typename RhsType , typename DstType >
void Eigen::FullPivHouseholderQR::_solve_impl ( const RhsType &  rhs,
DstType &  dst 
) const

Definition at line 544 of file FullPivHouseholderQR.h.

◆ _solve_impl_transposed()

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

Definition at line 578 of file FullPivHouseholderQR.h.

◆ absDeterminant()

MatrixType::RealScalar Eigen::FullPivHouseholderQR::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 427 of file FullPivHouseholderQR.h.

◆ check_template_parameters()

static void Eigen::FullPivHouseholderQR::check_template_parameters ( )
inlinestaticprotected

Definition at line 406 of file FullPivHouseholderQR.h.

◆ cols()

Index Eigen::FullPivHouseholderQR::cols ( ) const
inline

Definition at line 319 of file FullPivHouseholderQR.h.

◆ colsPermutation()

const PermutationType& Eigen::FullPivHouseholderQR::colsPermutation ( ) const
inline
Returns
a const reference to the column permutation matrix

Definition at line 198 of file FullPivHouseholderQR.h.

◆ compute() [1/2]

template<typename InputType >
FullPivHouseholderQR& Eigen::FullPivHouseholderQR::compute ( const EigenBase< InputType > &  matrix)

◆ compute() [2/2]

template<typename InputType >
FullPivHouseholderQR<MatrixType>& Eigen::FullPivHouseholderQR::compute ( const EigenBase< InputType > &  matrix)

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 FullPivHouseholderQR, FullPivHouseholderQR(const MatrixType&)

Definition at line 451 of file FullPivHouseholderQR.h.

◆ computeInPlace()

void Eigen::FullPivHouseholderQR::computeInPlace ( )
protected

Definition at line 459 of file FullPivHouseholderQR.h.

◆ dimensionOfKernel()

Index Eigen::FullPivHouseholderQR::dimensionOfKernel ( ) const
inline
Returns
the dimension of the kernel of the matrix of which *this is the QR decomposition.
Note
This method has to determine which pivots should be considered nonzero. For that, it uses the threshold value that you can control by calling setThreshold(const RealScalar&).

Definition at line 263 of file FullPivHouseholderQR.h.

◆ hCoeffs()

const HCoeffsType& Eigen::FullPivHouseholderQR::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 325 of file FullPivHouseholderQR.h.

◆ inverse()

const Inverse<FullPivHouseholderQR> Eigen::FullPivHouseholderQR::inverse ( ) const
inline
Returns
the inverse of the matrix of which *this is the QR decomposition.
Note
If this matrix is not invertible, the returned matrix has undefined coefficients. Use isInvertible() to first determine whether this matrix is invertible.

Definition at line 312 of file FullPivHouseholderQR.h.

◆ isInjective()

bool Eigen::FullPivHouseholderQR::isInjective ( ) const
inline
Returns
true if the matrix of which *this is the QR decomposition represents an injective linear map, i.e. has trivial kernel; false otherwise.
Note
This method has to determine which pivots should be considered nonzero. For that, it uses the threshold value that you can control by calling setThreshold(const RealScalar&).

Definition at line 276 of file FullPivHouseholderQR.h.

◆ isInvertible()

bool Eigen::FullPivHouseholderQR::isInvertible ( ) const
inline
Returns
true if the matrix of which *this is the QR decomposition is invertible.
Note
This method has to determine which pivots should be considered nonzero. For that, it uses the threshold value that you can control by calling setThreshold(const RealScalar&).

Definition at line 301 of file FullPivHouseholderQR.h.

◆ isSurjective()

bool Eigen::FullPivHouseholderQR::isSurjective ( ) const
inline
Returns
true if the matrix of which *this is the QR decomposition represents a surjective linear map; false otherwise.
Note
This method has to determine which pivots should be considered nonzero. For that, it uses the threshold value that you can control by calling setThreshold(const RealScalar&).

Definition at line 289 of file FullPivHouseholderQR.h.

◆ logAbsDeterminant()

MatrixType::RealScalar Eigen::FullPivHouseholderQR::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 436 of file FullPivHouseholderQR.h.

◆ matrixQ()

FullPivHouseholderQR< MatrixType >::MatrixQReturnType Eigen::FullPivHouseholderQR::matrixQ ( void  ) const
inline
Returns
Expression object representing the matrix Q

Definition at line 694 of file FullPivHouseholderQR.h.

◆ matrixQR()

const MatrixType& Eigen::FullPivHouseholderQR::matrixQR ( ) const
inline
Returns
a reference to the matrix where the Householder QR decomposition is stored

Definition at line 188 of file FullPivHouseholderQR.h.

◆ maxPivot()

RealScalar Eigen::FullPivHouseholderQR::maxPivot ( ) const
inline
Returns
the absolute value of the biggest pivot, i.e. the biggest diagonal coefficient of U.

Definition at line 394 of file FullPivHouseholderQR.h.

◆ nonzeroPivots()

Index Eigen::FullPivHouseholderQR::nonzeroPivots ( ) const
inline
Returns
the number of nonzero pivots in the QR decomposition. Here nonzero is meant in the exact sense, not in a fuzzy sense. So that notion isn't really intrinsically interesting, but it is still useful when implementing algorithms.
See also
rank()

Definition at line 385 of file FullPivHouseholderQR.h.

◆ rank()

Index Eigen::FullPivHouseholderQR::rank ( ) const
inline
Returns
the rank of the matrix of which *this is the QR decomposition.
Note
This method has to determine which pivots should be considered nonzero. For that, it uses the threshold value that you can control by calling setThreshold(const RealScalar&).

Definition at line 246 of file FullPivHouseholderQR.h.

◆ rows()

Index Eigen::FullPivHouseholderQR::rows ( ) const
inline

Definition at line 318 of file FullPivHouseholderQR.h.

◆ rowsTranspositions()

const IntDiagSizeVectorType& Eigen::FullPivHouseholderQR::rowsTranspositions ( ) const
inline
Returns
a const reference to the vector of indices representing the rows transpositions

Definition at line 205 of file FullPivHouseholderQR.h.

◆ setThreshold() [1/2]

FullPivHouseholderQR& Eigen::FullPivHouseholderQR::setThreshold ( const RealScalar &  threshold)
inline

Allows to prescribe a threshold to be used by certain methods, such as rank(), who need to determine when pivots are to be considered nonzero. This is not used for the QR decomposition itself.

When it needs to get the threshold value, Eigen calls threshold(). By default, this uses a formula to automatically determine a reasonable threshold. Once you have called the present method setThreshold(const RealScalar&), your value is used instead.

Parameters
thresholdThe new value to use as the threshold.

A pivot will be considered nonzero if its absolute value is strictly greater than $ \vert pivot \vert \leqslant threshold \times \vert maxpivot \vert $ where maxpivot is the biggest pivot.

If you want to come back to the default behavior, call setThreshold(Default_t)

Definition at line 344 of file FullPivHouseholderQR.h.

◆ setThreshold() [2/2]

FullPivHouseholderQR& Eigen::FullPivHouseholderQR::setThreshold ( Default_t  )
inline

Allows to come back to the default behavior, letting Eigen use its default formula for determining the threshold.

You should pass the special object Eigen::Default as parameter here.

qr.setThreshold(Eigen::Default);

See the documentation of setThreshold(const RealScalar&).

Definition at line 359 of file FullPivHouseholderQR.h.

◆ threshold()

RealScalar Eigen::FullPivHouseholderQR::threshold ( ) const
inline

Returns the threshold that will be used by certain methods such as rank().

See the documentation of setThreshold(const RealScalar&).

Definition at line 369 of file FullPivHouseholderQR.h.

Friends And Related Function Documentation

◆ SolverBase< FullPivHouseholderQR >

friend class SolverBase< FullPivHouseholderQR >
friend

Definition at line 67 of file FullPivHouseholderQR.h.

Member Data Documentation

◆ m_cols_permutation

PermutationType Eigen::FullPivHouseholderQR::m_cols_permutation
protected

Definition at line 417 of file FullPivHouseholderQR.h.

◆ m_cols_transpositions

IntDiagSizeVectorType Eigen::FullPivHouseholderQR::m_cols_transpositions
protected

Definition at line 416 of file FullPivHouseholderQR.h.

◆ m_det_pq

Index Eigen::FullPivHouseholderQR::m_det_pq
protected

Definition at line 423 of file FullPivHouseholderQR.h.

◆ m_hCoeffs

HCoeffsType Eigen::FullPivHouseholderQR::m_hCoeffs
protected

Definition at line 414 of file FullPivHouseholderQR.h.

◆ m_isInitialized

bool Eigen::FullPivHouseholderQR::m_isInitialized
protected

Definition at line 419 of file FullPivHouseholderQR.h.

◆ m_maxpivot

RealScalar Eigen::FullPivHouseholderQR::m_maxpivot
protected

Definition at line 420 of file FullPivHouseholderQR.h.

◆ m_nonzero_pivots

Index Eigen::FullPivHouseholderQR::m_nonzero_pivots
protected

Definition at line 421 of file FullPivHouseholderQR.h.

◆ m_precision

RealScalar Eigen::FullPivHouseholderQR::m_precision
protected

Definition at line 422 of file FullPivHouseholderQR.h.

◆ m_prescribedThreshold

RealScalar Eigen::FullPivHouseholderQR::m_prescribedThreshold
protected

Definition at line 420 of file FullPivHouseholderQR.h.

◆ m_qr

MatrixType Eigen::FullPivHouseholderQR::m_qr
protected

Definition at line 413 of file FullPivHouseholderQR.h.

◆ m_rows_transpositions

IntDiagSizeVectorType Eigen::FullPivHouseholderQR::m_rows_transpositions
protected

Definition at line 415 of file FullPivHouseholderQR.h.

◆ m_temp

RowVectorType Eigen::FullPivHouseholderQR::m_temp
protected

Definition at line 418 of file FullPivHouseholderQR.h.

◆ m_usePrescribedThreshold

bool Eigen::FullPivHouseholderQR::m_usePrescribedThreshold
protected

Definition at line 419 of file FullPivHouseholderQR.h.

The documentation for this class was generated from the following files:
matrix
Map< Matrix< T, Dynamic, Dynamic, ColMajor >, 0, OuterStride<> > matrix(T *data, int rows, int cols, int stride)
Definition: gtsam/3rdparty/Eigen/blas/common.h:110
qr
HouseholderQR< MatrixXf > qr(A)
Eigen::Default
@ Default
Definition: Constants.h:362

gtsam
Author(s):
autogenerated on Sat Jun 1 2024 03:09:33