SparseLDLT< _MatrixType, Cholmod > Class Template Reference

#include <CholmodSupportLegacy.h>

Inheritance diagram for SparseLDLT< _MatrixType, Cholmod >:

List of all members.

Public Types
typedef MatrixType::Index	Index
typedef _MatrixType	MatrixType
Public Member Functions
cholmod_common *	cholmodCommon () const
const cholmod_factor *	cholmodFactor () const
Index	cols () const
void	compute (const _MatrixType &matrix)
const Base::CholMatrixType &	matrixL (void) const
Index	rows () const
template<typename Rhs >
const internal::solve_retval < SparseLDLT< MatrixType, Cholmod >, Rhs >	solve (const MatrixBase< Rhs > &b) const
template<typename Derived >
void	solveInPlace (MatrixBase< Derived > &b) const
	SparseLDLT (int flags=0)
	SparseLDLT (const _MatrixType &matrix, int flags=0)
bool	succeeded () const
	~SparseLDLT ()
Protected Types
typedef SparseLDLT< _MatrixType >	Base
typedef Base::RealScalar	RealScalar
typedef Base::Scalar	Scalar
Protected Attributes
cholmod_common	m_cholmod
cholmod_factor *	m_cholmodFactor

---

Detailed Description

template<typename _MatrixType>
class SparseLDLT< _MatrixType, Cholmod >

Definition at line 325 of file CholmodSupportLegacy.h.

---

Member Typedef Documentation

template<typename _MatrixType >

typedef SparseLDLT<_MatrixType> SparseLDLT< _MatrixType, Cholmod >::Base [protected]

Definition at line 328 of file CholmodSupportLegacy.h.

template<typename _MatrixType >

typedef MatrixType::Index SparseLDLT< _MatrixType, Cholmod >::Index

Reimplemented from SparseLDLT< _MatrixType >.

Definition at line 339 of file CholmodSupportLegacy.h.

template<typename _MatrixType >

typedef _MatrixType SparseLDLT< _MatrixType, Cholmod >::MatrixType

Reimplemented from SparseLDLT< _MatrixType >.

Definition at line 338 of file CholmodSupportLegacy.h.

template<typename _MatrixType >

typedef Base::RealScalar SparseLDLT< _MatrixType, Cholmod >::RealScalar [protected]

Reimplemented from SparseLDLT< _MatrixType >.

Definition at line 330 of file CholmodSupportLegacy.h.

template<typename _MatrixType >

typedef Base::Scalar SparseLDLT< _MatrixType, Cholmod >::Scalar [protected]

Reimplemented from SparseLDLT< _MatrixType >.

Definition at line 329 of file CholmodSupportLegacy.h.

---

Constructor & Destructor Documentation

template<typename _MatrixType >

SparseLDLT< _MatrixType, Cholmod >::SparseLDLT

(

int

flags = 0

)

[inline]

Creates a dummy LDLT factorization object with flags flags.

Reimplemented from SparseLDLT< _MatrixType >.

Definition at line 341 of file CholmodSupportLegacy.h.

template<typename _MatrixType >

SparseLDLT< _MatrixType, Cholmod >::SparseLDLT	(	const _MatrixType &	matrix,
		int	flags = 0
	)		[inline]

Creates a LDLT object and compute the respective factorization of matrix using flags flags.

Reimplemented from SparseLDLT< _MatrixType >.

Definition at line 347 of file CholmodSupportLegacy.h.

template<typename _MatrixType >

SparseLDLT< _MatrixType, Cholmod >::~SparseLDLT

(

)

[inline]

Definition at line 354 of file CholmodSupportLegacy.h.

---

Member Function Documentation

template<typename _MatrixType >

cholmod_common* SparseLDLT< _MatrixType, Cholmod >::cholmodCommon

(

)

const [inline]

Definition at line 382 of file CholmodSupportLegacy.h.

template<typename _MatrixType >

const cholmod_factor* SparseLDLT< _MatrixType, Cholmod >::cholmodFactor

(

)

const [inline]

Definition at line 379 of file CholmodSupportLegacy.h.

template<typename _MatrixType >

Index SparseLDLT< _MatrixType, Cholmod >::cols

(

void

)

const [inline]

Reimplemented from SparseLDLT< _MatrixType >.

Definition at line 376 of file CholmodSupportLegacy.h.

template<typename _MatrixType >

void SparseLDLT< _MatrixType, Cholmod >::compute

(

const _MatrixType &

matrix

)

Computes/re-computes the LDLT factorization

Reimplemented from SparseLDLT< _MatrixType >.

Definition at line 430 of file CholmodSupportLegacy.h.

template<typename _MatrixType >

const SparseLDLT< _MatrixType >::CholMatrixType & SparseLDLT< _MatrixType, Cholmod >::matrixL

(

void

)

const [inline]

Returns:

the lower triangular matrix L

Reimplemented from SparseLDLT< _MatrixType >.

Definition at line 473 of file CholmodSupportLegacy.h.

template<typename _MatrixType >

Index SparseLDLT< _MatrixType, Cholmod >::rows

(

void

)

const [inline]

Reimplemented from SparseLDLT< _MatrixType >.

Definition at line 377 of file CholmodSupportLegacy.h.

template<typename _MatrixType >

template<typename Rhs >

const internal::solve_retval<SparseLDLT<MatrixType, Cholmod>, Rhs> SparseLDLT< _MatrixType, Cholmod >::solve

(

const MatrixBase< Rhs > &

b

)

const [inline]

Reimplemented from SparseLDLT< _MatrixType >.

Definition at line 368 of file CholmodSupportLegacy.h.

template<typename _MatrixType >

template<typename Derived >

void SparseLDLT< _MatrixType, Cholmod >::solveInPlace

(

MatrixBase< Derived > &

b

)

const

Reimplemented from SparseLDLT< _MatrixType >.

Definition at line 495 of file CholmodSupportLegacy.h.

template<typename _MatrixType >

bool SparseLDLT< _MatrixType, Cholmod >::succeeded

(

void

)

const

Returns:

true if the factorization succeeded

Reimplemented from SparseLDLT< _MatrixType >.

Definition at line 467 of file CholmodSupportLegacy.h.

---

Member Data Documentation

template<typename _MatrixType >

cholmod_common SparseLDLT< _MatrixType, Cholmod >::m_cholmod [mutable, protected]

Definition at line 388 of file CholmodSupportLegacy.h.

template<typename _MatrixType >

cholmod_factor* SparseLDLT< _MatrixType, Cholmod >::m_cholmodFactor [protected]

Definition at line 389 of file CholmodSupportLegacy.h.

---

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

• CholmodSupportLegacy.h