A base class for direct sparse Cholesky factorizations. More...

#include <SimplicialCholesky.h>

Inheritance diagram for Eigen::SimplicialCholeskyBase< Derived >:

Classes
struct	keep_diag

Public Types
enum	{ UpLo = internal::traits<Derived>::UpLo }

enum	{ ColsAtCompileTime = MatrixType::ColsAtCompileTime, MaxColsAtCompileTime = MatrixType::MaxColsAtCompileTime }

typedef internal::traits< Derived >::MatrixType	MatrixType

typedef internal::traits< Derived >::OrderingType	OrderingType

typedef MatrixType::Scalar	Scalar

typedef MatrixType::RealScalar	RealScalar

typedef MatrixType::StorageIndex	StorageIndex

typedef SparseMatrix< Scalar, ColMajor, StorageIndex >	CholMatrixType

typedef CholMatrixType const *	ConstCholMatrixPtr

typedef Matrix< Scalar, Dynamic, 1 >	VectorType

typedef Matrix< StorageIndex, Dynamic, 1 >	VectorI

Public Member Functions
	SimplicialCholeskyBase ()

	SimplicialCholeskyBase (const MatrixType &matrix)

Derived &	derived ()

const Derived &	derived () const

Index	cols () const

Index	rows () const

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

const PermutationMatrix< Dynamic, Dynamic, StorageIndex > &	permutationP () const

const PermutationMatrix< Dynamic, Dynamic, StorageIndex > &	permutationPinv () const

Derived &	setShift (const RealScalar &offset, const RealScalar &scale=1)

template<typename Stream >
void	dumpMemory (Stream &s)

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

template<typename Rhs , typename Dest >
void	_solve_impl (const SparseMatrixBase< Rhs > &b, SparseMatrixBase< Dest > &dest) const

Derived &	derived ()

const Derived &	derived () const

Public Member Functions inherited from Eigen::SparseSolverBase< Derived >
	SparseSolverBase ()

Derived &	derived ()

const Derived &	derived () const

template<typename Rhs >
const Solve< Derived, Rhs >	solve (const MatrixBase< Rhs > &b) const

template<typename Rhs >
const Solve< Derived, Rhs >	solve (const SparseMatrixBase< Rhs > &b) const

template<typename Rhs , typename Dest >
void	_solve_impl (const SparseMatrixBase< Rhs > &b, SparseMatrixBase< Dest > &dest) const

Protected Member Functions
template<bool DoLDLT>
void	compute (const MatrixType &matrix)

template<bool DoLDLT>
void	factorize (const MatrixType &a)

template<bool DoLDLT>
void	factorize_preordered (const CholMatrixType &a)

void	analyzePattern (const MatrixType &a, bool doLDLT)

void	analyzePattern_preordered (const CholMatrixType &a, bool doLDLT)

void	ordering (const MatrixType &a, ConstCholMatrixPtr &pmat, CholMatrixType &ap)

Protected Attributes
ComputationInfo	m_info

bool	m_factorizationIsOk

bool	m_analysisIsOk

CholMatrixType	m_matrix

VectorType	m_diag

VectorI	m_parent

VectorI	m_nonZerosPerCol

PermutationMatrix< Dynamic, Dynamic, StorageIndex >	m_P

PermutationMatrix< Dynamic, Dynamic, StorageIndex >	m_Pinv

RealScalar	m_shiftOffset

RealScalar	m_shiftScale

Protected Attributes inherited from Eigen::SparseSolverBase< Derived >
bool	m_isInitialized

Detailed Description

template<typename Derived>
class Eigen::SimplicialCholeskyBase< Derived >

A base class for direct sparse Cholesky factorizations.

This is a base class for LL^T and LDL^T Cholesky factorizations of sparse matrices that are selfadjoint and positive definite. These factorizations allow for solving A.X = B where X and B can be either dense or sparse.

In order to reduce the fill-in, a symmetric permutation P is applied prior to the factorization such that the factorized matrix is P A P^-1.

Template Parameters

Derived the type of the derived class, that is the actual factorization type.

Constructor & Destructor Documentation

◆ SimplicialCholeskyBase()

template<typename Derived >

Eigen::SimplicialCholeskyBase< Derived >::SimplicialCholeskyBase ( )

inline

Default constructor

Member Function Documentation

◆ compute()

template<typename Derived >

template<bool DoLDLT>

void Eigen::SimplicialCholeskyBase< Derived >::compute ( const MatrixType & matrix )

inlineprotected

Computes the sparse Cholesky decomposition of matrix

◆ info()

template<typename Derived >

ComputationInfo Eigen::SimplicialCholeskyBase< Derived >::info ( ) const

inline

Reports whether previous computation was successful.

Returns: Success if computation was successful, NumericalIssue if the matrix.appears to be negative.

◆ permutationP()

template<typename Derived >

const PermutationMatrix<Dynamic,Dynamic,StorageIndex>& Eigen::SimplicialCholeskyBase< Derived >::permutationP ( ) const

inline

Returns: the permutation P

See also: permutationPinv()

◆ permutationPinv()

template<typename Derived >

const PermutationMatrix<Dynamic,Dynamic,StorageIndex>& Eigen::SimplicialCholeskyBase< Derived >::permutationPinv ( ) const

inline

Returns: the inverse P^-1 of the permutation P

See also: permutationP()

◆ setShift()

template<typename Derived >

Derived& Eigen::SimplicialCholeskyBase< Derived >::setShift	(	const RealScalar &	offset,
		const RealScalar &	scale = `1`
	)

inline

Sets the shift parameters that will be used to adjust the diagonal coefficients during the numerical factorization.

During the numerical factorization, the diagonal coefficients are transformed by the following linear model:
d_ii = offset + scale * d_ii

The default is the identity transformation with offset=0, and scale=1.

Returns: a reference to *this.

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

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

template<typename Derived> class Eigen::SimplicialCholeskyBase< Derived >

Constructor & Destructor Documentation

◆ SimplicialCholeskyBase()

Member Function Documentation

◆ compute()

◆ info()

◆ permutationP()

◆ permutationPinv()

◆ setShift()

template<typename Derived>
class Eigen::SimplicialCholeskyBase< Derived >