Eigen  3.3.4
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Eigen::SPQR< MatrixType > Class Template Reference

Detailed Description

template<typename MatrixType>
class Eigen::SPQR< MatrixType >

Sparse QR factorization based on SuiteSparseQR library.

This class is used to perform a multithreaded and multifrontal rank-revealing QR decomposition of sparse matrices. The result is then used to solve linear leasts_square systems. Clearly, a QR factorization is returned such that A*P = Q*R where :

P is the column permutation. Use colsPermutation() to get it.

Q is the orthogonal matrix represented as Householder reflectors. Use matrixQ() to get an expression and matrixQ().transpose() to get the transpose. You can then apply it to a vector.

R is the sparse triangular factor. Use matrixQR() to get it as SparseMatrix. NOTE : The Index type of R is always SuiteSparse_long. You can get it with SPQR::Index

Template Parameters
_MatrixTypeThe type of the sparse matrix A, must be a column-major SparseMatrix<>

This class follows the sparse solver concept .

+ Inheritance diagram for Eigen::SPQR< MatrixType >:

Public Member Functions

cholmod_common * cholmodCommon () const
 
Index cols () const
 
PermutationType colsPermutation () const
 Get the permutation that was applied to columns of A.
 
ComputationInfo info () const
 Reports whether previous computation was successful. More...
 
SPQRMatrixQReturnType< SPQRmatrixQ () const
 Get an expression of the matrix Q.
 
const MatrixType matrixR () const
 
Index rank () const
 
Index rows () const
 
void setPivotThreshold (const RealScalar &tol)
 Set the tolerance tol to treat columns with 2-norm < =tol as zero.
 
void setSPQROrdering (int ord)
 Set the fill-reducing ordering method to be used.
 
- Public Member Functions inherited from Eigen::SparseSolverBase< SPQR< _MatrixType > >
const Solve< SPQR< _MatrixType >
, Rhs > 
solve (const MatrixBase< Rhs > &b) const
 
const Solve< SPQR< _MatrixType >
, Rhs > 
solve (const SparseMatrixBase< Rhs > &b) const
 
 SparseSolverBase ()
 

Member Function Documentation

template<typename MatrixType >
cholmod_common* Eigen::SPQR< MatrixType >::cholmodCommon ( ) const
inline
Returns
a pointer to the SPQR workspace
template<typename MatrixType >
Index Eigen::SPQR< MatrixType >::cols ( void  ) const
inline

Get the number of columns of the input matrix.

template<typename MatrixType >
ComputationInfo Eigen::SPQR< MatrixType >::info ( ) const
inline

Reports whether previous computation was successful.

Returns
Success if computation was succesful, NumericalIssue if the sparse QR can not be computed
template<typename MatrixType >
const MatrixType Eigen::SPQR< MatrixType >::matrixR ( ) const
inline
Returns
the sparse triangular factor R. It is a sparse matrix
template<typename MatrixType >
Index Eigen::SPQR< MatrixType >::rank ( ) const
inline

Gets the rank of the matrix. It should be equal to matrixQR().cols if the matrix is full-rank

template<typename MatrixType >
Index Eigen::SPQR< MatrixType >::rows ( void  ) const
inline

Get the number of rows of the input matrix and the Q matrix


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