Eigen::SparseLLT< _MatrixType, Cholmod > Class Template Reference

---

Detailed Description

template<typename _MatrixType>
class Eigen::SparseLLT< _MatrixType, Cholmod >

Definition at line 126 of file CholmodSupport.

Inheritance diagram for Eigen::SparseLLT< _MatrixType, Cholmod >:

List of all members.

Public Types
typedef _MatrixType	MatrixType
typedef MatrixType::Index	Index
Public Member Functions
	SparseLLT (int flags=0)
	Creates a dummy LLT factorization object with flags flags.
	SparseLLT (const MatrixType &matrix, int flags=0)
	Creates a LLT object and compute the respective factorization of matrix using flags flags.
	~SparseLLT ()
const CholMatrixType &	matrixL () const
template<typename Derived >
bool	solveInPlace (MatrixBase< Derived > &b) const
template<typename Rhs >
const internal::solve_retval < SparseLLT< MatrixType, Cholmod >, Rhs >	solve (const MatrixBase< Rhs > &b) const
void	compute (const MatrixType &matrix)
	Computes/re-computes the LLT factorization.
Index	cols () const
Index	rows () const
const cholmod_factor *	cholmodFactor () const
cholmod_common *	cholmodCommon () const
bool	succeeded () const
void	setPrecision (RealScalar v)
	Sets the relative threshold value used to prune zero coefficients during the decomposition.
RealScalar	precision () const
void	setFlags (int f)
	Sets the flags.
int	flags () const
Protected Types
typedef SparseLLT< _MatrixType >	Base
typedef Base::Scalar	Scalar
typedef Base::RealScalar	RealScalar
typedef Base::CholMatrixType	CholMatrixType
enum
Protected Attributes
cholmod_common	m_cholmod
cholmod_factor *	m_cholmodFactor
CholMatrixType	m_matrix
RealScalar	m_precision
int	m_flags
int	m_status
bool	m_succeeded

---

Member Typedef Documentation

template<typename _MatrixType >

typedef SparseLLT<_MatrixType> Eigen::SparseLLT< _MatrixType, Cholmod >::Base [protected]

Definition at line 129 of file CholmodSupport.

template<typename _MatrixType >

typedef Base::CholMatrixType Eigen::SparseLLT< _MatrixType, Cholmod >::CholMatrixType [protected]

Reimplemented from Eigen::SparseLLT< _MatrixType >.

Definition at line 132 of file CholmodSupport.

template<typename _MatrixType >

typedef MatrixType::Index Eigen::SparseLLT< _MatrixType, Cholmod >::Index

Reimplemented from Eigen::SparseLLT< _MatrixType >.

Definition at line 141 of file CholmodSupport.

template<typename _MatrixType >

typedef _MatrixType Eigen::SparseLLT< _MatrixType, Cholmod >::MatrixType

Reimplemented from Eigen::SparseLLT< _MatrixType >.

Definition at line 140 of file CholmodSupport.

template<typename _MatrixType >

typedef Base::RealScalar Eigen::SparseLLT< _MatrixType, Cholmod >::RealScalar [protected]

Reimplemented from Eigen::SparseLLT< _MatrixType >.

Definition at line 131 of file CholmodSupport.

template<typename _MatrixType >

typedef Base::Scalar Eigen::SparseLLT< _MatrixType, Cholmod >::Scalar [protected]

Reimplemented from Eigen::SparseLLT< _MatrixType >.

Definition at line 130 of file CholmodSupport.

---

Member Enumeration Documentation

anonymous enum [protected, inherited]

Definition at line 46 of file SparseExtra.

---

Constructor & Destructor Documentation

template<typename _MatrixType >

Eigen::SparseLLT< _MatrixType, Cholmod >::SparseLLT

(

int

flags = 0

)

[inline]

Creates a dummy LLT factorization object with flags flags.

Reimplemented from Eigen::SparseLLT< _MatrixType >.

Definition at line 143 of file CholmodSupport.

template<typename _MatrixType >

Eigen::SparseLLT< _MatrixType, Cholmod >::SparseLLT	(	const MatrixType &	matrix,
		int	flags = 0
	)		[inline]

Creates a LLT object and compute the respective factorization of matrix using flags flags.

Reimplemented from Eigen::SparseLLT< _MatrixType >.

Definition at line 149 of file CholmodSupport.

template<typename _MatrixType >

Eigen::SparseLLT< _MatrixType, Cholmod >::~SparseLLT

(

)

[inline]

Definition at line 156 of file CholmodSupport.

---

Member Function Documentation

template<typename _MatrixType >

cholmod_common* Eigen::SparseLLT< _MatrixType, Cholmod >::cholmodCommon

(

)

const [inline]

Definition at line 184 of file CholmodSupport.

template<typename _MatrixType >

const cholmod_factor* Eigen::SparseLLT< _MatrixType, Cholmod >::cholmodFactor

(

)

const [inline]

Definition at line 181 of file CholmodSupport.

template<typename _MatrixType >

Index Eigen::SparseLLT< _MatrixType, Cholmod >::cols

(

void

)

const [inline]

Reimplemented from Eigen::SparseLLT< _MatrixType >.

Definition at line 178 of file CholmodSupport.

template<typename _MatrixType >

void Eigen::SparseLLT< _MatrixType, Cholmod >::compute

(

const MatrixType &

matrix

)

Computes/re-computes the LLT factorization.

Reimplemented from Eigen::SparseLLT< _MatrixType >.

Definition at line 233 of file CholmodSupport.

int Eigen::SparseLLT< _MatrixType, DefaultBackend >::flags

(

)

const [inline, inherited]

Returns:

the current flags

Definition at line 104 of file SparseExtra.

template<typename _MatrixType >

const SparseLLT< _MatrixType, Cholmod >::CholMatrixType & Eigen::SparseLLT< _MatrixType, Cholmod >::matrixL

(

void

)

const [inline]

Returns:

the lower triangular matrix L

Reimplemented from Eigen::SparseLLT< _MatrixType >.

Definition at line 273 of file CholmodSupport.

RealScalar Eigen::SparseLLT< _MatrixType, DefaultBackend >::precision

(

)

const [inline, inherited]

Returns:

the current precision.

See also:

setPrecision()

Definition at line 90 of file SparseExtra.

template<typename _MatrixType >

Index Eigen::SparseLLT< _MatrixType, Cholmod >::rows

(

void

)

const [inline]

Reimplemented from Eigen::SparseLLT< _MatrixType >.

Definition at line 179 of file CholmodSupport.

void Eigen::SparseLLT< _MatrixType, DefaultBackend >::setFlags

(

int

f

)

[inline, inherited]

Sets the flags.

Possible values are:

• CompleteFactorization
• IncompleteFactorization
• MemoryEfficient (hint to use the memory most efficient method offered by the backend)
• SupernodalMultifrontal (implies a complete factorization if supported by the backend, overloads the MemoryEfficient flags)
• SupernodalLeftLooking (implies a complete factorization if supported by the backend, overloads the MemoryEfficient flags)

See also:

Flags

Definition at line 102 of file SparseExtra.

void Eigen::SparseLLT< _MatrixType, DefaultBackend >::setPrecision

(

RealScalar

v

)

[inline, inherited]

Sets the relative threshold value used to prune zero coefficients during the decomposition.

Setting a value greater than zero speeds up computation, and yields to an imcomplete factorization with fewer non zero coefficients. Such approximate factors are especially useful to initialize an iterative solver.

Warning:

if precision is greater that zero, the LLT factorization is not guaranteed to succeed even if the matrix is positive definite.

Note that the exact meaning of this parameter might depends on the actual backend. Moreover, not all backends support this feature.

See also:

precision()

Definition at line 85 of file SparseExtra.

template<typename _MatrixType >

template<typename Rhs >

const internal::solve_retval<SparseLLT<MatrixType, Cholmod>, Rhs> Eigen::SparseLLT< _MatrixType, Cholmod >::solve

(

const MatrixBase< Rhs > &

b

)

const [inline]

Reimplemented from Eigen::SparseLLT< _MatrixType >.

Definition at line 170 of file CholmodSupport.

template<typename _MatrixType >

template<typename Derived >

bool Eigen::SparseLLT< _MatrixType, Cholmod >::solveInPlace

(

MatrixBase< Derived > &

b

)

const

Reimplemented from Eigen::SparseLLT< _MatrixType >.

Definition at line 294 of file CholmodSupport.

template<typename _MatrixType >

bool Eigen::SparseLLT< _MatrixType, Cholmod >::succeeded

(

void

)

const

Returns:

true if the factorization succeeded

Reimplemented from Eigen::SparseLLT< _MatrixType >.

Definition at line 266 of file CholmodSupport.

---

Member Data Documentation

template<typename _MatrixType >

cholmod_common Eigen::SparseLLT< _MatrixType, Cholmod >::m_cholmod [mutable, protected]

Definition at line 190 of file CholmodSupport.

template<typename _MatrixType >

cholmod_factor* Eigen::SparseLLT< _MatrixType, Cholmod >::m_cholmodFactor [protected]

Definition at line 191 of file CholmodSupport.

int Eigen::SparseLLT< _MatrixType, DefaultBackend >::m_flags [protected, inherited]

Definition at line 132 of file SparseExtra.

CholMatrixType Eigen::SparseLLT< _MatrixType, DefaultBackend >::m_matrix [protected, inherited]

Definition at line 130 of file SparseExtra.

RealScalar Eigen::SparseLLT< _MatrixType, DefaultBackend >::m_precision [protected, inherited]

Definition at line 131 of file SparseExtra.

int Eigen::SparseLLT< _MatrixType, DefaultBackend >::m_status [mutable, protected, inherited]

Definition at line 133 of file SparseExtra.

bool Eigen::SparseLLT< _MatrixType, DefaultBackend >::m_succeeded [protected, inherited]

Definition at line 134 of file SparseExtra.