CholmodBase< _MatrixType, _UpLo, Derived > Class Template Reference
[CholmodSupport module]

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

Inherits Eigen::internal::noncopyable.

List of all members.

Public Member Functions
void	analyzePattern (const MatrixType &matrix)
cholmod_common &	cholmod ()
Derived &	compute (const MatrixType &matrix)
void	factorize (const MatrixType &matrix)
ComputationInfo	info () const
	Reports whether previous computation was successful.
Derived &	setShift (const RealScalar &offset)
template<typename Rhs >
const internal::sparse_solve_retval < CholmodBase, Rhs >	solve (const SparseMatrixBase< Rhs > &b) const
template<typename Rhs >
const internal::solve_retval < CholmodBase, Rhs >	solve (const MatrixBase< Rhs > &b) const

---

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

---

Member Function Documentation

void analyzePattern

(

const MatrixType &

matrix

)

[inline]

Performs a symbolic decomposition on the sparsity pattern of matrix.

This function is particularly useful when solving for several problems having the same structure.

See also:

factorize()

Referenced by CholmodBase< _MatrixType, _UpLo, CholmodSimplicialLLT< _MatrixType, _UpLo > >::compute().

cholmod_common& 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.

Derived& compute

(

const MatrixType &

matrix

)

[inline]

Computes the sparse Cholesky decomposition of matrix

void factorize

(

const MatrixType &

matrix

)

[inline]

Performs a numeric decomposition of matrix

The given matrix must have the same sparsity pattern as the matrix on which the symbolic decomposition has been performed.

See also:

analyzePattern()

Referenced by CholmodBase< _MatrixType, _UpLo, CholmodSimplicialLLT< _MatrixType, _UpLo > >::compute().

ComputationInfo info

(

)

const [inline]

Reports whether previous computation was successful.

Returns:

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

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.

const internal::sparse_solve_retval<CholmodBase, Rhs> solve

(

const SparseMatrixBase< Rhs > &

b

)

const [inline]

Returns:

the solution x of using the current decomposition of A.

See also:

compute()

const internal::solve_retval<CholmodBase, Rhs> solve

(

const MatrixBase< Rhs > &

b

)

const [inline]

Returns:

the solution x of using the current decomposition of A.

See also:

compute()

---

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

• CholmodSupport.h