Public Types | Public Member Functions | Protected Types | Protected Attributes
SparseLLT< _MatrixType, Cholmod > Class Template Reference

#include <CholmodSupportLegacy.h>

Inheritance diagram for SparseLLT< _MatrixType, Cholmod >:
Inheritance graph
[legend]

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 CholMatrixTypematrixL () const
Index rows () const
template<typename Rhs >
const internal::solve_retval
< SparseLLT< MatrixType,
Cholmod >, Rhs > 
solve (const MatrixBase< Rhs > &b) const
template<typename Derived >
bool solveInPlace (MatrixBase< Derived > &b) const
 SparseLLT (int flags=0)
 SparseLLT (const MatrixType &matrix, int flags=0)
bool succeeded () const
 ~SparseLLT ()

Protected Types

typedef SparseLLT< _MatrixType > Base
typedef Base::CholMatrixType CholMatrixType
typedef Base::RealScalar RealScalar
typedef Base::Scalar Scalar

Protected Attributes

cholmod_common m_cholmod
cholmod_factor * m_cholmodFactor

Detailed Description

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

Definition at line 125 of file CholmodSupportLegacy.h.


Member Typedef Documentation

template<typename _MatrixType >
typedef SparseLLT<_MatrixType> SparseLLT< _MatrixType, Cholmod >::Base [protected]

Definition at line 128 of file CholmodSupportLegacy.h.

template<typename _MatrixType >
typedef Base::CholMatrixType SparseLLT< _MatrixType, Cholmod >::CholMatrixType [protected]

Reimplemented from SparseLLT< _MatrixType >.

Definition at line 131 of file CholmodSupportLegacy.h.

template<typename _MatrixType >
typedef MatrixType::Index SparseLLT< _MatrixType, Cholmod >::Index

Reimplemented from SparseLLT< _MatrixType >.

Definition at line 140 of file CholmodSupportLegacy.h.

template<typename _MatrixType >
typedef _MatrixType SparseLLT< _MatrixType, Cholmod >::MatrixType

Reimplemented from SparseLLT< _MatrixType >.

Definition at line 139 of file CholmodSupportLegacy.h.

template<typename _MatrixType >
typedef Base::RealScalar SparseLLT< _MatrixType, Cholmod >::RealScalar [protected]

Reimplemented from SparseLLT< _MatrixType >.

Definition at line 130 of file CholmodSupportLegacy.h.

template<typename _MatrixType >
typedef Base::Scalar SparseLLT< _MatrixType, Cholmod >::Scalar [protected]

Reimplemented from SparseLLT< _MatrixType >.

Definition at line 129 of file CholmodSupportLegacy.h.


Constructor & Destructor Documentation

template<typename _MatrixType >
SparseLLT< _MatrixType, Cholmod >::SparseLLT ( int  flags = 0) [inline]

Creates a dummy LLT factorization object with flags flags.

Reimplemented from SparseLLT< _MatrixType >.

Definition at line 142 of file CholmodSupportLegacy.h.

template<typename _MatrixType >
SparseLLT< _MatrixType, Cholmod >::SparseLLT ( const MatrixType matrix,
int  flags = 0 
) [inline]

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

Reimplemented from SparseLLT< _MatrixType >.

Definition at line 148 of file CholmodSupportLegacy.h.

template<typename _MatrixType >
SparseLLT< _MatrixType, Cholmod >::~SparseLLT ( ) [inline]

Definition at line 155 of file CholmodSupportLegacy.h.


Member Function Documentation

template<typename _MatrixType >
cholmod_common* SparseLLT< _MatrixType, Cholmod >::cholmodCommon ( ) const [inline]

Definition at line 183 of file CholmodSupportLegacy.h.

template<typename _MatrixType >
const cholmod_factor* SparseLLT< _MatrixType, Cholmod >::cholmodFactor ( ) const [inline]

Definition at line 180 of file CholmodSupportLegacy.h.

template<typename _MatrixType >
Index SparseLLT< _MatrixType, Cholmod >::cols ( void  ) const [inline]

Reimplemented from SparseLLT< _MatrixType >.

Definition at line 177 of file CholmodSupportLegacy.h.

template<typename _MatrixType >
void SparseLLT< _MatrixType, Cholmod >::compute ( const MatrixType matrix)

Computes/re-computes the LLT factorization

Reimplemented from SparseLLT< _MatrixType >.

Definition at line 232 of file CholmodSupportLegacy.h.

template<typename _MatrixType >
const SparseLLT< _MatrixType, Cholmod >::CholMatrixType & SparseLLT< _MatrixType, Cholmod >::matrixL ( void  ) const [inline]
Returns:
the lower triangular matrix L

Reimplemented from SparseLLT< _MatrixType >.

Definition at line 272 of file CholmodSupportLegacy.h.

template<typename _MatrixType >
Index SparseLLT< _MatrixType, Cholmod >::rows ( void  ) const [inline]

Reimplemented from SparseLLT< _MatrixType >.

Definition at line 178 of file CholmodSupportLegacy.h.

template<typename _MatrixType >
template<typename Rhs >
const internal::solve_retval<SparseLLT<MatrixType, Cholmod>, Rhs> SparseLLT< _MatrixType, Cholmod >::solve ( const MatrixBase< Rhs > &  b) const [inline]

Reimplemented from SparseLLT< _MatrixType >.

Definition at line 169 of file CholmodSupportLegacy.h.

template<typename _MatrixType >
template<typename Derived >
bool SparseLLT< _MatrixType, Cholmod >::solveInPlace ( MatrixBase< Derived > &  b) const

Reimplemented from SparseLLT< _MatrixType >.

Definition at line 293 of file CholmodSupportLegacy.h.

template<typename _MatrixType >
bool SparseLLT< _MatrixType, Cholmod >::succeeded ( void  ) const
Returns:
true if the factorization succeeded

Reimplemented from SparseLLT< _MatrixType >.

Definition at line 265 of file CholmodSupportLegacy.h.


Member Data Documentation

template<typename _MatrixType >
cholmod_common SparseLLT< _MatrixType, Cholmod >::m_cholmod [mutable, protected]

Definition at line 189 of file CholmodSupportLegacy.h.

template<typename _MatrixType >
cholmod_factor* SparseLLT< _MatrixType, Cholmod >::m_cholmodFactor [protected]

Definition at line 190 of file CholmodSupportLegacy.h.


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


re_vision
Author(s): Dorian Galvez-Lopez
autogenerated on Sun Jan 5 2014 11:34:25