Public Types | Public Member Functions | Protected Member Functions | Private Types
Eigen::CholmodDecomposition< _MatrixType, _UpLo > Class Template Reference

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

#include <CholmodSupport.h>

Inheritance diagram for Eigen::CholmodDecomposition< _MatrixType, _UpLo >:
Inheritance graph
[legend]

List of all members.

Public Types

typedef _MatrixType MatrixType

Public Member Functions

 CholmodDecomposition ()
 CholmodDecomposition (const MatrixType &matrix)
void setMode (CholmodMode mode)
 ~CholmodDecomposition ()

Protected Member Functions

void init ()

Private Types

typedef CholmodBase
< _MatrixType, _UpLo,
CholmodDecomposition
Base

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:
_MatrixTypethe type of the sparse matrix A, it must be a SparseMatrix<>
_UpLothe 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 495 of file CholmodSupport.h.


Member Typedef Documentation

template<typename _MatrixType , int _UpLo = Lower>
typedef CholmodBase<_MatrixType, _UpLo, CholmodDecomposition> Eigen::CholmodDecomposition< _MatrixType, _UpLo >::Base [private]

Definition at line 497 of file CholmodSupport.h.

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

Constructor & Destructor Documentation

template<typename _MatrixType , int _UpLo = Lower>
Eigen::CholmodDecomposition< _MatrixType, _UpLo >::CholmodDecomposition ( ) [inline]

Definition at line 504 of file CholmodSupport.h.

template<typename _MatrixType , int _UpLo = Lower>
Eigen::CholmodDecomposition< _MatrixType, _UpLo >::CholmodDecomposition ( const MatrixType matrix) [inline]

Definition at line 506 of file CholmodSupport.h.

template<typename _MatrixType , int _UpLo = Lower>
Eigen::CholmodDecomposition< _MatrixType, _UpLo >::~CholmodDecomposition ( ) [inline]

Definition at line 512 of file CholmodSupport.h.


Member Function Documentation

template<typename _MatrixType , int _UpLo = Lower>
void Eigen::CholmodDecomposition< _MatrixType, _UpLo >::init ( ) [inline, protected]

Definition at line 540 of file CholmodSupport.h.

template<typename _MatrixType , int _UpLo = Lower>
void Eigen::CholmodDecomposition< _MatrixType, _UpLo >::setMode ( CholmodMode  mode) [inline]

Definition at line 514 of file CholmodSupport.h.


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


win_eigen
Author(s): Daniel Stonier
autogenerated on Wed Sep 16 2015 07:12:45