Public Types | Public Member Functions
Eigen::SimplicialLLT< _MatrixType, _UpLo > Class Template Reference

A direct sparse LLT Cholesky factorizations. More...

#include <SimplicialCholesky.h>

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

List of all members.

Public Types

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

Public Member Functions

void analyzePattern (const MatrixType &a)
SimplicialLLTcompute (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

template<typename _MatrixType, int _UpLo>
class Eigen::SimplicialLLT< _MatrixType, _UpLo >

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:
_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.
See also:
class SimplicialLDLT

Definition at line 362 of file SimplicialCholesky.h.


Member Typedef Documentation

template<typename _MatrixType , int _UpLo>
typedef SimplicialCholeskyBase<SimplicialLLT> Eigen::SimplicialLLT< _MatrixType, _UpLo >::Base

Definition at line 367 of file SimplicialCholesky.h.

template<typename _MatrixType , int _UpLo>
typedef SparseMatrix<Scalar,ColMajor,Index> Eigen::SimplicialLLT< _MatrixType, _UpLo >::CholMatrixType
template<typename _MatrixType , int _UpLo>
typedef MatrixType::Index Eigen::SimplicialLLT< _MatrixType, _UpLo >::Index
template<typename _MatrixType , int _UpLo>
typedef Traits::MatrixL Eigen::SimplicialLLT< _MatrixType, _UpLo >::MatrixL

Definition at line 374 of file SimplicialCholesky.h.

template<typename _MatrixType , int _UpLo>
typedef _MatrixType Eigen::SimplicialLLT< _MatrixType, _UpLo >::MatrixType
template<typename _MatrixType , int _UpLo>
typedef Traits::MatrixU Eigen::SimplicialLLT< _MatrixType, _UpLo >::MatrixU

Definition at line 375 of file SimplicialCholesky.h.

template<typename _MatrixType , int _UpLo>
typedef MatrixType::RealScalar Eigen::SimplicialLLT< _MatrixType, _UpLo >::RealScalar
template<typename _MatrixType , int _UpLo>
typedef MatrixType::Scalar Eigen::SimplicialLLT< _MatrixType, _UpLo >::Scalar
template<typename _MatrixType , int _UpLo>
typedef internal::traits<SimplicialLLT> Eigen::SimplicialLLT< _MatrixType, _UpLo >::Traits

Definition at line 373 of file SimplicialCholesky.h.

template<typename _MatrixType , int _UpLo>
typedef Matrix<Scalar,Dynamic,1> Eigen::SimplicialLLT< _MatrixType, _UpLo >::VectorType

Member Enumeration Documentation

template<typename _MatrixType , int _UpLo>
anonymous enum
Enumerator:
UpLo 

Definition at line 366 of file SimplicialCholesky.h.


Constructor & Destructor Documentation

template<typename _MatrixType , int _UpLo>
Eigen::SimplicialLLT< _MatrixType, _UpLo >::SimplicialLLT ( ) [inline]

Default constructor

Definition at line 378 of file SimplicialCholesky.h.

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

Constructs and performs the LLT factorization of matrix

Definition at line 380 of file SimplicialCholesky.h.


Member Function Documentation

template<typename _MatrixType , int _UpLo>
void Eigen::SimplicialLLT< _MatrixType, _UpLo >::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 408 of file SimplicialCholesky.h.

template<typename _MatrixType , int _UpLo>
SimplicialLLT& Eigen::SimplicialLLT< _MatrixType, _UpLo >::compute ( const MatrixType matrix) [inline]

Computes the sparse Cholesky decomposition of matrix

Reimplemented from Eigen::SimplicialCholeskyBase< SimplicialLLT< _MatrixType, _UpLo > >.

Definition at line 396 of file SimplicialCholesky.h.

template<typename _MatrixType , int _UpLo>
Scalar Eigen::SimplicialLLT< _MatrixType, _UpLo >::determinant ( ) const [inline]
Returns:
the determinant of the underlying matrix from the current factorization

Definition at line 425 of file SimplicialCholesky.h.

template<typename _MatrixType , int _UpLo>
void Eigen::SimplicialLLT< _MatrixType, _UpLo >::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()

Reimplemented from Eigen::SimplicialCholeskyBase< SimplicialLLT< _MatrixType, _UpLo > >.

Definition at line 419 of file SimplicialCholesky.h.

template<typename _MatrixType , int _UpLo>
const MatrixL Eigen::SimplicialLLT< _MatrixType, _UpLo >::matrixL ( ) const [inline]
Returns:
an expression of the factor L

Definition at line 384 of file SimplicialCholesky.h.

template<typename _MatrixType , int _UpLo>
const MatrixU Eigen::SimplicialLLT< _MatrixType, _UpLo >::matrixU ( ) const [inline]
Returns:
an expression of the factor U (= L^*)

Definition at line 390 of file SimplicialCholesky.h.


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


win_eigen
Author(s): Daniel Stonier
autogenerated on Mon Oct 6 2014 12:27:19