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

#include <SimplicialCholesky.h>

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

List of all members.

Public Types

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

Public Member Functions

template<typename Rhs , typename Dest >
void _solve (const MatrixBase< Rhs > &b, MatrixBase< Dest > &dest) const
void analyzePattern (const MatrixType &a)
SimplicialCholeskycompute (const MatrixType &matrix)
Scalar determinant () const
void factorize (const MatrixType &a)
const CholMatrixType rawMatrix () const
SimplicialCholeskysetMode (SimplicialCholeskyMode mode)
 SimplicialCholesky ()
 SimplicialCholesky (const MatrixType &matrix)
const VectorType vectorD () const

Protected Attributes

bool m_LDLT

Detailed Description

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

Deprecated:
use SimplicialLDLT or class SimplicialLLT
See also:
class SimplicialLDLT, class SimplicialLLT

Definition at line 532 of file SimplicialCholesky.h.


Member Typedef Documentation

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

Definition at line 537 of file SimplicialCholesky.h.

template<typename _MatrixType , int _UpLo>
typedef SparseMatrix<Scalar,ColMajor,Index> Eigen::SimplicialCholesky< _MatrixType, _UpLo >::CholMatrixType
template<typename _MatrixType , int _UpLo>
typedef MatrixType::Index Eigen::SimplicialCholesky< _MatrixType, _UpLo >::Index
template<typename _MatrixType , int _UpLo>
typedef internal::traits<SimplicialLDLT<MatrixType,UpLo> > Eigen::SimplicialCholesky< _MatrixType, _UpLo >::LDLTTraits

Definition at line 544 of file SimplicialCholesky.h.

template<typename _MatrixType , int _UpLo>
typedef internal::traits<SimplicialLLT<MatrixType,UpLo> > Eigen::SimplicialCholesky< _MatrixType, _UpLo >::LLTTraits

Definition at line 545 of file SimplicialCholesky.h.

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

Definition at line 543 of file SimplicialCholesky.h.

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

Member Enumeration Documentation

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

Definition at line 536 of file SimplicialCholesky.h.


Constructor & Destructor Documentation

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

Definition at line 547 of file SimplicialCholesky.h.

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

Definition at line 549 of file SimplicialCholesky.h.


Member Function Documentation

template<typename _MatrixType , int _UpLo>
template<typename Rhs , typename Dest >
void Eigen::SimplicialCholesky< _MatrixType, _UpLo >::_solve ( const MatrixBase< Rhs > &  b,
MatrixBase< Dest > &  dest 
) const [inline]
template<typename _MatrixType , int _UpLo>
void Eigen::SimplicialCholesky< _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 597 of file SimplicialCholesky.h.

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

Computes the sparse Cholesky decomposition of matrix

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

Definition at line 582 of file SimplicialCholesky.h.

template<typename _MatrixType , int _UpLo>
Scalar Eigen::SimplicialCholesky< _MatrixType, _UpLo >::determinant ( ) const [inline]

Definition at line 654 of file SimplicialCholesky.h.

template<typename _MatrixType , int _UpLo>
void Eigen::SimplicialCholesky< _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< SimplicialCholesky< _MatrixType, _UpLo > >.

Definition at line 608 of file SimplicialCholesky.h.

template<typename _MatrixType , int _UpLo>
const CholMatrixType Eigen::SimplicialCholesky< _MatrixType, _UpLo >::rawMatrix ( ) const [inline]

Definition at line 576 of file SimplicialCholesky.h.

template<typename _MatrixType , int _UpLo>
SimplicialCholesky& Eigen::SimplicialCholesky< _MatrixType, _UpLo >::setMode ( SimplicialCholeskyMode  mode) [inline]

Definition at line 555 of file SimplicialCholesky.h.

template<typename _MatrixType , int _UpLo>
const VectorType Eigen::SimplicialCholesky< _MatrixType, _UpLo >::vectorD ( ) const [inline]

Definition at line 572 of file SimplicialCholesky.h.


Member Data Documentation

template<typename _MatrixType , int _UpLo>
bool Eigen::SimplicialCholesky< _MatrixType, _UpLo >::m_LDLT [protected]

Definition at line 668 of file SimplicialCholesky.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:58