Eigen::SimplicialLLT Class Reference

A direct sparse LLT Cholesky factorizations. More...

#include <SimplicialCholesky.h>

Public Types
enum	{ UpLo = _UpLo }
typedef SimplicialCholeskyBase< SimplicialLLT >	Base
typedef SparseMatrix< Scalar, ColMajor, Index >	CholMatrixType
typedef Traits::MatrixL	MatrixL
typedef _MatrixType	MatrixType
typedef Traits::MatrixU	MatrixU
typedef MatrixType::RealScalar	RealScalar
typedef MatrixType::Scalar	Scalar
typedef MatrixType::StorageIndex	StorageIndex
typedef internal::traits< SimplicialLLT >	Traits
typedef Matrix< Scalar, Dynamic, 1 >	VectorType

Public Member Functions
void	analyzePattern (const MatrixType &a)
SimplicialLLT &	compute (const MatrixType &matrix)
Scalar	determinant () const
void	factorize (const MatrixType &a)
const MatrixL	matrixL () const
const MatrixU	matrixU () const
	SimplicialLLT ()
	SimplicialLLT (const MatrixType &matrix)

Detailed Description

A direct sparse LLT Cholesky factorizations.

This class provides a LL^T Cholesky factorizations of sparse matrices that are selfadjoint and positive definite. The factorization allows 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

_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.
_Ordering	The ordering method to use, either AMDOrdering<> or NaturalOrdering<>. Default is AMDOrdering<>

\implsparsesolverconcept

See also

class SimplicialLDLT, class AMDOrdering, class NaturalOrdering

Definition at line 274 of file SimplicialCholesky.h.

Member Typedef Documentation

Base

typedef SimplicialCholeskyBase<SimplicialLLT> Eigen::SimplicialLLT::Base

Definition at line 343 of file SimplicialCholesky.h.

CholMatrixType

typedef SparseMatrix<Scalar,ColMajor,Index> Eigen::SimplicialLLT::CholMatrixType

Definition at line 347 of file SimplicialCholesky.h.

MatrixL

typedef Traits::MatrixL Eigen::SimplicialLLT::MatrixL

Definition at line 350 of file SimplicialCholesky.h.

MatrixType

typedef _MatrixType Eigen::SimplicialLLT::MatrixType

Definition at line 341 of file SimplicialCholesky.h.

MatrixU

typedef Traits::MatrixU Eigen::SimplicialLLT::MatrixU

Definition at line 351 of file SimplicialCholesky.h.

RealScalar

typedef MatrixType::RealScalar Eigen::SimplicialLLT::RealScalar

Definition at line 345 of file SimplicialCholesky.h.

Scalar

typedef MatrixType::Scalar Eigen::SimplicialLLT::Scalar

Definition at line 344 of file SimplicialCholesky.h.

StorageIndex

typedef MatrixType::StorageIndex Eigen::SimplicialLLT::StorageIndex

Definition at line 346 of file SimplicialCholesky.h.

Traits

typedef internal::traits<SimplicialLLT> Eigen::SimplicialLLT::Traits

Definition at line 349 of file SimplicialCholesky.h.

VectorType

typedef Matrix<Scalar,Dynamic,1> Eigen::SimplicialLLT::VectorType

Definition at line 348 of file SimplicialCholesky.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
UpLo

Definition at line 342 of file SimplicialCholesky.h.

Constructor & Destructor Documentation

SimplicialLLT() [1/2]

Eigen::SimplicialLLT::SimplicialLLT ( )

inline

Default constructor

Definition at line 354 of file SimplicialCholesky.h.

SimplicialLLT() [2/2]

Eigen::SimplicialLLT::SimplicialLLT ( const MatrixType &  matrix )

inlineexplicit

Constructs and performs the LLT factorization of matrix

Definition at line 356 of file SimplicialCholesky.h.

Member Function Documentation

analyzePattern()

void Eigen::SimplicialLLT::analyzePattern ( const MatrixType &  a )

inline

Performs a symbolic decomposition on the sparcity of matrix.

This function is particularly useful when solving for several problems having the same structure.

See also

factorize()

Definition at line 384 of file SimplicialCholesky.h.

compute()

SimplicialLLT& Eigen::SimplicialLLT::compute ( const MatrixType &  matrix )

inline

Computes the sparse Cholesky decomposition of matrix

Definition at line 372 of file SimplicialCholesky.h.

determinant()

Scalar Eigen::SimplicialLLT::determinant ( ) const

inline

Returns

the determinant of the underlying matrix from the current factorization

Definition at line 401 of file SimplicialCholesky.h.

factorize()

void Eigen::SimplicialLLT::factorize ( const MatrixType &  a )

inline

Performs a numeric decomposition of matrix

The given matrix must has the same sparcity than the matrix on which the symbolic decomposition has been performed.

See also

analyzePattern()

Definition at line 395 of file SimplicialCholesky.h.

matrixL()

const MatrixL Eigen::SimplicialLLT::matrixL ( ) const

inline

Returns

an expression of the factor L

Definition at line 360 of file SimplicialCholesky.h.

matrixU()

const MatrixU Eigen::SimplicialLLT::matrixU ( ) const

inline

Returns

an expression of the factor U (= L^*)

Definition at line 366 of file SimplicialCholesky.h.

---

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

• SimplicialCholesky.h