Eigen::SimplicialCholesky< _MatrixType, _UpLo > Class Template Reference

#include <SimplicialCholesky.h>

Inheritance diagram for Eigen::SimplicialCholesky< _MatrixType, _UpLo >:

Collaboration diagram for Eigen::SimplicialCholesky< _MatrixType, _UpLo >:

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

Public Member Functions
	SimplicialCholesky (const MatrixType &matrix)
SimplicialCholesky &	setMode (SimplicialCholeskyMode mode)
const VectorType	vectorD () const
const CholMatrixType	rawMatrix () const
SimplicialCholesky &	compute (const MatrixType &matrix)
void	analyzePattern (const MatrixType &a)
void	factorize (const MatrixType &a)
template<typename Rhs , typename Dest >
void	_solve (const MatrixBase< Rhs > &b, MatrixBase< Dest > &dest) const
Scalar	determinant () const
Public Member Functions inherited from Eigen::SimplicialCholeskyBase< SimplicialCholesky< _MatrixType, _UpLo > >
	SimplicialCholeskyBase ()
	SimplicialCholeskyBase (const MatrixType &matrix)
SimplicialCholesky< _MatrixType, _UpLo > &	derived ()
const SimplicialCholesky< _MatrixType, _UpLo > &	derived () const
Index	cols () const
Index	rows () const
ComputationInfo	info () const
	Reports whether previous computation was successful. More...
const internal::solve_retval< SimplicialCholeskyBase, Rhs >	solve (const MatrixBase< Rhs > &b) const
const internal::sparse_solve_retval< SimplicialCholeskyBase, Rhs >	solve (const SparseMatrixBase< Rhs > &b) const
const PermutationMatrix< Dynamic, Dynamic, Index > &	permutationP () const
const PermutationMatrix< Dynamic, Dynamic, Index > &	permutationPinv () const
SimplicialCholesky< _MatrixType, _UpLo > &	setShift (const RealScalar &offset, const RealScalar &scale=1)
void	dumpMemory (Stream &s)
void	_solve (const MatrixBase< Rhs > &b, MatrixBase< Dest > &dest) const

Protected Attributes
bool	m_LDLT
Protected Attributes inherited from Eigen::SimplicialCholeskyBase< SimplicialCholesky< _MatrixType, _UpLo > >
ComputationInfo	m_info
bool	m_isInitialized
bool	m_factorizationIsOk
bool	m_analysisIsOk
CholMatrixType	m_matrix
VectorType	m_diag
VectorXi	m_parent
VectorXi	m_nonZerosPerCol
PermutationMatrix< Dynamic, Dynamic, Index >	m_P
PermutationMatrix< Dynamic, Dynamic, Index >	m_Pinv
RealScalar	m_shiftOffset
RealScalar	m_shiftScale

Additional Inherited Members
Protected Member Functions inherited from Eigen::SimplicialCholeskyBase< SimplicialCholesky< _MatrixType, _UpLo > >
void	compute (const MatrixType &matrix)
void	factorize (const MatrixType &a)
void	factorize_preordered (const CholMatrixType &a)
void	analyzePattern (const MatrixType &a, bool doLDLT)
void	analyzePattern_preordered (const CholMatrixType &a, bool doLDLT)
void	ordering (const MatrixType &a, CholMatrixType &ap)

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 245 of file SimplicialCholesky.h.

Member Function Documentation

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 536 of file SimplicialCholesky.h.

    {
      Base::analyzePattern(a, m_LDLT);
    }

template<typename _MatrixType , int _UpLo>

SimplicialCholesky& Eigen::SimplicialCholesky< _MatrixType, _UpLo >::compute ( const MatrixType &  matrix )

inline

Computes the sparse Cholesky decomposition of matrix

Definition at line 521 of file SimplicialCholesky.h.

    {
      if(m_LDLT)
        Base::template compute<true>(matrix);
      else
        Base::template compute<false>(matrix);
      return *this;
    }

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()

Definition at line 547 of file SimplicialCholesky.h.

    {
      if(m_LDLT)
        Base::template factorize<true>(a);
      else
        Base::template factorize<false>(a);
    }

---

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

• C:/Users/Brig/Documents/ShapeWorksStudio/src/Surfworks/Eigen/src/SparseCholesky/SimplicialCholesky.h