Eigen::CholmodBase< _MatrixType, _UpLo, Derived > Class Template Reference

The base class for the direct Cholesky factorization of Cholmod. More...

#include <CholmodSupport.h>

Inheritance diagram for Eigen::CholmodBase< _MatrixType, _UpLo, Derived >:

Collaboration diagram for Eigen::CholmodBase< _MatrixType, _UpLo, Derived >:

Public Types
enum	{ UpLo = _UpLo }
typedef _MatrixType	MatrixType
typedef MatrixType::Scalar	Scalar
typedef MatrixType::RealScalar	RealScalar
typedef MatrixType	CholMatrixType
typedef MatrixType::Index	Index

Public Member Functions
	CholmodBase (const MatrixType &matrix)
Index	cols () const
Index	rows () const
Derived &	derived ()
const Derived &	derived () const
ComputationInfo	info () const
	Reports whether previous computation was successful. More...
Derived &	compute (const MatrixType &matrix)
template<typename Rhs >
const internal::solve_retval< CholmodBase, Rhs >	solve (const MatrixBase< Rhs > &b) const
template<typename Rhs >
const internal::sparse_solve_retval< CholmodBase, Rhs >	solve (const SparseMatrixBase< Rhs > &b) const
void	analyzePattern (const MatrixType &matrix)
void	factorize (const MatrixType &matrix)
cholmod_common &	cholmod ()
template<typename Rhs , typename Dest >
void	_solve (const MatrixBase< Rhs > &b, MatrixBase< Dest > &dest) const
template<typename RhsScalar , int RhsOptions, typename RhsIndex , typename DestScalar , int DestOptions, typename DestIndex >
void	_solve (const SparseMatrix< RhsScalar, RhsOptions, RhsIndex > &b, SparseMatrix< DestScalar, DestOptions, DestIndex > &dest) const
Derived &	setShift (const RealScalar &offset)
template<typename Stream >
void	dumpMemory (Stream &)

Protected Attributes
cholmod_common	m_cholmod
cholmod_factor *	m_cholmodFactor
RealScalar	m_shiftOffset [2]
ComputationInfo	m_info
bool	m_isInitialized
int	m_factorizationIsOk
int	m_analysisIsOk

Detailed Description

template<typename _MatrixType, int _UpLo, typename Derived>
class Eigen::CholmodBase< _MatrixType, _UpLo, Derived >

The base class for the direct Cholesky factorization of Cholmod.

See also

class CholmodSupernodalLLT, class CholmodSimplicialLDLT, class CholmodSimplicialLLT

Definition at line 158 of file CholmodSupport.h.

Member Function Documentation

template<typename _MatrixType, int _UpLo, typename Derived>

void Eigen::CholmodBase< _MatrixType, _UpLo, Derived >::analyzePattern ( const MatrixType &  matrix )

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 250 of file CholmodSupport.h.

    {
      if(m_cholmodFactor)
      {
        cholmod_free_factor(&m_cholmodFactor, &m_cholmod);
        m_cholmodFactor = 0;
      }
      cholmod_sparse A = viewAsCholmod(matrix.template selfadjointView<UpLo>());
      m_cholmodFactor = cholmod_analyze(&A, &m_cholmod);
      
      this->m_isInitialized = true;
      this->m_info = Success;
      m_analysisIsOk = true;
      m_factorizationIsOk = false;
    }

template<typename _MatrixType, int _UpLo, typename Derived>

cholmod_common& Eigen::CholmodBase< _MatrixType, _UpLo, Derived >::cholmod ( )

inline

Returns a reference to the Cholmod's configuration structure to get a full control over the performed operations. See the Cholmod user guide for details.

Definition at line 285 of file CholmodSupport.h.

{ return m_cholmod; }

template<typename _MatrixType, int _UpLo, typename Derived>

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

inline

Computes the sparse Cholesky decomposition of matrix

Definition at line 209 of file CholmodSupport.h.

    {
      analyzePattern(matrix);
      factorize(matrix);
      return derived();
    }

template<typename _MatrixType, int _UpLo, typename Derived>

void Eigen::CholmodBase< _MatrixType, _UpLo, Derived >::factorize ( const MatrixType &  matrix )

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 272 of file CholmodSupport.h.

    {
      eigen_assert(m_analysisIsOk && "You must first call analyzePattern()");
      cholmod_sparse A = viewAsCholmod(matrix.template selfadjointView<UpLo>());
      cholmod_factorize_p(&A, m_shiftOffset, 0, 0, m_cholmodFactor, &m_cholmod);
      
      // If the factorization failed, minor is the column at which it did. On success minor == n.
      this->m_info = (m_cholmodFactor->minor == m_cholmodFactor->n ? Success : NumericalIssue);
      m_factorizationIsOk = true;
    }

template<typename _MatrixType, int _UpLo, typename Derived>

ComputationInfo Eigen::CholmodBase< _MatrixType, _UpLo, Derived >::info ( ) const

inline

Reports whether previous computation was successful.

Returns

Success if computation was succesful, NumericalIssue if the matrix.appears to be negative.

Definition at line 202 of file CholmodSupport.h.

    {
      eigen_assert(m_isInitialized && "Decomposition is not initialized.");
      return m_info;
    }

template<typename _MatrixType, int _UpLo, typename Derived>

Derived& Eigen::CholmodBase< _MatrixType, _UpLo, Derived >::setShift ( const RealScalar &  offset )

inline

Sets the shift parameter that will be used to adjust the diagonal coefficients during the numerical factorization.

During the numerical factorization, an offset term is added to the diagonal coefficients:
d_ii = offset + d_ii

The default is offset=0.

Returns

a reference to *this.

Definition at line 342 of file CholmodSupport.h.

    {
      m_shiftOffset[0] = offset;
      return derived();
    }

template<typename _MatrixType, int _UpLo, typename Derived>

template<typename Rhs >

const internal::solve_retval<CholmodBase, Rhs> Eigen::CholmodBase< _MatrixType, _UpLo, Derived >::solve ( const MatrixBase< Rhs > &  b ) const

inline

Returns

the solution x of using the current decomposition of A.

See also

compute()

Definition at line 222 of file CholmodSupport.h.

    {
      eigen_assert(m_isInitialized && "LLT is not initialized.");
      eigen_assert(rows()==b.rows()
                && "CholmodDecomposition::solve(): invalid number of rows of the right hand side matrix b");
      return internal::solve_retval<CholmodBase, Rhs>(*this, b.derived());
    }

template<typename _MatrixType, int _UpLo, typename Derived>

template<typename Rhs >

const internal::sparse_solve_retval<CholmodBase, Rhs> Eigen::CholmodBase< _MatrixType, _UpLo, Derived >::solve ( const SparseMatrixBase< Rhs > &  b ) const

inline

Returns

the solution x of using the current decomposition of A.

See also

compute()

Definition at line 236 of file CholmodSupport.h.

    {
      eigen_assert(m_isInitialized && "LLT is not initialized.");
      eigen_assert(rows()==b.rows()
                && "CholmodDecomposition::solve(): invalid number of rows of the right hand side matrix b");
      return internal::sparse_solve_retval<CholmodBase, Rhs>(*this, b.derived());
    }

---

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

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