Eigen::SimplicialCholesky Class Reference

#include <SimplicialCholesky.h>

Public Types
enum	{ UpLo = _UpLo }
typedef SimplicialCholeskyBase< SimplicialCholesky >	Base
typedef SparseMatrix< Scalar, ColMajor, StorageIndex >	CholMatrixType
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 MatrixType::StorageIndex	StorageIndex
typedef internal::traits< SimplicialCholesky >	Traits
typedef Matrix< Scalar, Dynamic, 1 >	VectorType

Public Member Functions
template<typename Rhs , typename Dest >
void	_solve_impl (const MatrixBase< Rhs > &b, MatrixBase< Dest > &dest) const
template<typename Rhs , typename Dest >
void	_solve_impl (const SparseMatrixBase< Rhs > &b, SparseMatrixBase< 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

Protected Attributes
bool	m_LDLT

Detailed Description

Deprecated:

use SimplicialLDLT or class SimplicialLLT

See also

class SimplicialLDLT, class SimplicialLLT

Definition at line 276 of file SimplicialCholesky.h.

Member Typedef Documentation

Base

typedef SimplicialCholeskyBase<SimplicialCholesky> Eigen::SimplicialCholesky::Base

Definition at line 516 of file SimplicialCholesky.h.

CholMatrixType

typedef SparseMatrix<Scalar,ColMajor,StorageIndex> Eigen::SimplicialCholesky::CholMatrixType

Definition at line 520 of file SimplicialCholesky.h.

LDLTTraits

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

Definition at line 523 of file SimplicialCholesky.h.

LLTTraits

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

Definition at line 524 of file SimplicialCholesky.h.

MatrixType

typedef _MatrixType Eigen::SimplicialCholesky::MatrixType

Definition at line 514 of file SimplicialCholesky.h.

RealScalar

typedef MatrixType::RealScalar Eigen::SimplicialCholesky::RealScalar

Definition at line 518 of file SimplicialCholesky.h.

Scalar

typedef MatrixType::Scalar Eigen::SimplicialCholesky::Scalar

Definition at line 517 of file SimplicialCholesky.h.

StorageIndex

typedef MatrixType::StorageIndex Eigen::SimplicialCholesky::StorageIndex

Definition at line 519 of file SimplicialCholesky.h.

Traits

typedef internal::traits<SimplicialCholesky> Eigen::SimplicialCholesky::Traits

Definition at line 522 of file SimplicialCholesky.h.

VectorType

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

Definition at line 521 of file SimplicialCholesky.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
UpLo

Definition at line 515 of file SimplicialCholesky.h.

Constructor & Destructor Documentation

SimplicialCholesky() [1/2]

Eigen::SimplicialCholesky::SimplicialCholesky ( )

inline

Definition at line 526 of file SimplicialCholesky.h.

SimplicialCholesky() [2/2]

Eigen::SimplicialCholesky::SimplicialCholesky ( const MatrixType &  matrix )

inlineexplicit

Definition at line 528 of file SimplicialCholesky.h.

Member Function Documentation

_solve_impl() [1/2]

template<typename Rhs , typename Dest >

void Eigen::SimplicialCholesky::_solve_impl ( const MatrixBase< Rhs > &  b, MatrixBase< Dest > &  dest  ) const

inline

Definition at line 597 of file SimplicialCholesky.h.

_solve_impl() [2/2]

template<typename Rhs , typename Dest >

void Eigen::SimplicialCholesky::_solve_impl ( const SparseMatrixBase< Rhs > &  b, SparseMatrixBase< Dest > &  dest  ) const

inline

Definition at line 635 of file SimplicialCholesky.h.

analyzePattern()

void Eigen::SimplicialCholesky::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 576 of file SimplicialCholesky.h.

compute()

SimplicialCholesky& Eigen::SimplicialCholesky::compute ( const MatrixType &  matrix )

inline

Computes the sparse Cholesky decomposition of matrix

Definition at line 561 of file SimplicialCholesky.h.

determinant()

Scalar Eigen::SimplicialCholesky::determinant ( ) const

inline

Definition at line 640 of file SimplicialCholesky.h.

factorize()

void Eigen::SimplicialCholesky::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 587 of file SimplicialCholesky.h.

rawMatrix()

const CholMatrixType Eigen::SimplicialCholesky::rawMatrix ( ) const

inline

Definition at line 555 of file SimplicialCholesky.h.

setMode()

SimplicialCholesky& Eigen::SimplicialCholesky::setMode ( SimplicialCholeskyMode  mode )

inline

Definition at line 534 of file SimplicialCholesky.h.

vectorD()

const VectorType Eigen::SimplicialCholesky::vectorD ( ) const

inline

Definition at line 551 of file SimplicialCholesky.h.

Member Data Documentation

m_LDLT

bool Eigen::SimplicialCholesky::m_LDLT

protected

Definition at line 654 of file SimplicialCholesky.h.

---

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

• SimplicialCholesky.h