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 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) |
| 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
template<typename _MatrixType, int _UpLo, typename _Ordering>
class Eigen::SimplicialLLT< _MatrixType, _UpLo, _Ordering >
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<>
- See also:
- class SimplicialLDLT, class AMDOrdering, class NaturalOrdering
Definition at line 306 of file SimplicialCholesky.h.
Member Typedef Documentation
| typedef SimplicialCholeskyBase<SimplicialLLT> Eigen::SimplicialLLT< _MatrixType, _UpLo, _Ordering >::Base |
Definition at line 311 of file SimplicialCholesky.h.
| typedef SparseMatrix<Scalar,ColMajor,Index> Eigen::SimplicialLLT< _MatrixType, _UpLo, _Ordering >::CholMatrixType |
Reimplemented from Eigen::SimplicialCholeskyBase< SimplicialLLT< _MatrixType, _UpLo, _Ordering > >.
Definition at line 315 of file SimplicialCholesky.h.
| typedef MatrixType::Index Eigen::SimplicialLLT< _MatrixType, _UpLo, _Ordering >::Index |
Reimplemented from Eigen::SimplicialCholeskyBase< SimplicialLLT< _MatrixType, _UpLo, _Ordering > >.
Definition at line 314 of file SimplicialCholesky.h.
| typedef Traits::MatrixL Eigen::SimplicialLLT< _MatrixType, _UpLo, _Ordering >::MatrixL |
Definition at line 318 of file SimplicialCholesky.h.
| typedef _MatrixType Eigen::SimplicialLLT< _MatrixType, _UpLo, _Ordering >::MatrixType |
Reimplemented from Eigen::SimplicialCholeskyBase< SimplicialLLT< _MatrixType, _UpLo, _Ordering > >.
Definition at line 309 of file SimplicialCholesky.h.
| typedef Traits::MatrixU Eigen::SimplicialLLT< _MatrixType, _UpLo, _Ordering >::MatrixU |
Definition at line 319 of file SimplicialCholesky.h.
| typedef MatrixType::RealScalar Eigen::SimplicialLLT< _MatrixType, _UpLo, _Ordering >::RealScalar |
Reimplemented from Eigen::SimplicialCholeskyBase< SimplicialLLT< _MatrixType, _UpLo, _Ordering > >.
Definition at line 313 of file SimplicialCholesky.h.
| typedef MatrixType::Scalar Eigen::SimplicialLLT< _MatrixType, _UpLo, _Ordering >::Scalar |
Reimplemented from Eigen::SimplicialCholeskyBase< SimplicialLLT< _MatrixType, _UpLo, _Ordering > >.
Definition at line 312 of file SimplicialCholesky.h.
| typedef internal::traits<SimplicialLLT> Eigen::SimplicialLLT< _MatrixType, _UpLo, _Ordering >::Traits |
Definition at line 317 of file SimplicialCholesky.h.
| typedef Matrix<Scalar,Dynamic,1> Eigen::SimplicialLLT< _MatrixType, _UpLo, _Ordering >::VectorType |
Reimplemented from Eigen::SimplicialCholeskyBase< SimplicialLLT< _MatrixType, _UpLo, _Ordering > >.
Definition at line 316 of file SimplicialCholesky.h.
Member Enumeration Documentation
| anonymous enum |
Definition at line 310 of file SimplicialCholesky.h.
Constructor & Destructor Documentation
| Eigen::SimplicialLLT< _MatrixType, _UpLo, _Ordering >::SimplicialLLT | ( | ) | [inline] |
Default constructor
Definition at line 322 of file SimplicialCholesky.h.
| Eigen::SimplicialLLT< _MatrixType, _UpLo, _Ordering >::SimplicialLLT | ( | const MatrixType & | matrix | ) | [inline] |
Constructs and performs the LLT factorization of matrix
Definition at line 324 of file SimplicialCholesky.h.
Member Function Documentation
| void Eigen::SimplicialLLT< _MatrixType, _UpLo, _Ordering >::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 352 of file SimplicialCholesky.h.
| SimplicialLLT& Eigen::SimplicialLLT< _MatrixType, _UpLo, _Ordering >::compute | ( | const MatrixType & | matrix | ) | [inline] |
Computes the sparse Cholesky decomposition of matrix
Reimplemented from Eigen::SimplicialCholeskyBase< SimplicialLLT< _MatrixType, _UpLo, _Ordering > >.
Definition at line 340 of file SimplicialCholesky.h.
| Scalar Eigen::SimplicialLLT< _MatrixType, _UpLo, _Ordering >::determinant | ( | ) | const [inline] |
- Returns:
- the determinant of the underlying matrix from the current factorization
Definition at line 369 of file SimplicialCholesky.h.
| void Eigen::SimplicialLLT< _MatrixType, _UpLo, _Ordering >::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, _Ordering > >.
Definition at line 363 of file SimplicialCholesky.h.
| const MatrixL Eigen::SimplicialLLT< _MatrixType, _UpLo, _Ordering >::matrixL | ( | ) | const [inline] |
- Returns:
- an expression of the factor L
Definition at line 328 of file SimplicialCholesky.h.
| const MatrixU Eigen::SimplicialLLT< _MatrixType, _UpLo, _Ordering >::matrixU | ( | ) | const [inline] |
- Returns:
- an expression of the factor U (= L^*)
Definition at line 334 of file SimplicialCholesky.h.
The documentation for this class was generated from the following file: