Sparse QR factorization based on SuiteSparseQR library. More...

#include <SuiteSparseQRSupport.h>

Inheritance diagram for Eigen::SPQR< _MatrixType >:

Public Types
enum	{ ColsAtCompileTime = Dynamic, MaxColsAtCompileTime = Dynamic }

typedef SparseMatrix< Scalar, ColMajor, StorageIndex >	MatrixType

typedef Map< PermutationMatrix< Dynamic, Dynamic, StorageIndex > >	PermutationType

typedef _MatrixType::RealScalar	RealScalar

typedef _MatrixType::Scalar	Scalar

typedef SuiteSparse_long	StorageIndex

Public Member Functions
template<typename Rhs , typename Dest >
void	_solve_impl (const MatrixBase< Rhs > &b, MatrixBase< Dest > &dest) const

cholmod_common *	cholmodCommon () const

Index	cols () const

PermutationType	colsPermutation () const
	Get the permutation that was applied to columns of A. More...

void	compute (const _MatrixType &matrix)

ComputationInfo	info () const
	Reports whether previous computation was successful. More...

SPQRMatrixQReturnType< SPQR >	matrixQ () const
	Get an expression of the matrix Q. More...

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. More...

void	setSPQROrdering (int ord)
	Set the fill-reducing ordering method to be used. More...

	SPQR ()

	SPQR (const _MatrixType &matrix)

void	SPQR_free ()

	~SPQR ()

Public Member Functions inherited from Eigen::SparseSolverBase< SPQR< _MatrixType > >
void	_solve_impl (const SparseMatrixBase< Rhs > &b, SparseMatrixBase< Dest > &dest) const

SPQR< _MatrixType > &	derived ()

const SPQR< _MatrixType > &	derived () const

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

const Solve< SPQR< _MatrixType >, Rhs >	solve (const SparseMatrixBase< Rhs > &b) const

	SparseSolverBase ()

	~SparseSolverBase ()

Protected Types
typedef SparseSolverBase< SPQR< _MatrixType > >	Base

Protected Attributes
int	m_allow_tol

bool	m_analysisIsOk

cholmod_common	m_cc

cholmod_sparse *	m_cR

StorageIndex *	m_E

bool	m_factorizationIsOk

cholmod_sparse *	m_H

StorageIndex *	m_HPinv

cholmod_dense *	m_HTau

ComputationInfo	m_info

bool	m_isRUpToDate

int	m_ordering

MatrixType	m_R

Index	m_rank

Index	m_rows

RealScalar	m_tolerance

bool	m_useDefaultThreshold

Protected Attributes inherited from Eigen::SparseSolverBase< SPQR< _MatrixType > >
bool	m_isInitialized

Friends
template<typename , typename >
struct	SPQR_QProduct

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

_MatrixType The type of the sparse matrix A, must be a column-major SparseMatrix<>

Definition at line 16 of file SuiteSparseQRSupport.h.