A general Cholesky factorization and solver based on Cholmod. More...

#include <CholmodSupport.h>

Inheritance diagram for Eigen::CholmodDecomposition< _MatrixType, _UpLo >:

Collaboration diagram for Eigen::CholmodDecomposition< _MatrixType, _UpLo >:

Public Types
typedef _MatrixType	MatrixType

Public Types inherited from Eigen::CholmodBase< _MatrixType, _UpLo, CholmodDecomposition< _MatrixType, _UpLo > >
enum

typedef _MatrixType	MatrixType

typedef MatrixType::Scalar	Scalar

typedef MatrixType::RealScalar	RealScalar

typedef MatrixType	CholMatrixType

typedef MatrixType::Index	Index

Public Member Functions
	CholmodDecomposition (const MatrixType &matrix)

void	setMode (CholmodMode mode)

Public Member Functions inherited from Eigen::CholmodBase< _MatrixType, _UpLo, CholmodDecomposition< _MatrixType, _UpLo > >
	CholmodBase (const MatrixType &matrix)

Index	cols () const

Index	rows () const

CholmodDecomposition< _MatrixType, _UpLo > &	derived ()

const CholmodDecomposition< _MatrixType, _UpLo > &	derived () const

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

CholmodDecomposition< _MatrixType, _UpLo > &	compute (const MatrixType &matrix)

const internal::solve_retval< CholmodBase, Rhs >	solve (const MatrixBase< Rhs > &b) const

const internal::sparse_solve_retval< CholmodBase, Rhs >	solve (const SparseMatrixBase< Rhs > &b) const

void	analyzePattern (const MatrixType &matrix)

void	factorize (const MatrixType &matrix)

cholmod_common &	cholmod ()

void	_solve (const MatrixBase< Rhs > &b, MatrixBase< Dest > &dest) const

void	_solve (const SparseMatrix< RhsScalar, RhsOptions, RhsIndex > &b, SparseMatrix< DestScalar, DestOptions, DestIndex > &dest) const

CholmodDecomposition< _MatrixType, _UpLo > &	setShift (const RealScalar &offset)

void	dumpMemory (Stream &)

Protected Member Functions
void	init ()

Additional Inherited Members
Protected Attributes inherited from Eigen::CholmodBase< _MatrixType, _UpLo, CholmodDecomposition< _MatrixType, _UpLo > >
cholmod_common	m_cholmod

cholmod_factor *	m_cholmodFactor

RealScalar	m_shiftOffset [2]

ComputationInfo	m_info

bool	m_isInitialized

int	m_factorizationIsOk

int	m_analysisIsOk

Detailed Description

template<typename _MatrixType, int _UpLo = Lower>
class Eigen::CholmodDecomposition< _MatrixType, _UpLo >

A general Cholesky factorization and solver based on Cholmod.

This class allows to solve for A.X = B sparse linear problems via a LL^T or LDL^T Cholesky factorization using the Cholmod library. The sparse matrix A must be selfajoint and positive definite. The vectors or matrices X and B can be either dense or sparse.

This variant permits to change the underlying Cholesky method at runtime. On the other hand, it does not provide access to the result of the factorization. The default is to let Cholmod automatically choose between a simplicial and supernodal factorization.

Template Parameters

_MatrixType	the type of the sparse matrix A, it must be a SparseMatrix<>
_UpLo	the triangular part that will be used for the computations. It can be Lower or Upper. Default is Lower.

This class supports all kind of SparseMatrix<>: row or column major; upper, lower, or both; compressed or non compressed.

See also: TutorialSparseDirectSolvers

Definition at line 520 of file CholmodSupport.h.

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

C:/Users/Brig/Documents/ShapeWorksStudio/src/Surfworks/Eigen/src/CholmodSupport/CholmodSupport.h

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

template<typename _MatrixType, int _UpLo = Lower> class Eigen::CholmodDecomposition< _MatrixType, _UpLo >

template<typename _MatrixType, int _UpLo = Lower>
class Eigen::CholmodDecomposition< _MatrixType, _UpLo >