#include <SimplicialCholesky.h>

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

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 Types inherited from Eigen::SimplicialCholeskyBase< SimplicialCholesky< _MatrixType, _UpLo > >
enum

typedef SparseMatrix< Scalar, ColMajor, Index >	CholMatrixType

typedef MatrixType::Index	Index

typedef internal::traits< SimplicialCholesky< _MatrixType, _UpLo > >::MatrixType	MatrixType

typedef MatrixType::RealScalar	RealScalar

typedef MatrixType::Scalar	Scalar

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)

SimplicialCholesky &	compute (const MatrixType &matrix)

Scalar	determinant () const

void	factorize (const MatrixType &a)

const CholMatrixType	rawMatrix () const

SimplicialCholesky &	setMode (SimplicialCholeskyMode mode)

	SimplicialCholesky ()

	SimplicialCholesky (const MatrixType &matrix)

const VectorType	vectorD () const

Public Member Functions inherited from Eigen::SimplicialCholeskyBase< SimplicialCholesky< _MatrixType, _UpLo > >
void	_solve (const MatrixBase< Rhs > &b, MatrixBase< Dest > &dest) const

Index	cols () const

SimplicialCholesky< _MatrixType, _UpLo > &	derived ()

const SimplicialCholesky< _MatrixType, _UpLo > &	derived () const

void	dumpMemory (Stream &s)

ComputationInfo	info () const
	Reports whether previous computation was successful. More...

const PermutationMatrix< Dynamic, Dynamic, Index > &	permutationP () const

const PermutationMatrix< Dynamic, Dynamic, Index > &	permutationPinv () const

Index	rows () const

SimplicialCholesky< _MatrixType, _UpLo > &	setShift (const RealScalar &offset, const RealScalar &scale=1)

	SimplicialCholeskyBase ()

	SimplicialCholeskyBase (const MatrixType &matrix)

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

	~SimplicialCholeskyBase ()

Protected Attributes
bool	m_LDLT

Protected Attributes inherited from Eigen::SimplicialCholeskyBase< SimplicialCholesky< _MatrixType, _UpLo > >
bool	m_analysisIsOk

VectorType	m_diag

bool	m_factorizationIsOk

ComputationInfo	m_info

bool	m_isInitialized

CholMatrixType	m_matrix

VectorXi	m_nonZerosPerCol

PermutationMatrix< Dynamic, Dynamic, Index >	m_P

VectorXi	m_parent

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	analyzePattern (const MatrixType &a, bool doLDLT)

void	analyzePattern_preordered (const CholMatrixType &a, bool doLDLT)

void	compute (const MatrixType &matrix)

void	factorize (const MatrixType &a)

void	factorize_preordered (const CholMatrixType &a)

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 Typedef Documentation

◆ Base

template<typename _MatrixType , int _UpLo>

typedef SimplicialCholeskyBase<SimplicialCholesky> Eigen::SimplicialCholesky< _MatrixType, _UpLo >::Base

Definition at line 476 of file SimplicialCholesky.h.

◆ CholMatrixType

template<typename _MatrixType , int _UpLo>

typedef SparseMatrix<Scalar,ColMajor,Index> Eigen::SimplicialCholesky< _MatrixType, _UpLo >::CholMatrixType

Definition at line 480 of file SimplicialCholesky.h.

◆ Index

template<typename _MatrixType , int _UpLo>

typedef MatrixType::Index Eigen::SimplicialCholesky< _MatrixType, _UpLo >::Index

Definition at line 479 of file SimplicialCholesky.h.

◆ LDLTTraits

template<typename _MatrixType , int _UpLo>

typedef internal::traits<SimplicialLDLT<MatrixType,UpLo> > Eigen::SimplicialCholesky< _MatrixType, _UpLo >::LDLTTraits

Definition at line 483 of file SimplicialCholesky.h.

◆ LLTTraits

template<typename _MatrixType , int _UpLo>

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

Definition at line 484 of file SimplicialCholesky.h.

◆ MatrixType

template<typename _MatrixType , int _UpLo>

typedef _MatrixType Eigen::SimplicialCholesky< _MatrixType, _UpLo >::MatrixType

Definition at line 474 of file SimplicialCholesky.h.

◆ RealScalar

template<typename _MatrixType , int _UpLo>

typedef MatrixType::RealScalar Eigen::SimplicialCholesky< _MatrixType, _UpLo >::RealScalar

Definition at line 478 of file SimplicialCholesky.h.

◆ Scalar

template<typename _MatrixType , int _UpLo>

typedef MatrixType::Scalar Eigen::SimplicialCholesky< _MatrixType, _UpLo >::Scalar

Definition at line 477 of file SimplicialCholesky.h.

◆ Traits

template<typename _MatrixType , int _UpLo>

typedef internal::traits<SimplicialCholesky> Eigen::SimplicialCholesky< _MatrixType, _UpLo >::Traits

Definition at line 482 of file SimplicialCholesky.h.

◆ VectorType

template<typename _MatrixType , int _UpLo>

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

Definition at line 481 of file SimplicialCholesky.h.

Member Enumeration Documentation

◆ anonymous enum

template<typename _MatrixType , int _UpLo>

anonymous enum

Enumerator
UpLo

Definition at line 475 of file SimplicialCholesky.h.

Constructor & Destructor Documentation

◆ SimplicialCholesky() [1/2]

template<typename _MatrixType , int _UpLo>

Eigen::SimplicialCholesky< _MatrixType, _UpLo >::SimplicialCholesky ( )

inline

Definition at line 486 of file SimplicialCholesky.h.

◆ SimplicialCholesky() [2/2]

template<typename _MatrixType , int _UpLo>

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

inline

Definition at line 488 of file SimplicialCholesky.h.

Member Function Documentation

◆ _solve()

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

Definition at line 557 of file SimplicialCholesky.h.

◆ analyzePattern()

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.

◆ compute()

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.

◆ determinant()

template<typename _MatrixType , int _UpLo>

Scalar Eigen::SimplicialCholesky< _MatrixType, _UpLo >::determinant ( ) const

inline

Definition at line 593 of file SimplicialCholesky.h.

◆ factorize()

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.

◆ rawMatrix()

template<typename _MatrixType , int _UpLo>

const CholMatrixType Eigen::SimplicialCholesky< _MatrixType, _UpLo >::rawMatrix ( ) const

inline

Definition at line 515 of file SimplicialCholesky.h.

◆ setMode()

template<typename _MatrixType , int _UpLo>

SimplicialCholesky& Eigen::SimplicialCholesky< _MatrixType, _UpLo >::setMode ( SimplicialCholeskyMode mode )

inline

Definition at line 494 of file SimplicialCholesky.h.

◆ vectorD()

template<typename _MatrixType , int _UpLo>

const VectorType Eigen::SimplicialCholesky< _MatrixType, _UpLo >::vectorD ( ) const

inline

Definition at line 511 of file SimplicialCholesky.h.

Member Data Documentation

◆ m_LDLT

template<typename _MatrixType , int _UpLo>

bool Eigen::SimplicialCholesky< _MatrixType, _UpLo >::m_LDLT

protected

Definition at line 607 of file SimplicialCholesky.h.

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

SimplicialCholesky.h

Public Types

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ Base

◆ CholMatrixType

◆ Index

◆ LDLTTraits

◆ LLTTraits

◆ MatrixType

◆ RealScalar

◆ Scalar

◆ Traits

◆ VectorType

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ SimplicialCholesky() [1/2]

◆ SimplicialCholesky() [2/2]

Member Function Documentation

◆ _solve()

◆ analyzePattern()

◆ compute()

◆ determinant()

◆ factorize()

◆ rawMatrix()

◆ setMode()

◆ vectorD()

Member Data Documentation

◆ m_LDLT

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